Preserve sources of variable values (graphql#3811)

[graphql#3077 rebased on
main](graphql#3077).

Depends on graphql#3810

@leebyron comments from original PR:

> By way of introducing type `VariableValues`, allows
`getVariableValues` to return both the coerced values as well as the
original sources, which are then made available in `ExecutionContext`.
>
> While variable sources are not used directly here, they're used
directly in graphql#3065. This PR is pulled out as a pre-req to aid review

---------

Co-authored-by: Lee Byron <lee.byron@robinhood.com>

Author: yaacovCR

src/execution/__tests__/executor-test.ts

@@ -237,7 +237,19 @@ describe('Execute: Handles basic execution tasks', () => {
     expect(resolvedInfo).to.deep.include({
       fieldNodes: [field],
       path: { prev: undefined, key: 'result', typename: 'Test' },
-      variableValues: { var: 'abc' },
+      variableValues: {
+        sources: {
+          var: {
+            signature: {
+              name: 'var',
+              type: GraphQLString,
+              defaultValue: undefined,
+            },
+            value: 'abc',
+          },
+        },
+        coerced: { var: 'abc' },
+      },
     });
   });
 

src/execution/collectFields.ts

@@ -21,16 +21,12 @@ import type { GraphQLSchema } from '../type/schema.js';
 import { typeFromAST } from '../utilities/typeFromAST.js';
 
 import type { GraphQLVariableSignature } from './getVariableSignature.js';
-import { experimentalGetArgumentValues, getDirectiveValues } from './values.js';
-
-export interface FragmentVariables {
-  signatures: ObjMap<GraphQLVariableSignature>;
-  values: ObjMap<unknown>;
-}
+import type { VariableValues } from './values.js';
+import { getDirectiveValues, getFragmentVariableValues } from './values.js';
 
 export interface FieldDetails {
   node: FieldNode;
-  fragmentVariables?: FragmentVariables | undefined;
+  fragmentVariableValues?: VariableValues | undefined;
 }
 
 export type FieldGroup = ReadonlyArray<FieldDetails>;
@@ -45,7 +41,7 @@ export interface FragmentDetails {
 interface CollectFieldsContext {
   schema: GraphQLSchema;
   fragments: ObjMap<FragmentDetails>;
-  variableValues: { [variable: string]: unknown };
+  variableValues: VariableValues;
   runtimeType: GraphQLObjectType;
   visitedFragmentNames: Set<string>;
 }
@@ -62,7 +58,7 @@ interface CollectFieldsContext {
 export function collectFields(
   schema: GraphQLSchema,
   fragments: ObjMap<FragmentDetails>,
-  variableValues: { [variable: string]: unknown },
+  variableValues: VariableValues,
   runtimeType: GraphQLObjectType,
   selectionSet: SelectionSetNode,
 ): GroupedFieldSet {
@@ -92,7 +88,7 @@ export function collectFields(
 export function collectSubfields(
   schema: GraphQLSchema,
   fragments: ObjMap<FragmentDetails>,
-  variableValues: { [variable: string]: unknown },
+  variableValues: VariableValues,
   returnType: GraphQLObjectType,
   fieldGroup: FieldGroup,
 ): GroupedFieldSet {
@@ -108,12 +104,12 @@ export function collectSubfields(
   for (const fieldDetail of fieldGroup) {
     const selectionSet = fieldDetail.node.selectionSet;
     if (selectionSet) {
-      const { fragmentVariables } = fieldDetail;
+      const { fragmentVariableValues } = fieldDetail;
       collectFieldsImpl(
         context,
         selectionSet,
         subGroupedFieldSet,
-        fragmentVariables,
+        fragmentVariableValues,
       );
     }
   }
@@ -125,7 +121,7 @@ function collectFieldsImpl(
   context: CollectFieldsContext,
   selectionSet: SelectionSetNode,
   groupedFieldSet: AccumulatorMap<string, FieldDetails>,
-  fragmentVariables?: FragmentVariables,
+  fragmentVariableValues?: VariableValues,
 ): void {
   const {
     schema,
@@ -138,18 +134,24 @@ function collectFieldsImpl(
   for (const selection of selectionSet.selections) {
     switch (selection.kind) {
       case Kind.FIELD: {
-        if (!shouldIncludeNode(selection, variableValues, fragmentVariables)) {
+        if (
+          !shouldIncludeNode(selection, variableValues, fragmentVariableValues)
+        ) {
           continue;
         }
         groupedFieldSet.add(getFieldEntryKey(selection), {
           node: selection,
-          fragmentVariables,
+          fragmentVariableValues,
         });
         break;
       }
       case Kind.INLINE_FRAGMENT: {
         if (
-          !shouldIncludeNode(selection, variableValues, fragmentVariables) ||
+          !shouldIncludeNode(
+            selection,
+            variableValues,
+            fragmentVariableValues,
+          ) ||
           !doesFragmentConditionMatch(schema, selection, runtimeType)
         ) {
           continue;
@@ -159,16 +161,17 @@ function collectFieldsImpl(
           context,
           selection.selectionSet,
           groupedFieldSet,
-          fragmentVariables,
+          fragmentVariableValues,
         );
+
         break;
       }
       case Kind.FRAGMENT_SPREAD: {
         const fragName = selection.name.value;
 
         if (
           visitedFragmentNames.has(fragName) ||
-          !shouldIncludeNode(selection, variableValues, fragmentVariables)
+          !shouldIncludeNode(selection, variableValues, fragmentVariableValues)
         ) {
           continue;
         }
@@ -182,25 +185,22 @@ function collectFieldsImpl(
         }
 
         const fragmentVariableSignatures = fragment.variableSignatures;
-        let newFragmentVariables: FragmentVariables | undefined;
+        let newFragmentVariableValues: VariableValues | undefined;
         if (fragmentVariableSignatures) {
-          newFragmentVariables = {
-            signatures: fragmentVariableSignatures,
-            values: experimentalGetArgumentValues(
-              selection,
-              Object.values(fragmentVariableSignatures),
-              variableValues,
-              fragmentVariables,
-            ),
-          };
+          newFragmentVariableValues = getFragmentVariableValues(
+            selection,
+            fragmentVariableSignatures,
+            variableValues,
+            fragmentVariableValues,
+          );
         }
 
         visitedFragmentNames.add(fragName);
         collectFieldsImpl(
           context,
           fragment.definition.selectionSet,
           groupedFieldSet,
-          newFragmentVariables,
+          newFragmentVariableValues,
         );
         break;
       }
@@ -214,14 +214,14 @@ function collectFieldsImpl(
  */
 function shouldIncludeNode(
   node: FragmentSpreadNode | FieldNode | InlineFragmentNode,
-  variableValues: { [variable: string]: unknown },
-  fragmentVariables: FragmentVariables | undefined,
+  variableValues: VariableValues,
+  fragmentVariableValues: VariableValues | undefined,
 ): boolean {
   const skip = getDirectiveValues(
     GraphQLSkipDirective,
     node,
     variableValues,
-    fragmentVariables,
+    fragmentVariableValues,
   );
   if (skip?.if === true) {
     return false;
@@ -231,7 +231,7 @@ function shouldIncludeNode(
     GraphQLIncludeDirective,
     node,
     variableValues,
-    fragmentVariables,
+    fragmentVariableValues,
   );
   if (include?.if === false) {
     return false;

src/execution/execute.ts

@@ -58,6 +58,7 @@ import {
 } from './collectFields.js';
 import { getVariableSignature } from './getVariableSignature.js';
 import { mapAsyncIterable } from './mapAsyncIterable.js';
+import type { VariableValues } from './values.js';
 import {
   experimentalGetArgumentValues,
   getArgumentValues,
@@ -120,7 +121,7 @@ export interface ExecutionContext {
   rootValue: unknown;
   contextValue: unknown;
   operation: OperationDefinitionNode;
-  variableValues: { [variable: string]: unknown };
+  variableValues: VariableValues;
   fieldResolver: GraphQLFieldResolver<any, any>;
   typeResolver: GraphQLTypeResolver<any, any>;
   subscribeFieldResolver: GraphQLFieldResolver<any, any>;
@@ -354,15 +355,15 @@ export function buildExecutionContext(
   /* c8 ignore next */
   const variableDefinitions = operation.variableDefinitions ?? [];
 
-  const coercedVariableValues = getVariableValues(
+  const variableValuesOrErrors = getVariableValues(
     schema,
     variableDefinitions,
     rawVariableValues ?? {},
     { maxErrors: options?.maxCoercionErrors ?? 50 },
   );
 
-  if (coercedVariableValues.errors) {
-    return coercedVariableValues.errors;
+  if (variableValuesOrErrors.errors) {
+    return variableValuesOrErrors.errors;
   }
 
   return {
@@ -371,7 +372,7 @@ export function buildExecutionContext(
     rootValue,
     contextValue,
     operation,
-    variableValues: coercedVariableValues.coerced,
+    variableValues: variableValuesOrErrors.variableValues,
     fieldResolver: fieldResolver ?? defaultFieldResolver,
     typeResolver: typeResolver ?? defaultTypeResolver,
     subscribeFieldResolver: subscribeFieldResolver ?? defaultFieldResolver,
@@ -557,7 +558,7 @@ function executeField(
       fieldGroup[0].node,
       fieldDef.args,
       exeContext.variableValues,
-      fieldGroup[0].fragmentVariables,
+      fieldGroup[0].fragmentVariableValues,
     );
 
     // The resolve function's optional third argument is a context value that