Add new autoconfig_summary field to the deploy output entry (#11500)

* Add new `experimental_autoconfig_summary` field to the deploy output entry

* drop the `experimental_` prefix

* remove extra package.json modification

Author: dario-piotrowicz

.changeset/cold-numbers-sneeze.md

@@ -0,0 +1,9 @@
+---
+"wrangler": minor
+---
+
+Add new `autoconfig_summary` field to the deploy output entry
+
+This change augments `wrangler deploy` output being printed to `WRANGLER_OUTPUT_FILE_DIRECTORY` or `WRANGLER_OUTPUT_FILE_PATH` to also include a new `autoconfig_summary` field containing the possible summary details for the autoconfig process (the field is `undefined` if autoconfig didn't run).
+
+Note: the field is experimental and could change while autoconfig is not GA

packages/wrangler/src/__tests__/autoconfig/run-summary.test.ts

@@ -25,7 +25,7 @@ describe("autoconfig run - buildOperationsSummary()", () => {
 
 	describe("interactive mode", () => {
 		test("presents a summary for a simple project where only a wrangler.jsonc file needs to be created", async () => {
-			await buildOperationsSummary(
+			const summary = await buildOperationsSummary(
 				{
 					workerName: "worker-name",
 					projectPath: "<PROJECT_PATH>",
@@ -47,10 +47,25 @@ describe("autoconfig run - buildOperationsSummary()", () => {
 				  }
 				"
 			`);
+
+			expect(summary).toMatchInlineSnapshot(`
+				Object {
+				  "scripts": Object {},
+				  "wranglerConfig": Object {
+				    "$schema": "node_modules/wrangler/config-schema.json",
+				    "compatibility_date": "2025-01-01",
+				    "name": "worker-name",
+				    "observability": Object {
+				      "enabled": true,
+				    },
+				  },
+				  "wranglerInstall": false,
+				}
+			`);
 		});
 
 		test("shows that wrangler will be added as a devDependency when not already installed as such", async () => {
-			await buildOperationsSummary(
+			const summary = await buildOperationsSummary(
 				{
 					workerName: "worker-name",
 					projectPath: "<PROJECT_PATH>",
@@ -69,10 +84,28 @@ describe("autoconfig run - buildOperationsSummary()", () => {
 				 - wrangler (devDependency)
 				`
 			);
+
+			expect(summary).toMatchInlineSnapshot(`
+				Object {
+				  "scripts": Object {
+				    "deploy": "wrangler deploy",
+				    "preview": "wrangler dev",
+				  },
+				  "wranglerConfig": Object {
+				    "$schema": "node_modules/wrangler/config-schema.json",
+				    "compatibility_date": "2025-01-01",
+				    "name": "worker-name",
+				    "observability": Object {
+				      "enabled": true,
+				    },
+				  },
+				  "wranglerInstall": true,
+				}
+			`);
 		});
 
 		test("when a package.json is present wrangler@latest will be unconditionally installed (even if already present)", async () => {
-			await buildOperationsSummary(
+			const summary = await buildOperationsSummary(
 				{
 					workerName: "worker-name",
 					projectPath: "<PROJECT_PATH>",
@@ -93,10 +126,28 @@ describe("autoconfig run - buildOperationsSummary()", () => {
 				 - wrangler (devDependency)
 				`
 			);
+
+			expect(summary).toMatchInlineSnapshot(`
+				Object {
+				  "scripts": Object {
+				    "deploy": "wrangler deploy",
+				    "preview": "wrangler dev",
+				  },
+				  "wranglerConfig": Object {
+				    "$schema": "node_modules/wrangler/config-schema.json",
+				    "compatibility_date": "2025-01-01",
+				    "name": "worker-name",
+				    "observability": Object {
+				      "enabled": true,
+				    },
+				  },
+				  "wranglerInstall": true,
+				}
+			`);
 		});
 
 		test("shows that when needed a framework specific configuration will be run", async () => {
-			await buildOperationsSummary(
+			const summary = await buildOperationsSummary(
 				{
 					workerName: "worker-name",
 					projectPath: "<PROJECT_PATH>",
@@ -109,10 +160,14 @@ describe("autoconfig run - buildOperationsSummary()", () => {
 			expect(std.out).toContain(
 				'🛠️  Configuring project for Astro with "astro add cloudflare"'
 			);
+
+			expect(summary.frameworkConfiguration).toBe(
+				'Configuring project for Astro with "astro add cloudflare"'
+			);
 		});
 
 		test("doesn't show the framework specific configuration step for the Static framework", async () => {
-			await buildOperationsSummary(
+			const summary = await buildOperationsSummary(
 				{
 					workerName: "worker-name",
 					projectPath: "<PROJECT_PATH>",
@@ -123,6 +178,7 @@ describe("autoconfig run - buildOperationsSummary()", () => {
 			);
 
 			expect(std.out).not.toContain("🛠️  Configuring project for");
+			expect(summary.frameworkConfiguration).toBeUndefined();
 		});
 	});
 });

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

@@ -3,6 +3,7 @@ import { Buffer } from "node:buffer";
 import { spawnSync } from "node:child_process";
 import { randomFillSync } from "node:crypto";
 import * as fs from "node:fs";
+import { readFile } from "node:fs/promises";
 import * as path from "node:path";
 import {
 	APIError,
@@ -15,7 +16,19 @@ import * as esbuild from "esbuild";
 import { http, HttpResponse } from "msw";
 import * as TOML from "smol-toml";
 import dedent from "ts-dedent";
-import { afterEach, beforeEach, describe, expect, it, test, vi } from "vitest";
+import {
+	afterEach,
+	assert,
+	beforeEach,
+	describe,
+	expect,
+	it,
+	test,
+	vi,
+} from "vitest";
+import { getDetailsForAutoConfig } from "../autoconfig/details";
+import { Static } from "../autoconfig/frameworks/static";
+import { runAutoConfig } from "../autoconfig/run";
 import { printBundleSize } from "../deployment-bundle/bundle-reporter";
 import { clearOutputFilePath } from "../output";
 import { getSubdomainValues } from "../triggers/deploy";
@@ -72,6 +85,7 @@ import {
 } from "./helpers/write-wrangler-config";
 import type { AssetManifest } from "../assets";
 import type { CustomDomain, CustomDomainChangeset } from "../deploy/deploy";
+import type { OutputEntry } from "../output";
 import type { PostTypedConsumerBody, QueueResponse } from "../queues/client";
 import type {
 	Config,
@@ -104,6 +118,9 @@ vi.mock("../package-manager", async (importOriginal) => ({
 	},
 }));
 
+vi.mock("../autoconfig/details");
+vi.mock("../autoconfig/run");
+
 describe("deploy", () => {
 	mockAccountId();
 	mockApiToken();
@@ -15786,6 +15803,100 @@ export default{
 			expect(process.exitCode).not.toBe(0);
 		});
 	});
+
+	it("should output a deploy output entry to WRANGLER_OUTPUT_FILE_PATH containing a field with the autoconfig summary if autoconfig run", async () => {
+		const outputFile = "./output.json";
+
+		vi.mocked(getDetailsForAutoConfig).mockResolvedValue({
+			configured: false,
+			framework: new Static("static"),
+			workerName: "my-site",
+			projectPath: ".",
+		});
+
+		vi.mocked(runAutoConfig).mockImplementation(async () => {
+			const wranglerConfig = {
+				name: "my-site",
+				compatibility_date: "2025-12-02",
+				assets: {
+					directory: ".",
+				},
+			};
+
+			writeWranglerConfig(wranglerConfig);
+
+			return {
+				scripts: {
+					build: "npm run build-my-static-site",
+				},
+				wranglerInstall: true,
+				wranglerConfig,
+			};
+		});
+
+		await runWrangler("deploy --x-autoconfig --dry-run", {
+			...process.env,
+			WRANGLER_OUTPUT_FILE_PATH: outputFile,
+		});
+
+		const deployOutputEntry = (await readFile(outputFile, "utf8"))
+			.split("\n")
+			.filter(Boolean)
+			.map((line) => JSON.parse(line))
+			.find((obj) => obj.type === "deploy") as OutputEntry | undefined;
+
+		assert(deployOutputEntry?.type === "deploy");
+
+		expect(deployOutputEntry.autoconfig_summary).toMatchInlineSnapshot(`
+			Object {
+			  "scripts": Object {
+			    "build": "npm run build-my-static-site",
+			  },
+			  "wranglerConfig": Object {
+			    "assets": Object {
+			      "directory": ".",
+			    },
+			    "compatibility_date": "2025-12-02",
+			    "name": "my-site",
+			  },
+			  "wranglerInstall": true,
+			}
+		`);
+	});
+
+	it("should output a deploy output entry to WRANGLER_OUTPUT_FILE_PATH not containing a field with the autoconfig summary if autoconfig didn't run", async () => {
+		const outputFile = "./output.json";
+
+		writeWranglerConfig({
+			name: "worker-name",
+			compatibility_date: "2025-12-02",
+			assets: {
+				directory: ".",
+			},
+		});
+
+		vi.mocked(getDetailsForAutoConfig).mockResolvedValue({
+			configured: true,
+			framework: new Static("static"),
+			workerName: "my-worker",
+			projectPath: ".",
+		});
+
+		await runWrangler("deploy --x-autoconfig --dry-run", {
+			...process.env,
+			WRANGLER_OUTPUT_FILE_PATH: outputFile,
+		});
+
+		const deployOutputEntry = (await readFile(outputFile, "utf8"))
+			.split("\n")
+			.filter(Boolean)
+			.map((line) => JSON.parse(line))
+			.find((obj) => obj.type === "deploy") as OutputEntry | undefined;
+
+		assert(deployOutputEntry?.type === "deploy");
+
+		expect(deployOutputEntry.autoconfig_summary).toBeUndefined();
+	});
 });
 
 /** Write mock assets to the file system so they can be uploaded. */

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

@@ -94,6 +94,7 @@ describe("writeOutput()", () => {
 			targets: undefined,
 			worker_name_overridden: false,
 			wrangler_environment: undefined,
+			autoconfig_summary: undefined,
 		});
 
 		const outputFile = readFileSync(WRANGLER_OUTPUT_FILE_PATH, "utf8");
@@ -113,6 +114,7 @@ describe("writeOutput()", () => {
 				version_id: "1234",
 				targets: undefined,
 				worker_name_overridden: false,
+				autoconfig_summary: undefined,
 				wrangler_environment: undefined,
 			},
 		]);
@@ -163,6 +165,7 @@ describe("writeOutput()", () => {
 			targets: undefined,
 			worker_name_overridden: false,
 			wrangler_environment: undefined,
+			autoconfig_summary: undefined,
 		});
 
 		const outputFilePaths = readdirSync("output");
@@ -186,6 +189,7 @@ describe("writeOutput()", () => {
 				targets: undefined,
 				worker_name_overridden: false,
 				wrangler_environment: undefined,
+				autoconfig_summary: undefined,
 			},
 		]);
 	});