graphql-data-generator 0.4.0-alpha.7 → 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,6 +8,7 @@ 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;
 globalThis.jasmine
     ?.getEnv()
@@ -57,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
@@ -172,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
@@ -218,9 +228,9 @@ 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);
-            const error = new Error(`Expected query ${operation} requested in refetchQueries options.include array to have been mocked`);
+            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);

package/package.json

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

package/script/jest.js

@@ -34,6 +34,7 @@ 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;
 globalThis.jasmine
     ?.getEnv()
@@ -84,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
@@ -202,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
@@ -248,9 +258,9 @@ 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);
-            const error = new Error(`Expected query ${operation} requested in refetchQueries options.include array to have been mocked`);
+            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);