Upgrade to envelop v3 (#1660)

saihaj · enisdenjo · ardatan · web-flow · commit 715541729f76 · 2022-10-17T05:19:29.000-04:00
* update envelop

* bring error formatter here

* feat: create a wrapped schema

* changeset for now

* useOnResolver envelop plugin proposal

* run canary for v3

* do not run deps

* fix version

* plz

* remove

* update envelop

* error masking works

* plz build

* update to new envelop

* Fix tests

* works

* update

* resolve to envelop v3

* deno resolve import to envelop/core 3

* code review

* update guide

* unnecessary cast

* use own isGraphQL

* dev is when not prod

* use http validation context generic

* use yoga types

* plugins need to inherit the context

* patch envelop core

* patch envelop response-cache

* partial yoga masked error opts

* appearantly dev env is when dev env

* remove unused

* remove more

* relative imports need .js

* Go

* Go

Co-authored-by: enisdenjo &lt;badurinadenis@gmail.com&gt;
Co-authored-by: Arda TANRIKULU &lt;ardatanrikulu@gmail.com&gt;
diff --git a/.changeset/strong-peas-exercise.md b/.changeset/strong-peas-exercise.md
@@ -0,0 +1,10 @@
+---
+'graphql-yoga': major
+---
+
+update to Envelop `useMaskedError` plugin
+
+- Removed handleValidationErrors and handleParseErrors
+- Renamed formatError to maskError
+
+Checkout envelop docs for more details https://www.the-guild.dev/graphql/envelop/v3/guides/migrating-from-v2-to-v3#8-update-options-for-usemaskederrors-plugin
diff --git a/examples/apollo-federation/gateway/package.json b/examples/apollo-federation/gateway/package.json
@@ -8,7 +8,7 @@
   },
   "dependencies": {
     "@apollo/gateway": "^0.52.0",
-    "@envelop/apollo-federation": "^2.5.0",
+    "@envelop/apollo-federation": "3.0.1",
     "graphql-yoga": "3.0.0-next.4",
     "graphql": "^16.5.0"
   }
diff --git a/examples/fastify-modules/package.json b/examples/fastify-modules/package.json
@@ -7,7 +7,7 @@
     "check": "tsc --pretty --noEmit"
   },
   "dependencies": {
-    "@envelop/graphql-modules": "3.6.0",
+    "@envelop/graphql-modules": "4.0.1",
     "@graphql-tools/load-files": "6.6.1",
     "graphql-yoga": "3.0.0-next.4",
     "fastify": "4.7.0",
diff --git a/examples/generic-auth/package.json b/examples/generic-auth/package.json
@@ -19,7 +19,7 @@
     "typescript": "4.8.4"
   },
   "dependencies": {
-    "@envelop/generic-auth": "4.6.0",
+    "@envelop/generic-auth": "5.0.1",
     "graphql-yoga": "3.0.0-next.4",
     "graphql": "16.6.0"
   }
diff --git a/examples/live-query/package.json b/examples/live-query/package.json
@@ -13,7 +13,7 @@
     "typescript": "4.8.4"
   },
   "dependencies": {
-    "@envelop/live-query": "4.2.0",
+    "@envelop/live-query": "5.0.1",
     "@n1ru4l/in-memory-live-query-store": "0.10.0",
     "graphql-yoga": "3.0.0-next.4",
     "graphql": "16.6.0"
diff --git a/examples/sveltekit/package.json b/examples/sveltekit/package.json
@@ -35,7 +35,7 @@
 		"vite": "3.1.6"
 	},
 	"dependencies": {
-		"@envelop/graphql-jit": "4.6.0",
+		"@envelop/graphql-jit": "5.0.1",
 		"graphql-yoga": "3.0.0-next.4",
 		"graphql": "16.6.0"
 	},
diff --git a/import-map.json b/import-map.json
@@ -7,7 +7,7 @@
     "@graphql-tools/utils": "npm:@graphql-tools/utils",
     "graphql": "npm:graphql",
     "dset": "npm:dset",
-    "@envelop/core": "npm:@envelop/core@2",
+    "@envelop/core": "npm:@envelop/core@3",
     "@envelop/parser-cache": "npm:@envelop/parser-cache",
     "@envelop/validation-cache": "npm:@envelop/validation-cache",
     "@whatwg-node/fetch": "npm:@whatwg-node/fetch",
diff --git a/package.json b/package.json
@@ -95,6 +95,7 @@
     "weak-napi": "2.0.2"
   },
   "resolutions": {
-    "graphql": "16.6.0"
+    "graphql": "16.6.0",
+    "@envelop/core": "3.0.2"
   }
 }
diff --git a/packages/graphql-yoga/__tests__/context.spec.ts b/packages/graphql-yoga/__tests__/context.spec.ts
@@ -120,7 +120,6 @@ describe('Context', () => {
     const onContextBuildingFn = jest.fn(
       (() => {}) as Plugin['onContextBuilding'],
     )
-    const onResolverCalledFn = jest.fn((() => {}) as Plugin['onResolverCalled'])
 
     const yoga = createYoga({
       schema,
@@ -131,7 +130,6 @@ describe('Context', () => {
           onParse: onParseFn,
           onValidate: onValidateFn,
           onContextBuilding: onContextBuildingFn,
-          onResolverCalled: onResolverCalledFn,
         },
       ],
     })
@@ -157,8 +155,5 @@ describe('Context', () => {
 
     expect(onContextBuildingFn.mock.lastCall[0].context.params).toEqual(params)
     expect(onContextBuildingFn.mock.lastCall[0].context.request).toBeDefined()
-
-    expect(onResolverCalledFn.mock.lastCall[0].context.params).toEqual(params)
-    expect(onResolverCalledFn.mock.lastCall[0].context.request).toBeDefined()
   })
 })
diff --git a/packages/graphql-yoga/package.json b/packages/graphql-yoga/package.json
@@ -49,9 +49,9 @@
   },
   "dependencies": {
     "@graphql-tools/utils": "8.12.0",
-    "@envelop/core": "^2.5.0",
-    "@envelop/parser-cache": "^4.6.0",
-    "@envelop/validation-cache": "^4.6.0",
+    "@envelop/core": "3.0.2",
+    "@envelop/parser-cache": "5.0.1",
+    "@envelop/validation-cache": "5.0.1",
     "@graphql-typed-document-node/core": "^3.1.1",
     "@graphql-tools/schema": "^9.0.0",
     "@graphql-yoga/subscription": "^3.0.0-next.0",
@@ -63,8 +63,8 @@
   "devDependencies": {
     "@types/node": "16.11.64",
     "html-minifier-terser": "7.0.0",
-    "@envelop/disable-introspection": "^3.5.0",
-    "@envelop/live-query": "^4.1.0",
+    "@envelop/disable-introspection": "4.0.1",
+    "@envelop/live-query": "5.0.1",
     "graphql": "^16.0.1",
     "graphql-scalars": "1.18.0",
     "graphql-http": "^1.6.0",
diff --git a/packages/graphql-yoga/src/error.ts b/packages/graphql-yoga/src/error.ts
@@ -21,10 +21,16 @@ function hasToString(obj: any): obj is { toString(): string } {
   return obj != null && typeof obj.toString === 'function'
 }
 
-export function isOriginalGraphQLError(error: Error): boolean {
-  if (error instanceof GraphQLError) {
-    if (error.originalError != null) {
-      return isOriginalGraphQLError(error.originalError)
+export function isGraphQLError(val: unknown): val is GraphQLError {
+  return val instanceof GraphQLError
+}
+
+export function isOriginalGraphQLError(
+  val: unknown,
+): val is GraphQLError & { originalError: GraphQLError } {
+  if (val instanceof GraphQLError) {
+    if (val.originalError != null) {
+      return isOriginalGraphQLError(val.originalError)
     }
     return true
   }
@@ -44,13 +50,18 @@ export function handleError(
       }
     }
   } else if (maskedErrorsOpts) {
-    const maskedError = maskedErrorsOpts.formatError(
+    const maskedError = maskedErrorsOpts.maskError(
       error,
       maskedErrorsOpts.errorMessage,
-      maskedErrorsOpts.isDev,
     )
-    errors.add(maskedError)
-  } else if (error instanceof GraphQLError) {
+    errors.add(
+      isGraphQLError(maskedError)
+        ? maskedError
+        : createGraphQLError(maskedError.message, {
+            originalError: maskedError,
+          }),
+    )
+  } else if (isGraphQLError(error)) {
     errors.add(error)
   } else if (error instanceof Error) {
     errors.add(
@@ -91,7 +102,6 @@ export function handleError(
   }
   return Array.from(errors)
 }
-
 export function getResponseInitByRespectingErrors(
   result: ResultProcessorInput,
   headers: Record<string, string> = {},
diff --git a/packages/graphql-yoga/src/plugins/requestValidation/useHTTPValidationError.ts b/packages/graphql-yoga/src/plugins/requestValidation/useHTTPValidationError.ts
@@ -13,12 +13,15 @@ export function getAggregateErrorFromErrors(
   throw new AggregateError(errors)
 }
 
-export function useHTTPValidationError(): Plugin {
+export function useHTTPValidationError<
+  PluginContext extends Record<string, any> = {},
+>(): Plugin<PluginContext> {
   return {
     onValidate() {
       return ({ valid, result }) => {
         if (!valid) {
-          throw getAggregateErrorFromErrors(result)
+          // Typecasting since Envelop is Agnostic to GraphQL.js
+          throw getAggregateErrorFromErrors(result as GraphQLError[])
         }
       }
     },
diff --git a/packages/graphql-yoga/src/server.ts b/packages/graphql-yoga/src/server.ts
@@ -1,12 +1,20 @@
-import { print, ExecutionResult } from 'graphql'
+import {
+  print,
+  ExecutionResult,
+  execute,
+  parse,
+  validate,
+  subscribe,
+  specifiedRules,
+} from 'graphql'
 import {
   GetEnvelopedFn,
   envelop,
-  useMaskedErrors,
-  UseMaskedErrorsOpts,
+  useEngine,
   useExtendContext,
   useLogger,
   PromiseOrValue,
+  useMaskedErrors,
 } from '@envelop/core'
 import { useValidationCache, ValidationCache } from '@envelop/validation-cache'
 import { ParserCacheOptions, useParserCache } from '@envelop/parser-cache'
@@ -96,7 +104,7 @@ export type YogaServerOptions<
    *
    * @default true
    */
-  maskedErrors?: boolean | UseMaskedErrorsOpts
+  maskedErrors?: boolean | Partial<YogaMaskedErrorOpts>
   /**
    * Context
    */
@@ -239,9 +247,13 @@ export class YogaServer<
       options?.maskedErrors === false
         ? null
         : {
-            formatError: yogaDefaultFormatError,
+            maskError: (error, message) =>
+              yogaDefaultFormatError({
+                error,
+                message,
+                isDev: this.maskedErrorsOpts?.isDev ?? false,
+              }),
             errorMessage: 'Unexpected error.',
-            isDev: globalThis.process?.env?.NODE_ENV === 'development',
             ...(typeof options?.maskedErrors === 'object'
               ? options.maskedErrors
               : {}),
@@ -263,6 +275,7 @@ export class YogaServer<
     const graphqlEndpoint = this.graphqlEndpoint
 
     this.plugins = [
+      useEngine({ parse, validate, execute, subscribe, specifiedRules }),
       // Use the schema provided by the user
       !!options?.schema && useSchema(options.schema),
 
@@ -311,13 +324,14 @@ export class YogaServer<
           },
         }),
       options?.context != null &&
-        useExtendContext(async (initialContext) => {
+        useExtendContext((initialContext) => {
           if (options?.context) {
             if (typeof options.context === 'function') {
-              return (options.context as Function)(initialContext)
+              return options.context(initialContext)
             }
             return options.context
           }
+          return {}
         }),
       // Middlewares before processing the incoming HTTP request
       useHealthCheck({
@@ -395,7 +409,9 @@ export class YogaServer<
 
     this.getEnveloped = envelop({
       plugins: this.plugins,
-    }) as GetEnvelopedFn<TUserContext & TServerContext & YogaInitialContext>
+    }) as unknown as GetEnvelopedFn<
+      TUserContext & TServerContext & YogaInitialContext
+    >
 
     this.onRequestHooks = []
     this.onRequestParseHooks = []
diff --git a/packages/graphql-yoga/src/types.ts b/packages/graphql-yoga/src/types.ts
@@ -1,6 +1,6 @@
-import type { DocumentNode, GraphQLError } from 'graphql'
+import type { GraphQLError } from 'graphql'
 import type { TypedDocumentNode } from '@graphql-typed-document-node/core'
-import type { FormatErrorHandler, PromiseOrValue } from '@envelop/core'
+import type { MaskError, PromiseOrValue } from '@envelop/core'
 import type { createFetch } from '@whatwg-node/fetch'
 import type { GraphQLSchema } from 'graphql'
 
@@ -83,9 +83,9 @@ export interface FetchEvent extends Event {
 }
 
 export type YogaMaskedErrorOpts = {
-  formatError: FormatErrorHandler
+  maskError: MaskError
   errorMessage: string
-  isDev: boolean
+  isDev?: boolean
 }
 
 export type MaybeArray<T> = T | T[]
diff --git a/packages/graphql-yoga/src/utils/yogaDefaultFormatError.ts b/packages/graphql-yoga/src/utils/yogaDefaultFormatError.ts
@@ -1,46 +1,61 @@
-import { FormatErrorHandler } from '@envelop/core'
 import { createGraphQLError } from '@graphql-tools/utils'
-import { GraphQLError, GraphQLErrorExtensions } from 'graphql'
+import { GraphQLErrorExtensions } from 'graphql'
+import { isGraphQLError } from '../error.js'
 
-export const yogaDefaultFormatError: FormatErrorHandler = (
-  err,
+export const yogaDefaultFormatError = ({
+  error,
   message,
   isDev,
-) => {
-  if (err instanceof GraphQLError) {
-    if (err.originalError) {
-      if (err.originalError.name === 'GraphQLError') {
-        return err
+}: {
+  error: unknown
+  message: string
+  isDev?: boolean
+}) => {
+  const dev = isDev || globalThis.process?.env?.NODE_ENV === 'development'
+
+  if (isGraphQLError(error)) {
+    if (error.originalError) {
+      if (error.originalError.name === 'GraphQLError') {
+        return error
       }
       // Original error should be removed
       const extensions: GraphQLErrorExtensions = {
-        ...err.extensions,
+        ...error.extensions,
         http: {
           status: 500,
-          ...err.extensions?.http,
+          ...error.extensions?.http,
         },
       }
-      if (isDev) {
+      if (dev) {
         extensions.originalError = {
-          message: err.originalError.message,
-          stack: err.originalError.stack,
+          message: error.originalError.message,
+          stack: error.originalError.stack,
         }
       }
       return createGraphQLError(message, {
-        nodes: err.nodes,
-        source: err.source,
-        positions: err.positions,
-        path: err.path,
+        nodes: error.nodes,
+        source: error.source,
+        positions: error.positions,
+        path: error.path,
         extensions,
       })
     }
-    return err
+    return error
   }
+
   return createGraphQLError(message, {
     extensions: {
       http: {
         status: 500,
       },
+      originalError: dev
+        ? error instanceof Error
+          ? {
+              message: error.message,
+              stack: error.stack,
+            }
+          : error
+        : undefined,
     },
   })
 }
diff --git a/packages/node/package.json b/packages/node/package.json
@@ -66,6 +66,15 @@
     "graphql-yoga": "3.0.0-next.4",
     "tslib": "^2.3.1"
   },
+  "devDependencies": {
+    "@envelop/disable-introspection": "4.0.1",
+    "@envelop/live-query": "5.0.1",
+    "@types/eventsource": "1.1.9",
+    "@types/node": "16.11.63",
+    "graphql": "^16.6.0",
+    "graphql-scalars": "1.18.0",
+    "puppeteer": "18.0.5"
+  },
   "peerDependencies": {
     "graphql": "^15.2.0 || ^16.0.0"
   },
diff --git a/packages/plugins/apollo-inline-trace/package.json b/packages/plugins/apollo-inline-trace/package.json
diff --git a/packages/plugins/apollo-inline-trace/src/index.ts b/packages/plugins/apollo-inline-trace/src/index.ts
diff --git a/packages/plugins/response-cache/package.json b/packages/plugins/response-cache/package.json
diff --git a/website/src/pages/v3/migration/migration-from-yoga-v2.mdx b/website/src/pages/v3/migration/migration-from-yoga-v2.mdx
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@`
`8`	`8`	`},`
`9`	`9`	`"dependencies": {`
`10`	`10`	`"@apollo/gateway": "^0.52.0",`
`11`		`- "@envelop/apollo-federation": "^2.5.0",`
	`11`	`+ "@envelop/apollo-federation": "3.0.1",`
`12`	`12`	`"graphql-yoga": "3.0.0-next.4",`
`13`	`13`	`"graphql": "^16.5.0"`
`14`	`14`	`}`
Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@`
`19`	`19`	`"typescript": "4.8.4"`
`20`	`20`	`},`
`21`	`21`	`"dependencies": {`
`22`		`- "@envelop/generic-auth": "4.6.0",`
	`22`	`+ "@envelop/generic-auth": "5.0.1",`
`23`	`23`	`"graphql-yoga": "3.0.0-next.4",`
`24`	`24`	`"graphql": "16.6.0"`
`25`	`25`	`}`
Original file line number	Diff line number	Diff line change
`@@ -95,6 +95,7 @@`
`95`	`95`	`"weak-napi": "2.0.2"`
`96`	`96`	`},`
`97`	`97`	`"resolutions": {`
`98`		`- "graphql": "16.6.0"`
	`98`	`+ "graphql": "16.6.0",`
	`99`	`+ "@envelop/core": "3.0.2"`
`99`	`100`	`}`
`100`	`101`	`}`