Adding skipSchemaSizeLimit setting to disable the schema size limitation to SBT, Maven and Gradle plugins.

yholkamp · yholkamp · commit 85737bd4c084 · 2023-11-10T12:27:27.000+01:00
This removes the previous tokenLimit as there will be a number of separate settings to configure.
diff --git a/docs/codegen-options.md b/docs/codegen-options.md
@@ -68,7 +68,8 @@
 |                `supportUnknownFields`                 |                                Boolean                                 |                             False                              | Specifies whether api classes should support unknown fields during serialization or deserialization. If `true`, classes will include a property of type [`java.util.Map<String,Object>`](https://docs.oracle.com/javase/8/docs/api/index.html?java/util/Map.html) that will store unknown fields.                                                                              |
 |              `unknownFieldsPropertyName`              |                                 String                                 |                       userDefinedFields                        | Specifies the name of the property to be included in api classes to support unknown fields during serialization or deserialization                                                                                                                                                                                                                                             |
 |                        `skip`                         |                                Boolean                                 |                             False                              | If true, then code generation will not happen                                                                                                                                                                                                                                                                                                                                  |
-|                     `tokenLimit`                      |                                Integer                                 |                             15000                              | Specifies the maximum number of GraphQL grammar tokens to process.                                                                                                                                                                                                       
+|                 `skipSchemaSizeLimit`                 |                                Boolean                                 |                              True                              | When set to true, the GraphQL schema will be processed with token, character, line and rule depth limits. Set to false to process the schema regardless of its size.
+|
 
 
 ### 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
@@ -15,6 +15,7 @@
 import com.kobylynskyi.graphql.codegen.supplier.MappingConfigSupplier;
 import com.kobylynskyi.graphql.codegen.supplier.MergeableMappingConfigSupplier;
 import com.kobylynskyi.graphql.codegen.supplier.SchemaFinder;
+import graphql.parser.ParserOptions;
 import org.gradle.api.Action;
 import org.gradle.api.DefaultTask;
 import org.gradle.api.plugins.JavaPluginExtension;
@@ -121,6 +122,7 @@ public class GraphQLCodegenGradleTask extends DefaultTask implements GraphQLCode
     private String unknownFieldsPropertyName = MappingConfigConstants.DEFAULT_UNKNOWN_FIELDS_PROPERTY_NAME;
 
     private Boolean skip = false;
+    private Boolean skipSchemaSizeLimit = true;
 
     public GraphQLCodegenGradleTask() {
         setGroup("codegen");
@@ -228,6 +230,15 @@ private GraphQLCodegen instantiateCodegen(MappingConfig mappingConfig) throws IO
         GeneratedLanguage language = mappingConfigSupplier.map(Supplier::get)
                 .map(MappingConfig::getGeneratedLanguage)
                 .orElse(generatedLanguage);
+
+        if(skipSchemaSizeLimit) {
+            ParserOptions.Builder parserOptionBuilder = ParserOptions.newParserOptions()
+                  .maxTokens(Integer.MAX_VALUE)
+                  .maxCharacters(Integer.MAX_VALUE)
+                  .maxWhitespaceTokens(Integer.MAX_VALUE)
+                  .maxRuleDepth(Integer.MAX_VALUE);
+            ParserOptions.setDefaultParserOptions(parserOptionBuilder.build());
+        }
         switch (language) {
             case JAVA:
                 return new JavaGraphQLCodegen(getActualSchemaPaths(), graphqlQueryIntrospectionResultPath,
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
@@ -249,11 +249,8 @@ public class GraphQLCodegenMojo extends AbstractMojo implements GraphQLCodegenCo
     @Parameter(defaultValue = "false")
     private boolean skip;
 
-    /**
-     * Maximum number of GraphQL grammar tokens to process.
-     */
-    @Parameter(defaultValue = "15000")
-    private int tokenLimit;
+    @Parameter(defaultValue = "true")
+    private boolean skipSchemaSizeLimit;
 
     @Override
     public void execute() throws MojoExecutionException {
@@ -346,11 +343,14 @@ private GraphQLCodegen instantiateCodegen(MappingConfig mappingConfig) throws IO
                 .map(MappingConfig::getGeneratedLanguage)
                 .orElse(generatedLanguage);
 
-        ParserOptions.Builder parserOptionBuilder = ParserOptions.newParserOptions()
-            .maxTokens(tokenLimit)
-            .maxCharacters(tokenLimit)
-            .maxWhitespaceTokens(tokenLimit);
-        ParserOptions.setDefaultParserOptions(parserOptionBuilder.build());
+        if (skipSchemaSizeLimit) {
+            ParserOptions.Builder parserOptionBuilder = ParserOptions.newParserOptions()
+                .maxTokens(Integer.MAX_VALUE)
+                .maxCharacters(Integer.MAX_VALUE)
+                .maxWhitespaceTokens(Integer.MAX_VALUE)
+                .maxRuleDepth(Integer.MAX_VALUE);
+            ParserOptions.setDefaultParserOptions(parserOptionBuilder.build());
+        }
 
         switch (language) {
             case JAVA:
diff --git a/plugins/sbt/graphql-java-codegen-sbt-plugin/src/main/scala/io/github/dreamylost/graphql/codegen/GraphQLCodegenKeys.scala b/plugins/sbt/graphql-java-codegen-sbt-plugin/src/main/scala/io/github/dreamylost/graphql/codegen/GraphQLCodegenKeys.scala
@@ -178,5 +178,6 @@ trait GraphQLCodegenKeys {
 
   val supportUnknownFields      = settingKey[Boolean]("supportUnknownFields")
   val unknownFieldsPropertyName = settingKey[String]("unknownFieldsPropertyName")
+  val skipSchemaSizeLimit       = settingKey[Boolean]("Skip schema size limit checks.")
 
 }
diff --git a/plugins/sbt/graphql-java-codegen-sbt-plugin/src/main/scala/io/github/dreamylost/graphql/codegen/GraphQLCodegenPlugin.scala b/plugins/sbt/graphql-java-codegen-sbt-plugin/src/main/scala/io/github/dreamylost/graphql/codegen/GraphQLCodegenPlugin.scala
@@ -1,5 +1,6 @@
 package io.github.dreamylost.graphql.codegen
 
+import graphql.parser.ParserOptions
 import com.kobylynskyi.graphql.codegen.GraphQLCodegenValidate
 import com.kobylynskyi.graphql.codegen.java.JavaGraphQLCodegen
 import com.kobylynskyi.graphql.codegen.model._
@@ -131,7 +132,8 @@ class GraphQLCodegenPlugin(configuration: Configuration, private[codegen] val co
     unknownFieldsPropertyName      := MappingConfigConstants.DEFAULT_UNKNOWN_FIELDS_PROPERTY_NAME,
     generateNoArgsConstructorOnly  := MappingConfigConstants.DEFAULT_GENERATE_NOARGS_CONSTRUCTOR_ONLY,
     generateModelsWithPublicFields := MappingConfigConstants.DEFAULT_GENERATE_MODELS_WITH_PUBLIC_FIELDS,
-    skip                           := false
+    skip                           := false,
+    skipSchemaSizeLimit            := true
   )
 
   private def getMappingConfig(): Def.Initialize[MappingConfig] = Def.setting {
@@ -247,6 +249,16 @@ class GraphQLCodegenPlugin(configuration: Configuration, private[codegen] val co
       graphqlCodegen := {
         sLog.value.info(s"Generating files: ${BuildInfo.toString}")
         val mappingConfigSupplier = buildJsonSupplier(configurationFiles.value)
+
+        if (skipSchemaSizeLimit.value) {
+          val parserOptionBuilder = ParserOptions
+            .newParserOptions()
+            .maxTokens(Integer.MAX_VALUE)
+            // .maxCharacters(Integer.MAX_VALUE)
+            .maxWhitespaceTokens(Integer.MAX_VALUE)
+            .maxRuleDepth(Integer.MAX_VALUE);
+          ParserOptions.setDefaultParserOptions(parserOptionBuilder.build());
+        }
         val language = mappingConfigSupplier.map(_.get()).map(_.getGeneratedLanguage).getOrElse(generatedLanguage.value)
         var result   = Seq.empty[File]
         try {

Original file line number	Diff line number	Diff line change
`@@ -178,5 +178,6 @@ trait GraphQLCodegenKeys {`
`178`	`178`
`179`	`179`	`val supportUnknownFields = settingKey[Boolean]("supportUnknownFields")`
`180`	`180`	`val unknownFieldsPropertyName = settingKey[String]("unknownFieldsPropertyName")`
	`181`	`+ val skipSchemaSizeLimit = settingKey[Boolean]("Skip schema size limit checks.")`
`181`	`182`
`182`	`183`	`}`