Skip to content

[Java] [vertx] Allow PoolOptions configuration when vertx 5#23829

Open
RickyRister wants to merge 1 commit into
OpenAPITools:masterfrom
RickyRister:vertx5-pooloptions
Open

[Java] [vertx] Allow PoolOptions configuration when vertx 5#23829
RickyRister wants to merge 1 commit into
OpenAPITools:masterfrom
RickyRister:vertx5-pooloptions

Conversation

@RickyRister
Copy link
Copy Markdown
Contributor

@RickyRister RickyRister commented May 20, 2026

Closes #23828

When useVertx5 is enabled, the ApiClient will have an additional poolConfig field. That field is for storing the json that will eventually be mapped to the PoolOptions that is passed into the WebClient factory method alongside the WebClientOptions.

We still generate a ApiClient constructor with two params (which will just forward to the main constructor, passing an empty json for the poolConfig) to maintain backwards compatibility.

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 solves a reported issue, reference it using GitHub's linking syntax (e.g., having "fixes #123" present in the PR description)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

Summary by cubic

Adds configurable connection pool support for Vert.x 5 by introducing a poolConfig JSON in ApiClient and passing it to WebClient.create as PoolOptions. Closes #23828.

  • New Features
    • When useVertx5 is enabled, ApiClient includes a poolConfig field used to build PoolOptions.
    • Added ApiClient(Vertx, JsonObject, JsonObject); the existing 2-arg constructor forwards with an empty JSON to keep compatibility.
    • WebClient is now created with both WebClientOptions and PoolOptions derived from poolConfig.

Written for commit bc890da. Summary will update on new commits. Review in cubic

@RickyRister
Copy link
Copy Markdown
Contributor Author

@bbdouglas (2017/07) @sreeshas (2017/08) @jfiala (2017/08) @lukoyanov (2017/09) @cbornet (2017/09) @jeff9finger (2018/01) @karismann (2019/03) @Zomzog (2019/04) @lwlee2608 (2019/10) @martin-mfg (2023/08)

Copy link
Copy Markdown
Contributor

@cubic-dev-ai cubic-dev-ai Bot left a comment

Choose a reason for hiding this comment

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

1 issue found across 3 files

Prompt for AI agents (unresolved issues)

Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.


<file name="samples/client/petstore/java/vertx5-supportVertxFuture/src/main/java/org/openapitools/client/ApiClient.java">

<violation number="1" location="samples/client/petstore/java/vertx5-supportVertxFuture/src/main/java/org/openapitools/client/ApiClient.java:661">
P2: Changing the protected `buildWebClient` hook from 2 args to 3 args breaks downstream overrides and can silently drop custom WebClient configuration.</violation>
</file>

Reply with feedback, questions, or to request a fix.

Re-trigger cubic

* @return WebClient
*/
protected WebClient buildWebClient(Vertx vertx, JsonObject config) {
protected WebClient buildWebClient(Vertx vertx, JsonObject config, JsonObject poolConfig) {
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

P2: Changing the protected buildWebClient hook from 2 args to 3 args breaks downstream overrides and can silently drop custom WebClient configuration.

Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At samples/client/petstore/java/vertx5-supportVertxFuture/src/main/java/org/openapitools/client/ApiClient.java, line 661:

<comment>Changing the protected `buildWebClient` hook from 2 args to 3 args breaks downstream overrides and can silently drop custom WebClient configuration.</comment>

<file context>
@@ -650,13 +658,13 @@ protected <T> Handler<AsyncResult<HttpResponse<Buffer>>> buildResponseHandler(Ty
      * @return WebClient
      */
-    protected WebClient buildWebClient(Vertx vertx, JsonObject config) {
+    protected WebClient buildWebClient(Vertx vertx, JsonObject config, JsonObject poolConfig) {
 
         if (!config.containsKey("userAgent")) {
</file context>

@wing328
Copy link
Copy Markdown
Member

wing328 commented May 20, 2026

thanks for the PR

cc @sjw2547 who added vertx 5 support

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] [Java] [vertx] Cannot configure PoolOptions in vertx 5

2 participants