APQ: Follow Apollo's implementation more & integration tests for Apol…

…lo Client (dotansimha#2985)

* Integration tests for APQ plugin and Apollo Client

* Skip v15

* Go

* Go

* Lint

* Follow Apollo's implementation

* Fix tests

* chore(dependencies): updated changesets for modified dependencies

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

.changeset/@graphql-yoga_plugin-prometheus-2985-dependencies.md

@@ -0,0 +1,6 @@
+---
+'@graphql-yoga/plugin-prometheus': patch
+---
+dependencies updates:
+  - Updated dependency [`@envelop/[email protected]`
+    ↗︎](https://www.npmjs.com/package/@envelop/prometheus/v/8.0.1) (from `8.0.0`, in `dependencies`)

.changeset/olive-hairs-unite.md

@@ -0,0 +1,5 @@
+---
+'@graphql-yoga/plugin-apq': patch
+---
+
+Add `extensions.code` to match Apollo's APQ implementation

jest.config.js

@@ -35,6 +35,7 @@ if (process.env.LEAKS_TEST === 'true') {
     '!**/urql-exchange.spec.ts',
     '!**/apollo-link.spec.ts',
     '!**/uwebsockets.test.ts',
+    '!**/apollo-client.test.ts',
   );
 }
 

packages/plugins/apq/__integration-tests__/apollo-client.test.ts

@@ -0,0 +1,91 @@
+/* eslint-disable import/no-extraneous-dependencies */
+import crypto from 'node:crypto';
+import { parse, version } from 'graphql';
+import { createSchema, createYoga } from 'graphql-yoga';
+import { ApolloClient, HttpLink, InMemoryCache } from '@apollo/client';
+import { createPersistedQueryLink } from '@apollo/client/link/persisted-queries';
+import { useAPQ } from '@graphql-yoga/plugin-apq';
+
+function sha256(input: string) {
+  return crypto.createHash('sha256').update(input).digest('hex');
+}
+
+describe('Automatic Persisted Queries', () => {
+  if (version.startsWith('15')) {
+    // eslint-disable-next-line @typescript-eslint/no-empty-function
+    it('noop', () => {});
+    return;
+  }
+  const server = createYoga({
+    schema: createSchema({
+      typeDefs: /* GraphQL */ `
+        type Query {
+          foo: String
+        }
+      `,
+      resolvers: {
+        Query: {
+          foo() {
+            return 'bar';
+          },
+        },
+      },
+    }),
+    plugins: [useAPQ()],
+  });
+
+  const fetchSpy = jest.fn(async (info: RequestInfo | URL, init: RequestInit) =>
+    server.fetch(info as URL, init),
+  );
+
+  const linkChain = createPersistedQueryLink({ sha256 }).concat(
+    new HttpLink({ uri: 'http://localhost:4000/graphql', fetch: fetchSpy }),
+  );
+
+  const client = new ApolloClient({
+    cache: new InMemoryCache(),
+    link: linkChain,
+  });
+
+  it('works', async () => {
+    const query = '{\n  foo\n}';
+    const { data } = await client.query({ query: parse(query) });
+
+    expect(data).toEqual({ foo: 'bar' });
+
+    expect(fetchSpy).toHaveBeenCalledTimes(2);
+    expect(fetchSpy.mock.calls[0][1]).toMatchObject({
+      body: JSON.stringify({
+        variables: {},
+        extensions: {
+          persistedQuery: {
+            version: 1,
+            sha256Hash: sha256(query),
+          },
+        },
+      }),
+      headers: {
+        'content-type': 'application/json',
+        accept: '*/*',
+      },
+      method: 'POST',
+    });
+    expect(fetchSpy.mock.calls[1][1]).toMatchObject({
+      body: JSON.stringify({
+        variables: {},
+        extensions: {
+          persistedQuery: {
+            version: 1,
+            sha256Hash: sha256(query),
+          },
+        },
+        query,
+      }),
+      headers: {
+        'content-type': 'application/json',
+        accept: '*/*',
+      },
+      method: 'POST',
+    });
+  });
+});

packages/plugins/apq/__tests__/apq.spec.ts

@@ -139,7 +139,9 @@ describe('Automatic Persisted Queries', () => {
 
     expect(response.ok).toBe(false);
     expect(await response.json()).toEqual({
-      errors: [{ message: 'PersistedQueryMismatch' }],
+      errors: [
+        { message: 'PersistedQueryMismatch', extensions: { code: 'PERSISTED_QUERY_MISMATCH' } },
+      ],
     });
   });
 });

packages/plugins/apq/package.json

@@ -41,6 +41,8 @@
     "graphql-yoga": "^4.0.4"
   },
   "devDependencies": {
+    "@apollo/client": "3.8.2",
+    "crypto-hash": "2.0.1",
     "graphql-yoga": "4.0.4"
   },
   "publishConfig": {

packages/plugins/apq/src/index.ts

@@ -88,6 +88,7 @@ export function useAPQ(options: APQOptions = {}): Plugin {
               http: {
                 status: 404,
               },
+              code: 'PERSISTED_QUERY_NOT_FOUND',
             },
           });
         }
@@ -103,6 +104,7 @@ export function useAPQ(options: APQOptions = {}): Plugin {
               http: {
                 status: 400,
               },
+              code: 'PERSISTED_QUERY_MISMATCH',
             },
           });
         }