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

[Issue 9685] Make RestTemplate thread safe by using the withHttpInfo pattern used … #9737

Merged
merged 3 commits into from
Oct 3, 2019

Conversation

thomasJoei
Copy link
Contributor

…by many other generated clients

PR checklist

  • Read the contribution guidelines.
  • Ran the shell script under ./bin/ to update Petstore sample so that CIs can verify the change. (For instance, only need to run ./bin/{LANG}-petstore.sh and ./bin/security/{LANG}-petstore.sh if updating the {LANG} (e.g. php, ruby, python, etc) code generator or {LANG} client's mustache templates). Windows batch files can be found in .\bin\windows\.
  • Filed the PR against the correct branch: 3.0.0 branch for changes related to OpenAPI spec 3.0. Default: master.
  • Copied the technical committee to review the pull request if your PR is targeting a particular programming language.

Description of the PR

This PR is to make the generated RestTemplate client thread safe. Currently, we don't have any way of retrieving the response headers except by using getResponseHeaders() method which returns the latest response headers, in the case multiple threads use the ApiClient we might end up getting the headers of the response sent to another thread.

This PR purpose is to add an additional method which not only return the expected DTO but also the ResponseEntity wrapping it, so user can easily retrieve headers by inspecting the ResponseEntity. The usual methods to directly get the DTO are conserved.

This change breaks backward compatibility since (thread unsafe) attributes, statusCode and responseHeaders, are removed from ApiClient class.

Fixes: #9685, #9222

PR mostly inspired by @tsiq-karold work on Jersey2 (#7605), and withHttpInfo pattern used in other generated clients.

@HugoMario
Copy link
Contributor

LGTM, thanks a lot @thomasJoei !!!

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.

Swagger CodeGen APIClient.java not returning the headers from the rest response by calling resttemplate
2 participants