Skip to content

feat(rust-server): refactor server module templates to avoid a monolithic run function.#23432

Merged
wing328 merged 2 commits intoOpenAPITools:masterfrom
dsteeley:refactor-rust-server-server
Apr 13, 2026
Merged

feat(rust-server): refactor server module templates to avoid a monolithic run function.#23432
wing328 merged 2 commits intoOpenAPITools:masterfrom
dsteeley:refactor-rust-server-server

Conversation

@dsteeley
Copy link
Copy Markdown
Contributor

@dsteeley dsteeley commented Apr 2, 2026

This PR address a potential issue with the rust-server generator for large APIs where the compilation hits an OOM error in small container images. By refactoring the server dispatches we remove the monolithic function and this means Cargo doesn't OOM.

Tested locally with my large API that generating with the new templates doesn't result in an OOM error.

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

Refactors the rust-server generator to split the monolithic run() into per-operation handler functions for servers and callbacks, reducing compile-time memory and preventing rustc OOMs on large APIs. Also guards against duplicate handler names when operationIds collide after snake_case normalization.

  • Refactors

    • Added server-operation-handler.mustache to generate async fn handle_<operation>() per operation; server-operation.mustache now dispatches to them.
    • Generated per-operation handlers for callback routes in client-callbacks.mustache.
    • Deduplicated per-operation IDs across tags to avoid name collisions; added a test spec (duplicate-operation-id.yaml).
    • Regenerated Rust server samples to reflect the new structure.
  • Migration

    • No public API changes to generated code; existing implementations compile without changes.
    • No configuration or dependency updates required (hyper usage and behavior remain the same).

Written for commit 3e8baaf. Summary will update on new commits.

@dsteeley dsteeley marked this pull request as ready for review April 8, 2026 15:25
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 15 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="modules/openapi-generator/src/main/resources/rust-server/server-operation-handler.mustache">

<violation number="1" location="modules/openapi-generator/src/main/resources/rust-server/server-operation-handler.mustache:223">
P2: Validation call is compiled only when `validate` feature is disabled, so validation logic never runs in validate builds.</violation>
</file>

Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.

@wing328 wing328 merged commit 16342ee into OpenAPITools:master Apr 13, 2026
19 checks passed
@wing328 wing328 added Server: Rust Enhancement: Code Cleanup General refactoring, removal of deprecated things, commenting, etc. labels Apr 13, 2026
@wing328 wing328 added this to the 7.22.0 milestone Apr 13, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Enhancement: Code Cleanup General refactoring, removal of deprecated things, commenting, etc. Server: Rust

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants