-
-
Notifications
You must be signed in to change notification settings - Fork 7.3k
[dart-dio] Fix json_serializable response for type:string format:binary #21379
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[dart-dio] Fix json_serializable response for type:string format:binary #21379
Conversation
| if (SERIALIZATION_LIBRARY_JSON_SERIALIZABLE.equals(library)) { | ||
| // built_value serialization uses Uint8List for all MultipartFile types | ||
| // in json_serialization, MultipartFile is used as the file parameter type, but | ||
| // MultipartFile isn't readable, instead we convert this to a Uin8List | ||
| if (op.isResponseFile) { | ||
| op.imports.add("Uint8List"); | ||
| op.returnType = "Uint8List"; | ||
| op.returnBaseType = "Uint8List"; | ||
| } | ||
| } |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In a previous iteration I implemented the same logic as the built_value serialization method, where both parameter and return types are considered Uint8List
In an effort to keep this change slightly less impactful, I've opted to just change the return type when the response is a file
I'm open to input on this change, whether we want parity with built_value (both parameters and return types are Uint8List) or are ok with what I have here
|
@wing328 Ended up creating a specific test case for this to prevent effecting non-dart-dio generators: bin/configs/dart-dio-binary-response.yaml Can you approve the workflow run so we can see if tests pass? |
|
@jaumard (2018/09) @josh-burton (2019/12) @amondnet (2019/12) @sbu-WBT (2020/12) @kuhnroyal (2020/12) @agilob (2020/12) @ahmednfwela (2021/08) Any thoughts? |
|
@matthewnitschke-wk thanks again for the PR is it correct to say that you've tested this fix locally with your use cases and it's working as expected? |
@wing328 Correct, I've validated that the specific combination of |
|
ok. let's give it a try |
|
thanks again for the PR which has been merged |
Summary
Using the
dart-diogenerator against a response oftype:string,format:binary, would result in aMultipartFilereturn type. This causes thedeserializefunction to fail.This PR takes inspiration from the built_value serialization method by treating response file types as
Uint8ListCloses #20682
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)…ry response types
@jaumard (2018/09) @josh-burton (2019/12) @amondnet (2019/12) @sbu-WBT (2020/12) @kuhnroyal (2020/12) @agilob (2020/12) @ahmednfwela (2021/08)