@graphql-mesh/hmac-upstream-signature 1.2.18 → 1.2.19-alpha-73dbe3a2dabb6b84105c4dac3586696daa3d4fcb

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # @graphql-mesh/hmac-upstream-signature
 
+## 1.2.19-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.18
 
 ### Patch Changes

package/dist/index.cjs

@@ -1,6 +1,6 @@
 'use strict';
 
-var transportCommon = require('@graphql-mesh/transport-common');
+var executorCommon = require('@graphql-tools/executor-common');
 var utils = require('@graphql-tools/utils');
 var jsonStableStringify = require('json-stable-stringify');
 
@@ -10,13 +10,17 @@ var jsonStableStringify__default = /*#__PURE__*/_interopDefault(jsonStableString
 
 const DEFAULT_EXTENSION_NAME = "hmac-signature";
 const DEFAULT_SHOULD_SIGN_FN = () => true;
-const defaultExecutionRequestSerializer = (executionRequest) => jsonStableStringify__default.default({
-  query: transportCommon.defaultPrintFn(executionRequest.document),
-  variables: executionRequest.variables
-});
+const defaultExecutionRequestSerializer = (executionRequest) => jsonStableStringify__default.default(
+  executorCommon.executionRequestToGraphQLParams({
+    executionRequest: {
+      document: executionRequest.document,
+      variables: executionRequest.variables
+    }
+  })
+);
 const defaultParamsSerializer = (params) => jsonStableStringify__default.default({
   query: params.query,
-  variables: params.variables
+  variables: params.variables != null && Object.keys(params.variables).length > 0 ? params.variables : void 0
 });
 function createCryptoKey({
   textEncoder,

package/dist/index.d.cts

@@ -1,11 +1,18 @@
 import { ExecutionRequest, Executor, ExecutionResult, MaybePromise, Maybe } from '@graphql-tools/utils';
 import { Plugin, YogaInitialContext, GraphQLParams } from 'graphql-yoga';
-import { TransportEntry } from '@graphql-mesh/transport-common';
-import { Logger, OnFetchHook, MeshFetch, MeshPubSub, KeyValueCache } from '@graphql-mesh/types';
 import { GraphQLSchema, FragmentDefinitionNode, FieldNode, GraphQLResolveInfo, SelectionSetNode, GraphQLOutputType, GraphQLFieldResolver, OperationTypeNode, GraphQLError, SelectionNode, ExecutionResult as ExecutionResult$1 } from 'graphql';
+import { Logger, OnFetchHook, MeshFetch, MeshPubSub, KeyValueCache } from '@graphql-mesh/types';
 import DataLoader from 'dataloader';
 import { GraphQLResolveInfo as GraphQLResolveInfo$1, GraphQLOutputType as GraphQLOutputType$1 } from 'graphql/type';
 
+interface TransportEntry<Options extends Record<string, any> = Record<string, any>> {
+    kind: string;
+    subgraph: string;
+    location?: string;
+    headers?: [string, string][];
+    options?: Options;
+}
+
 type SchemaTransform<TContext = Record<any, string>> = (originalWrappingSchema: GraphQLSchema, subschemaConfig: SubschemaConfig<any, any, any, TContext>) => GraphQLSchema;
 type RequestTransform<T = Record<string, any>, TContext = Record<any, string>> = (originalRequest: ExecutionRequest, delegationContext: DelegationContext<TContext>, transformationContext: T) => ExecutionRequest;
 type ResultTransform<T = Record<string, any>, TContext = Record<any, string>> = (originalResult: ExecutionResult, delegationContext: DelegationContext<TContext>, transformationContext: T) => ExecutionResult;

package/dist/index.d.ts

@@ -1,11 +1,18 @@
 import { ExecutionRequest, Executor, ExecutionResult, MaybePromise, Maybe } from '@graphql-tools/utils';
 import { Plugin, YogaInitialContext, GraphQLParams } from 'graphql-yoga';
-import { TransportEntry } from '@graphql-mesh/transport-common';
-import { Logger, OnFetchHook, MeshFetch, MeshPubSub, KeyValueCache } from '@graphql-mesh/types';
 import { GraphQLSchema, FragmentDefinitionNode, FieldNode, GraphQLResolveInfo, SelectionSetNode, GraphQLOutputType, GraphQLFieldResolver, OperationTypeNode, GraphQLError, SelectionNode, ExecutionResult as ExecutionResult$1 } from 'graphql';
+import { Logger, OnFetchHook, MeshFetch, MeshPubSub, KeyValueCache } from '@graphql-mesh/types';
 import DataLoader from 'dataloader';
 import { GraphQLResolveInfo as GraphQLResolveInfo$1, GraphQLOutputType as GraphQLOutputType$1 } from 'graphql/type';
 
+interface TransportEntry<Options extends Record<string, any> = Record<string, any>> {
+    kind: string;
+    subgraph: string;
+    location?: string;
+    headers?: [string, string][];
+    options?: Options;
+}
+
 type SchemaTransform<TContext = Record<any, string>> = (originalWrappingSchema: GraphQLSchema, subschemaConfig: SubschemaConfig<any, any, any, TContext>) => GraphQLSchema;
 type RequestTransform<T = Record<string, any>, TContext = Record<any, string>> = (originalRequest: ExecutionRequest, delegationContext: DelegationContext<TContext>, transformationContext: T) => ExecutionRequest;
 type ResultTransform<T = Record<string, any>, TContext = Record<any, string>> = (originalResult: ExecutionResult, delegationContext: DelegationContext<TContext>, transformationContext: T) => ExecutionResult;

package/dist/index.js

@@ -1,16 +1,20 @@
-import { defaultPrintFn } from '@graphql-mesh/transport-common';
+import { executionRequestToGraphQLParams } from '@graphql-tools/executor-common';
 import { mapMaybePromise } from '@graphql-tools/utils';
 import jsonStableStringify from 'json-stable-stringify';
 
 const DEFAULT_EXTENSION_NAME = "hmac-signature";
 const DEFAULT_SHOULD_SIGN_FN = () => true;
-const defaultExecutionRequestSerializer = (executionRequest) => jsonStableStringify({
-  query: defaultPrintFn(executionRequest.document),
-  variables: executionRequest.variables
-});
+const defaultExecutionRequestSerializer = (executionRequest) => jsonStableStringify(
+  executionRequestToGraphQLParams({
+    executionRequest: {
+      document: executionRequest.document,
+      variables: executionRequest.variables
+    }
+  })
+);
 const defaultParamsSerializer = (params) => jsonStableStringify({
   query: params.query,
-  variables: params.variables
+  variables: params.variables != null && Object.keys(params.variables).length > 0 ? params.variables : void 0
 });
 function createCryptoKey({
   textEncoder,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphql-mesh/hmac-upstream-signature",
-  "version": "1.2.18",
+  "version": "1.2.19-alpha-73dbe3a2dabb6b84105c4dac3586696daa3d4fcb",
   "type": "module",
   "repository": {
     "type": "git",
@@ -43,15 +43,15 @@
   },
   "dependencies": {
     "@graphql-mesh/cross-helpers": "^0.4.9",
-    "@graphql-mesh/transport-common": "^0.7.24",
     "@graphql-mesh/types": "^0.103.6",
     "@graphql-mesh/utils": "^0.103.6",
+    "@graphql-tools/executor-common": "^0.0.0",
     "@graphql-tools/utils": "^10.7.0",
     "json-stable-stringify": "^1.1.1",
     "tslib": "^2.8.1"
   },
   "devDependencies": {
-    "@graphql-hive/gateway": "1.7.3",
+    "@graphql-hive/gateway": "1.7.4-alpha-73dbe3a2dabb6b84105c4dac3586696daa3d4fcb",
     "@types/json-stable-stringify": "^1.1.0",
     "graphql": "^16.9.0",
     "graphql-yoga": "^5.10.6",