Move the unenv tests from the preset to wrangler e2e (#10031)

Author: vicb

.changeset/gold-beans-tie.md

@@ -0,0 +1,7 @@
+---
+"@cloudflare/vite-plugin": patch
+"@cloudflare/unenv-preset": patch
+"wrangler": patch
+---
+
+wrangler and vite-plugin now depend upon the latest version of unenv-preset

packages/unenv-preset/README.md

@@ -18,3 +18,7 @@ const { alias, inject, external, polyfill } = env;
 ```
 
 See the unenv [README](https://github.com/unjs/unenv/blob/main/README.md) for more details.
+
+## Tests
+
+This package is tested via wrangler e2e tests.

packages/unenv-preset/package.json

@@ -40,19 +40,14 @@
 	"scripts": {
 		"build": "unbuild",
 		"check:lint": "eslint",
-		"check:type": "tsc --noEmit",
-		"test:ci": "vitest run",
-		"test:watch": "vitest"
+		"check:type": "tsc --noEmit"
 	},
 	"devDependencies": {
 		"@types/debug": "4.1.12",
 		"@types/node-unenv": "npm:@types/node@^22.14.0",
 		"debug": "4.4.1",
 		"typescript": "catalog:default",
-		"unbuild": "^3.2.0",
-		"undici": "catalog:default",
-		"vitest": "catalog:default",
-		"wrangler": "workspace:*"
+		"unbuild": "^3.2.0"
 	},
 	"peerDependencies": {
 		"unenv": "2.0.0-rc.17",

packages/unenv-preset/tests/index.test.ts

@@ -42,7 +42,7 @@
 		"test:watch": "vitest"
 	},
 	"dependencies": {
-		"@cloudflare/unenv-preset": "2.3.3",
+		"@cloudflare/unenv-preset": "workspace:*",
 		"@mjackson/node-fetch-server": "^0.6.1",
 		"@rollup/plugin-replace": "^6.0.1",
 		"get-port": "^7.1.0",

packages/vite-plugin-cloudflare/package.json

@@ -0,0 +1,51 @@
+/**
+ * Test building and serving locally a worker in nodejs_compat mode.
+ */
+
+import path from "node:path";
+import { fetch } from "undici";
+import { afterAll, beforeAll, describe, expect, test, vi } from "vitest";
+import { formatCompatibilityDate } from "../../src/utils/compatibility-date";
+import { WranglerE2ETestHelper } from "../helpers/e2e-wrangler-test";
+import { generateResourceName } from "../helpers/generate-resource-name";
+import { TESTS } from "./worker/index";
+import type { WranglerLongLivedCommand } from "../helpers/wrangler";
+
+describe(`@cloudflare/unenv-preset local tests`, () => {
+	let url: string;
+	let wrangler: WranglerLongLivedCommand;
+
+	beforeAll(async () => {
+		const helper = new WranglerE2ETestHelper();
+		await helper.seed({
+			"wrangler.jsonc": JSON.stringify({
+				name: generateResourceName(),
+				main: path.join(__dirname, "/worker/index.ts"),
+				compatibility_date: formatCompatibilityDate(new Date()),
+				compatibility_flags: ["nodejs_compat"],
+				vars: {
+					DEBUG: "example",
+				},
+			}),
+		});
+
+		wrangler = helper.runLongLived(`wrangler dev`, {
+			stopOnTestFinished: false,
+		});
+		url = (await wrangler.waitForReady()).url;
+	});
+
+	afterAll(async () => {
+		await wrangler.stop();
+	});
+
+	test.for(Object.keys(TESTS))("%s", { timeout: 20_000 }, async (testName) => {
+		// Retries the callback until it succeeds or times out.
+		// Useful for the i.e. DNS tests where underlying requests might error/timeout.
+		await vi.waitFor(async () => {
+			const response = await fetch(`${url}/${testName}`);
+			const body = await response.text();
+			expect(body).toMatch("OK!");
+		});
+	});
+});

packages/wrangler/e2e/unenv-preset/local.test.ts

@@ -0,0 +1,74 @@
+/**
+ * Test building and serving a worker in nodejs_compat mode.
+ * This makes sure the prod workerd is is compatible with unenv.
+ */
+
+import assert from "node:assert";
+import path from "node:path";
+import { fetch } from "undici";
+import { afterAll, beforeAll, describe, expect, test, vi } from "vitest";
+import { formatCompatibilityDate } from "../../src/utils/compatibility-date";
+import { CLOUDFLARE_ACCOUNT_ID } from "../helpers/account-id";
+import { WranglerE2ETestHelper } from "../helpers/e2e-wrangler-test";
+import { generateResourceName } from "../helpers/generate-resource-name";
+import { retry } from "../helpers/retry";
+import { TESTS } from "./worker/index";
+
+describe.skipIf(!CLOUDFLARE_ACCOUNT_ID)(
+	`@cloudflare/unenv-preset remote tests`,
+	() => {
+		let url: string;
+		let helper: WranglerE2ETestHelper;
+
+		beforeAll(async () => {
+			helper = new WranglerE2ETestHelper();
+			await helper.seed({
+				"wrangler.jsonc": JSON.stringify({
+					name: generateResourceName(),
+					main: path.join(__dirname, "/worker/index.ts"),
+					compatibility_date: formatCompatibilityDate(new Date()),
+					compatibility_flags: ["nodejs_compat"],
+					vars: {
+						DEBUG: "example",
+					},
+				}),
+			});
+
+			const { stdout } = await helper.run(`wrangler deploy`);
+
+			const match = stdout.match(
+				/(?<url>https:\/\/tmp-e2e-.+?\..+?\.workers\.dev)/
+			);
+			assert(match?.groups);
+			url = match.groups.url;
+
+			const { text } = await retry(
+				(s) => s.status !== 200,
+				async () => {
+					const r = await fetch(`${url}/ping`);
+					return { text: await r.text(), status: r.status };
+				}
+			);
+			expect(text).toEqual("pong");
+		}, 30_000);
+
+		afterAll(async () => {
+			// clean up user Worker
+			await helper.run(`wrangler delete`);
+		});
+
+		test.for(Object.keys(TESTS))(
+			"%s",
+			{ timeout: 20_000 },
+			async (testName) => {
+				// Retries the callback until it succeeds or times out.
+				// Useful for the i.e. DNS tests where underlying requests might error/timeout.
+				await vi.waitFor(async () => {
+					const response = await fetch(`${url}/${testName}`);
+					const body = await response.text();
+					expect(body).toMatch("OK!");
+				});
+			}
+		);
+	}
+);

packages/wrangler/e2e/unenv-preset/remote.test.ts

@@ -2,7 +2,7 @@ import assert from "node:assert";
 
 // List all the test functions.
 // The test can be executing by fetching the `/${testName}` url.
-export const TESTS = {
+export const TESTS: Record<string, () => void> = {
 	testCryptoGetRandomValues,
 	testImplementsBuffer,
 	testNodeCompatModules,
@@ -19,6 +19,10 @@ export default {
 	async fetch(request: Request): Promise<Response> {
 		const url = new URL(request.url);
 		const testName = url.pathname.slice(1);
+		if (testName === "ping") {
+			// Used by the deploy test to know when the worker is online
+			return new Response("pong");
+		}
 		const test = TESTS[testName];
 		if (!test) {
 			return new Response(
@@ -157,7 +161,9 @@ async function testTimers() {
 	const timers = await import("node:timers");
 	const timeout = timers.setTimeout(() => null, 1000);
 	// active is deprecated and no more in the type
-	(timers as any).active(timeout);
+	(timers as unknown as { active: (t: NodeJS.Timeout) => void }).active(
+		timeout
+	);
 	timers.clearTimeout(timeout);
 
 	const timersPromises = await import("node:timers/promises");
@@ -174,15 +180,17 @@ export async function testNet() {
 export async function testTls() {
 	const tls = await import("node:tls");
 	assert.strictEqual(typeof tls, "object");
+	// @ts-expect-error Node types are wrong
 	assert.strictEqual(typeof tls.convertALPNProtocols, "function");
 }
 
 export async function testDebug() {
+	// @ts-expect-error "@cloudflare/unenv-preset/npm/debug" is an unenv alias, it does not exist as a module.
 	const debug = await import("@cloudflare/unenv-preset/npm/debug");
 	const logs: string[] = [];
 
 	// Append all logs to the array instead of logging to console
-	debug.default.log = (...args) =>
+	debug.default.log = (...args: string[]) =>
 		logs.push(args.map((arg) => arg.toString()).join(" "));
 
 	const exampleLog = debug.default("example");

packages/unenv-preset/tests/worker/index.ts renamed to packages/wrangler/e2e/unenv-preset/worker/index.ts

@@ -67,7 +67,7 @@
 	},
 	"dependencies": {
 		"@cloudflare/kv-asset-handler": "workspace:*",
-		"@cloudflare/unenv-preset": "2.3.3",
+		"@cloudflare/unenv-preset": "workspace:*",
 		"blake3-wasm": "2.1.5",
 		"esbuild": "catalog:default",
 		"miniflare": "workspace:*",