wrangler 0.0.0-fb43821 → 0.0.0-fbfc24d7

package/src/__tests__/helpers/mock-stdin.ts

@@ -0,0 +1,108 @@
+const ORIGINAL_STDIN = process.stdin;
+
+/**
+ * Mock process.stdin so that we can pipe in text for non-interactive mode tests.
+ */
+export function useMockStdin({ isTTY }: { isTTY: boolean }) {
+	const mockStdin = new MockStdIn(isTTY);
+
+	beforeEach(() => {
+		mockStdin.reset();
+		Object.defineProperty(process, "stdin", {
+			value: mockStdin,
+			configurable: true,
+			writable: false,
+		});
+	});
+
+	afterEach(() => {
+		Object.defineProperty(process, "stdin", {
+			value: ORIGINAL_STDIN,
+			configurable: true,
+			writable: false,
+		});
+	});
+
+	return mockStdin;
+}
+
+const failCallback: (value: unknown) => void = () => {
+	throw new Error(
+		"TEST FAILURE: stdin callback called before being initialized."
+	);
+};
+
+/**
+ * A mock version of `process.std`, which can be used to simulate piping data
+ * into the wrangler process in non-interactive mode.
+ */
+class MockStdIn {
+	private endCallback = failCallback;
+	private errorCallback = failCallback;
+	private chunks: string[] = [];
+	private error: Error | undefined;
+
+	/**
+	 * Set this to true if you want the stdin stream to error.
+	 */
+	throwError(error: Error) {
+		this.error = error;
+	}
+
+	/**
+	 * Call this to clean out the chunks that are queued for sending.
+	 */
+	reset() {
+		this.chunks.length = 0;
+		this.error = undefined;
+	}
+
+	/**
+	 * Queue up some chunks to be sent.
+	 */
+	send(...chunks: string[]) {
+		this.chunks.push(...chunks);
+	}
+
+	constructor(
+		/**
+		 * Used by wrangler to check whether stdin is interactive.
+		 */
+		readonly isTTY: boolean
+	) {}
+
+	/**
+	 * Used by wrangler to add event listeners.
+	 */
+	on(eventName: string, callback: () => void) {
+		switch (eventName) {
+			case "readable":
+				setImmediate(callback);
+				break;
+			case "end":
+				this.endCallback = callback;
+				break;
+			case "error":
+				this.errorCallback = callback;
+				break;
+		}
+	}
+
+	/**
+	 * Used by wrangler to get the next chunk of data in the stream.
+	 */
+	read() {
+		if (this.error) {
+			setImmediate(() => this.errorCallback(this.error));
+		}
+		if (this.chunks.length === 0) {
+			setImmediate(this.endCallback);
+		}
+		return this.chunks.shift() ?? null;
+	}
+
+	/**
+	 * Used by Ink.js to set the encoding of the stdout.
+	 */
+	setEncoding() {}
+}

package/src/__tests__/helpers/mock-web-socket.ts

@@ -0,0 +1,29 @@
+import { WebSocket } from "mock-socket";
+
+/**
+ * A version of the mock WebSocket that supports the methods that we use.
+ */
+export class MockWebSocket extends WebSocket {
+	on(event: string | symbol, listener: (...args: unknown[]) => void): this {
+		switch (event) {
+			case "message":
+				this.onmessage = ({ data }) => {
+					listener(data);
+				};
+				break;
+			case "open":
+				this.onopen = listener;
+				break;
+			case "close":
+				this.onclose = listener;
+				break;
+			default:
+				throw new Error("Unknown event type: " + event.toString());
+		}
+		return this;
+	}
+
+	terminate() {
+		this.close();
+	}
+}

package/src/__tests__/helpers/run-in-tmp.ts

@@ -0,0 +1,38 @@
+import * as fs from "node:fs";
+import os from "node:os";
+import * as path from "node:path";
+import { reinitialiseAuthTokens } from "../../user";
+
+const originalCwd = process.cwd();
+
+export function runInTempDir({ homedir } = { homedir: "./home" }) {
+	let tmpDir: string;
+
+	beforeEach(() => {
+		// Use realpath because the temporary path can point to a symlink rather than the actual path.
+		tmpDir = fs.realpathSync(
+			fs.mkdtempSync(path.join(os.tmpdir(), "wrangler-tests"))
+		);
+
+		process.chdir(tmpDir);
+		// The path that is returned from `homedir()` should be absolute.
+		const absHomedir = path.resolve(tmpDir, homedir);
+		// Override where the home directory is so that we can write our own user config,
+		// without destroying the real thing.
+		fs.mkdirSync(absHomedir, { recursive: true });
+		// Note it is very important that we use the "default" value from "node:os" (e.g. `import os from "node:os";`)
+		// rather than an alias to the module (e.g. `import * as os from "node:os";`).
+		// This is because the module gets transpiled so that the "method" `homedir()` gets converted to a
+		// getter that is not configurable (and so cannot be spied upon).
+		jest.spyOn(os, "homedir")?.mockReturnValue(absHomedir);
+		// Now that we have changed the home directory location, we must reinitialize the user auth state
+		reinitialiseAuthTokens();
+	});
+
+	afterEach(() => {
+		if (fs.existsSync(tmpDir)) {
+			process.chdir(originalCwd);
+			fs.rmSync(tmpDir, { recursive: true });
+		}
+	});
+}

package/src/__tests__/helpers/run-wrangler.ts

@@ -0,0 +1,16 @@
+import { main } from "../../index";
+import { normalizeSlashes, stripTimings } from "./mock-console";
+
+/**
+ * A helper to 'run' wrangler commands for tests.
+ */
+export async function runWrangler(cmd?: string) {
+	try {
+		await main(cmd?.split(" ") ?? []);
+	} catch (err) {
+		if (err instanceof Error) {
+			err.message = normalizeSlashes(stripTimings(err.message));
+		}
+		throw err;
+	}
+}

package/src/__tests__/helpers/write-worker-source.ts

@@ -0,0 +1,31 @@
+import fs from "node:fs";
+
+/** Write a mock Worker script to disk. */
+export function writeWorkerSource({
+	basePath = ".",
+	format = "js",
+	type = "esm",
+}: {
+	basePath?: string;
+	format?: "js" | "ts" | "jsx" | "tsx" | "mjs";
+	type?: "esm" | "sw";
+} = {}) {
+	if (basePath !== ".") {
+		fs.mkdirSync(basePath, { recursive: true });
+	}
+	fs.writeFileSync(
+		`${basePath}/index.${format}`,
+		type === "esm"
+			? `import { foo } from "./another";
+      export default {
+        async fetch(request) {
+          return new Response('Hello' + foo);
+        },
+      };`
+			: `import { foo } from "./another";
+      addEventListener('fetch', event => {
+        event.respondWith(new Response('Hello' + foo));
+      })`
+	);
+	fs.writeFileSync(`${basePath}/another.${format}`, `export const foo = 100;`);
+}

package/src/__tests__/helpers/write-wrangler-toml.ts

@@ -0,0 +1,17 @@
+import * as fs from "fs";
+import TOML from "@iarna/toml";
+import type { RawConfig } from "../../config";
+
+/** Write a mock wrangler.toml file to disk. */
+export default function writeWranglerToml(config: RawConfig = {}) {
+	fs.writeFileSync(
+		"./wrangler.toml",
+		TOML.stringify({
+			compatibility_date: "2022-01-12",
+			name: "test-name",
+			...(config as TOML.JsonMap),
+		}),
+
+		"utf-8"
+	);
+}

package/src/__tests__/https-options.test.ts

@@ -0,0 +1,163 @@
+import fs from "node:fs";
+import os from "node:os";
+import path from "node:path";
+import { getGlobalWranglerConfigPath } from "../global-wrangler-config-path";
+import { getHttpsOptions } from "../https-options";
+import { mockConsoleMethods } from "./helpers/mock-console";
+import { runInTempDir } from "./helpers/run-in-tmp";
+
+describe("getHttpsOptions()", () => {
+	runInTempDir();
+	const std = mockConsoleMethods();
+
+	it("should use cached values if they have not expired", async () => {
+		fs.mkdirSync(path.resolve(getGlobalWranglerConfigPath(), "local-cert"), {
+			recursive: true,
+		});
+		fs.writeFileSync(
+			path.resolve(getGlobalWranglerConfigPath(), "local-cert/key.pem"),
+			"PRIVATE KEY"
+		);
+		fs.writeFileSync(
+			path.resolve(getGlobalWranglerConfigPath(), "local-cert/cert.pem"),
+			"PUBLIC KEY"
+		);
+		const result = await getHttpsOptions();
+		expect(result.key).toEqual("PRIVATE KEY");
+		expect(result.cert).toEqual("PUBLIC KEY");
+		expect(std.out).toMatchInlineSnapshot(`""`);
+		expect(std.warn).toMatchInlineSnapshot(`""`);
+		expect(std.err).toMatchInlineSnapshot(`""`);
+	});
+
+	it("should generate and cache new keys if none are cached", async () => {
+		const result = await getHttpsOptions();
+		const key = fs.readFileSync(
+			path.resolve(getGlobalWranglerConfigPath(), "local-cert/key.pem"),
+			"utf8"
+		);
+		const cert = fs.readFileSync(
+			path.resolve(getGlobalWranglerConfigPath(), "local-cert/cert.pem"),
+			"utf8"
+		);
+		expect(result.key).toEqual(key);
+		expect(result.cert).toEqual(cert);
+		expect(std.out).toMatchInlineSnapshot(
+			`"Generating new self-signed certificate..."`
+		);
+		expect(std.warn).toMatchInlineSnapshot(`""`);
+		expect(std.err).toMatchInlineSnapshot(`""`);
+	});
+
+	it("should generate and cache new keys if cached files have expired", async () => {
+		fs.mkdirSync(path.resolve(getGlobalWranglerConfigPath(), "local-cert"), {
+			recursive: true,
+		});
+		const ORIGINAL_KEY = "EXPIRED PRIVATE KEY";
+		const ORIGINAL_CERT = "EXPIRED PUBLIC KEY";
+		fs.writeFileSync(
+			path.resolve(getGlobalWranglerConfigPath(), "local-cert/key.pem"),
+			ORIGINAL_KEY
+		);
+		fs.writeFileSync(
+			path.resolve(getGlobalWranglerConfigPath(), "local-cert/cert.pem"),
+			ORIGINAL_CERT
+		);
+		mockStatSync(/\.pem$/, { mtimeMs: new Date(2000).valueOf() });
+
+		const result = await getHttpsOptions();
+		const key = fs.readFileSync(
+			path.resolve(getGlobalWranglerConfigPath(), "local-cert/key.pem"),
+			"utf8"
+		);
+		const cert = fs.readFileSync(
+			path.resolve(getGlobalWranglerConfigPath(), "local-cert/cert.pem"),
+			"utf8"
+		);
+		expect(key).not.toEqual(ORIGINAL_KEY);
+		expect(cert).not.toEqual(ORIGINAL_CERT);
+		expect(result.key).toEqual(key);
+		expect(result.cert).toEqual(cert);
+		expect(std.out).toMatchInlineSnapshot(
+			`"Generating new self-signed certificate..."`
+		);
+		expect(std.warn).toMatchInlineSnapshot(`""`);
+		expect(std.err).toMatchInlineSnapshot(`""`);
+	});
+
+	it("should warn if not able to write to the cache (legacy config path)", async () => {
+		fs.mkdirSync(path.join(os.homedir(), ".wrangler"));
+		mockWriteFileSyncThrow(/\.pem$/);
+		await getHttpsOptions();
+		expect(
+			fs.existsSync(
+				path.resolve(getGlobalWranglerConfigPath(), "local-cert/key.pem")
+			)
+		).toBe(false);
+		expect(
+			fs.existsSync(
+				path.resolve(getGlobalWranglerConfigPath(), "local-cert/cert.pem")
+			)
+		).toBe(false);
+		expect(std.out).toMatchInlineSnapshot(
+			`"Generating new self-signed certificate..."`
+		);
+		expect(std.warn).toMatchInlineSnapshot(`
+		      "▲ [WARNING] Unable to cache generated self-signed certificate in home/.wrangler/local-cert.
+
+		        ERROR: Cannot write file
+
+		      "
+	    `);
+		expect(std.err).toMatchInlineSnapshot(`""`);
+		fs.rmSync(path.join(os.homedir(), ".wrangler"), { recursive: true });
+	});
+
+	it("should warn if not able to write to the cache", async () => {
+		mockWriteFileSyncThrow(/\.pem$/);
+		await getHttpsOptions();
+		expect(
+			fs.existsSync(
+				path.resolve(getGlobalWranglerConfigPath(), "local-cert/key.pem")
+			)
+		).toBe(false);
+		expect(
+			fs.existsSync(
+				path.resolve(getGlobalWranglerConfigPath(), "local-cert/cert.pem")
+			)
+		).toBe(false);
+		expect(std.out).toMatchInlineSnapshot(
+			`"Generating new self-signed certificate..."`
+		);
+		expect(std.warn).toMatchInlineSnapshot(`
+		"▲ [WARNING] Unable to cache generated self-signed certificate in test-xdg-config/local-cert.
+
+		  ERROR: Cannot write file
+
+		"
+	`);
+		expect(std.err).toMatchInlineSnapshot(`""`);
+	});
+});
+
+function mockStatSync(matcher: RegExp, stats: Partial<fs.Stats>) {
+	const originalStatSync = jest.requireActual("node:fs").statSync;
+	jest.spyOn(fs, "statSync").mockImplementation((statPath, options) => {
+		return matcher.test(statPath.toString())
+			? (stats as fs.Stats)
+			: originalStatSync(statPath, options);
+	});
+}
+
+function mockWriteFileSyncThrow(matcher: RegExp) {
+	const originalWriteFileSync = jest.requireActual("node:fs").writeFileSync;
+	jest
+		.spyOn(fs, "writeFileSync")
+		.mockImplementation((filePath, data, options) => {
+			if (matcher.test(filePath.toString())) {
+				throw new Error("ERROR: Cannot write file");
+			} else {
+				return originalWriteFileSync(filePath, data, options);
+			}
+		});
+}