Fix API returning HTML error pages when user sends invalid JSON

[poikilotherm]

What this PR does / why we need it:

Ensure any JSON parsing errors do not result in HTML error pages.

Which issue(s) this PR closes:

• Closes Malformed JSON input to multiple API endpoints returns HTTP 500 HTML instead of HTTP 400 JSON error #11717

Special notes for your reviewer:

1. Let me know if GSON, Jackson etc should be added to the list of implementations.
2. Let me know if there should be a line in the API changelog about this. It affects a lot of API endpoints.

Suggestions on how to test this:
I added an API test with one of the affected endpoints. Just execute the test before applying the patches and after.

I also wanted to fix the catchall error handler I tried to implement some time ago. For that, I had to modify the logging in the JsonResponseBuilder. The situation where sending invalid JSON to the endpoints results in a HTML response was not reproducible for me. Please test again!

Here's how a response looks like when not applying the JSON error handler, but with the fix for the logging:

$ http POST http://localhost:8080/api/admin/bannerMessage --raw="{test}"
HTTP/1.1 500 Internal Server Error
Connection: close
Content-Length: 284
Content-Type: application/json;charset=UTF-8
Server: Payara Server 6.2025.3 #badassfish
X-Frame-Options: SAMEORIGIN
X-Powered-By: Servlet/6.0 JSP/3.1 (Payara Server 6.2025.3 #badassfish Java/Eclipse Adoptium/17)

{
    "code": 500,
    "incidentId": "5cbfad8c-4a7a-4faf-8470-42c684da9721",
    "interalError": "JsonParsingException",
    "message": "Internal server error. More details available at the server logs.",
    "requestMethod": "POST",
    "requestUrl": "http://localhost:8080/api/v1/admin/bannerMessage",
    "status": "ERROR"
}

With the JSON error handler, this is now an error 400 (as it should be), but in case other exceptions bubble up...

An example to test this with the JSON handler in place:

$ http PUT http://localhost:8080/api/admin/settings/test --raw="test"
HTTP/1.1 500 Internal Server Error
Connection: close
Content-Length: 319
Content-Type: application/json;charset=UTF-8
Server: Payara Server 6.2025.3 #badassfish
X-Frame-Options: SAMEORIGIN
X-Powered-By: Servlet/6.0 JSP/3.1 (Payara Server 6.2025.3 #badassfish Java/Eclipse Adoptium/17)

{
    "code": 500,
    "incidentId": "206716ef-f1de-4b5e-9e48-e7ed100f8e4f",
    "interalError": "RollbackException",
    "internalCause": "PersistenceException",
    "message": "Internal server error. More details available at the server logs.",
    "requestMethod": "PUT",
    "requestUrl": "http://localhost:8080/api/v1/admin/settings/test",
    "status": "ERROR"
}

As a curl command, this would be: curl -X PUT -d "test" http://localhost:8080/api/admin/settings/test
Watch the server log! 😄 (BTW I tested this with the Dockerized Dev Instance using mvn -Pct package docker:run)

Does this PR introduce a user interface change? If mockups are available, please link/include them here:
Not within the UI, but of course the API "user interface".

Is there a release notes update needed for this change?:
Maybe?

Additional documentation:
None?

[coveralls]

coverage: 24.232% (-0.001%) from 24.233%
when pulling 67301a3 on 11717-fix-api-errors
into faff4ec on develop.

[stevenwinship]

@poikilotherm Please resolve conflicts

[pdurbin]

@poikilotherm I bumped this to 6.10. Also, please resolve merge conflicts. Thanks!

[poikilotherm]

@pdurbin I made a rebase and force pushed. There were ~300 commits missing, to this is the cleaner fix, avoiding any merge conflicts.

[stevenwinship]

Re: Let me know if GSON, Jackson etc should be added to the list of implementations.
Let me know if there should be a line in the API changelog about this. It affects a lot of API endpoints.

I did some testing with unit tests and IT tests that make calls where Gson reads json. The IT tests returned 400 and appropriate exceptions were returned when invalid json was given. I don't believe we need to make changes here.
Maybe more testing on the QA end can be done

As for the API changelog, I didn't see any mention of an expected 500 for the response. I would say that it's not a change as most people would assume it should return 400.

Approving this pr

[github-actions]

📦 Pushed preview images as

ghcr.io/gdcc/dataverse:11717-fix-api-errors

ghcr.io/gdcc/configbaker:11717-fix-api-errors

🚢 See on GHCR. Use by referencing with full name as printed above, mind the registry name.