Remove formatErrors from Apollo server (#6198)

.changeset/happy-seals-cheat.md

@@ -0,0 +1,5 @@
+---
+'@keystone-next/keystone': major
+---
+
+Removed the `uid` and `name` properties from the errors returned by the GraphQL API.

packages/keystone/package.json

@@ -100,9 +100,7 @@
     "react": "^17.0.2",
     "react-dom": "^17.0.2",
     "resolve": "^1.20.0",
-    "serialize-error": "^8.1.0",
     "source-map-support": "^0.5.19",
-    "stack-utils": "^2.0.3",
     "typescript": "^4.3.5",
     "uid-safe": "^2.1.5",
     "uuid": "^8.3.2"

packages/keystone/src/admin-ui/components/GraphQLErrorNotice.tsx

@@ -17,7 +17,10 @@ export function GraphQLErrorNotice({ errors, networkError }: GraphQLErrorNoticeP
       <Stack gap="small">
         {errors.map(err => {
           const errButAny: any = err;
-          if (err.name === 'ValidationFailureError' && errButAny.data?.messages?.length) {
+          if (
+            err.message === 'You attempted to perform an invalid mutation' &&
+            errButAny.data?.messages?.length
+          ) {
             return errButAny.data.messages.map((message: string) => (
               <Notice tone="negative">{message}</Notice>
             ));

packages/keystone/src/lib/server/createApolloServer.ts

@@ -5,7 +5,6 @@ import { ApolloServer as ApolloServerExpress } from 'apollo-server-express';
 import type { Config } from 'apollo-server-express';
 import type { CreateContext, SessionStrategy } from '@keystone-next/types';
 import { createSessionContext } from '../../session';
-import { formatError } from './format-error';
 
 export const createApolloServerMicro = ({
   graphQLSchema,
@@ -87,7 +86,6 @@ const _createApolloServerConfig = ({
   return {
     uploads: false,
     schema: graphQLSchema,
-    formatError, // TODO: this needs to be discussed
     // FIXME: support for apollo studio tracing
     // ...(process.env.ENGINE_API_KEY || process.env.APOLLO_KEY
     //   ? { tracing: true }

tests/api-tests/utils.ts

@@ -17,12 +17,10 @@ export const apiTestConfig = (
 });
 
 const unpackErrors = (errors: readonly any[] | undefined) =>
-  (errors || []).map(
-    ({ locations, uid, extensions: { exception, ...extensions }, ...unpacked }) => ({
-      extensions,
-      ...unpacked,
-    })
-  );
+  (errors || []).map(({ locations, extensions: { exception, ...extensions }, ...unpacked }) => ({
+    extensions,
+    ...unpacked,
+  }));
 
 export const expectInternalServerError = (
   errors: readonly any[] | undefined,
@@ -32,7 +30,6 @@ export const expectInternalServerError = (
   expect(unpackedErrors).toEqual(
     args.map(({ path, message }) => ({
       extensions: { code: 'INTERNAL_SERVER_ERROR' },
-      name: 'GraphQLError',
       path,
       message,
     }))
@@ -47,7 +44,6 @@ export const expectGraphQLValidationError = (
   expect(unpackedErrors).toEqual(
     args.map(({ message }) => ({
       extensions: { code: 'GRAPHQL_VALIDATION_FAILED' },
-      name: 'ValidationError',
       message,
     }))
   );
@@ -91,7 +87,6 @@ export const expectPrismaError = (
   expect(unpackedErrors).toEqual(
     args.map(({ path, message }) => ({
       extensions: { code: 'INTERNAL_SERVER_ERROR' },
-      name: 'GraphQLError',
       path,
       message,
     }))
@@ -121,7 +116,6 @@ export const expectBadUserInput = (
   expect(unpackedErrors).toEqual(
     args.map(({ path, message }) => ({
       extensions: { code: 'INTERNAL_SERVER_ERROR' },
-      name: 'GraphQLError',
       path,
       message,
     }))

yarn.lock

@@ -11895,13 +11895,6 @@ [email protected]:
     range-parser "~1.2.1"
     statuses "~1.5.0"
 
-serialize-error@^8.1.0:
-  version "8.1.0"
-  resolved "https://registry.yarnpkg.com/serialize-error/-/serialize-error-8.1.0.tgz#3a069970c712f78634942ddd50fbbc0eaebe2f67"
-  integrity sha512-3NnuWfM6vBYoy5gZFvHiYsVbafvI9vZv/+jlIigFn4oP4zjNPK3LhcY0xSCgeb1a5L8jO71Mit9LlNoi2UfDDQ==
-  dependencies:
-    type-fest "^0.20.2"
-
 [email protected]:
   version "1.14.1"
   resolved "https://registry.yarnpkg.com/serve-static/-/serve-static-1.14.1.tgz#666e636dc4f010f7ef29970a88a674320898b2f9"