-
-
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
base: master
Are you sure you want to change the base?
Conversation
…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.
|
ab87592
to
6bb4f1a
Compare
// in order to avoid name conflicts, we map parameters inside the functions | ||
String in_function_identifier = ""; | ||
if (this.useSingleRequestParameter) { | ||
in_function_identifier = "params." + parameter.paramName; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
can we rename in_function_identifier
to inFunctionIdentifier
instead to conform to java variable naming convention?
serde_json::from_str(&local_var_content).map_err(Error::from) | ||
if !status.is_client_error() && !status.is_server_error() { | ||
let content = resp.text()?; | ||
serde_json::from_str(&content).map_err(Error::from) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
what about adding a fake endpoint with the parameter content
to the test spec to ensure the change works as expected?
test spec: modules/openapi-generator/src/test/resources/3_0/rust/petstore.yaml
an example of fake endpoint: https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator/src/test/resources/3_0/rust/petstore.yaml#L585
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)