Move findWranglerConfig tests to workers-utils (#11349)

* Move findWranglerConfig tests to workers-utils

What appeared to be a simple move turned into quite a lot of changes.
But they are all for the betterment of society and general wellbeing of civilization.

* rename `test` entry-point to `test-helpers`

* add changeset

Author: petebacondarwin

.changeset/cold-hands-occur.md

@@ -0,0 +1,5 @@
+---
+"@cloudflare/workers-utils": patch
+---
+
+Adds a new `test-helpers` entry-point to the workers-utils package

.vscode/settings.json

@@ -8,6 +8,7 @@
 		"cfetch",
 		"chatgpt",
 		"clipboardy",
+		"cloudchamber",
 		"cloudflareaccess",
 		"cloudflared",
 		"Codespaces",

packages/workers-utils/package.json

@@ -14,11 +14,16 @@
 	"license": "MIT OR Apache-2.0",
 	"author": "[email protected]",
 	"exports": {
-		"browser": "./dist/browser.mjs",
-		"import": "./dist/index.mjs"
+		".": {
+			"browser": "./dist/browser.mjs",
+			"import": "./dist/index.mjs",
+			"types": "./dist/index.d.mts"
+		},
+		"./test-helpers": {
+			"import": "./dist/test-helpers/index.mjs",
+			"types": "./dist/test-helpers/index.d.mts"
+		}
 	},
-	"main": "dist/index.mjs",
-	"types": "dist/index.d.mts",
 	"files": [
 		"dist"
 	],

packages/workers-utils/src/test-helpers/index.ts

@@ -0,0 +1,11 @@
+export { mockConsoleMethods } from "./mock-console";
+export {
+	normalizeString,
+	mockCreateDate,
+	mockEndDate,
+	mockModifiedDate,
+	mockQueuedDate,
+	mockStartDate,
+} from "./normalize";
+export { runInTempDir } from "./run-in-tmp";
+export { seed } from "./seed";

packages/workers-utils/src/test-helpers/mock-console.ts

@@ -0,0 +1,89 @@
+import * as util from "node:util";
+import { afterEach, beforeEach, vi } from "vitest";
+import { normalizeString } from "./normalize";
+import type { MockInstance } from "vitest";
+
+/**
+ * We use this module to mock console methods, and optionally
+ * assert on the values they're called with in our tests.
+ */
+
+let debugSpy: MockInstance,
+	logSpy: MockInstance,
+	infoSpy: MockInstance,
+	errorSpy: MockInstance,
+	warnSpy: MockInstance;
+
+/**
+ * An object containing the normalized output of each console method.
+ *
+ * We use `defineProperties` to add non enumerable methods to the object,
+ * so they don't show up in test assertions that iterate over the object's keys.
+ * i.e. `expect(std).toMatchInlineSnapshot('...')`;
+ */
+const std = Object.defineProperties(
+	{ debug: "", out: "", info: "", err: "", warn: "", getAndClearOut: () => "" },
+	{
+		debug: {
+			get: () => normalizeOutput(debugSpy),
+			enumerable: true,
+		},
+		out: {
+			get: () => normalizeOutput(logSpy),
+			enumerable: true,
+		},
+		info: {
+			get: () => normalizeOutput(infoSpy),
+			enumerable: true,
+		},
+		err: {
+			get: () => normalizeOutput(errorSpy),
+			enumerable: true,
+		},
+		warn: {
+			get: () => normalizeOutput(warnSpy),
+			enumerable: true,
+		},
+		/**
+		 * Return the content of the mocked stdout and clear the mock's history.
+		 *
+		 * Helpful for tests that need to assert on multiple sequential console outputs.
+		 */
+		getAndClearOut: {
+			value: () => {
+				const output = normalizeOutput(logSpy);
+				logSpy.mockClear();
+				return output;
+			},
+			enumerable: false,
+		},
+	}
+);
+
+function normalizeOutput(spy: MockInstance, join = "\n"): string {
+	return normalizeString(captureCalls(spy, join));
+}
+
+function captureCalls(spy: MockInstance, join = "\n"): string {
+	return spy.mock.calls
+		.map((args: unknown[]) => util.format("%s", ...args))
+		.join(join);
+}
+
+export function mockConsoleMethods() {
+	beforeEach(() => {
+		debugSpy = vi.spyOn(console, "debug").mockImplementation(() => {});
+		logSpy = vi.spyOn(console, "log").mockImplementation(() => {});
+		infoSpy = vi.spyOn(console, "info").mockImplementation(() => {});
+		errorSpy = vi.spyOn(console, "error").mockImplementation(() => {});
+		warnSpy = vi.spyOn(console, "warn").mockImplementation(() => {});
+	});
+	afterEach(() => {
+		debugSpy.mockRestore();
+		logSpy.mockRestore();
+		infoSpy.mockRestore();
+		errorSpy.mockRestore();
+		warnSpy.mockRestore();
+	});
+	return std;
+}

packages/wrangler/src/__tests__/helpers/normalize.ts renamed to packages/workers-utils/src/test-helpers/normalize.ts

@@ -0,0 +1,51 @@
+import * as fs from "node:fs";
+import { rm } from "node:fs/promises";
+import os from "node:os";
+import * as path from "node:path";
+import { afterEach, beforeEach, vi } from "vitest";
+
+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);
+		process.env.PWD = 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).
+		vi.spyOn(os, "homedir")?.mockReturnValue(absHomedir);
+	});
+
+	afterEach(() => {
+		if (fs.existsSync(tmpDir)) {
+			process.chdir(originalCwd);
+			process.env.PWD = originalCwd;
+			// Don't block on deleting the tmp dir
+			void rm(tmpDir).catch(() => {
+				// Best effort - try once then just move on - they are only temp files after all.
+				// It seems that Windows doesn't let us delete this, with errors like:
+				//
+				// Error: EBUSY: resource busy or locked, rmdir 'C:\Users\RUNNER~1\AppData\Local\Temp\wrangler-modules-pKJ7OQ'
+				// ⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯
+				// Serialized Error: {
+				// 	"code": "EBUSY",
+				// 	"errno": -4082,
+				// 	"path": "C:\Users\RUNNER~1\AppData\Local\Temp\wrangler-modules-pKJ7OQ",
+				// 	"syscall": "rmdir",
+			});
+		}
+	});
+}

packages/workers-utils/src/test-helpers/run-in-tmp.ts

@@ -1,7 +1,7 @@
 // Seeds the `root` directory on the file system with some data. Use in
 
-import { mkdir, writeFile } from "fs/promises";
-import path from "path";
+import { mkdir, writeFile } from "node:fs/promises";
+import path from "node:path";
 
 // combination with `dedent` for petty formatting of seeded contents.
 export async function seed(files: Record<string, string | Uint8Array>) {

packages/wrangler/src/__tests__/helpers/seed.ts renamed to packages/workers-utils/src/test-helpers/seed.ts

@@ -1,9 +1,12 @@
 import path from "node:path";
-import { findWranglerConfig } from "@cloudflare/workers-utils";
-import { mockConsoleMethods } from "../helpers/mock-console";
-import { normalizeString } from "../helpers/normalize";
-import { runInTempDir } from "../helpers/run-in-tmp";
-import { seed } from "../helpers/seed";
+import { describe, expect, it } from "vitest";
+import { findWranglerConfig } from "../../src/config/config-helpers";
+import {
+	mockConsoleMethods,
+	normalizeString,
+	runInTempDir,
+	seed,
+} from "../../src/test-helpers";
 
 describe("config findWranglerConfig()", () => {
 	runInTempDir();

packages/wrangler/src/__tests__/config/findWranglerConfig.test.ts renamed to packages/workers-utils/tests/config/findWranglerConfig.test.ts

@@ -2,7 +2,7 @@
 	"extends": "@cloudflare/workers-tsconfig/tsconfig.json",
 	"compilerOptions": {
 		"module": "preserve",
-		"types": ["node", "vitest/globals"],
+		"types": ["node"],
 		"jsx": "preserve"
 	},
 	"include": ["../*.d.ts", "**/*.ts", "**/*.tsx", "**/*.js"]