[wrangler] Add bundle sizes to structured output (#14915)

Author: longlho

.changeset/tidy-ravens-report.md

@@ -0,0 +1,5 @@
+---
+"wrangler": minor
+---
+
+Include exact raw and gzip-compressed Worker bundle sizes in structured `deploy` and `version-upload` output.

packages/deploy-helpers/src/deploy/deploy.ts

@@ -23,7 +23,11 @@ import {
 	syncAssets,
 } from "./helpers/assets";
 import { getBindings } from "./helpers/binding-utils";
-import { printBundleSize } from "./helpers/bundle-reporter";
+import {
+	getSize,
+	printBundleSize,
+	type BundleSize,
+} from "./helpers/bundle-reporter";
 import { confirmLatestDeploymentOverwrite } from "./helpers/confirm-latest-deployment-overwrite";
 import { createWorkerUploadForm } from "./helpers/create-worker-upload-form";
 import { deployWfpUserWorker } from "./helpers/deploy-wfp";
@@ -140,6 +144,7 @@ type DeployResult = {
 	workerTag: string | null;
 	assetUploadStats?: AssetUploadStats;
 	targets?: string[];
+	bundleSize?: BundleSize;
 };
 
 export default async function deploy(
@@ -161,6 +166,12 @@ export default async function deploy(
 		targets: result.targets,
 		wrangler_environment: props.env,
 		worker_name_overridden: props.workerNameOverridden ?? false,
+		bundle_size: result.bundleSize
+			? {
+					raw_bytes: result.bundleSize.size,
+					gzip_bytes: result.bundleSize.gzipSize,
+				}
+			: undefined,
 	});
 
 	return result;
@@ -367,10 +378,8 @@ async function deployWorker(
 		0
 	);
 
-	await printBundleSize(
-		{ name: path.basename(resolvedEntryPointPath), content: content },
-		modules
-	);
+	const bundleSize = await getSize([...modules, { content }]);
+	printBundleSize(bundleSize);
 
 	// We can use the new versions/deployments APIs if we:
 	// * are uploading a worker that already exists
@@ -746,7 +755,7 @@ async function deployWorker(
 
 	if (isDryRun) {
 		logger.log(`--dry-run: exiting now.`);
-		return { versionId, workerTag };
+		return { versionId, workerTag, bundleSize };
 	}
 
 	const uploadMs = Date.now() - start;
@@ -769,7 +778,7 @@ async function deployWorker(
 	// Early exit for WfP since it doesn't need the below code
 	if (props.dispatchNamespace !== undefined) {
 		deployWfpUserWorker(props.dispatchNamespace, versionId);
-		return { versionId, workerTag, assetUploadStats };
+		return { versionId, workerTag, assetUploadStats, bundleSize };
 	}
 	assert(accountId);
 	// deploy triggers
@@ -793,5 +802,6 @@ async function deployWorker(
 		workerTag,
 		assetUploadStats,
 		targets: targets ?? [],
+		bundleSize,
 	};
 }

packages/deploy-helpers/src/deploy/helpers/bundle-reporter.ts

@@ -9,7 +9,14 @@ const ONE_KIB_BYTES = 1024;
 // See https://developers.cloudflare.com/workers/platform/limits/#worker-size
 const MAX_GZIP_SIZE_BYTES = 3 * ONE_KIB_BYTES * ONE_KIB_BYTES;
 
-async function getSize(modules: Pick<CfModule, "content">[]) {
+export interface BundleSize {
+	size: number;
+	gzipSize: number;
+}
+
+export async function getSize(
+	modules: Pick<CfModule, "content">[]
+): Promise<BundleSize> {
 	const gzipSize = gzipSync(
 		await new Blob(modules.map((file) => file.content)).arrayBuffer()
 	).byteLength;
@@ -18,15 +25,7 @@ async function getSize(modules: Pick<CfModule, "content">[]) {
 	return { size: aggregateSize, gzipSize };
 }
 
-export async function printBundleSize(
-	main: {
-		name: string;
-		content: string;
-	},
-	modules: CfModule[]
-) {
-	const { size, gzipSize } = await getSize([...modules, main]);
-
+export function printBundleSize({ size, gzipSize }: BundleSize) {
 	const bundleReport = `${(size / ONE_KIB_BYTES).toFixed(2)} KiB / gzip: ${(
 		gzipSize / ONE_KIB_BYTES
 	).toFixed(2)} KiB`;

packages/deploy-helpers/src/deploy/versions-upload.ts

@@ -16,7 +16,11 @@ import { getWorkersDevSubdomain } from "../triggers/subdomain";
 import { resolveAssetOptions, syncAssets } from "./helpers/assets";
 import { renderBindingDependsOnExportError } from "./helpers/binding-depends-on-export";
 import { getBindings } from "./helpers/binding-utils";
-import { printBundleSize } from "./helpers/bundle-reporter";
+import {
+	getSize,
+	printBundleSize,
+	type BundleSize,
+} from "./helpers/bundle-reporter";
 import { createWorkerUploadForm } from "./helpers/create-worker-upload-form";
 import {
 	applyServiceAndEnvironmentTags,
@@ -59,6 +63,7 @@ type VersionsUploadResult = {
 	assetUploadStats?: AssetUploadStats;
 	versionPreviewUrl?: string | undefined;
 	versionPreviewAliasUrl?: string | undefined;
+	bundleSize?: BundleSize;
 };
 
 export default async function versionsUpload(
@@ -86,6 +91,12 @@ export default async function versionsUpload(
 		preview_alias_url: result.versionPreviewAliasUrl,
 		wrangler_environment: props.env,
 		worker_name_overridden: props.workerNameOverridden ?? false,
+		bundle_size: result.bundleSize
+			? {
+					raw_bytes: result.bundleSize.size,
+					gzip_bytes: result.bundleSize.gzipSize,
+				}
+			: undefined,
 	});
 
 	return result;
@@ -232,10 +243,8 @@ async function uploadWorkerVersion(
 				: undefined,
 	};
 
-	await printBundleSize(
-		{ name: path.basename(resolvedEntryPointPath), content: content },
-		modules
-	);
+	const bundleSize = await getSize([...modules, { content }]);
+	printBundleSize(bundleSize);
 
 	let workerBundle: FormData;
 
@@ -415,7 +424,7 @@ async function uploadWorkerVersion(
 
 	if (props.dryRun) {
 		logger.log(`--dry-run: exiting now.`);
-		return { versionId, workerTag };
+		return { versionId, workerTag, bundleSize };
 	}
 	assert(accountId);
 
@@ -466,5 +475,6 @@ Changes to triggers (routes, custom domains, cron schedules, etc) must be applie
 		assetUploadStats: assetsUploadResult?.assetUploadStats,
 		versionPreviewUrl,
 		versionPreviewAliasUrl,
+		bundleSize,
 	};
 }

packages/workers-utils/src/output.ts

@@ -74,6 +74,13 @@ interface OutputEntryBase<T extends string> {
 	type: T;
 }
 
+interface OutputEntryBundleSize {
+	/** The uncompressed size of the Worker bundle. */
+	raw_bytes: number;
+	/** The gzip-compressed size of the Worker bundle. */
+	gzip_bytes: number;
+}
+
 /**
  * All the different types of entry that can be written to the output file.
  */
@@ -112,6 +119,8 @@ interface OutputEntryDeployment extends OutputEntryBase<"deploy"> {
 	worker_name_overridden: boolean;
 	/** wrangler environment used */
 	wrangler_environment: string | undefined;
+	/** Exact Worker bundle sizes in bytes. */
+	bundle_size?: OutputEntryBundleSize;
 }
 
 interface OutputEntryPreview extends OutputEntryBase<"preview"> {
@@ -194,6 +203,8 @@ interface OutputEntryVersionUpload extends OutputEntryBase<"version-upload"> {
 	worker_name_overridden: boolean;
 	/** wrangler environment used */
 	wrangler_environment: string | undefined;
+	/** Exact Worker bundle sizes in bytes. */
+	bundle_size?: OutputEntryBundleSize;
 }
 
 interface OutputEntryVersionDeployment extends OutputEntryBase<"version-deploy"> {

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

@@ -11,7 +11,10 @@ import {
 import * as esbuild from "esbuild";
 import { http, HttpResponse } from "msw";
 import { afterEach, beforeEach, describe, it, test, vi } from "vitest";
-import { printBundleSize } from "../../deployment-bundle/bundle-reporter";
+import {
+	getSize,
+	printBundleSize,
+} from "../../deployment-bundle/bundle-reporter";
 import { clearOutputFilePath } from "../../output";
 import { diagnoseScriptSizeError } from "../../utils/friendly-validator-errors";
 import { mockAccountId, mockApiToken } from "../helpers/mock-account-id";
@@ -1117,17 +1120,19 @@ export default { fetch() { return new Response(foo); } }`
 			// keeping these as unit tests to try and keep them snappy, as they often deal with
 			// big files that would take a while to deal with in a full wrangler test
 
-			test("should print the bundle size", async ({ expect }) => {
+			test("should calculate the bundle size", async ({ expect }) => {
 				const bigModule = Buffer.alloc(10_000_000);
 				randomFillSync(bigModule);
-				await printBundleSize({ name: "index.js", content: "" }, [
-					{
-						name: "index.js",
-						filePath: undefined,
-						content: bigModule,
-						type: "buffer",
-					},
-				]);
+				const bundleSize = await getSize([{ content: bigModule }]);
+
+				expect(bundleSize).toEqual({
+					size: 10_000_000,
+					gzipSize: expect.any(Number),
+				});
+			});
+
+			test("should print the bundle size", ({ expect }) => {
+				printBundleSize({ size: 10_000_000, gzipSize: 10_000_000 });
 
 				expect(std).toMatchInlineSnapshot(`
 					{

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

@@ -1956,7 +1956,13 @@ describe("deploy", () => {
 			.map((line) => JSON.parse(line)) as OutputEntry[];
 
 		expect(outputEntries).toContainEqual(
-			expect.objectContaining({ type: "deploy" })
+			expect.objectContaining({
+				type: "deploy",
+				bundle_size: {
+					raw_bytes: expect.any(Number),
+					gzip_bytes: expect.any(Number),
+				},
+			})
 		);
 
 		const autoconfigOutputEntry = outputEntries.find(

packages/wrangler/src/deployment-bundle/bundle-reporter.ts

@@ -1 +1 @@
-export { printBundleSize } from "@cloudflare/deploy-helpers";
+export { getSize, printBundleSize } from "@cloudflare/deploy-helpers";

packages/wrangler/src/dev/remote.ts

@@ -3,7 +3,7 @@ import path from "node:path";
 import { syncAssets } from "@cloudflare/deploy-helpers";
 import { APIError, UserError } from "@cloudflare/workers-utils";
 import { isAuthenticationError } from "../core/handle-errors";
-import { printBundleSize } from "../deployment-bundle/bundle-reporter";
+import { getSize, printBundleSize } from "../deployment-bundle/bundle-reporter";
 import { getBundleType } from "../deployment-bundle/bundle-type";
 import { withSourceURLs } from "../deployment-bundle/source-url";
 import { getInferredHost } from "../dev";
@@ -164,13 +164,7 @@ export async function createRemoteWorkerInit(props: {
 	);
 
 	// TODO: For Dev we could show the reporter message in the interactive box.
-	void printBundleSize(
-		{
-			name: path.basename(props.bundle.path),
-			content,
-		},
-		props.modules
-	);
+	void getSize([...props.modules, { content }]).then(printBundleSize);
 
 	const workersSitesAssets = await syncWorkersSite(
 		props.complianceConfig,