Skip to content

[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

Open
wants to merge 10 commits into
base: master
Choose a base branch
from

Conversation

matthewnitschke-wk
Copy link

@matthewnitschke-wk matthewnitschke-wk commented Jun 4, 2025

Summary

Using the dart-dio generator against a response of type:string, format:binary, would result in a MultipartFile return type. This causes the deserialize function to fail.

This PR takes inspiration from the built_value serialization method by treating response file types as Uint8List

Closes #20682

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package || exit
    ./bin/generate-samples.sh ./bin/configs/*.yaml || exit
    ./bin/utils/export_docs_generators.sh || exit
    
    (For Windows users, please run the script in WSL)
    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.
  • File the PR against the correct branch: master (upcoming 7.x.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.
    …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)

Comment on lines +673 to +682
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";
}
}
Copy link
Author

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

@matthewnitschke-wk matthewnitschke-wk marked this pull request as ready for review June 4, 2025 21:13
@matthewnitschke-wk
Copy link
Author

@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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[BUG][DART-DIO] Generation of response with content type 'application/octet-stream' returns 'MultipartFile' instead of 'Stream<Unit8List>'
2 participants