Cherry pick raw and coerced variable refactor for 18.x branch

src/main/java/graphql/ExecutionInput.java

@@ -2,6 +2,7 @@
 
 import graphql.cachecontrol.CacheControl;
 import graphql.execution.ExecutionId;
+import graphql.execution.RawVariables;
 import graphql.execution.instrumentation.dataloader.DataLoaderDispatcherInstrumentationState;
 import org.dataloader.DataLoaderRegistry;
 
@@ -24,7 +25,7 @@ public class ExecutionInput {
     private final GraphQLContext graphQLContext;
     private final Object localContext;
     private final Object root;
-    private final Map<String, Object> variables;
+    private final RawVariables rawVariables;
     private final Map<String, Object> extensions;
     private final DataLoaderRegistry dataLoaderRegistry;
     private final CacheControl cacheControl;
@@ -39,7 +40,7 @@ private ExecutionInput(Builder builder) {
         this.context = builder.context;
         this.graphQLContext = assertNotNull(builder.graphQLContext);
         this.root = builder.root;
-        this.variables = builder.variables;
+        this.rawVariables = builder.rawVariables;
         this.dataLoaderRegistry = builder.dataLoaderRegistry;
         this.cacheControl = builder.cacheControl;
         this.executionId = builder.executionId;
@@ -97,10 +98,17 @@ public Object getRoot() {
     }
 
     /**
-     * @return a map of variables that can be referenced via $syntax in the query
+     * @return a map of raw variables that can be referenced via $syntax in the query.
      */
     public Map<String, Object> getVariables() {
-        return variables;
+        return rawVariables.toMap();
+    }
+
+    /**
+     * @return a map of raw variables that can be referenced via $syntax in the query.
+     */
+    public RawVariables getRawVariables() {
+        return rawVariables;
     }
 
     /**
@@ -158,7 +166,7 @@ public ExecutionInput transform(Consumer<Builder> builderConsumer) {
                 .root(this.root)
                 .dataLoaderRegistry(this.dataLoaderRegistry)
                 .cacheControl(this.cacheControl)
-                .variables(this.variables)
+                .variables(this.rawVariables.toMap())
                 .extensions(this.extensions)
                 .executionId(this.executionId)
                 .locale(this.locale);
@@ -176,7 +184,7 @@ public String toString() {
                 ", context=" + context +
                 ", graphQLContext=" + graphQLContext +
                 ", root=" + root +
-                ", variables=" + variables +
+                ", rawVariables=" + rawVariables +
                 ", dataLoaderRegistry=" + dataLoaderRegistry +
                 ", executionId= " + executionId +
                 ", locale= " + locale +
@@ -209,7 +217,7 @@ public static class Builder {
         private Object context = graphQLContext; // we make these the same object on purpose - legacy code will get the same object if this change nothing
         private Object localContext;
         private Object root;
-        private Map<String, Object> variables = Collections.emptyMap();
+        private RawVariables rawVariables = RawVariables.emptyVariables();
         public Map<String, Object> extensions = Collections.emptyMap();
         //
         // this is important - it allows code to later known if we never really set a dataloader and hence it can optimize
@@ -242,7 +250,6 @@ public Builder executionId(ExecutionId executionId) {
             return this;
         }
 
-
         /**
          * Sets the locale to use for this operation
          *
@@ -351,8 +358,16 @@ public Builder root(Object root) {
             return this;
         }
 
-        public Builder variables(Map<String, Object> variables) {
-            this.variables = assertNotNull(variables, () -> "variables map can't be null");
+        /**
+         * Adds raw (not coerced) variables
+         *
+         * @param rawVariables the map of raw variables
+         *
+         * @return this builder
+         */
+        public Builder variables(Map<String, Object> rawVariables) {
+            assertNotNull(rawVariables, () -> "variables map can't be null");
+            this.rawVariables = new RawVariables(rawVariables);
             return this;
         }
 

src/main/java/graphql/analysis/NodeVisitorWithTypeTracking.java

@@ -1,6 +1,7 @@
 package graphql.analysis;
 
 import graphql.Internal;
+import graphql.execution.CoercedVariables;
 import graphql.execution.ConditionalNodes;
 import graphql.execution.ValuesResolver;
 import graphql.introspection.Introspection;
@@ -154,7 +155,7 @@ public TraversalControl visitField(Field field, TraverserContext<Node> context)
         boolean isTypeNameIntrospectionField = fieldDefinition == schema.getIntrospectionTypenameFieldDefinition();
         GraphQLFieldsContainer fieldsContainer = !isTypeNameIntrospectionField ? (GraphQLFieldsContainer) unwrapAll(parentEnv.getOutputType()) : null;
         GraphQLCodeRegistry codeRegistry = schema.getCodeRegistry();
-        Map<String, Object> argumentValues = valuesResolver.getArgumentValues(codeRegistry, fieldDefinition.getArguments(), field.getArguments(), variables);
+        Map<String, Object> argumentValues = valuesResolver.getArgumentValues(codeRegistry, fieldDefinition.getArguments(), field.getArguments(), new CoercedVariables(variables));
         QueryVisitorFieldEnvironment environment = new QueryVisitorFieldEnvironmentImpl(isTypeNameIntrospectionField,
                 field,
                 fieldDefinition,

src/main/java/graphql/analysis/QueryTraverser.java

@@ -1,6 +1,8 @@
 package graphql.analysis;
 
 import graphql.PublicApi;
+import graphql.execution.CoercedVariables;
+import graphql.execution.RawVariables;
 import graphql.execution.ValuesResolver;
 import graphql.language.Document;
 import graphql.language.FragmentDefinition;
@@ -42,26 +44,26 @@ public class QueryTraverser {
     private final Collection<? extends Node> roots;
     private final GraphQLSchema schema;
     private final Map<String, FragmentDefinition> fragmentsByName;
-    private final Map<String, Object> variables;
+    private CoercedVariables coercedVariables;
 
     private final GraphQLCompositeType rootParentType;
 
     private QueryTraverser(GraphQLSchema schema,
                            Document document,
                            String operation,
                            Map<String, Object> variables) {
-        assertNotNull(document, () -> "document  can't be null");
+        assertNotNull(document, () -> "document can't be null");
         NodeUtil.GetOperationResult getOperationResult = NodeUtil.getOperation(document, operation);
         List<VariableDefinition> variableDefinitions = getOperationResult.operationDefinition.getVariableDefinitions();
         this.schema = assertNotNull(schema, () -> "schema can't be null");
         this.fragmentsByName = getOperationResult.fragmentsByName;
         this.roots = singletonList(getOperationResult.operationDefinition);
         this.rootParentType = getRootTypeFromOperation(getOperationResult.operationDefinition);
-        this.variables = coerceVariables(assertNotNull(variables, () -> "variables can't be null"), variableDefinitions);
+        this.coercedVariables = coerceVariables(assertNotNull(variables, () -> "variables can't be null"), variableDefinitions);
     }
 
-    private Map<String, Object> coerceVariables(Map<String, Object> rawVariables, List<VariableDefinition> variableDefinitions) {
-        return new ValuesResolver().coerceVariableValues(schema, variableDefinitions, rawVariables);
+    private CoercedVariables coerceVariables(Map<String, Object> rawVariables, List<VariableDefinition> variableDefinitions) {
+        return new ValuesResolver().coerceVariableValues(schema, variableDefinitions, new RawVariables(rawVariables));
     }
 
     private QueryTraverser(GraphQLSchema schema,
@@ -70,11 +72,11 @@ private QueryTraverser(GraphQLSchema schema,
                            Map<String, FragmentDefinition> fragmentsByName,
                            Map<String, Object> variables) {
         this.schema = assertNotNull(schema, () -> "schema can't be null");
-        this.variables = assertNotNull(variables, () -> "variables can't be null");
         assertNotNull(root, () -> "root can't be null");
         this.roots = Collections.singleton(root);
         this.rootParentType = assertNotNull(rootParentType, () -> "rootParentType can't be null");
         this.fragmentsByName = assertNotNull(fragmentsByName, () -> "fragmentsByName can't be null");
+        this.coercedVariables = new CoercedVariables(assertNotNull(variables, () -> "variables can't be null"));
     }
 
     public Object visitDepthFirst(QueryVisitor queryVisitor) {
@@ -181,7 +183,7 @@ private Object visitImpl(QueryVisitor visitFieldCallback, Boolean preOrder) {
         }
 
         NodeTraverser nodeTraverser = new NodeTraverser(rootVars, this::childrenOf);
-        NodeVisitorWithTypeTracking nodeVisitorWithTypeTracking = new NodeVisitorWithTypeTracking(preOrderCallback, postOrderCallback, variables, schema, fragmentsByName);
+        NodeVisitorWithTypeTracking nodeVisitorWithTypeTracking = new NodeVisitorWithTypeTracking(preOrderCallback, postOrderCallback, coercedVariables.toMap(), schema, fragmentsByName);
         return nodeTraverser.depthFirst(nodeVisitorWithTypeTracking, roots);
     }
 

src/main/java/graphql/execution/CoercedVariables.java

@@ -0,0 +1,35 @@
+package graphql.execution;
+
+import graphql.Internal;
+import graphql.collect.ImmutableKit;
+import graphql.collect.ImmutableMapWithNullValues;
+
+import java.util.Map;
+
+/**
+ * Holds coerced variables
+ */
+@Internal
+public class CoercedVariables {
+    private final ImmutableMapWithNullValues<String, Object> coercedVariables;
+
+    public CoercedVariables(Map<String, Object> coercedVariables) {
+        this.coercedVariables = ImmutableMapWithNullValues.copyOf(coercedVariables);
+    }
+
+    public Map<String, Object> toMap() {
+        return coercedVariables;
+    }
+
+    public boolean containsKey(String key) {
+        return coercedVariables.containsKey(key);
+    }
+
+    public Object get(String key) {
+        return coercedVariables.get(key);
+    }
+
+    public static CoercedVariables emptyVariables() {
+        return new CoercedVariables(ImmutableKit.emptyMap());
+    }
+}

src/main/java/graphql/execution/ConditionalNodes.java

@@ -34,7 +34,7 @@ public boolean shouldInclude(Map<String, Object> variables, List<Directive> dire
     private boolean getDirectiveResult(Map<String, Object> variables, List<Directive> directives, String directiveName, boolean defaultValue) {
         Directive foundDirective = NodeUtil.findNodeByName(directives, directiveName);
         if (foundDirective != null) {
-            Map<String, Object> argumentValues = valuesResolver.getArgumentValues(SkipDirective.getArguments(), foundDirective.getArguments(), variables);
+            Map<String, Object> argumentValues = valuesResolver.getArgumentValues(SkipDirective.getArguments(), foundDirective.getArguments(), new CoercedVariables(variables));
             Object flag = argumentValues.get("if");
             Assert.assertTrue(flag instanceof Boolean, () -> String.format("The '%s' directive MUST have a value for the 'if' argument", directiveName));
             return (Boolean) flag;

src/main/java/graphql/execution/Execution.java

@@ -30,7 +30,6 @@
 import static graphql.execution.ExecutionContextBuilder.newExecutionContextBuilder;
 import static graphql.execution.ExecutionStepInfo.newExecutionStepInfo;
 import static graphql.execution.ExecutionStrategyParameters.newParameters;
-import static graphql.execution.nextgen.Common.getOperationRootType;
 import static graphql.language.OperationDefinition.Operation.MUTATION;
 import static graphql.language.OperationDefinition.Operation.QUERY;
 import static graphql.language.OperationDefinition.Operation.SUBSCRIPTION;
@@ -62,10 +61,10 @@ public CompletableFuture<ExecutionResult> execute(Document document, GraphQLSche
         Map<String, FragmentDefinition> fragmentsByName = getOperationResult.fragmentsByName;
         OperationDefinition operationDefinition = getOperationResult.operationDefinition;
 
-        Map<String, Object> inputVariables = executionInput.getVariables();
+        RawVariables inputVariables = executionInput.getRawVariables();
         List<VariableDefinition> variableDefinitions = operationDefinition.getVariableDefinitions();
 
-        Map<String, Object> coercedVariables;
+        CoercedVariables coercedVariables;
         try {
             coercedVariables = valuesResolver.coerceVariableValues(graphQLSchema, variableDefinitions, inputVariables);
         } catch (RuntimeException rte) {
@@ -88,7 +87,7 @@ public CompletableFuture<ExecutionResult> execute(Document document, GraphQLSche
                 .localContext(executionInput.getLocalContext())
                 .root(executionInput.getRoot())
                 .fragmentsByName(fragmentsByName)
-                .variables(coercedVariables)
+                .coercedVariables(coercedVariables)
                 .document(document)
                 .operationDefinition(operationDefinition)
                 .dataLoaderRegistry(executionInput.getDataLoaderRegistry())

src/main/java/graphql/execution/ExecutionContext.java

@@ -9,7 +9,6 @@
 import graphql.PublicApi;
 import graphql.cachecontrol.CacheControl;
 import graphql.collect.ImmutableKit;
-import graphql.collect.ImmutableMapWithNullValues;
 import graphql.execution.instrumentation.Instrumentation;
 import graphql.execution.instrumentation.InstrumentationState;
 import graphql.language.Document;
@@ -43,7 +42,7 @@ public class ExecutionContext {
     private final ImmutableMap<String, FragmentDefinition> fragmentsByName;
     private final OperationDefinition operationDefinition;
     private final Document document;
-    private final ImmutableMapWithNullValues<String, Object> variables;
+    private final CoercedVariables coercedVariables;
     private final Object root;
     private final Object context;
     private final GraphQLContext graphQLContext;
@@ -66,7 +65,7 @@ public class ExecutionContext {
         this.mutationStrategy = builder.mutationStrategy;
         this.subscriptionStrategy = builder.subscriptionStrategy;
         this.fragmentsByName = builder.fragmentsByName;
-        this.variables = ImmutableMapWithNullValues.copyOf(builder.variables);
+        this.coercedVariables = builder.coercedVariables;
         this.document = builder.document;
         this.operationDefinition = builder.operationDefinition;
         this.context = builder.context;
@@ -80,7 +79,7 @@ public class ExecutionContext {
         this.errors.set(builder.errors);
         this.localContext = builder.localContext;
         this.executionInput = builder.executionInput;
-        queryTree = FpKit.interThreadMemoize(() -> ExecutableNormalizedOperationFactory.createExecutableNormalizedOperation(graphQLSchema, operationDefinition, fragmentsByName, variables));
+        queryTree = FpKit.interThreadMemoize(() -> ExecutableNormalizedOperationFactory.createExecutableNormalizedOperation(graphQLSchema, operationDefinition, fragmentsByName, coercedVariables));
     }
 
 
@@ -116,8 +115,16 @@ public OperationDefinition getOperationDefinition() {
         return operationDefinition;
     }
 
+    /**
+     * @deprecated use {@link #getCoercedVariables()} instead
+     */
+    @Deprecated
     public Map<String, Object> getVariables() {
-        return variables;
+        return coercedVariables.toMap();
+    }
+
+    public CoercedVariables getCoercedVariables() {
+        return coercedVariables;
     }
 
     /**

src/main/java/graphql/execution/ExecutionContextBuilder.java

@@ -9,7 +9,6 @@
 import graphql.PublicApi;
 import graphql.cachecontrol.CacheControl;
 import graphql.collect.ImmutableKit;
-import graphql.collect.ImmutableMapWithNullValues;
 import graphql.execution.instrumentation.Instrumentation;
 import graphql.execution.instrumentation.InstrumentationState;
 import graphql.language.Document;
@@ -39,7 +38,7 @@ public class ExecutionContextBuilder {
     Object root;
     Document document;
     OperationDefinition operationDefinition;
-    ImmutableMapWithNullValues<String, Object> variables = ImmutableMapWithNullValues.emptyMap();
+    CoercedVariables coercedVariables = CoercedVariables.emptyVariables();
     ImmutableMap<String, FragmentDefinition> fragmentsByName = ImmutableKit.emptyMap();
     DataLoaderRegistry dataLoaderRegistry;
     CacheControl cacheControl;
@@ -86,7 +85,7 @@ public ExecutionContextBuilder() {
         root = other.getRoot();
         document = other.getDocument();
         operationDefinition = other.getOperationDefinition();
-        variables = ImmutableMapWithNullValues.copyOf(other.getVariables());
+        coercedVariables = other.getCoercedVariables();
         fragmentsByName = ImmutableMap.copyOf(other.getFragmentsByName());
         dataLoaderRegistry = other.getDataLoaderRegistry();
         cacheControl = other.getCacheControl();
@@ -151,8 +150,17 @@ public ExecutionContextBuilder root(Object root) {
         return this;
     }
 
+    /**
+     * @deprecated use {@link #coercedVariables(CoercedVariables)} instead
+     */
+    @Deprecated
     public ExecutionContextBuilder variables(Map<String, Object> variables) {
-        this.variables = ImmutableMapWithNullValues.copyOf(variables);
+        this.coercedVariables = new CoercedVariables(variables);
+        return this;
+    }
+
+    public ExecutionContextBuilder coercedVariables(CoercedVariables coercedVariables) {
+        this.coercedVariables = coercedVariables;
         return this;
     }
 

src/main/java/graphql/execution/ExecutionStepInfoFactory.java

@@ -27,7 +27,7 @@ public ExecutionStepInfo newExecutionStepInfoForSubField(ExecutionContext execut
         GraphQLOutputType fieldType = fieldDefinition.getType();
         List<Argument> fieldArgs = mergedField.getArguments();
         GraphQLCodeRegistry codeRegistry = executionContext.getGraphQLSchema().getCodeRegistry();
-        Supplier<Map<String, Object>> argumentValues = FpKit.intraThreadMemoize(() -> valuesResolver.getArgumentValues(codeRegistry, fieldDefinition.getArguments(), fieldArgs, executionContext.getVariables()));
+        Supplier<Map<String, Object>> argumentValues = FpKit.intraThreadMemoize(() -> valuesResolver.getArgumentValues(codeRegistry, fieldDefinition.getArguments(), fieldArgs, executionContext.getCoercedVariables()));
 
         ResultPath newPath = parentInfo.getPath().segment(mergedField.getResultKey());
 

src/main/java/graphql/execution/ExecutionStrategy.java

@@ -817,7 +817,7 @@ protected ExecutionStepInfo createExecutionStepInfo(ExecutionContext executionCo
         if (!fieldArgDefs.isEmpty()) {
             List<Argument> fieldArgs = field.getArguments();
             GraphQLCodeRegistry codeRegistry = executionContext.getGraphQLSchema().getCodeRegistry();
-            argumentValues = FpKit.intraThreadMemoize(() -> valuesResolver.getArgumentValues(codeRegistry, fieldArgDefs, fieldArgs, executionContext.getVariables()));
+            argumentValues = FpKit.intraThreadMemoize(() -> valuesResolver.getArgumentValues(codeRegistry, fieldArgDefs, fieldArgs, executionContext.getCoercedVariables()));
         }