[java][okhttp-gson] fix: JSON deserialization fallback for String return types
#22498
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 change is a follow-up to #21115, the fix for kubernetes-client/java#4020.
The original change switched deserialization to be InputStream-based, which no longer
falls back to returning the raw
StringonJsonParseExceptionwhen the return typeis
String.class:openapi-generator/modules/openapi-generator/src/main/resources/Java/libraries/okhttp-gson/JSON.mustache
Lines 193 to 201 in 2c7efda
We cannot implement the same fallback for InputStream-based deserialization because an
InputStream can only be consumed once. If JSON parsing fails, we cannot
rewind the stream to return the raw content.
Fix:
In
ApiClient, check the return type before choosing the deserialization path. If it isString.class, use String-basedJSON.deserialize(String, Type)with fallback behavior. For all other types, use the InputStream-basedJSON.deserialize(InputStream, Type)for streaming which supports responses > 2GB.This preserves backward compatibility for the fallback behavior - when JSON parsing fails and the return type is
String.class, the raw response body is returned as a String instead of throwingJsonParseException.PR checklist
Commit all changed files.
This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
These must match the expectations made by your contribution.
You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example
./bin/generate-samples.sh bin/configs/java*.IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
master(upcoming7.x.0minor release - breaking changes with fallbacks),8.0.x(breaking changes without fallbacks)"fixes #123"present in the PR description)