Support for removing JSON attributes from response bodies in MVC #3777
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
raccoonback
force-pushed
the
support-json-field-removal-filter-in-mvc
branch
from
736a0b8 to
5903a10
Compare
raccoonback
commented
Apr 22, 2025
Comment on lines
+183
to
+192
| try { | ||
| JsonNode jsonBodyContent = OBJECT_MAPPER.readValue(responseBody, JsonNode.class); | ||
|
|
||
| removeJsonAttributes(jsonBodyContent, immutableFieldList, deleteRecursively); | ||
|
|
||
| responseBody = OBJECT_MAPPER.writeValueAsString(jsonBodyContent); | ||
| } | ||
| catch (JsonProcessingException exception) { | ||
| throw new IllegalStateException("Failed to process JSON of response body.", exception); | ||
| } |
There was a problem hiding this comment.
Remove a specific attribute based on a JsonNode.
|
|
||
| return modifyResponseBody(String.class, String.class, APPLICATION_JSON_VALUE, (request, response, body) -> { | ||
| String responseBody = body; | ||
| if (APPLICATION_JSON.isCompatibleWith(response.headers().getContentType())) { |
There was a problem hiding this comment.
Only process when the content-type is application/json.
Comment on lines
+203
to
+205
| if (deleteRecursively) { | ||
| jsonNode.forEach(childNode -> removeJsonAttributes(childNode, fieldNames, true)); | ||
| } |
There was a problem hiding this comment.
If nested attributes also need to be removed, handle them recursively.
ryanjbaxter
reviewed
May 12, 2025
| responseBody = OBJECT_MAPPER.writeValueAsString(jsonBodyContent); | ||
| } | ||
| catch (JsonProcessingException exception) { | ||
| throw new IllegalStateException("Failed to process JSON of response body.", exception); |
There was a problem hiding this comment.
What will happen if this exception is not handled in the configuration as you do in the test?
There was a problem hiding this comment.
If the global exception is not handled as in the test configuration, the request will not be routed to a specific handler.
Instead, the DispatcherServlet will forward the request to the /error path for default error handling.
raccoonback
force-pushed
the
support-json-field-removal-filter-in-mvc
branch
from
5903a10 to
9ba0e65
Compare
Signed-off-by: raccoonback <[email protected]>
|
@ryanjbaxter I've changed the target to the 4.2.x branch. |
raccoonback
force-pushed
the
support-json-field-removal-filter-in-mvc
branch
from
9ba0e65 to
77dd818
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Motivation
This PR adds support for filtering out specific JSON attributes from response bodies in Spring MVC, extending functionality previously available only in WebFlux.
Changes