Add support useOneOfInterfaces property (#1608)

altro3 · web-flow · commit aa9fe0656284 · 2024-07-03T07:03:18.000+02:00
diff --git a/build-logic/src/main/groovy/io.micronaut.build.internal.openapi-java-generator-test-suite.gradle b/build-logic/src/main/groovy/io.micronaut.build.internal.openapi-java-generator-test-suite.gradle
@@ -25,6 +25,7 @@ def openapiGenerate = tasks.register("generateOpenApi", OpenApiGeneratorTask) {
     clientId = "myClient"
     clientPath = true
     ksp = false
+    useOneOfInterfaces = false
     classpath.from(configurations.openapiGenerator)
     openApiDefinition.convention(layout.projectDirectory.file("petstore.json"))
     outputDirectory.convention(layout.buildDirectory.dir("generated/openapi"))
diff --git a/build-logic/src/main/groovy/io.micronaut.build.internal.openapi-kotlin-kapt-generator-test-suite.gradle b/build-logic/src/main/groovy/io.micronaut.build.internal.openapi-kotlin-kapt-generator-test-suite.gradle
@@ -25,6 +25,7 @@ def openapiGenerate = tasks.register("generateOpenApi", OpenApiGeneratorTask) {
     clientId = "myClient"
     clientPath = true
     ksp = false
+    useOneOfInterfaces = false
     classpath.from(configurations.openapiGenerator)
     openApiDefinition.convention(layout.projectDirectory.file("petstore.json"))
     outputDirectory.convention(layout.buildDirectory.dir("generated/openapi"))
diff --git a/build-logic/src/main/groovy/io.micronaut.build.internal.openapi-kotlin-ksp-generator-test-suite.gradle b/build-logic/src/main/groovy/io.micronaut.build.internal.openapi-kotlin-ksp-generator-test-suite.gradle
@@ -25,6 +25,7 @@ def openapiGenerate = tasks.register("generateOpenApi", OpenApiGeneratorTask) {
     clientId = "myClient"
     clientPath = true
     ksp = true
+    useOneOfInterfaces = false
     classpath.from(configurations.openapiGenerator)
     openApiDefinition.convention(layout.projectDirectory.file("petstore.json"))
     outputDirectory.convention(layout.buildDirectory.dir("generated/openapi"))
diff --git a/build-logic/src/main/groovy/io/micronaut/build/internal/openapi/OpenApiGeneratorTask.java b/build-logic/src/main/groovy/io/micronaut/build/internal/openapi/OpenApiGeneratorTask.java
@@ -67,6 +67,9 @@ public abstract class OpenApiGeneratorTask extends DefaultTask {
     @Input
     public abstract Property<Boolean> getKsp();
 
+    @Input
+    public abstract Property<Boolean> getUseOneOfInterfaces();
+
     @Input
     public abstract Property<Boolean> getClientPath();
 
@@ -144,6 +147,7 @@ public void execute() throws IOException {
             args.add(Boolean.toString(generatedAnnotation));
             args.add(Boolean.toString(getKsp().get()));
             args.add(Boolean.toString(getClientPath().get()));
+            args.add(Boolean.toString(getUseOneOfInterfaces().get()));
             args.add(getNameMapping().get().toString());
             args.add(getClientId().getOrElse(""));
             args.add(getApiNamePrefix().getOrElse(""));
diff --git a/openapi-generator/src/main/java/io/micronaut/openapi/generator/AbstractMicronautJavaCodegen.java b/openapi-generator/src/main/java/io/micronaut/openapi/generator/AbstractMicronautJavaCodegen.java
@@ -158,6 +158,7 @@ protected AbstractMicronautJavaCodegen() {
         generateSwaggerAnnotations = this instanceof JavaMicronautClientCodegen ? OPT_GENERATE_SWAGGER_ANNOTATIONS_FALSE : OPT_GENERATE_SWAGGER_ANNOTATIONS_SWAGGER_2;
         generateOperationOnlyForFirstTag = this instanceof JavaMicronautServerCodegen;
         openApiNullable = false;
+        useOneOfInterfaces = true;
         inlineSchemaOption.put("RESOLVE_INLINE_ENUMS", "true");
         // CHECKSTYLE:ON
 
@@ -235,7 +236,7 @@ protected AbstractMicronautJavaCodegen() {
 
         final CliOption serializationLibraryOpt = CliOption.newString(CodegenConstants.SERIALIZATION_LIBRARY, "Serialization library for model");
         serializationLibraryOpt.defaultValue(SerializationLibraryKind.JACKSON.name());
-        Map<String, String> serializationLibraryOptions = new HashMap<>();
+        var serializationLibraryOptions = new HashMap<String, String>();
         serializationLibraryOptions.put(SerializationLibraryKind.JACKSON.name(), "Jackson as serialization library");
         serializationLibraryOptions.put(SerializationLibraryKind.MICRONAUT_SERDE_JACKSON.name(), "Use micronaut-serialization with Jackson annotations");
         serializationLibraryOpt.setEnum(serializationLibraryOptions);
diff --git a/openapi-generator/src/main/java/io/micronaut/openapi/generator/AbstractMicronautKotlinCodegen.java b/openapi-generator/src/main/java/io/micronaut/openapi/generator/AbstractMicronautKotlinCodegen.java
@@ -55,6 +55,7 @@
 import java.io.File;
 import java.security.SecureRandom;
 import java.util.ArrayList;
+import java.util.Collection;
 import java.util.EnumSet;
 import java.util.HashMap;
 import java.util.Iterator;
@@ -212,6 +213,7 @@ protected AbstractMicronautKotlinCodegen() {
         generateOperationOnlyForFirstTag = this instanceof KotlinMicronautServerCodegen;
         enumPropertyNaming = CodegenConstants.ENUM_PROPERTY_NAMING_TYPE.UPPERCASE;
         inlineSchemaOption.put("RESOLVE_INLINE_ENUMS", "true");
+        useOneOfInterfaces = true;
         // CHECKSTYLE:ON
 
         // Set implemented features for user information
@@ -1274,6 +1276,9 @@ public Map<String, ModelsMap> postProcessAllModels(Map<String, ModelsMap> objs)
             var allVars = new ArrayList<CodegenProperty>();
 
             processParentModel(model, requiredVarsWithoutDiscriminator, requiredParentVarsWithoutDiscriminator, allVars, false);
+            model.allVars = allVars;
+
+            processOneOfModels(model, objs.values());
 
             var withInheritance = model.hasChildren || model.parent != null;
             model.vendorExtensions.put("withInheritance", withInheritance);
@@ -1301,7 +1306,6 @@ public Map<String, ModelsMap> postProcessAllModels(Map<String, ModelsMap> objs)
             if (!requiredVarsWithoutDiscriminator.isEmpty()) {
                 model.vendorExtensions.put("requiredVarsWithoutDiscriminator", requiredVarsWithoutDiscriminator);
             }
-            model.allVars = allVars;
             model.vendorExtensions.put("requiredVars", requiredVars);
             model.vendorExtensions.put("withRequiredOrOptionalVars", !requiredVarsWithoutDiscriminator.isEmpty() || !optionalVars.isEmpty());
             model.vendorExtensions.put("optionalVars", optionalVars);
@@ -1324,6 +1328,44 @@ public Map<String, ModelsMap> postProcessAllModels(Map<String, ModelsMap> objs)
         return objs;
     }
 
+    private void processOneOfModels(CodegenModel model, Collection<ModelsMap> models) {
+
+        if (!model.vendorExtensions.containsKey("x-is-one-of-interface")
+                || !Boolean.parseBoolean(model.vendorExtensions.get("x-is-one-of-interface").toString())) {
+            return;
+        }
+
+        var discriminator = model.discriminator;
+        if (discriminator == null) {
+            return;
+        }
+        var oneOfInterfaceName = model.name;
+        for (var modelMap : models) {
+            var m = modelMap.getModels().get(0).getModel();
+
+            if (!m.vendorExtensions.containsKey("x-implements")) {
+                continue;
+            }
+            var xImplements = m.vendorExtensions.get("x-implements");
+            if (!(xImplements instanceof List<?> xImplementsList)) {
+                continue;
+            }
+            for (var implInterface : xImplementsList) {
+                if (!oneOfInterfaceName.equalsIgnoreCase(implInterface.toString())) {
+                    continue;
+                }
+                for (var prop : m.allVars) {
+                    if (prop.name.equals(discriminator.getPropertyName())) {
+                        prop.isDiscriminator = true;
+                        prop.isOverridden = true;
+                        prop.vendorExtensions.put("overridden", true);
+                        break;
+                    }
+                }
+            }
+        }
+    }
+
     private void processProperty(CodegenProperty property, boolean isServer, CodegenModel model, Map<String, ModelsMap> models) {
 
         property.vendorExtensions.put("withRequiredAndOptionalVars", model.vendorExtensions.get("withRequiredAndOptionalVars"));
diff --git a/openapi-generator/src/main/java/io/micronaut/openapi/generator/MicronautCodeGeneratorEntryPoint.java b/openapi-generator/src/main/java/io/micronaut/openapi/generator/MicronautCodeGeneratorEntryPoint.java
@@ -182,6 +182,7 @@ private void configureOptions() {
                 javaCodeGen.setModelNameSuffix(options.modelNameSuffix);
             }
 
+            javaCodeGen.setUseOneOfInterfaces(options.useOneOfInterfaces());
             javaCodeGen.setReactive(options.reactive);
             javaCodeGen.setGenerateHttpResponseAlways(options.generateHttpResponseAlways);
             javaCodeGen.setGenerateHttpResponseWhereRequired(options.generateHttpResponseWhereRequired);
@@ -245,7 +246,7 @@ private void configureOptions() {
             if (options.modelNameSuffix != null && !options.modelNameSuffix.isBlank()) {
                 kotlinCodeGen.setModelNameSuffix(options.modelNameSuffix);
             }
-
+            kotlinCodeGen.setUseOneOfInterfaces(options.useOneOfInterfaces);
             kotlinCodeGen.setReactive(options.reactive);
             kotlinCodeGen.setGenerateHttpResponseAlways(options.generateHttpResponseAlways);
             kotlinCodeGen.setGenerateHttpResponseWhereRequired(options.generateHttpResponseWhereRequired);
@@ -513,6 +514,7 @@ private static class DefaultOptionsBuilder implements MicronautCodeGeneratorOpti
 
             private boolean optional;
             private boolean reactive = true;
+            private boolean useOneOfInterfaces = true;
             private boolean generateHttpResponseAlways;
             private boolean generateHttpResponseWhereRequired = true;
             private TestFramework testFramework = TestFramework.JUNIT5;
@@ -688,6 +690,12 @@ public MicronautCodeGeneratorOptionsBuilder withDateTimeFormat(DateTimeFormat fo
                 return this;
             }
 
+            @Override
+            public MicronautCodeGeneratorOptionsBuilder withUseOneOfInterfaces(boolean useOneOfInterfaces) {
+                this.useOneOfInterfaces = useOneOfInterfaces;
+                return this;
+            }
+
             private Options build() {
                 return new Options(
                     lang,
@@ -715,6 +723,7 @@ private Options build() {
                     beanValidation,
                     optional,
                     reactive,
+                    useOneOfInterfaces,
                     generateHttpResponseAlways,
                     generateHttpResponseWhereRequired,
                     testFramework,
@@ -766,6 +775,7 @@ private record Options(
         boolean beanValidation,
         boolean optional,
         boolean reactive,
+        boolean useOneOfInterfaces,
         boolean generateHttpResponseAlways,
         boolean generateHttpResponseWhereRequired,
         TestFramework testFramework,
diff --git a/openapi-generator/src/main/java/io/micronaut/openapi/generator/MicronautCodeGeneratorOptionsBuilder.java b/openapi-generator/src/main/java/io/micronaut/openapi/generator/MicronautCodeGeneratorOptionsBuilder.java
@@ -248,6 +248,15 @@ public interface MicronautCodeGeneratorOptionsBuilder {
      */
     MicronautCodeGeneratorOptionsBuilder withDateTimeFormat(DateTimeFormat format);
 
+    /**
+     * Flag to indicate whether to use the utils.OneOfImplementorAdditionalData related logic.
+     *
+     * @param useOneOfInterfaces if true, then use the utils.OneOfImplementorAdditionalData related logic.
+     *
+     * @return this builder
+     */
+    MicronautCodeGeneratorOptionsBuilder withUseOneOfInterfaces(boolean useOneOfInterfaces);
+
     /**
      * The possible date-time formatting configurations.
      */
diff --git a/openapi-generator/src/main/resources/templates/java-micronaut/common/model/oneof_interface.mustache b/openapi-generator/src/main/resources/templates/java-micronaut/common/model/oneof_interface.mustache
@@ -7,8 +7,9 @@
 {{/generatedAnnotation}}
 {{>common/model/typeInfoAnnotation}}
 {{>common/model/xmlAnnotation}}
-public interface {{classname}} {{#vendorExtensions.x-implements}}{{#-first}}extends {{{.}}}{{/-first}}{{^-first}}, {{{.}}}{{/-first}}{{/vendorExtensions.x-implements}} {
+public interface {{classname}}{{#vendorExtensions.x-implements}}{{#-first}} extends {{{.}}}{{/-first}}{{^-first}}, {{{.}}}{{/-first}}{{/vendorExtensions.x-implements}} {
 {{/formatNoEmptyLines}}
+
     {{#discriminator}}
     public {{propertyType}} {{propertyGetter}}();
     {{/discriminator}}
diff --git a/openapi-generator/src/main/resources/templates/kotlin-micronaut/common/model/oneof_interface.mustache b/openapi-generator/src/main/resources/templates/kotlin-micronaut/common/model/oneof_interface.mustache
@@ -6,10 +6,10 @@
 {{>common/generatedAnnotation}}
 {{/generatedAnnotation}}
 {{>common/model/typeInfoAnnotation}}
-{{>common/model/xmlAnnotation}}
-public interface {{classname}} {{#vendorExtensions.x-implements}}{{#-first}}extends {{{.}}}{{/-first}}{{^-first}}, {{{.}}}{{/-first}}{{/vendorExtensions.x-implements}} {
+interface {{classname}}{{#vendorExtensions.x-implements}}{{#-first}} : {{{.}}}{{/-first}}{{^-first}}, {{{.}}}{{/-first}}{{/vendorExtensions.x-implements}} {
 {{/formatNoEmptyLines}}
+
     {{#discriminator}}
-    public {{propertyType}} {{propertyGetter}}()
+    val {{propertyName}}: {{propertyType}}
     {{/discriminator}}
 }
diff --git a/openapi-generator/src/main/resources/templates/kotlin-micronaut/common/model/pojo.mustache b/openapi-generator/src/main/resources/templates/kotlin-micronaut/common/model/pojo.mustache
@@ -58,7 +58,7 @@
     {{#vendorExtensions.hasChildren}}open {{/vendorExtensions.hasChildren}}var {{{name}}}: {{{vendorExtensions.typeWithEnumWithGenericAnnotations}}} = {{#defaultValue}}{{{.}}}{{/defaultValue}}{{^defaultValue}}null{{/defaultValue}},
     {{/vendorExtensions.optionalVars}}
 {{/vendorExtensions.withInheritance}}
-{{/formatNoEmptyLines}}){{#parent}}: {{{parent}}}({{#vendorExtensions.requiredParentVarsWithoutDiscriminator}}{{name}}{{^-last}}, {{/-last}}{{/vendorExtensions.requiredParentVarsWithoutDiscriminator}}) {{/parent}}{{#vendorExtensions.x-implements}}{{#parent}}, {{/parent}}{{^parent}}: {{/parent}}{{^-first}}, {{{.}}}{{/-first}}{{#-last}} {{/-last}}{{/vendorExtensions.x-implements}} {{openbrace}}
+{{/formatNoEmptyLines}}){{#parent}}: {{{parent}}}({{#vendorExtensions.requiredParentVarsWithoutDiscriminator}}{{name}}{{^-last}}, {{/-last}}{{/vendorExtensions.requiredParentVarsWithoutDiscriminator}}) {{/parent}}{{#vendorExtensions.x-implements}}{{#parent}}, {{/parent}}{{^parent}}: {{/parent}}{{^-first}}, {{/-first}}{{{.}}}{{/vendorExtensions.x-implements}} {{openbrace}}
 
     {{#vendorExtensions.withInheritance}}
 
diff --git a/openapi-generator/src/test/java/io/micronaut/openapi/generator/JavaMicronautClientCodegenTest.java b/openapi-generator/src/test/java/io/micronaut/openapi/generator/JavaMicronautClientCodegenTest.java
@@ -478,4 +478,15 @@ public void setTitle(String title) {
                         """
         );
     }
+
+    @Test
+    void testOneOf() {
+
+        var codegen = new JavaMicronautClientCodegen();
+        String outputPath = generateFiles(codegen, "src/test/resources/3_0/oneof-with-discriminator.yml", CodegenConstants.APIS, CodegenConstants.MODELS);
+        String path = outputPath + "src/main/java/org/openapitools/";
+
+        assertFileContains(path + "model/Subject.java", "public String getTypeCode();");
+        assertFileContains(path + "model/Person.java", "public String getTypeCode() {");
+    }
 }
diff --git a/openapi-generator/src/test/java/io/micronaut/openapi/generator/KotlinMicronautClientCodegenTest.java b/openapi-generator/src/test/java/io/micronaut/openapi/generator/KotlinMicronautClientCodegenTest.java
@@ -527,4 +527,15 @@ data class Book(
                             var title: String,
                         """);
     }
+
+    @Test
+    void testOneOf() {
+
+        var codegen = new KotlinMicronautClientCodegen();
+        String outputPath = generateFiles(codegen, "src/test/resources/3_0/oneof-with-discriminator.yml", CodegenConstants.APIS, CodegenConstants.MODELS);
+        String path = outputPath + "src/main/kotlin/org/openapitools/";
+
+        assertFileContains(path + "model/Subject.kt", "val typeCode: String");
+        assertFileContains(path + "model/Person.kt", "override var typeCode: String = \"PERS\",");
+    }
 }
diff --git a/openapi-generator/src/test/resources/3_0/oneof-with-discriminator.yml b/openapi-generator/src/test/resources/3_0/oneof-with-discriminator.yml
@@ -0,0 +1,100 @@
+openapi: 3.0.0
+info:
+  description: This is a library API
+  version: 1.0.0
+  title: Library
+  license:
+    name: Apache-2.0
+    url: "https://www.apache.org/licenses/LICENSE-2.0.html"
+tags:
+  - name: books
+    description: Add books
+paths:
+  /add-subject:
+    post:
+      tags: [ subjects ]
+      summary: Add a new subject
+      operationId: addSubject
+      requestBody:
+        required: true
+        content:
+          "application/json":
+            schema:
+              $ref: "#/components/schemas/subject"
+      responses:
+        "200":
+          description: Success
+          content:
+            "application/json":
+              schema:
+                $ref: "#/components/schemas/subject"
+        "400":
+          description: Bad Request
+components:
+  schemas:
+    subject:
+      oneOf:
+        - $ref: '#/components/schemas/organization'
+        - $ref: '#/components/schemas/corporation'
+        - $ref: '#/components/schemas/person'
+      discriminator:
+        propertyName: typeCode
+        mapping:
+          ORG: '#/components/schemas/organization'
+          CORP: '#/components/schemas/corporation'
+          PERS: '#/components/schemas/person'
+    organization:
+      type: object
+      required:
+        - typeCode
+        - orgName
+      description: Organization customer data
+      properties:
+        typeCode:
+          type: string
+          pattern: ^ORG$
+          description: Customer type ORG
+          default: ORG
+          example: ORG
+        orgName:
+          type: string
+    corporation:
+      type: object
+      required:
+        - typeCode
+        - corpName
+        - directorName
+      description: Corporation customer data
+      properties:
+        typeCode:
+          description: Customer type CORP
+          type: string
+          pattern: ^CORP$
+          default: CORP
+          example: CORP
+        corpName:
+          type: string
+          description: Corporation name
+          example: Micronaut
+        directorName:
+          type: string
+          description: Director name
+          example: John
+    person:
+      type: object
+      required:
+        - typeCode
+        - personName
+        - inn
+        - account
+      description: Person customer data
+      properties:
+        typeCode:
+          type: string
+          pattern: ^PERS$
+          default: PERS
+          description: Customer type PERS
+          example: PERS
+        personName:
+          type: string
+          description: Person name
diff --git a/test-suite-generator-util/src/main/java/io/micronaut/openapi/testsuite/GeneratorMain.java b/test-suite-generator-util/src/main/java/io/micronaut/openapi/testsuite/GeneratorMain.java
