Include serialised FormData in debug logs (#6854)

* Include serialised FormData in debug logs * Create bright-deers-rescue.md * fix tests * Fix tests * fix lint
cloudflare · Oct 3, 2024 · 04a8fed · 04a8fed
1 parent 7ca37bc
commit 04a8fed
Show file tree

Hide file tree

Showing 4 changed files with 73 additions and 6 deletions.
diff --git a/.changeset/bright-deers-rescue.md b/.changeset/bright-deers-rescue.md
@@ -0,0 +1,5 @@
+---
+"wrangler": patch
+---
+
+chore: Include serialised `FormData` in debug logs
diff --git a/packages/wrangler/src/__tests__/deploy.test.ts b/packages/wrangler/src/__tests__/deploy.test.ts
@@ -14,7 +14,6 @@ import {
 	printBundleSize,
 	printOffendingDependencies,
 } from "../deployment-bundle/bundle-reporter";
-import { logger } from "../logger";
 import { writeAuthConfigFile } from "../user";
 import { mockAccountId, mockApiToken } from "./helpers/mock-account-id";
 import { mockAuthDomain } from "./helpers/mock-auth-domain";
@@ -80,7 +79,6 @@ describe("deploy", () => {
 		mockLastDeploymentRequest();
 		mockDeploymentsListRequest();
 		msw.use(...mswListNewDeploymentsLatestFull);
-		logger.loggerLevel = "log";
 	});
 
 	afterEach(() => {
@@ -248,6 +246,40 @@ describe("deploy", () => {
 		expect(std.err).toMatchInlineSnapshot(`""`);
 	});
 
+	it("should include serialised FormData in debug logs", async () => {
+		fs.mkdirSync("./my-worker", { recursive: true });
+		fs.writeFileSync(
+			"./my-worker/wrangler.toml",
+			TOML.stringify({
+				name: "test-worker",
+				compatibility_date: "2022-01-12",
+				vars: { xyz: 123 },
+			}),
+			"utf-8"
+		);
+		writeWorkerSource({ basePath: "./my-worker" });
+		mockUploadWorkerRequest({
+			expectedScriptName: "test-worker",
+			expectedBindings: [
+				{
+					json: 123,
+					name: "xyz",
+					type: "json",
+				},
+			],
+			expectedCompatibilityDate: "2022-01-12",
+		});
+		mockSubDomainRequest();
+
+		vi.stubEnv("WRANGLER_LOG", "debug");
+		vi.stubEnv("WRANGLER_LOG_SANITIZE", "false");
+
+		await runWrangler("deploy ./my-worker/index.js");
+		expect(std.debug).toContain(
+			`{"main_module":"index.js","bindings":[{"name":"xyz","type":"json","json":123}],"compatibility_date":"2022-01-12","compatibility_flags":[]}`
+		);
+	});
+
 	it("should support wrangler.jsonc", async () => {
 		fs.mkdirSync("./my-worker", { recursive: true });
 		fs.writeFileSync(
@@ -4105,7 +4137,9 @@ addEventListener('fetch', event => {});`
 			});
 
 			it("debug log level", async () => {
-				logger.loggerLevel = "debug";
+				vi.stubEnv("WRANGLER_LOG", "debug");
+				vi.stubEnv("WRANGLER_LOG_SANITIZE", "false");
+
 				await runWrangler("deploy");
 
 				const diffRegexp = /^ [+=-]/;

diff --git a/packages/wrangler/src/cfetch/internal.ts b/packages/wrangler/src/cfetch/internal.ts
@@ -1,5 +1,5 @@
 import assert from "node:assert";
-import { fetch, File, Headers, Response } from "undici";
+import { fetch, File, FormData, Headers, Response } from "undici";
 import { version as wranglerVersion } from "../../package.json";
 import { getCloudflareApiBaseUrl } from "../environment-variables/misc-variables";
 import { UserError } from "../errors";
@@ -41,6 +41,14 @@ export async function performApiFetch(
 	logger.debugWithSanitization("HEADERS:", JSON.stringify(logHeaders, null, 2));
 
 	logger.debugWithSanitization("INIT:", JSON.stringify({ ...init }, null, 2));
+	if (init.body instanceof FormData) {
+		logger.debugWithSanitization(
+			"BODY:",
+			await new Response(init.body).text(),
+			null,
+			2
+		);
+	}
 	logger.debug("-- END CF API REQUEST");
 	return await fetch(`${getCloudflareApiBaseUrl()}${resource}${queryString}`, {
 		method,

diff --git a/packages/wrangler/src/logger.ts b/packages/wrangler/src/logger.ts
@@ -31,6 +31,17 @@ const getLogLevelFromEnv = getEnvironmentVariableFactory({
 	variableName: "WRANGLER_LOG",
 });
 
+const warnOnce = (() => {
+	let logged = false;
+
+	return (...args: Parameters<typeof console.warn>) => {
+		if (!logged) {
+			console.warn(...args);
+			logged = true;
+		}
+	};
+})();
+
 function getLoggerLevel(): LoggerLevel {
 	const fromEnv = getLogLevelFromEnv()?.toLowerCase();
 	if (fromEnv !== undefined) {
@@ -40,7 +51,7 @@ function getLoggerLevel(): LoggerLevel {
 		const expected = Object.keys(LOGGER_LEVELS)
 			.map((level) => `"${level}"`)
 			.join(" | ");
-		console.warn(
+		warnOnce(
 			`Unrecognised WRANGLER_LOG value ${JSON.stringify(
 				fromEnv
 			)}, expected ${expected}, defaulting to "log"...`
@@ -54,7 +65,16 @@ export type TableRow<Keys extends string> = Record<Keys, string>;
 export class Logger {
 	constructor() {}
 
-	loggerLevel = getLoggerLevel();
+	private overrideLoggerLevel?: LoggerLevel;
+
+	get loggerLevel() {
+		return this.overrideLoggerLevel ?? getLoggerLevel();
+	}
+
+	set loggerLevel(val) {
+		this.overrideLoggerLevel = val;
+	}
+
 	columns = process.stdout.columns;
 
 	debug = (...args: unknown[]) => this.doLog("debug", args);