Add support for default variable values. (#2704)

This only works for scalar types and their list/optional variants, not input object types closes #2703 and part of #2686
apollographql · Oct 28, 2020 · d9039bf · d9039bf
1 parent 93df14d
commit d9039bf
Show file tree

Hide file tree

Showing 12 changed files with 1,239 additions and 4 deletions.
diff --git a/...ler/src/main/kotlin/com/apollographql/apollo/compiler/ast/builder/OperationTypeBuilder.kt b/...ler/src/main/kotlin/com/apollographql/apollo/compiler/ast/builder/OperationTypeBuilder.kt
@@ -56,7 +56,7 @@ internal fun Operation.ast(
                     typesPackageName = context.typesPackageName
                 ),
                 isOptional = variable.optional(),
-                defaultValue = null,
+                defaultValue = variable.defaultValue,
                 description = ""
             )
           }

diff --git a/...ompiler/src/main/kotlin/com/apollographql/apollo/compiler/codegen/kotlin/KotlinCodeGen.kt b/...ompiler/src/main/kotlin/com/apollographql/apollo/compiler/codegen/kotlin/KotlinCodeGen.kt
@@ -399,6 +399,7 @@ internal object KotlinCodeGen {
     }
   }
 
+  // TODO: fix for input object types
   fun Any.toDefaultValueCodeBlock(typeName: TypeName, fieldType: FieldType): CodeBlock = when {
     this is Number -> CodeBlock.of("%L%L", castTo(typeName), if (typeName == LONG) "L" else "")
     fieldType is FieldType.Scalar.Enum -> CodeBlock.of("%T.safeValueOf(%S)", typeName, this)

diff --git a/...ompiler/src/main/kotlin/com/apollographql/apollo/compiler/codegen/kotlin/OperationType.kt b/...ompiler/src/main/kotlin/com/apollographql/apollo/compiler/codegen/kotlin/OperationType.kt
@@ -23,6 +23,7 @@ import com.apollographql.apollo.compiler.codegen.kotlin.KotlinCodeGen.createMapp
 import com.apollographql.apollo.compiler.codegen.kotlin.KotlinCodeGen.marshallerFunSpec
 import com.apollographql.apollo.compiler.codegen.kotlin.KotlinCodeGen.responseFieldsPropertySpec
 import com.apollographql.apollo.compiler.codegen.kotlin.KotlinCodeGen.suppressWarningsAnnotation
+import com.apollographql.apollo.compiler.codegen.kotlin.KotlinCodeGen.toDefaultValueCodeBlock
 import com.apollographql.apollo.compiler.codegen.kotlin.KotlinCodeGen.toMapperFun
 import com.squareup.kotlinpoet.ClassName
 import com.squareup.kotlinpoet.CodeBlock
@@ -165,13 +166,26 @@ private val OperationType.primaryConstructorSpec: FunSpec
     return FunSpec
         .constructorBuilder()
         .addParameters(variables.fields.map { variable ->
-          val typeName = variable.type.asTypeName()
+          val typeName = variable.type.asTypeName().let {
+            if (variable.isOptional) Input::class.asClassName().parameterizedBy(it) else it
+          }
+          val defaultValue = variable.defaultValue?.toDefaultValueCodeBlock(typeName, variable.type)
+              .let { code ->
+                if (variable.isOptional) {
+                  code?.let { CodeBlock.of("%T.optional(%L)", Input::class, it) } ?: CodeBlock.of("%T.absent()", Input::class)
+                } else {
+                  code
+                }
+              }
+
           ParameterSpec
               .builder(
                   name = variable.name,
-                  type = if (variable.isOptional) Input::class.asClassName().parameterizedBy(typeName) else typeName
+                  type = typeName
               )
-              .applyIf(variable.isOptional) { defaultValue("%T.absent()", Input::class.asClassName()) }
+              .applyIf(defaultValue != null) {
+                defaultValue(defaultValue!!)
+              }
               .build()
         })
         .build()

diff --git a/apollo-compiler/src/main/kotlin/com/apollographql/apollo/compiler/ir/Variable.kt b/apollo-compiler/src/main/kotlin/com/apollographql/apollo/compiler/ir/Variable.kt
@@ -3,6 +3,7 @@ package com.apollographql.apollo.compiler.ir
 data class Variable(
     val name: String,
     val type: String,
+    val defaultValue: Any?,
     val sourceLocation: SourceLocation
 ) {
   fun optional(): Boolean = !type.endsWith(suffix = "!")

diff --git a/...src/main/kotlin/com/apollographql/apollo/compiler/parser/graphql/GraphQLDocumentParser.kt b/...src/main/kotlin/com/apollographql/apollo/compiler/parser/graphql/GraphQLDocumentParser.kt
@@ -20,6 +20,7 @@ import com.apollographql.apollo.compiler.parser.introspection.IntrospectionSchem
 import com.apollographql.apollo.compiler.parser.introspection.asGraphQLType
 import com.apollographql.apollo.compiler.parser.introspection.isAssignableFrom
 import com.apollographql.apollo.compiler.parser.introspection.possibleTypes
+import com.apollographql.apollo.compiler.parser.introspection.resolveType
 import org.antlr.v4.runtime.ANTLRInputStream
 import org.antlr.v4.runtime.BaseErrorListener
 import org.antlr.v4.runtime.CommonTokenStream
@@ -232,10 +233,12 @@ class GraphQLDocumentParser(
         message = "Unknown variable type `$type`",
         token = type().start
     )
+
     return ParseResult(
         result = Variable(
             name = name,
             type = type,
+            defaultValue = defaultValue()?.value()?.parse(schema.resolveType(type)),
             sourceLocation = SourceLocation(variable().NAME().symbol)
         ),
         usedTypes = setOf(schemaType.name)