graphql-data-generator 0.3.0-alpha.3 → 0.3.0-alpha.5

package/esm/jest.js

@@ -1,10 +1,10 @@
 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 { print } from "graphql";
+import { Kind, print } from "graphql";
 import { diff as jestDiff } from "jest-diff";
 let currentSpecResult;
 jasmine.getEnv().addReporter({
@@ -12,18 +12,11 @@ jasmine.getEnv().addReporter({
 });
 const afterTest = [];
 afterEach(async () => {
-    for (const hook of afterTest)
+    const hooks = afterTest.splice(0);
+    for (const hook of hooks)
         await hook();
-    afterTest.splice(0);
 });
-const diff = (a, b) => jestDiff(a, b, {
-    omitAnnotationLines: true,
-    // aColor: green,
-    // bColor: red,
-    // changeColor: inverse,
-    // commonColor: dim,
-    // patchColor: yellow,
-})
+const diff = (a, b) => jestDiff(a, b, { omitAnnotationLines: true })
     ?.replace(/\w+ \{/g, "{") // Remove class names
     .replace(/\w+ \[/g, "["); // Remove array class names
 const getErrorMessage = (operation, mockLink) => {
@@ -38,7 +31,7 @@ const getErrorMessage = (operation, mockLink) => {
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     const alts = (mockLink
         .mockedResponsesByKey[key] ?? []);
-    let errorMessage = `Expected GraphQL ${operationType} ${operation.operationName} to have been mocked`;
+    let errorMessage = `Expected ${operationType} ${operation.operationName} to have been mocked`;
     if (alts.length || Object.keys(operation.variables).length > 0) {
         errorMessage += ` with variables ${dntShim.Deno.inspect(operation.variables, { depth: Infinity, colors: true })}`;
     }
@@ -61,13 +54,38 @@ const getErrorMessage = (operation, mockLink) => {
             : undefined,
     };
 };
+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`.
+ */
+export const failRefetchWarnings = (value = true) => _failRefetchWarnings = value;
+const AutoWatch = ({ mocks }) => {
+    const client = useApolloClient();
+    for (const mock of mocks)
+        if (mock.watch)
+            client.watchQuery(mock.request);
+    return null;
+};
 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;
@@ -78,7 +96,8 @@ export const MockProvider = ({ mocks, stack: renderStack, children }) => {
                     if (currentSpecResult.failedExpectations.length)
                         return;
                     if (mock.result.mock.calls.length === 0) {
-                        const err = new Error(`Expected to have used mock${mock.request.variables
+                        const operation = mock.request.query.definitions.find((d) => d.kind === Kind.OPERATION_DEFINITION);
+                        const err = new Error(`Expected to have used ${operation?.operation} ${operation?.name?.value}${mock.request.variables
                             ? ` with variables ${dntShim.Deno.inspect(mock.request.variables, {
                                 depth: Infinity,
                                 colors: true,
@@ -113,5 +132,30 @@ export const MockProvider = ({ mocks, stack: renderStack, children }) => {
         // @ts-ignore It's fine
         return ApolloLink.from([errorLoggingLink, mockLink]);
     }, [observableMocks, renderStack]);
-    return React.createElement(MockedProvider, { link: link }, children);
+    if (_failRefetchWarnings) {
+        const oldWarn = console.warn.bind(console.warn);
+        console.warn = (message, operation, ...etc) => {
+            if (message !==
+                'Unknown query named "%s" requested in refetchQueries in options.include array') {
+                return oldWarn(message, operation, ...etc);
+            }
+            try {
+                fail({
+                    name: "Error",
+                    message: `Expected query ${operation} requested in refetchQueries options.include array to have bene mocked`,
+                    stack: renderStack,
+                });
+            }
+            catch {
+                // eat
+            }
+        };
+        afterTest.push(() => {
+            console.warn = oldWarn;
+        });
+    }
+    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.3",
+  "version": "0.3.0-alpha.5",
   "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 = void 0;
+exports.MockProvider = 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");
@@ -38,18 +38,11 @@ jasmine.getEnv().addReporter({
 });
 const afterTest = [];
 afterEach(async () => {
-    for (const hook of afterTest)
+    const hooks = afterTest.splice(0);
+    for (const hook of hooks)
         await hook();
-    afterTest.splice(0);
 });
-const diff = (a, b) => (0, jest_diff_1.diff)(a, b, {
-    omitAnnotationLines: true,
-    // aColor: green,
-    // bColor: red,
-    // changeColor: inverse,
-    // commonColor: dim,
-    // patchColor: yellow,
-})
+const diff = (a, b) => (0, jest_diff_1.diff)(a, b, { omitAnnotationLines: true })
     ?.replace(/\w+ \{/g, "{") // Remove class names
     .replace(/\w+ \[/g, "["); // Remove array class names
 const getErrorMessage = (operation, mockLink) => {
@@ -64,7 +57,7 @@ const getErrorMessage = (operation, mockLink) => {
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     const alts = (mockLink
         .mockedResponsesByKey[key] ?? []);
-    let errorMessage = `Expected GraphQL ${operationType} ${operation.operationName} to have been mocked`;
+    let errorMessage = `Expected ${operationType} ${operation.operationName} to have been mocked`;
     if (alts.length || Object.keys(operation.variables).length > 0) {
         errorMessage += ` with variables ${dntShim.Deno.inspect(operation.variables, { depth: Infinity, colors: true })}`;
     }
@@ -87,13 +80,39 @@ const getErrorMessage = (operation, mockLink) => {
             : undefined,
     };
 };
+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`.
+ */
+const failRefetchWarnings = (value = true) => _failRefetchWarnings = value;
+exports.failRefetchWarnings = failRefetchWarnings;
+const AutoWatch = ({ mocks }) => {
+    const client = (0, client_1.useApolloClient)();
+    for (const mock of mocks)
+        if (mock.watch)
+            client.watchQuery(mock.request);
+    return null;
+};
 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;
@@ -104,7 +123,8 @@ const MockProvider = ({ mocks, stack: renderStack, children }) => {
                     if (currentSpecResult.failedExpectations.length)
                         return;
                     if (mock.result.mock.calls.length === 0) {
-                        const err = new Error(`Expected to have used mock${mock.request.variables
+                        const operation = mock.request.query.definitions.find((d) => d.kind === graphql_1.Kind.OPERATION_DEFINITION);
+                        const err = new Error(`Expected to have used ${operation?.operation} ${operation?.name?.value}${mock.request.variables
                             ? ` with variables ${dntShim.Deno.inspect(mock.request.variables, {
                                 depth: Infinity,
                                 colors: true,
@@ -119,9 +139,9 @@ 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 }) => {
+        const errorLoggingLink = new error_1.ErrorLink(({ networkError, operation }) => {
             if (!networkError?.message.includes("No more mocked responses"))
                 return;
             const { message, stack: altStack } = getErrorMessage(operation, mockLink);
@@ -139,6 +159,31 @@ const MockProvider = ({ mocks, stack: renderStack, children }) => {
         // @ts-ignore It's fine
         return client_1.ApolloLink.from([errorLoggingLink, mockLink]);
     }, [observableMocks, renderStack]);
-    return react_1.default.createElement(index_js_2.MockedProvider, { link: link }, children);
+    if (_failRefetchWarnings) {
+        const oldWarn = console.warn.bind(console.warn);
+        console.warn = (message, operation, ...etc) => {
+            if (message !==
+                'Unknown query named "%s" requested in refetchQueries in options.include array') {
+                return oldWarn(message, operation, ...etc);
+            }
+            try {
+                fail({
+                    name: "Error",
+                    message: `Expected query ${operation} requested in refetchQueries options.include array to have bene mocked`,
+                    stack: renderStack,
+                });
+            }
+            catch {
+                // eat
+            }
+        };
+        afterTest.push(() => {
+            console.warn = oldWarn;
+        });
+    }
+    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,5 +1,12 @@
 import React from "react";
 import type { OperationMock } from "./types.js";
+/**
+ * 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`.
+ */
+export declare const failRefetchWarnings: (value?: boolean) => boolean;
 export declare const MockProvider: ({ mocks, stack: renderStack, children }: {
     mocks: OperationMock[];
     stack?: string;

package/types/types.d.ts

@@ -28,6 +28,7 @@ export type OperationMock<Data extends Record<string, unknown> = Record<string,
     };
     error?: Error;
     stack?: string;
+    watch?: boolean;
 };
 export type SimpleOperationMock<Data extends Record<string, unknown> = Record<string, unknown>, Variables = Record<string, unknown> | never> = {
     data: Data;