[JAVA] fix several anyOf/oneOf problems (#19817)

* erasure duplicates * sanitize beanValidation * oneOf maps * anyOf * update samples
OpenAPITools · Oct 10, 2024 · b730e36 · b730e36
1 parent 43fd189
commit b730e36
Show file tree

Hide file tree

Showing 137 changed files with 10,054 additions and 103 deletions.
diff --git a/.github/workflows/samples-java-client-jdk11.yaml b/.github/workflows/samples-java-client-jdk11.yaml
@@ -11,6 +11,7 @@ on:
       - samples/openapi3/client/petstore/java/jersey2-java8-swagger2/**
       - samples/openapi3/client/petstore/java/native**
       - samples/client/others/java/okhttp-gson-oneOf/**
+      - samples/client/others/java/okhttp-gson-oneOf-array/**
       - samples/client/others/java/resttemplate-useAbstractionForFiles/**
       - samples/client/others/java/webclient-useAbstractionForFiles/**
       - samples/client/others/java/jersey2-oneOf-duplicates/**
@@ -26,6 +27,7 @@ on:
       - samples/openapi3/client/petstore/java/jersey2-java8-swagger2/**
       - samples/openapi3/client/petstore/java/native**
       - samples/client/others/java/okhttp-gson-oneOf/**
+      - samples/client/others/java/okhttp-gson-oneOf-array/**
       - samples/client/others/java/resttemplate-useAbstractionForFiles/**
       - samples/client/others/java/webclient-useAbstractionForFiles/**
       - samples/client/others/java/jersey2-oneOf-duplicates/**
@@ -75,6 +77,7 @@ jobs:
           - samples/client/petstore/java/resttemplate-swagger2/
           - samples/openapi3/client/petstore/java/jersey2-java8-swagger2/
           - samples/client/others/java/okhttp-gson-oneOf/
+          - samples/client/others/java/okhttp-gson-oneOf-array/
           - samples/client/echo_api/java/okhttp-gson-user-defined-templates/
           - samples/client/others/java/resttemplate-useAbstractionForFiles/
           - samples/client/others/java/webclient-useAbstractionForFiles/

diff --git a/CI/circle_parallel.sh b/CI/circle_parallel.sh
@@ -115,6 +115,7 @@ else
   (cd samples/client/petstore/java/jersey2-java8 && mvn integration-test)
   (cd samples/openapi3/client/petstore/java/jersey2-java8 && mvn integration-test)
   (cd samples/client/petstore/java/jersey3 && mvn integration-test)
+  (cd samples/client/petstore/java/jersey3-oneOf && mvn integration-test)
   (cd samples/client/others/java/okhttp-gson-streaming && mvn integration-test)
   (cd samples/client/petstore/java/okhttp-gson && mvn integration-test)
   (cd samples/client/petstore/java/okhttp-gson-3.1 && mvn integration-test)

diff --git a/bin/configs/java-jersey3-oneOf.yaml b/bin/configs/java-jersey3-oneOf.yaml
@@ -0,0 +1,7 @@
+generatorName: java
+outputDir: samples/client/petstore/java/jersey3-oneOf
+library: jersey3
+inputSpec: modules/openapi-generator/src/test/resources/3_0/oneOf_additionalProperties.yaml
+templateDir: modules/openapi-generator/src/main/resources/Java
+additionalProperties:
+  hideGenerationTimestamp: true
diff --git a/bin/configs/java-okhttp-gson-oneOf-array.yaml b/bin/configs/java-okhttp-gson-oneOf-array.yaml
@@ -0,0 +1,8 @@
+generatorName: java
+outputDir: samples/client/others/java/okhttp-gson-oneOf-array
+library: okhttp-gson
+inputSpec: modules/openapi-generator/src/test/resources/3_0/oneOf_array.yaml
+templateDir: modules/openapi-generator/src/main/resources/Java
+additionalProperties:
+  hideGenerationTimestamp: "true"
+  useBeanValidation: "true"
diff --git a/modules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java b/modules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java
@@ -8444,6 +8444,7 @@ private List<CodegenProperty> getComposedProperties(List<Schema> xOfCollection,
         }
         List<CodegenProperty> xOf = new ArrayList<>();
         Set<String> dataTypeSet = new HashSet<>(); // to keep track of dataType
+        Set<String> dataTypeSetIgnoringErasure = new HashSet<>();
         int i = 0;
         for (Schema xOfSchema : xOfCollection) {
             CodegenProperty cp = fromProperty(collectionName + "_" + i, xOfSchema, false);
@@ -8452,7 +8453,7 @@ private List<CodegenProperty> getComposedProperties(List<Schema> xOfCollection,
 
             if (dataTypeSet.contains(cp.dataType)
                     || (isTypeErasedGenerics() && dataTypeSet.contains(cp.baseType))) {
-                // add "x-duplicated-data-type" to indicate if the dataType already occurs before
+                // add "x-duplicated-data-type" to indicate if the (base) dataType already occurs before
                 // in other sub-schemas of allOf/anyOf/oneOf
                 cp.vendorExtensions.putIfAbsent("x-duplicated-data-type", true);
             } else {
@@ -8462,6 +8463,13 @@ private List<CodegenProperty> getComposedProperties(List<Schema> xOfCollection,
                     dataTypeSet.add(cp.dataType);
                 }
             }
+            if (dataTypeSetIgnoringErasure.contains(cp.dataType)) {
+                // add "x-duplicated-data-type-ignoring-erasure" to indicate if the dataType already occurs before
+                // in other sub-schemas of allOf/anyOf/oneOf
+                cp.vendorExtensions.putIfAbsent("x-duplicated-data-type-ignoring-erasure", true);
+            } else {
+                dataTypeSetIgnoringErasure.add(cp.dataType);
+            }
         }
         return xOf;
     }

diff --git a/...enapi-generator/src/main/java/org/openapitools/codegen/languages/AbstractJavaCodegen.java b/...enapi-generator/src/main/java/org/openapitools/codegen/languages/AbstractJavaCodegen.java
@@ -642,7 +642,7 @@ public void processOpts() {
         convertPropertyToBooleanAndWriteBack(CONTAINER_DEFAULT_TO_NULL, this::setContainerDefaultToNull);
 
         additionalProperties.put("sanitizeGeneric", (Mustache.Lambda) (fragment, writer) -> {
-            String content = fragment.execute();
+            String content = removeAnnotations(fragment.execute());
             for (final String s: List.of("<", ">", ",", " ")) {
                 content = content.replace(s, "");
             }
@@ -1793,16 +1793,20 @@ public void postProcessResponseWithProperty(CodegenResponse response, CodegenPro
             return;
         }
 
-        // the response data types should not contains a bean validation annotation.
+        // the response data types should not contain a bean validation annotation.
         if (property.dataType.contains("@")) {
-            property.dataType = property.dataType.replaceAll("(?:(?i)@[a-z0-9]*+([(].*[)]|\\s*))*+", "");
+            property.dataType = removeAnnotations(property.dataType);
         }
-        // the response data types should not contains a bean validation annotation.
+        // the response data types should not contain a bean validation annotation.
         if (response.dataType.contains("@")) {
-            response.dataType = response.dataType.replaceAll("(?:(?i)@[a-z0-9]*+([(].*[)]|\\s*))*+", "");
+            response.dataType = removeAnnotations(response.dataType);
         }
     }
 
+    private String removeAnnotations(String type) {
+        return type.replaceAll("(?:(?i)@[a-z0-9]*+([(].*[)]|\\s*))*+", "");
+    }
+
     @Override
     public ModelsMap postProcessModels(ModelsMap objs) {
         // recursively add import for mapping one type to multiple imports

diff --git a/modules/openapi-generator/src/main/resources/Java/libraries/jersey2/anyof_model.mustache b/modules/openapi-generator/src/main/resources/Java/libraries/jersey2/anyof_model.mustache
@@ -68,10 +68,23 @@ public class {{classname}} extends AbstractOpenApiSchema{{#vendorExtensions.x-im
                 return ret;
             }
             {{/discriminator}}
+            {{#composedSchemas}}
             {{#anyOf}}
-            // deserialize {{{.}}}
+            // deserialize {{{dataType}}}{{#isNullable}} (nullable){{/isNullable}}
             try {
-                deserialized = tree.traverse(jp.getCodec()).readValueAs({{{.}}}.class);
+                {{^isArray}}
+                {{^isMap}}
+                deserialized = tree.traverse(jp.getCodec()).readValueAs({{{dataType}}}.class);
+                {{/isMap}}
+                {{/isArray}}
+                {{#isArray}}
+                final TypeReference<{{{dataType}}}> ref = new TypeReference<{{{dataType}}}>(){};
+                deserialized = tree.traverse(jp.getCodec()).readValueAs(ref);
+                {{/isArray}}
+                {{#isMap}}
+                final TypeReference<{{{dataType}}}> ref = new TypeReference<{{{dataType}}}>(){};
+                deserialized = tree.traverse(jp.getCodec()).readValueAs(ref);
+                {{/isMap}}
                 {{classname}} ret = new {{classname}}();
                 ret.setActualInstance(deserialized);
                 return ret;
@@ -81,6 +94,7 @@ public class {{classname}} extends AbstractOpenApiSchema{{#vendorExtensions.x-im
             }
 
             {{/anyOf}}
+            {{/composedSchemas}}
             throw new IOException(String.format("Failed deserialization for {{classname}}: no match found"));
         }
 
@@ -119,13 +133,17 @@ public class {{classname}} extends AbstractOpenApiSchema{{#vendorExtensions.x-im
         return Objects.hash(getActualInstance(), isNullable(), getSchemaType(), additionalProperties);
     }
     {{/additionalPropertiesType}}
+    {{#composedSchemas}}
     {{#anyOf}}
-    public {{classname}}({{{.}}} o) {
+    {{^vendorExtensions.x-duplicated-data-type}}
+    public {{classname}}({{{baseType}}} o) {
         super("anyOf", {{#isNullable}}Boolean.TRUE{{/isNullable}}{{^isNullable}}Boolean.FALSE{{/isNullable}});
         setActualInstance(o);
     }
 
+    {{/vendorExtensions.x-duplicated-data-type}}
     {{/anyOf}}
+    {{/composedSchemas}}
     static {
         {{#anyOf}}
         schemas.put("{{{.}}}", new GenericType<{{{.}}}>() {
@@ -165,13 +183,17 @@ public class {{classname}} extends AbstractOpenApiSchema{{#vendorExtensions.x-im
         }
 
         {{/isNullable}}
+        {{#composedSchemas}}
         {{#anyOf}}
-        if (JSON.isInstanceOf({{{.}}}.class, instance, new HashSet<>())) {
+        {{^vendorExtensions.x-duplicated-data-type}}
+        if (JSON.isInstanceOf({{{baseType}}}.class, instance, new HashSet<>())) {
             super.setActualInstance(instance);
             return;
         }
 
+        {{/vendorExtensions.x-duplicated-data-type}}
         {{/anyOf}}
+        {{/composedSchemas}}
         throw new RuntimeException("Invalid instance type. Must be {{#anyOf}}{{{.}}}{{^-last}}, {{/-last}}{{/anyOf}}");
     }
 
@@ -186,17 +208,21 @@ public class {{classname}} extends AbstractOpenApiSchema{{#vendorExtensions.x-im
         return super.getActualInstance();
     }
 
+    {{#composedSchemas}}
     {{#anyOf}}
+    {{^vendorExtensions.x-duplicated-data-type-ignoring-erasure}}
     /**
-     * Get the actual instance of `{{{.}}}`. If the actual instance is not `{{{.}}}`,
+     * Get the actual instance of `{{{dataType}}}`. If the actual instance is not `{{{dataType}}}`,
      * the ClassCastException will be thrown.
      *
-     * @return The actual instance of `{{{.}}}`
-     * @throws ClassCastException if the instance is not `{{{.}}}`
+     * @return The actual instance of `{{{dataType}}}`
+     * @throws ClassCastException if the instance is not `{{{dataType}}}`
      */
-    public {{{.}}} get{{{.}}}() throws ClassCastException {
-        return ({{{.}}})super.getActualInstance();
+    public {{{dataType}}} get{{#sanitizeGeneric}}{{{dataType}}}{{/sanitizeGeneric}}() throws ClassCastException {
+        return ({{{dataType}}})super.getActualInstance();
     }
 
+    {{/vendorExtensions.x-duplicated-data-type-ignoring-erasure}}
     {{/anyOf}}
+    {{/composedSchemas}}
 }
diff --git a/modules/openapi-generator/src/main/resources/Java/libraries/jersey2/oneof_model.mustache b/modules/openapi-generator/src/main/resources/Java/libraries/jersey2/oneof_model.mustache
@@ -120,7 +120,13 @@ public class {{classname}} extends AbstractOpenApiSchema{{#vendorExtensions.x-im
                 }
                 {{/isPrimitiveType}}
                 if (attemptParsing) {
+                    {{#isMap}}
+                    final TypeReference<{{{dataType}}}> ref = new TypeReference<{{{dataType}}}>(){};
+                    deserialized = tree.traverse(jp.getCodec()).readValueAs(ref);
+                    {{/isMap}}
+                    {{^isMap}}
                     deserialized = tree.traverse(jp.getCodec()).readValueAs({{{dataType}}}.class);
+                    {{/isMap}}
                     // TODO: there is no validation against JSON schema constraints
                     // (min, max, enum, pattern...), this does not perform a strict JSON
                     // validation, which means the 'match' count may be higher than it should be.
@@ -266,24 +272,19 @@ public class {{classname}} extends AbstractOpenApiSchema{{#vendorExtensions.x-im
 
     {{#composedSchemas}}
     {{#oneOf}}
+    {{^vendorExtensions.x-duplicated-data-type-ignoring-erasure}}
     /**
      * Get the actual instance of `{{{dataType}}}`. If the actual instance is not `{{{dataType}}}`,
      * the ClassCastException will be thrown.
      *
      * @return The actual instance of `{{{dataType}}}`
      * @throws ClassCastException if the instance is not `{{{dataType}}}`
      */
-    {{^isArray}}
-    public {{{dataType}}} get{{{dataType}}}() throws ClassCastException {
+    public {{{dataType}}} get{{#sanitizeGeneric}}{{{dataType}}}{{/sanitizeGeneric}}() throws ClassCastException {
         return ({{{dataType}}})super.getActualInstance();
     }
-    {{/isArray}}
-    {{#isArray}}
-        public {{{dataType}}} get{{#sanitizeGeneric}}{{{dataType}}}{{/sanitizeGeneric}}() throws ClassCastException {
-        return ({{{dataType}}})super.getActualInstance();
-        }
-    {{/isArray}}
 
+    {{/vendorExtensions.x-duplicated-data-type-ignoring-erasure}}
     {{/oneOf}}
     {{/composedSchemas}}
 }
diff --git a/modules/openapi-generator/src/main/resources/Java/libraries/jersey3/anyof_model.mustache b/modules/openapi-generator/src/main/resources/Java/libraries/jersey3/anyof_model.mustache
@@ -68,10 +68,23 @@ public class {{classname}} extends AbstractOpenApiSchema{{#vendorExtensions.x-im
                 return ret;
             }
             {{/discriminator}}
+            {{#composedSchemas}}
             {{#anyOf}}
-            // deserialize {{{.}}}
+            // deserialize {{{dataType}}}{{#isNullable}} (nullable){{/isNullable}}
             try {
-                deserialized = tree.traverse(jp.getCodec()).readValueAs({{{.}}}.class);
+                {{^isArray}}
+                {{^isMap}}
+                deserialized = tree.traverse(jp.getCodec()).readValueAs({{{dataType}}}.class);
+                {{/isMap}}
+                {{/isArray}}
+                {{#isArray}}
+                final TypeReference<{{{dataType}}}> ref = new TypeReference<{{{dataType}}}>(){};
+                deserialized = tree.traverse(jp.getCodec()).readValueAs(ref);
+                {{/isArray}}
+                {{#isMap}}
+                final TypeReference<{{{dataType}}}> ref = new TypeReference<{{{dataType}}}>(){};
+                deserialized = tree.traverse(jp.getCodec()).readValueAs(ref);
+                {{/isMap}}
                 {{classname}} ret = new {{classname}}();
                 ret.setActualInstance(deserialized);
                 return ret;
@@ -81,6 +94,7 @@ public class {{classname}} extends AbstractOpenApiSchema{{#vendorExtensions.x-im
             }
 
             {{/anyOf}}
+            {{/composedSchemas}}
             throw new IOException(String.format("Failed deserialization for {{classname}}: no match found"));
         }
 
@@ -119,13 +133,17 @@ public class {{classname}} extends AbstractOpenApiSchema{{#vendorExtensions.x-im
         return Objects.hash(getActualInstance(), isNullable(), getSchemaType(), additionalProperties);
     }
     {{/additionalPropertiesType}}
+    {{#composedSchemas}}
     {{#anyOf}}
-    public {{classname}}({{{.}}} o) {
+    {{^vendorExtensions.x-duplicated-data-type}}
+    public {{classname}}({{{baseType}}} o) {
         super("anyOf", {{#isNullable}}Boolean.TRUE{{/isNullable}}{{^isNullable}}Boolean.FALSE{{/isNullable}});
         setActualInstance(o);
     }
 
+    {{/vendorExtensions.x-duplicated-data-type}}
     {{/anyOf}}
+    {{/composedSchemas}}
     static {
         {{#anyOf}}
         schemas.put("{{{.}}}", new GenericType<{{{.}}}>() {
@@ -165,13 +183,17 @@ public class {{classname}} extends AbstractOpenApiSchema{{#vendorExtensions.x-im
         }
 
         {{/isNullable}}
+        {{#composedSchemas}}
         {{#anyOf}}
-        if (JSON.isInstanceOf({{{.}}}.class, instance, new HashSet<>())) {
+        {{^vendorExtensions.x-duplicated-data-type}}
+        if (JSON.isInstanceOf({{{baseType}}}.class, instance, new HashSet<>())) {
             super.setActualInstance(instance);
             return;
         }
 
+        {{/vendorExtensions.x-duplicated-data-type}}
         {{/anyOf}}
+        {{/composedSchemas}}
         throw new RuntimeException("Invalid instance type. Must be {{#anyOf}}{{{.}}}{{^-last}}, {{/-last}}{{/anyOf}}");
     }
 
@@ -186,17 +208,21 @@ public class {{classname}} extends AbstractOpenApiSchema{{#vendorExtensions.x-im
         return super.getActualInstance();
     }
 
+    {{#composedSchemas}}
     {{#anyOf}}
+    {{^vendorExtensions.x-duplicated-data-type-ignoring-erasure}}
     /**
-     * Get the actual instance of `{{{.}}}`. If the actual instance is not `{{{.}}}`,
+     * Get the actual instance of `{{{dataType}}}`. If the actual instance is not `{{{dataType}}}`,
      * the ClassCastException will be thrown.
      *
-     * @return The actual instance of `{{{.}}}`
-     * @throws ClassCastException if the instance is not `{{{.}}}`
+     * @return The actual instance of `{{{dataType}}}`
+     * @throws ClassCastException if the instance is not `{{{dataType}}}`
      */
-    public {{{.}}} get{{{.}}}() throws ClassCastException {
-        return ({{{.}}})super.getActualInstance();
+    public {{{dataType}}} get{{#sanitizeGeneric}}{{{dataType}}}{{/sanitizeGeneric}}() throws ClassCastException {
+        return ({{{dataType}}})super.getActualInstance();
     }
 
+    {{/vendorExtensions.x-duplicated-data-type-ignoring-erasure}}
     {{/anyOf}}
+    {{/composedSchemas}}
 }
diff --git a/modules/openapi-generator/src/main/resources/Java/libraries/jersey3/oneof_model.mustache b/modules/openapi-generator/src/main/resources/Java/libraries/jersey3/oneof_model.mustache
@@ -120,7 +120,13 @@ public class {{classname}} extends AbstractOpenApiSchema{{#vendorExtensions.x-im
                 }
                 {{/isPrimitiveType}}
                 if (attemptParsing) {
+                    {{#isMap}}
+                    final TypeReference<{{{dataType}}}> ref = new TypeReference<{{{dataType}}}>(){};
+                    deserialized = tree.traverse(jp.getCodec()).readValueAs(ref);
+                    {{/isMap}}
+                    {{^isMap}}
                     deserialized = tree.traverse(jp.getCodec()).readValueAs({{{dataType}}}.class);
+                    {{/isMap}}
                     // TODO: there is no validation against JSON schema constraints
                     // (min, max, enum, pattern...), this does not perform a strict JSON
                     // validation, which means the 'match' count may be higher than it should be.
@@ -266,24 +272,19 @@ public class {{classname}} extends AbstractOpenApiSchema{{#vendorExtensions.x-im
 
     {{#composedSchemas}}
     {{#oneOf}}
+    {{^vendorExtensions.x-duplicated-data-type-ignoring-erasure}}
     /**
      * Get the actual instance of `{{{dataType}}}`. If the actual instance is not `{{{dataType}}}`,
      * the ClassCastException will be thrown.
      *
      * @return The actual instance of `{{{dataType}}}`
      * @throws ClassCastException if the instance is not `{{{dataType}}}`
      */
-    {{^isArray}}
-    public {{{dataType}}} get{{{dataType}}}() throws ClassCastException {
+    public {{{dataType}}} get{{#sanitizeGeneric}}{{{dataType}}}{{/sanitizeGeneric}}() throws ClassCastException {
         return ({{{dataType}}})super.getActualInstance();
     }
-    {{/isArray}}
-    {{#isArray}}
-        public {{{dataType}}} get{{#sanitizeGeneric}}{{{dataType}}}{{/sanitizeGeneric}}() throws ClassCastException {
-        return ({{{dataType}}})super.getActualInstance();
-        }
-    {{/isArray}}
 
+    {{/vendorExtensions.x-duplicated-data-type-ignoring-erasure}}
     {{/oneOf}}
     {{/composedSchemas}}
 }