feat: APQ between subgraph and gateway

.changeset/wise-seahorses-rhyme.md

@@ -0,0 +1,27 @@
+---
+'@graphql-tools/executor-http': minor
+'@graphql-mesh/transport-http': patch
+---
+
+Automatic Persisted Queries support for upstream requests
+
+For HTTP Executor;
+```ts
+buildHTTPExecutor({
+    // ...
+    apq: true,
+})
+```
+
+For Gateway Configuration;
+```ts
+export const gatewayConfig = defineConfig({
+    transportEntries: {
+        '*': {
+            options: {
+                apq: true
+            }
+        }
+    },
+})
+```

e2e/apq-subgraphs/apq-subgraphs.e2e.ts

@@ -0,0 +1,86 @@
+import { createTenv } from '@internal/e2e';
+import { stripIgnoredCharacters } from 'graphql';
+import { describe, expect, it } from 'vitest';
+import { hashSHA256 } from '../../packages/executors/http/src/utils';
+
+const { service, gateway } = createTenv(__dirname);
+
+describe('APQ to the upstream', () => {
+  it('works', async () => {
+    await using gw = await gateway({
+      supergraph: {
+        with: 'mesh',
+        services: [await service('greetings')],
+      },
+    });
+    const query = stripIgnoredCharacters(/* GraphQL */ `
+      {
+        __typename
+        hello
+      }
+    `);
+    const sha256Hash = await hashSHA256(query);
+    await expect(gw.execute({ query })).resolves.toEqual({
+      data: {
+        __typename: 'Query',
+        hello: 'world',
+      },
+    });
+    // First it sends the request with query
+    expect(gw.getStd('both')).toContain(
+      `fetch 1 ${JSON.stringify({
+        extensions: {
+          persistedQuery: {
+            version: 1,
+            sha256Hash,
+          },
+        },
+      })}`,
+    );
+    // Then it sends the query with the hash
+    // In the following requests the query won't be needed
+    expect(gw.getStd('both')).toContain(
+      `fetch 2 ${JSON.stringify({
+        query,
+        extensions: {
+          persistedQuery: {
+            version: 1,
+            sha256Hash,
+          },
+        },
+      })}`,
+    );
+
+    await expect(gw.execute({ query })).resolves.toEqual({
+      data: {
+        __typename: 'Query',
+        hello: 'world',
+      },
+    });
+
+    // The query is not sent again
+    expect(gw.getStd('both')).toContain(
+      `fetch 3 ${JSON.stringify({
+        extensions: {
+          persistedQuery: {
+            version: 1,
+            sha256Hash,
+          },
+        },
+      })}`,
+    );
+
+    // The query is not sent again
+    expect(gw.getStd('both')).not.toContain(
+      `fetch 4 ${JSON.stringify({
+        query,
+        extensions: {
+          persistedQuery: {
+            version: 1,
+            sha256Hash,
+          },
+        },
+      })}`,
+    );
+  });
+});

e2e/apq-subgraphs/gateway.config.ts

@@ -0,0 +1,20 @@
+import { defineConfig } from '@graphql-hive/gateway';
+
+let fetchCnt = 0;
+export const gatewayConfig = defineConfig({
+  transportEntries: {
+    greetings: {
+      options: {
+        apq: true,
+      },
+    },
+  },
+  plugins: () => [
+    {
+      onFetch({ options }) {
+        fetchCnt++;
+        process.stdout.write(`fetch ${fetchCnt} ${options.body}\n`);
+      },
+    },
+  ],
+});

e2e/apq-subgraphs/mesh.config.ts

@@ -0,0 +1,17 @@
+import {
+  defineConfig,
+  loadGraphQLHTTPSubgraph,
+} from '@graphql-mesh/compose-cli';
+import { Opts } from '@internal/testing';
+
+const opts = Opts(process.argv);
+
+export const composeConfig = defineConfig({
+  subgraphs: [
+    {
+      sourceHandler: loadGraphQLHTTPSubgraph('greetings', {
+        endpoint: `http://localhost:${opts.getServicePort('greetings')}/graphql`,
+      }),
+    },
+  ],
+});

e2e/apq-subgraphs/package.json

@@ -0,0 +1,10 @@
+{
+  "name": "@e2e/apq-subgraphs",
+  "private": true,
+  "devDependencies": {
+    "@apollo/server": "^4.11.2",
+    "@graphql-mesh/compose-cli": "^1.2.13",
+    "graphql": "^16.9.0",
+    "tslib": "^2.8.1"
+  }
+}

e2e/apq-subgraphs/services/greetings.ts

@@ -0,0 +1,25 @@
+import { ApolloServer } from '@apollo/server';
+import { startStandaloneServer } from '@apollo/server/standalone';
+import { Opts } from '@internal/testing';
+
+const opts = Opts(process.argv);
+
+const apolloServer = new ApolloServer({
+  typeDefs: /* GraphQL */ `
+    type Query {
+      hello: String
+    }
+  `,
+  resolvers: {
+    Query: {
+      hello: () => 'world',
+    },
+  },
+});
+
+startStandaloneServer(apolloServer, {
+  listen: { port: opts.getServicePort('greetings') },
+}).catch((e) => {
+  console.error(e);
+  process.exit(1);
+});

internal/e2e/src/tenv.ts

@@ -401,7 +401,9 @@ export function createTenv(cwd: string): Tenv {
           subgraph = await handleDockerHostName(subgraph, volumes);
         }
 
-        for (const configfile of await glob('gateway.config.*', { cwd })) {
+        for (const configfile of await glob('gateway.config.*', {
+          cwd,
+        })) {
           volumes.push({
             host: configfile,
             container: `/gateway/${path.basename(configfile)}`,

packages/executors/http/package.json

@@ -49,6 +49,7 @@
     "value-or-promise": "^1.0.12"
   },
   "devDependencies": {
+    "@apollo/server": "^4.11.2",
     "@types/extract-files": "8.1.3",
     "@whatwg-node/disposablestack": "^0.0.5",
     "graphql": "^16.9.0",

packages/executors/http/src/createFormDataFromVariables.ts

@@ -9,6 +9,7 @@ import {
   FormData as DefaultFormData,
 } from '@whatwg-node/fetch';
 import { extractFiles, isExtractableFile } from 'extract-files';
+import { SerializedRequest } from './index.js';
 import { isGraphQLUpload } from './isGraphQLUpload.js';
 
 function collectAsyncIterableValues<T>(
@@ -30,18 +31,8 @@ function collectAsyncIterableValues<T>(
   return iterate();
 }
 
-export function createFormDataFromVariables<TVariables>(
-  {
-    query,
-    variables,
-    operationName,
-    extensions,
-  }: {
-    query: string;
-    variables: TVariables;
-    operationName?: string;
-    extensions?: any;
-  },
+export function createFormDataFromVariables(
+  body: SerializedRequest,
   {
     File: FileCtor = DefaultFile,
     FormData: FormDataCtor = DefaultFormData,
@@ -50,7 +41,10 @@ export function createFormDataFromVariables<TVariables>(
     FormData?: typeof DefaultFormData;
   },
 ) {
-  const vars = Object.assign({}, variables);
+  if (!body.variables) {
+    return JSON.stringify(body);
+  }
+  const vars = Object.assign({}, body.variables);
   const { clone, files } = extractFiles(
     vars,
     'variables',
@@ -62,16 +56,7 @@ export function createFormDataFromVariables<TVariables>(
       typeof v?.arrayBuffer === 'function') as any,
   );
   if (files.size === 0) {
-    return JSON.stringify(
-      {
-        query,
-        variables,
-        operationName,
-        extensions,
-      },
-      null,
-      2,
-    );
+    return JSON.stringify(body);
   }
   const map: Record<number, string[]> = {};
   const uploads: any[] = [];
@@ -85,10 +70,8 @@ export function createFormDataFromVariables<TVariables>(
   form.append(
     'operations',
     JSON.stringify({
-      query,
+      ...body,
       variables: clone,
-      operationName,
-      extensions,
     }),
   );
   form.append('map', JSON.stringify(map));