graphql-data-generator 0.4.0-alpha.6 → 0.4.0-alpha.8

package/README.md

@@ -279,10 +279,38 @@ be helpful to disable asserting all requests are mocked. A helper,
 `allowMissingMocks`, exists to disable these assertions and can be called before
 any tests.
 
+### Issues
+
+#### Refetch warnings
+
 If you are using an old version of `@apollo/client`, missing refetch requests
 will emit warnings instead of errors. You can use `failRefetchWarnings` to
 convert these warnings to errors.
 
+#### Early unmounts
+
+`@testing-library/react` automatically registers an `afterEach` hook to clean up
+the DOM after each test. Similarly, `graphql-data-generator` adds its own
+`afterEach` hook to verify that all mocks are consumed by the end of the test.
+
+This can lead to unexpected errors or noisy logs if the DOM is unmounted before
+`graphql-data-generator` runs its checks.
+
+To avoid this, `graphql-data-generator` disables `@testing-library/react`'s
+cleanup by default — **but only if it is loaded first**. If you can’t guarantee
+the load order, you should manually disable the automatic cleanup:
+
+```ts
+import "npm:@testing-library/react/dont-cleanup-after-each";
+```
+
+If instead you want to disable `graphql-data-generator`'s cleanup behavior,
+call:
+
+```ts
+import { skipCleanupAfterEach } from "graphql-data-generator";
+```
+
 ## Extra
 
 The `init` function supports a 6th optional generic parameter, `Extra`, which

package/esm/jest.js

@@ -8,10 +8,20 @@ import { Kind, print } from "graphql";
 import { diff as jestDiff } from "jest-diff";
 import "@testing-library/react/dont-cleanup-after-each";
 import { cleanup } from "@testing-library/react";
+import { addTypenameToDocument } from "@apollo/client/utilities";
 let currentSpecResult;
-jasmine.getEnv().addReporter({
+globalThis.jasmine
+    ?.getEnv()
+    .addReporter({
     specStarted: (result) => currentSpecResult = result,
 });
+const alreadyFailed = () => {
+    if ((currentSpecResult?.failedExpectations.length ?? 0) > 0)
+        return true;
+    const state = expect.getState();
+    return state.assertionCalls > state.numPassingAsserts ||
+        state.suppressedErrors.length > 0;
+};
 let _skipCleanupAfterEach = false;
 /**
  * `@testing-library/react` automatically unmounts React trees that were mounted
@@ -48,7 +58,7 @@ const getOperationInfo = (document) => {
 const getErrorMessage = (operation, mockLink) => {
     const operationType = getOperationType(operation);
     const key = JSON.stringify({
-        query: print(operation.query),
+        query: print(addTypenameToDocument(operation.query)),
     });
     // Bypassing private variable
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -83,7 +93,7 @@ let _failRefetchWarnings = false;
  * 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.
+ * `MockedProvider` is mounted.
  *
  * This is not required on modern version of `@apollo/client`.
  */
@@ -114,7 +124,7 @@ const _waitForMocks = async (mocks, { cause, timeout }) => {
             continue;
         try {
             await waitFor(() => {
-                if (currentSpecResult.failedExpectations.length)
+                if (alreadyFailed())
                     return;
                 if (mock.result.mock.calls.length === 0) {
                     throw new Error("");
@@ -134,11 +144,8 @@ const _waitForMocks = async (mocks, { cause, timeout }) => {
             }
             else if (cause)
                 err.stack = cause;
-            fail({
-                name: "Error",
-                message: err.message,
-                stack: err.stack,
-            });
+            err.stack = `${err.message}\n${err.stack?.split("\n").slice(1).join("\n")}`;
+            expect.getState().suppressedErrors.push(err);
         }
     }
 };
@@ -152,11 +159,11 @@ export const waitForMocks = async (mock = lastMocks.length, { timeout, offset =
         const matches = lastMocks.map((m, i) => [m, i])
             .filter(([m]) => getOperationName(m.request.query) === mock);
         if (matches.length <= offset) {
-            fail({
-                name: "Error",
-                message: `Expected mock ${mock} to have been mocked`,
-                stack: getStack(waitForMocks),
-            });
+            const err = new Error(`Expected mock ${mock} to have been mocked`);
+            Error.captureStackTrace(err, waitForMocks);
+            err.stack = err.message + "\n" +
+                err.stack?.split("\n").slice(1).join("\n");
+            throw err;
         }
         expect(matches.length).toBeGreaterThan(offset);
         mock = matches[offset][1] + 1;
@@ -166,6 +173,15 @@ export const waitForMocks = async (mock = lastMocks.length, { timeout, offset =
         cause: getStack(waitForMocks),
     });
 };
+const isDocument = (thing) => !!thing && typeof thing === "object" && "kind" in thing &&
+    thing.kind === "Document";
+const getBareOperationName = (operation) => {
+    if (typeof operation === "string")
+        return operation;
+    if (isDocument(operation))
+        return getOperationName(operation) ?? "<unknown>";
+    return "<unknown>";
+};
 /**
  * A wrapper for `@apollo/client/testing`, this component will assert all
  * requests have matching mocks and all defined mocks are used unless marked
@@ -190,20 +206,17 @@ export const MockedProvider = ({ mocks, stack: renderStack, children, link: pass
                 !networkError?.message?.includes("No more mocked responses"))
                 return;
             const { message, stack: altStack } = getErrorMessage(operation, mockLink);
-            try {
-                networkError.message = message;
-                if (altStack) {
-                    networkError.stack = renderStack
-                        ? `${altStack}\nCaused By: ${renderStack}`
-                        : altStack;
-                }
-                else if (renderStack)
-                    networkError.stack = renderStack;
-                fail({ name: "Error", message, stack: networkError.stack });
-            }
-            catch {
-                // fail both throws and marks the test as failed in jest; we only need the latter
+            networkError.message = message;
+            if (altStack) {
+                networkError.stack = renderStack
+                    ? `${altStack}\nCaused By: ${renderStack}`
+                    : altStack;
             }
+            else if (renderStack)
+                networkError.stack = renderStack;
+            networkError.stack = message + "\n" +
+                networkError.stack?.split("\n").slice(1).join("\n");
+            expect.getState().suppressedErrors.push(networkError);
         });
         return ApolloLink.from([
             errorLoggingLink,
@@ -215,18 +228,12 @@ export const MockedProvider = ({ mocks, stack: renderStack, children, link: pass
         const oldWarn = console.warn.bind(console.warn);
         console.warn = (message, operation, ...etc) => {
             if (typeof message !== "string" ||
-                !message.match(/Unknown query named.*refetchQueries/))
+                !message.match(/Unknown query.*refetchQueries/))
                 return oldWarn(message, operation, ...etc);
-            try {
-                fail({
-                    name: "Error",
-                    message: `Expected query ${operation} requested in refetchQueries options.include array to have been mocked`,
-                    stack: renderStack,
-                });
-            }
-            catch {
-                // eat
-            }
+            const error = new Error(`Expected query ${getBareOperationName(operation)} requested in refetchQueries options.include array to have been mocked`);
+            error.stack = error.message + "\n" +
+                renderStack?.split("\n").slice(1).join("\n");
+            expect.getState().suppressedErrors.push(error);
         };
         afterTest.push(() => {
             console.warn = oldWarn;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "graphql-data-generator",
-  "version": "0.4.0-alpha.6",
+  "version": "0.4.0-alpha.8",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/voces/graphql-data-generator.git"

package/script/jest.js

@@ -34,10 +34,20 @@ const graphql_1 = require("graphql");
 const jest_diff_1 = require("jest-diff");
 require("@testing-library/react/dont-cleanup-after-each");
 const react_2 = require("@testing-library/react");
+const utilities_1 = require("@apollo/client/utilities");
 let currentSpecResult;
-jasmine.getEnv().addReporter({
+globalThis.jasmine
+    ?.getEnv()
+    .addReporter({
     specStarted: (result) => currentSpecResult = result,
 });
+const alreadyFailed = () => {
+    if ((currentSpecResult?.failedExpectations.length ?? 0) > 0)
+        return true;
+    const state = expect.getState();
+    return state.assertionCalls > state.numPassingAsserts ||
+        state.suppressedErrors.length > 0;
+};
 let _skipCleanupAfterEach = false;
 /**
  * `@testing-library/react` automatically unmounts React trees that were mounted
@@ -75,7 +85,7 @@ const getOperationInfo = (document) => {
 const getErrorMessage = (operation, mockLink) => {
     const operationType = getOperationType(operation);
     const key = JSON.stringify({
-        query: (0, graphql_1.print)(operation.query),
+        query: (0, graphql_1.print)((0, utilities_1.addTypenameToDocument)(operation.query)),
     });
     // Bypassing private variable
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -110,7 +120,7 @@ let _failRefetchWarnings = false;
  * 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.
+ * `MockedProvider` is mounted.
  *
  * This is not required on modern version of `@apollo/client`.
  */
@@ -143,7 +153,7 @@ const _waitForMocks = async (mocks, { cause, timeout }) => {
             continue;
         try {
             await (0, dom_1.waitFor)(() => {
-                if (currentSpecResult.failedExpectations.length)
+                if (alreadyFailed())
                     return;
                 if (mock.result.mock.calls.length === 0) {
                     throw new Error("");
@@ -163,11 +173,8 @@ const _waitForMocks = async (mocks, { cause, timeout }) => {
             }
             else if (cause)
                 err.stack = cause;
-            fail({
-                name: "Error",
-                message: err.message,
-                stack: err.stack,
-            });
+            err.stack = `${err.message}\n${err.stack?.split("\n").slice(1).join("\n")}`;
+            expect.getState().suppressedErrors.push(err);
         }
     }
 };
@@ -181,11 +188,11 @@ const waitForMocks = async (mock = lastMocks.length, { timeout, offset = 0 } = {
         const matches = lastMocks.map((m, i) => [m, i])
             .filter(([m]) => getOperationName(m.request.query) === mock);
         if (matches.length <= offset) {
-            fail({
-                name: "Error",
-                message: `Expected mock ${mock} to have been mocked`,
-                stack: getStack(exports.waitForMocks),
-            });
+            const err = new Error(`Expected mock ${mock} to have been mocked`);
+            Error.captureStackTrace(err, exports.waitForMocks);
+            err.stack = err.message + "\n" +
+                err.stack?.split("\n").slice(1).join("\n");
+            throw err;
         }
         expect(matches.length).toBeGreaterThan(offset);
         mock = matches[offset][1] + 1;
@@ -196,6 +203,15 @@ const waitForMocks = async (mock = lastMocks.length, { timeout, offset = 0 } = {
     });
 };
 exports.waitForMocks = waitForMocks;
+const isDocument = (thing) => !!thing && typeof thing === "object" && "kind" in thing &&
+    thing.kind === "Document";
+const getBareOperationName = (operation) => {
+    if (typeof operation === "string")
+        return operation;
+    if (isDocument(operation))
+        return getOperationName(operation) ?? "<unknown>";
+    return "<unknown>";
+};
 /**
  * A wrapper for `@apollo/client/testing`, this component will assert all
  * requests have matching mocks and all defined mocks are used unless marked
@@ -220,20 +236,17 @@ const MockedProvider = ({ mocks, stack: renderStack, children, link: passedLink,
                 !networkError?.message?.includes("No more mocked responses"))
                 return;
             const { message, stack: altStack } = getErrorMessage(operation, mockLink);
-            try {
-                networkError.message = message;
-                if (altStack) {
-                    networkError.stack = renderStack
-                        ? `${altStack}\nCaused By: ${renderStack}`
-                        : altStack;
-                }
-                else if (renderStack)
-                    networkError.stack = renderStack;
-                fail({ name: "Error", message, stack: networkError.stack });
-            }
-            catch {
-                // fail both throws and marks the test as failed in jest; we only need the latter
+            networkError.message = message;
+            if (altStack) {
+                networkError.stack = renderStack
+                    ? `${altStack}\nCaused By: ${renderStack}`
+                    : altStack;
             }
+            else if (renderStack)
+                networkError.stack = renderStack;
+            networkError.stack = message + "\n" +
+                networkError.stack?.split("\n").slice(1).join("\n");
+            expect.getState().suppressedErrors.push(networkError);
         });
         return client_1.ApolloLink.from([
             errorLoggingLink,
@@ -245,18 +258,12 @@ const MockedProvider = ({ mocks, stack: renderStack, children, link: passedLink,
         const oldWarn = console.warn.bind(console.warn);
         console.warn = (message, operation, ...etc) => {
             if (typeof message !== "string" ||
-                !message.match(/Unknown query named.*refetchQueries/))
+                !message.match(/Unknown query.*refetchQueries/))
                 return oldWarn(message, operation, ...etc);
-            try {
-                fail({
-                    name: "Error",
-                    message: `Expected query ${operation} requested in refetchQueries options.include array to have been mocked`,
-                    stack: renderStack,
-                });
-            }
-            catch {
-                // eat
-            }
+            const error = new Error(`Expected query ${getBareOperationName(operation)} requested in refetchQueries options.include array to have been mocked`);
+            error.stack = error.message + "\n" +
+                renderStack?.split("\n").slice(1).join("\n");
+            expect.getState().suppressedErrors.push(error);
         };
         afterTest.push(() => {
             console.warn = oldWarn;

package/types/jest.d.ts

@@ -19,7 +19,7 @@ export declare const skipCleanupAfterEach: (value?: boolean) => void;
  * 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.
+ * `MockedProvider` is mounted.
  *
  * This is not required on modern version of `@apollo/client`.
  */