Skip to content

fix: update axum generated multipart requests to own the body#21301

Merged
wing328 merged 6 commits intoOpenAPITools:masterfrom
AlexandreCassagne:fix-axum-multipart-lifetime
May 31, 2025
Merged

fix: update axum generated multipart requests to own the body#21301
wing328 merged 6 commits intoOpenAPITools:masterfrom
AlexandreCassagne:fix-axum-multipart-lifetime

Conversation

@AlexandreCassagne
Copy link
Copy Markdown
Contributor

@AlexandreCassagne AlexandreCassagne commented May 19, 2025

This PR updates axum multipart requests (multipart and multipart-related) to give ownership of the multipart request contents to the application.

The following method on Multipart highlights the need:

pub async fn next_field(&mut self) -> Result<Option<Field<'_>>, MultipartError>

it requires &mut on the multipart argument to allow reading its contents.

In axum documentation, multipart requests are implemented with full ownership (https://docs.rs/axum/latest/axum/extract/struct.Multipart.html).

Taken from the above link, please note the order of parameters is important:

⚠️ Since extracting multipart form data from the request requires consuming the body, the Multipart extractor must be last if there are multiple extractors in a handler. See "the order of extractors"

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 is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

… Body

Notes: &Multipart cannot access fields, as we need mutable access.
@wing328
Copy link
Copy Markdown
Member

wing328 commented May 19, 2025

thanks for the PR

please run ./bin/generate-samples.sh ./bin/configs/manual/rust-axum-* (using WSL if you're using Windows) to update the samples

@AlexandreCassagne
Copy link
Copy Markdown
Contributor Author

@wing328 done, will push. Is there a test that will check that the servers compile and/or successfully produce multipart?

@AlexandreCassagne
Copy link
Copy Markdown
Contributor Author

Notes: Ran
   ./mvnw clean package || exit
   ./bin/generate-samples.sh
   ./bin/configs/*.yaml || exit
   ./bin/utils/export_docs_generators.sh || exit
Notes: Multipart should be owned; normal request remains borrowed
@wing328
Copy link
Copy Markdown
Member

wing328 commented May 19, 2025

@@ -1 +1 @@
7.13.0-SNAPSHOT
7.12.0-SNAPSHOT
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

can you please merge the latest master (upstream official) to your branch, build the CLI JAR locally and regenerate the samples again?

@wing328
Copy link
Copy Markdown
Member

wing328 commented May 20, 2025

thanks for the PR

cc @linxGnu

@AlexandreCassagne
Copy link
Copy Markdown
Contributor Author

@wing328 can anyone other than @linxGnu review if not available?

@wing328 wing328 added this to the 7.14.0 milestone May 31, 2025
@wing328
Copy link
Copy Markdown
Member

wing328 commented May 31, 2025

let's give it a try

thanks again for the PR

@wing328 wing328 merged commit 1f8787e into OpenAPITools:master May 31, 2025
19 checks passed
@linxGnu
Copy link
Copy Markdown
Contributor

linxGnu commented Jun 2, 2025

Sorry for late reply due to urgent project at my full-time job.

The PR LGTM. Also fyi @Victoria-Casasampere-BeeTheData about the changes

@AlexandreCassagne
Copy link
Copy Markdown
Contributor Author

@wing328 am I missing something, or is this MR merged but not showing up in newer versions?

@linxGnu
Copy link
Copy Markdown
Contributor

linxGnu commented Jan 7, 2026

@AlexandreCassagne

Seem like there are changes between. Would you mind to make a PR to fix this (or I can make a PR on your behalf)?

Latest Commit (in master branch) already included your changes:

{{#x-consumes-multipart}}
    body: Multipart,
    {{/x-consumes-multipart}}
    {{#x-consumes-multipart-related}}
    body: axum::body::Body,

@linxGnu
Copy link
Copy Markdown
Contributor

linxGnu commented Jan 7, 2026

@AlexandreCassagne

In the meantime, you can use this feature flag as well: openapi-generator generate .... --additional-properties ownedRequest=true

@AlexandreCassagne
Copy link
Copy Markdown
Contributor Author

@AlexandreCassagne

Seem like there are changes between. Would you mind to make a PR to fix this (or I can make a PR on your behalf)?

Latest Commit (in master branch) already included your changes:

{{#x-consumes-multipart}}
    body: Multipart,
    {{/x-consumes-multipart}}
    {{#x-consumes-multipart-related}}
    body: axum::body::Body,

Hey @linxGnu, I'm not sure I understand what the issue is, would you mind raising the PR and tagging me there?

Thanks!

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.

3 participants