Configure some batch delegation options (#1403)

Author: enisdenjo

.changeset/angry-plants-hide.md

@@ -0,0 +1,7 @@
+---
+'@graphql-hive/gateway-runtime': patch
+---
+
+Rename `__experimental__batchDelegation` to `__experimental__batchExecution`
+
+Because it enables/disabled batch execution, and not delegation.

.changeset/shaggy-trains-camp.md

@@ -0,0 +1,8 @@
+---
+'@graphql-mesh/fusion-runtime': minor
+'@graphql-hive/gateway-runtime': minor
+---
+
+Allow configuring some of the batch delegation options
+
+Like the `maxBatchSize` which is used to limit the number of items requested in a single delegated batch.

internal/perf/package.json

@@ -8,7 +8,6 @@
     "canvas": "^3.1.2",
     "chart.js": "^4.4.7",
     "chartjs-plugin-trendline": "^2.1.9",
-    "memlab": "^1.1.59",
     "parse-duration": "^2.0.0",
     "speedscope": "./speedscope-1.23.0-alpha.4.tgz",
     "ws": "^8.18.3"

packages/fusion-runtime/src/federation/supergraph.ts

@@ -156,6 +156,7 @@ export const handleFederationSupergraph: UnifiedGraphHandler = function ({
   onDelegationPlanHooks,
   onDelegationStageExecuteHooks,
   onDelegateHooks,
+  batchDelegateOptions,
   additionalTypeDefs: additionalTypeDefsFromConfig = [],
   additionalResolvers: additionalResolversFromConfig = [],
   logger,
@@ -187,6 +188,7 @@ export const handleFederationSupergraph: UnifiedGraphHandler = function ({
 
   let executableUnifiedGraph = getStitchedSchemaFromSupergraphSdl({
     supergraphSdl: getDocumentNodeFromSchema(unifiedGraph),
+    batchDelegateOptions,
     /**
      * This visits over the subgraph schema to get;
      * - Extra Type Defs and Resolvers (additionalTypeDefs & additionalResolvers)

packages/fusion-runtime/src/unifiedGraphManager.ts

@@ -55,6 +55,16 @@ export function ensureSchema(source: GraphQLSchema | DocumentNode | string) {
   }
   return source;
 }
+/**
+ * Configure the batch delegation options for all merged types in all subschemas.
+ */
+export interface BatchDelegateOptions {
+  /**
+   * Limits the number of items that get requested when performing batch delegation.
+   * @default Infinity
+   */
+  maxBatchSize?: number;
+}
 
 export type UnifiedGraphHandler = (
   opts: UnifiedGraphHandlerOpts,
@@ -68,6 +78,10 @@ export interface UnifiedGraphHandlerOpts {
   onDelegationPlanHooks?: OnDelegationPlanHook<any>[];
   onDelegationStageExecuteHooks?: OnDelegationStageExecuteHook<any>[];
   onDelegateHooks?: OnDelegateHook<unknown>[];
+  /**
+   * Configure the batch delegation options for all merged types in all subschemas.
+   */
+  batchDelegateOptions?: BatchDelegateOptions;
 
   logger?: Logger;
 }
@@ -104,6 +118,11 @@ export interface UnifiedGraphManagerOptions<TContext> {
    * @default true
    */
   batch?: boolean;
+  /**
+   * Configure the batch delegation options for all merged types in all subschemas.
+   */
+  batchDelegateOptions?: BatchDelegateOptions;
+
   instrumentation?: () => Instrumentation | undefined;
 
   onUnifiedGraphChange?(newUnifiedGraph: GraphQLSchema): void;
@@ -309,6 +328,7 @@ export class UnifiedGraphManager<TContext> implements AsyncDisposable {
         onDelegationPlanHooks: this.onDelegationPlanHooks,
         onDelegationStageExecuteHooks: this.onDelegationStageExecuteHooks,
         onDelegateHooks: this.opts.onDelegateHooks,
+        batchDelegateOptions: this.opts.batchDelegateOptions,
         logger: this.opts.transportContext?.logger,
       });
       const transportExecutorStack = new AsyncDisposableStack();

packages/runtime/src/createGatewayRuntime.ts

@@ -728,7 +728,8 @@ export function createGatewayRuntime<
       additionalTypeDefs: config.additionalTypeDefs,
       additionalResolvers: config.additionalResolvers as IResolvers[],
       instrumentation: () => instrumentation,
-      batch: config.__experimental__batchDelegation,
+      batch: config.__experimental__batchExecution,
+      batchDelegateOptions: config.__experimental__batchDelegateOptions,
     });
     getSchema = () => unifiedGraphManager.getUnifiedGraph();
     readinessChecker = () => {

packages/runtime/src/types.ts

@@ -2,6 +2,7 @@ import type { Plugin as EnvelopPlugin } from '@envelop/core';
 import type { useGenericAuth } from '@envelop/generic-auth';
 import { HivePubSub } from '@graphql-hive/pubsub';
 import type {
+  BatchDelegateOptions,
   Instrumentation as GatewayRuntimeInstrumentation,
   TransportEntryAdditions,
   Transports,
@@ -674,7 +675,16 @@ interface GatewayConfigBase<TContext extends Record<string, any>> {
    *
    * @experimental
    */
-  __experimental__batchDelegation?: boolean;
+  __experimental__batchExecution?: boolean;
+
+  /**
+   * Configure the delegation batching options for all types on all subgraphs
+   *
+   * Do not use it unless you know what you are doing!
+   *
+   * @experimental
+   */
+  __experimental__batchDelegateOptions?: BatchDelegateOptions;
 
   /**
    * Subgraph error handling

packages/runtime/tests/sync.test.ts

@@ -51,7 +51,7 @@ it.skipIf(globalThis.Bun)(
           upstreamYoga.fetch,
         ),
       ],
-      __experimental__batchDelegation: false,
+      __experimental__batchExecution: false,
     });
     const res = gw.fetch('http://localhost:4000/graphql', {
       method: 'POST',