Implement inheritance and oneOf support in kotlin-client

Author: vlsergey

bin/configs/kotlin-client-oneOf.yaml

@@ -0,0 +1,9 @@
+generatorName: kotlin
+outputDir: samples/client/petstore/kotlin-client-oneOf
+inputSpec: modules/openapi-generator/src/test/resources/3_0/oneof_polymorphism_and_inheritance.yaml
+templateDir: modules/openapi-generator/src/main/resources/kotlin-client
+additionalProperties:
+  artifactId: kotlin-client-oneOf
+  library: jvm-ktor
+  serializationLibrary: jackson
+  sortParamsByRequiredFlag: false

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

@@ -2623,7 +2623,7 @@ protected void updateModelForComposedSchema(CodegenModel m, Schema schema, Map<S
 
         // TODO revise the logic below to set discriminator, xml attributes
         if (supportsInheritance || supportsMixins) {
-            m.allVars = new ArrayList<>();
+            m.allVars = m.allVars == null ? new ArrayList<>() : m.allVars;
             if (composed.getAllOf() != null) {
                 int modelImplCnt = 0; // only one inline object allowed in a ComposedModel
                 int modelDiscriminators = 0; // only one discriminator allowed in a ComposedModel

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

@@ -34,6 +34,7 @@
 import java.io.File;
 import java.io.IOException;
 import java.util.*;
+import java.util.function.BiConsumer;
 import java.util.function.Function;
 import java.util.regex.Pattern;
 import java.util.stream.Collectors;
@@ -407,10 +408,40 @@ public String modelFileFolder() {
         return outputFolder + File.separator + sourceFolder + File.separator + modelPackage().replace('.', File.separatorChar);
     }
 
+    private enum KotlinModelType {
+        INTERFACE("interface", "x-kotlin-interface"), OPEN_CLASS("open class", "x-kotlin-open-class"), DATA_CLASS(
+                "data class", "x-kotlin-data-class");
+
+        final String literal;
+        final String flag;
+
+        KotlinModelType(String literal, String flag) {
+            this.literal = literal;
+            this.flag = flag;
+        }
+    }
+
+    private enum CombinationType {
+        ALL_OF(it -> it.allOf), ONE_OF(it -> it.oneOf);
+        final Function<CodegenModel, Set<String>> modelNamesFunc;
+
+        CombinationType(Function<CodegenModel, Set<String>> modelNamesFunc) {
+            this.modelNamesFunc = modelNamesFunc;
+        }
+    }
+
+    private List<CodegenModel> getModels(CodegenModel cm, CombinationType ct) {
+        List<CodegenModel> interfaceModels = cm.getInterfaceModels();
+        Set<String> names = ct.modelNamesFunc.apply(cm);
+        if (names == null || interfaceModels == null) {
+            return Collections.emptyList();
+        }
+        return interfaceModels.stream().filter(it -> names.contains(it.classname)).collect(Collectors.toList());
+    }
+
     @Override
     public Map<String, ModelsMap> postProcessAllModels(Map<String, ModelsMap> objs) {
         objs = super.postProcessAllModels(objs);
-        objs = super.updateAllModels(objs);
 
         if (!additionalModelTypeAnnotations.isEmpty()) {
             for (String modelName : objs.keySet()) {
@@ -419,26 +450,118 @@ public Map<String, ModelsMap> postProcessAllModels(Map<String, ModelsMap> objs)
             }
         }
 
-        return objs;
-    }
+        final BiConsumer<CodegenModel, CodegenModel> markAsExtends = (childModel, superModel) -> {
+            ((Map<CodegenModel, CodegenModel>) childModel.vendorExtensions.computeIfAbsent("x-implements",
+                    (k) -> new IdentityHashMap<>())).put(superModel, superModel);
+            superModel.vendorExtensions.put("x-has-implementors", Boolean.TRUE);
+        };
 
-    @Override
-    public ModelsMap postProcessModels(ModelsMap objs) {
-        objs = super.postProcessModelsEnum(objs);
-        for (ModelMap mo : objs.getModels()) {
-            CodegenModel cm = mo.getModel();
-            if (cm.getDiscriminator() != null) {
-                cm.vendorExtensions.put("x-has-data-class-body", true);
-                break;
+        for (ModelsMap map : objs.values()) {
+            for (ModelMap mo : map.getModels()) {
+                CodegenModel codegenModel = mo.getModel();
+                for (CodegenModel referencedModel : getModels(codegenModel, CombinationType.ALL_OF)) {
+                    if (!referencedModel.name.equals(codegenModel.parent)) {
+                        markAsExtends.accept(codegenModel, referencedModel);
+                    }
+                }
+                for (CodegenModel interfaceModel : getModels(codegenModel, CombinationType.ONE_OF)) {
+                    markAsExtends.accept(interfaceModel, codegenModel);
+                }
             }
+        }
+
+        for (ModelsMap map : objs.values()) {
+            for (ModelMap mo : map.getModels()) {
+                CodegenModel cm = mo.getModel();
+
+                KotlinModelType kotlinType;
+                if (cm.getDiscriminator() != null || cm.vendorExtensions.get("x-has-implementors") == Boolean.TRUE) {
+                    kotlinType = KotlinModelType.INTERFACE;
+                } else if (cm.hasChildren) {
+                    kotlinType = KotlinModelType.OPEN_CLASS;
+                } else {
+                    kotlinType = KotlinModelType.DATA_CLASS;
+                }
+                cm.vendorExtensions.put("x-kotlin-model-type", kotlinType.literal);
+                cm.vendorExtensions.put(kotlinType.flag, true);
+                cm.vendorExtensions.put("x-parent-kotlin-interface",
+                        cm.parentModel != null && (cm.parentModel.getDiscriminator() != null || cm.vendorExtensions.get("x-has-implementors") == Boolean.TRUE));
 
-            for (CodegenProperty var : cm.vars) {
-                if (var.isEnum || isSerializableModel()) {
+                if (kotlinType != KotlinModelType.DATA_CLASS || isSerializableModel() || cm.vars.stream().anyMatch(var -> var.isEnum)) {
                     cm.vendorExtensions.put("x-has-data-class-body", true);
-                    break;
+                }
+
+                final Map<CodegenModel, CodegenModel> xImplements =
+                        (Map<CodegenModel, CodegenModel>) cm.vendorExtensions.getOrDefault("x-implements",
+                                Collections.emptyMap());
+                if (!xImplements.isEmpty()) {
+                    cm.vendorExtensions.put("x-kotlin-interfaces-list",
+                            xImplements.keySet().stream().filter(im -> im != cm.parentModel).map(CodegenModel::getClassname).sorted().collect(Collectors.joining(", ")));
+                }
+            }
+        }
+
+        // we need to add variables from parent to current model if current is data class
+        for (ModelsMap map : objs.values()) {
+            for (ModelMap mo : map.getModels()) {
+                final CodegenModel cm = mo.getModel();
+                final CodegenModel parentModel = cm.getParentModel();
+                final boolean selfIsInterface = Objects.equals(cm.getVendorExtensions().get("x-kotlin-model-type"),
+                        KotlinModelType.INTERFACE.literal);
+
+                if (!selfIsInterface && parentModel != null) {
+                    // TODO: handle other interfaces as well, not only parent? need test case
+                    Set<String> alreadyDefined =
+                            cm.getAllVars().stream().map(CodegenProperty::getName).collect(Collectors.toSet());
+                    for (CodegenProperty prop : parentModel.getVars()) {
+                        if (!alreadyDefined.contains(prop.name)) {
+                            cm.allVars.add(prop.clone());
+                            alreadyDefined.add(prop.name);
+                        }
+                    }
+                }
+            }
+        }
+
+        // mark all override variables as such
+        for (ModelsMap map : objs.values()) {
+            for (ModelMap mo : map.getModels()) {
+                CodegenModel cm = mo.getModel();
+                Set<String> inheritedPropertyNames = new TreeSet<>();
+
+                Collection<CodegenModel> interfaceModels =
+                        ((Map<CodegenModel, CodegenModel>) cm.getVendorExtensions().getOrDefault("x-implements",
+                                Collections.emptyMap())).values();
+                for (CodegenModel interfaceModel : interfaceModels) {
+                    interfaceModel.vars.stream().map(it -> it.name).forEach(inheritedPropertyNames::add);
+                    interfaceModel.allVars.stream().map(it -> it.name).forEach(inheritedPropertyNames::add);
+                }
+
+                final CodegenModel parentModel = cm.getParentModel();
+                if (parentModel != null) {
+                    parentModel.vars.stream().map(it -> it.name).forEach(inheritedPropertyNames::add);
+                    parentModel.allVars.stream().map(it -> it.name).forEach(inheritedPropertyNames::add);
+                }
+
+                for (CodegenProperty prop : cm.vars) {
+                    if (inheritedPropertyNames.contains(prop.name)) {
+                        prop.vendorExtensions.put("x-kotlin-override", Boolean.TRUE);
+                    }
+                }
+                for (CodegenProperty prop : cm.allVars) {
+                    if (inheritedPropertyNames.contains(prop.name)) {
+                        prop.vendorExtensions.put("x-kotlin-override", Boolean.TRUE);
+                    }
                 }
             }
         }
+
+        return objs;
+    }
+
+    @Override
+    public ModelsMap postProcessModels(ModelsMap objs) {
+        objs = super.postProcessModels(objs);
         return postProcessModelsEnum(objs);
     }
 
@@ -890,29 +1013,6 @@ protected boolean needToImport(String type) {
                 !type.contains(".");
     }
 
-    @Override
-    public CodegenModel fromModel(String name, Schema schema) {
-        CodegenModel m = super.fromModel(name, schema);
-        m.optionalVars = m.optionalVars.stream().distinct().collect(Collectors.toList());
-        // Update allVars/requiredVars/optionalVars with isInherited
-        // Each of these lists contains elements that are similar, but they are all cloned
-        // via CodegenModel.removeAllDuplicatedProperty and therefore need to be updated
-        // separately.
-        // First find only the parent vars via baseName matching
-        Map<String, CodegenProperty> allVarsMap = m.allVars.stream()
-                .collect(Collectors.toMap(CodegenProperty::getBaseName, Function.identity()));
-        allVarsMap.keySet()
-                .removeAll(m.vars.stream().map(CodegenProperty::getBaseName).collect(Collectors.toSet()));
-        // Update the allVars
-        allVarsMap.values().forEach(p -> p.isInherited = true);
-        // Update any other vars (requiredVars, optionalVars)
-        Stream.of(m.requiredVars, m.optionalVars)
-                .flatMap(List::stream)
-                .filter(p -> allVarsMap.containsKey(p.baseName))
-                .forEach(p -> p.isInherited = true);
-        return m;
-    }
-
     @Override
     public String toEnumValue(String value, String datatype) {
         if ("kotlin.Int".equals(datatype) || "kotlin.Long".equals(datatype)) {

modules/openapi-generator/src/main/resources/kotlin-client/data_class.mustache

@@ -62,13 +62,13 @@ import {{packageName}}.infrastructure.ITransformForStorage
 @Deprecated(message = "This schema is deprecated.")
 {{/isDeprecated}}
 {{>additionalModelTypeAnnotations}}
-{{#nonPublicApi}}internal {{/nonPublicApi}}{{#discriminator}}interface{{/discriminator}}{{^discriminator}}data class{{/discriminator}} {{classname}}{{^discriminator}} (
+{{#nonPublicApi}}internal {{/nonPublicApi}}{{vendorExtensions.x-kotlin-model-type}} {{classname}}{{^vendorExtensions.x-kotlin-interface}} (
 
 {{#allVars}}
 {{#required}}{{>data_class_req_var}}{{/required}}{{^required}}{{>data_class_opt_var}}{{/required}}{{^-last}},{{/-last}}
 
 {{/allVars}}
-){{/discriminator}}{{#parent}}{{^serializableModel}}{{^parcelizeModels}} : {{{parent}}}{{#isMap}}(){{/isMap}}{{#isArray}}(){{/isArray}}{{/parcelizeModels}}{{/serializableModel}}{{/parent}}{{#parent}}{{#serializableModel}}{{^parcelizeModels}} : {{{parent}}}{{#isMap}}(){{/isMap}}{{#isArray}}(){{/isArray}}, Serializable{{/parcelizeModels}}{{/serializableModel}}{{/parent}}{{#parent}}{{^serializableModel}}{{#parcelizeModels}} : {{{parent}}}{{#isMap}}(){{/isMap}}{{#isArray}}(){{/isArray}}, Parcelable{{/parcelizeModels}}{{/serializableModel}}{{/parent}}{{#parent}}{{#serializableModel}}{{#parcelizeModels}} : {{{parent}}}{{#isMap}}(){{/isMap}}{{#isArray}}(){{/isArray}}, Serializable, Parcelable{{/parcelizeModels}}{{/serializableModel}}{{/parent}}{{^parent}}{{#serializableModel}}{{^parcelizeModels}} : Serializable{{/parcelizeModels}}{{/serializableModel}}{{/parent}}{{^parent}}{{^serializableModel}}{{#parcelizeModels}} : Parcelable{{/parcelizeModels}}{{/serializableModel}}{{/parent}}{{^parent}}{{#serializableModel}}{{#parcelizeModels}} : Serializable, Parcelable{{/parcelizeModels}}{{/serializableModel}}{{/parent}}{{#generateRoomModels}}{{#parent}}, {{/parent}}{{^discriminator}}{{^parent}}:{{/parent}} ITransformForStorage<{{classname}}RoomModel>{{/discriminator}}{{/generateRoomModels}}{{#vendorExtensions.x-has-data-class-body}} {
+){{/vendorExtensions.x-kotlin-interface}}{{#parent}}{{^serializableModel}}{{^parcelizeModels}} : {{{parent}}}{{^isMap}}{{^isArray}}{{>data_class_parent_args}}{{/isArray}}{{/isMap}}{{#isMap}}(){{/isMap}}{{#isArray}}(){{/isArray}}{{/parcelizeModels}}{{/serializableModel}}{{/parent}}{{#parent}}{{#serializableModel}}{{^parcelizeModels}} : {{{parent}}}{{^isMap}}{{^isArray}}{{>data_class_parent_args}}{{/isArray}}{{/isMap}}{{#isMap}}(){{/isMap}}{{#isArray}}(){{/isArray}}, Serializable{{/parcelizeModels}}{{/serializableModel}}{{/parent}}{{#parent}}{{^serializableModel}}{{#parcelizeModels}} : {{{parent}}}{{^isMap}}{{^isArray}}{{>data_class_parent_args}}{{/isArray}}{{/isMap}}{{#isMap}}(){{/isMap}}{{#isArray}}(){{/isArray}}, Parcelable{{/parcelizeModels}}{{/serializableModel}}{{/parent}}{{#parent}}{{#serializableModel}}{{#parcelizeModels}} : {{{parent}}}{{^isMap}}{{^isArray}}{{>data_class_parent_args}}{{/isArray}}{{/isMap}}{{#isMap}}(){{/isMap}}{{#isArray}}(){{/isArray}}, Serializable, Parcelable{{/parcelizeModels}}{{/serializableModel}}{{/parent}}{{^parent}}{{#serializableModel}}{{^parcelizeModels}} : Serializable{{/parcelizeModels}}{{/serializableModel}}{{/parent}}{{^parent}}{{^serializableModel}}{{#parcelizeModels}} : Parcelable{{/parcelizeModels}}{{/serializableModel}}{{/parent}}{{^parent}}{{#serializableModel}}{{#parcelizeModels}} : Serializable, Parcelable{{/parcelizeModels}}{{/serializableModel}}{{/parent}}{{#generateRoomModels}}{{#parent}}, {{/parent}}{{^discriminator}}{{^parent}}:{{/parent}} ITransformForStorage<{{classname}}RoomModel>{{/discriminator}}{{/generateRoomModels}}{{#vendorExtensions.x-kotlin-interfaces-list}}{{#parent}},{{/parent}}{{^parent}} : {{/parent}}{{vendorExtensions.x-kotlin-interfaces-list}}{{/vendorExtensions.x-kotlin-interfaces-list}}{{#vendorExtensions.x-has-data-class-body}} {
 {{/vendorExtensions.x-has-data-class-body}}
 {{#generateRoomModels}}
     companion object { }
@@ -83,9 +83,9 @@ import {{packageName}}.infrastructure.ITransformForStorage
         private const val serialVersionUID: Long = 123
     }
 {{/serializableModel}}
-{{#discriminator}}{{#vars}}{{#required}}
+{{#vendorExtensions.x-kotlin-interface}}{{#vars}}{{#required}}
 {{>interface_req_var}}{{/required}}{{^required}}
-{{>interface_opt_var}}{{/required}}{{/vars}}{{/discriminator}}
+{{>interface_opt_var}}{{/required}}{{/vars}}{{/vendorExtensions.x-kotlin-interface}}
 {{#hasEnums}}
 {{#vars}}
 {{#isEnum}}

modules/openapi-generator/src/main/resources/kotlin-client/data_class_opt_var.mustache

@@ -18,4 +18,4 @@
     {{#deprecated}}
     @Deprecated(message = "This property is deprecated.")
     {{/deprecated}}
-    {{#multiplatform}}@SerialName(value = "{{{vendorExtensions.x-base-name-literal}}}") {{/multiplatform}}{{#isInherited}}override {{/isInherited}}{{>modelMutable}} {{{name}}}: {{#isArray}}{{#isList}}{{#uniqueItems}}kotlin.collections.{{#modelMutable}}Mutable{{/modelMutable}}Set{{/uniqueItems}}{{^uniqueItems}}kotlin.collections.{{#modelMutable}}Mutable{{/modelMutable}}List{{/uniqueItems}}{{/isList}}{{^isList}}kotlin.Array{{/isList}}<{{^items.isEnum}}{{^items.isPrimitiveType}}{{^items.isModel}}{{#kotlinx_serialization}}@Contextual {{/kotlinx_serialization}}{{/items.isModel}}{{/items.isPrimitiveType}}{{{items.dataType}}}{{/items.isEnum}}{{#items.isEnum}}{{classname}}.{{{nameInCamelCase}}}{{/items.isEnum}}>{{/isArray}}{{^isEnum}}{{^isArray}}{{{dataType}}}{{/isArray}}{{/isEnum}}{{#isEnum}}{{^isArray}}{{classname}}.{{{nameInCamelCase}}}{{/isArray}}{{/isEnum}}? = {{^defaultValue}}null{{/defaultValue}}{{#defaultValue}}{{^isNumber}}{{{defaultValue}}}{{/isNumber}}{{#isNumber}}{{^multiplatform}}{{{dataType}}}("{{{defaultValue}}}"){{/multiplatform}}{{#multiplatform}}({{{defaultValue}}}).toDouble(){{/multiplatform}}{{/isNumber}}{{/defaultValue}}
+    {{#multiplatform}}@SerialName(value = "{{{vendorExtensions.x-base-name-literal}}}") {{/multiplatform}}{{>model_override}}{{>model_open}}{{>modelMutable}} {{{name}}}: {{#isArray}}{{#isList}}{{#uniqueItems}}kotlin.collections.{{#modelMutable}}Mutable{{/modelMutable}}Set{{/uniqueItems}}{{^uniqueItems}}kotlin.collections.{{#modelMutable}}Mutable{{/modelMutable}}List{{/uniqueItems}}{{/isList}}{{^isList}}kotlin.Array{{/isList}}<{{^items.isEnum}}{{^items.isPrimitiveType}}{{^items.isModel}}{{#kotlinx_serialization}}@Contextual {{/kotlinx_serialization}}{{/items.isModel}}{{/items.isPrimitiveType}}{{{items.dataType}}}{{/items.isEnum}}{{#items.isEnum}}{{classname}}.{{{nameInCamelCase}}}{{/items.isEnum}}>{{/isArray}}{{^isEnum}}{{^isArray}}{{{dataType}}}{{/isArray}}{{/isEnum}}{{#isEnum}}{{^isArray}}{{classname}}.{{{nameInCamelCase}}}{{/isArray}}{{/isEnum}}? = {{^defaultValue}}null{{/defaultValue}}{{#defaultValue}}{{^isNumber}}{{{defaultValue}}}{{/isNumber}}{{#isNumber}}{{^multiplatform}}{{{dataType}}}("{{{defaultValue}}}"){{/multiplatform}}{{#multiplatform}}({{{defaultValue}}}).toDouble(){{/multiplatform}}{{/isNumber}}{{/defaultValue}}

modules/openapi-generator/src/main/resources/kotlin-client/data_class_parent_args.mustache

@@ -0,0 +1,2 @@
+{{^vendorExtensions.x-parent-kotlin-interface}}({{#parentModel.allVars}}
+    {{name}} = {{name}}{{^-last}},{{/-last}}{{/parentModel.allVars}}){{/vendorExtensions.x-parent-kotlin-interface}}