wrangler 0.0.0-e043479 → 0.0.0-e0621809

package/src/__tests__/jest.setup.ts

@@ -1,69 +1,179 @@
+import chalk from "chalk";
 import fetchMock from "jest-fetch-mock";
-import {
-  fetchInternal,
-  fetchKVGetValue,
-  getCloudflareAPIBaseURL,
-} from "../cfetch/internal";
-import { confirm, prompt } from "../dialogs";
-import { mockFetchInternal, mockFetchKVGetValue } from "./helpers/mock-cfetch";
 import { MockWebSocket } from "./helpers/mock-web-socket";
+import { msw } from "./helpers/msw";
+
+//turn off chalk for tests due to inconsistencies between operating systems
+chalk.level = 0;
+
+/**
+ * The relative path between the bundled code and the Wrangler package.
+ * This is used as a reliable way to compute paths relative to the Wrangler package
+ * in the source files, rather than relying upon `__dirname` which can change depending
+ * on whether the source files have been bundled and the location of the outdir.
+ *
+ * This is exposed in the source via the `getBasePath()` function, which should be used
+ * in place of `__dirname` and similar Node.js constants.
+ */
+(
+	global as unknown as { __RELATIVE_PACKAGE_PATH__: string }
+).__RELATIVE_PACKAGE_PATH__ = "..";
+
+// Set `LC_ALL` to fix the language as English for the messages thrown by Yargs.
+process.env.LC_ALL = "en";
+
+// Mock out getPort since we don't actually care about what ports are open in unit tests.
+jest.mock("get-port", () => {
+	return {
+		__esModule: true,
+		default: jest.fn().mockImplementation(async (options) => options.port),
+	};
+});
+
+jest.mock("child_process", () => {
+	return {
+		__esModule: true,
+		...jest.requireActual("child_process"),
+		spawnSync: jest.fn().mockImplementation(async (binary, ...args) => {
+			if (binary === "cloudflared") return { error: true };
+			return jest.requireActual("child_process").spawnSync(binary, ...args);
+		}),
+	};
+});
 
 jest.mock("ws", () => {
-  return {
-    __esModule: true,
-    default: MockWebSocket,
-  };
+	return {
+		__esModule: true,
+		default: MockWebSocket,
+	};
 });
 
 jest.mock("undici", () => {
-  return {
-    ...jest.requireActual("undici"),
-    fetch: jest.requireActual("jest-fetch-mock"),
-  };
+	return {
+		...jest.requireActual("undici"),
+		fetch: jest.requireActual("jest-fetch-mock"),
+	};
 });
 
-// Outside of the Sentry tests themselves, we mock Sentry to ensure that it doesn't actually send any data and
-// that it doesn't interfere with the rest of the tests.
-jest.mock("../reporting");
-
 fetchMock.doMock(() => {
-  // Any un-mocked fetches should throw
-  throw new Error("Unexpected fetch request");
+	// Any un-mocked fetches should throw
+	throw new Error("Unexpected fetch request");
 });
 
 jest.mock("../package-manager");
 
-jest.mock("../cfetch/internal");
-(fetchInternal as jest.Mock).mockImplementation(mockFetchInternal);
-(fetchKVGetValue as jest.Mock).mockImplementation(mockFetchKVGetValue);
-(getCloudflareAPIBaseURL as jest.Mock).mockReturnValue(
-  "https://api.cloudflare.com/client/v4"
-);
+// requests not mocked with `jest-fetch-mock` fall through
+// to `mock-service-worker`
+fetchMock.dontMock();
+beforeAll(() => {
+	msw.listen({
+		onUnhandledRequest: (request) => {
+			throw new Error(
+				`No mock found for ${request.method} ${request.url.href}
+				`
+			);
+		},
+	});
+});
+afterEach(() => {
+	msw.restoreHandlers();
+	msw.resetHandlers();
+});
+afterAll(() => msw.close());
+
+jest.mock("../dev/dev", () => {
+	const { useApp } = jest.requireActual("ink");
+	const { useEffect } = jest.requireActual("react");
+	return jest.fn().mockImplementation(() => {
+		const { exit } = useApp();
+		useEffect(() => {
+			exit();
+		});
+		return null;
+	});
+});
+
+// Make sure that we don't accidentally try to open a browser window when running tests.
+// We will actually provide a mock implementation for `openInBrowser()` within relevant tests.
+jest.mock("../open-in-browser");
 
-jest.mock("../dialogs");
+// Mock the functions involved in getAuthURL so we don't take snapshots of the constantly changing URL.
+jest.mock("../user/generate-auth-url", () => {
+	return {
+		generateRandomState: jest.fn().mockImplementation(() => "MOCK_STATE_PARAM"),
+		generateAuthUrl: jest
+			.fn()
+			.mockImplementation(({ authUrl, clientId, callbackUrl, scopes }) => {
+				return (
+					authUrl +
+					`?response_type=code&` +
+					`client_id=${encodeURIComponent(clientId)}&` +
+					`redirect_uri=${encodeURIComponent(callbackUrl)}&` +
+					// we add offline_access manually for every request
+					`scope=${encodeURIComponent(
+						[...scopes, "offline_access"].join(" ")
+					)}&` +
+					`state=MOCK_STATE_PARAM&` +
+					`code_challenge=${encodeURIComponent("MOCK_CODE_CHALLENGE")}&` +
+					`code_challenge_method=S256`
+				);
+			}),
+	};
+});
+
+jest.mock("../is-ci", () => {
+	return { CI: { isCI: jest.fn().mockImplementation(() => false) } };
+});
 
-// By default (if not configured by mockConfirm()) calls to `confirm()` should throw.
-(confirm as jest.Mock).mockImplementation((text: string) => {
-  throw new Error(
-    `Unexpected call to \`confirm("${text}")\`.\nYou should use \`mockConfirm()\` to mock calls to \`confirm()\` with expectations. Search the codebase for \`mockConfirm\` to learn more.`
-  );
+jest.mock("../user/generate-random-state", () => {
+	return {
+		generateRandomState: jest.fn().mockImplementation(() => "MOCK_STATE_PARAM"),
+	};
 });
 
-// By default (if not configured by mockPrompt()) calls to `prompt()` should throw.
-(prompt as jest.Mock).mockImplementation((text: string) => {
-  throw new Error(
-    `Unexpected call to \`prompt(${text}, ...)\`.\nYou should use \`mockPrompt()\` to mock calls to \`prompt()\` with expectations. Search the codebase for \`mockPrompt\` to learn more.`
-  );
+jest.mock("xdg-app-paths", () => {
+	return {
+		__esModule: true,
+		default: jest.fn().mockImplementation(() => {
+			return {
+				config() {
+					return jest.requireActual("node:path").resolve("test-xdg-config");
+				},
+			};
+		}),
+	};
 });
 
-jest.mock("../dev", () => {
-  const { useApp } = jest.requireActual("ink");
-  const { useEffect } = jest.requireActual("react");
-  return jest.fn().mockImplementation(() => {
-    const { exit } = useApp();
-    useEffect(() => {
-      exit();
-    });
-    return null;
-  });
+jest.mock("../metrics/metrics-config", () => {
+	const realModule = jest.requireActual("../metrics/metrics-config");
+	const fakeModule = {
+		...realModule,
+		// Although we mock out the getMetricsConfig() function in most tests,
+		// we need a way to reinstate it for the metrics specific tests.
+		// This is what `useOriginal` is for.
+		useOriginal: false,
+		getMetricsConfig: (...args: unknown[]) =>
+			fakeModule.useOriginal
+				? realModule.getMetricsConfig(...args)
+				: async () => {
+						return {
+							enabled: false,
+							deviceId: "mock-device",
+							userId: undefined,
+						};
+				  },
+	};
+	return fakeModule;
+});
+jest.mock("prompts", () => {
+	return {
+		__esModule: true,
+		default: jest.fn((...args) => {
+			throw new Error(
+				`Unexpected call to \`prompts("${JSON.stringify(
+					args
+				)}")\`.\nYou should use \`mockConfirm()/mockSelect()/mockPrompt()\` to mock calls to \`confirm()\` with expectations.`
+			);
+		}),
+	};
 });