V3 backport: Support wrangler version upload for Python Workers (#9713)

* Support version upload for Python Workers

* Create chilly-dancers-clap.md

* fix format

* fix rebase

* fix snapshots

* address comments (from v4 PR)

---------

Co-authored-by: Dario Piotrowicz <[email protected]>

Author: penalosa

.changeset/chilly-dancers-clap.md

@@ -0,0 +1,5 @@
+---
+"wrangler": patch
+---
+
+Support `wrangler version upload` for Python Workers

packages/wrangler/src/__tests__/helpers/assert-request.ts

@@ -0,0 +1,41 @@
+import type { mockConsoleMethods } from "./mock-console";
+
+/**
+ * Assert that Wrangler has made a request matching a certain pattern. Unlike MSW (which mocks the return value of the request),
+ * this helper asserts that a request has been made. It should be used in combination with MSW—MSW providing the mock API, and this helper being used
+ * to make sure the right data is sent to the mock API.
+ *
+ * This works by matching against the contents of Wrangler's debug logging,
+ * which includes Cloudflare API requests that are made
+ */
+export function makeApiRequestAsserter(
+	console: ReturnType<typeof mockConsoleMethods>
+) {
+	beforeEach(() => {
+		vi.stubEnv("WRANGLER_LOG", "debug");
+		vi.stubEnv("WRANGLER_LOG_SANITIZE", "false");
+	});
+	return function assertApiRequest(
+		url: RegExp,
+		{ method, body }: { method?: string; body?: RegExp }
+	) {
+		const startLine = console.debug.match(
+			new RegExp(`-- START CF API REQUEST: ${method} ` + url.source)
+		);
+		assert(startLine !== null, "Request not made by Wrangler");
+		const requestDetails = console.debug
+			.slice(startLine.index)
+			.match(
+				/HEADERS: (?<headers>(.|\n)*?)\nINIT: (?<init>(.|\n)*?)\n(BODY: (?<bodyMatch>(.|\n)*?)\n)?-- END CF API REQUEST/
+			);
+		const {
+			headers: _headers,
+			init: _init,
+			bodyMatch,
+		} = requestDetails?.groups ?? {};
+
+		if (body) {
+			expect(bodyMatch).toMatch(body);
+		}
+	};
+}

packages/wrangler/src/__tests__/helpers/write-worker-source.ts

@@ -1,4 +1,5 @@
 import fs from "node:fs";
+import dedent from "ts-dedent";
 
 /** Write a mock Worker script to disk. */
 export function writeWorkerSource({
@@ -7,25 +8,42 @@ export function writeWorkerSource({
 	type = "esm",
 }: {
 	basePath?: string;
-	format?: "js" | "ts" | "jsx" | "tsx" | "mjs";
-	type?: "esm" | "sw";
+	format?: "js" | "ts" | "jsx" | "tsx" | "mjs" | "py";
+	type?: "esm" | "sw" | "python";
 } = {}) {
 	if (basePath !== ".") {
 		fs.mkdirSync(basePath, { recursive: true });
 	}
-	fs.writeFileSync(
-		`${basePath}/index.${format}`,
-		type === "esm"
-			? `import { foo } from "./another";
-      export default {
-        async fetch(request) {
-          return new Response('Hello' + foo);
-        },
-      };`
-			: `import { foo } from "./another";
-      addEventListener('fetch', event => {
-        event.respondWith(new Response('Hello' + foo));
-      })`
-	);
+
+	let workerContent;
+
+	switch (type) {
+		case "esm":
+			workerContent = /* javascript */ dedent`
+				import { foo } from "./another";
+				export default {
+					async fetch(request) {
+					return new Response('Hello' + foo);
+					},
+				};`;
+			break;
+		case "sw":
+			workerContent = /* javascript */ dedent`
+				import { foo } from "./another";
+				addEventListener('fetch', event => {
+					event.respondWith(new Response('Hello' + foo));
+				})`;
+			break;
+		case "python":
+			workerContent = /* python */ dedent`
+				from js import Response
+				def on_fetch(request):
+					return Response.new("Hello World")
+				`;
+			break;
+	}
+
+	fs.writeFileSync(`${basePath}/index.${format}`, workerContent);
+
 	fs.writeFileSync(`${basePath}/another.${format}`, `export const foo = 100;`);
 }

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

@@ -1,4 +1,5 @@
 import { http, HttpResponse } from "msw";
+import { makeApiRequestAsserter } from "../helpers/assert-request";
 import { mockAccountId, mockApiToken } from "../helpers/mock-account-id";
 import { mockConsoleMethods } from "../helpers/mock-console";
 import { useMockIsTTY } from "../helpers/mock-istty";
@@ -18,6 +19,7 @@ describe("versions upload", () => {
 	mockApiToken();
 	const { setIsTTY } = useMockIsTTY();
 	const std = mockConsoleMethods();
+	const assertApiRequest = makeApiRequestAsserter(std);
 
 	function mockGetScript() {
 		msw.use(
@@ -172,4 +174,44 @@ describe("versions upload", () => {
 
 		expect(std.info).toContain("Retrying API call after error...");
 	});
+
+	test("correctly detects python workers", async () => {
+		mockGetScript();
+		mockUploadVersion(true);
+		mockGetWorkerSubdomain({ enabled: true, previews_enabled: true });
+		mockSubDomainRequest();
+
+		// Setup
+		writeWranglerConfig({
+			name: "test-name",
+			main: "./index.py",
+			compatibility_flags: ["python_workers"],
+		});
+		writeWorkerSource({ type: "python", format: "py" });
+		setIsTTY(false);
+
+		await runWrangler("versions upload");
+
+		assertApiRequest(/.*?workers\/scripts\/test-name\/versions/, {
+			method: "POST",
+			// Make sure the main module (index.py) has a text/x-python content type
+			body: /Content-Disposition: form-data; name="index.py"; filename="index.py"\nContent-Type: text\/x-python/,
+		});
+
+		expect(std.out).toMatchInlineSnapshot(`
+			"┌──────────────────┬────────┬──────────┐
+			│ Name             │ Type   │ Size     │
+			├──────────────────┼────────┼──────────┤
+			│ another.py       │ python │ xx KiB │
+			├──────────────────┼────────┼──────────┤
+			│ Total (1 module) │        │ xx KiB │
+			└──────────────────┴────────┴──────────┘
+			Total Upload: xx KiB / gzip: xx KiB
+			Worker Startup Time: 500 ms
+			No bindings found.
+			Uploaded test-name (TIMINGS)
+			Worker Version ID: 51e4886e-2db7-4900-8d38-fbfecfeab993
+			Version Preview URL: https://51e4886e-test-name.test-sub-domain.workers.dev"
+		`);
+	});
 });

packages/wrangler/src/api/startDevWorker/BundlerController.ts

@@ -2,13 +2,13 @@ import assert from "assert";
 import { readFileSync, realpathSync, writeFileSync } from "fs";
 import path from "path";
 import { watch } from "chokidar";
-import { noBundleWorker } from "../../deploy/deploy";
 import { bundleWorker, shouldCheckFetch } from "../../deployment-bundle/bundle";
 import { getBundleType } from "../../deployment-bundle/bundle-type";
 import {
 	createModuleCollector,
 	getWrangler1xLegacyModuleReferences,
 } from "../../deployment-bundle/module-collection";
+import { noBundleWorker } from "../../deployment-bundle/no-bundle-worker";
 import { runCustomBuild } from "../../deployment-bundle/run-custom-build";
 import { getAssetChangeMessage } from "../../dev";
 import { runBuild } from "../../dev/use-esbuild";

packages/wrangler/src/deploy/deploy.ts

@@ -11,17 +11,13 @@ import { configFileName, formatConfigSnippet } from "../config";
 import { getBindings, provisionBindings } from "../deployment-bundle/bindings";
 import { bundleWorker } from "../deployment-bundle/bundle";
 import { printBundleSize } from "../deployment-bundle/bundle-reporter";
-import { getBundleType } from "../deployment-bundle/bundle-type";
 import { createWorkerUploadForm } from "../deployment-bundle/create-worker-upload-form";
 import { logBuildOutput } from "../deployment-bundle/esbuild-plugins/log-build-output";
-import {
-	findAdditionalModules,
-	writeAdditionalModules,
-} from "../deployment-bundle/find-additional-modules";
 import {
 	createModuleCollector,
 	getWrangler1xLegacyModuleReferences,
 } from "../deployment-bundle/module-collection";
+import { noBundleWorker } from "../deployment-bundle/no-bundle-worker";
 import { validateNodeCompatMode } from "../deployment-bundle/node-compat";
 import { loadSourceMaps } from "../deployment-bundle/source-maps";
 import { confirm } from "../dialogs";
@@ -61,7 +57,6 @@ import type { Config } from "../config";
 import type {
 	CustomDomainRoute,
 	Route,
-	Rule,
 	ZoneIdRoute,
 	ZoneNameRoute,
 } from "../config/environment";
@@ -1283,22 +1278,3 @@ export async function updateQueueConsumers(
 
 	return updateConsumers;
 }
-
-export async function noBundleWorker(
-	entry: Entry,
-	rules: Rule[],
-	outDir: string | undefined
-) {
-	const modules = await findAdditionalModules(entry, rules);
-	if (outDir) {
-		await writeAdditionalModules(modules, outDir);
-	}
-
-	const bundleType = getBundleType(entry.format, entry.file);
-	return {
-		modules,
-		dependencies: {} as { [path: string]: { bytesInOutput: number } },
-		resolvedEntryPointPath: entry.file,
-		bundleType,
-	};
-}

packages/wrangler/src/deployment-bundle/no-bundle-worker.ts

@@ -0,0 +1,26 @@
+import { getBundleType } from "./bundle-type";
+import {
+	findAdditionalModules,
+	writeAdditionalModules,
+} from "./find-additional-modules";
+import type { Rule } from "../config/environment";
+import type { Entry } from "./entry";
+
+export async function noBundleWorker(
+	entry: Entry,
+	rules: Rule[],
+	outDir: string | undefined
+) {
+	const modules = await findAdditionalModules(entry, rules);
+	if (outDir) {
+		await writeAdditionalModules(modules, outDir);
+	}
+
+	const bundleType = getBundleType(entry.format, entry.file);
+	return {
+		modules,
+		dependencies: {} as { [path: string]: { bytesInOutput: number } },
+		resolvedEntryPointPath: entry.file,
+		bundleType,
+	};
+}

packages/wrangler/src/versions/upload.ts

@@ -13,18 +13,14 @@ import { createCommand } from "../core/create-command";
 import { getBindings, provisionBindings } from "../deployment-bundle/bindings";
 import { bundleWorker } from "../deployment-bundle/bundle";
 import { printBundleSize } from "../deployment-bundle/bundle-reporter";
-import { getBundleType } from "../deployment-bundle/bundle-type";
 import { createWorkerUploadForm } from "../deployment-bundle/create-worker-upload-form";
 import { getEntry } from "../deployment-bundle/entry";
 import { logBuildOutput } from "../deployment-bundle/esbuild-plugins/log-build-output";
-import {
-	findAdditionalModules,
-	writeAdditionalModules,
-} from "../deployment-bundle/find-additional-modules";
 import {
 	createModuleCollector,
 	getWrangler1xLegacyModuleReferences,
 } from "../deployment-bundle/module-collection";
+import { noBundleWorker } from "../deployment-bundle/no-bundle-worker";
 import { validateNodeCompatMode } from "../deployment-bundle/node-compat";
 import { loadSourceMaps } from "../deployment-bundle/source-maps";
 import { confirm } from "../dialogs";
@@ -56,7 +52,6 @@ import { printBindings } from "../utils/print-bindings";
 import { retryOnAPIFailure } from "../utils/retry";
 import type { AssetsOptions } from "../assets";
 import type { Config } from "../config";
-import type { Rule } from "../config/environment";
 import type { Entry } from "../deployment-bundle/entry";
 import type { CfPlacement, CfWorkerInit } from "../deployment-bundle/worker";
 import type { RetrieveSourceMapFunction } from "../sourcemap";
@@ -891,21 +886,3 @@ Changes to triggers (routes, custom domains, cron schedules, etc) must be applie
 function formatTime(duration: number) {
 	return `(${(duration / 1000).toFixed(2)} sec)`;
 }
-
-async function noBundleWorker(
-	entry: Entry,
-	rules: Rule[],
-	outDir: string | undefined
-) {
-	const modules = await findAdditionalModules(entry, rules);
-	if (outDir) {
-		await writeAdditionalModules(modules, outDir);
-	}
-
-	return {
-		modules,
-		dependencies: {} as { [path: string]: { bytesInOutput: number } },
-		resolvedEntryPointPath: entry.file,
-		bundleType: getBundleType(entry.format),
-	};
-}