Generate jackson type id resolver annotation (#637)

* Generate Jackson resolver annotation on union interface

* Generate Jackson resolver (Java only)

* plug with gradle plugin & some fixes

* plug with maven plugin

* fix issue when model package was null or empty

* fix codestyle issue

* handle model name prefix & suffix

* support scala jackson-typeid annotations
support scala jackosn enum annotation

* support scala jackson-typeid annotations
support scala jackosn enum annotation

* codefix

* fix bug

* fix bug

* codestyle fix

* fix ci test

* fix checkstyle

* fix ci test

* refactor duplicated code in *GraphQLTypeMapper

* add GraphQLTypeMapper methods javadoc

* remove unecessary import

* refactor to use definition

Co-authored-by: 梦境迷离 <dreamylost@outlook.com>
Co-authored-by: 梦境迷离 <568845948@qq.com>

Author: gdhordain

docs/codegen-options.md

@@ -18,6 +18,7 @@
 | `generateImmutableModels`                             | Boolean                                                               | False                                                  | Specifies whether generated model classes should be immutable. |
 | `generateToString`                                    | Boolean                                                               | False                                                  | Specifies whether generated model classes should have toString method defined. |
 | `addGeneratedAnnotation`                              | Boolean                                                               | True                                                   | Specifies whether generated classes should have `@Generated` annotation. |
+| `generateJacksonTypeIdResolver`                       | Boolean                                                               | False                                                  | Specifies whether generated union interfaces should be annotated with a custom Jackson type id resolver generated in model package. |
 | `apiNamePrefix`                                       | String                                                                | Empty                                                  | Sets the prefix for GraphQL api classes (query, mutation, subscription). |
 | `apiNameSuffix`                                       | String                                                                | `Resolver`                                             | Sets the suffix for GraphQL api classes (query, mutation, subscription). |
 | `apiInterfaceStrategy`                                | *See<br>[ApiInterfaceStrategy](#option-apiinterfacestrategy)*         | `INTERFACE_PER_OPERATION`                              | *See [ApiInterfaceStrategy](#option-apiinterfacestrategy)* |

plugins/gradle/graphql-java-codegen-gradle-plugin/src/main/java/io/github/kobylynskyi/graphql/codegen/gradle/GraphQLCodegenGradleTask.java

@@ -83,6 +83,7 @@ public class GraphQLCodegenGradleTask extends DefaultTask implements GraphQLCode
     private Boolean useOptionalForNullableReturnTypes = MappingConfigConstants.DEFAULT_USE_OPTIONAL_FOR_NULLABLE_RETURN_TYPES;
     private Boolean generateApisWithThrowsException = MappingConfigConstants.DEFAULT_GENERATE_APIS_WITH_THROWS_EXCEPTION;
     private Boolean addGeneratedAnnotation = MappingConfigConstants.DEFAULT_ADD_GENERATED_ANNOTATION;
+    private Boolean generateJacksonTypeIdResolver = MappingConfigConstants.DEFAULT_GENERATE_JACKSON_TYPE_ID_RESOLVER;
     private Set<String> fieldsWithResolvers = new HashSet<>();
     private Set<String> fieldsWithoutResolvers = new HashSet<>();
     private Set<String> typesAsInterfaces = new HashSet<>();
@@ -144,6 +145,7 @@ public void generate() throws Exception {
         mappingConfig.setUseOptionalForNullableReturnTypes(useOptionalForNullableReturnTypes);
         mappingConfig.setGenerateApisWithThrowsException(generateApisWithThrowsException);
         mappingConfig.setAddGeneratedAnnotation(addGeneratedAnnotation);
+        mappingConfig.setGenerateJacksonTypeIdResolver(generateJacksonTypeIdResolver);
         mappingConfig.setApiReturnType(apiReturnType);
         mappingConfig.setApiReturnListType(apiReturnListType);
         mappingConfig.setSubscriptionReturnType(subscriptionReturnType);
@@ -634,6 +636,17 @@ public void setAddGeneratedAnnotation(Boolean addGeneratedAnnotation) {
         this.addGeneratedAnnotation = addGeneratedAnnotation;
     }
 
+    @Input
+    @Optional
+    @Override
+    public Boolean getGenerateJacksonTypeIdResolver() {
+        return generateJacksonTypeIdResolver;
+    }
+
+    public void setGenerateJacksonTypeIdResolver(Boolean generateJacksonTypeIdResolver) {
+        this.generateJacksonTypeIdResolver = generateJacksonTypeIdResolver;
+    }
+
     @Input
     @Optional
     @Override

plugins/maven/graphql-java-codegen-maven-plugin/src/main/java/io/github/kobylynskyi/graphql/codegen/GraphQLCodegenMojo.java

@@ -152,6 +152,9 @@ public class GraphQLCodegenMojo extends AbstractMojo implements GraphQLCodegenCo
     @Parameter(defaultValue = MappingConfigConstants.DEFAULT_ADD_GENERATED_ANNOTATION_STRING)
     private boolean addGeneratedAnnotation;
 
+    @Parameter(defaultValue = MappingConfigConstants.DEFAULT_GENERATE_JACKSON_TYPE_ID_RESOLVER_STRING)
+    private boolean generateJacksonTypeIdResolver;
+
     @Parameter
     private String[] fieldsWithResolvers;
 
@@ -242,6 +245,7 @@ public void execute() throws MojoExecutionException {
         mappingConfig.setUseOptionalForNullableReturnTypes(useOptionalForNullableReturnTypes);
         mappingConfig.setGenerateApisWithThrowsException(generateApisWithThrowsException);
         mappingConfig.setAddGeneratedAnnotation(addGeneratedAnnotation);
+        mappingConfig.setGenerateJacksonTypeIdResolver(generateJacksonTypeIdResolver);
         mappingConfig.setFieldsWithResolvers(mapToHashSet(fieldsWithResolvers));
         mappingConfig.setFieldsWithoutResolvers(mapToHashSet(fieldsWithoutResolvers));
         mappingConfig.setRelayConfig(relayConfig);
@@ -494,6 +498,11 @@ public Boolean getAddGeneratedAnnotation() {
         return addGeneratedAnnotation;
     }
 
+    @Override
+    public Boolean getGenerateJacksonTypeIdResolver() {
+        return generateJacksonTypeIdResolver;
+    }
+
     @Override
     public ApiRootInterfaceStrategy getApiRootInterfaceStrategy() {
         return apiRootInterfaceStrategy;

plugins/sbt/README.md

@@ -47,6 +47,7 @@ customAnnotationsMapping := {
   mapping.put("Character", annotations)
   // Note: only for Scala, please pay attention here, codegen have not generated `EpisodeDOTypeRefer.scala` class, so you should create it.
   // Since, 4.1.3, support to generate it.
+  // Since, 5.0.1, It will be done automatically, no need to add this.
   mapping.put("Droid.appearsIn", util.Arrays.asList("@com.fasterxml.jackson.module.scala.JsonScalaEnumeration(classOf[io.github.dreamylost.model.EpisodeDOTypeRefer])"))
   mapping.put("Human.appearsIn", util.Arrays.asList("@com.fasterxml.jackson.module.scala.JsonScalaEnumeration(classOf[io.github.dreamylost.model.EpisodeDOTypeRefer])"))
   mapping

plugins/sbt/graphql-java-codegen-sbt-plugin/src/main/scala/io/github/dreamylost/graphql/codegen/GraphQLCodegenKeys.scala

@@ -124,6 +124,8 @@ trait GraphQLCodegenKeys {
 
   val generateModelOpenClasses = settingKey[Boolean]("The class type of the generated model. If true, generate normal classes, else generate case class.")
 
+  val generateJacksonTypeIdResolver = settingKey[Boolean]("Specifies whether generated union interfaces should be annotated with a custom Jackson type id resolver generated in model package")
+
   //for version
   val javaxValidationApiVersion = settingKey[Option[String]]("javax-validation-api version")
   val graphqlJavaCodegenVersion = settingKey[Option[String]]("graphql java codegen version")

plugins/sbt/graphql-java-codegen-sbt-plugin/src/main/scala/io/github/dreamylost/graphql/codegen/GraphQLCodegenPlugin.scala

@@ -63,6 +63,7 @@ class GraphQLCodegenPlugin(configuration: Configuration, private[codegen] val co
     configurationFiles := Seq.empty[String],
     graphqlSchemaPaths := Seq.empty,
     graphqlSchemaValidate := Seq.empty,
+    generateJacksonTypeIdResolver := MappingConfigConstants.DEFAULT_GENERATE_JACKSON_TYPE_ID_RESOLVER,
     customTypesMapping := new JHashMap[String, String](), //TODO use scala Map, convert to java Map
     customAnnotationsMapping := new JHashMap[String, JList[String]](),
     directiveAnnotationsMapping := new JHashMap[String, JList[String]](),
@@ -169,6 +170,7 @@ class GraphQLCodegenPlugin(configuration: Configuration, private[codegen] val co
     mappingConfig.setRelayConfig((relayConfig in GraphQLCodegenConfig).value)
     mappingConfig.setGeneratedLanguage((generatedLanguage in GraphQLCodegenConfig).value)
     mappingConfig.setGenerateModelOpenClasses((generateModelOpenClasses in GraphQLCodegenConfig).value)
+    mappingConfig.setGenerateJacksonTypeIdResolver((generateJacksonTypeIdResolver in GraphQLCodegenConfig).value);
     mappingConfig
   }
 

plugins/sbt/graphql-java-codegen-sbt-plugin/src/sbt-test/graphql-codegen-sbt-plugin/example-client-scala/build.sbt

@@ -34,8 +34,6 @@ customAnnotationsMapping := {
       |        new com.fasterxml.jackson.annotation.JsonSubTypes.Type(value = classOf[HumanDO], name = "Human"),
       |        new com.fasterxml.jackson.annotation.JsonSubTypes.Type(value = classOf[DroidDO], name = "Droid")))""".stripMargin)
   mapping.put("Character", annotations)
-  mapping.put("Droid.appearsIn", util.Arrays.asList("@com.fasterxml.jackson.module.scala.JsonScalaEnumeration(classOf[io.github.dreamylost.model.EpisodeDOTypeRefer])"))
-  mapping.put("Human.appearsIn", util.Arrays.asList("@com.fasterxml.jackson.module.scala.JsonScalaEnumeration(classOf[io.github.dreamylost.model.EpisodeDOTypeRefer])"))
   mapping
 }
 generateCodegenTargetPath in GraphQLCodegenConfig := crossTarget.value / "src_managed_graphql_scala"

src/main/java/com/kobylynskyi/graphql/codegen/FreeMarkerTemplateType.java

@@ -10,6 +10,7 @@ enum FreeMarkerTemplateType {
     INTERFACE,
     OPERATIONS,
     PARAMETRIZED_INPUT,
-    RESPONSE_PROJECTION;
+    RESPONSE_PROJECTION,
+    JACKSON_TYPE_ID_RESOLVER;
 
 }

src/main/java/com/kobylynskyi/graphql/codegen/FreeMarkerTemplatesRegistry.java

@@ -15,6 +15,7 @@
 
 import static com.kobylynskyi.graphql.codegen.FreeMarkerTemplateType.ENUM;
 import static com.kobylynskyi.graphql.codegen.FreeMarkerTemplateType.INTERFACE;
+import static com.kobylynskyi.graphql.codegen.FreeMarkerTemplateType.JACKSON_TYPE_ID_RESOLVER;
 import static com.kobylynskyi.graphql.codegen.FreeMarkerTemplateType.OPERATIONS;
 import static com.kobylynskyi.graphql.codegen.FreeMarkerTemplateType.PARAMETRIZED_INPUT;
 import static com.kobylynskyi.graphql.codegen.FreeMarkerTemplateType.REQUEST;
@@ -61,6 +62,8 @@ class FreeMarkerTemplatesRegistry {
                     configuration.getTemplate("templates/java-lang/javaClassGraphqlParametrizedInput.ftl"));
             javaTemplates.put(RESPONSE_PROJECTION,
                     configuration.getTemplate("templates/java-lang/javaClassGraphqlResponseProjection.ftl"));
+            javaTemplates.put(JACKSON_TYPE_ID_RESOLVER,
+                    configuration.getTemplate("templates/java-lang/javaClassGraphqlJacksonTypeIdResolver.ftl"));
             templateMap.put(GeneratedLanguage.JAVA, javaTemplates);
 
             EnumMap<FreeMarkerTemplateType, Template> scalaTemplates = new EnumMap<>(FreeMarkerTemplateType.class);
@@ -82,6 +85,8 @@ class FreeMarkerTemplatesRegistry {
                     configuration.getTemplate("templates/scala-lang/scalaClassGraphqlParametrizedInput.ftl"));
             scalaTemplates.put(RESPONSE_PROJECTION,
                     configuration.getTemplate("templates/scala-lang/scalaClassGraphqlResponseProjection.ftl"));
+            scalaTemplates.put(JACKSON_TYPE_ID_RESOLVER,
+                    configuration.getTemplate("templates/scala-lang/scalaClassGraphqlJacksonTypeIdResolver.ftl"));
             templateMap.put(GeneratedLanguage.SCALA, scalaTemplates);
 
             EnumMap<FreeMarkerTemplateType, Template> kotlinTemplates = new EnumMap<>(FreeMarkerTemplateType.class);
@@ -103,6 +108,8 @@ class FreeMarkerTemplatesRegistry {
                     configuration.getTemplate("templates/kotlin-lang/kotlinClassGraphqlParametrizedInput.ftl"));
             kotlinTemplates.put(RESPONSE_PROJECTION,
                     configuration.getTemplate("templates/kotlin-lang/kotlinClassGraphqlResponseProjection.ftl"));
+            kotlinTemplates.put(JACKSON_TYPE_ID_RESOLVER,
+                    configuration.getTemplate("templates/kotlin-lang/kotlinClassGraphqlJacksonTypeIdResolver.ftl"));
             templateMap.put(GeneratedLanguage.KOTLIN, kotlinTemplates);
         } catch (IOException e) {
             throw new UnableToLoadFreeMarkerTemplateException(e);

src/main/java/com/kobylynskyi/graphql/codegen/GraphQLCodegen.java

@@ -1,5 +1,6 @@
 package com.kobylynskyi.graphql.codegen;
 
+import com.kobylynskyi.graphql.codegen.mapper.DataModelMapper;
 import com.kobylynskyi.graphql.codegen.mapper.DataModelMapperFactory;
 import com.kobylynskyi.graphql.codegen.mapper.FieldDefinitionToParameterMapper;
 import com.kobylynskyi.graphql.codegen.model.ApiInterfaceStrategy;
@@ -28,10 +29,17 @@
 import java.util.ArrayList;
 import java.util.Collection;
 import java.util.Collections;
+import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
 import java.util.Optional;
 
+import static com.kobylynskyi.graphql.codegen.model.DataModelFields.CLASS_NAME;
+import static com.kobylynskyi.graphql.codegen.model.DataModelFields.GENERATED_ANNOTATION;
+import static com.kobylynskyi.graphql.codegen.model.DataModelFields.GENERATED_INFO;
+import static com.kobylynskyi.graphql.codegen.model.DataModelFields.MODEL_NAME_PREFIX;
+import static com.kobylynskyi.graphql.codegen.model.DataModelFields.MODEL_NAME_SUFFIX;
+import static com.kobylynskyi.graphql.codegen.model.DataModelFields.PACKAGE;
 import static java.util.stream.Collectors.toList;
 
 /**
@@ -185,6 +193,10 @@ protected void initDefaultValues(MappingConfig mappingConfig) {
         if (mappingConfig.getAddGeneratedAnnotation() == null) {
             mappingConfig.setAddGeneratedAnnotation(MappingConfigConstants.DEFAULT_ADD_GENERATED_ANNOTATION);
         }
+        if (mappingConfig.getGenerateJacksonTypeIdResolver() == null) {
+            mappingConfig.setGenerateJacksonTypeIdResolver(
+                    MappingConfigConstants.DEFAULT_GENERATE_JACKSON_TYPE_ID_RESOLVER);
+        }
         if (mappingConfig.getUseOptionalForNullableReturnTypes() == null) {
             mappingConfig.setUseOptionalForNullableReturnTypes(
                     MappingConfigConstants.DEFAULT_USE_OPTIONAL_FOR_NULLABLE_RETURN_TYPES);
@@ -313,6 +325,9 @@ private List<File> processDefinitions(ExtendedDocument document) {
         for (ExtendedInterfaceTypeDefinition definition : document.getInterfaceDefinitions()) {
             generateFieldResolver(context, definition.getFieldDefinitions(), definition).ifPresent(generatedFiles::add);
         }
+        if (Boolean.TRUE.equals(mappingConfig.getGenerateJacksonTypeIdResolver())) {
+            generatedFiles.add(generateJacksonTypeIdResolver(context));
+        }
         System.out.printf("Generated %d definition classes in folder %s%n", generatedFiles.size(),
                 outputDir.getAbsolutePath());
         return generatedFiles;
@@ -534,6 +549,18 @@ private File generateEnum(MappingContext mappingContext, ExtendedEnumTypeDefinit
                 .generateFile(mappingContext, FreeMarkerTemplateType.ENUM, dataModel, outputDir);
     }
 
+    private File generateJacksonTypeIdResolver(MappingContext context) {
+        Map<String, Object> dataModel = new HashMap<>();
+        dataModel.put(PACKAGE, DataModelMapper.getModelPackageName(context));
+        dataModel.put(MODEL_NAME_PREFIX, context.getModelNamePrefix());
+        dataModel.put(MODEL_NAME_SUFFIX, context.getModelNameSuffix());
+        dataModel.put(CLASS_NAME, "GraphqlJacksonTypeIdResolver");
+        dataModel.put(GENERATED_ANNOTATION, context.getAddGeneratedAnnotation());
+        dataModel.put(GENERATED_INFO, context.getGeneratedInformation());
+        return GraphQLCodegenFileCreator
+                .generateFile(context, FreeMarkerTemplateType.JACKSON_TYPE_ID_RESOLVER, dataModel, outputDir);
+    }
+
     protected void initCustomTypeMappings(Collection<ExtendedScalarTypeDefinition> scalarTypeDefinitions) {
         for (ExtendedScalarTypeDefinition definition : scalarTypeDefinitions) {
             if (definition.getDefinition() != null) {