Schema-driven testing utilities (#11605)

Author: alessbell

.api-reports/api-report-testing.md

@@ -4,13 +4,16 @@
 
 ```ts
 
+/// <reference types="node" />
+
 import type { ASTNode } from 'graphql';
 import type { DocumentNode } from 'graphql';
 import type { ExecutionResult } from 'graphql';
 import type { FieldNode } from 'graphql';
 import type { FragmentDefinitionNode } from 'graphql';
 import type { GraphQLError } from 'graphql';
 import type { GraphQLErrorExtensions } from 'graphql';
+import type { GraphQLSchema } from 'graphql';
 import { Observable } from 'zen-observable-ts';
 import type { Observer } from 'zen-observable-ts';
 import * as React_2 from 'react';
@@ -446,6 +449,24 @@ type ConcastSourcesIterable<T> = Iterable<Source<T>>;
 // @public (undocumented)
 export function createMockClient<TData>(data: TData, query: DocumentNode, variables?: {}): ApolloClient<NormalizedCacheObject>;
 
+// @alpha
+export const createMockFetch: (schema: GraphQLSchema, mockFetchOpts?: {
+    validate: boolean;
+}) => {
+    mock: (uri: any, options: any) => Promise<Response>;
+    restore: () => void;
+} & Disposable;
+
+// @alpha
+export const createMockSchema: (staticSchema: GraphQLSchema, mocks: {
+    [key: string]: any;
+}) => GraphQLSchema;
+
+// Warning: (ae-forgotten-export) The symbol "ProxiedSchema" needs to be exported by the entry point index.d.ts
+//
+// @alpha
+export const createProxiedSchema: (schemaWithMocks: GraphQLSchema, resolvers: Resolvers) => ProxiedSchema;
+
 // @public (undocumented)
 namespace DataProxy {
     // (undocumented)
@@ -1265,6 +1286,25 @@ type Path = ReadonlyArray<string | number>;
 // @public (undocumented)
 type Primitive = null | undefined | string | number | boolean | symbol | bigint;
 
+// Warning: (ae-forgotten-export) The symbol "ProxiedSchemaFns" needs to be exported by the entry point index.d.ts
+//
+// @public (undocumented)
+type ProxiedSchema = GraphQLSchema & ProxiedSchemaFns;
+
+// @public (undocumented)
+interface ProxiedSchemaFns {
+    // (undocumented)
+    add: (addOptions: {
+        resolvers: Resolvers;
+    }) => ProxiedSchema;
+    // (undocumented)
+    fork: (forkOptions?: {
+        resolvers?: Resolvers;
+    }) => ProxiedSchema;
+    // (undocumented)
+    reset: () => void;
+}
+
 // @public (undocumented)
 class QueryInfo {
     constructor(queryManager: QueryManager<any>, queryId?: string);

.api-reports/api-report-testing_core.md

@@ -4,13 +4,16 @@
 
 ```ts
 
+/// <reference types="node" />
+
 import type { ASTNode } from 'graphql';
 import type { DocumentNode } from 'graphql';
 import type { ExecutionResult } from 'graphql';
 import type { FieldNode } from 'graphql';
 import type { FragmentDefinitionNode } from 'graphql';
 import type { GraphQLError } from 'graphql';
 import type { GraphQLErrorExtensions } from 'graphql';
+import type { GraphQLSchema } from 'graphql';
 import { Observable } from 'zen-observable-ts';
 import type { Observer } from 'zen-observable-ts';
 import type { Subscriber } from 'zen-observable-ts';
@@ -445,6 +448,19 @@ type ConcastSourcesIterable<T> = Iterable<Source<T>>;
 // @public (undocumented)
 export function createMockClient<TData>(data: TData, query: DocumentNode, variables?: {}): ApolloClient<NormalizedCacheObject>;
 
+// @alpha
+export const createMockFetch: (schema: GraphQLSchema, mockFetchOpts?: {
+    validate: boolean;
+}) => {
+    mock: (uri: any, options: any) => Promise<Response>;
+    restore: () => void;
+} & Disposable;
+
+// Warning: (ae-forgotten-export) The symbol "ProxiedSchema" needs to be exported by the entry point index.d.ts
+//
+// @alpha
+export const createProxiedSchema: (schemaWithMocks: GraphQLSchema, resolvers: Resolvers) => ProxiedSchema;
+
 // @public (undocumented)
 namespace DataProxy {
     // (undocumented)
@@ -1220,6 +1236,25 @@ type Path = ReadonlyArray<string | number>;
 // @public (undocumented)
 type Primitive = null | undefined | string | number | boolean | symbol | bigint;
 
+// Warning: (ae-forgotten-export) The symbol "ProxiedSchemaFns" needs to be exported by the entry point index.d.ts
+//
+// @public (undocumented)
+type ProxiedSchema = GraphQLSchema & ProxiedSchemaFns;
+
+// @public (undocumented)
+interface ProxiedSchemaFns {
+    // (undocumented)
+    add: (addOptions: {
+        resolvers: Resolvers;
+    }) => ProxiedSchema;
+    // (undocumented)
+    fork: (forkOptions?: {
+        resolvers?: Resolvers;
+    }) => ProxiedSchema;
+    // (undocumented)
+    reset: () => void;
+}
+
 // @public (undocumented)
 class QueryInfo {
     constructor(queryManager: QueryManager<any>, queryId?: string);

.changeset/chatty-llamas-switch.md

@@ -0,0 +1,5 @@
+---
+"@apollo/client": minor
+---
+
+Adds `createMockFetch` utility for integration testing that includes the link chain

.changeset/stupid-bears-cheat.md

@@ -0,0 +1,5 @@
+---
+"@apollo/client": minor
+---
+
+Adds proxiedSchema and createMockSchema testing utilities

.size-limits.json

@@ -1,4 +1,4 @@
 {
-  "dist/apollo-client.min.cjs": 39512,
-  "import { ApolloClient, InMemoryCache, HttpLink } from \"dist/index.js\" (production)": 32801
+  "dist/apollo-client.min.cjs": 39506,
+  "import { ApolloClient, InMemoryCache, HttpLink } from \"dist/index.js\" (production)": 32793
 }

.vscode/launch.json

@@ -1,25 +1,22 @@
 {
   "version": "0.2.0",
   "configurations": [
-    {
-      "name": "Attach to Node.js inspector",
-      "port": 9229,
-      "request": "attach",
-      "skipFiles": ["<node_internals>/**"],
-      "type": "pwa-node"
-    },
     {
       "type": "node",
       "request": "launch",
-      "name": "Jest Current File",
-      "program": "${workspaceFolder}/node_modules/.bin/jest",
-      "args": ["${relativeFile}", "--config", "./config/jest.config.js"],
+      "name": "Jest Attach Node Inspector for Current File",
+      "cwd": "${workspaceFolder}",
+      "runtimeArgs": [
+        "--inspect-brk",
+        "${workspaceRoot}/node_modules/.bin/jest",
+        "${relativeFile}",
+        "--config",
+        "./config/jest.config.js",
+        "--runInBand",
+        "--watch"
+      ],
       "console": "integratedTerminal",
-      "internalConsoleOptions": "neverOpen",
-      "disableOptimisticBPs": true,
-      "windows": {
-        "program": "${workspaceFolder}/node_modules/jest/bin/jest"
-      }
+      "internalConsoleOptions": "neverOpen"
     }
   ]
 }

config/jest.config.js

@@ -33,6 +33,7 @@ const react17TestFileIgnoreList = [
   ignoreTSFiles,
   // We only support Suspense with React 18, so don't test suspense hooks with
   // React 17
+  "src/testing/core/__tests__/createProxiedSchema.test.tsx",
   "src/react/hooks/__tests__/useSuspenseQuery.test.tsx",
   "src/react/hooks/__tests__/useBackgroundQuery.test.tsx",
   "src/react/hooks/__tests__/useLoadableQuery.test.tsx",

package-lock.json

@@ -112,6 +112,7 @@
     "@changesets/changelog-github": "0.5.0",
     "@changesets/cli": "2.27.1",
     "@graphql-tools/schema": "10.0.3",
+    "@graphql-tools/utils": "10.0.13",
     "@microsoft/api-extractor": "7.42.3",
     "@rollup/plugin-node-resolve": "11.2.1",
     "@size-limit/esbuild-why": "11.1.2",

package.json

@@ -0,0 +1,15 @@
+diff --git a/node_modules/jest-environment-jsdom/build/index.js b/node_modules/jest-environment-jsdom/build/index.js
+index 2e6c16c..174e7a0 100644
+--- a/node_modules/jest-environment-jsdom/build/index.js
++++ b/node_modules/jest-environment-jsdom/build/index.js
+@@ -96,6 +96,10 @@ class JSDOMEnvironment {
+     // TODO: remove this ASAP, but it currently causes tests to run really slow
+     global.Buffer = Buffer;
+ 
++    // Add mocks for schemaProxy tests that rely on `Response` and `fetch`
++    // being globally available
++    global.Response = Response;
++
+     // Report uncaught errors.
+     this.errorEventListener = event => {
+       if (userErrorListenerCount === 0 && event.error != null) {