Add locations to composition errors

federation-js/src/composition/utils.ts

@@ -40,6 +40,7 @@ import {
   FederationType,
   FederationDirective,
   FederationField,
+  ServiceDefinition,
 } from './types';
 import federationDirectives from '../directives';
 import { assert, isNotNullOrUndefined } from '../utilities';
@@ -555,6 +556,17 @@ export function typeNodesAreEquivalent(
   );
 }
 
+
+export function findTypeNodeInServiceList(typeName: string, serviceName: string, serviceList: ServiceDefinition[]) {
+  return serviceList.find(
+    service => service.name === serviceName
+    )?.typeDefs.definitions.find(
+      definition =>
+      'name' in definition
+      && definition.name?.value === typeName
+      );
+}
+
 /**
  * A map of `Kind`s from their definition to their respective extensions
  */

federation-js/src/composition/validate/postComposition/__tests__/keyFieldsMissingOnBase.test.ts

@@ -80,7 +80,7 @@ describe('keyFieldsMissingOnBase', () => {
           "code": "KEY_FIELDS_MISSING_ON_BASE",
           "locations": Array [
             Object {
-              "column": 1,
+              "column": 19,
               "line": 2,
             },
           ],

federation-js/src/composition/validate/postComposition/__tests__/keyFieldsSelectInvalidType.test.ts

@@ -90,7 +90,7 @@ describe('keyFieldsSelectInvalidType', () => {
           "code": "KEY_FIELDS_SELECT_INVALID_TYPE",
           "locations": Array [
             Object {
-              "column": 1,
+              "column": 19,
               "line": 2,
             },
           ],
@@ -138,7 +138,7 @@ describe('keyFieldsSelectInvalidType', () => {
           "code": "KEY_FIELDS_SELECT_INVALID_TYPE",
           "locations": Array [
             Object {
-              "column": 1,
+              "column": 19,
               "line": 2,
             },
           ],

federation-js/src/composition/validate/postComposition/__tests__/keysMatchBaseService.test.ts

@@ -124,7 +124,7 @@ describe('keysMatchBaseService', () => {
         "code": "MULTIPLE_KEYS_ON_EXTENSION",
         "locations": Array [
           Object {
-            "column": 1,
+            "column": 26,
             "line": 2,
           },
         ],
@@ -169,7 +169,7 @@ describe('keysMatchBaseService', () => {
         "code": "KEY_NOT_SPECIFIED",
         "locations": Array [
           Object {
-            "column": 1,
+            "column": 26,
             "line": 2,
           },
         ],

federation-js/src/composition/validate/postComposition/keyFieldsMissingOnBase.ts

@@ -1,12 +1,13 @@
 import { isObjectType, FieldNode, GraphQLError } from 'graphql';
-import { logServiceAndType, errorWithCode, getFederationMetadata } from '../../utils';
+import { logServiceAndType, errorWithCode, getFederationMetadata, findTypeNodeInServiceList } from '../../utils';
 import { PostCompositionValidator } from '.';
 
 /**
  * - The fields argument can not select fields that were overwritten by another service
  */
 export const keyFieldsMissingOnBase: PostCompositionValidator = ({
   schema,
+  serviceList,
 }) => {
   const errors: GraphQLError[] = [];
 
@@ -30,6 +31,12 @@ export const keyFieldsMissingOnBase: PostCompositionValidator = ({
             // NOTE: We don't need to warn if there is no matching field.
             // keyFieldsSelectInvalidType already does that :)
             if (matchingField) {
+              const typeNode = findTypeNodeInServiceList(typeName, serviceName, serviceList);
+              const fieldNode = typeNode && 'directives' in typeNode ?
+                typeNode.directives?.find(directive =>
+                  directive.name.value === 'key')?.arguments?.find
+                  (argument => argument.name.value === 'fields') : undefined;
+
               const fieldFederationMetadata = getFederationMetadata(matchingField);
               // warn if not from base type OR IF IT WAS OVERWITTEN
               if (fieldFederationMetadata?.serviceName) {
@@ -38,7 +45,7 @@ export const keyFieldsMissingOnBase: PostCompositionValidator = ({
                     'KEY_FIELDS_MISSING_ON_BASE',
                     logServiceAndType(serviceName, typeName) +
                       `A @key selects ${name}, but ${typeName}.${name} was either created or overwritten by ${fieldFederationMetadata.serviceName}, not ${serviceName}`,
-                    namedType.astNode ?? undefined,
+                    fieldNode,
                   ),
                 );
               }

federation-js/src/composition/validate/postComposition/keyFieldsSelectInvalidType.ts

@@ -7,7 +7,7 @@ import {
   isUnionType,
   GraphQLError,
 } from 'graphql';
-import { logServiceAndType, errorWithCode, getFederationMetadata } from '../../utils';
+import { logServiceAndType, errorWithCode, getFederationMetadata, findTypeNodeInServiceList } from '../../utils';
 import { PostCompositionValidator } from '.';
 
 /**
@@ -17,6 +17,7 @@ import { PostCompositionValidator } from '.';
  */
 export const keyFieldsSelectInvalidType: PostCompositionValidator = ({
   schema,
+  serviceList,
 }) => {
   const errors: GraphQLError[] = [];
 
@@ -36,13 +37,19 @@ export const keyFieldsSelectInvalidType: PostCompositionValidator = ({
 
             // find corresponding field for each selected field
             const matchingField = allFieldsInType[name];
+            const typeNode = findTypeNodeInServiceList(typeName, serviceName, serviceList);
+            const fieldNode = typeNode && 'directives' in typeNode ?
+              typeNode.directives?.find(
+                directive => directive.name.value === 'key')?.arguments?.find(
+                  argument => argument.name.value === 'fields') : undefined;
+
             if (!matchingField) {
               errors.push(
                 errorWithCode(
                   'KEY_FIELDS_SELECT_INVALID_TYPE',
                   logServiceAndType(serviceName, typeName) +
                     `A @key selects ${name}, but ${typeName}.${name} could not be found`,
-                  namedType.astNode ?? undefined,
+                  fieldNode,
                 ),
               );
             }
@@ -58,7 +65,7 @@ export const keyFieldsSelectInvalidType: PostCompositionValidator = ({
                     'KEY_FIELDS_SELECT_INVALID_TYPE',
                     logServiceAndType(serviceName, typeName) +
                       `A @key selects ${typeName}.${name}, which is an interface type. Keys cannot select interfaces.`,
-                    namedType.astNode ?? undefined,
+                    fieldNode,
                   ),
                 );
               }
@@ -73,7 +80,7 @@ export const keyFieldsSelectInvalidType: PostCompositionValidator = ({
                     'KEY_FIELDS_SELECT_INVALID_TYPE',
                     logServiceAndType(serviceName, typeName) +
                       `A @key selects ${typeName}.${name}, which is a union type. Keys cannot select union types.`,
-                    namedType.astNode ?? undefined,
+                      fieldNode,
                   ),
                 );
               }

federation-js/src/composition/validate/postComposition/keysMatchBaseService.ts

@@ -9,6 +9,7 @@ import {
   logServiceAndType,
   errorWithCode,
   getFederationMetadata,
+  findTypeNodeInServiceList,
 } from '../../utils';
 import { PostCompositionValidator } from '.';
 
@@ -19,6 +20,7 @@ import { PostCompositionValidator } from '.';
  */
 export const keysMatchBaseService: PostCompositionValidator = function ({
   schema,
+  serviceList,
 }) {
   const errors: GraphQLError[] = [];
   const types = schema.getTypeMap();
@@ -38,7 +40,7 @@ export const keysMatchBaseService: PostCompositionValidator = function ({
               'KEY_MISSING_ON_BASE',
               logServiceAndType(serviceName, parentTypeName) +
                 `appears to be an entity but no @key directives are specified on the originating type.`,
-              parentType.astNode ?? undefined,
+              findTypeNodeInServiceList(parentTypeName, serviceName, serviceList),
             ),
           );
           continue;
@@ -50,13 +52,17 @@ export const keysMatchBaseService: PostCompositionValidator = function ({
           .filter(([service]) => service !== serviceName)
           .forEach(([extendingService, keyFields = []]) => {
             // Extensions can't specify more than one key
+            const extendingServiceTypeNode = findTypeNodeInServiceList(parentTypeName, extendingService, serviceList);
             if (keyFields.length > 1) {
               errors.push(
                 errorWithCode(
                   'MULTIPLE_KEYS_ON_EXTENSION',
                   logServiceAndType(extendingService, parentTypeName) +
                     `is extended from service ${serviceName} but specifies multiple @key directives. Extensions may only specify one @key.`,
-                  parentType.astNode ?? undefined,
+                  extendingServiceTypeNode && 'directives' in extendingServiceTypeNode ?
+                    extendingServiceTypeNode.directives?.find(directive =>
+                      directive.name.value === 'key')?.arguments?.find
+                        (argument => argument.name.value === 'fields') : undefined,
                 ),
               );
               return;
@@ -68,6 +74,7 @@ export const keysMatchBaseService: PostCompositionValidator = function ({
             // services which can link one key to another via "joins".
             const extensionKey = printFieldSet(keyFields[0]);
             if (!availableKeys.includes(extensionKey)) {
+              const extendingServiceTypeNode = findTypeNodeInServiceList(parentTypeName, extendingService, serviceList);
               errors.push(
                 errorWithCode(
                   'KEY_NOT_SPECIFIED',
@@ -76,7 +83,10 @@ export const keysMatchBaseService: PostCompositionValidator = function ({
                     `\t${availableKeys
                       .map((fieldSet) => `@key(fields: "${fieldSet}")`)
                       .join('\n\t')}`,
-                  parentType.astNode ?? undefined
+                  extendingServiceTypeNode && 'directives' in extendingServiceTypeNode ?
+                    extendingServiceTypeNode.directives?.find(directive =>
+                      directive.name.value === 'key')?.arguments?.find
+                        (argument => argument.name.value === 'fields') : undefined,
                 ),
               );
               return;