feat(executor): add schema coordinate to graphql errors (#7588)

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: TheGuildBot <[email protected]>

Author: 5 people

.changeset/@graphql-tools_graphql-file-loader-7588-dependencies.md

@@ -0,0 +1,5 @@
+---
+"@graphql-tools/graphql-file-loader": patch
+---
+dependencies updates:
+  - Updated dependency [`@graphql-tools/[email protected]` ↗︎](https://www.npmjs.com/package/@graphql-tools/import/v/7.1.7) (from `7.1.6`, in `dependencies`)

.changeset/@graphql-tools_import-7588-dependencies.md

@@ -0,0 +1,5 @@
+---
+"@graphql-tools/import": patch
+---
+dependencies updates:
+  - Updated dependency [`@theguild/federation-composition@^0.21.0` ↗︎](https://www.npmjs.com/package/@theguild/federation-composition/v/0.21.0) (from `^0.20.2`, in `dependencies`)

.changeset/@graphql-tools_node-require-7588-dependencies.md

@@ -0,0 +1,5 @@
+---
+"@graphql-tools/node-require": patch
+---
+dependencies updates:
+  - Updated dependency [`@graphql-tools/[email protected]` ↗︎](https://www.npmjs.com/package/@graphql-tools/graphql-file-loader/v/8.1.7) (from `8.1.6`, in `dependencies`)

.changeset/floppy-women-poke.md

@@ -0,0 +1,34 @@
+---
+'@graphql-tools/executor': minor
+'@graphql-tools/utils': minor
+---
+
+Add optional schema coordinate in error extensions. This extension allows to precisely identify the
+source of the error by automated tools like tracing or monitoring.
+
+This new feature is opt-in, you have to enable it using `schemaCoordinateInErrors` executor option.
+
+**Caution:** This feature, when enabled, will expose information about your schema. If you need to
+keep your schema private and secret, you should strip this attribute at serialization time before
+sending errors to the client.
+
+```ts
+import { parse } from 'graphql'
+import { normalizedExecutor } from '@graphql-tools/executor'
+import { getSchemaCoordinate } from '@graphql-tools/utils'
+import schema from './schema'
+
+const result = await normalizedExecutor({
+  schema,
+  document: parse(`...`),
+  schemaCoordinateInErrors: true // enable adding schema coordinate to graphql errors
+})
+
+if (result.errors) {
+  for (const error of result.errors) {
+    console.log('Error in resolver ', error.coordinate, ':', error.message)
+    // or with `getSchemaCoordinate` util, to workaround types if needed
+    console.log('Error in resolver', getSchemaCoordinate(error), ':', error.message)
+  }
+}
+```

.github/workflows/pr.yml

@@ -19,6 +19,7 @@ jobs:
     permissions:
       contents: read
       id-token: write
+      pull-requests: write
     uses: the-guild-org/shared-config/.github/workflows/release-snapshot.yml@v1
     if: ${{ github.event.pull_request.title != 'Upcoming Release Changes' }}
     with:

package-lock.json

@@ -1271,4 +1271,92 @@ describe('Execute: Handles basic execution tasks', () => {
     const [error] = result.errors!;
     expect(error.originalError?.name).toBe('Error');
   });
+
+  it('should properly add schema coordinate on errors only if enabled', () => {
+    const schema = new GraphQLSchema({
+      query: new GraphQLObjectType({
+        name: 'Query',
+        fields: {
+          foo: {
+            type: GraphQLInt,
+            resolve: () => {
+              throw new Error('Test Error');
+            },
+          },
+        },
+      }),
+    });
+
+    const document = parse('{ foo }');
+
+    expect(
+      executeSync({
+        schema,
+        document,
+        schemaCoordinateInErrors: true,
+      }).errors![0].coordinate,
+    ).toBe('Query.foo');
+
+    expect(
+      executeSync({
+        schema,
+        document,
+        schemaCoordinateInErrors: false,
+      }).errors![0].coordinate,
+    ).toBe(undefined);
+  });
+
+  it('should properly add schema coordinate even with abstract types', () => {
+    const I = new GraphQLInterfaceType({ name: 'I', fields: { f: { type: GraphQLString } } });
+    const A = new GraphQLObjectType({
+      name: 'A',
+      interfaces: [I],
+      fields: {
+        f: {
+          type: GraphQLString,
+          resolve: () => {
+            throw new Error('Error A');
+          },
+        },
+      },
+    });
+
+    const B = new GraphQLObjectType({ name: 'B', fields: { b: { type: GraphQLString } } });
+
+    const schema = new GraphQLSchema({
+      types: [I, A, B],
+      query: new GraphQLObjectType({
+        name: 'Query',
+        fields: {
+          i: {
+            type: I,
+            resolve: () => ({ __typename: 'A' }),
+          },
+          u: {
+            type: new GraphQLUnionType({
+              name: 'U',
+              types: [A, B],
+            }),
+            resolve: () => ({ __typename: 'A' }),
+          },
+        },
+      }),
+    });
+
+    expect(
+      executeSync({
+        schema,
+        document: parse('{ i { f } }'),
+        schemaCoordinateInErrors: true,
+      }).errors![0].coordinate,
+    ).toBe('A.f');
+
+    expect(
+      executeSync({
+        schema,
+        document: parse('{ u { ...on A { f } } }'),
+        schemaCoordinateInErrors: true,
+      }).errors![0].coordinate,
+    ).toBe('A.f');
+  });
 });