@graphql-tools/executor-http 1.2.2 → 1.2.3-alpha-73dbe3a2dabb6b84105c4dac3586696daa3d4fcb

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # @graphql-tools/executor-http
 
+## 1.2.3-alpha-73dbe3a2dabb6b84105c4dac3586696daa3d4fcb
+
+### Patch Changes
+
+- [#381](https://github.com/graphql-hive/gateway/pull/381) [`73dbe3a`](https://github.com/graphql-hive/gateway/commit/73dbe3a2dabb6b84105c4dac3586696daa3d4fcb) Thanks [@ardatan](https://github.com/ardatan)! - Like HMAC Upstream Signature plugin, different components of the gateway were using different ways of serializing the execution request.
+  Some of them were ignoring `variables` if it is empty, some of not, this was causing the signature generation to be different for the same query.
+  For example, it was working as expected in Proxy mode, but not working as expected in Federation Gateway mode.
+
+  With this change, now we have a shared helper to serialize the upstream execution request with a memoized `print` function for query AST etc to have a consistent serialization so consistent signature generation for HMAC.
+
 ## 1.2.2
 
 ### Patch Changes

package/dist/index.cjs

@@ -1,13 +1,14 @@
 'use strict';
 
 var gatewayAbortSignalAny = require('@graphql-hive/gateway-abort-signal-any');
+var executorCommon = require('@graphql-tools/executor-common');
 var utils = require('@graphql-tools/utils');
 var disposablestack = require('@whatwg-node/disposablestack');
 var fetch = require('@whatwg-node/fetch');
 var valueOrPromise = require('value-or-promise');
 var extractFiles = require('extract-files');
-var graphql = require('graphql');
 var repeater = require('@repeaterjs/repeater');
+var graphql = require('graphql');
 var browser = require('meros/browser');
 var node = require('meros/node');
 
@@ -121,10 +122,6 @@ function isBlob(obj) {
   return typeof obj.arrayBuffer === "function";
 }
 
-const defaultPrintFn = utils.memoize1(function defaultPrintFn2(document) {
-  return graphql.stripIgnoredCharacters(graphql.print(document));
-});
-
 function createAbortErrorReason() {
   return new Error("Executor was disposed.");
 }
@@ -302,7 +299,7 @@ function createSignalWrapper(signal) {
   });
 }
 function buildHTTPExecutor(options) {
-  const printFn = options?.print ?? defaultPrintFn;
+  const printFn = options?.print ?? executorCommon.defaultPrintFn;
   const disposeCtrl = new AbortController();
   const sharedSignal = createSignalWrapper(disposeCtrl.signal);
   const baseExecutor = (request, excludeQuery) => {
@@ -355,12 +352,11 @@ function buildHTTPExecutor(options) {
     };
     const query = printFn(request.document);
     let serializeFn = function serialize() {
-      return {
-        query: excludeQuery ? void 0 : printFn(request.document),
-        variables: (request.variables && Object.keys(request.variables).length) > 0 ? request.variables : void 0,
-        operationName: request.operationName ? request.operationName : void 0,
-        extensions: request.extensions && Object.keys(request.extensions).length > 0 ? request.extensions : void 0
-      };
+      return executorCommon.executionRequestToGraphQLParams({
+        executionRequest: request,
+        excludeQuery,
+        printFn
+      });
     };
     if (options?.apq) {
       serializeFn = function serializeWithAPQ() {
@@ -370,12 +366,14 @@ function buildHTTPExecutor(options) {
             version: 1,
             sha256Hash
           };
-          return {
-            query: excludeQuery ? void 0 : query,
-            variables: (request.variables && Object.keys(request.variables).length) > 0 ? request.variables : void 0,
-            operationName: request.operationName ? request.operationName : void 0,
-            extensions
-          };
+          return executorCommon.executionRequestToGraphQLParams({
+            executionRequest: {
+              ...request,
+              extensions
+            },
+            excludeQuery,
+            printFn
+          });
         });
       };
     }

package/dist/index.d.cts

@@ -80,12 +80,6 @@ interface HTTPExecutorOptions {
      */
     disposable?: boolean;
 }
-type SerializedRequest = {
-    query?: string;
-    variables?: Record<string, any>;
-    operationName?: string;
-    extensions?: any;
-};
 type HeadersConfig = Record<string, string>;
 declare function buildHTTPExecutor(options?: Omit<HTTPExecutorOptions, 'fetch'> & {
     fetch: SyncFetchFn;
@@ -98,4 +92,4 @@ declare function buildHTTPExecutor(options?: Omit<HTTPExecutorOptions, 'fetch'>
 }): DisposableAsyncExecutor<any, HTTPExecutorOptions>;
 declare function buildHTTPExecutor(options?: Omit<HTTPExecutorOptions, 'fetch'>): DisposableAsyncExecutor<any, HTTPExecutorOptions>;
 
-export { type AsyncFetchFn, type AsyncImportFn, type FetchFn, type HTTPExecutorOptions, type HeadersConfig, type RegularFetchFn, type SerializedRequest, type SyncFetchFn, type SyncImportFn, type SyncResponse, buildHTTPExecutor, isLiveQueryOperationDefinitionNode };
+export { type AsyncFetchFn, type AsyncImportFn, type FetchFn, type HTTPExecutorOptions, type HeadersConfig, type RegularFetchFn, type SyncFetchFn, type SyncImportFn, type SyncResponse, buildHTTPExecutor, isLiveQueryOperationDefinitionNode };

package/dist/index.d.ts

@@ -80,12 +80,6 @@ interface HTTPExecutorOptions {
      */
     disposable?: boolean;
 }
-type SerializedRequest = {
-    query?: string;
-    variables?: Record<string, any>;
-    operationName?: string;
-    extensions?: any;
-};
 type HeadersConfig = Record<string, string>;
 declare function buildHTTPExecutor(options?: Omit<HTTPExecutorOptions, 'fetch'> & {
     fetch: SyncFetchFn;
@@ -98,4 +92,4 @@ declare function buildHTTPExecutor(options?: Omit<HTTPExecutorOptions, 'fetch'>
 }): DisposableAsyncExecutor<any, HTTPExecutorOptions>;
 declare function buildHTTPExecutor(options?: Omit<HTTPExecutorOptions, 'fetch'>): DisposableAsyncExecutor<any, HTTPExecutorOptions>;
 
-export { type AsyncFetchFn, type AsyncImportFn, type FetchFn, type HTTPExecutorOptions, type HeadersConfig, type RegularFetchFn, type SerializedRequest, type SyncFetchFn, type SyncImportFn, type SyncResponse, buildHTTPExecutor, isLiveQueryOperationDefinitionNode };
+export { type AsyncFetchFn, type AsyncImportFn, type FetchFn, type HTTPExecutorOptions, type HeadersConfig, type RegularFetchFn, type SyncFetchFn, type SyncImportFn, type SyncResponse, buildHTTPExecutor, isLiveQueryOperationDefinitionNode };

package/dist/index.js

@@ -1,11 +1,12 @@
 import { abortSignalAny } from '@graphql-hive/gateway-abort-signal-any';
-import { isAsyncIterable, isPromise, mapMaybePromise, memoize1, createGraphQLError, inspect, mapAsyncIterator, mergeIncrementalResult, getOperationASTFromRequest } from '@graphql-tools/utils';
+import { defaultPrintFn, executionRequestToGraphQLParams } from '@graphql-tools/executor-common';
+import { isAsyncIterable, isPromise, mapMaybePromise, createGraphQLError, inspect, mapAsyncIterator, mergeIncrementalResult, memoize1, getOperationASTFromRequest } from '@graphql-tools/utils';
 import { DisposableSymbols } from '@whatwg-node/disposablestack';
 import { File, FormData, TextEncoder, crypto, TextDecoder, fetch } from '@whatwg-node/fetch';
 import { ValueOrPromise } from 'value-or-promise';
 import { extractFiles, isExtractableFile } from 'extract-files';
-import { stripIgnoredCharacters, print, GraphQLError } from 'graphql';
 import { Repeater } from '@repeaterjs/repeater';
+import { GraphQLError } from 'graphql';
 import { meros as meros$1 } from 'meros/browser';
 import { meros } from 'meros/node';
 
@@ -119,10 +120,6 @@ function isBlob(obj) {
   return typeof obj.arrayBuffer === "function";
 }
 
-const defaultPrintFn = memoize1(function defaultPrintFn2(document) {
-  return stripIgnoredCharacters(print(document));
-});
-
 function createAbortErrorReason() {
   return new Error("Executor was disposed.");
 }
@@ -353,12 +350,11 @@ function buildHTTPExecutor(options) {
     };
     const query = printFn(request.document);
     let serializeFn = function serialize() {
-      return {
-        query: excludeQuery ? void 0 : printFn(request.document),
-        variables: (request.variables && Object.keys(request.variables).length) > 0 ? request.variables : void 0,
-        operationName: request.operationName ? request.operationName : void 0,
-        extensions: request.extensions && Object.keys(request.extensions).length > 0 ? request.extensions : void 0
-      };
+      return executionRequestToGraphQLParams({
+        executionRequest: request,
+        excludeQuery,
+        printFn
+      });
     };
     if (options?.apq) {
       serializeFn = function serializeWithAPQ() {
@@ -368,12 +364,14 @@ function buildHTTPExecutor(options) {
             version: 1,
             sha256Hash
           };
-          return {
-            query: excludeQuery ? void 0 : query,
-            variables: (request.variables && Object.keys(request.variables).length) > 0 ? request.variables : void 0,
-            operationName: request.operationName ? request.operationName : void 0,
-            extensions
-          };
+          return executionRequestToGraphQLParams({
+            executionRequest: {
+              ...request,
+              extensions
+            },
+            excludeQuery,
+            printFn
+          });
         });
       };
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphql-tools/executor-http",
-  "version": "1.2.2",
+  "version": "1.2.3-alpha-73dbe3a2dabb6b84105c4dac3586696daa3d4fcb",
   "type": "module",
   "description": "A set of utils for faster development of GraphQL tools",
   "repository": {
@@ -40,6 +40,7 @@
   },
   "dependencies": {
     "@graphql-hive/gateway-abort-signal-any": "^0.0.2",
+    "@graphql-tools/executor-common": "^0.0.0",
     "@graphql-tools/utils": "^10.7.0",
     "@repeaterjs/repeater": "^3.0.4",
     "@whatwg-node/disposablestack": "^0.0.5",