fix(kotlin-spring): add parentCtorCallNeeded model template property

.github/workflows/samples-kotlin-server.yaml

@@ -41,6 +41,7 @@ jobs:
           - samples/server/petstore/kotlin-springboot-source-swagger2
           - samples/server/petstore/kotlin-springboot-x-kotlin-implements
           - samples/server/petstore/kotlin-springboot-include-http-request-context-delegate
+          - samples/server/petstore/kotlin-spring-issue8366-inheritance-parent-ctor-call
           - samples/server/petstore/kotlin-server/ktor2
           - samples/server/petstore/kotlin-server/jaxrs-spec
           - samples/server/petstore/kotlin-server/jaxrs-spec-mutiny

bin/configs/kotlin-spring-issue8366-inheritance-parent-ctor-call.yaml

@@ -0,0 +1,12 @@
+generatorName: kotlin-spring
+outputDir: samples/server/petstore/kotlin-spring-issue8366-inheritance-parent-ctor-call
+library: spring-boot
+inputSpec: modules/openapi-generator/src/test/resources/3_0/kotlin/issue8366-inheritance-parent-ctor-call.yaml
+templateDir: modules/openapi-generator/src/main/resources/kotlin-spring
+additionalProperties:
+  documentationProvider: springdoc
+  annotationLibrary: swagger2
+  useSwaggerUI: "true"
+  serviceImplementation: "true"
+  reactive: "true"
+  beanValidations: "false"

modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/AbstractKotlinCodegen.java

@@ -123,6 +123,8 @@ public enum KotlinEnumNamingType {
     // ref: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-hash-map/
     protected Set<String> propertyAdditionalKeywords = new HashSet<>(Arrays.asList("entries", "keys", "size", "values"));
 
+    private final List<Pattern> PARENT_TYPES_NEEDING_CTOR_CALL = List.of(Pattern.compile("^kotlin\\.collections\\.HashMap.*"));
+
     private final Map<String, String> schemaKeyToModelNameCache = new HashMap<>();
     @Getter @Setter
     protected List<String> additionalModelTypeAnnotations = new LinkedList<>();
@@ -498,10 +500,46 @@ public ModelsMap postProcessModels(ModelsMap objs) {
                     break;
                 }
             }
+
+            final boolean isParentCtorCallNeeded = isParentCtorCallNeeded(cm);
+            cm.vendorExtensions.put("x-is-parent-ctor-call-needed", isParentCtorCallNeeded);
         }
         return postProcessModelsEnum(objs);
     }
 
+    /**
+     * Determines if a constructor call is needed for the parent type of a model
+     * and if yes, the invocation syntax `()` is added in the generated code.
+     *
+     * Important note: This is kotlin specific at the moment, but could be
+     * extended with to support detection for other languages as well.
+     *
+     * The generator used to default to issuing a supertype
+     * constructor call and then it was changed to default to not doing it.
+     * Both are wrong since there are different cases and the decision has to be
+     * made at runtime based on the parent type itself.
+     *
+     * For example if it is a HashMap (because you set
+     * additionalProperties: true for example) then it MUST HAVE a parent
+     * constructor call. If the parent type is an interface because you are
+     * using allOf with a discriminator property then the generated code for the
+     * model will have it's parent type as the interface which MUST NOT HAVE a
+     * parent constructor call.
+     *
+     * @see https://github.com/OpenAPITools/openapi-generator/issues/8366
+     *
+     * @return {boolean} `true` if the () call syntax is needed, false otherwise.
+     */
+    protected boolean isParentCtorCallNeeded(CodegenModel cm) {
+        final String parent = cm.getParent();
+
+        if (parent != null) {
+            return PARENT_TYPES_NEEDING_CTOR_CALL.stream()
+                    .anyMatch(pattern -> pattern.matcher(parent).matches());
+        }
+        return false;
+    }
+
     @Override
     public OperationsMap postProcessOperationsWithModels(OperationsMap objs, List<ModelMap> allModels) {
         handleImplicitHeaders(objs);

modules/openapi-generator/src/main/resources/kotlin-spring/dataClass.mustache

@@ -21,9 +21,9 @@
 {{/hasOptional}}{{/hasRequired}}{{#optionalVars}}{{>dataClassOptVar}}{{^-last}},
 {{/-last}}{{/optionalVars}}
 ){{/discriminator}}{{! no newline
-}}{{#parent}} : {{{.}}}{{#isMap}}(){{/isMap}}{{! no newline
-      }}{{#vendorExtensions.x-kotlin-implements}}, {{{.}}}{{/vendorExtensions.x-kotlin-implements}}{{! <- serializableModel is also handled via x-kotlin-implements
-      }}{{#vendorExtensions.x-implements-sealed-interfaces}}{{#.}}, {{{.}}}{{/.}}{{/vendorExtensions.x-implements-sealed-interfaces}}{{! <- add sealed interface implementations
+}}{{#parent}} : {{{.}}}{{#vendorExtensions.x-is-parent-ctor-call-needed}}(){{/vendorExtensions.x-is-parent-ctor-call-needed}}{{! no newline
+    }}{{#vendorExtensions.x-kotlin-implements}}, {{{.}}}{{/vendorExtensions.x-kotlin-implements}}{{! no newline
+    }}{{#vendorExtensions.x-implements-sealed-interfaces}}{{#.}}, {{{.}}}{{/.}}{{/vendorExtensions.x-implements-sealed-interfaces}}{{! no newline
 }}{{/parent}}{{! no newline
 }}{{^parent}}{{! no newline
     }}{{#vendorExtensions.x-kotlin-implements}}{{! no newline

modules/openapi-generator/src/test/java/org/openapitools/codegen/kotlin/spring/KotlinSpringServerCodegenTest.java

@@ -1248,6 +1248,108 @@ public void generateSerializableModelWithXimplementsSkipAndSchemaImplements() th
         );
     }
 
+    @Test
+    public void generateSerializableModelWithParentCtorCallNeeded() throws Exception {
+        File output = Files.createTempDirectory("test").toFile().getCanonicalFile();
+        output.deleteOnExit();
+        String outputPath = output.getAbsolutePath().replace('\\', '/');
+
+        KotlinSpringServerCodegen codegen = new KotlinSpringServerCodegen();
+        codegen.setOutputDir(output.getAbsolutePath());
+        codegen.additionalProperties().put(CodegenConstants.SERIALIZABLE_MODEL, true);
+
+        ClientOptInput input = new ClientOptInput()
+                .openAPI(TestUtils.parseSpec("src/test/resources/3_0/kotlin/issue8366-inheritance-parent-ctor-call.yaml"))
+                .config(codegen);
+        DefaultGenerator generator = new DefaultGenerator();
+
+        generator.setGeneratorPropertyDefault(CodegenConstants.MODELS, "true");
+        generator.setGeneratorPropertyDefault(CodegenConstants.MODEL_TESTS, "false");
+        generator.setGeneratorPropertyDefault(CodegenConstants.MODEL_DOCS, "false");
+        generator.setGeneratorPropertyDefault(CodegenConstants.APIS, "false");
+        generator.setGeneratorPropertyDefault(CodegenConstants.SUPPORTING_FILES, "false");
+
+        generator.opts(input).generate();
+
+        Path path = Paths.get(outputPath + "/src/main/kotlin/org/openapitools/model/JarFile.kt");
+        assertFileContains(
+                path,
+                ") : kotlin.collections.HashMap<String, kotlin.Any>(), java.io.Serializable {",
+                "private const val serialVersionUID: kotlin.Long = 1"
+        );
+        assertFileNotContains(path, ") : kotlin.collections.HashMap<String, kotlin.Any> {");
+    }
+
+    @Test
+    public void generateNonSerializableModelWithParentCtorCallNeeded() throws Exception {
+        File output = Files.createTempDirectory("test").toFile().getCanonicalFile();
+        output.deleteOnExit();
+        String outputPath = output.getAbsolutePath().replace('\\', '/');
+
+        KotlinSpringServerCodegen codegen = new KotlinSpringServerCodegen();
+        codegen.setOutputDir(output.getAbsolutePath());
+
+        ClientOptInput input = new ClientOptInput()
+                .openAPI(TestUtils.parseSpec("src/test/resources/3_0/kotlin/issue8366-inheritance-parent-ctor-call.yaml"))
+                .config(codegen);
+        DefaultGenerator generator = new DefaultGenerator();
+
+        generator.setGeneratorPropertyDefault(CodegenConstants.MODELS, "true");
+        generator.setGeneratorPropertyDefault(CodegenConstants.MODEL_TESTS, "false");
+        generator.setGeneratorPropertyDefault(CodegenConstants.MODEL_DOCS, "false");
+        generator.setGeneratorPropertyDefault(CodegenConstants.APIS, "false");
+        generator.setGeneratorPropertyDefault(CodegenConstants.SUPPORTING_FILES, "false");
+
+        generator.opts(input).generate();
+
+        Path path = Paths.get(outputPath + "/src/main/kotlin/org/openapitools/model/JarFile.kt");
+        assertFileContains(
+                path,
+                ") : kotlin.collections.HashMap<String, kotlin.Any>() {"
+        );
+        assertFileNotContains(
+                path,
+                "java.io.Serializable",
+                ") : kotlin.collections.HashMap<String, kotlin.Any> {"
+        );
+    }
+
+    @Test
+    public void generateNonSerializableModelWithParentCtorCallNeededAndXimplements() throws Exception {
+        File output = Files.createTempDirectory("test").toFile().getCanonicalFile();
+        output.deleteOnExit();
+        String outputPath = output.getAbsolutePath().replace('\\', '/');
+
+        KotlinSpringServerCodegen codegen = new KotlinSpringServerCodegen();
+        codegen.setOutputDir(output.getAbsolutePath());
+        codegen.additionalProperties().put(KotlinSpringServerCodegen.SCHEMA_IMPLEMENTS, Map.of(
+                "JarFile", List.of("com.some.pack.ExtraInterface")
+        ));
+
+        ClientOptInput input = new ClientOptInput()
+                .openAPI(TestUtils.parseSpec("src/test/resources/3_0/kotlin/issue8366-inheritance-parent-ctor-call.yaml"))
+                .config(codegen);
+        DefaultGenerator generator = new DefaultGenerator();
+
+        generator.setGeneratorPropertyDefault(CodegenConstants.MODELS, "true");
+        generator.setGeneratorPropertyDefault(CodegenConstants.MODEL_TESTS, "false");
+        generator.setGeneratorPropertyDefault(CodegenConstants.MODEL_DOCS, "false");
+        generator.setGeneratorPropertyDefault(CodegenConstants.APIS, "false");
+        generator.setGeneratorPropertyDefault(CodegenConstants.SUPPORTING_FILES, "false");
+
+        generator.opts(input).generate();
+
+        Path path = Paths.get(outputPath + "/src/main/kotlin/org/openapitools/model/JarFile.kt");
+        assertFileContains(
+                path,
+                ") : kotlin.collections.HashMap<String, kotlin.Any>(), com.some.pack.ExtraInterface {"
+        );
+        assertFileNotContains(
+                path,
+                "java.io.Serializable"
+        );
+    }
+
     @Test
     public void generateHttpInterfaceReactiveWithReactorResponseEntity() throws Exception {
         File output = Files.createTempDirectory("test").toFile().getCanonicalFile();

modules/openapi-generator/src/test/resources/3_0/kotlin/issue8366-inheritance-parent-ctor-call.yaml

@@ -0,0 +1,93 @@
+openapi: 3.0.3
+info:
+  version: "1.0.0"
+  title: ""
+paths:
+  /documents/v1:
+    get:
+      responses:
+        200:
+          description: lorem
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: "#/components/schemas/ParentSchema"
+components:
+  schemas:
+    JarFiles:
+      type: array
+      items:
+        $ref: "#/components/schemas/JarFile"
+    JarFile:
+      type: object
+      required:
+      - filename
+      - contentBase64
+      - hasDbMigrations
+      additionalProperties: true
+      properties:
+        filename:
+          type: string
+          nullable: false
+          minLength: 1
+          maxLength: 255
+        hasDbMigrations:
+          description: Indicates whether the cordapp jar in question contains any
+            embedded migrations that Cactus can/should execute between copying the
+            jar into the cordapp directory and starting the node back up.
+          type: boolean
+          nullable: false
+        contentBase64:
+          type: string
+          format: base64
+          nullable: false
+          minLength: 1
+          maxLength: 1073741824
+
+    ParentSchema:
+      type: object
+      properties:
+        id:
+          type: string
+        type:
+          $ref: "#/components/schemas/DiscriminatingType"
+      discriminator:
+        propertyName: type
+        mapping:
+          subtypeA: "#/components/schemas/SubtypeA"
+          subtypeB: "#/components/schemas/SubtypeB"
+          subtypeC: "#/components/schemas/SubtypeC"
+    SubtypeA:
+      type: object
+      allOf:
+        - $ref: '#/components/schemas/ParentSchema'
+        - type: object
+          properties:
+            subtypeAproperty:
+              type: integer
+    SubtypeB:
+      type: object
+      allOf:
+        - $ref: '#/components/schemas/ParentSchema'
+        - type: object
+          properties:
+            subtypeBproperty:
+              type: string
+    SubtypeC:
+      type: object
+      additionalProperties: true
+      allOf:
+        - $ref: '#/components/schemas/ParentSchema'
+        - type: object
+          properties:
+            subtypeAproperty:
+              type: integer
+
+    DiscriminatingType:
+      type: string
+      enum:
+        - subtypeA
+        - subtypeB
+        - subtypeC

samples/server/petstore/kotlin-spring-issue8366-inheritance-parent-ctor-call/.openapi-generator-ignore

@@ -0,0 +1,23 @@
+# OpenAPI Generator Ignore
+# Generated by openapi-generator https://github.com/openapitools/openapi-generator
+
+# Use this file to prevent files from being overwritten by the generator.
+# The patterns follow closely to .gitignore or .dockerignore.
+
+# As an example, the C# client generator defines ApiClient.cs.
+# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
+#ApiClient.cs
+
+# You can match any string of characters against a directory, file or extension with a single asterisk (*):
+#foo/*/qux
+# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
+
+# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
+#foo/**/qux
+# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
+
+# You can also negate patterns with an exclamation (!).
+# For example, you can ignore all files in a docs folder with the file extension .md:
+#docs/*.md
+# Then explicitly reverse the ignore rule for a single file:
+#!docs/README.md

samples/server/petstore/kotlin-spring-issue8366-inheritance-parent-ctor-call/.openapi-generator/FILES

@@ -0,0 +1,23 @@
+README.md
+build.gradle.kts
+gradle/wrapper/gradle-wrapper.jar
+gradle/wrapper/gradle-wrapper.properties
+gradlew
+gradlew.bat
+pom.xml
+settings.gradle
+src/main/kotlin/org/openapitools/Application.kt
+src/main/kotlin/org/openapitools/HomeController.kt
+src/main/kotlin/org/openapitools/api/ApiUtil.kt
+src/main/kotlin/org/openapitools/api/DocumentsApiController.kt
+src/main/kotlin/org/openapitools/api/DocumentsApiService.kt
+src/main/kotlin/org/openapitools/api/DocumentsApiServiceImpl.kt
+src/main/kotlin/org/openapitools/configuration/EnumConverterConfiguration.kt
+src/main/kotlin/org/openapitools/model/DiscriminatingType.kt
+src/main/kotlin/org/openapitools/model/JarFile.kt
+src/main/kotlin/org/openapitools/model/ParentSchema.kt
+src/main/kotlin/org/openapitools/model/SubtypeA.kt
+src/main/kotlin/org/openapitools/model/SubtypeB.kt
+src/main/kotlin/org/openapitools/model/SubtypeC.kt
+src/main/resources/application.yaml
+src/main/resources/openapi.yaml

samples/server/petstore/kotlin-spring-issue8366-inheritance-parent-ctor-call/.openapi-generator/VERSION

@@ -0,0 +1 @@
+7.24.0-SNAPSHOT

samples/server/petstore/kotlin-spring-issue8366-inheritance-parent-ctor-call/README.md

@@ -0,0 +1,21 @@
+# 
+
+This Kotlin based [Spring Boot](https://spring.io/projects/spring-boot) application has been generated using the [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator).
+
+## Getting Started
+
+This document assumes you have either maven or gradle available, either via the wrapper or otherwise. This does not come with a gradle / maven wrapper checked in.
+
+By default a [`pom.xml`](pom.xml) file will be generated. If you specified `gradleBuildFile=true` when generating this project, a `build.gradle.kts` will also be generated. Note this uses [Gradle Kotlin DSL](https://github.com/gradle/kotlin-dsl).
+
+To build the project using maven, run:
+```bash
+mvn package && java -jar target/openapi-spring-1.0.0.jar
+```
+
+To build the project using gradle, run:
+```bash
+gradle build && java -jar build/libs/openapi-spring-1.0.0.jar
+```
+
+If all builds successfully, the server should run on [http://localhost:8080/](http://localhost:8080/)