@graphql-hive/gateway-runtime 2.7.9 → 2.8.0-alpha-bb7cb0747a2f268a4a03e2f7f7f2ccd1364ded49

package/CHANGELOG.md

@@ -1,5 +1,30 @@
 # @graphql-hive/gateway-runtime
 
+## 2.8.0-alpha-bb7cb0747a2f268a4a03e2f7f7f2ccd1364ded49
+### Minor Changes
+
+
+
+- [#2133](https://github.com/graphql-hive/gateway/pull/2133) [`18ca078`](https://github.com/graphql-hive/gateway/commit/18ca078a3b34afd9420e37f758713b597fa05352) Thanks [@copilot-swe-agent](https://github.com/apps/copilot-swe-agent)! - Allow `maxCost` in `DemandControlPluginOptions` to accept a function for dynamic cost limiting.
+  
+  Previously, `maxCost` only accepted a static `number`. It now also accepts a synchronous or
+  asynchronous function `(payload: DemandControlMaxCostPayload) => MaybePromise<number>`, where
+  `payload` contains:
+  
+  - `operationCost` – the estimated cost of the current subgraph operation
+  - `totalCost` – the accumulated cost for the whole request context so far
+  - `subgraphName` – the name of the subgraph being executed
+  - `executionRequest` – the full execution request object
+  
+  This lets you implement per-user rate limits, per-subgraph budgets, or any other context-aware
+  cost policy. The `DemandControlMaxCostPayload` interface is exported from the package for use
+  when typing your `maxCost` function.
+
+### Patch Changes
+
+- Updated dependencies []:
+  - @graphql-mesh/hmac-upstream-signature@2.0.10
+
 ## 2.7.9
 ### Patch Changes
 

package/dist/index.cjs

@@ -1226,9 +1226,11 @@ function useDemandControl({
     fieldCost,
     typeCost
   });
+  const maxCostFn = maxCost == null ? null : typeof maxCost === "function" ? maxCost : () => maxCost;
   const costByContextMap = /* @__PURE__ */ new WeakMap();
+  const resolvedMaxCostByContextMap = /* @__PURE__ */ new WeakMap();
   return {
-    onSubgraphExecute({ subgraph, executionRequest, log }) {
+    onSubgraphExecute({ subgraph, subgraphName, executionRequest, log }) {
       if (!subgraph) {
         return;
       }
@@ -1249,16 +1251,34 @@ function useDemandControl({
         },
         "[useDemandControl]"
       );
-      if (maxCost != null && costByContext > maxCost) {
-        throw utils.createGraphQLError(
-          `Operation estimated cost ${costByContext} exceeded configured maximum ${maxCost}`,
-          {
-            extensions: {
-              code: "COST_ESTIMATED_TOO_EXPENSIVE",
-              cost: {
-                estimated: costByContext,
-                max: maxCost
-              }
+      if (maxCostFn != null) {
+        return promiseHelpers.handleMaybePromise(
+          () => maxCostFn({
+            operationCost,
+            totalCost: costByContext,
+            subgraphName,
+            executionRequest
+          }),
+          (resolvedMaxCost) => {
+            if (executionRequest.context) {
+              resolvedMaxCostByContextMap.set(
+                executionRequest.context,
+                resolvedMaxCost
+              );
+            }
+            if (costByContext > resolvedMaxCost) {
+              throw utils.createGraphQLError(
+                `Operation estimated cost ${costByContext} exceeded configured maximum ${resolvedMaxCost}`,
+                {
+                  extensions: {
+                    code: "COST_ESTIMATED_TOO_EXPENSIVE",
+                    cost: {
+                      estimated: costByContext,
+                      max: resolvedMaxCost
+                    }
+                  }
+                }
+              );
             }
           }
         );
@@ -1267,6 +1287,7 @@ function useDemandControl({
     onExecutionResult({ result, setResult, context }) {
       if (includeExtensionMetadata) {
         const costByContext = costByContextMap.get(context) || 0;
+        const resolvedMaxCost = resolvedMaxCostByContextMap.get(context);
         if (utils.isAsyncIterable(result)) {
           setResult(
             utils.mapAsyncIterator(result, (value) => ({
@@ -1275,7 +1296,7 @@ function useDemandControl({
                 ...value.extensions || {},
                 cost: {
                   estimated: costByContext,
-                  max: maxCost
+                  ...resolvedMaxCost != null ? { max: resolvedMaxCost } : {}
                 }
               }
             }))
@@ -1287,7 +1308,7 @@ function useDemandControl({
               ...result?.extensions || {},
               cost: {
                 estimated: costByContext,
-                max: maxCost
+                ...resolvedMaxCost != null ? { max: resolvedMaxCost } : {}
               }
             }
           });

package/dist/index.d.cts

@@ -18,7 +18,7 @@ import { ResponseCacheConfig } from '@graphql-mesh/plugin-response-cache';
 import { MeshFetch, KeyValueCache, MeshFetchRequestInit, Logger as Logger$1 } from '@graphql-mesh/types';
 import { FetchInstrumentation } from '@graphql-mesh/utils';
 import { HTTPExecutorOptions } from '@graphql-tools/executor-http';
-import { ExecutionRequest, MaybeAsyncIterable, ExecutionResult, MaybePromise, ValidationRule, TypeSource, IResolvers, Executor } from '@graphql-tools/utils';
+import { ExecutionRequest, MaybePromise, MaybeAsyncIterable, ExecutionResult, ValidationRule, TypeSource, IResolvers, Executor } from '@graphql-tools/utils';
 import { CSRFPreventionPluginOptions } from '@graphql-yoga/plugin-csrf-prevention';
 import { UsePersistedOperationsOptions } from '@graphql-yoga/plugin-persisted-operations';
 import { GraphQLResolveInfo } from 'graphql/type';
@@ -37,13 +37,34 @@ interface UseContentEncodingOpts {
 
 type AgentFactory<TContext> = (payload: OnFetchHookPayload<Partial<TContext> & GatewayContext & Record<string, any>>) => Agent | Agent$1 | false | undefined;
 
+interface DemandControlMaxCostPayload {
+    /**
+     * The estimated cost of the current subgraph operation.
+     */
+    operationCost: number;
+    /**
+     * The total estimated cost accumulated for the whole request context so far.
+     */
+    totalCost: number;
+    /**
+     * The name of the subgraph being executed.
+     */
+    subgraphName: string;
+    /**
+     * The execution request being processed.
+     */
+    executionRequest: ExecutionRequest<any, any>;
+}
 interface DemandControlPluginOptions {
     /**
-     * 	The maximum cost of an accepted operation. An operation with a higher cost than this is rejected.
-     *  If not provided, no maximum cost is enforced.
-     *  @default Infinity
+     * The maximum cost of an accepted operation. An operation with a higher cost than this is rejected.
+     * Can be a static number or a function (sync or async) that receives cost details and returns the
+     * maximum cost allowed. Use a function to implement dynamic cost limits based on the context,
+     * subgraph, or estimated cost.
+     * If not provided, no maximum cost is enforced.
+     * @default Infinity
      */
-    maxCost?: number;
+    maxCost?: number | ((payload: DemandControlMaxCostPayload) => MaybePromise<number>);
     /**
      * The assumed maximum size of a list for fields that return lists.
      * @default 0
@@ -922,4 +943,4 @@ declare function getProxyExecutor<TContext extends Record<string, any>>({ config
 
 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 };
+export { type DemandControlMaxCostPayload, 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

@@ -18,7 +18,7 @@ import { ResponseCacheConfig } from '@graphql-mesh/plugin-response-cache';
 import { MeshFetch, KeyValueCache, MeshFetchRequestInit, Logger as Logger$1 } from '@graphql-mesh/types';
 import { FetchInstrumentation } from '@graphql-mesh/utils';
 import { HTTPExecutorOptions } from '@graphql-tools/executor-http';
-import { ExecutionRequest, MaybeAsyncIterable, ExecutionResult, MaybePromise, ValidationRule, TypeSource, IResolvers, Executor } from '@graphql-tools/utils';
+import { ExecutionRequest, MaybePromise, MaybeAsyncIterable, ExecutionResult, ValidationRule, TypeSource, IResolvers, Executor } from '@graphql-tools/utils';
 import { CSRFPreventionPluginOptions } from '@graphql-yoga/plugin-csrf-prevention';
 import { UsePersistedOperationsOptions } from '@graphql-yoga/plugin-persisted-operations';
 import { GraphQLResolveInfo } from 'graphql/type';
@@ -37,13 +37,34 @@ interface UseContentEncodingOpts {
 
 type AgentFactory<TContext> = (payload: OnFetchHookPayload<Partial<TContext> & GatewayContext & Record<string, any>>) => Agent | Agent$1 | false | undefined;
 
+interface DemandControlMaxCostPayload {
+    /**
+     * The estimated cost of the current subgraph operation.
+     */
+    operationCost: number;
+    /**
+     * The total estimated cost accumulated for the whole request context so far.
+     */
+    totalCost: number;
+    /**
+     * The name of the subgraph being executed.
+     */
+    subgraphName: string;
+    /**
+     * The execution request being processed.
+     */
+    executionRequest: ExecutionRequest<any, any>;
+}
 interface DemandControlPluginOptions {
     /**
-     * 	The maximum cost of an accepted operation. An operation with a higher cost than this is rejected.
-     *  If not provided, no maximum cost is enforced.
-     *  @default Infinity
+     * The maximum cost of an accepted operation. An operation with a higher cost than this is rejected.
+     * Can be a static number or a function (sync or async) that receives cost details and returns the
+     * maximum cost allowed. Use a function to implement dynamic cost limits based on the context,
+     * subgraph, or estimated cost.
+     * If not provided, no maximum cost is enforced.
+     * @default Infinity
      */
-    maxCost?: number;
+    maxCost?: number | ((payload: DemandControlMaxCostPayload) => MaybePromise<number>);
     /**
      * The assumed maximum size of a list for fields that return lists.
      * @default 0
@@ -922,4 +943,4 @@ declare function getProxyExecutor<TContext extends Record<string, any>>({ config
 
 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 };
+export { type DemandControlMaxCostPayload, 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

@@ -1225,9 +1225,11 @@ function useDemandControl({
     fieldCost,
     typeCost
   });
+  const maxCostFn = maxCost == null ? null : typeof maxCost === "function" ? maxCost : () => maxCost;
   const costByContextMap = /* @__PURE__ */ new WeakMap();
+  const resolvedMaxCostByContextMap = /* @__PURE__ */ new WeakMap();
   return {
-    onSubgraphExecute({ subgraph, executionRequest, log }) {
+    onSubgraphExecute({ subgraph, subgraphName, executionRequest, log }) {
       if (!subgraph) {
         return;
       }
@@ -1248,16 +1250,34 @@ function useDemandControl({
         },
         "[useDemandControl]"
       );
-      if (maxCost != null && costByContext > maxCost) {
-        throw createGraphQLError(
-          `Operation estimated cost ${costByContext} exceeded configured maximum ${maxCost}`,
-          {
-            extensions: {
-              code: "COST_ESTIMATED_TOO_EXPENSIVE",
-              cost: {
-                estimated: costByContext,
-                max: maxCost
-              }
+      if (maxCostFn != null) {
+        return handleMaybePromise(
+          () => maxCostFn({
+            operationCost,
+            totalCost: costByContext,
+            subgraphName,
+            executionRequest
+          }),
+          (resolvedMaxCost) => {
+            if (executionRequest.context) {
+              resolvedMaxCostByContextMap.set(
+                executionRequest.context,
+                resolvedMaxCost
+              );
+            }
+            if (costByContext > resolvedMaxCost) {
+              throw createGraphQLError(
+                `Operation estimated cost ${costByContext} exceeded configured maximum ${resolvedMaxCost}`,
+                {
+                  extensions: {
+                    code: "COST_ESTIMATED_TOO_EXPENSIVE",
+                    cost: {
+                      estimated: costByContext,
+                      max: resolvedMaxCost
+                    }
+                  }
+                }
+              );
             }
           }
         );
@@ -1266,6 +1286,7 @@ function useDemandControl({
     onExecutionResult({ result, setResult, context }) {
       if (includeExtensionMetadata) {
         const costByContext = costByContextMap.get(context) || 0;
+        const resolvedMaxCost = resolvedMaxCostByContextMap.get(context);
         if (isAsyncIterable(result)) {
           setResult(
             mapAsyncIterator(result, (value) => ({
@@ -1274,7 +1295,7 @@ function useDemandControl({
                 ...value.extensions || {},
                 cost: {
                   estimated: costByContext,
-                  max: maxCost
+                  ...resolvedMaxCost != null ? { max: resolvedMaxCost } : {}
                 }
               }
             }))
@@ -1286,7 +1307,7 @@ function useDemandControl({
               ...result?.extensions || {},
               cost: {
                 estimated: costByContext,
-                max: maxCost
+                ...resolvedMaxCost != null ? { max: resolvedMaxCost } : {}
               }
             }
           });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphql-hive/gateway-runtime",
-  "version": "2.7.9",
+  "version": "2.8.0-alpha-bb7cb0747a2f268a4a03e2f7f7f2ccd1364ded49",
   "type": "module",
   "repository": {
     "type": "git",