Kotlin: Add option to add defaults to nullable fields (#863)

zmack · web-flow · commit 96bdde748baf · 2021-11-10T21:13:52.000-05:00
diff --git a/docs/codegen-options.md b/docs/codegen-options.md
@@ -56,6 +56,7 @@ See [DirectiveAnnotationsMapping](#option-directiveannotationsmapping)* |
 | `responseProjectionMaxDepth`                          | Integer                                                               | 3                                                      | Sets max depth when use `all$()` which for facilitating the construction of projection automatically, the fields on all projections are provided when it be invoked. This is a global configuration, of course, you can use `all$(max)` to set for each method. For self recursive types, too big depth may result in a large number of returned data!|
 | `generatedLanguage`                                   | Enum                                                                  | GeneratedLanguage.JAVA                                 | Choose which language you want to generate, Java,Scala,Kotlin were supported. Note that due to language features, there are slight differences in default values between languages.|
 | `generateModelOpenClasses`                            | Boolean                                                               | false                                                  | The class type of the generated model. If true, generate normal classes, else generate data classes. It only support in kotlin(```data class```) and scala(```case class```). Maybe we will consider to support Java ```record``` in the future.|
+| `initializeNullableTypes`                             | Boolean                                                               | false                                                  | Adds a default null value to nullable arguments. Only supported in Kotlin.
 | `typesAsInterfaces`                                   | Set(String)                                                           | Empty                                                  | Types that must generated as interfaces should be defined here in format: `TypeName` or `@directive`. E.g.: `User`, `@asInterface`. |
 
 ### Option `graphqlSchemas`
diff --git a/plugins/gradle/graphql-java-codegen-gradle-plugin/src/main/java/io/github/kobylynskyi/graphql/codegen/gradle/GraphQLCodegenGradleTask.java b/plugins/gradle/graphql-java-codegen-gradle-plugin/src/main/java/io/github/kobylynskyi/graphql/codegen/gradle/GraphQLCodegenGradleTask.java
@@ -103,6 +103,7 @@ public class GraphQLCodegenGradleTask extends DefaultTask implements GraphQLCode
     private List<String> configurationFiles;
     private GeneratedLanguage generatedLanguage = MappingConfigConstants.DEFAULT_GENERATED_LANGUAGE;
     private Boolean generateModelOpenClasses = MappingConfigConstants.DEFAULT_GENERATE_MODEL_OPEN_CLASSES;
+    private Boolean initializeNullableTypes = MappingConfigConstants.DEFAULT_INITIALIZE_NULLABLE_TYPES;
 
     public GraphQLCodegenGradleTask() {
         setGroup("codegen");
@@ -178,6 +179,7 @@ public void generate() throws Exception {
 
         mappingConfig.setGeneratedLanguage(generatedLanguage);
         mappingConfig.setGenerateModelOpenClasses(generateModelOpenClasses);
+        mappingConfig.setInitializeNullableTypes(initializeNullableTypes);
 
         instantiateCodegen(mappingConfig).generate();
     }
@@ -844,4 +846,15 @@ public Boolean isGenerateModelOpenClasses() {
     public void setGenerateModelOpenClasses(Boolean generateModelOpenClasses) {
         this.generateModelOpenClasses = generateModelOpenClasses;
     }
+
+    @Input
+    @Optional
+    @Override
+    public Boolean isInitializeNullableTypes() {
+        return initializeNullableTypes;
+    }
+
+    public void setInitializeNullableTypes(Boolean initializeNullableTypes) {
+        this.initializeNullableTypes = initializeNullableTypes;
+    }
 }
diff --git a/plugins/maven/graphql-java-codegen-maven-plugin/src/main/java/io/github/kobylynskyi/graphql/codegen/GraphQLCodegenMojo.java b/plugins/maven/graphql-java-codegen-maven-plugin/src/main/java/io/github/kobylynskyi/graphql/codegen/GraphQLCodegenMojo.java
@@ -209,6 +209,9 @@ public class GraphQLCodegenMojo extends AbstractMojo implements GraphQLCodegenCo
     @Parameter(defaultValue = MappingConfigConstants.DEFAULT_GENERATE_MODEL_OPEN_CLASSES_STRING)
     private boolean generateModelOpenClasses;
 
+    @Parameter(defaultValue = MappingConfigConstants.DEFAULT_INITIALIZE_NULLABLE_TYPES_STRING)
+    private boolean initializeNullableTypes;
+
     @Override
     public void execute() throws MojoExecutionException {
         addCompileSourceRootIfConfigured();
@@ -267,6 +270,7 @@ public void execute() throws MojoExecutionException {
 
         mappingConfig.setGeneratedLanguage(generatedLanguage);
         mappingConfig.setGenerateModelOpenClasses(isGenerateModelOpenClasses());
+        mappingConfig.setInitializeNullableTypes(isInitializeNullableTypes());
 
         try {
             instantiateCodegen(mappingConfig).generate();
@@ -603,6 +607,11 @@ public Boolean isGenerateModelOpenClasses() {
         return generateModelOpenClasses;
     }
 
+    @Override
+    public Boolean isInitializeNullableTypes() {
+        return initializeNullableTypes;
+    }
+
     public ParentInterfacesConfig getParentInterfaces() {
         return parentInterfaces;
     }
diff --git a/src/main/java/com/kobylynskyi/graphql/codegen/kotlin/KotlinGraphQLCodegen.java b/src/main/java/com/kobylynskyi/graphql/codegen/kotlin/KotlinGraphQLCodegen.java
@@ -49,6 +49,9 @@ protected void initDefaultValues(MappingConfig mappingConfig) {
         if (mappingConfig.isGenerateModelOpenClasses() == null) {
             mappingConfig.setGenerateModelOpenClasses(false);
         }
+        if (mappingConfig.isInitializeNullableTypes() == null) {
+            mappingConfig.setInitializeNullableTypes(false);
+        }
         if (mappingConfig.getGenerateBuilder() == null) {
             // functional expression
             mappingConfig.setGenerateBuilder(false);
diff --git a/src/main/java/com/kobylynskyi/graphql/codegen/mapper/FieldDefinitionsToResolverDataModelMapper.java b/src/main/java/com/kobylynskyi/graphql/codegen/mapper/FieldDefinitionsToResolverDataModelMapper.java
@@ -24,6 +24,7 @@
 import java.util.Set;
 import java.util.stream.Collectors;
 
+import static com.kobylynskyi.graphql.codegen.model.DataModelFields.INITIALIZE_NULLABLE_TYPES;
 import static com.kobylynskyi.graphql.codegen.model.DataModelFields.CLASS_NAME;
 import static com.kobylynskyi.graphql.codegen.model.DataModelFields.ENUM_IMPORT_IT_SELF_IN_SCALA;
 import static com.kobylynskyi.graphql.codegen.model.DataModelFields.GENERATED_ANNOTATION;
@@ -162,6 +163,7 @@ private Map<String, Object> mapToResolverModel(MappingContext mappingContext, St
         dataModel.put(GENERATED_INFO, mappingContext.getGeneratedInformation());
         dataModel.put(ENUM_IMPORT_IT_SELF_IN_SCALA, mappingContext.getEnumImportItSelfInScala());
         dataModel.put(GENERATE_MODEL_OPEN_CLASSES, mappingContext.isGenerateModelOpenClasses());
+        dataModel.put(INITIALIZE_NULLABLE_TYPES, mappingContext.isInitializeNullableTypes());
         return dataModel;
     }
 
diff --git a/src/main/java/com/kobylynskyi/graphql/codegen/mapper/InputDefinitionToDataModelMapper.java b/src/main/java/com/kobylynskyi/graphql/codegen/mapper/InputDefinitionToDataModelMapper.java
@@ -8,6 +8,7 @@
 import java.util.Map;
 
 import static com.kobylynskyi.graphql.codegen.model.DataModelFields.ANNOTATIONS;
+import static com.kobylynskyi.graphql.codegen.model.DataModelFields.INITIALIZE_NULLABLE_TYPES;
 import static com.kobylynskyi.graphql.codegen.model.DataModelFields.BUILDER;
 import static com.kobylynskyi.graphql.codegen.model.DataModelFields.CLASS_NAME;
 import static com.kobylynskyi.graphql.codegen.model.DataModelFields.ENUM_IMPORT_IT_SELF_IN_SCALA;
@@ -67,6 +68,7 @@ public Map<String, Object> map(MappingContext mappingContext, ExtendedInputObjec
         dataModel.put(GENERATED_INFO, mappingContext.getGeneratedInformation());
         dataModel.put(ENUM_IMPORT_IT_SELF_IN_SCALA, mappingContext.getEnumImportItSelfInScala());
         dataModel.put(GENERATE_MODEL_OPEN_CLASSES, mappingContext.isGenerateModelOpenClasses());
+        dataModel.put(INITIALIZE_NULLABLE_TYPES, mappingContext.isInitializeNullableTypes());
         return dataModel;
     }
 
diff --git a/src/main/java/com/kobylynskyi/graphql/codegen/mapper/TypeDefinitionToDataModelMapper.java b/src/main/java/com/kobylynskyi/graphql/codegen/mapper/TypeDefinitionToDataModelMapper.java
@@ -18,6 +18,7 @@
 import java.util.stream.Collectors;
 
 import static com.kobylynskyi.graphql.codegen.model.DataModelFields.ANNOTATIONS;
+import static com.kobylynskyi.graphql.codegen.model.DataModelFields.INITIALIZE_NULLABLE_TYPES;
 import static com.kobylynskyi.graphql.codegen.model.DataModelFields.BUILDER;
 import static com.kobylynskyi.graphql.codegen.model.DataModelFields.CLASS_NAME;
 import static com.kobylynskyi.graphql.codegen.model.DataModelFields.ENUM_IMPORT_IT_SELF_IN_SCALA;
@@ -102,6 +103,7 @@ public Map<String, Object> map(MappingContext mappingContext,
         dataModel.put(ENUM_IMPORT_IT_SELF_IN_SCALA, mappingContext.getEnumImportItSelfInScala());
         dataModel.put(PARENT_INTERFACE_PROPERTIES, mappingContext.getParentInterfaceProperties());
         dataModel.put(GENERATE_MODEL_OPEN_CLASSES, mappingContext.isGenerateModelOpenClasses());
+        dataModel.put(INITIALIZE_NULLABLE_TYPES, mappingContext.isInitializeNullableTypes());
         return dataModel;
     }
 
diff --git a/src/main/java/com/kobylynskyi/graphql/codegen/model/DataModelFields.java b/src/main/java/com/kobylynskyi/graphql/codegen/model/DataModelFields.java
@@ -36,6 +36,7 @@ public final class DataModelFields {
     public static final String PARENT_INTERFACE_PROPERTIES = "parentInterfaceProperties";
     public static final String SERIALIZATION_LIBRARY = "serializationLibrary";
     public static final String GENERATE_MODEL_OPEN_CLASSES = "generateModelOpenClasses";
+    public static final String INITIALIZE_NULLABLE_TYPES = "initializeNullableTypes";
 
     private DataModelFields() {
     }
diff --git a/src/main/java/com/kobylynskyi/graphql/codegen/model/GraphQLCodegenConfiguration.java b/src/main/java/com/kobylynskyi/graphql/codegen/model/GraphQLCodegenConfiguration.java
@@ -446,4 +446,12 @@ public interface GraphQLCodegenConfiguration {
      */
     Boolean isGenerateModelOpenClasses();
 
+    /**
+     * Specifies whether classes should be generated with constructors setting the
+     * default value for nullable fields to null.
+     *
+     * @return <b>true</b> if nullable fields should be defaulted to null.
+     */
+    Boolean isInitializeNullableTypes();
+
 }
diff --git a/src/main/java/com/kobylynskyi/graphql/codegen/model/MappingConfig.java b/src/main/java/com/kobylynskyi/graphql/codegen/model/MappingConfig.java
@@ -78,6 +78,7 @@ public class MappingConfig implements GraphQLCodegenConfiguration, Combinable<Ma
     private Set<String> typesAsInterfaces = new HashSet<>();
 
     private boolean generateModelOpenClasses;
+    private boolean initializeNullableTypes;
 
     private GeneratedLanguage generatedLanguage;
 
@@ -185,6 +186,8 @@ public void combine(MappingConfig source) {
         generatedLanguage = getValueOrDefaultToThis(source, GraphQLCodegenConfiguration::getGeneratedLanguage);
         generateModelOpenClasses = getValueOrDefaultToThis(source,
                 GraphQLCodegenConfiguration::isGenerateModelOpenClasses);
+        initializeNullableTypes = getValueOrDefaultToThis(source,
+                GraphQLCodegenConfiguration::isInitializeNullableTypes);
     }
 
     private <T> T getValueOrDefaultToThis(MappingConfig source, Function<MappingConfig, T> getValueFunction) {
@@ -647,7 +650,6 @@ public void setGeneratedLanguage(GeneratedLanguage generatedLanguage) {
         this.generatedLanguage = generatedLanguage;
     }
 
-
     public Boolean isGenerateModelOpenClasses() {
         return generateModelOpenClasses;
     }
@@ -656,4 +658,12 @@ public void setGenerateModelOpenClasses(boolean generateModelOpenClasses) {
         this.generateModelOpenClasses = generateModelOpenClasses;
     }
 
+    public Boolean isInitializeNullableTypes() {
+        return initializeNullableTypes;
+    }
+
+    public void setInitializeNullableTypes(boolean initializeNullableTypes) {
+        this.initializeNullableTypes = initializeNullableTypes;
+    }
+
 }
diff --git a/src/main/java/com/kobylynskyi/graphql/codegen/model/MappingConfigConstants.java b/src/main/java/com/kobylynskyi/graphql/codegen/model/MappingConfigConstants.java
@@ -68,6 +68,10 @@ public class MappingConfigConstants {
     public static final boolean DEFAULT_GENERATE_MODEL_OPEN_CLASSES = false;
     public static final String DEFAULT_GENERATE_MODEL_OPEN_CLASSES_STRING = "false";
 
+    //Only supported in kotlin.
+    public static final boolean DEFAULT_INITIALIZE_NULLABLE_TYPES = false;
+    public static final String DEFAULT_INITIALIZE_NULLABLE_TYPES_STRING = "false";
+
 
     private MappingConfigConstants() {
     }
diff --git a/src/main/java/com/kobylynskyi/graphql/codegen/model/MappingContext.java b/src/main/java/com/kobylynskyi/graphql/codegen/model/MappingContext.java
@@ -57,6 +57,11 @@ public Boolean isGenerateModelOpenClasses() {
         return config.isGenerateModelOpenClasses();
     }
 
+    @Override
+    public Boolean isInitializeNullableTypes() {
+        return config.isInitializeNullableTypes();
+    }
+
     @Override
     public Map<String, String> getCustomTypesMapping() {
         return config.getCustomTypesMapping();
diff --git a/src/main/resources/templates/kotlin-lang/type.ftl b/src/main/resources/templates/kotlin-lang/type.ftl
@@ -68,7 +68,7 @@ open class ${className}()<#if implements?has_content> : <#list implements as int
     <#if parentInterfaces?has_content><#list parentInterfaces as parent><#if parent == field.name>override
     </#if></#list></#if><#if !immutableModels><#list field.annotations as annotation>@get:${annotation}
     </#list>var <#else><#list field.annotations as annotation>@get:${annotation}
-    </#list>val </#if>${field.name}: ${field.type}<#if field.defaultValue?has_content> = ${field.defaultValue}</#if><#if field_has_next>,</#if>
+    </#list>val </#if>${field.name}: ${field.type}<#if field.defaultValue?has_content> = ${field.defaultValue}<#elseif field.type?ends_with("?") && (initializeNullableTypes == true)> = null</#if><#if field_has_next>,</#if>
 </#list>
 </#if>
 )<#if implements?has_content> : <#list implements as interface>${interface}<#if interface_has_next>, </#if></#list></#if> {
diff --git a/src/test/java/com/kobylynskyi/graphql/codegen/kotlin/GraphQLCodegenInitializeNullableTypesTest.java b/src/test/java/com/kobylynskyi/graphql/codegen/kotlin/GraphQLCodegenInitializeNullableTypesTest.java
@@ -0,0 +1,53 @@
+package com.kobylynskyi.graphql.codegen.kotlin;
+
+import com.kobylynskyi.graphql.codegen.TestUtils;
+import com.kobylynskyi.graphql.codegen.model.GeneratedLanguage;
+import com.kobylynskyi.graphql.codegen.model.MappingConfig;
+import com.kobylynskyi.graphql.codegen.utils.Utils;
+import org.junit.jupiter.api.AfterEach;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+
+import java.io.File;
+import java.util.Objects;
+
+import static com.kobylynskyi.graphql.codegen.TestUtils.assertSameTrimmedContent;
+import static com.kobylynskyi.graphql.codegen.TestUtils.getFileByName;
+import static java.util.Collections.singletonList;
+
+class GraphQLCodegenInitializeNullableTypesTest {
+
+    private final File outputBuildDir = new File("build/generated");
+    private final File outputScalaClassesDir = new File("build/generated/com/github/graphql");
+    private final MappingConfig mappingConfig = new MappingConfig();
+
+    @BeforeEach
+    void init() {
+        mappingConfig.setGenerateParameterizedFieldsResolvers(false);
+        mappingConfig.setPackageName("com.github.graphql");
+        mappingConfig.setGeneratedLanguage(GeneratedLanguage.KOTLIN);
+        mappingConfig.setGenerateToString(true);
+        mappingConfig.setGenerateApis(true);
+        mappingConfig.setGenerateClient(true);
+        mappingConfig.setGenerateEqualsAndHashCode(true);
+        mappingConfig.setInitializeNullableTypes(true);
+        mappingConfig.setGenerateBuilder(true);
+    }
+
+    @AfterEach
+    void cleanup() {
+        Utils.deleteDir(outputBuildDir);
+    }
+
+    @Test
+    void generate_InitializeNullableTypes() throws Exception {
+        new KotlinGraphQLCodegen(singletonList("src/test/resources/schemas/github.graphqls"),
+                outputBuildDir, mappingConfig, TestUtils.getStaticGeneratedInfo()).generate();
+        File[] files = Objects.requireNonNull(outputScalaClassesDir.listFiles());
+
+        assertSameTrimmedContent(
+                new File("src/test/resources/expected-classes/kt/Commit_initialize_nullable_types.kt.txt"),
+                getFileByName(files, "Commit.kt"));
+    }
+
+}
diff --git a/src/test/resources/expected-classes/kt/Commit_initialize_nullable_types.kt.txt b/src/test/resources/expected-classes/kt/Commit_initialize_nullable_types.kt.txt

Original file line number	Diff line number	Diff line change
`@@ -36,6 +36,7 @@ public final class DataModelFields {`
`36`	`36`	`public static final String PARENT_INTERFACE_PROPERTIES = "parentInterfaceProperties";`
`37`	`37`	`public static final String SERIALIZATION_LIBRARY = "serializationLibrary";`
`38`	`38`	`public static final String GENERATE_MODEL_OPEN_CLASSES = "generateModelOpenClasses";`
	`39`	`+ public static final String INITIALIZE_NULLABLE_TYPES = "initializeNullableTypes";`
`39`	`40`
`40`	`41`	`private DataModelFields() {`
`41`	`42`	`}`
Original file line number	Diff line number	Diff line change
`@@ -78,6 +78,7 @@ public class MappingConfig implements GraphQLCodegenConfiguration, Combinable<Ma`
`78`	`78`	`private Set<String> typesAsInterfaces = new HashSet<>();`
`79`	`79`
`80`	`80`	`private boolean generateModelOpenClasses;`
	`81`	`+ private boolean initializeNullableTypes;`
`81`	`82`
`82`	`83`	`private GeneratedLanguage generatedLanguage;`
`83`	`84`
`@@ -185,6 +186,8 @@ public void combine(MappingConfig source) {`
`185`	`186`	`generatedLanguage = getValueOrDefaultToThis(source, GraphQLCodegenConfiguration::getGeneratedLanguage);`
`186`	`187`	`generateModelOpenClasses = getValueOrDefaultToThis(source,`
`187`	`188`	`GraphQLCodegenConfiguration::isGenerateModelOpenClasses);`
	`189`	`+ initializeNullableTypes = getValueOrDefaultToThis(source,`
	`190`	`+ GraphQLCodegenConfiguration::isInitializeNullableTypes);`
`188`	`191`	`}`
`189`	`192`
`190`	`193`	`private <T> T getValueOrDefaultToThis(MappingConfig source, Function<MappingConfig, T> getValueFunction) {`
`@@ -647,7 +650,6 @@ public void setGeneratedLanguage(GeneratedLanguage generatedLanguage) {`
`647`	`650`	`this.generatedLanguage = generatedLanguage;`
`648`	`651`	`}`
`649`	`652`
`650`		`-`
`651`	`653`	`public Boolean isGenerateModelOpenClasses() {`
`652`	`654`	`return generateModelOpenClasses;`
`653`	`655`	`}`
`@@ -656,4 +658,12 @@ public void setGenerateModelOpenClasses(boolean generateModelOpenClasses) {`
`656`	`658`	`this.generateModelOpenClasses = generateModelOpenClasses;`
`657`	`659`	`}`
`658`	`660`
	`661`	`+ public Boolean isInitializeNullableTypes() {`
	`662`	`+ return initializeNullableTypes;`
	`663`	`+ }`
	`664`	`+`
	`665`	`+ public void setInitializeNullableTypes(boolean initializeNullableTypes) {`
	`666`	`+ this.initializeNullableTypes = initializeNullableTypes;`
	`667`	`+ }`
	`668`	`+`
`659`	`669`	`}`