graphql-data-generator 0.3.0-alpha.10 → 0.3.0-alpha.11

package/esm/jest.js

@@ -19,11 +19,19 @@ afterEach(async () => {
 const diff = (a, b) => jestDiff(a, b, { omitAnnotationLines: true })
     ?.replace(/\w+ \{/g, "{") // Remove class names
     .replace(/\w+ \[/g, "["); // Remove array class names
+const getOperationDefinition = (document) => document.definitions.find((d) => d.kind === Kind.OPERATION_DEFINITION);
+const getOperationType = (operation) => getOperationDefinition(operation.query)?.operation ??
+    "<unknown operation type>";
+const getOperationName = (document) => getOperationDefinition(document)?.name?.value;
+const getOperationInfo = (document) => {
+    const def = getOperationDefinition(document);
+    return {
+        name: def?.name?.value ?? "<unknown operation>",
+        operationType: def?.operation ?? "<unknown operation type>",
+    };
+};
 const getErrorMessage = (operation, mockLink) => {
-    const definition = operation.query.definitions[0];
-    const operationType = definition.kind === "OperationDefinition"
-        ? definition.operation
-        : "<unknown operation type>";
+    const operationType = getOperationType(operation);
     const key = JSON.stringify({
         query: print(operation.query),
     });
@@ -78,6 +86,55 @@ const AutoWatch = ({ mocks }) => {
             client.watchQuery(mock.request);
     return null;
 };
+let lastMocks = [];
+// deno-lint-ignore ban-types
+const getStack = (to) => {
+    const obj = {};
+    Error.captureStackTrace(obj, to);
+    return obj.stack;
+};
+const _waitForMocks = async (mocks, cause) => {
+    for (const mock of mocks) {
+        if (mock.optional || mock.error)
+            continue;
+        await waitFor(() => {
+            if (currentSpecResult.failedExpectations.length)
+                return;
+            if (mock.result.mock.calls.length === 0) {
+                const { name, operationType } = getOperationInfo(mock.request.query);
+                const err = new Error(`Expected to have used ${operationType} ${name}${mock.request.variables
+                    ? ` with variables ${dntShim.Deno.inspect(mock.request.variables, {
+                        depth: Infinity,
+                        colors: true,
+                    })}`
+                    : ""}`);
+                err.stack = `${mock.stack}${cause ? `\nCaused by: ${cause}` : ""}`;
+                throw err;
+            }
+        });
+    }
+};
+/**
+ * Wait for mocks to have been used.
+ * @param mock If `undefined`, waits for all mocks. If a number, waits fort he first `mocks` mocks. If a string, waits for all mocks up until and including that mock.
+ * @param offset If `mocks` is a string, grabs the `offset`th mock of that name (e.g., the third `getReport` mock)
+ */
+export const waitForMocks = async (mock = lastMocks.length, offset = 0) => {
+    if (typeof mock === "string") {
+        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),
+            });
+        }
+        expect(matches.length).toBeGreaterThan(offset);
+        mock = matches[offset][1] + 1;
+    }
+    await _waitForMocks(lastMocks.slice(0, mock), getStack(waitForMocks));
+};
 /**
  * A wrapper for `@apollo/client/testing`, this component will assert all
  * requests have matching mocks and all defined mocks are used unless marked
@@ -85,12 +142,15 @@ const AutoWatch = ({ mocks }) => {
  */
 export const MockProvider = ({ mocks, stack: renderStack, children, link: passedLink, ...rest }) => {
     const observableMocks = useMemo(() => {
-        const observableMocks = mocks.flatMap((m) => [
-            {
-                ...m,
-                stack: m.stack,
-                result: Object.assign(jest.fn(() => m.result), m.result),
-            },
+        const observableMocks = mocks.map((m) => ({
+            ...m,
+            stack: m.stack,
+            result: Object.assign(jest.fn(() => m.result), m.result),
+        }));
+        lastMocks = observableMocks;
+        afterTest.push(() => _waitForMocks(lastMocks, renderStack));
+        return observableMocks.flatMap((m) => [
+            m,
             ...(m.watch
                 ? [{
                         ...m,
@@ -100,30 +160,6 @@ export const MockProvider = ({ mocks, stack: renderStack, children, link: passed
                     }]
                 : []),
         ]);
-        afterTest.push(async () => {
-            if (currentSpecResult.failedExpectations.length)
-                return;
-            for (const mock of observableMocks) {
-                if (mock.optional || mock.error)
-                    continue;
-                await waitFor(() => {
-                    if (currentSpecResult.failedExpectations.length)
-                        return;
-                    if (mock.result.mock.calls.length === 0) {
-                        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,
-                            })}`
-                            : ""}`);
-                        err.stack = mock.stack ?? renderStack ?? err.stack;
-                        throw err;
-                    }
-                }, { onTimeout: (e) => e });
-            }
-        });
-        return observableMocks;
     }, [mocks]);
     const link = useMemo(() => {
         const mockLink = new MockLink(observableMocks);

package/package.json

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

package/script/jest.js

@@ -23,7 +23,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.MockProvider = exports.allowMissingMocks = exports.failRefetchWarnings = void 0;
+exports.MockProvider = exports.waitForMocks = 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");
@@ -45,11 +45,19 @@ afterEach(async () => {
 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 getOperationDefinition = (document) => document.definitions.find((d) => d.kind === graphql_1.Kind.OPERATION_DEFINITION);
+const getOperationType = (operation) => getOperationDefinition(operation.query)?.operation ??
+    "<unknown operation type>";
+const getOperationName = (document) => getOperationDefinition(document)?.name?.value;
+const getOperationInfo = (document) => {
+    const def = getOperationDefinition(document);
+    return {
+        name: def?.name?.value ?? "<unknown operation>",
+        operationType: def?.operation ?? "<unknown operation type>",
+    };
+};
 const getErrorMessage = (operation, mockLink) => {
-    const definition = operation.query.definitions[0];
-    const operationType = definition.kind === "OperationDefinition"
-        ? definition.operation
-        : "<unknown operation type>";
+    const operationType = getOperationType(operation);
     const key = JSON.stringify({
         query: (0, graphql_1.print)(operation.query),
     });
@@ -106,6 +114,56 @@ const AutoWatch = ({ mocks }) => {
             client.watchQuery(mock.request);
     return null;
 };
+let lastMocks = [];
+// deno-lint-ignore ban-types
+const getStack = (to) => {
+    const obj = {};
+    Error.captureStackTrace(obj, to);
+    return obj.stack;
+};
+const _waitForMocks = async (mocks, cause) => {
+    for (const mock of mocks) {
+        if (mock.optional || mock.error)
+            continue;
+        await (0, dom_1.waitFor)(() => {
+            if (currentSpecResult.failedExpectations.length)
+                return;
+            if (mock.result.mock.calls.length === 0) {
+                const { name, operationType } = getOperationInfo(mock.request.query);
+                const err = new Error(`Expected to have used ${operationType} ${name}${mock.request.variables
+                    ? ` with variables ${dntShim.Deno.inspect(mock.request.variables, {
+                        depth: Infinity,
+                        colors: true,
+                    })}`
+                    : ""}`);
+                err.stack = `${mock.stack}${cause ? `\nCaused by: ${cause}` : ""}`;
+                throw err;
+            }
+        });
+    }
+};
+/**
+ * Wait for mocks to have been used.
+ * @param mock If `undefined`, waits for all mocks. If a number, waits fort he first `mocks` mocks. If a string, waits for all mocks up until and including that mock.
+ * @param offset If `mocks` is a string, grabs the `offset`th mock of that name (e.g., the third `getReport` mock)
+ */
+const waitForMocks = async (mock = lastMocks.length, offset = 0) => {
+    if (typeof mock === "string") {
+        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),
+            });
+        }
+        expect(matches.length).toBeGreaterThan(offset);
+        mock = matches[offset][1] + 1;
+    }
+    await _waitForMocks(lastMocks.slice(0, mock), getStack(exports.waitForMocks));
+};
+exports.waitForMocks = waitForMocks;
 /**
  * A wrapper for `@apollo/client/testing`, this component will assert all
  * requests have matching mocks and all defined mocks are used unless marked
@@ -113,12 +171,15 @@ const AutoWatch = ({ mocks }) => {
  */
 const MockProvider = ({ mocks, stack: renderStack, children, link: passedLink, ...rest }) => {
     const observableMocks = (0, react_1.useMemo)(() => {
-        const observableMocks = mocks.flatMap((m) => [
-            {
-                ...m,
-                stack: m.stack,
-                result: Object.assign(jest.fn(() => m.result), m.result),
-            },
+        const observableMocks = mocks.map((m) => ({
+            ...m,
+            stack: m.stack,
+            result: Object.assign(jest.fn(() => m.result), m.result),
+        }));
+        lastMocks = observableMocks;
+        afterTest.push(() => _waitForMocks(lastMocks, renderStack));
+        return observableMocks.flatMap((m) => [
+            m,
             ...(m.watch
                 ? [{
                         ...m,
@@ -128,30 +189,6 @@ const MockProvider = ({ mocks, stack: renderStack, children, link: passedLink, .
                     }]
                 : []),
         ]);
-        afterTest.push(async () => {
-            if (currentSpecResult.failedExpectations.length)
-                return;
-            for (const mock of observableMocks) {
-                if (mock.optional || mock.error)
-                    continue;
-                await (0, dom_1.waitFor)(() => {
-                    if (currentSpecResult.failedExpectations.length)
-                        return;
-                    if (mock.result.mock.calls.length === 0) {
-                        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,
-                            })}`
-                            : ""}`);
-                        err.stack = mock.stack ?? renderStack ?? err.stack;
-                        throw err;
-                    }
-                }, { onTimeout: (e) => e });
-            }
-        });
-        return observableMocks;
     }, [mocks]);
     const link = (0, react_1.useMemo)(() => {
         const mockLink = new testing_1.MockLink(observableMocks);

package/types/jest.d.ts

@@ -16,6 +16,12 @@ export declare const failRefetchWarnings: (value?: boolean) => boolean;
  * migration.
  */
 export declare const allowMissingMocks: (value: true) => true;
+/**
+ * Wait for mocks to have been used.
+ * @param mock If `undefined`, waits for all mocks. If a number, waits fort he first `mocks` mocks. If a string, waits for all mocks up until and including that mock.
+ * @param offset If `mocks` is a string, grabs the `offset`th mock of that name (e.g., the third `getReport` mock)
+ */
+export declare const waitForMocks: (mock?: number | string, offset?: number) => Promise<void>;
 /**
  * A wrapper for `@apollo/client/testing`, this component will assert all
  * requests have matching mocks and all defined mocks are used unless marked