Merge pull request #453 from apollographql/mw/testing-improvements

Testing infrastructure improvements

Author: martijnwalraven

.vscode/tasks.json

@@ -0,0 +1,25 @@
+{
+  "version": "2.0.0",
+  "tasks": [
+    {
+      "label": "TypeScript watch",
+      "type": "typescript",
+      "tsconfig": "tsconfig.json",
+      "option": "watch",
+      "problemMatcher": ["$tsc-watch"],
+      "group": {
+        "kind": "build",
+        "isDefault": true
+      },
+      "presentation": {
+        "reveal": "never",
+        "revealProblems": "onProblem",
+        "panel": "shared",
+        "clear": true
+      },
+      "runOptions": {
+        "runOn": "folderOpen"
+      }
+    }
+  ]
+}

federation-integration-testsuite-js/src/index.ts

@@ -1 +1,2 @@
+export * from './snapshotSerializers';
 export * from './fixtures';

federation-integration-testsuite-js/src/matchers/index.ts

@@ -0,0 +1,4 @@
+import './toCallService';
+import './toHaveBeenCalledBefore';
+import './toHaveFetched';
+import './toMatchAST';

gateway-js/src/__tests__/matchers/toCallService.ts renamed to federation-integration-testsuite-js/src/matchers/toCallService.ts

@@ -1,12 +1,10 @@
-import { QueryPlan } from '@apollo/gateway';
-import { PlanNode } from '../../QueryPlan';
-import astSerializer from '../../snapshotSerializers/astSerializer';
-import queryPlanSerializer from '../../snapshotSerializers/queryPlanSerializer';
+import { QueryPlan, PlanNode } from '@apollo/query-planner';
+import { astSerializer, queryPlanSerializer } from '../snapshotSerializers';
 const prettyFormat = require('pretty-format');
 
 declare global {
   namespace jest {
-    interface Matchers<R, T> {
+    interface Matchers<R> {
       toCallService(service: string): R;
     }
   }

gateway-js/src/__tests__/matchers/toHaveBeenCalledBefore.ts renamed to federation-integration-testsuite-js/src/matchers/toHaveBeenCalledBefore.ts

@@ -3,8 +3,8 @@
 export {};
 declare global {
   namespace jest {
-    interface Matchers<R, T> {
-      toHaveBeenCalledBefore(spy: SpyInstance): R;
+    interface Matchers<R> {
+      toHaveBeenCalledBefore(secondSpy: jest.SpyInstance): R;
     }
   }
 }

gateway-js/src/__tests__/matchers/toHaveFetched.ts renamed to federation-integration-testsuite-js/src/matchers/toHaveFetched.ts

@@ -1,24 +1,21 @@
 import { RequestInit, Headers } from 'apollo-server-env';
+type RequestInitWithJSONBody = Omit<RequestInit, 'body'> & { body?: object }
 
 // Make this file a module
 // See: https://github.com/microsoft/TypeScript/issues/17736
 export {};
 declare global {
   namespace jest {
-    interface Matchers<R, T> {
-      toHaveFetched(spy: SpyInstance): R;
+    interface Matchers<R> {
+      toHaveFetched(requestUrl: string, requestOpts?: RequestInitWithJSONBody): R;
+      toHaveFetchedNth(nthCall: number, requestUrl: string, requestOpts?: RequestInitWithJSONBody): R;
     }
   }
 }
 
-function prepareHttpOptions(requestUrl: string, requestOpts: RequestInit): RequestInit {
-  const headers = new Headers();
+function prepareHttpOptions(requestUrl: string, requestOpts: RequestInitWithJSONBody): RequestInit {
+  const headers = new Headers(requestOpts.headers);
   headers.set('Content-Type', 'application/json');
-  if (requestOpts.headers) {
-    for (let name in requestOpts.headers) {
-      headers.set(name, requestOpts.headers[name]);
-    }
-  }
 
   const requestHttp = {
     method: 'POST',
@@ -37,7 +34,7 @@ function toHaveFetched(
   this: jest.MatcherUtils,
   fetch: jest.SpyInstance,
   requestUrl: string,
-  requestOpts: RequestInit
+  requestOpts: RequestInitWithJSONBody = {}
 ): { message(): string; pass: boolean } {
   const httpOptions = prepareHttpOptions(requestUrl, requestOpts);
   let pass = false;
@@ -60,7 +57,7 @@ function toHaveFetchedNth(
   fetch: jest.SpyInstance,
   nthCall: number,
   requestUrl: string,
-  requestOpts: RequestInit
+  requestOpts: RequestInitWithJSONBody = {}
 ): { message(): string; pass: boolean } {
   const httpOptions = prepareHttpOptions(requestUrl, requestOpts);
   let pass = false;

federation-integration-testsuite-js/src/matchers/toMatchAST.ts

@@ -0,0 +1,43 @@
+import { ASTNode } from 'graphql';
+import { MatcherHintOptions } from 'jest-matcher-utils';
+import { diffFormatted, indentLines, printExpectedFormatted } from './utils';
+
+declare global {
+  namespace jest {
+    interface Matchers<R> {
+      toMatchAST(expected: ASTNode): R;
+    }
+  }
+}
+
+expect.extend({
+  toMatchAST(received: ASTNode, expected: ASTNode) {
+    const matcherName = 'toMatchAST';
+    const options: MatcherHintOptions = {
+      isNot: this.isNot,
+      promise: this.promise,
+    };
+
+    const pass = this.equals(received, expected);
+
+    const message = pass
+      ? () =>
+          this.utils.matcherHint(matcherName, undefined, undefined, options) +
+          '\n\n' +
+          `Expected AST to not equal:\n` +
+          indentLines(printExpectedFormatted(expected))
+      : () =>
+          this.utils.matcherHint(matcherName, undefined, undefined, options) +
+          '\n\n' +
+          diffFormatted(expected, received, {
+            aAnnotation: 'Expected',
+            bAnnotation: 'Received',
+            expand: this.expand ?? true,
+            includeChangeCounts: true,
+          });
+    return {
+      message,
+      pass,
+    };
+  },
+});

federation-integration-testsuite-js/src/matchers/toMatchQueryPlan.ts

@@ -0,0 +1,43 @@
+import { QueryPlan } from '@apollo/query-planner';
+import { MatcherHintOptions } from 'jest-matcher-utils';
+import { diffFormatted, indentLines, printExpectedFormatted } from './utils';
+
+declare global {
+  namespace jest {
+    interface Matchers<R> {
+      toMatchQueryPlan(expected: QueryPlan): R;
+    }
+  }
+}
+
+expect.extend({
+  toMatchQueryPlan(received: QueryPlan, expected: QueryPlan) {
+    const matcherName = 'toMatchQueryPlan';
+    const options: MatcherHintOptions = {
+      isNot: this.isNot,
+      promise: this.promise,
+    };
+
+    const pass = this.equals(received, expected);
+
+    const message = pass
+      ? () =>
+          this.utils.matcherHint(matcherName, undefined, undefined, options) +
+          '\n\n' +
+          `Expected query plan to not equal:\n` +
+          indentLines(printExpectedFormatted(expected))
+      : () =>
+          this.utils.matcherHint(matcherName, undefined, undefined, options) +
+          '\n\n' +
+          diffFormatted(expected, received, {
+            aAnnotation: 'Expected',
+            bAnnotation: 'Received',
+            expand: this.expand ?? true,
+            includeChangeCounts: true,
+          });
+    return {
+      message,
+      pass,
+    };
+  },
+});

federation-integration-testsuite-js/src/matchers/utils.ts

@@ -0,0 +1,53 @@
+import diff, { DiffOptions } from 'jest-diff';
+import { EXPECTED_COLOR, RECEIVED_COLOR } from 'jest-matcher-utils';
+import prettyFormat from 'pretty-format';
+import {
+  queryPlanSerializer,
+  astSerializer,
+  typeSerializer,
+} from '../snapshotSerializers';
+
+const defaultFormatOptions: prettyFormat.OptionsReceived = {
+  plugins: [queryPlanSerializer, astSerializer, typeSerializer],
+};
+
+export function diffFormatted(
+  expected: unknown,
+  received: unknown,
+  diffOptions?: DiffOptions,
+  formatOptions: prettyFormat.OptionsReceived = defaultFormatOptions,
+) {
+  const expectedString = prettyFormat(expected, formatOptions);
+  const receivedString = prettyFormat(received, formatOptions);
+
+  return diff(expectedString, receivedString, diffOptions);
+}
+
+export function indentLines(
+  text: string,
+  depth: number = 1,
+  indent: string = ' ',
+) {
+  const indentation = indent.repeat(depth);
+  return text
+    .split('\n')
+    .map((line) => indentation + line)
+    .join('\n');
+}
+
+// The corresponding functions in `jest-matcher-utils` call their own `stringify` function,
+// and that doesn't allow passing in custom pretty-format plugins.
+
+export function printReceivedFormatted(
+  value: unknown,
+  formatOptions: prettyFormat.OptionsReceived = defaultFormatOptions,
+): string {
+  return RECEIVED_COLOR(prettyFormat(value, formatOptions));
+}
+
+export function printExpectedFormatted(
+  value: unknown,
+  formatOptions: prettyFormat.OptionsReceived = defaultFormatOptions,
+): string {
+  return EXPECTED_COLOR(prettyFormat(value, formatOptions));
+}

federation-js/src/snapshotSerializers/graphqlErrorSerializer.ts renamed to federation-integration-testsuite-js/src/snapshotSerializers/graphqlErrorSerializer.ts

@@ -0,0 +1,6 @@
+export { astSerializer } from '@apollo/query-planner';
+export { queryPlanSerializer } from '@apollo/query-planner';
+export { default as selectionSetSerializer } from './selectionSetSerializer';
+export { default as typeSerializer } from './typeSerializer';
+export { default as graphqlErrorSerializer } from './graphqlErrorSerializer';
+

federation-integration-testsuite-js/src/snapshotSerializers/index.ts

@@ -3,11 +3,11 @@
   "compilerOptions": {
     "rootDir": "./src",
     "outDir": "./dist",
-    "noImplicitAny": false,
-    "strictNullChecks": false,
     "types": ["node", "jest"]
   },
   "include": ["src/**/*"],
   "exclude": ["**/__tests__"],
-  "references": []
+  "references": [
+    { "path": "../gateway-js" }
+  ]
 }

federation-js/src/snapshotSerializers/selectionSetSerializer.ts renamed to federation-integration-testsuite-js/src/snapshotSerializers/selectionSetSerializer.ts

@@ -1,5 +1,8 @@
-const config = require('../jest.config.base');
+const baseConfig = require('../jest.config.base');
 
-const additionalConfig = {};
-
-module.exports = Object.assign(Object.create(null), config, additionalConfig);
+/** @typedef {import('ts-jest/dist/types')} */
+/** @type {import('@jest/types').Config.InitialOptions} */
+module.exports = {
+  ...baseConfig,
+  setupFilesAfterEnv: ['./src/__tests__/testSetup.ts'],
+};

federation-js/src/snapshotSerializers/typeSerializer.ts renamed to federation-integration-testsuite-js/src/snapshotSerializers/typeSerializer.ts

@@ -0,0 +1 @@
+import 'apollo-federation-integration-testsuite/dist/matchers';

federation-integration-testsuite-js/tsconfig.json

@@ -1,7 +1,8 @@
 {
-  "extends": "../../../tsconfig.test.base",
+  "extends": "../../tsconfig.test",
   "include": ["**/*"],
   "references": [
-    { "path": "../../" },
+    { "path": "../.." },
+    { "path": "../../../federation-integration-testsuite-js" },
   ]
 }