Add coordinate field to schema element definitions

* Defines a `GraphQLSchemaElement` base class which defines a `.coordinate` property and `toString`/`toJSON` methods. * Adds base class to types, fields, arguments, input fields, enum values, and directives. * Uses this in validation error printing string templates.
yaacovCR · Mar 20, 2024 · 80f3a1c · 80f3a1c
1 parent 0b41718
commit 80f3a1c
Show file tree

Hide file tree

Showing 27 changed files with 649 additions and 638 deletions.
diff --git a/src/execution/__tests__/nonnull-test.ts b/src/execution/__tests__/nonnull-test.ts
@@ -620,7 +620,7 @@ describe('Execute: handles non-nullable types', () => {
         errors: [
           {
             message:
-              'Argument "cannotBeNull" of required type "String!" was not provided.',
+              'Argument Query.withNonNullArg(cannotBeNull:) of required type String! was not provided.',
             locations: [{ line: 3, column: 13 }],
             path: ['withNonNullArg'],
           },
@@ -647,7 +647,7 @@ describe('Execute: handles non-nullable types', () => {
         errors: [
           {
             message:
-              'Argument "cannotBeNull" of non-null type "String!" must not be null.',
+              'Argument Query.withNonNullArg(cannotBeNull:) of non-null type String! must not be null.',
             locations: [{ line: 3, column: 42 }],
             path: ['withNonNullArg'],
           },
@@ -677,7 +677,7 @@ describe('Execute: handles non-nullable types', () => {
         errors: [
           {
             message:
-              'Argument "cannotBeNull" of required type "String!" was provided the variable "$testVar" which was not provided a runtime value.',
+              'Argument Query.withNonNullArg(cannotBeNull:) of required type String! was provided the variable "$testVar" which was not provided a runtime value.',
             locations: [{ line: 3, column: 42 }],
             path: ['withNonNullArg'],
           },
@@ -705,7 +705,7 @@ describe('Execute: handles non-nullable types', () => {
         errors: [
           {
             message:
-              'Argument "cannotBeNull" of non-null type "String!" must not be null.',
+              'Argument Query.withNonNullArg(cannotBeNull:) of non-null type String! must not be null.',
             locations: [{ line: 3, column: 43 }],
             path: ['withNonNullArg'],
           },

diff --git a/src/execution/__tests__/oneof-test.ts b/src/execution/__tests__/oneof-test.ts
@@ -83,7 +83,7 @@ describe('Execute: Handles OneOf Input Objects', () => {
             message:
               // This type of error would be caught at validation-time
               // hence the vague error message here.
-              'Argument "input" of non-null type "TestInputObject!" must not be null.',
+              'Argument Query.test(input:) of non-null type TestInputObject! must not be null.',
             path: ['test'],
           },
         ],

diff --git a/src/execution/__tests__/variables-test.ts b/src/execution/__tests__/variables-test.ts
@@ -226,7 +226,7 @@ describe('Execute: Handles inputs', () => {
           errors: [
             {
               message:
-                'Argument "input" has invalid value ["foo", "bar", "baz"].',
+                'Argument TestType.fieldWithObjectInput(input:) of type TestInputObject has invalid value ["foo", "bar", "baz"].',
               path: ['fieldWithObjectInput'],
               locations: [{ line: 3, column: 41 }],
             },
@@ -262,7 +262,7 @@ describe('Execute: Handles inputs', () => {
           errors: [
             {
               message:
-                'Argument "input" has invalid value { c: "foo", e: "bar" }.',
+                'Argument TestType.fieldWithObjectInput(input:) of type TestInputObject has invalid value { c: "foo", e: "bar" }.',
               path: ['fieldWithObjectInput'],
               locations: [{ line: 3, column: 41 }],
             },
@@ -678,7 +678,7 @@ describe('Execute: Handles inputs', () => {
         errors: [
           {
             message:
-              'Variable "$value" of required type "String!" was not provided.',
+              'Variable "$value" of required type String! was not provided.',
             locations: [{ line: 2, column: 16 }],
           },
         ],
@@ -697,7 +697,7 @@ describe('Execute: Handles inputs', () => {
         errors: [
           {
             message:
-              'Variable "$value" of non-null type "String!" must not be null.',
+              'Variable "$value" of non-null type String! must not be null.',
             locations: [{ line: 2, column: 16 }],
           },
         ],
@@ -743,7 +743,7 @@ describe('Execute: Handles inputs', () => {
         errors: [
           {
             message:
-              'Argument "input" of required type "String!" was not provided.',
+              'Argument TestType.fieldWithNonNullableStringInput(input:) of required type String! was not provided.',
             locations: [{ line: 1, column: 3 }],
             path: ['fieldWithNonNullableStringInput'],
           },
@@ -791,7 +791,7 @@ describe('Execute: Handles inputs', () => {
         errors: [
           {
             message:
-              'Argument "input" of required type "String!" was provided the variable "$foo" which was not provided a runtime value.',
+              'Argument TestType.fieldWithNonNullableStringInput(input:) of required type String! was provided the variable "$foo" which was not provided a runtime value.',
             locations: [{ line: 3, column: 50 }],
             path: ['fieldWithNonNullableStringInput'],
           },
@@ -846,7 +846,7 @@ describe('Execute: Handles inputs', () => {
         errors: [
           {
             message:
-              'Variable "$input" of non-null type "[String]!" must not be null.',
+              'Variable "$input" of non-null type [String]! must not be null.',
             locations: [{ line: 2, column: 16 }],
           },
         ],
@@ -928,7 +928,7 @@ describe('Execute: Handles inputs', () => {
         errors: [
           {
             message:
-              'Variable "$input" of non-null type "[String!]!" must not be null.',
+              'Variable "$input" of non-null type [String!]! must not be null.',
             locations: [{ line: 2, column: 16 }],
           },
         ],
@@ -977,7 +977,7 @@ describe('Execute: Handles inputs', () => {
         errors: [
           {
             message:
-              'Variable "$input" expected value of type "TestType!" which cannot be used as an input type.',
+              'Variable "$input" expected value of type TestType! which cannot be used as an input type.',
             locations: [{ line: 2, column: 24 }],
           },
         ],
@@ -996,7 +996,7 @@ describe('Execute: Handles inputs', () => {
         errors: [
           {
             message:
-              'Variable "$input" expected value of type "UnknownType!" which cannot be used as an input type.',
+              'Variable "$input" expected value of type UnknownType! which cannot be used as an input type.',
             locations: [{ line: 2, column: 24 }],
           },
         ],
@@ -1042,7 +1042,8 @@ describe('Execute: Handles inputs', () => {
         },
         errors: [
           {
-            message: 'Argument "input" has invalid value WRONG_TYPE.',
+            message:
+              'Argument TestType.fieldWithDefaultArgumentValue(input:) of type String has invalid value WRONG_TYPE.',
             locations: [{ line: 3, column: 48 }],
             path: ['fieldWithDefaultArgumentValue'],
           },

diff --git a/src/execution/values.ts b/src/execution/values.ts
@@ -84,7 +84,7 @@ function coerceVariableValues(
       const varTypeStr = print(varDefNode.type);
       onError(
         new GraphQLError(
-          `Variable "$${varName}" expected value of type "${varTypeStr}" which cannot be used as an input type.`,
+          `Variable "$${varName}" expected value of type ${varTypeStr} which cannot be used as an input type.`,
           { nodes: varDefNode.type },
         ),
       );
@@ -95,10 +95,9 @@ function coerceVariableValues(
       if (varDefNode.defaultValue) {
         coercedValues[varName] = valueFromAST(varDefNode.defaultValue, varType);
       } else if (isNonNullType(varType)) {
-        const varTypeStr = inspect(varType);
         onError(
           new GraphQLError(
-            `Variable "$${varName}" of required type "${varTypeStr}" was not provided.`,
+            `Variable "$${varName}" of required type ${varType} was not provided.`,
             { nodes: varDefNode },
           ),
         );
@@ -108,10 +107,9 @@ function coerceVariableValues(
 
     const value = inputs[varName];
     if (value === null && isNonNullType(varType)) {
-      const varTypeStr = inspect(varType);
       onError(
         new GraphQLError(
-          `Variable "$${varName}" of non-null type "${varTypeStr}" must not be null.`,
+          `Variable "$${varName}" of non-null type ${varType} must not be null.`,
           { nodes: varDefNode },
         ),
       );
@@ -170,8 +168,7 @@ export function getArgumentValues(
         coercedValues[name] = argDef.defaultValue;
       } else if (isNonNullType(argType)) {
         throw new GraphQLError(
-          `Argument "${name}" of required type "${inspect(argType)}" ` +
-            'was not provided.',
+          `Argument ${argDef} of required type ${argType} was not provided.`,
           { nodes: node },
         );
       }
@@ -191,7 +188,7 @@ export function getArgumentValues(
           coercedValues[name] = argDef.defaultValue;
         } else if (isNonNullType(argType)) {
           throw new GraphQLError(
-            `Argument "${name}" of required type "${inspect(argType)}" ` +
+            `Argument ${argDef} of required type ${argType} ` +
               `was provided the variable "$${variableName}" which was not provided a runtime value.`,
             { nodes: valueNode },
           );
@@ -203,8 +200,7 @@ export function getArgumentValues(
 
     if (isNull && isNonNullType(argType)) {
       throw new GraphQLError(
-        `Argument "${name}" of non-null type "${inspect(argType)}" ` +
-          'must not be null.',
+        `Argument ${argDef} of non-null type ${argType} must not be null.`,
         { nodes: valueNode },
       );
     }
@@ -215,7 +211,9 @@ export function getArgumentValues(
       // execution. This is a runtime check to ensure execution does not
       // continue with an invalid argument value.
       throw new GraphQLError(
-        `Argument "${name}" has invalid value ${print(valueNode)}.`,
+        `Argument ${argDef} of type ${argType} has invalid value ${print(
+          valueNode,
+        )}.`,
         { nodes: valueNode },
       );
     }

diff --git a/src/index.ts b/src/index.ts
@@ -40,12 +40,17 @@ export {
   // Definitions
   GraphQLSchema,
   GraphQLDirective,
+  GraphQLSchemaElement,
   GraphQLScalarType,
   GraphQLObjectType,
   GraphQLInterfaceType,
   GraphQLUnionType,
   GraphQLEnumType,
   GraphQLInputObjectType,
+  GraphQLField,
+  GraphQLArgument,
+  GraphQLEnumValue,
+  GraphQLInputField,
   GraphQLList,
   GraphQLNonNull,
   // Standard GraphQL Scalars
@@ -161,23 +166,19 @@ export type {
   GraphQLSchemaExtensions,
   GraphQLDirectiveConfig,
   GraphQLDirectiveExtensions,
-  GraphQLArgument,
   GraphQLArgumentConfig,
   GraphQLArgumentExtensions,
   GraphQLEnumTypeConfig,
   GraphQLEnumTypeExtensions,
-  GraphQLEnumValue,
   GraphQLEnumValueConfig,
   GraphQLEnumValueConfigMap,
   GraphQLEnumValueExtensions,
-  GraphQLField,
   GraphQLFieldConfig,
   GraphQLFieldConfigArgumentMap,
   GraphQLFieldConfigMap,
   GraphQLFieldExtensions,
   GraphQLFieldMap,
   GraphQLFieldResolver,
-  GraphQLInputField,
   GraphQLInputFieldConfig,
   GraphQLInputFieldConfigMap,
   GraphQLInputFieldExtensions,