[12.x] feat: Support custom response without modifying the exception handler #57342
+46
−3
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR changes
Handler::prepareJsonResponse()
to useresponse()->json()
instead ofnew JsonResponse()
directly, ensuring consistency when developers customize theResponseFactory
.Problem
When developers extend
ResponseFactory
to customize JSON response behavior (e.g., adding custom headers, wrapping response data, or using a customJsonResponse
subclass), the customization applies everywhere EXCEPT in exception responses, becauseHandler::prepareJsonResponse()
directly instantiatesJsonResponse
.Solution
We have 3 ways to maintain consistency.
prepareJsonResponse
support callback like theshouldReturnJson
methodUse the
response()->json()
helper, which respects customResponseFactory
implementations.For example, we customized the JSON response like this:
Before PR, the exception response:
We can see that did not use our customized JSON format.
After PR: