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

[Java] Refactor webClient generator to use URI templates to capture correct metrics #4314

Merged
merged 2 commits into from
Nov 12, 2019

Conversation

atsharp
Copy link
Contributor

@atsharp atsharp commented Oct 29, 2019

Spring supports automatic instrumentation of WebClient and RestTemplate to capture metrics when using injected clients. When instrumenting these HTTP clients, a URI template must be provided to properly group parameterized HTTP requests. For example, given a URI /resources/{id}, metrics should be captured under /resources/{id} instead of/resources/1234/resources/4321/etc.

Currently, the OpenAPI generated RestTemplate clients use RestTemplate.getUriTemplateHandler, which can capture URI templates and resolve metrics appropriately. However, WebClient based templates render paths as Strings directly, which erases the template and results in incorrect metric instrumentation:

String path = UriComponentsBuilder.fromPath("{{{path}}}"){{#hasPathParams}}.buildAndExpand(uriVariables){{/hasPathParams}}{{^hasPathParams}}.build(){{/hasPathParams}}.toUriString();

Refactoring the WebClient generated clients to use WebClient.UriSpec.uri(String, Map<String, Object> will capture URI templates and enable appropriate metric collection.

Note that the URI string provided to UriSpec.uri(String, Map) is rendered as a template using UriComponentsBuilder.encode which was introduced in spring-webflux 5.0.8.RELEASE, and thus, requires a minor version increase.

Note that this approach is similar to that of 4299 but is less invasive.

CC: @bbdouglas @sreeshas @jfiala @lukoyanov @cbornet @jeff9finger @karismann @Zomzog

PR checklist

  • Read the contribution guidelines.
  • If contributing template-only or documentation-only changes which will change sample output, build the project before.
  • Run the shell script(s) under ./bin/ (or Windows batch scripts under.\bin\windows) to update Petstore samples related to your fix. This is important, as CI jobs will verify all generator outputs of your HEAD commit, and these must match the expectations made by your contribution. You only need to run ./bin/{LANG}-petstore.sh, ./bin/openapi3/{LANG}-petstore.sh if updating the code or mustache templates for a language ({LANG}) (e.g. php, ruby, python, etc).
  • File the PR against the correct branch: master, 4.1.x, 5.0.x. Default: master.
  • Copy the technical committee to review the pull request if your PR is targeting a particular programming language.

Copy link
Member

@wing328 wing328 left a comment

Choose a reason for hiding this comment

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

Thanks for the enhancement, which looks good to me.

@wing328 wing328 merged commit 9ceabc7 into OpenAPITools:master Nov 12, 2019
jimschubert added a commit that referenced this pull request Nov 13, 2019
* master:
  [csharp-netcore] Propagate raw content to the ApiException error content. (#4381)
  Remove path relative to my home dir. (#4470)
  Avoid generating uncompilable response body in Spring's API template (#2903)
  cpp-qt5-client: remove host since it is not well handled (#4429)
  [Java] Refactor webClient generator to use URI templates to capture correct metrics (#4314)
  [Java]: Client resttemplate and webclient: array parameters of type integer in path badly generated (#4379)
  Dart generate keywords (#4449)
  [core] Fix system properties being immutable (#4447)
  [Kotlin][Client] minor improvements (#4419)
  [typescript-rxjs]: Add support for nullable (#4438)
  [asciidoc] fix names of parameters (#4440)
@wing328
Copy link
Member

wing328 commented Nov 15, 2019

@atsharp thanks for the PR, which has been included in the v4.2.1 release: https://twitter.com/oas_generator/status/1195339336922759168

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.

2 participants