feat: support outputing ND-JSON files via an environment variable

.changeset/strong-rats-confess.md

@@ -0,0 +1,5 @@
+---
+"wrangler": minor
+---
+
+feat: support outputting ND-JSON files via an environment variable

packages/wrangler/src/__tests__/output.test.ts

@@ -0,0 +1,245 @@
+import { readdirSync, readFileSync } from "node:fs";
+import { join } from "node:path";
+import { clearOutputFilePath, writeOutput } from "../output";
+import { runInTempDir } from "./helpers/run-in-tmp";
+import type { OutputEntry } from "../output";
+
+const originalProcessEnv = process.env;
+const {
+	WRANGLER_OUTPUT_FILE_DIRECTORY: _,
+	WRANGLER_OUTPUT_FILE_PATH: __,
+	...processEnvNoVars
+} = originalProcessEnv;
+
+describe("writeOutput()", () => {
+	runInTempDir({ homedir: "home" });
+	afterEach(clearOutputFilePath);
+
+	it("should do nothing with no env vars set", () => {
+		try {
+			process.env = processEnvNoVars;
+			writeOutput({
+				type: "wrangler-session",
+				version: 1,
+				wrangler_version: "0.0.0.0",
+				command_line_args: ["--help"],
+				log_file_path: "some/log/path.log",
+			});
+			// No files written
+			expect(readdirSync(".")).toEqual(["home"]);
+		} finally {
+			process.env = originalProcessEnv;
+		}
+	});
+
+	it("should write to the file given by WRANGLER_OUTPUT_FILE_PATH", () => {
+		try {
+			const WRANGLER_OUTPUT_FILE_PATH = "output.json";
+			process.env = { ...processEnvNoVars, WRANGLER_OUTPUT_FILE_PATH };
+			writeOutput({
+				type: "wrangler-session",
+				version: 1,
+				wrangler_version: "0.0.0.0",
+				command_line_args: ["--help"],
+				log_file_path: "some/log/path.log",
+			});
+			const outputFile = readFileSync(WRANGLER_OUTPUT_FILE_PATH, "utf8");
+			expect(outputFile).toContainEntries([
+				{
+					type: "wrangler-session",
+					version: 1,
+					wrangler_version: "0.0.0.0",
+					command_line_args: ["--help"],
+					log_file_path: "some/log/path.log",
+				},
+			]);
+		} finally {
+			process.env = originalProcessEnv;
+		}
+	});
+
+	it("should write to the file given by WRANGLER_OUTPUT_FILE_PATH, ignoring WRANGLER_OUTPUT_FILE_DIRECTORY", () => {
+		try {
+			const WRANGLER_OUTPUT_FILE_PATH = "output.json";
+			process.env = {
+				...processEnvNoVars,
+				WRANGLER_OUTPUT_FILE_PATH,
+				WRANGLER_OUTPUT_FILE_DIRECTORY: ".",
+			};
+			writeOutput({
+				type: "wrangler-session",
+				version: 1,
+				wrangler_version: "0.0.0.0",
+				command_line_args: ["--help"],
+				log_file_path: "some/log/path.log",
+			});
+			const outputFile = readFileSync(WRANGLER_OUTPUT_FILE_PATH, "utf8");
+			expect(outputFile).toContainEntries([
+				{
+					type: "wrangler-session",
+					version: 1,
+					wrangler_version: "0.0.0.0",
+					command_line_args: ["--help"],
+					log_file_path: "some/log/path.log",
+				},
+			]);
+		} finally {
+			process.env = originalProcessEnv;
+		}
+	});
+
+	it("should write multiple entries to the file given by WRANGLER_OUTPUT_FILE_PATH", () => {
+		try {
+			const WRANGLER_OUTPUT_FILE_PATH = "output.json";
+			process.env = { ...processEnvNoVars, WRANGLER_OUTPUT_FILE_PATH };
+			writeOutput({
+				type: "wrangler-session",
+				version: 1,
+				wrangler_version: "0.0.0.0",
+				command_line_args: ["--help"],
+				log_file_path: "some/log/path.log",
+			});
+			writeOutput({
+				type: "deployment",
+				version: 1,
+				worker_name: "Worker",
+				worker_tag: "ABCDE12345",
+				deployment_id: "1234",
+			});
+
+			const outputFile = readFileSync(WRANGLER_OUTPUT_FILE_PATH, "utf8");
+			expect(outputFile).toContainEntries([
+				{
+					type: "wrangler-session",
+					version: 1,
+					wrangler_version: "0.0.0.0",
+					command_line_args: ["--help"],
+					log_file_path: "some/log/path.log",
+				},
+				{
+					type: "deployment",
+					version: 1,
+					worker_name: "Worker",
+					worker_tag: "ABCDE12345",
+					deployment_id: "1234",
+				},
+			]);
+		} finally {
+			process.env = originalProcessEnv;
+		}
+	});
+
+	it("should write to a random file in WRANGLER_OUTPUT_FILE_DIRECTORY", () => {
+		try {
+			process.env = {
+				...processEnvNoVars,
+				WRANGLER_OUTPUT_FILE_DIRECTORY: "output",
+			};
+			writeOutput({
+				type: "wrangler-session",
+				version: 1,
+				wrangler_version: "0.0.0.0",
+				command_line_args: ["--help"],
+				log_file_path: "some/log/path.log",
+			});
+
+			const outputFilePaths = readdirSync("output");
+			expect(outputFilePaths.length).toEqual(1);
+			expect(outputFilePaths[0]).toMatch(/wrangler-output-.+\.json/);
+			const outputFile = readFileSync(
+				join("output", outputFilePaths[0]),
+				"utf8"
+			);
+			expect(outputFile).toContainEntries([
+				{
+					type: "wrangler-session",
+					version: 1,
+					wrangler_version: "0.0.0.0",
+					command_line_args: ["--help"],
+					log_file_path: "some/log/path.log",
+				},
+			]);
+		} finally {
+			process.env = originalProcessEnv;
+		}
+	});
+
+	it("should write multiple entries to the same random file in WRANGLER_OUTPUT_FILE_DIRECTORY", () => {
+		try {
+			process.env = {
+				...processEnvNoVars,
+				WRANGLER_OUTPUT_FILE_DIRECTORY: "output",
+			};
+			writeOutput({
+				type: "wrangler-session",
+				version: 1,
+				wrangler_version: "0.0.0.0",
+				command_line_args: ["--help"],
+				log_file_path: "some/log/path.log",
+			});
+			writeOutput({
+				type: "deployment",
+				version: 1,
+				worker_name: "Worker",
+				worker_tag: "ABCDE12345",
+				deployment_id: "1234",
+			});
+
+			const outputFilePaths = readdirSync("output");
+			expect(outputFilePaths.length).toEqual(1);
+			expect(outputFilePaths[0]).toMatch(/wrangler-output-.+\.json/);
+			const outputFile = readFileSync(
+				join("output", outputFilePaths[0]),
+				"utf8"
+			);
+			expect(outputFile).toContainEntries([
+				{
+					type: "wrangler-session",
+					version: 1,
+					wrangler_version: "0.0.0.0",
+					command_line_args: ["--help"],
+					log_file_path: "some/log/path.log",
+				},
+				{
+					type: "deployment",
+					version: 1,
+					worker_name: "Worker",
+					worker_tag: "ABCDE12345",
+					deployment_id: "1234",
+				},
+			]);
+		} finally {
+			process.env = originalProcessEnv;
+		}
+	});
+});
+
+expect.extend({
+	toContainEntries(received: string, expected: OutputEntry[]) {
+		const actual = received
+			.trim()
+			.split("\n")
+			.map((line) => JSON.parse(line));
+
+		const stamped = expected.map((entry) => ({
+			...entry,
+			timestamp: expect.any(String),
+		}));
+
+		return {
+			pass: this.equals(actual, stamped),
+			message: () => `Entries are${this.isNot ? "" : " not"} as expected.`,
+			actual,
+			expected: stamped,
+		};
+	},
+});
+
+interface CustomMatchers {
+	toContainEntries: (expected: OutputEntry[]) => unknown;
+}
+
+declare module "vitest" {
+	interface Assertion extends CustomMatchers {}
+	interface AsymmetricMatchersContaining extends CustomMatchers {}
+}

packages/wrangler/src/__tests__/versions/versions.deploy.test.ts

@@ -44,7 +44,8 @@ describe("versions deploy", () => {
 			mswListVersions,
 			mswGetVersion(),
 			mswPostNewDeployment,
-			mswPatchNonVersionedScriptSettings
+			mswPatchNonVersionedScriptSettings,
+			...mswSuccessDeploymentScriptMetadata
 		);
 	});
 

packages/wrangler/src/deploy/deploy.ts

@@ -306,35 +306,44 @@ Update them to point to this script instead?`;
 	return domains.map((domain) => renderRoute(domain));
 }
 
-export default async function deploy(
-	props: Props
-): Promise<{ sourceMapSize?: number }> {
+export default async function deploy(props: Props): Promise<{
+	sourceMapSize?: number;
+	deploymentId: string | null;
+	workerTag: string | null;
+}> {
 	// TODO: warn if git/hg has uncommitted changes
 	const { config, accountId, name } = props;
+	let workerTag: string | null = null;
+	let deploymentId: string | null = null;
+
 	if (!props.dispatchNamespace && accountId && name) {
 		try {
-			const serviceMetaData = await fetchResult(
-				`/accounts/${accountId}/workers/services/${name}`
-			);
-			const { default_environment } = serviceMetaData as {
+			const serviceMetaData = await fetchResult<{
 				default_environment: {
-					script: { last_deployed_from: "dash" | "wrangler" | "api" };
+					script: {
+						tag: string;
+						last_deployed_from: "dash" | "wrangler" | "api";
+					};
 				};
-			};
+			}>(`/accounts/${accountId}/workers/services/${name}`);
+			const {
+				default_environment: { script },
+			} = serviceMetaData;
+			workerTag = script.tag;
 
-			if (default_environment.script.last_deployed_from === "dash") {
+			if (script.last_deployed_from === "dash") {
 				logger.warn(
 					`You are about to publish a Workers Service that was last published via the Cloudflare Dashboard.\nEdits that have been made via the dashboard will be overridden by your local code and config.`
 				);
 				if (!(await confirm("Would you like to continue?"))) {
-					return {};
+					return { deploymentId, workerTag };
 				}
-			} else if (default_environment.script.last_deployed_from === "api") {
+			} else if (script.last_deployed_from === "api") {
 				logger.warn(
 					`You are about to publish a Workers Service that was last updated via the script API.\nEdits that have been made via the script API will be overridden by your local code and config.`
 				);
 				if (!(await confirm("Would you like to continue?"))) {
-					return {};
+					return { deploymentId, workerTag };
 				}
 			}
 		} catch (e) {
@@ -436,15 +445,13 @@ See https://developers.cloudflare.com/workers/platform/compatibility-dates for m
 			? `/accounts/${accountId}/workers/services/${scriptName}/environments/${envName}`
 			: `/accounts/${accountId}/workers/scripts/${scriptName}`;
 
-	let deploymentId: string | null = null;
-
 	const { format } = props.entry;
 
 	if (!props.dispatchNamespace && prod && accountId && scriptName) {
 		const yes = await confirmLatestDeploymentOverwrite(accountId, scriptName);
 		if (!yes) {
 			cancel("Aborting deploy...");
-			return {};
+			return { deploymentId, workerTag };
 		}
 	}
 
@@ -828,7 +835,7 @@ See https://developers.cloudflare.com/workers/platform/compatibility-dates for m
 
 	if (props.dryRun) {
 		logger.log(`--dry-run: exiting now.`);
-		return {};
+		return { deploymentId, workerTag };
 	}
 	assert(accountId, "Missing accountId");
 
@@ -839,7 +846,7 @@ See https://developers.cloudflare.com/workers/platform/compatibility-dates for m
 	// Early exit for WfP since it doesn't need the below code
 	if (props.dispatchNamespace !== undefined) {
 		deployWfpUserWorker(props.dispatchNamespace, deploymentId);
-		return {};
+		return { deploymentId, workerTag };
 	}
 
 	// deploy triggers
@@ -850,7 +857,7 @@ See https://developers.cloudflare.com/workers/platform/compatibility-dates for m
 
 	logVersionIdChange();
 
-	return { sourceMapSize };
+	return { sourceMapSize, deploymentId, workerTag };
 }
 
 function deployWfpUserWorker(