Schema Coordinates (#3044)

This PR is the residual changes from the original schema coordinates PR above and beyond what was backported to 16.x.x

Co-authored-by: Benjie Gillam <benjie@jemjie.com>
Co-authored-by: Mark Larah <mark@larah.me>

Author: 3 people

cspell.yml

@@ -21,6 +21,7 @@ overrides:
       - html
     words:
       - craco
+      - esbuild
       - swcrc
       - codegen
       - subschema
@@ -30,16 +31,14 @@ overrides:
       - URQL
       - tada
       - Graphile
-      - esbuild
 
 validateDirectives: true
 ignoreRegExpList:
   - u\{[0-9a-f]{1,8}\}
 
 words:
-  - Coodinate
-  - metafield
   - graphiql
+  - metafield
   - uncoerce
   - uncoerced
 

src/index.ts

@@ -330,7 +330,6 @@ export type {
   UnionTypeExtensionNode,
   EnumTypeExtensionNode,
   InputObjectTypeExtensionNode,
-  // Schema Coordinates
   SchemaCoordinateNode,
   TypeCoordinateNode,
   MemberCoordinateNode,

src/language/__tests__/predicates-test.ts

@@ -144,14 +144,12 @@ describe('AST node predicates', () => {
   });
 
   it('isSchemaCoordinateNode', () => {
-    expect(
-      [
-        Kind.TYPE_COORDINATE,
-        Kind.MEMBER_COORDINATE,
-        Kind.ARGUMENT_COORDINATE,
-        Kind.DIRECTIVE_COORDINATE,
-        Kind.DIRECTIVE_ARGUMENT_COORDINATE,
-      ].every((kind) => isSchemaCoordinateNode({ kind } as ASTNode)),
-    ).to.equal(true);
+    expect(filterNodes(isSchemaCoordinateNode)).to.deep.equal([
+      'ArgumentCoordinate',
+      'DirectiveArgumentCoordinate',
+      'DirectiveCoordinate',
+      'MemberCoordinate',
+      'TypeCoordinate',
+    ]);
   });
 });

src/language/index.ts

@@ -96,7 +96,6 @@ export type {
   UnionTypeExtensionNode,
   EnumTypeExtensionNode,
   InputObjectTypeExtensionNode,
-  // Schema Coordinates
   SchemaCoordinateNode,
   TypeCoordinateNode,
   MemberCoordinateNode,

src/language/parser.ts

@@ -1491,15 +1491,15 @@ export class Parser {
     throw this.unexpected(start);
   }
 
-  // Schema Coordinates
+  // Implements the parsing rules in the Schema Coordinates section.
 
   /**
    * SchemaCoordinate :
    *   - Name
    *   - Name . Name
    *   - Name . Name ( Name : )
-   *   - \@ Name
-   *   - \@ Name ( Name : )
+   *   - @ Name
+   *   - @ Name ( Name : )
    */
   parseSchemaCoordinate(): SchemaCoordinateNode {
     const start = this._lexer.token;

src/utilities/__tests__/resolveSchemaCoordinate-test.ts

@@ -1,8 +1,9 @@
-import { expect } from 'chai';
+import { assert, expect } from 'chai';
 import { describe, it } from 'mocha';
 
 import type {
   GraphQLEnumType,
+  GraphQLField,
   GraphQLInputObjectType,
   GraphQLObjectType,
 } from '../../type/definition.js';
@@ -181,3 +182,68 @@ describe('resolveSchemaCoordinate', () => {
     );
   });
 });
+
+/*
+ * NOTE: the following are not required for spec compliance; resolution
+ * of meta-fields is implementation-defined.
+ *
+ * These tests are here to ensure a change of behavior will only be made
+ * in a semver-major release of GraphQL.js.
+ */
+describe('resolveSchemaCoordinate (meta-fields and introspection types)', () => {
+  it('resolves a meta-field', () => {
+    const type = schema.getType('Business') as GraphQLObjectType;
+    const field = schema.getField(type, '__typename');
+    assert.ok(field);
+    expect(
+      resolveSchemaCoordinate(schema, 'Business.__typename'),
+    ).to.deep.equal({
+      kind: 'Field',
+      type,
+      field,
+    });
+  });
+
+  it('resolves a meta-field argument', () => {
+    const type = schema.getType('Query') as GraphQLObjectType;
+    const field = schema.getField(type, '__type') as GraphQLField;
+    const fieldArgument = field.args.find((arg) => arg.name === 'name');
+    expect(
+      resolveSchemaCoordinate(schema, 'Query.__type(name:)'),
+    ).to.deep.equal({
+      kind: 'FieldArgument',
+      type,
+      field,
+      fieldArgument,
+    });
+  });
+
+  it('resolves an Introspection Type', () => {
+    expect(resolveSchemaCoordinate(schema, '__Type')).to.deep.equal({
+      kind: 'NamedType',
+      type: schema.getType('__Type'),
+    });
+  });
+
+  it('resolves an Introspection Type Field', () => {
+    const type = schema.getType('__Directive') as GraphQLObjectType;
+    const field = type.getFields().name;
+    expect(resolveSchemaCoordinate(schema, '__Directive.name')).to.deep.equal({
+      kind: 'Field',
+      type,
+      field,
+    });
+  });
+
+  it('resolves an Introspection Type Enum Value', () => {
+    const type = schema.getType('__DirectiveLocation') as GraphQLEnumType;
+    const enumValue = type.getValue('INLINE_FRAGMENT');
+    expect(
+      resolveSchemaCoordinate(schema, '__DirectiveLocation.INLINE_FRAGMENT'),
+    ).to.deep.equal({
+      kind: 'EnumValue',
+      type,
+      enumValue,
+    });
+  });
+});

src/utilities/resolveSchemaCoordinate.ts

@@ -148,9 +148,7 @@ function resolveMemberCoordinate(
     !isInterfaceType(type)
   ) {
     throw new Error(
-      `Expected ${inspect(
-        typeName,
-      )} to be an Enum, Input Object, Object or Interface type.`,
+      `Expected ${inspect(typeName)} to be an Enum, Input Object, Object or Interface type.`,
     );
   }
 
@@ -185,7 +183,7 @@ function resolveMemberCoordinate(
   // 6. Otherwise:
   // 1. Let {fieldName} be the value of the second {Name}.
   const fieldName = schemaCoordinate.memberName.value;
-  const field = type.getFields()[fieldName];
+  const field = schema.getField(type, fieldName);
 
   // 2. Return the field of {type} named {fieldName} if it exists.
   if (field == null) {
@@ -222,21 +220,19 @@ function resolveArgumentCoordinate(
   // 4. Let {fieldName} be the value of the second {Name}.
   // 5. Let {field} be the field of {type} named {fieldName}.
   const fieldName = schemaCoordinate.fieldName.value;
-  const field = type.getFields()[fieldName];
+  const field = schema.getField(type, fieldName);
 
   // 7. Assert: {field} must exist.
   if (field == null) {
     throw new Error(
-      `Expected ${inspect(fieldName)} to exist as a field of type ${inspect(
-        typeName,
-      )} in the schema.`,
+      `Expected ${inspect(fieldName)} to exist as a field of type ${inspect(typeName)} in the schema.`,
     );
   }
 
   // 7. Let {fieldArgumentName} be the value of the third {Name}.
   const fieldArgumentName = schemaCoordinate.argumentName.value;
   const fieldArgument = field.args.find(
-    (arg: GraphQLArgument) => arg.name === fieldArgumentName,
+    (arg) => arg.name === fieldArgumentName,
   );
 
   // 8. Return the argument of {field} named {fieldArgumentName} if it exists.
@@ -248,7 +244,7 @@ function resolveArgumentCoordinate(
 }
 
 /**
- * DirectiveCoordinate : \@ Name
+ * DirectiveCoordinate : @ Name
  */
 function resolveDirectiveCoordinate(
   schema: GraphQLSchema,
@@ -267,7 +263,7 @@ function resolveDirectiveCoordinate(
 }
 
 /**
- * DirectiveArgumentCoordinate : \@ Name ( Name : )
+ * DirectiveArgumentCoordinate : @ Name ( Name : )
  */
 function resolveDirectiveArgumentCoordinate(
   schema: GraphQLSchema,
@@ -281,9 +277,7 @@ function resolveDirectiveArgumentCoordinate(
   // 3. Assert {directive} must exist.
   if (!directive) {
     throw new Error(
-      `Expected ${inspect(
-        directiveName,
-      )} to be defined as a directive in the schema.`,
+      `Expected ${inspect(directiveName)} to be defined as a directive in the schema.`,
     );
   }