chore: Update graphql-server to Yoga v4 and latest subscriptions (red…

…woodjs#8753) * WIP v4 yoga and gql updates * Update graphql tools bump * yarn constraints * GraphQLArmor bump * Updates scalars in studio * Updates error masking tests * Resolve yarn * yarn dedupe * Add resolution to e2e --------- Co-authored-by: Josh GM Walker <56300765+Josh-Walker-GM@users.noreply.github.com>
dthyresson · Jun 29, 2023 · 89cdba8 · 89cdba8
1 parent 4031414
commit 89cdba8
Show file tree

Hide file tree

Showing 15 changed files with 329 additions and 141 deletions.
diff --git a/packages/codemods/package.json b/packages/codemods/package.json
@@ -39,7 +39,7 @@
     "deepmerge": "4.3.1",
     "execa": "5.1.1",
     "fast-glob": "3.2.12",
-    "graphql": "16.6.0",
+    "graphql": "16.7.1",
     "jest": "29.5.0",
     "jscodeshift": "0.15.0",
     "pascalcase": "1.0.0",

diff --git a/packages/core/package.json b/packages/core/package.json
@@ -65,7 +65,7 @@
     "esbuild": "0.18.10",
     "fast-glob": "3.2.12",
     "file-loader": "6.2.0",
-    "graphql": "16.6.0",
+    "graphql": "16.7.1",
     "graphql-tag": "2.12.6",
     "html-webpack-plugin": "5.5.3",
     "lodash": "4.17.21",

diff --git a/packages/forms/package.json b/packages/forms/package.json
@@ -38,15 +38,15 @@
     "@types/react": "18.2.14",
     "@types/react-dom": "18.2.6",
     "@types/testing-library__jest-dom": "5.14.6",
-    "graphql": "16.6.0",
+    "graphql": "16.7.1",
     "jest": "29.5.0",
     "nodemon": "2.0.22",
     "react": "18.2.0",
     "react-dom": "18.2.0",
     "typescript": "5.1.3"
   },
   "peerDependencies": {
-    "graphql": "16.6.0",
+    "graphql": "16.7.1",
     "react": "18.2.0"
   },
   "gitHead": "3905ed045508b861b495f8d5630d76c7a157d8f1"

diff --git a/packages/graphql-server/package.json b/packages/graphql-server/package.json
@@ -29,21 +29,21 @@
     "@envelop/filter-operation-type": "5.0.0",
     "@envelop/live-query": "6.0.0",
     "@envelop/on-resolve": "3.0.0",
-    "@escape.tech/graphql-armor": "2.0.0",
-    "@graphql-tools/merge": "8.4.2",
-    "@graphql-tools/schema": "9.0.19",
-    "@graphql-tools/utils": "9.2.1",
-    "@graphql-yoga/subscription": "3.1.0",
+    "@escape.tech/graphql-armor": "2.2.0",
+    "@graphql-tools/merge": "9.0.0",
+    "@graphql-tools/schema": "10.0.0",
+    "@graphql-tools/utils": "10.0.1",
+    "@graphql-yoga/subscription": "4.0.0",
     "@n1ru4l/graphql-live-query": "0.10.0",
     "@n1ru4l/in-memory-live-query-store": "0.10.0",
     "@opentelemetry/api": "1.4.1",
     "@redwoodjs/api": "5.0.0",
     "@redwoodjs/project-config": "5.0.0",
     "core-js": "3.31.0",
-    "graphql": "16.6.0",
+    "graphql": "16.7.1",
     "graphql-scalars": "1.22.2",
     "graphql-tag": "2.12.6",
-    "graphql-yoga": "3.9.1",
+    "graphql-yoga": "4.0.2",
     "lodash": "4.17.21",
     "uuid": "9.0.0"
   },

diff --git a/packages/graphql-server/src/plugins/__tests__/useArmor.test.ts b/packages/graphql-server/src/plugins/__tests__/useArmor.test.ts
@@ -471,11 +471,8 @@ describe('useArmor secures the GraphQLHandler endpoint for depth, aliases, cost,
    *
    * Note: When reporting the number of found tokens as in
    *
-   * '"Syntax Error: Token limit of 2 exceeded, found 3."'
+   * '"Syntax Error: Token limit of 2 exceeded."'
    *
-   * The number found is not the total tokens, but the value when found that exceeded the limit.
-   *
-   * Therefore found would be n + 1.
    *
    */
   describe('when protecting against token complexity', () => {
@@ -491,7 +488,7 @@ describe('useArmor secures the GraphQLHandler endpoint for depth, aliases, cost,
         expect(response.statusCode).toBe(200)
         expect(data).toBeUndefined()
         expect(errors[0].message).toMatchInlineSnapshot(
-          '"Syntax Error: Token limit of 2 exceeded, found 3."'
+          '"Syntax Error: Token limit of 2 exceeded."'
         )
       })
     })

diff --git a/packages/graphql-server/src/plugins/__tests__/useRedwoodError.test.ts b/packages/graphql-server/src/plugins/__tests__/useRedwoodError.test.ts
@@ -6,8 +6,12 @@ import { createLogger } from '@redwoodjs/api/logger'
 import { createGraphQLHandler } from '../../functions/graphql'
 
 jest.mock('../../makeMergedSchema', () => {
+  const { createGraphQLError } = require('graphql-yoga')
   const { makeExecutableSchema } = require('@graphql-tools/schema')
-  const { ForbiddenError } = require('@redwoodjs/graphql-server/dist/errors')
+  const {
+    ForbiddenError,
+    RedwoodGraphQLError,
+  } = require('@redwoodjs/graphql-server/dist/errors')
   const { EmailValidationError, RedwoodError } = require('@redwoodjs/api')
 
   const { CurrencyResolver } = require('graphql-scalars')
@@ -37,14 +41,15 @@ jest.mock('../../makeMergedSchema', () => {
             getUser(id: Int!): User!
             invalidUser: User!
             unexpectedUser: User!
+            graphQLErrorUser: User!
+            redwoodGraphQLErrorUser: User!
           }
 
           scalar Currency
 
           type Product {
             id: Int!
             name: String!
-
             currency_iso_4217: Currency!
           }
 
@@ -70,6 +75,14 @@ jest.mock('../../makeMergedSchema', () => {
             forbiddenUser: () => {
               throw new ForbiddenError('You are forbidden')
             },
+            graphQLErrorUser: () => {
+              throw createGraphQLError('You are forbidden by a GraphQLError')
+            },
+            redwoodGraphQLErrorUser: () => {
+              throw new RedwoodGraphQLError(
+                'You are forbidden by a RedwoodGraphQLError'
+              )
+            },
             invalidUser: () => {
               throw new EmailValidationError('emailmissingatexample.com')
             },
@@ -262,7 +275,75 @@ describe('useRedwoodError', () => {
         })
 
         const response = await handler(mockedEvent, {} as Context)
+        const { data, errors } = JSON.parse(response.body)
+
         expect(response.statusCode).toBe(200)
+        expect(data).toBeNull()
+        expect(errors[0].message).toContain(
+          'Emailmissingatexample.com must be formatted'
+        )
+      })
+    })
+
+    describe('with a RedwoodGraphQLError', () => {
+      it('does not mask error message', async () => {
+        const handler = createGraphQLHandler({
+          loggerConfig: { logger: createLogger({}), options: {} },
+          sdls: {},
+          directives: {},
+          services: {},
+          onException: () => {},
+        })
+
+        const mockedEvent = mockLambdaEvent({
+          headers: {
+            'Content-Type': 'application/json',
+          },
+          body: JSON.stringify({
+            query: '{ redwoodGraphQLErrorUser { id, name } }',
+          }),
+          httpMethod: 'POST',
+        })
+
+        const response = await handler(mockedEvent, {} as Context)
+        const { data, errors } = JSON.parse(response.body)
+
+        expect(response.statusCode).toBe(200)
+        expect(data).toBeNull()
+        expect(errors[0].message).toContain(
+          'You are forbidden by a RedwoodGraphQLError'
+        )
+      })
+    })
+
+    describe('with a GraphQLError', () => {
+      it('does not mask error message', async () => {
+        const handler = createGraphQLHandler({
+          loggerConfig: { logger: createLogger({}), options: {} },
+          sdls: {},
+          directives: {},
+          services: {},
+          onException: () => {},
+        })
+
+        const mockedEvent = mockLambdaEvent({
+          headers: {
+            'Content-Type': 'application/json',
+          },
+          body: JSON.stringify({
+            query: '{ graphQLErrorUser { id, name } }',
+          }),
+          httpMethod: 'POST',
+        })
+
+        const response = await handler(mockedEvent, {} as Context)
+        const { data, errors } = JSON.parse(response.body)
+
+        expect(response.statusCode).toBe(200)
+        expect(data).toBeNull()
+        expect(errors[0].message).toContain(
+          'You are forbidden by a GraphQLError'
+        )
       })
     })
 
@@ -297,7 +378,7 @@ describe('useRedwoodError', () => {
         expect(data.products[0].currency_iso_4217).toEqual('USD')
       })
 
-      it('shows the custom scalar currency type validation error message', async () => {
+      it('masks a custom scalar currency type runtime validation error message', async () => {
         const handler = createGraphQLHandler({
           loggerConfig: { logger: createLogger({}), options: {} },
           sdls: {},
@@ -324,9 +405,7 @@ describe('useRedwoodError', () => {
         const { data, errors } = JSON.parse(response.body)
 
         expect(data).toBeNull()
-        expect(errors[0].message).toEqual(
-          'Value is not a valid currency value: Calamari flan'
-        )
+        expect(errors[0].message).toEqual('Something went wrong.')
       })
     })
 

diff --git a/packages/graphql-server/src/plugins/useArmor.ts b/packages/graphql-server/src/plugins/useArmor.ts
@@ -35,6 +35,7 @@ export const useArmor = (logger: Logger, config?: ArmorConfig) => {
     },
     maxDepth: {
       ...config?.maxDepth,
+      flattenFragments: true,
       onReject: [logRejection],
     },
     maxDirectives: {

diff --git a/packages/internal/package.json b/packages/internal/package.json
@@ -52,7 +52,7 @@
     "esbuild": "0.18.10",
     "fast-glob": "3.2.12",
     "fs-extra": "11.1.1",
-    "graphql": "16.6.0",
+    "graphql": "16.7.1",
     "kill-port": "1.6.1",
     "prettier": "2.8.8",
     "rimraf": "5.0.1",

diff --git a/packages/prerender/package.json b/packages/prerender/package.json
@@ -35,7 +35,7 @@
     "babel-plugin-ignore-html-and-css-imports": "0.1.0",
     "cheerio": "1.0.0-rc.12",
     "core-js": "3.31.0",
-    "graphql": "16.6.0",
+    "graphql": "16.7.1",
     "mime-types": "2.1.35"
   },
   "devDependencies": {

diff --git a/packages/structure/package.json b/packages/structure/package.json
@@ -41,7 +41,7 @@
     "dotenv-defaults": "5.0.2",
     "enquirer": "2.3.6",
     "fast-glob": "3.2.12",
-    "graphql": "16.6.0",
+    "graphql": "16.7.1",
     "lazy-get-decorator": "2.2.1",
     "line-column": "1.0.2",
     "lodash": "4.17.21",

diff --git a/packages/studio/frontend/package.json b/packages/studio/frontend/package.json
@@ -22,8 +22,8 @@
     "@tailwindcss/forms": "0.5.3",
     "@tremor/react": "3.2.3",
     "graphiql": "2.4.7",
-    "graphql": "16.6.0",
-    "graphql-scalars": "1.21.3",
+    "graphql": "16.7.1",
+    "graphql-scalars": "1.22.2",
     "json-bigint-patch": "0.0.8",
     "pretty-ms": "7.0.0",
     "react": "18.2.0",

diff --git a/packages/studio/package.json b/packages/studio/package.json
@@ -39,7 +39,7 @@
     "fast-json-parse": "1.0.3",
     "fastify": "4.18.0",
     "fastify-raw-body": "4.2.0",
-    "graphql": "16.6.0",
+    "graphql": "16.7.1",
     "graphql-scalars": "1.22.2",
     "graphql-yoga": "3.9.1",
     "jsonwebtoken": "9.0.0",

diff --git a/packages/web/package.json b/packages/web/package.json
@@ -39,7 +39,7 @@
     "@babel/runtime-corejs3": "7.22.5",
     "@redwoodjs/auth": "5.0.0",
     "core-js": "3.31.0",
-    "graphql": "16.6.0",
+    "graphql": "16.7.1",
     "graphql-tag": "2.12.6",
     "react-helmet-async": "1.3.0",
     "react-hot-toast": "2.4.1",

diff --git a/tasks/run-e2e b/tasks/run-e2e
@@ -83,6 +83,7 @@ const createRedwoodJSApp = ({ typescript, bundler }) => {
       '@prisma/client': getVersionFrmRwPkg('@prisma/client', 'api'),
       '@prisma/internals': getVersionFrmRwPkg('@prisma/internals', 'cli'),
       'graphql-yoga': getVersionFrmRwPkg('graphql-yoga', 'graphql-server'),
+      graphql: getVersionFrmRwPkg('graphql', 'graphql-server'),
     }
 
     fs.writeFileSync(packageJSONPath, JSON.stringify(packageJSON, null, 2))