graphql-data-generator 0.3.0-alpha.4 → 0.3.0-alpha.6

package/esm/jest.js

@@ -1,8 +1,8 @@
 import * as dntShim from "./_dnt.shims.js";
 import React, { useMemo } from "react";
-import { ApolloLink } from "@apollo/client";
-import { ErrorLink } from "@apollo/client/link/error/index.js";
-import { MockedProvider, MockLink, } from "@apollo/client/testing/index.js";
+import { ApolloLink, useApolloClient, } from "@apollo/client";
+import { ErrorLink } from "@apollo/client/link/error";
+import { MockedProvider, MockLink, } from "@apollo/client/testing";
 import { waitFor } from "@testing-library/dom";
 import { Kind, print } from "graphql";
 import { diff as jestDiff } from "jest-diff";
@@ -54,15 +54,52 @@ const getErrorMessage = (operation, mockLink) => {
             : undefined,
     };
 };
-let _interceptRefetchWarnings = false;
-export const interceptRefetchWarnings = (value = true) => _interceptRefetchWarnings = value;
+let _failRefetchWarnings = false;
+/**
+ * In older versions of `@apollo/client`, refetches with missing mocks trigger
+ * warnings instead of being treated as standard missing mocks.
+ * This utility converts those warnings into failures and ensures watch queries
+ * are installed for queries with `watch: true`. This must be set when
+ * `MockProvider` is mounted.
+ *
+ * This is not required on modern version of `@apollo/client`.
+ */
+export const failRefetchWarnings = (value = true) => _failRefetchWarnings = value;
+let _allowMissingMocks = false;
+/**
+ * Allows missing mocks, resulting in tests passing. Usage is intended to ease
+ * migration.
+ */
+export const allowMissingMocks = (value) => _allowMissingMocks = value;
+const AutoWatch = ({ mocks }) => {
+    const client = useApolloClient();
+    for (const mock of mocks)
+        if (mock.watch)
+            client.watchQuery(mock.request);
+    return null;
+};
+/**
+ * A wrapper for `@apollo/client/testing`, this component will assert all
+ * requests have matching mocks and all defined mocks are used unless marked
+ * `optional`.
+ */
 export const MockProvider = ({ mocks, stack: renderStack, children }) => {
     const observableMocks = useMemo(() => {
-        const observableMocks = mocks.map((m) => ({
-            ...m,
-            stack: m.stack,
-            result: Object.assign(jest.fn(() => m.result), m.result),
-        }));
+        const observableMocks = mocks.flatMap((m) => [
+            {
+                ...m,
+                stack: m.stack,
+                result: Object.assign(jest.fn(() => m.result), m.result),
+            },
+            ...(m.watch
+                ? [{
+                        ...m,
+                        stack: m.stack,
+                        result: Object.assign(jest.fn(() => m.result), m.result),
+                        watch: false,
+                    }]
+                : []),
+        ]);
         afterTest.push(async () => {
             if (currentSpecResult.failedExpectations.length)
                 return;
@@ -92,7 +129,8 @@ export const MockProvider = ({ mocks, stack: renderStack, children }) => {
         const mockLink = new MockLink(observableMocks);
         mockLink.showWarnings = false;
         const errorLoggingLink = new ErrorLink(({ networkError, operation }) => {
-            if (!networkError?.message.includes("No more mocked responses"))
+            if (_allowMissingMocks ||
+                !networkError?.message.includes("No more mocked responses"))
                 return;
             const { message, stack: altStack } = getErrorMessage(operation, mockLink);
             try {
@@ -109,7 +147,7 @@ export const MockProvider = ({ mocks, stack: renderStack, children }) => {
         // @ts-ignore It's fine
         return ApolloLink.from([errorLoggingLink, mockLink]);
     }, [observableMocks, renderStack]);
-    if (_interceptRefetchWarnings) {
+    if (_failRefetchWarnings) {
         const oldWarn = console.warn.bind(console.warn);
         console.warn = (message, operation, ...etc) => {
             if (message !==
@@ -131,5 +169,8 @@ export const MockProvider = ({ mocks, stack: renderStack, children }) => {
             console.warn = oldWarn;
         });
     }
-    return React.createElement(MockedProvider, { link: link }, children);
+    return (React.createElement(MockedProvider, { link: link },
+        React.createElement(React.Fragment, null,
+            React.createElement(AutoWatch, { mocks: observableMocks }),
+            children)));
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "graphql-data-generator",
-  "version": "0.3.0-alpha.4",
+  "version": "0.3.0-alpha.6",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/voces/graphql-data-generator.git"
@@ -35,6 +35,16 @@
   "bin": {
     "graphql-data-generator": "./esm/cli.js"
   },
+  "typesVersions": {
+    "*": {
+      "script/jest": [
+        "types/jest.d.ts"
+      ],
+      "script/plugin": [
+        "types/plugin.d.ts"
+      ]
+    }
+  },
   "dependencies": {
     "@graphql-codegen/visitor-plugin-common": "*",
     "fast-glob": "*",

package/script/jest.js

@@ -23,12 +23,12 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.MockProvider = exports.interceptRefetchWarnings = void 0;
+exports.MockProvider = exports.allowMissingMocks = exports.failRefetchWarnings = void 0;
 const dntShim = __importStar(require("./_dnt.shims.js"));
 const react_1 = __importStar(require("react"));
 const client_1 = require("@apollo/client");
-const index_js_1 = require("@apollo/client/link/error/index.js");
-const index_js_2 = require("@apollo/client/testing/index.js");
+const error_1 = require("@apollo/client/link/error");
+const testing_1 = require("@apollo/client/testing");
 const dom_1 = require("@testing-library/dom");
 const graphql_1 = require("graphql");
 const jest_diff_1 = require("jest-diff");
@@ -80,16 +80,54 @@ const getErrorMessage = (operation, mockLink) => {
             : undefined,
     };
 };
-let _interceptRefetchWarnings = false;
-const interceptRefetchWarnings = (value = true) => _interceptRefetchWarnings = value;
-exports.interceptRefetchWarnings = interceptRefetchWarnings;
+let _failRefetchWarnings = false;
+/**
+ * In older versions of `@apollo/client`, refetches with missing mocks trigger
+ * warnings instead of being treated as standard missing mocks.
+ * This utility converts those warnings into failures and ensures watch queries
+ * are installed for queries with `watch: true`. This must be set when
+ * `MockProvider` is mounted.
+ *
+ * This is not required on modern version of `@apollo/client`.
+ */
+const failRefetchWarnings = (value = true) => _failRefetchWarnings = value;
+exports.failRefetchWarnings = failRefetchWarnings;
+let _allowMissingMocks = false;
+/**
+ * Allows missing mocks, resulting in tests passing. Usage is intended to ease
+ * migration.
+ */
+const allowMissingMocks = (value) => _allowMissingMocks = value;
+exports.allowMissingMocks = allowMissingMocks;
+const AutoWatch = ({ mocks }) => {
+    const client = (0, client_1.useApolloClient)();
+    for (const mock of mocks)
+        if (mock.watch)
+            client.watchQuery(mock.request);
+    return null;
+};
+/**
+ * A wrapper for `@apollo/client/testing`, this component will assert all
+ * requests have matching mocks and all defined mocks are used unless marked
+ * `optional`.
+ */
 const MockProvider = ({ mocks, stack: renderStack, children }) => {
     const observableMocks = (0, react_1.useMemo)(() => {
-        const observableMocks = mocks.map((m) => ({
-            ...m,
-            stack: m.stack,
-            result: Object.assign(jest.fn(() => m.result), m.result),
-        }));
+        const observableMocks = mocks.flatMap((m) => [
+            {
+                ...m,
+                stack: m.stack,
+                result: Object.assign(jest.fn(() => m.result), m.result),
+            },
+            ...(m.watch
+                ? [{
+                        ...m,
+                        stack: m.stack,
+                        result: Object.assign(jest.fn(() => m.result), m.result),
+                        watch: false,
+                    }]
+                : []),
+        ]);
         afterTest.push(async () => {
             if (currentSpecResult.failedExpectations.length)
                 return;
@@ -116,10 +154,11 @@ const MockProvider = ({ mocks, stack: renderStack, children }) => {
         return observableMocks;
     }, [mocks]);
     const link = (0, react_1.useMemo)(() => {
-        const mockLink = new index_js_2.MockLink(observableMocks);
+        const mockLink = new testing_1.MockLink(observableMocks);
         mockLink.showWarnings = false;
-        const errorLoggingLink = new index_js_1.ErrorLink(({ networkError, operation }) => {
-            if (!networkError?.message.includes("No more mocked responses"))
+        const errorLoggingLink = new error_1.ErrorLink(({ networkError, operation }) => {
+            if (_allowMissingMocks ||
+                !networkError?.message.includes("No more mocked responses"))
                 return;
             const { message, stack: altStack } = getErrorMessage(operation, mockLink);
             try {
@@ -136,7 +175,7 @@ const MockProvider = ({ mocks, stack: renderStack, children }) => {
         // @ts-ignore It's fine
         return client_1.ApolloLink.from([errorLoggingLink, mockLink]);
     }, [observableMocks, renderStack]);
-    if (_interceptRefetchWarnings) {
+    if (_failRefetchWarnings) {
         const oldWarn = console.warn.bind(console.warn);
         console.warn = (message, operation, ...etc) => {
             if (message !==
@@ -158,6 +197,9 @@ const MockProvider = ({ mocks, stack: renderStack, children }) => {
             console.warn = oldWarn;
         });
     }
-    return react_1.default.createElement(index_js_2.MockedProvider, { link: link }, children);
+    return (react_1.default.createElement(testing_1.MockedProvider, { link: link },
+        react_1.default.createElement(react_1.default.Fragment, null,
+            react_1.default.createElement(AutoWatch, { mocks: observableMocks }),
+            children)));
 };
 exports.MockProvider = MockProvider;

package/types/jest.d.ts

@@ -1,6 +1,25 @@
 import React from "react";
 import type { OperationMock } from "./types.js";
-export declare const interceptRefetchWarnings: (value?: boolean) => boolean;
+/**
+ * In older versions of `@apollo/client`, refetches with missing mocks trigger
+ * warnings instead of being treated as standard missing mocks.
+ * This utility converts those warnings into failures and ensures watch queries
+ * are installed for queries with `watch: true`. This must be set when
+ * `MockProvider` is mounted.
+ *
+ * This is not required on modern version of `@apollo/client`.
+ */
+export declare const failRefetchWarnings: (value?: boolean) => boolean;
+/**
+ * Allows missing mocks, resulting in tests passing. Usage is intended to ease
+ * migration.
+ */
+export declare const allowMissingMocks: (value: true) => true;
+/**
+ * A wrapper for `@apollo/client/testing`, this component will assert all
+ * requests have matching mocks and all defined mocks are used unless marked
+ * `optional`.
+ */
 export declare const MockProvider: ({ mocks, stack: renderStack, children }: {
     mocks: OperationMock[];
     stack?: string;

package/types/types.d.ts

@@ -28,12 +28,16 @@ export type OperationMock<Data extends Record<string, unknown> = Record<string,
     };
     error?: Error;
     stack?: string;
+    watch?: boolean;
+    optional?: boolean;
 };
 export type SimpleOperationMock<Data extends Record<string, unknown> = Record<string, unknown>, Variables = Record<string, unknown> | never> = {
     data: Data;
     variables?: Variables;
     error?: Error;
     errors?: GraphQLError[];
+    watch?: boolean;
+    optional?: boolean;
 };
 export type SimpleOperationPatch<Data extends Record<string, unknown> = Record<string, unknown>, Variables = Record<string, unknown> | never> = Patch<{
     data: Data;
@@ -41,5 +45,7 @@ export type SimpleOperationPatch<Data extends Record<string, unknown> = Record<s
 }> & {
     error?: Error;
     errors?: GraphQLError[];
+    watch?: boolean;
+    optional?: boolean;
 };
 export {};