@graphql-tools/executor-common 0.0.0 → 0.0.1-alpha-3df7faeea69a8bf7e4423f5661c1cb8974232f19

package/CHANGELOG.md

@@ -0,0 +1,11 @@
+# @graphql-tools/executor-common
+
+## 0.0.1-alpha-3df7faeea69a8bf7e4423f5661c1cb8974232f19
+
+### 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.

package/dist/index.cjs

@@ -7,7 +7,7 @@ var graphql = require('graphql');
 const defaultPrintFn = utils.memoize1(function defaultPrintFn2(document) {
   return graphql.stripIgnoredCharacters(core.getDocumentString(document, graphql.print));
 });
-function executionRequestToGraphQLParams({
+function serializeExecutionRequest({
   executionRequest,
   excludeQuery,
   printFn = defaultPrintFn
@@ -21,4 +21,4 @@ function executionRequestToGraphQLParams({
 }
 
 exports.defaultPrintFn = defaultPrintFn;
-exports.executionRequestToGraphQLParams = executionRequestToGraphQLParams;
+exports.serializeExecutionRequest = serializeExecutionRequest;

package/dist/index.d.cts

@@ -7,20 +7,20 @@ interface ExecutionRequestToGraphQLParams {
     excludeQuery?: boolean;
     printFn?: typeof defaultPrintFn;
 }
-interface GraphQLParams {
+interface SerializedExecutionRequest {
     query?: string | undefined;
     variables?: Record<string, any>;
     operationName?: string;
     extensions?: Record<string, any>;
 }
-declare function executionRequestToGraphQLParams(opts: Omit<ExecutionRequestToGraphQLParams, 'excludeQuery'> & {
+declare function serializeExecutionRequest(opts: Omit<ExecutionRequestToGraphQLParams, 'excludeQuery'> & {
     excludeQuery: true;
-}): Omit<GraphQLParams, 'query'>;
-declare function executionRequestToGraphQLParams(opts: Omit<ExecutionRequestToGraphQLParams, 'excludeQuery'> & {
+}): Omit<SerializedExecutionRequest, 'query'>;
+declare function serializeExecutionRequest(opts: Omit<ExecutionRequestToGraphQLParams, 'excludeQuery'> & {
     excludeQuery?: false;
-}): Omit<GraphQLParams, 'query'> & {
+}): Omit<SerializedExecutionRequest, 'query'> & {
     query: string;
 };
-declare function executionRequestToGraphQLParams(opts: ExecutionRequestToGraphQLParams): GraphQLParams;
+declare function serializeExecutionRequest(opts: ExecutionRequestToGraphQLParams): SerializedExecutionRequest;
 
-export { type GraphQLParams, defaultPrintFn, executionRequestToGraphQLParams };
+export { type SerializedExecutionRequest, defaultPrintFn, serializeExecutionRequest };

package/dist/index.d.ts

@@ -7,20 +7,20 @@ interface ExecutionRequestToGraphQLParams {
     excludeQuery?: boolean;
     printFn?: typeof defaultPrintFn;
 }
-interface GraphQLParams {
+interface SerializedExecutionRequest {
     query?: string | undefined;
     variables?: Record<string, any>;
     operationName?: string;
     extensions?: Record<string, any>;
 }
-declare function executionRequestToGraphQLParams(opts: Omit<ExecutionRequestToGraphQLParams, 'excludeQuery'> & {
+declare function serializeExecutionRequest(opts: Omit<ExecutionRequestToGraphQLParams, 'excludeQuery'> & {
     excludeQuery: true;
-}): Omit<GraphQLParams, 'query'>;
-declare function executionRequestToGraphQLParams(opts: Omit<ExecutionRequestToGraphQLParams, 'excludeQuery'> & {
+}): Omit<SerializedExecutionRequest, 'query'>;
+declare function serializeExecutionRequest(opts: Omit<ExecutionRequestToGraphQLParams, 'excludeQuery'> & {
     excludeQuery?: false;
-}): Omit<GraphQLParams, 'query'> & {
+}): Omit<SerializedExecutionRequest, 'query'> & {
     query: string;
 };
-declare function executionRequestToGraphQLParams(opts: ExecutionRequestToGraphQLParams): GraphQLParams;
+declare function serializeExecutionRequest(opts: ExecutionRequestToGraphQLParams): SerializedExecutionRequest;
 
-export { type GraphQLParams, defaultPrintFn, executionRequestToGraphQLParams };
+export { type SerializedExecutionRequest, defaultPrintFn, serializeExecutionRequest };

package/dist/index.js

@@ -5,7 +5,7 @@ import { stripIgnoredCharacters, print } from 'graphql';
 const defaultPrintFn = memoize1(function defaultPrintFn2(document) {
   return stripIgnoredCharacters(getDocumentString(document, print));
 });
-function executionRequestToGraphQLParams({
+function serializeExecutionRequest({
   executionRequest,
   excludeQuery,
   printFn = defaultPrintFn
@@ -18,4 +18,4 @@ function executionRequestToGraphQLParams({
   };
 }
 
-export { defaultPrintFn, executionRequestToGraphQLParams };
+export { defaultPrintFn, serializeExecutionRequest };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphql-tools/executor-common",
-  "version": "0.0.0",
+  "version": "0.0.1-alpha-3df7faeea69a8bf7e4423f5661c1cb8974232f19",
   "type": "module",
   "description": "A set of utils for faster development of GraphQL tools",
   "repository": {