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] harden against name collisions while generate cleaner rust code, fix #20337 #20396

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

xMAC94x
Copy link

@xMAC94x xMAC94x commented Jan 2, 2025

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 the api.mustache file if they want to mention the old {{{paramName}}}

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 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.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.

…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.
@imaami
Copy link
Contributor

imaami commented Jan 2, 2025

VENDOR_EXTENTION_PARAM_IDENTIFIER seems like a typo, shouldn't it be VENDOR_EXTENSION_PARAM_IDENTIFIER?

// 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;
Copy link
Member

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?

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