feat(graphql-yoga): add support for experimental error coordinate

feat(graphql-yoga): add support for experimental error coordinate

Author: EmrysMyrddin

package.json

@@ -22,13 +22,7 @@
     "node": ">=18.0.0",
     "pnpm": ">=9.1.3"
   },
-  "keywords": [
-    "graphql",
-    "server",
-    "api",
-    "graphql-server",
-    "apollo"
-  ],
+  "keywords": ["graphql", "server", "api", "graphql-server", "apollo"],
   "scripts": {
     "build": "pnpm --filter=@graphql-yoga/graphiql run build && pnpm --filter=@graphql-yoga/render-graphiql run build && pnpm --filter=graphql-yoga run generate-graphiql-html && bob build && pnpm --filter=graphql-yoga run inject-version",
     "build-website": "pnpm build && cd website && pnpm build",
@@ -91,9 +85,7 @@
     "wrangler": "4.46.0"
   },
   "lint-staged": {
-    "packages/**/src/**/*.{ts,tsx}": [
-      "cross-env \"ESLINT_USE_FLAT_CONFIG=false\" eslint --fix"
-    ],
+    "packages/**/src/**/*.{ts,tsx}": ["cross-env \"ESLINT_USE_FLAT_CONFIG=false\" eslint --fix"],
     "**/*.{ts,tsx,graphql,yml,yaml,md,json,html,mdx,prettierignore,eslintignore,js,mjs,cjs,md}": [
       "prettier --write"
     ]
@@ -107,6 +99,8 @@
     },
     "overrides": {
       "axios": "1.13.2",
+      "@graphql-tools/executor": "1.5.0-alpha-20251113162628-fc5dd9a67f15da93da0f992ac3e357a9431c42bc",
+      "@graphql-tools/utils": "10.11.0-alpha-20251113162628-fc5dd9a67f15da93da0f992ac3e357a9431c42bc",
       "estree-util-value-to-estree": "3.5.0",
       "eslint-plugin-unicorn": "56.0.1",
       "esbuild": "0.25.12",

packages/graphql-yoga/__tests__/error-masking.spec.ts

@@ -1,5 +1,6 @@
 import { inspect } from '@graphql-tools/utils';
 import { createGraphQLError, createLogger, createSchema, createYoga } from '../src/index.js';
+import { useErrorCoordinate } from '../src/plugins/use-error-coordinate.js';
 import { eventStream } from './utilities.js';
 
 describe('error masking', () => {
@@ -859,4 +860,50 @@ describe('error masking', () => {
 }
 `);
   });
+
+  it.only('should mask experimental coordinate error attribute on production env', async () => {
+    const yoga = createYoga({
+      logging: false,
+      // maskedErrors: {
+      //   isDev: true,
+      // },
+      maskedErrors: false,
+      plugins: [useErrorCoordinate()],
+      schema: createSchema({
+        typeDefs: /* GraphQL */ `
+          type Query {
+            a: String!
+          }
+        `,
+        resolvers: {
+          Query: {
+            a: () => {
+              throw createGraphQLError('Test Error', { coordinate: 'Query.a' });
+            },
+          },
+        },
+      }),
+    });
+
+    const response = await yoga.fetch('http://yoga/graphql', {
+      method: 'POST',
+      headers: {
+        accept: 'application/graphql-response+json',
+        'content-type': 'application/json',
+      },
+      body: JSON.stringify({ query: '{ a }' }),
+    });
+
+    const body = await response.json();
+    expect(response.status).toEqual(200);
+
+    expect(body).toMatchObject({
+      errors: [
+        {
+          message: 'Test Error',
+          coordinate: 'Query.a',
+        },
+      ],
+    });
+  });
 });

packages/graphql-yoga/src/plugins/result-processor/stringify.ts

@@ -1,5 +1,5 @@
 import { GraphQLError } from 'graphql';
-import { createGraphQLError } from '@graphql-tools/utils';
+import { createGraphQLError, getSchemaCoordinate } from '@graphql-tools/utils';
 import { isGraphQLError } from '../../error.js';
 import { MaybeArray } from '../../types.js';
 import { ExecutionResultWithSerializer } from '../types.js';
@@ -50,6 +50,7 @@ function omitInternalsFromError<E extends GraphQLError | Error | undefined>(err:
       path: err.path,
       originalError: omitInternalsFromError(err.originalError || undefined),
       extensions: Object.keys(extensions).length ? extensions : undefined,
+      coordinate: getSchemaCoordinate(err),
     }) as E;
   }
   return err;

packages/graphql-yoga/src/plugins/use-error-coordinate.ts

@@ -0,0 +1,10 @@
+import { ExecutionArgs } from '@graphql-tools/executor';
+import { Plugin } from './types.js';
+
+export function useErrorCoordinate(): Plugin {
+  return {
+    onExecute({ args }) {
+      (args as ExecutionArgs).schemaCoordinateInErrors = true;
+    },
+  };
+}

packages/graphql-yoga/src/utils/mask-error.ts

@@ -1,4 +1,4 @@
-import { createGraphQLError } from '@graphql-tools/utils';
+import { createGraphQLError, getSchemaCoordinate } from '@graphql-tools/utils';
 import { isGraphQLError, isOriginalGraphQLError } from '../error.js';
 import { MaskError } from '../types.js';
 
@@ -42,6 +42,9 @@ export const maskError: MaskError = (
     if (error.extensions?.['http']) {
       errorExtensions['http'] = error.extensions['http'];
     }
+    if (isDev) {
+      errorOptions.coordinate = getSchemaCoordinate(error);
+    }
   } else if (isDev) {
     errorExtensions['originalError'] = serializeError(error);
   }