-
-
Notifications
You must be signed in to change notification settings - Fork 6.7k
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] harden against name collisions while generate cleaner rust code, fix #20337 #20396
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
5 tasks
|
ab87592
to
6bb4f1a
Compare
wing328
reviewed
Jan 4, 2025
...es/openapi-generator/src/main/java/org/openapitools/codegen/languages/RustClientCodegen.java
Outdated
Show resolved
Hide resolved
wing328
reviewed
Jan 5, 2025
samples/client/others/rust/reqwest/composed-oneof/src/apis/default_api.rs
Show resolved
Hide resolved
please follow step 3 to update the samples after add a fake parameter |
…ay they CANNOT clash with anything locally, as our hardcoded stuff in mustache files doesnt start with "p_" , when using the grouped option, we just use the params directly and dont unpack the variables at all, prevending furthur name clashes.
b639362
to
c3c117f
Compare
c3c117f
to
7bc1e4c
Compare
thanks again for the PR. all tests passed. |
mikefaille
pushed a commit
to mikefaille/openapi-generator
that referenced
this pull request
Jan 14, 2025
fix OpenAPITools#20337 (OpenAPITools#20396) * prevent all name clashes by using a prefix for all parameters, this way they CANNOT clash with anything locally, as our hardcoded stuff in mustache files doesnt start with "p_" , when using the grouped option, we just use the params directly and dont unpack the variables at all, prevending furthur name clashes. * get rid of "local_var" prefix, now that we no longer clash with paramater names * fix a typo and remove the r# generated to the paramName when we create the identifier * java code formatting and added a fake-endpoint parameter test * update rust samples
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This change adjust the generated rust code to be less prone to name collisions, by actually escaping the user-data instead of having a
local_var_
prefix (see #20337 for details).It uses the vendor extensions, so specific names can also be overwritten (if needed).
It also gets rid of the naming problems in a whole for grouped parameters because it gets rid of the "unbox" in the template.
The change will modify code generated with openapi-generator but should not interact with the generated interfaces, thus I think its no breaking change.
No extra tests where added and this change should validate if CI passes the integration tests.
[RUST] @frol @farcaller @richardwhiuk @paladinzh @jacob-pro
@wing328
Note: After this PR is merged, future PRs should use
{{{vendorExtensions.x-rust-param-identifier}}}
within theapi.mustache
file if they want to mention the old{{{paramName}}}
PR checklist
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.
master
(upcoming7.x.0
minor release - breaking changes with fallbacks),8.0.x
(breaking changes without fallbacks)