feat(unenv-preset): shim debug package for cloudflare env support (#10014)

* feat(unenv-preset): shim debug package for cloudflare env support

* update patch

Author: edmundhung

.changeset/debug-shims-bundle.md

@@ -0,0 +1,5 @@
+---
+"@cloudflare/unenv-preset": minor
+---
+
+Shim `debug` npm package with patched version for cloudflare env support

package.json

@@ -79,6 +79,7 @@
 		},
 		"patchedDependencies": {
 			"@cloudflare/[email protected]": "patches/@[email protected]",
+			"[email protected]": "patches/[email protected]",
 			"[email protected]": "patches/[email protected]",
 			"[email protected]": "patches/[email protected]",
 			"[email protected]": "patches/[email protected]",

packages/unenv-preset/build.config.ts

@@ -4,9 +4,22 @@ export default defineBuildConfig({
 	declaration: true,
 	rollup: {
 		cjsBridge: true,
+		inlineDependencies: true,
+		resolve: {
+			exportConditions: ["workerd"],
+		},
 	},
+	externals: [/^cloudflare:/],
 	entries: [
 		"src/index",
-		{ input: "src/runtime/", outDir: "dist/runtime", format: "esm" },
+		// Use rollup for debug file to inline the dependency
+		"src/runtime/npm/debug",
+		// Use mkdist for the rest to preserve structure
+		{
+			input: "src/runtime/",
+			outDir: "dist/runtime",
+			format: "esm",
+			pattern: ["**", "!npm/debug.ts"],
+		},
 	],
 });

packages/unenv-preset/package.json

@@ -45,7 +45,9 @@
 		"test:watch": "vitest"
 	},
 	"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",

packages/unenv-preset/src/preset.ts

@@ -79,6 +79,9 @@ export const cloudflare: Preset = {
 				[`node:${m}`, `@cloudflare/unenv-preset/node/${m}`],
 			])
 		),
+
+		// To override the npm shim from unenv
+		debug: "@cloudflare/unenv-preset/npm/debug",
 	},
 	inject: {
 		// Setting symbols implemented by workerd to `false` so that `inject`s defined in base presets are not used.

packages/unenv-preset/src/runtime/npm/debug.ts

@@ -0,0 +1 @@
+export { default } from "debug";

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

@@ -37,8 +37,10 @@ describe(`@cloudflare/unenv-preset ${platform} ${workerdPath}`, () => {
 				const body = await response.text();
 				expect(body).toMatch("OK!");
 			});
-		} catch {
+		} catch (e) {
+			// Log the output before re-throwing the error
 			console.log("OUTPUT", await getOutput());
+			throw e;
 		}
 	});
 });

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

@@ -12,6 +12,7 @@ export const TESTS = {
 	testTimers,
 	testNet,
 	testTls,
+	testDebug,
 };
 
 export default {
@@ -175,3 +176,20 @@ export async function testTls() {
 	assert.strictEqual(typeof tls, "object");
 	assert.strictEqual(typeof tls.convertALPNProtocols, "function");
 }
+
+export async function testDebug() {
+	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) =>
+		logs.push(args.map((arg) => arg.toString()).join(" "));
+
+	const exampleLog = debug.default("example");
+	const testLog = exampleLog.extend("test");
+
+	exampleLog("This is an example log");
+	testLog("This is a test log");
+
+	assert.deepEqual(logs, ["example This is an example log +0ms"]);
+}

packages/unenv-preset/tests/worker/wrangler.json

@@ -2,5 +2,8 @@
 	"name": "cloudflare-unenv-preset-test",
 	"main": "./index.ts",
 	"compatibility_date": "2024-12-16",
-	"compatibility_flags": ["nodejs_compat"]
+	"compatibility_flags": ["nodejs_compat"],
+	"vars": {
+		"DEBUG": "example"
+	}
 }

patches/[email protected]

@@ -0,0 +1,40 @@
+diff --git a/package.json b/package.json
+index afc2f8b615b2229c7b3b818c5f4b6f90dcc99f9a..a92870c2e9bda8dfe042ec48a0ed2669e8546e22 100644
+--- a/package.json
++++ b/package.json
+@@ -53,6 +53,12 @@
+   },
+   "main": "./src/index.js",
+   "browser": "./src/browser.js",
++  "exports": {
++    "workerd": "./src/workerd.js",
++    "node": "./src/index.js",
++    "browser": "./src/browser.js",
++    "default": "./src/index.js"
++  },
+   "engines": {
+     "node": ">=6.0"
+   },
+diff --git a/src/workerd.js b/src/workerd.js
+new file mode 100644
+index 0000000000000000000000000000000000000000..ccc6e14bace87cc7bfccdf957c25f89a9e2df8ca
+--- /dev/null
++++ b/src/workerd.js
+@@ -0,0 +1,17 @@
++import { env } from "cloudflare:workers";
++import humanize from "ms";
++import setup from "./common";
++
++const createDebug = setup({
++	log: console.debug.bind(console),
++	load: () => env.DEBUG,
++	save: () => {},
++	colors: [],
++	useColors: () => false,
++	destroy: () => {},
++	formatArgs(args) {
++		args[0] = this.namespace + " " + args[0] + " +" + humanize(this.diff);
++    }
++});
++
++export default createDebug;