Skip to content

[BUG][dart-dio]: EnumClass conflict when using 'name' in a enum component #20911

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

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

Conversation

epou
Copy link
Contributor

@epou epou commented Mar 17, 2025

Fixes #20910

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.

@jaumard (2018/09) @josh-burton (2019/12) @amondnet (2019/12) @sbu-WBT (2020/12) @kuhnroyal (2020/12) @agilob (2020/12) @ahmednfwela (2021/08)

@epou
Copy link
Contributor Author

epou commented Mar 17, 2025

I was having doubts about implementing the fix by changing the mustache code, so all the enum options are treated the same or overriding the java code to only target those enum values that are equal to name:

In file: modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/DartDioClientCodegen.java

    @Override
    public String toEnumVarName(String value, String datatype) {
         String name = super.toEnumVarName(value, datatype);

         // Fix for Dart (using built_value):
         // The issue is caused by using "name" as an enum value name,
         // which conflicts with the built-in "name" property of EnumClass.
         if (SERIALIZATION_LIBRARY_BUILT_VALUE.equals(library) && "name".equals(name)) {
             name = name + "Attr";
         }
         return name;
     }

I see goods and bads for each option. I'd love to hear opinions

@wing328
Copy link
Member

wing328 commented Mar 26, 2025

thanks for the PR

can you please pm me via Slack when you've time to discuss this?

https://join.slack.com/t/openapi-generator/shared_invite/zt-2wmkn4s8g-n19PJ99Y6Vei74WMUIehQA

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][dart-dio]: EnumClass conflict when using 'name' in a enum component
2 participants