chore: upgrade to graphql 16 (#137)

Graphql 16 Brings internal breaking api changes.

BREAKING CHANGE: A minimum of Graphql 16 is now required

Author: reconbot

lib/messages/complete.ts

@@ -16,21 +16,19 @@ export const complete: MessageHandler<CompleteMessage> = async ({ server, event,
     if (!subscription) {
       return
     }
-    const execContext = buildExecutionContext(
-      server.schema,
-      parse(subscription.subscription.query),
-      undefined,
-      await buildContext({ server, connectionInitPayload: subscription.connectionInitPayload, connectionId: subscription.connectionId }),
-      subscription.subscription.variables,
-      subscription.subscription.operationName,
-      undefined,
-    )
+    const execContext = buildExecutionContext({
+      schema: server.schema,
+      document: parse(subscription.subscription.query),
+      contextValue: await buildContext({ server, connectionInitPayload: subscription.connectionInitPayload, connectionId: subscription.connectionId }),
+      variableValues: subscription.subscription.variables,
+      operationName: subscription.subscription.operationName,
+    })
 
     if (isArray(execContext)) {
       throw new AggregateError(execContext)
     }
 
-    const { field, root, args, context, info } = getResolverAndArgs({ server, execContext })
+    const { field, root, args, context, info } = getResolverAndArgs({ execContext })
 
     const onComplete = (field?.subscribe as SubscribePseudoIterable<PubSubEvent>)?.onComplete
     server.log('messages:complete:onComplete', { onComplete: !!onComplete })

lib/messages/disconnect.ts

@@ -24,21 +24,19 @@ export const disconnect: MessageHandler<null> = async ({ server, event }) => {
     const deletions = topicSubscriptions.map(async (sub) => {
       const queryContext = await buildContext({ server, connectionInitPayload: sub.connectionInitPayload, connectionId })
 
-      const execContext = buildExecutionContext(
-        server.schema,
-        parse(sub.subscription.query),
-        undefined,
-        queryContext,
-        sub.subscription.variables,
-        sub.subscription.operationName,
-        undefined,
-      )
+      const execContext = buildExecutionContext({
+        schema: server.schema,
+        document: parse(sub.subscription.query),
+        contextValue: queryContext,
+        variableValues: sub.subscription.variables,
+        operationName: sub.subscription.operationName,
+      })
 
       if (isArray(execContext)) {
         throw new AggregateError(execContext)
       }
 
-      const { field, root, args, context, info } = getResolverAndArgs({ server, execContext })
+      const { field, root, args, context, info } = getResolverAndArgs({ execContext })
 
       const onComplete = (field?.subscribe as SubscribePseudoIterable<PubSubEvent>)?.onComplete
       server.log('messages:disconnect:onComplete', { onComplete: !!onComplete })

lib/messages/subscribe.ts

@@ -49,15 +49,13 @@ const setupSubscription: MessageHandler<SubscribeMessage> = async ({ server, eve
 
   const contextValue = await buildContext({ server, connectionInitPayload: connection.payload, connectionId })
 
-  const execContext = buildExecutionContext(
-    server.schema,
-    parse(message.payload.query),
-    undefined,
+  const execContext = buildExecutionContext({
+    schema: server.schema,
+    document: parse(message.payload.query),
     contextValue,
-    message.payload.variables,
-    message.payload.operationName,
-    undefined,
-  )
+    variableValues: message.payload.variables,
+    operationName: message.payload.operationName,
+  })
 
   if (isArray(execContext)) {
     return postToConnection(server)({
@@ -80,7 +78,7 @@ const setupSubscription: MessageHandler<SubscribeMessage> = async ({ server, eve
     return
   }
 
-  const { field, root, args, context, info } = getResolverAndArgs({ server, execContext })
+  const { field, root, args, context, info } = getResolverAndArgs({ execContext })
   if (!field) {
     throw new Error('No field')
   }
@@ -160,15 +158,13 @@ const validateMessage = (server: ServerClosure) => (message: SubscribeMessage) =
 async function executeQuery(server: ServerClosure, message: SubscribeMessage, contextValue: any, event: APIGatewayWebSocketEvent) {
   server.log('executeQuery', { connectionId: event.requestContext.connectionId, query: message.payload.query })
 
-  const result = await execute(
-    server.schema,
-    parse(message.payload.query),
-    undefined,
+  const result = await execute({
+    schema: server.schema,
+    document: parse(message.payload.query),
     contextValue,
-    message.payload.variables,
-    message.payload.operationName,
-    undefined,
-  )
+    variableValues: message.payload.variables,
+    operationName: message.payload.operationName,
+  })
 
   await postToConnection(server)({
     ...event.requestContext,

lib/pubsub/complete.ts

@@ -25,21 +25,19 @@ export const complete = (serverPromise: Promise<ServerClosure> | ServerClosure):
     })
     await server.models.subscription.delete({ id: sub.id })
 
-    const execContext = buildExecutionContext(
-      server.schema,
-      parse(sub.subscription.query),
-      undefined,
-      await buildContext({ server, connectionInitPayload: sub.connectionInitPayload, connectionId: sub.connectionId }),
-      sub.subscription.variables,
-      sub.subscription.operationName,
-      undefined,
-    )
+    const execContext = buildExecutionContext({
+      schema: server.schema,
+      document: parse(sub.subscription.query),
+      contextValue: await buildContext({ server, connectionInitPayload: sub.connectionInitPayload, connectionId: sub.connectionId }),
+      variableValues: sub.subscription.variables,
+      operationName: sub.subscription.operationName,
+    })
 
     if (isArray(execContext)) {
       throw new AggregateError(execContext)
     }
 
-    const { field, root, args, context, info } = getResolverAndArgs({ server, execContext })
+    const { field, root, args, context, info } = getResolverAndArgs({ execContext })
 
     const onComplete = (field?.subscribe as SubscribePseudoIterable<PubSubEvent>)?.onComplete
     server.log('pubsub:complete:onComplete', { onComplete: !!onComplete })

lib/pubsub/publish.ts

@@ -12,15 +12,14 @@ export const publish = (serverPromise: Promise<ServerClosure> | ServerClosure):
   server.log('pubsub:publish', { subscriptions: subscriptions.map(({ connectionId, filter, subscription }) => ({ connectionId, filter, subscription }) ) })
 
   const iters = subscriptions.map(async (sub) => {
-    const payload = await execute(
-      server.schema,
-      parse(sub.subscription.query),
-      event,
-      await buildContext({ server, connectionInitPayload: sub.connectionInitPayload, connectionId: sub.connectionId }),
-      sub.subscription.variables,
-      sub.subscription.operationName,
-      undefined,
-    )
+    const payload = await execute({
+      schema: server.schema,
+      document: parse(sub.subscription.query),
+      rootValue: event,
+      contextValue: await buildContext({ server, connectionInitPayload: sub.connectionInitPayload, connectionId: sub.connectionId }),
+      variableValues: sub.subscription.variables,
+      operationName: sub.subscription.operationName,
+    })
 
     const message: NextMessage = {
       id: sub.subscriptionId,

lib/utils/getResolverAndArgs.ts

@@ -1,13 +1,12 @@
-import { getOperationRootType } from 'graphql'
+import { GraphQLError } from 'graphql'
 import {
   buildResolveInfo,
-  collectFields,
   ExecutionContext,
   getFieldDef,
 } from 'graphql/execution/execute'
+import { collectFields } from 'graphql/execution/collectFields'
 import { getArgumentValues } from 'graphql/execution/values'
 import { addPath } from 'graphql/jsutils/Path'
-import { ServerClosure } from '../types'
 
 interface ResolverAndArgs {
   field: ReturnType<typeof getFieldDef>
@@ -17,44 +16,52 @@ interface ResolverAndArgs {
   info: ReturnType<typeof buildResolveInfo>
 }
 
-export const getResolverAndArgs = ({ server, execContext }: { server: ServerClosure, execContext: ExecutionContext }): ResolverAndArgs => {
-  // Taken from graphql-js - https://github.com/graphql/graphql-js/blob/main/src/subscription/subscribe.ts#L189
-  const type = getOperationRootType(server.schema, execContext.operation)
-  const fields = collectFields(
-    execContext,
-    type,
-    execContext.operation.selectionSet,
-    Object.create(null),
-    Object.create(null),
+export const getResolverAndArgs = ({ execContext }: { execContext: ExecutionContext }): ResolverAndArgs => {
+  // Taken from graphql-js executeSubscription - https://github.com/graphql/graphql-js/blob/main/src/execution/subscribe.ts#L187
+  const { schema, fragments, operation, variableValues, contextValue } = execContext
+
+  const rootType = schema.getSubscriptionType()
+  if (rootType == null) {
+    throw new GraphQLError(
+      'Schema is not configured to execute subscription operation.',
+      operation,
+    )
+  }
+
+  const rootFields = collectFields(
+    schema,
+    fragments,
+    variableValues,
+    rootType,
+    operation.selectionSet,
   )
-  const responseNames = Object.keys(fields)
-  const responseName = responseNames[0]
-  const fieldNodes = fields[responseName]
-  const fieldNode = fieldNodes[0]
-  const fieldName = fieldNode.name.value
-  const field = getFieldDef(server.schema, type, fieldName)
-  const path = addPath(undefined, responseName, type.name)
-
-  if (!field) {
-    throw new Error('invalid schema, unknown field definition')
+  const [responseName, fieldNodes] = [...rootFields.entries()][0]
+  const fieldDef = getFieldDef(schema, rootType, fieldNodes[0])
+
+  if (!fieldDef) {
+    const fieldName = fieldNodes[0].name.value
+    throw new GraphQLError(
+      `The subscription field "${fieldName}" is not defined.`,
+      fieldNodes,
+    )
   }
 
+  const path = addPath(undefined, responseName, rootType.name)
   const info = buildResolveInfo(
     execContext,
-    field,
+    fieldDef,
     fieldNodes,
-    type,
+    rootType,
     path,
   )
 
-  const args = getArgumentValues(field, fieldNode, execContext.variableValues)
-  const context = execContext.contextValue
+  const args = getArgumentValues(fieldDef, fieldNodes[0], variableValues)
 
   return {
-    field,
+    field: fieldDef,
     root: null,
     args,
-    context,
+    context: contextValue,
     info,
   }
 }

package-lock.json

@@ -39,7 +39,7 @@
   },
   "peerDependencies": {
     "aws-sdk": ">= 2.844.0",
-    "graphql": ">= 14.0.0 < 16"
+    "graphql": ">= 16.0.0"
   },
   "devDependencies": {
     "@architect/functions": "^4.0.0",
@@ -64,7 +64,7 @@
     "esbuild-register": "^3.0.0",
     "eslint": "^7.29.0",
     "eslint-plugin-mocha-no-only": "^1.1.1",
-    "graphql": "^15.0.0",
+    "graphql": "^16.0.1",
     "graphql-ws": "^5.3.0",
     "inside-out-async": "^1.0.0",
     "mocha": "^9.1.2",