chore: make Forms OpenAPI compliant

[Chartman123]

This fixes #2356

[codecov]

Codecov Report

Attention: Patch coverage is 32.07547% with 72 lines in your changes missing coverage. Please review.

Please upload report for BASE (main@39bd5df). Learn more about missing BASE report.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #2358   +/-   ##
=======================================
  Coverage        ?   42.88%           
  Complexity      ?      851           
=======================================
  Files           ?       72           
  Lines           ?     3211           
  Branches        ?        0           
=======================================
  Hits            ?     1377           
  Misses          ?     1834           
  Partials        ?        0           

[provokateurin]

@Chartman123 as it seems you are pretty much free to change the API however you like, would you like to have a review by me of the whole API to point out improvements?

[Chartman123]

@provokateurin yes, that would be nice :) Would you recommend to first do this review and then make it OpenAPI compliant?

[provokateurin]

I think it is easier to first make it all work and then review and refactor it.

[Chartman123]

Ok, I think I should be ready by the weekend

[Chartman123]

@provokateurin I've fixed most of the psalm errors now... but I just can't seem to find a way to fix the remaining ones.

fix any problems reported by nextcloud/openapi-extractor#168

how can I do this? do I have to apply the patch manually to the files in the vendor-bin directory?

[provokateurin]

I've fixed most of the psalm errors now... but I just can't seem to find a way to fix the remaining ones.

I can try to take a look, but I'm already busy with similar problems this week so I might lack the headspace for it this week.

how can I do this? do I have to apply the patch manually to the files in the vendor-bin directory?

You can clone the repo, do a composer i in it an then call generate-spec using the path so something like ../../openapi-extractor/generate-spec.

[provokateurin]

I fixed everything. The main problem was that you didn't type the lower-level methods and then psalm wasn't inferring the types correctly anymore.
I also fixed the array syntaxes from the PR I mentioned above and uncovered some more problems that I fixed as well.

Now you should take a look if everything is to your liking and change anything you want and then I can give this an API design review 🎉

[provokateurin]

Uh ok I made the tests unhappy, can you fix that for me?

[provokateurin]

Now you should take a look if everything is to your liking and change anything you want

To be more precise: I had to change some of your type declarations to match the real code. Please check that everything you want to have exposed through the API is as intended (both missing information and too much information e.g. for security).

[Chartman123]

Thank you very much 😇 I'll have a look at it tomorrow or on the weekend.

[Chartman123]

@provokateurin I was able to fix the unit tests (switched back to associative array in Question.php). Now there's only one error left in the integration tests, that might be related to this \stdClass / array thing for the extraSettings...

{
  "reqId": "MjuGvNE73yn63SvGLLMK",
  "level": 3,
  "time": "2024-11-04T22:25:29+00:00",
  "remoteAddr": "192.168.1.132",
  "user": "admin",
  "app": "no app in context",
  "method": "POST",
  "url": "/nextcloud/ocs/v2.php/apps/forms/api/v3/forms/148/submissions",
  "message": "Cannot use object of type stdClass as array in file '/home/chris/workspace/Github/forms/lib/Service/SubmissionService.php' line 383",
  "userAgent": "Mozilla/5.0 (X11; Linux x86_64; rv:131.0) Gecko/20100101 Firefox/131.0",
  "version": "30.0.1.2",
  "exception": {
    "Exception": "Exception",
    "Message": "Cannot use object of type stdClass as array in file '/home/chris/workspace/Github/forms/lib/Service/SubmissionService.php' line 383",
    "Code": 0,
    "Trace": [
      {
        "file": "/srv/www/htdocs/nextcloud/lib/private/AppFramework/App.php",
        "line": 161,
        "function": "dispatch",
        "class": "OC\\AppFramework\\Http\\Dispatcher",
        "type": "->"
      },
      {
        "file": "/srv/www/htdocs/nextcloud/lib/private/Route/Router.php",
        "line": 302,
        "function": "main",
        "class": "OC\\AppFramework\\App",
        "type": "::"
      },
      {
        "file": "/srv/www/htdocs/nextcloud/ocs/v1.php",
        "line": 43,
        "function": "match",
        "class": "OC\\Route\\Router",
        "type": "->"
      },
      {
        "file": "/srv/www/htdocs/nextcloud/ocs/v2.php",
        "line": 7,
        "args": [
          "/srv/www/htdocs/nextcloud/ocs/v1.php"
        ],
        "function": "require_once"
      }
    ],
    "File": "/srv/www/htdocs/nextcloud/lib/private/AppFramework/Http/Dispatcher.php",
    "Line": 146,
    "Previous": {
      "Exception": "Error",
      "Message": "Cannot use object of type stdClass as array",
      "Code": 0,
      "Trace": [
        {
          "file": "/home/chris/workspace/Github/forms/lib/Controller/ApiController.php",
          "line": 1254,
          "function": "validateSubmission",
          "class": "OCA\\Forms\\Service\\SubmissionService",
          "type": "->"
        },
        {
          "file": "/srv/www/htdocs/nextcloud/lib/private/AppFramework/Http/Dispatcher.php",
          "line": 208,
          "function": "newSubmission",
          "class": "OCA\\Forms\\Controller\\ApiController",
          "type": "->"
        },
        {
          "file": "/srv/www/htdocs/nextcloud/lib/private/AppFramework/Http/Dispatcher.php",
          "line": 114,
          "function": "executeController",
          "class": "OC\\AppFramework\\Http\\Dispatcher",
          "type": "->"
        },
        {
          "file": "/srv/www/htdocs/nextcloud/lib/private/AppFramework/App.php",
          "line": 161,
          "function": "dispatch",
          "class": "OC\\AppFramework\\Http\\Dispatcher",
          "type": "->"
        },
        {
          "file": "/srv/www/htdocs/nextcloud/lib/private/Route/Router.php",
          "line": 302,
          "function": "main",
          "class": "OC\\AppFramework\\App",
          "type": "::"
        },
        {
          "file": "/srv/www/htdocs/nextcloud/ocs/v1.php",
          "line": 43,
          "function": "match",
          "class": "OC\\Route\\Router",
          "type": "->"
        },
        {
          "file": "/srv/www/htdocs/nextcloud/ocs/v2.php",
          "line": 7,
          "args": [
            "/srv/www/htdocs/nextcloud/ocs/v1.php"
          ],
          "function": "require_once"
        }
      ],
      "File": "/home/chris/workspace/Github/forms/lib/Service/SubmissionService.php",
      "Line": 383
    },
    "message": "Cannot use object of type stdClass as array in file '/home/chris/workspace/Github/forms/lib/Service/SubmissionService.php' line 383",
    "exception": [],
    "CustomMessage": "Cannot use object of type stdClass as array in file '/home/chris/workspace/Github/forms/lib/Service/SubmissionService.php' line 383"
  },
  "id": "67294e0e3a54b"
}

[provokateurin]

I'll take a look. I think my mistake was to do the conversion too early, it should only take place in the Controllers.

[provokateurin]

Hi, I just wanted to say that I haven't forgotten this PR.
I was busy with other tasks and didn't work last week.
I hope I come around to this again this week.

[Chartman123]

Hi, I just wanted to say that I haven't forgotten this PR. I was busy with other tasks and didn't work last week. I hope I come around to this again this week.

Everything fine, I also don't have much time at the moment :)