@graphql-hive/gateway-runtime 2.5.0-rc-ebf83bc98540be878888a5491dcf0bf2b198f980 → 2.5.0-rc-f909d80e1d0b4647d77c7443c18ffbb111c89059

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # @graphql-hive/gateway-runtime
 
-## 2.5.0-rc-ebf83bc98540be878888a5491dcf0bf2b198f980
+## 2.5.0-rc-f909d80e1d0b4647d77c7443c18ffbb111c89059
 ### Minor Changes
 
 
@@ -17,6 +17,12 @@
   - Updated dependency [`@types/node@^25.0.0` ↗︎](https://www.npmjs.com/package/@types/node/v/25.0.0) (from `^24.10.1`, in `dependencies`)
 
 
+- [#1804](https://github.com/graphql-hive/gateway/pull/1804) [`c913e6c`](https://github.com/graphql-hive/gateway/commit/c913e6cfec407d4d2da5b264d38047a9df8e09f0) Thanks [@ardatan](https://github.com/ardatan)! - Fixes for better support of the plugin system in WebSockets;
+  
+  - Ensure  `params: GraphQLParams` and `request: Request` exist in the context
+  - Invoke `onParams` and `onExecutionResult` hooks from plugins properly
+
+
 - [#1787](https://github.com/graphql-hive/gateway/pull/1787) [`a50d93a`](https://github.com/graphql-hive/gateway/commit/a50d93a0bc8f3c67de7449ad9102d3f3b60ea96a) Thanks [@enisdenjo](https://github.com/enisdenjo)! - Usage reporting clientInfo context inherits Hive Gateway context
 
 - Updated dependencies []:

package/dist/index.cjs

@@ -2956,39 +2956,60 @@ const useStaticFiles = ({
   };
 };
 
-function getGraphQLWSOptions(gwRuntime, onContext) {
-  return {
-    execute: (args) => args.rootValue.execute(args),
-    subscribe: (args) => args.rootValue.subscribe(args),
-    onSubscribe: async (ctx, idOrMessage, payloadOrUndefined) => {
-      let payload;
-      if (typeof idOrMessage === "string") {
-        payload = payloadOrUndefined;
-      } else {
-        payload = idOrMessage.payload;
-      }
-      const { schema, execute: execute2, subscribe: subscribe2, contextFactory, parse, validate } = gwRuntime.getEnveloped({
-        connectionParams: ctx.connectionParams,
-        waitUntil: gwRuntime.waitUntil,
-        ...await onContext(ctx)
-      });
-      const args = {
-        schema: schema || await gwRuntime.getSchema(),
-        operationName: payload.operationName,
-        document: parse(payload.query),
-        variableValues: payload.variables,
-        contextValue: await contextFactory(),
-        rootValue: {
-          execute: execute2,
-          subscribe: subscribe2
-        }
-      };
-      if (args.schema) {
-        const errors = validate(args.schema, args.document);
-        if (errors.length) return errors;
+const FAKE_DOCUMENT = {
+  kind: graphql.Kind.DOCUMENT,
+  definitions: [
+    {
+      kind: graphql.Kind.OPERATION_DEFINITION,
+      operation: graphql.OperationTypeNode.SUBSCRIPTION,
+      selectionSet: {
+        kind: graphql.Kind.SELECTION_SET,
+        selections: []
       }
-      return args;
     }
+  ]
+};
+function getGraphQLWSOptions(yoga, onContext) {
+  function onSubscribe(ctx, idOrMessage, paramsOrUndefined) {
+    let params;
+    if (typeof idOrMessage === "string") {
+      if (paramsOrUndefined == null) {
+        throw new Error("Payload is required in graphql-ws v6+");
+      }
+      params = paramsOrUndefined;
+    } else {
+      params = idOrMessage.payload;
+    }
+    return promiseHelpers.handleMaybePromise(
+      () => onContext(ctx),
+      (additionalContext) => ({
+        // Relax this check https://github.com/enisdenjo/graphql-ws/blob/master/src/server.ts#L805
+        // We don't need `schema` here as it is handled by the gateway runtime
+        document: FAKE_DOCUMENT,
+        contextValue: {
+          connectionParams: ctx.connectionParams,
+          waitUntil: yoga.waitUntil,
+          params,
+          ...additionalContext
+        }
+        // So we cast it to ExecutionArgs to satisfy the return type without `schema`
+      })
+    );
+  }
+  function handleRegularArgs(args) {
+    const context = args.contextValue;
+    return yoga.getResultForParams(
+      {
+        params: context.params,
+        request: context.request
+      },
+      context
+    );
+  }
+  return {
+    execute: handleRegularArgs,
+    subscribe: handleRegularArgs,
+    onSubscribe
   };
 }
 

package/dist/index.d.cts

@@ -899,6 +899,6 @@ declare function getProxyExecutor<TContext extends Record<string, any>>({ config
     instrumentation: () => Instrumentation$2 | undefined;
 }): Executor;
 
-declare function getGraphQLWSOptions<TContext extends Record<string, any>, E>(gwRuntime: GatewayRuntime<TContext>, onContext: (ctx: Context<ConnectionInitMessage['payload'], E>) => MaybePromise<Record<string, unknown>>): ServerOptions<ConnectionInitMessage['payload'], E>;
+declare function getGraphQLWSOptions<TContext extends Record<string, any>, E>(yoga: YogaServerInstance<Record<string, any>, TContext>, onContext: (ctx: Context<ConnectionInitMessage['payload'], E>) => MaybePromise<Record<string, unknown>>): ServerOptions<ConnectionInitMessage['payload'], E>;
 
 export { type GatewayConfig, type GatewayConfigBase, type GatewayConfigContext, type GatewayConfigProxy, type GatewayConfigSchemaBase, type GatewayConfigSubgraph, type GatewayConfigSupergraph, type GatewayContext, type GatewayGraphOSManagedFederationOptions, type GatewayGraphOSOptions, type GatewayGraphOSReportingOptions, type GatewayHiveCDNOptions, type GatewayHivePersistedDocumentsOptions, type GatewayHiveReportingOptions, type GatewayPlugin, type GatewayRuntime, type Instrumentation, type OnCacheDeleteHook, type OnCacheDeleteHookEventPayload, type OnCacheDeleteHookResult, type OnCacheErrorHook, type OnCacheErrorHookPayload, type OnCacheGetHook, type OnCacheGetHookEventPayload, type OnCacheGetHookResult, type OnCacheHitHook, type OnCacheHitHookEventPayload, type OnCacheMissHook, type OnCacheSetHook, type OnCacheSetHookEventPayload, type OnCacheSetHookResult, type OnFetchHook, type OnFetchHookDone, type OnFetchHookDonePayload, type OnFetchHookPayload, type ProgressiveOverrideHandler, type PropagateHeadersOpts, type StaticFilesOpts, type UnifiedGraphConfig, createGatewayRuntime, createLoggerFromLogging, getGraphQLWSOptions, getProxyExecutor, getRetryInfo, isRetryExecutionRequest, useCustomFetch, usePropagateHeaders, useStaticFiles, useUpstreamRetry, useUpstreamTimeout };

package/dist/index.d.ts

@@ -899,6 +899,6 @@ declare function getProxyExecutor<TContext extends Record<string, any>>({ config
     instrumentation: () => Instrumentation$2 | undefined;
 }): Executor;
 
-declare function getGraphQLWSOptions<TContext extends Record<string, any>, E>(gwRuntime: GatewayRuntime<TContext>, onContext: (ctx: Context<ConnectionInitMessage['payload'], E>) => MaybePromise<Record<string, unknown>>): ServerOptions<ConnectionInitMessage['payload'], E>;
+declare function getGraphQLWSOptions<TContext extends Record<string, any>, E>(yoga: YogaServerInstance<Record<string, any>, TContext>, onContext: (ctx: Context<ConnectionInitMessage['payload'], E>) => MaybePromise<Record<string, unknown>>): ServerOptions<ConnectionInitMessage['payload'], E>;
 
 export { type GatewayConfig, type GatewayConfigBase, type GatewayConfigContext, type GatewayConfigProxy, type GatewayConfigSchemaBase, type GatewayConfigSubgraph, type GatewayConfigSupergraph, type GatewayContext, type GatewayGraphOSManagedFederationOptions, type GatewayGraphOSOptions, type GatewayGraphOSReportingOptions, type GatewayHiveCDNOptions, type GatewayHivePersistedDocumentsOptions, type GatewayHiveReportingOptions, type GatewayPlugin, type GatewayRuntime, type Instrumentation, type OnCacheDeleteHook, type OnCacheDeleteHookEventPayload, type OnCacheDeleteHookResult, type OnCacheErrorHook, type OnCacheErrorHookPayload, type OnCacheGetHook, type OnCacheGetHookEventPayload, type OnCacheGetHookResult, type OnCacheHitHook, type OnCacheHitHookEventPayload, type OnCacheMissHook, type OnCacheSetHook, type OnCacheSetHookEventPayload, type OnCacheSetHookResult, type OnFetchHook, type OnFetchHookDone, type OnFetchHookDonePayload, type OnFetchHookPayload, type ProgressiveOverrideHandler, type PropagateHeadersOpts, type StaticFilesOpts, type UnifiedGraphConfig, createGatewayRuntime, createLoggerFromLogging, getGraphQLWSOptions, getProxyExecutor, getRetryInfo, isRetryExecutionRequest, useCustomFetch, usePropagateHeaders, useStaticFiles, useUpstreamRetry, useUpstreamTimeout };

package/dist/index.js

@@ -23,7 +23,7 @@ import { AsyncDisposableStack } from '@whatwg-node/disposablestack';
 export * from '@whatwg-node/disposablestack';
 import { handleMaybePromise, iterateAsync } from '@whatwg-node/promise-helpers';
 import { useCookies } from '@whatwg-node/server-plugin-cookies';
-import { print, visit, visitWithTypeInfo, getArgumentValues, getNamedType, isIntrospectionType, isListType, isCompositeType, getOperationAST, isSchema, parse, buildSchema, buildASTSchema } from 'graphql';
+import { print, visit, visitWithTypeInfo, getArgumentValues, getNamedType, isIntrospectionType, isListType, isCompositeType, getOperationAST, isSchema, parse, buildSchema, buildASTSchema, Kind, OperationTypeNode } from 'graphql';
 import { isAsyncIterable as isAsyncIterable$1, useReadinessCheck, useExecutionCancellation, createYoga, chain, mergeSchemas } from 'graphql-yoga';
 import { DEFAULT_UPLINKS, fetchSupergraphSdlFromManagedFederation } from '@graphql-tools/federation';
 import { useApolloUsageReport } from '@graphql-yoga/plugin-apollo-usage-report';
@@ -2955,39 +2955,60 @@ const useStaticFiles = ({
   };
 };
 
-function getGraphQLWSOptions(gwRuntime, onContext) {
-  return {
-    execute: (args) => args.rootValue.execute(args),
-    subscribe: (args) => args.rootValue.subscribe(args),
-    onSubscribe: async (ctx, idOrMessage, payloadOrUndefined) => {
-      let payload;
-      if (typeof idOrMessage === "string") {
-        payload = payloadOrUndefined;
-      } else {
-        payload = idOrMessage.payload;
-      }
-      const { schema, execute: execute2, subscribe: subscribe2, contextFactory, parse, validate } = gwRuntime.getEnveloped({
-        connectionParams: ctx.connectionParams,
-        waitUntil: gwRuntime.waitUntil,
-        ...await onContext(ctx)
-      });
-      const args = {
-        schema: schema || await gwRuntime.getSchema(),
-        operationName: payload.operationName,
-        document: parse(payload.query),
-        variableValues: payload.variables,
-        contextValue: await contextFactory(),
-        rootValue: {
-          execute: execute2,
-          subscribe: subscribe2
-        }
-      };
-      if (args.schema) {
-        const errors = validate(args.schema, args.document);
-        if (errors.length) return errors;
+const FAKE_DOCUMENT = {
+  kind: Kind.DOCUMENT,
+  definitions: [
+    {
+      kind: Kind.OPERATION_DEFINITION,
+      operation: OperationTypeNode.SUBSCRIPTION,
+      selectionSet: {
+        kind: Kind.SELECTION_SET,
+        selections: []
       }
-      return args;
     }
+  ]
+};
+function getGraphQLWSOptions(yoga, onContext) {
+  function onSubscribe(ctx, idOrMessage, paramsOrUndefined) {
+    let params;
+    if (typeof idOrMessage === "string") {
+      if (paramsOrUndefined == null) {
+        throw new Error("Payload is required in graphql-ws v6+");
+      }
+      params = paramsOrUndefined;
+    } else {
+      params = idOrMessage.payload;
+    }
+    return handleMaybePromise(
+      () => onContext(ctx),
+      (additionalContext) => ({
+        // Relax this check https://github.com/enisdenjo/graphql-ws/blob/master/src/server.ts#L805
+        // We don't need `schema` here as it is handled by the gateway runtime
+        document: FAKE_DOCUMENT,
+        contextValue: {
+          connectionParams: ctx.connectionParams,
+          waitUntil: yoga.waitUntil,
+          params,
+          ...additionalContext
+        }
+        // So we cast it to ExecutionArgs to satisfy the return type without `schema`
+      })
+    );
+  }
+  function handleRegularArgs(args) {
+    const context = args.contextValue;
+    return yoga.getResultForParams(
+      {
+        params: context.params,
+        request: context.request
+      },
+      context
+    );
+  }
+  return {
+    execute: handleRegularArgs,
+    subscribe: handleRegularArgs,
+    onSubscribe
   };
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphql-hive/gateway-runtime",
-  "version": "2.5.0-rc-ebf83bc98540be878888a5491dcf0bf2b198f980",
+  "version": "2.5.0-rc-f909d80e1d0b4647d77c7443c18ffbb111c89059",
   "type": "module",
   "repository": {
     "type": "git",