Skip to content

Fix AbstractJavaCodegen ability to customize container types#13550

Open
dmivankov wants to merge 3 commits into
OpenAPITools:masterfrom
dmivankov:fix_custom_java_types
Open

Fix AbstractJavaCodegen ability to customize container types#13550
dmivankov wants to merge 3 commits into
OpenAPITools:masterfrom
dmivankov:fix_custom_java_types

Conversation

@dmivankov

@dmivankov dmivankov commented Sep 29, 2022

Copy link
Copy Markdown

Fix for #13549

After #5466 java codegen emits Set for array with uniqueItems=true which has its downsides

  • easy to lose track of element order (it can be important)
  • easy to lose ordering by switching between java Set flavors (HashSet vs LinkedHashSet) somewhere down the line
  • bigger divergence from original json types (either array or object)

Luckily types can be customized/overriden by extending the generator:

  • extend JavaClientCodegen for example
  • in constructor do
    super();
    // import/interface type
    typeMapping().put("set", typeMapping().get("array"));
    // concrete type
    instantiationTypes().put("set", instantiationTypes().get("array"));

But sometimes it won't work because of missing ArrayList import, can be fixed by also doing

    // workaround for https://github.com/OpenAPITools/openapi-generator/issues/13549
    // to be fixed in https://github.com/OpenAPITools/openapi-generator/pull/13550
    importMapping().put("LinkedHashSet", importMapping().get("ArrayList"));

Looks like a bug of assuming "set" fields are instantiated with LinkedHashSet,
let's fix it by using type mappings.

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/utils/export_docs_generators.sh
    
    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*.
    For Windows users, please run the script in Git BASH.
  • File the PR against the correct branch: master (6.1.0) (minor release - breaking changes with fallbacks), 7.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.

After OpenAPITools#5466
java codegen emits Set for array with uniqueItems=true which has
its downsides
- easy to lose track of element order (it can be important)
- easy to lose ordering by switching between java Set flavors (HashSet vs LinkedHashSet)
  somewhere down the line
- bigger divergence from original json types (either array or object)

Luckily types can be customized/overriden by extending the generator:
- extend JavaClientCodegen for example
- in constructor do
```java
    super();
    // import/interface type
    typeMapping().put("set", typeMapping().get("array"));
    // concrete type
    instantiationTypes().put("set", instantiationTypes().get("array"));
```

But sometimes it won't work because of missing ArrayList import, can be fixed by also doing
```java
    importMapping().put("LinkedHashSet", importMapping().get("ArrayList"));
```

Looks like a bug of assuming "set" fields are instantiated with LinkedHashSet,
let's fix it by using type mappings.
@dmivankov

Copy link
Copy Markdown
Author
tagging Java @bbdouglas (2017/07) @sreeshas (2017/08) @jfiala (2017/08) @lukoyanov (2017/09) @cbornet (2017/09) @jeff9finger (2018/01) @karismann (2019/03) @Zomzog (2019/04) @lwlee2608 (2019/10)

@wing328

wing328 commented Sep 30, 2022

Copy link
Copy Markdown
Member

@dmivankov

Copy link
Copy Markdown
Author

Added a test that was failing without this change

@wing328

wing328 commented Jan 27, 2024

Copy link
Copy Markdown
Member

when you've time, can you please resolve the merge conflicts and PM me via Slack when it's done?

https://join.slack.com/t/openapi-generator/shared_invite/zt-12jxxd7p2-XUeQM~4pzsU9x~eGLQqX2g

@dmivankov

Copy link
Copy Markdown
Author

Mechanically resolved the conflict but didn't try to retest locally, will need to remember more context first :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants