Ability to disable generation of the all$ method in projections (#645)

* Add flag for generating the all method in projections

* Add generation of all methods to plugin

* Add to documentation

* Move pojectionDepthOnFields to concrete implementation of projection

Co-authored-by: Robbert Noordzij <robbert.noordzij@ns.nl>

Author: robbertnoordzij

docs/codegen-options.md

@@ -51,6 +51,7 @@ See [DirectiveAnnotationsMapping](#option-directiveannotationsmapping)* |
 | `responseProjectionSuffix`                            | String                                                                | ResponseProjection                                     | Sets the suffix for `ResponseProjection` classes. |
 | `parametrizedInputSuffix`                             | String                                                                | ParametrizedInput                                      | Sets the suffix for `ParametrizedInput` classes. |
 | `parentInterfaces`                                    | *See<br>[parentInterfaces](#option-parentinterfaces)*                 | Empty                                                  | Block to define parent interfaces for generated interfaces (query / mutation / subscription / type resolver). *See [parentInterfaces](#option-parentinterfaces)* |
+| `generateAllMethodInProjection`                       | Boolean                                                               | true                                                   | Enables whether the `all$()` method should be generated in the projection classes. Disabling enforces the client to select the fields manually. | 
 | `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.|

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

@@ -94,6 +94,7 @@ public class GraphQLCodegenGradleTask extends DefaultTask implements GraphQLCode
     private String responseSuffix;
     private String responseProjectionSuffix;
     private String parametrizedInputSuffix;
+    private Boolean generateAllMethodInProjection = MappingConfigConstants.DEFAULT_GENERATE_ALL_METHOD;
     private int responseProjectionMaxDepth = MappingConfigConstants.DEFAULT_RESPONSE_PROJECTION_MAX_DEPTH;
     private Set<String> useObjectMapperForRequestSerialization = new HashSet<>();
 
@@ -165,6 +166,7 @@ public void generate() throws Exception {
         mappingConfig.setParametrizedInputSuffix(parametrizedInputSuffix);
         mappingConfig.setUseObjectMapperForRequestSerialization(useObjectMapperForRequestSerialization != null ?
                 useObjectMapperForRequestSerialization : new HashSet<>());
+        mappingConfig.setGenerateAllMethodInProjection(generateAllMethodInProjection);
         mappingConfig.setResponseProjectionMaxDepth(responseProjectionMaxDepth);
 
         mappingConfig.setResolverParentInterface(getResolverParentInterface());
@@ -742,6 +744,17 @@ public void setUseObjectMapperForRequestSerialization(Set<String> useObjectMappe
         this.useObjectMapperForRequestSerialization = useObjectMapperForRequestSerialization;
     }
 
+    @Input
+    @Optional
+    @Override
+    public Boolean getGenerateAllMethodInProjection() {
+        return generateAllMethodInProjection;
+    }
+
+    public void setGenerateAllMethodInProjection(boolean generateAllMethodInProjection) {
+        this.generateAllMethodInProjection = generateAllMethodInProjection;
+    }
+
     @Input
     @Optional
     @Override

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

@@ -185,6 +185,9 @@ public class GraphQLCodegenMojo extends AbstractMojo implements GraphQLCodegenCo
     @Parameter(defaultValue = MappingConfigConstants.DEFAULT_RESPONSE_PROJECTION_MAX_DEPTH_STRING)
     private int responseProjectionMaxDepth;
 
+    @Parameter(defaultValue = MappingConfigConstants.DEFAULT_GENERATE_ALL_METHOD_STRING)
+    private boolean generateAllMethodInProjection;
+
     @Parameter
     private ParentInterfacesConfig parentInterfaces = new ParentInterfacesConfig();
 
@@ -248,6 +251,7 @@ public void execute() throws MojoExecutionException {
         mappingConfig.setResponseSuffix(responseSuffix);
         mappingConfig.setResponseProjectionSuffix(responseProjectionSuffix);
         mappingConfig.setParametrizedInputSuffix(parametrizedInputSuffix);
+        mappingConfig.setGenerateAllMethodInProjection(generateAllMethodInProjection);
         mappingConfig.setResponseProjectionMaxDepth(responseProjectionMaxDepth);
         mappingConfig.setUseObjectMapperForRequestSerialization(mapToHashSet(useObjectMapperForRequestSerialization));
         mappingConfig.setTypesAsInterfaces(mapToHashSet(typesAsInterfaces));
@@ -515,6 +519,11 @@ public Set<String> getFieldsWithoutResolvers() {
         return mapToHashSet(fieldsWithoutResolvers);
     }
 
+    @Override
+    public Boolean getGenerateAllMethodInProjection() {
+        return generateAllMethodInProjection;
+    }
+
     @Override
     public Integer getResponseProjectionMaxDepth() {
         return responseProjectionMaxDepth;

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

@@ -114,6 +114,8 @@ trait GraphQLCodegenKeys {
 
   val graphqlQueryIntrospectionResultPath = settingKey[Option[String]]("graphqlQueryIntrospectionResultPath")
 
+  val generateAllMethodInProjection = settingKey[Boolean]("generateAllMethodInProjection")
+
   val responseProjectionMaxDepth = settingKey[Int]("limit depth when the projection is constructed automatically")
 
   val relayConfig = settingKey[RelayConfig]("Can be used to supply a custom configuration for Relay support.")

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

@@ -114,6 +114,7 @@ class GraphQLCodegenPlugin(configuration: Configuration, private[codegen] val co
     generateToString := MappingConfigConstants.DEFAULT_TO_STRING,
     // parent interfaces configs:
     parentInterfaces := parentInterfacesConfig,
+    generateAllMethodInProjection := MappingConfigConstants.DEFAULT_GENERATE_ALL_METHOD,
     responseProjectionMaxDepth := MappingConfigConstants.DEFAULT_RESPONSE_PROJECTION_MAX_DEPTH
   )
 
@@ -163,6 +164,7 @@ class GraphQLCodegenPlugin(configuration: Configuration, private[codegen] val co
     mappingConfig.setUseOptionalForNullableReturnTypes((useOptionalForNullableReturnTypes in GraphQLCodegenConfig).value)
     mappingConfig.setGenerateApisWithThrowsException((generateApisWithThrowsException in GraphQLCodegenConfig).value)
     mappingConfig.setAddGeneratedAnnotation((addGeneratedAnnotation in GraphQLCodegenConfig).value)
+    mappingConfig.setGenerateAllMethodInProjection((generateAllMethodInProjection in GraphQLCodegenConfig).value)
     mappingConfig.setResponseProjectionMaxDepth((responseProjectionMaxDepth in GraphQLCodegenConfig).value)
     mappingConfig.setRelayConfig((relayConfig in GraphQLCodegenConfig).value)
     mappingConfig.setGeneratedLanguage((generatedLanguage in GraphQLCodegenConfig).value)

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

@@ -2,6 +2,8 @@
 
 import com.kobylynskyi.graphql.codegen.model.GeneratedLanguage;
 import com.kobylynskyi.graphql.codegen.model.exception.UnableToLoadFreeMarkerTemplateException;
+import freemarker.core.OutputFormat;
+import freemarker.core.PlainTextOutputFormat;
 import freemarker.ext.beans.BeansWrapper;
 import freemarker.template.Configuration;
 import freemarker.template.Template;
@@ -33,6 +35,7 @@ class FreeMarkerTemplatesRegistry {
         Configuration configuration = new Configuration(FREEMARKER_TEMPLATE_VERSION);
         configuration.setClassLoaderForTemplateLoading(GraphQLCodegen.class.getClassLoader(), "");
         configuration.setDefaultEncoding("UTF-8");
+        configuration.setOutputFormat(PlainTextOutputFormat.INSTANCE);
         configuration.setTemplateExceptionHandler(TemplateExceptionHandler.RETHROW_HANDLER);
         configuration.setLogTemplateExceptions(false);
         configuration.setWrapUncheckedExceptions(true);

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

@@ -208,6 +208,9 @@ protected void initDefaultValues(MappingConfig mappingConfig) {
         if (mappingConfig.getGeneratedLanguage() == null) {
             mappingConfig.setGeneratedLanguage(MappingConfigConstants.DEFAULT_GENERATED_LANGUAGE);
         }
+        if (mappingConfig.getGenerateAllMethodInProjection() == null) {
+            mappingConfig.setGenerateAllMethodInProjection(MappingConfigConstants.DEFAULT_GENERATE_ALL_METHOD);
+        }
     }
 
     private void validateConfigs(MappingConfig mappingConfig) {

src/main/java/com/kobylynskyi/graphql/codegen/mapper/RequestResponseDefinitionToDataModelMapper.java

@@ -27,6 +27,7 @@
 import static com.kobylynskyi.graphql.codegen.model.DataModelFields.FIELDS;
 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.GENERATE_ALL_METHOD_IN_PROJECTION;
 import static com.kobylynskyi.graphql.codegen.model.DataModelFields.JAVA_DOC;
 import static com.kobylynskyi.graphql.codegen.model.DataModelFields.METHOD_NAME;
 import static com.kobylynskyi.graphql.codegen.model.DataModelFields.OPERATION_NAME;
@@ -118,6 +119,7 @@ public Map<String, Object> mapResponseProjection(MappingContext mappingContext,
         dataModel.put(EQUALS_AND_HASH_CODE, mappingContext.getGenerateEqualsAndHashCode());
         dataModel.put(GENERATED_ANNOTATION, mappingContext.getAddGeneratedAnnotation());
         dataModel.put(GENERATED_INFO, mappingContext.getGeneratedInformation());
+        dataModel.put(GENERATE_ALL_METHOD_IN_PROJECTION, mappingContext.getGenerateAllMethodInProjection());
         dataModel.put(RESPONSE_PROJECTION_MAX_DEPTH, mappingContext.getResponseProjectionMaxDepth());
         // dataModel.put(TO_STRING, mappingConfig.getGenerateToString()); always generated for serialization purposes
         return dataModel;

src/main/java/com/kobylynskyi/graphql/codegen/model/DataModelFields.java

@@ -28,6 +28,7 @@ public final class DataModelFields {
     public static final String RETURN_TYPE_NAME = "returnTypeName";
     public static final String GENERATED_ANNOTATION = "generatedAnnotation";
     public static final String GENERATED_INFO = "generatedInfo";
+    public static final String GENERATE_ALL_METHOD_IN_PROJECTION = "generateAllMethodInProjection";
     public static final String RESPONSE_PROJECTION_MAX_DEPTH = "responseProjectionMaxDepth";
     public static final String ENUM_IMPORT_IT_SELF_IN_SCALA = "enumImportItSelfInScala";
     public static final String PARENT_INTERFACE_PROPERTIES = "parentInterfaceProperties";

src/main/java/com/kobylynskyi/graphql/codegen/model/GraphQLCodegenConfiguration.java

@@ -375,6 +375,13 @@ public interface GraphQLCodegenConfiguration {
      */
     String getResolverParentInterface();
 
+    /**
+     * Enables the generation of the all$ method in the projection classes of the client.
+     *
+     * @return whether the generation is enabled.
+     */
+    Boolean getGenerateAllMethodInProjection();
+
     /**
      * Limit depth when `all$` invoke which has subProjections
      *