test: error handling example (#1734)

* test: error handling example

* make tests not flaky

* improve

* chore(dependencies): updated changesets for modified dependencies

* prettier

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

Author: saihaj

.changeset/graphql-yoga-1734-dependencies.md

@@ -0,0 +1,7 @@
+---
+'graphql-yoga': patch
+---
+
+dependencies updates:
+
+- Updated dependency [`@whatwg-node/[email protected]` ↗︎](https://www.npmjs.com/package/@whatwg-node/server/v/0.4.2) (from `0.4.1`, in `dependencies`)

examples/error-handling/__integration-tests__/error-handling.spec.ts

@@ -0,0 +1,61 @@
+import { yoga } from '../src/yoga'
+import { createServer, Server } from 'http'
+import { AddressInfo } from 'net'
+import { fetch } from '@whatwg-node/fetch'
+
+describe('error-handling example integration', () => {
+  let server: Server
+  let port: number
+
+  beforeAll(async () => {
+    server = createServer(yoga)
+    await new Promise<void>((resolve) => server.listen(0, resolve))
+    port = (server.address() as AddressInfo).port
+  })
+
+  afterAll(async () => {
+    await new Promise((resolve) => server.close(resolve))
+  })
+
+  it('should get a masked error', async () => {
+    const response = await fetch(
+      `http://localhost:${port}/graphql?query=query{greeting}`,
+    )
+    const body = await response.json()
+
+    expect(body.errors).toBeDefined()
+    expect(body.errors[0].message).toEqual('Unexpected error.')
+    expect(body.data).toBeNull()
+  })
+
+  it('should get a custom error', async () => {
+    const response = await fetch(
+      `http://localhost:${port}/graphql?query=query{user(byId: "6"){id}}`,
+    )
+    const body = await response.json()
+
+    expect(body.errors).toBeDefined()
+    expect(body.errors).toMatchInlineSnapshot(`
+        [
+          {
+            "extensions": {
+              "code": "USER_NOT_FOUND",
+              "someRandomExtensions": {
+                "aaaa": 3,
+              },
+            },
+            "locations": [
+              {
+                "column": 7,
+                "line": 1,
+              },
+            ],
+            "message": "User with id '6' not found.",
+            "path": [
+              "user",
+            ],
+          },
+        ]
+        `)
+  })
+})

examples/error-handling/src/index.ts

@@ -1,67 +1,5 @@
-import { createYoga, createSchema } from 'graphql-yoga'
-import { fetch } from '@whatwg-node/fetch'
-import { GraphQLError } from 'graphql'
 import { createServer } from 'http'
-
-const users = [
-  {
-    id: '1',
-    login: 'Laurin',
-  },
-  {
-    id: '2',
-    login: 'Saihaj',
-  },
-  {
-    id: '3',
-    login: 'Dotan',
-  },
-]
-
-// Provide your schema
-const yoga = createYoga({
-  schema: createSchema({
-    typeDefs: /* GraphQL */ `
-      type User {
-        id: ID!
-        login: String!
-      }
-      type Query {
-        greeting: String!
-        user(byId: ID!): User!
-      }
-    `,
-    resolvers: {
-      Query: {
-        greeting: async () => {
-          // This service does not exist
-          const greeting = await fetch('http://localhost:9876/greeting').then(
-            (res) => res.text(),
-          )
-
-          return greeting
-        },
-        user: async (_, args) => {
-          const user = users.find((user) => user.id === args.byId)
-          if (!user) {
-            throw new GraphQLError(`User with id '${args.byId}' not found.`, {
-              extensions: {
-                code: 'USER_NOT_FOUND',
-                someRandomExtensions: {
-                  aaaa: 3,
-                },
-              },
-            })
-          }
-
-          return user
-        },
-      },
-    },
-  }),
-  logging: true,
-  maskedErrors: true,
-})
+import { yoga } from './yoga'
 
 // Start the server and explore http://localhost:4000/graphql
 const server = createServer(yoga)

examples/error-handling/src/yoga.ts

@@ -0,0 +1,63 @@
+import { createYoga, createSchema } from 'graphql-yoga'
+import { fetch } from '@whatwg-node/fetch'
+import { GraphQLError } from 'graphql'
+
+const users = [
+  {
+    id: '1',
+    login: 'Laurin',
+  },
+  {
+    id: '2',
+    login: 'Saihaj',
+  },
+  {
+    id: '3',
+    login: 'Dotan',
+  },
+]
+
+// Provide your schema
+export const yoga = createYoga({
+  schema: createSchema({
+    typeDefs: /* GraphQL */ `
+      type User {
+        id: ID!
+        login: String!
+      }
+      type Query {
+        greeting: String!
+        user(byId: ID!): User!
+      }
+    `,
+    resolvers: {
+      Query: {
+        greeting: async () => {
+          // This service does not exist
+          const greeting = await fetch('http://localhost:9876/greeting').then(
+            (res) => res.text(),
+          )
+
+          return greeting
+        },
+        user: async (_, args) => {
+          const user = users.find((user) => user.id === args.byId)
+          if (!user) {
+            throw new GraphQLError(`User with id '${args.byId}' not found.`, {
+              extensions: {
+                code: 'USER_NOT_FOUND',
+                someRandomExtensions: {
+                  aaaa: 3,
+                },
+              },
+            })
+          }
+
+          return user
+        },
+      },
+    },
+  }),
+  logging: true,
+  maskedErrors: true,
+})

examples/error-handling/tsconfig.json

@@ -5,6 +5,7 @@
     "moduleResolution": "node",
     "module": "commonjs",
     "sourceMap": true,
-    "lib": ["esnext"]
+    "lib": ["esnext"],
+    "esModuleInterop": true
   }
 }