Configure client generate parser options (#1586) (#1592)

* Configure client generate parser options

* Fix star import failure from ktlint

* Set defaults, update documentation, fix name of parser options class for maven plugin

* Do not set default for parser options, use null to inherit default from graphql-java

Author: mgilbey

plugins/client/graphql-kotlin-client-generator/src/main/kotlin/com/expediagroup/graphql/plugin/client/generateClient.kt

@@ -16,11 +16,12 @@
 
 package com.expediagroup.graphql.plugin.client
 
-import com.expediagroup.graphql.plugin.client.generator.GraphQLClientGenerator
-import com.expediagroup.graphql.plugin.client.generator.GraphQLClientGeneratorConfig
 import com.expediagroup.graphql.plugin.client.generator.GraphQLScalar
 import com.expediagroup.graphql.plugin.client.generator.GraphQLSerializer
+import com.expediagroup.graphql.plugin.client.generator.GraphQLClientGeneratorConfig
+import com.expediagroup.graphql.plugin.client.generator.GraphQLClientGenerator
 import com.squareup.kotlinpoet.FileSpec
+import graphql.parser.ParserOptions
 import java.io.File
 
 /**
@@ -33,15 +34,17 @@ fun generateClient(
     serializer: GraphQLSerializer = GraphQLSerializer.JACKSON,
     schemaPath: String,
     queries: List<File>,
-    useOptionalInputWrapper: Boolean = false
+    useOptionalInputWrapper: Boolean = false,
+    parserOptions: ParserOptions.Builder.() -> Unit = {}
 ): List<FileSpec> {
     val customScalars = customScalarsMap.associateBy { it.scalar }
     val config = GraphQLClientGeneratorConfig(
         packageName = packageName,
         allowDeprecated = allowDeprecated,
         customScalarMap = customScalars,
         serializer = serializer,
-        useOptionalInputWrapper = useOptionalInputWrapper
+        useOptionalInputWrapper = useOptionalInputWrapper,
+        parserOptions = parserOptions
     )
     val generator = GraphQLClientGenerator(schemaPath, config)
     return generator.generate(queries)

plugins/client/graphql-kotlin-client-generator/src/main/kotlin/com/expediagroup/graphql/plugin/client/generator/GraphQLClientGenerator.kt

@@ -33,6 +33,7 @@ import com.squareup.kotlinpoet.TypeSpec
 import graphql.language.ObjectTypeDefinition
 import graphql.language.OperationDefinition
 import graphql.parser.Parser
+import graphql.parser.ParserOptions
 import graphql.schema.idl.SchemaParser
 import graphql.schema.idl.TypeDefinitionRegistry
 import kotlinx.serialization.Required
@@ -53,6 +54,7 @@ class GraphQLClientGenerator(
     private val sharedTypes: MutableMap<ClassName, List<TypeSpec>> = mutableMapOf()
     private var generateOptionalSerializer: Boolean = false
     private val graphQLSchema: TypeDefinitionRegistry
+    private val parserOptions: ParserOptions = ParserOptions.newParserOptions().also { this.config.parserOptions(it) }.build()
 
     init {
         graphQLSchema = parseSchema(schemaPath)
@@ -92,7 +94,7 @@ class GraphQLClientGenerator(
      */
     internal fun generate(queryFile: File): List<FileSpec> {
         val queryConst = queryFile.readText().trim()
-        val queryDocument = documentParser.parseDocument(queryConst)
+        val queryDocument = documentParser.parseDocument(queryConst, parserOptions)
 
         val operationDefinitions = queryDocument.definitions.filterIsInstance(OperationDefinition::class.java)
         if (operationDefinitions.size > 1) {

plugins/client/graphql-kotlin-client-generator/src/main/kotlin/com/expediagroup/graphql/plugin/client/generator/GraphQLClientGeneratorConfig.kt

@@ -17,6 +17,7 @@
 package com.expediagroup.graphql.plugin.client.generator
 
 import com.squareup.kotlinpoet.ClassName
+import graphql.parser.ParserOptions
 
 /**
  * GraphQL client generator configuration.
@@ -31,7 +32,9 @@ data class GraphQLClientGeneratorConfig(
     /** Type of JSON serializer to be used. */
     val serializer: GraphQLSerializer = GraphQLSerializer.JACKSON,
     /** Explicit opt-in flag to enable support for optional inputs. */
-    val useOptionalInputWrapper: Boolean = false
+    val useOptionalInputWrapper: Boolean = false,
+    /** Set parser options for processing GraphQL queries and schema definition language documents */
+    val parserOptions: ParserOptions.Builder.() -> Unit = {}
 )
 
 /**

plugins/graphql-kotlin-gradle-plugin/src/main/kotlin/com/expediagroup/graphql/plugin/gradle/GraphQLGradlePlugin.kt

@@ -93,6 +93,7 @@ class GraphQLGradlePlugin : Plugin<Project> {
                 generateClientTask.queryFiles.setFrom(extension.clientExtension.queryFiles)
                 generateClientTask.serializer.convention(extension.clientExtension.serializer)
                 generateClientTask.useOptionalInputWrapper.convention(extension.clientExtension.useOptionalInputWrapper)
+                generateClientTask.parserOptions.convention(extension.clientExtension.parserOptions)
 
                 when {
                     extension.clientExtension.endpoint != null -> {

plugins/graphql-kotlin-gradle-plugin/src/main/kotlin/com/expediagroup/graphql/plugin/gradle/GraphQLPluginExtension.kt

@@ -16,6 +16,7 @@
 
 package com.expediagroup.graphql.plugin.gradle
 
+import com.expediagroup.graphql.plugin.gradle.config.GraphQLParserOptions
 import com.expediagroup.graphql.plugin.gradle.config.GraphQLScalar
 import com.expediagroup.graphql.plugin.gradle.config.GraphQLSerializer
 import com.expediagroup.graphql.plugin.gradle.config.TimeoutConfiguration
@@ -84,6 +85,17 @@ open class GraphQLPluginClientExtension {
     fun timeout(action: Action<TimeoutConfiguration>) {
         action.execute(timeoutConfig)
     }
+
+    /** Configure options for parsing GraphQL queries and schema definition language documents. */
+    internal val parserOptions: GraphQLParserOptions = GraphQLParserOptions()
+
+    /**
+     * Configure options for parsing GraphQL queries and schema definition language documents. Settings
+     * here override the defaults set by GraphQL Java.
+     */
+    fun parserOptions(action: Action<GraphQLParserOptions>) {
+        action.execute(parserOptions)
+    }
 }
 
 open class GraphQLPluginSchemaExtension {

plugins/graphql-kotlin-gradle-plugin/src/main/kotlin/com/expediagroup/graphql/plugin/gradle/actions/GenerateClientAction.kt

@@ -39,8 +39,24 @@ abstract class GenerateClientAction : WorkAction<GenerateClientParameters> {
         val queryFiles = parameters.queryFiles.get()
         val targetDirectory = parameters.targetDirectory.get()
         val useOptionalInputWrapper = parameters.useOptionalInputWrapper.get()
+        val parserOptions = parameters.parserOptions.get()
 
-        generateClient(targetPackage, allowDeprecated, customScalarMap, serializer, schemaPath, queryFiles, useOptionalInputWrapper).forEach {
+        generateClient(
+            targetPackage,
+            allowDeprecated,
+            customScalarMap,
+            serializer,
+            schemaPath,
+            queryFiles,
+            useOptionalInputWrapper,
+            parserOptions = {
+                parserOptions.maxTokens?.let { maxTokens(it) }
+                parserOptions.maxWhitespaceTokens?.let { maxWhitespaceTokens(it) }
+                parserOptions.captureIgnoredChars?.let { captureIgnoredChars(it) }
+                parserOptions.captureSourceLocation?.let { captureSourceLocation(it) }
+                parserOptions.captureLineComments?.let { captureLineComments(it) }
+            }
+        ).forEach {
             it.writeTo(targetDirectory)
         }
     }

plugins/graphql-kotlin-gradle-plugin/src/main/kotlin/com/expediagroup/graphql/plugin/gradle/config/GraphQLParserOptions.kt

@@ -0,0 +1,20 @@
+package com.expediagroup.graphql.plugin.gradle.config
+
+import java.io.Serializable
+
+/**
+ * Configure options for parsing GraphQL queries and schema definition language documents. Settings
+ * here override the defaults set by GraphQL Java.
+ */
+data class GraphQLParserOptions(
+    /** Modify the maximum number of tokens read to prevent processing extremely large queries */
+    var maxTokens: Int? = null,
+    /** Modify the maximum number of whitespace tokens read to prevent processing extremely large queries */
+    var maxWhitespaceTokens: Int? = null,
+    /** Memory usage is significantly reduced by not capturing ignored characters, especially in SDL parsing. */
+    var captureIgnoredChars: Boolean? = null,
+    /** Single-line comments do not have any semantic meaning in GraphQL source documents and can be ignored */
+    var captureLineComments: Boolean? = null,
+    /** Memory usage is reduced by not setting SourceLocations on AST nodes, especially in SDL parsing. */
+    var captureSourceLocation: Boolean? = null
+) : Serializable

plugins/graphql-kotlin-gradle-plugin/src/main/kotlin/com/expediagroup/graphql/plugin/gradle/parameters/GenerateClientParameters.kt

@@ -16,6 +16,7 @@
 
 package com.expediagroup.graphql.plugin.gradle.parameters
 
+import com.expediagroup.graphql.plugin.gradle.config.GraphQLParserOptions
 import com.expediagroup.graphql.plugin.gradle.config.GraphQLScalar
 import com.expediagroup.graphql.plugin.gradle.config.GraphQLSerializer
 import org.gradle.api.provider.ListProperty
@@ -44,4 +45,6 @@ interface GenerateClientParameters : WorkParameters {
     val targetDirectory: Property<File>
     /** Explicit opt-in flag to wrap nullable arguments in OptionalInput that supports both null and undefined values. */
     val useOptionalInputWrapper: Property<Boolean>
+    /** Set parser options for processing GraphQL queries and schema definition language documents */
+    val parserOptions: Property<GraphQLParserOptions>
 }

plugins/graphql-kotlin-gradle-plugin/src/main/kotlin/com/expediagroup/graphql/plugin/gradle/tasks/AbstractGenerateClientTask.kt

@@ -17,6 +17,7 @@
 package com.expediagroup.graphql.plugin.gradle.tasks
 
 import com.expediagroup.graphql.plugin.gradle.actions.GenerateClientAction
+import com.expediagroup.graphql.plugin.gradle.config.GraphQLParserOptions
 import com.expediagroup.graphql.plugin.gradle.config.GraphQLScalar
 import com.expediagroup.graphql.plugin.gradle.config.GraphQLSerializer
 import org.gradle.api.DefaultTask
@@ -117,6 +118,10 @@ abstract class AbstractGenerateClientTask : DefaultTask() {
     @Option(option = "useOptionalInputWrapper", description = "Opt-in flag to wrap nullable arguments in OptionalInput that supports both null and undefined.")
     val useOptionalInputWrapper: Property<Boolean> = project.objects.property(Boolean::class.java)
 
+    @Input
+    @Optional
+    val parserOptions: Property<GraphQLParserOptions> = project.objects.property(GraphQLParserOptions::class.java)
+
     @OutputDirectory
     val outputDirectory: DirectoryProperty = project.objects.directoryProperty()
 
@@ -131,6 +136,7 @@ abstract class AbstractGenerateClientTask : DefaultTask() {
         customScalars.convention(emptyList())
         serializer.convention(GraphQLSerializer.JACKSON)
         useOptionalInputWrapper.convention(false)
+        parserOptions.convention(GraphQLParserOptions())
     }
 
     @Suppress("EXPERIMENTAL_API_USAGE")
@@ -177,6 +183,7 @@ abstract class AbstractGenerateClientTask : DefaultTask() {
             parameters.queryFiles.set(targetQueryFiles)
             parameters.targetDirectory.set(targetDirectory)
             parameters.useOptionalInputWrapper.set(useOptionalInputWrapper)
+            parameters.parserOptions.set(parserOptions)
         }
         workQueue.await()
         logger.debug("successfully generated GraphQL HTTP client")
@@ -191,6 +198,7 @@ abstract class AbstractGenerateClientTask : DefaultTask() {
         }
         logger.debug("  packageName = $packageName")
         logger.debug("  allowDeprecatedFields = $allowDeprecatedFields")
+        logger.debug("  parserOptions = $parserOptions")
         logger.debug("  converters")
         customScalars.get().forEach { (customScalar, type, converter) ->
             logger.debug("    - custom scalar = $customScalar")

plugins/graphql-kotlin-maven-plugin/src/integration/generate-client/pom.xml

@@ -78,6 +78,13 @@
                         <configuration>
                             <packageName>com.expediagroup.graphql.plugin.generated</packageName>
                             <schemaFile>schema.graphql</schemaFile>
+                            <parserOptions>
+                                <maxTokens>15000</maxTokens>
+                                <maxWhitespaceTokens>200000</maxWhitespaceTokens>
+                                <captureIgnoredChars>false</captureIgnoredChars>
+                                <captureLineComments>false</captureLineComments>
+                                <captureSourceLocation>true</captureSourceLocation>
+                            </parserOptions>
                         </configuration>
                     </execution>
                 </executions>

plugins/graphql-kotlin-maven-plugin/src/main/kotlin/com/expediagroup/graphql/plugin/maven/GenerateClientAbstractMojo.kt

@@ -73,6 +73,23 @@ abstract class GenerateClientAbstractMojo : AbstractMojo() {
     @Parameter(name = "customScalars")
     private var customScalars: List<CustomScalar> = mutableListOf()
 
+    /**
+     * Configure options for parsing GraphQL queries and schema definition language documents. Settings
+     * here override the defaults set by GraphQL Java.
+     *
+     * ```xml
+     * <parserOptions>
+     *     <maxTokens>15000</maxTokens>
+     *     <maxWhitespaceTokens>200000</maxWhitespaceTokens>
+     *     <captureIgnoredChars>false</captureIgnoredChars>
+     *     <captureLineComments>false</captureLineComments>
+     *     <captureSourceLocation>true</captureSourceLocation>
+     * </parserOptions>
+     * ```
+     */
+    @Parameter(name = "parserOptions")
+    private var parserOptions: ParserOptions? = null
+
     /**
      * Directory file containing GraphQL queries. Instead of specifying a directory you can also specify list of query file by using
      * [queryFiles] property instead.
@@ -116,7 +133,15 @@ abstract class GenerateClientAbstractMojo : AbstractMojo() {
 
         logConfiguration(schemaPath, targetQueryFiles)
         val customGraphQLScalars = customScalars.map { GraphQLScalar(it.scalar, it.type, it.converter) }
-        generateClient(packageName, allowDeprecatedFields, customGraphQLScalars, serializer, schemaPath, targetQueryFiles, useOptionalInputWrapper).forEach {
+        generateClient(packageName, allowDeprecatedFields, customGraphQLScalars, serializer, schemaPath, targetQueryFiles, useOptionalInputWrapper, parserOptions = {
+            parserOptions?.apply {
+                maxTokens?.let { maxTokens(it) }
+                maxWhitespaceTokens?.let { maxWhitespaceTokens(it) }
+                captureIgnoredChars?.let { captureIgnoredChars(it) }
+                captureLineComments?.let { captureLineComments(it) }
+                captureSourceLocation?.let { captureSourceLocation(it) }
+            }
+        }).forEach {
             it.writeTo(outputDirectory)
         }
 
@@ -149,6 +174,14 @@ abstract class GenerateClientAbstractMojo : AbstractMojo() {
             log.debug("      |- kotlin type = ${converterInfo.type}")
             log.debug("      |- converter = ${converterInfo.converter}")
         }
+        parserOptions?.apply {
+            log.debug("  parserOptions")
+            maxTokens?.let { log.debug("    maxTokens = $it") }
+            maxWhitespaceTokens?.let { log.debug("    maxWhitespaceTokens = $it") }
+            captureIgnoredChars?.let { log.debug("    captureIgnoredChars = $it") }
+            captureLineComments?.let { log.debug("    captureLineComments = $it") }
+            captureSourceLocation?.let { log.debug("    captureSourceLocation = $it") }
+        }
         log.debug("")
         log.debug("-- end GraphQL Client generator configuration --")
     }
@@ -177,3 +210,29 @@ class CustomScalar {
     @Parameter
     lateinit var converter: String
 }
+
+/**
+ * Configure options for parsing GraphQL queries and schema definition language documents. Settings
+ * here override the defaults set by GraphQL Java.
+ */
+class ParserOptions {
+    /** Modify the maximum number of tokens read to prevent processing extremely large queries */
+    @Parameter
+    var maxTokens: Int? = null
+
+    /** Modify the maximum number of whitespace tokens read to prevent processing extremely large queries */
+    @Parameter
+    var maxWhitespaceTokens: Int? = null
+
+    /** Memory usage is significantly reduced by not capturing ignored characters, especially in SDL parsing. */
+    @Parameter
+    var captureIgnoredChars: Boolean? = null
+
+    /** Single-line comments do not have any semantic meaning in GraphQL source documents and can be ignored */
+    @Parameter
+    var captureLineComments: Boolean? = null
+
+    /** Memory usage is reduced by not setting SourceLocations on AST nodes, especially in SDL parsing. */
+    @Parameter
+    var captureSourceLocation: Boolean? = null
+}