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

package/esm/jest.js

@@ -1,7 +1,7 @@
 import * as dntShim from "./_dnt.shims.js";
 import React, { useMemo } from "react";
 import { ApolloLink, useApolloClient, } from "@apollo/client";
-import { ErrorLink } from "@apollo/client/link/error";
+import { onError } from "@apollo/client/link/error";
 import { MockedProvider, MockLink, } from "@apollo/client/testing";
 import { waitFor } from "@testing-library/dom";
 import { Kind, print } from "graphql";
@@ -59,9 +59,18 @@ 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`.
+ * 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)
@@ -69,7 +78,12 @@ const AutoWatch = ({ mocks }) => {
             client.watchQuery(mock.request);
     return null;
 };
-export const MockProvider = ({ mocks, stack: renderStack, children }) => {
+/**
+ * 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, link: passedLink, ...rest }) => {
     const observableMocks = useMemo(() => {
         const observableMocks = mocks.flatMap((m) => [
             {
@@ -90,7 +104,7 @@ export const MockProvider = ({ mocks, stack: renderStack, children }) => {
             if (currentSpecResult.failedExpectations.length)
                 return;
             for (const mock of observableMocks) {
-                if ("optional" in mock && mock.optional || mock.error)
+                if (mock.optional || mock.error)
                     continue;
                 await waitFor(() => {
                     if (currentSpecResult.failedExpectations.length)
@@ -114,8 +128,9 @@ export const MockProvider = ({ mocks, stack: renderStack, children }) => {
     const link = useMemo(() => {
         const mockLink = new MockLink(observableMocks);
         mockLink.showWarnings = false;
-        const errorLoggingLink = new ErrorLink(({ networkError, operation }) => {
-            if (!networkError?.message.includes("No more mocked responses"))
+        const errorLoggingLink = onError(({ networkError, operation }) => {
+            if (_allowMissingMocks ||
+                !networkError?.message.includes("No more mocked responses"))
                 return;
             const { message, stack: altStack } = getErrorMessage(operation, mockLink);
             try {
@@ -129,8 +144,11 @@ export const MockProvider = ({ mocks, stack: renderStack, children }) => {
                 // fail both throws and marks the test as failed in jest; we only need the latter
             }
         });
-        // @ts-ignore It's fine
-        return ApolloLink.from([errorLoggingLink, mockLink]);
+        return ApolloLink.from([
+            errorLoggingLink,
+            mockLink,
+            ...(passedLink ? [passedLink] : []),
+        ]);
     }, [observableMocks, renderStack]);
     if (_failRefetchWarnings) {
         const oldWarn = console.warn.bind(console.warn);
@@ -154,7 +172,7 @@ export const MockProvider = ({ mocks, stack: renderStack, children }) => {
             console.warn = oldWarn;
         });
     }
-    return (React.createElement(MockedProvider, { link: link },
+    return (React.createElement(MockedProvider, { ...rest, 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.5",
+  "version": "0.3.0-alpha.7",
   "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.failRefetchWarnings = 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");
@@ -85,10 +85,20 @@ 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`.
+ * 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)
@@ -96,7 +106,12 @@ const AutoWatch = ({ mocks }) => {
             client.watchQuery(mock.request);
     return null;
 };
-const MockProvider = ({ mocks, stack: renderStack, children }) => {
+/**
+ * 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, link: passedLink, ...rest }) => {
     const observableMocks = (0, react_1.useMemo)(() => {
         const observableMocks = mocks.flatMap((m) => [
             {
@@ -117,7 +132,7 @@ const MockProvider = ({ mocks, stack: renderStack, children }) => {
             if (currentSpecResult.failedExpectations.length)
                 return;
             for (const mock of observableMocks) {
-                if ("optional" in mock && mock.optional || mock.error)
+                if (mock.optional || mock.error)
                     continue;
                 await (0, dom_1.waitFor)(() => {
                     if (currentSpecResult.failedExpectations.length)
@@ -141,8 +156,9 @@ const MockProvider = ({ mocks, stack: renderStack, children }) => {
     const link = (0, react_1.useMemo)(() => {
         const mockLink = new testing_1.MockLink(observableMocks);
         mockLink.showWarnings = false;
-        const errorLoggingLink = new error_1.ErrorLink(({ networkError, operation }) => {
-            if (!networkError?.message.includes("No more mocked responses"))
+        const errorLoggingLink = (0, error_1.onError)(({ networkError, operation }) => {
+            if (_allowMissingMocks ||
+                !networkError?.message.includes("No more mocked responses"))
                 return;
             const { message, stack: altStack } = getErrorMessage(operation, mockLink);
             try {
@@ -156,8 +172,11 @@ const MockProvider = ({ mocks, stack: renderStack, children }) => {
                 // fail both throws and marks the test as failed in jest; we only need the latter
             }
         });
-        // @ts-ignore It's fine
-        return client_1.ApolloLink.from([errorLoggingLink, mockLink]);
+        return client_1.ApolloLink.from([
+            errorLoggingLink,
+            mockLink,
+            ...(passedLink ? [passedLink] : []),
+        ]);
     }, [observableMocks, renderStack]);
     if (_failRefetchWarnings) {
         const oldWarn = console.warn.bind(console.warn);
@@ -181,7 +200,7 @@ const MockProvider = ({ mocks, stack: renderStack, children }) => {
             console.warn = oldWarn;
         });
     }
-    return (react_1.default.createElement(testing_1.MockedProvider, { link: link },
+    return (react_1.default.createElement(testing_1.MockedProvider, { ...rest, link: link },
         react_1.default.createElement(react_1.default.Fragment, null,
             react_1.default.createElement(AutoWatch, { mocks: observableMocks }),
             children)));

package/types/jest.d.ts

@@ -1,14 +1,27 @@
 import React from "react";
+import { MockedProviderProps } from "@apollo/client/testing";
 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`.
+ * 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;
-export declare const MockProvider: ({ mocks, stack: renderStack, children }: {
+/**
+ * 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, link: passedLink, ...rest }: Omit<MockedProviderProps, "mocks"> & {
     mocks: OperationMock[];
     stack?: string;
-    children?: React.ReactNode;
 }) => React.JSX.Element;

package/types/types.d.ts

@@ -29,12 +29,15 @@ 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;
@@ -42,5 +45,7 @@ export type SimpleOperationPatch<Data extends Record<string, unknown> = Record<s
 }> & {
     error?: Error;
     errors?: GraphQLError[];
+    watch?: boolean;
+    optional?: boolean;
 };
 export {};