Skip to content
GitLab
    • Explore Projects Groups Snippets
Projects Groups Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in / Register
  • O openapi-generator
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 3,476
    • Issues 3,476
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 402
    • Merge requests 402
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Packages and registries
    • Packages and registries
    • Package Registry
    • Infrastructure Registry
  • Monitor
    • Monitor
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Repository
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • OpenAPI Tools
  • openapi-generator
  • Merge requests
  • !13550
An error occurred while fetching the assigned milestone of the selected merge_request.

Fix AbstractJavaCodegen ability to customize container types

  • Review changes

  • Download
  • Email patches
  • Plain diff
Open Administrator requested to merge github/fork/dmivankov/fix_custom_java_types into master 2 years ago
  • Overview 3
  • Commits 2
  • Pipelines 1
  • Changes 3

Created by: dmivankov

Fix for https://github.com/OpenAPITools/openapi-generator/issues/13549

After https://github.com/OpenAPITools/openapi-generator/pull/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.
Compare
  • version 1
    8a62c9c9
    2 years ago

  • master (HEAD)

and
  • latest version
    8a62c9c9
    2 commits, 2 years ago

  • version 1
    8a62c9c9
    2 commits, 2 years ago

3 files
+ 64
- 4

    Preferences

    File browser
    Compare changes
modules/openap‎i-generator/src‎
main/java/org/…/‎codegen/languages‎
AbstractJava‎Codegen.java‎ +4 -4
te‎st‎
java/org/openapit‎ools/codegen/java‎
AbstractJavaCo‎degenTest.java‎ +34 -0
resour‎ces/3_0‎
setSche‎ma.yaml‎ +26 -0
modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/AbstractJavaCodegen.java
+ 4
- 4
  • View file @ a52fb6e3

  • Edit in single-file editor

  • Open in Web IDE


@@ -1474,16 +1474,16 @@ public abstract class AbstractJavaCodegen extends DefaultCodegen implements Code
if (!fullJavaUtil) {
if ("array".equals(property.containerType)) {
model.imports.add("ArrayList");
model.imports.add(instantiationTypes.get("array"));
} else if ("set".equals(property.containerType)) {
model.imports.add("LinkedHashSet");
model.imports.add(instantiationTypes.get("set"));
boolean canNotBeWrappedToNullable = !openApiNullable || !property.isNullable;
if (canNotBeWrappedToNullable) {
model.imports.add("JsonDeserialize");
property.vendorExtensions.put("x-setter-extra-annotation", "@JsonDeserialize(as = LinkedHashSet.class)");
property.vendorExtensions.put("x-setter-extra-annotation", "@JsonDeserialize(as = " + instantiationTypes.get("set") + ".class)");
}
} else if ("map".equals(property.containerType)) {
model.imports.add("HashMap");
model.imports.add(instantiationTypes.get("map"));
}
}
modules/openapi-generator/src/test/java/org/openapitools/codegen/java/AbstractJavaCodegenTest.java
+ 34
- 0
  • View file @ a52fb6e3

  • Edit in single-file editor

  • Open in Web IDE


@@ -844,6 +844,40 @@ public class AbstractJavaCodegenTest {
Assert.assertEquals(defaultValue, "null", "Expected string-ref map aliased model to default to null since nullable is not set to tru");
}
@Test
public void uniqueItemsSet() {
final P_AbstractJavaCodegen codegen = new P_AbstractJavaCodegen();
final OpenAPI openAPI = TestUtils.parseFlattenSpec("src/test/resources/3_0/setSchema.yaml");
codegen.additionalProperties().put(CodegenConstants.GENERATE_ALIAS_AS_MODEL, true);
codegen.setOpenAPI(openAPI);
Schema schema = openAPI.getComponents().getSchemas().get("Response");
CodegenModel cm = codegen.fromModel("Response", schema);
Assert.assertFalse(cm.getImports().contains("List"), "expect List import");
Assert.assertFalse(cm.getImports().contains("ArrayList"), "expect ArrayList import");
Assert.assertTrue(cm.getImports().contains("Set"), "expect no Set import");
Assert.assertTrue(cm.getImports().contains("LinkedHashSet"), "expect no LinkedHashSet import");
}
@Test
public void uniqueItemsArray() {
final P_AbstractJavaCodegen codegen = new P_AbstractJavaCodegen();
// overrides to keep uniqueItems=true arrays as arrays in generated code
codegen.typeMapping().put("set", codegen.typeMapping().get("array"));
codegen.instantiationTypes().put("set", codegen.instantiationTypes().get("array"));
final OpenAPI openAPI = TestUtils.parseFlattenSpec("src/test/resources/3_0/setSchema.yaml");
codegen.additionalProperties().put(CodegenConstants.GENERATE_ALIAS_AS_MODEL, true);
codegen.setOpenAPI(openAPI);
Schema schema = openAPI.getComponents().getSchemas().get("Response");
CodegenModel cm = codegen.fromModel("Response", schema);
Assert.assertTrue(cm.getImports().contains("List"), "expect List import");
Assert.assertTrue(cm.getImports().contains("ArrayList"), "expect ArrayList import");
Assert.assertFalse(cm.getImports().contains("Set"), "expect no Set import");
Assert.assertFalse(cm.getImports().contains("LinkedHashSet"), "expect no LinkedHashSet import");
}
@Test
public void srcMainFolderShouldNotBeOperatingSystemSpecificPaths() {
// it's not responsibility of the generator to fix OS-specific paths. This is left to template manager.
modules/openapi-generator/src/test/resources/3_0/setSchema.yaml 0 → 100644
+ 26
- 0
  • View file @ a52fb6e3

  • Edit in single-file editor

  • Open in Web IDE

openapi: 3.0.0
paths:
/examples:
get:
tags:
- Examples
summary: Get a list of transactions
operationId: getFilteredTransactions
responses:
200:
description: A list of deleted consumers
content:
application/json:
schema:
$ref: '#/components/schemas/Response'
components:
schemas:
Response:
type: object
properties:
something:
type: array
uniqueItems: true
items:
type: string
0 Assignees
None
Assign to
0 Reviewers
None
Request review from
Labels
0
None
0
None
    Assign labels
  • Manage project labels

Milestone
No milestone
None
None
Time tracking
No estimate or time spent
Lock merge request
Unlocked
0
0 participants
Reference:
Source branch: github/fork/dmivankov/fix_custom_java_types

Menu

Explore Projects Groups Snippets