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

[RUST-AXUM] fix generator not handling application/x-www-form-urlencoded request content #18061

Merged
merged 5 commits into from
Mar 12, 2024

Conversation

denisbog
Copy link
Contributor

@denisbog denisbog commented Mar 8, 2024

to fix #18060

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 
    ./bin/generate-samples.sh ./bin/configs/*.yaml
    ./bin/utils/export_docs_generators.sh
    
    (For Windows users, please run the script in Git BASH)
    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.1.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.

if (requestBody != null) {
String contentType = getContentType(requestBody);
if (contentType != null) {
contentType = contentType.toLowerCase(Locale.ROOT);
}
if (contentType != null &&
if (!handleFormContent && contentType != null &&
Copy link
Member

Choose a reason for hiding this comment

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

can you please elaborate more on this change?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

this is a new flag to disable the logic on how the form params are being handled, currently the body is being consumed and all identified form params extracted, in this branch bodyParam is not being set which is required by the axum template:

openapi-generator/modules/openapi-generator/src/main/resources/rust-axum/server-operation.mustache

  {{#bodyParam}}
    {{#vendorExtensions}}
      {{#x-consumes-json}}
          Json(body): Json<{{^required}}Option<{{/required}}{{{dataType}}}{{^required}}>{{/required}}>,
      {{/x-consumes-json}}
      {{#x-consumes-form-urlencoded}}
          Form(body): Form<{{^required}}Option<{{/required}}{{{dataType}}}{{^required}}>{{/required}}>,
      {{/x-consumes-form-urlencoded}}

axum can deserialize form params from the body

https://docs.rs/axum/latest/axum/struct.Form.html

Copy link
Member

@wing328 wing328 Mar 9, 2024

Choose a reason for hiding this comment

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

I prefer using !(this instanceof RustAxumServerCodegen) to make it much easier to understand this logic is tailor-made for the RustAxumServerCodegen instead of adding another option/flag

Copy link
Contributor Author

Choose a reason for hiding this comment

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

it does work, however this to me looks that we create a dependency to more specialized class inside the generic one (since we have to import RustAxumServerCodegen)

but I see that similar was done before.

import org.openapitools.codegen.languages.PhpNextgenClientCodegen;
import org.openapitools.codegen.languages.RustAxumServerCodegen; // new import
import org.openapitools.codegen.languages.RustServerCodegen;

@wing328
Copy link
Member

wing328 commented Mar 9, 2024

cc @linxGnu

@wing328 wing328 added this to the 7.4.0 milestone Mar 9, 2024
@wing328
Copy link
Member

wing328 commented Mar 11, 2024

https://github.com/OpenAPITools/openapi-generator/actions/runs/8215440138/job/22492223594?pr=18061

that's fixed in the latest master so it can be ignored

@wing328 wing328 changed the title fix for #18060 [RUST-AXUM] fix generator not handling application/x-www-form-urlencoded request content Mar 11, 2024
@wing328 wing328 modified the milestones: 7.4.0, 7.5.0 Mar 11, 2024
@wing328
Copy link
Member

wing328 commented Mar 11, 2024

@linxGnu are you happy with this change?

@linxGnu
Copy link
Contributor

linxGnu commented Mar 12, 2024

@wing328 LGTM for the changes

@wing328 wing328 merged commit 6251aa1 into OpenAPITools:master Mar 12, 2024
13 of 14 checks passed
linxGnu added a commit to linxGnu/openapi-generator that referenced this pull request Apr 11, 2024
@linxGnu linxGnu mentioned this pull request Apr 11, 2024
5 tasks
wing328 pushed a commit that referenced this pull request Apr 11, 2024
wing328 pushed a commit that referenced this pull request Apr 18, 2024
…oded request content, update for initial fix #18061  (#18362)

* fix #18060

* isolate the option as separate flag

* apply modification suggested by @wing328

* remove added newlines

* do not change the handle of multipart body, keep the change only for x-www-form-urlencoded
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][RUST-AXUM] generator does not handle application/x-www-form-urlencoded request content
3 participants