Skip to content
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

[rust] Added support for text/plain to reqwest clients #20643

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

Conversation

ranger-ross
Copy link
Contributor

@ranger-ross ranger-ross commented Feb 11, 2025

I am continuing my quest to improve the Rust Reqwest based clients. :)

This PR adds better content type header handling to the reqwest & reqwest-trait clients.
Specifically it adds support for text/plain when the return type is String. (and better error messages when the return type is not a string, instead of blindly trying and failing to JSON parse non-json responses)

This will fix #20617 , however it will not fix hyper clients and if supportMultipleResponses is true then this approach will also not work.

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 Git BASH)
    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.

cc: @frol @farcaller @richardwhiuk @paladinzh @jacob-pro

Comment on lines +680 to +682
if ("String".equals(operation.returnType)) {
operation.vendorExtensions.put("x-supports-plain-text", Boolean.TRUE);
}
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would not call this a vendor extension since its not meant for the API spec to set x-supports-plain-text.
I just needed a way to set attach some arbitrary metadata to an operation and this was the easiest way that I found to do it.

If there is a better way to do this, please let me know.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

in java client codegen, we've something similar:

if ("text/plain".equalsIgnoreCase(produce.get("mediaType").split(";")[0].trim())

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

if i remember correctly, there was a use case before which the content type is application/json and the return type is string (e.g. "something here") so I think we will need to check the content type (produce) as well

Comment on lines +148 to +154
if content_type.starts_with("application") && content_type.contains("json") {
return Self::Json;
} else if content_type.starts_with("text/plain") {
return Self::Text;
} else {
return Self::Unsupported(content_type.to_string());
}
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The rational for this logic is to be able to support both custom JSON variants and charset extensions.

  • application/json
  • application/vnd.github+json
  • application/json; charset=utf-8
  • application/vnd.github+json; charset=utf-8

as well as

  • text/plain
  • text/plain; charset=utf-8

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

Successfully merging this pull request may close these issues.

[BUG] [Rust] Text/plain response interpreted as json, causing error
2 participants