Resolve bugs related to not handling tailStream (#9039)

jamesopstad · web-flow · commit a9190de1340d · 2025-04-23T19:14:18.000+01:00
diff --git a/.changeset/tame-views-learn.md b/.changeset/tame-views-learn.md
@@ -0,0 +1,5 @@
+---
+"@cloudflare/vite-plugin": patch
+---
+
+Fixes two bugs that were caused by not accounting for an undocumented method on Workers and Durable Objects. `ctx.blockConcurrencyWhile` will now successfully block execution in Durable Objects and invoking Workers will no longer cause unhandled rejections.
diff --git a/packages/vite-plugin-cloudflare/playground/block-concurrency-while/__tests__/block-concurrency-while.spec.ts b/packages/vite-plugin-cloudflare/playground/block-concurrency-while/__tests__/block-concurrency-while.spec.ts
@@ -0,0 +1,7 @@
+import { expect, test } from "vitest";
+import { getJsonResponse } from "../../__test-utils__";
+
+test("blocks execution until `ctx.blockConcurrencyWhile` has completed", async () => {
+	const response = await getJsonResponse("/durable-object");
+	expect(response).toEqual({ isInitialized: true });
+});
diff --git a/packages/vite-plugin-cloudflare/playground/block-concurrency-while/package.json b/packages/vite-plugin-cloudflare/playground/block-concurrency-while/package.json
@@ -0,0 +1,19 @@
+{
+	"name": "@playground/block-concurrency-while",
+	"private": true,
+	"type": "module",
+	"scripts": {
+		"build": "vite build --app",
+		"check:types": "tsc --build",
+		"dev": "vite dev",
+		"preview": "vite preview"
+	},
+	"devDependencies": {
+		"@cloudflare/vite-plugin": "workspace:*",
+		"@cloudflare/workers-tsconfig": "workspace:*",
+		"@cloudflare/workers-types": "^4.20250422.0",
+		"typescript": "catalog:default",
+		"vite": "catalog:vite-plugin",
+		"wrangler": "workspace:*"
+	}
+}
diff --git a/packages/vite-plugin-cloudflare/playground/block-concurrency-while/src/index.ts b/packages/vite-plugin-cloudflare/playground/block-concurrency-while/src/index.ts
@@ -0,0 +1,38 @@
+import { DurableObject } from "cloudflare:workers";
+
+interface Env {
+	MyDurableObject: DurableObjectNamespace<MyDurableObject>;
+}
+
+export class MyDurableObject extends DurableObject {
+	#isInitialized = false;
+
+	constructor(ctx: DurableObjectState, env: Env) {
+		super(ctx, env);
+		console.log("constructor");
+		this.ctx.blockConcurrencyWhile(async () => {
+			console.log("blockConcurrencyWhile");
+			this.#isInitialized = true;
+		});
+	}
+
+	get isInitialized() {
+		console.log("isInitialized");
+		return this.#isInitialized;
+	}
+}
+
+export default {
+	async fetch(request, env) {
+		const url = new URL(request.url);
+
+		if (url.pathname === "/durable-object") {
+			const id = env.MyDurableObject.idFromName("test-id");
+			const stub = env.MyDurableObject.get(id);
+
+			return Response.json({ isInitialized: await stub.isInitialized });
+		}
+
+		return new Response(null, { status: 404 });
+	},
+} satisfies ExportedHandler<Env>;
diff --git a/packages/vite-plugin-cloudflare/playground/block-concurrency-while/tsconfig.json b/packages/vite-plugin-cloudflare/playground/block-concurrency-while/tsconfig.json
@@ -0,0 +1,7 @@
+{
+	"files": [],
+	"references": [
+		{ "path": "./tsconfig.node.json" },
+		{ "path": "./tsconfig.worker.json" }
+	]
+}
diff --git a/packages/vite-plugin-cloudflare/playground/block-concurrency-while/tsconfig.node.json b/packages/vite-plugin-cloudflare/playground/block-concurrency-while/tsconfig.node.json
@@ -0,0 +1,4 @@
+{
+	"extends": ["@cloudflare/workers-tsconfig/base.json"],
+	"include": ["vite.config.ts", "__tests__"]
+}
diff --git a/packages/vite-plugin-cloudflare/playground/block-concurrency-while/tsconfig.worker.json b/packages/vite-plugin-cloudflare/playground/block-concurrency-while/tsconfig.worker.json
@@ -0,0 +1,4 @@
+{
+	"extends": ["@cloudflare/workers-tsconfig/worker.json"],
+	"include": ["src"]
+}
diff --git a/packages/vite-plugin-cloudflare/playground/block-concurrency-while/turbo.json b/packages/vite-plugin-cloudflare/playground/block-concurrency-while/turbo.json
@@ -0,0 +1,9 @@
+{
+	"$schema": "http://turbo.build/schema.json",
+	"extends": ["//"],
+	"tasks": {
+		"build": {
+			"outputs": ["dist/**"]
+		}
+	}
+}
diff --git a/packages/vite-plugin-cloudflare/playground/block-concurrency-while/vite.config.ts b/packages/vite-plugin-cloudflare/playground/block-concurrency-while/vite.config.ts
@@ -0,0 +1,6 @@
+import { cloudflare } from "@cloudflare/vite-plugin";
+import { defineConfig } from "vite";
+
+export default defineConfig({
+	plugins: [cloudflare({ inspectorPort: false, persistState: false })],
+});
diff --git a/packages/vite-plugin-cloudflare/playground/block-concurrency-while/wrangler.jsonc b/packages/vite-plugin-cloudflare/playground/block-concurrency-while/wrangler.jsonc
@@ -0,0 +1,19 @@
+{
+	"name": "worker",
+	"main": "./src/index.ts",
+	"compatibility_date": "2024-12-30",
+	"durable_objects": {
+		"bindings": [
+			{
+				"name": "MyDurableObject",
+				"class_name": "MyDurableObject",
+			},
+		],
+	},
+	"migrations": [
+		{
+			"tag": "v1",
+			"new_classes": ["MyDurableObject"],
+		},
+	],
+}
diff --git a/packages/vite-plugin-cloudflare/playground/worker/__tests__/worker.spec.ts b/packages/vite-plugin-cloudflare/playground/worker/__tests__/worker.spec.ts
@@ -16,3 +16,7 @@ test("receives the original host as the `X-Forwarded-Host` header", async () =>
 	const response = await getTextResponse("/x-forwarded-host");
 	expect(response).toBe(testUrl.host);
 });
+
+test("does not cause unhandled rejection", async () => {
+	expect(serverLogs.errors.join()).not.toContain("__unhandled rejection__");
+});
diff --git a/packages/vite-plugin-cloudflare/playground/worker/src/index.ts b/packages/vite-plugin-cloudflare/playground/worker/src/index.ts
@@ -13,3 +13,7 @@ export default {
 		return new Response("Hello World!");
 	},
 } satisfies ExportedHandler;
+
+addEventListener("unhandledrejection", (event) => {
+	console.error("__unhandled rejection__");
+});
diff --git a/packages/vite-plugin-cloudflare/src/runner-worker/index.ts b/packages/vite-plugin-cloudflare/src/runner-worker/index.ts
@@ -22,28 +22,27 @@ interface DurableObjectConstructor<T = unknown> {
 
 interface WorkflowEntrypointConstructor<T = unknown> {
 	new (
-		// Constructor type to be added in https://github.com/cloudflare/workerd/pull/3239
-		// ...args: ConstructorParameters<typeof WorkflowEntrypoint<T>>
-		ctx: ExecutionContext,
-		env: T
+		...args: ConstructorParameters<typeof WorkflowEntrypoint<T>>
 	): WorkflowEntrypoint<T>;
 }
 
+const IGNORED_KEYS = ["self", "tailStream"];
+
 const WORKER_ENTRYPOINT_KEYS = [
 	"fetch",
+	"queue",
 	"tail",
+	"test",
 	"trace",
 	"scheduled",
-	"queue",
-	"test",
 ] as const;
 
 const DURABLE_OBJECT_KEYS = [
-	"fetch",
 	"alarm",
-	"webSocketMessage",
+	"fetch",
 	"webSocketClose",
 	"webSocketError",
+	"webSocketMessage",
 ] as const;
 
 const WORKFLOW_ENTRYPOINT_KEYS = ["run"] as const;
@@ -145,8 +144,8 @@ export function createWorkerEntrypointWrapper(
 					}
 
 					if (
-						key === "self" ||
 						typeof key === "symbol" ||
+						IGNORED_KEYS.includes(key) ||
 						(DURABLE_OBJECT_KEYS as readonly string[]).includes(key)
 					) {
 						return;
@@ -293,8 +292,8 @@ export function createDurableObjectWrapper(
 					}
 
 					if (
-						key === "self" ||
 						typeof key === "symbol" ||
+						IGNORED_KEYS.includes(key) ||
 						(WORKER_ENTRYPOINT_KEYS as readonly string[]).includes(key)
 					) {
 						return;
diff --git a/packages/vitest-pool-workers/src/worker/entrypoints.ts b/packages/vitest-pool-workers/src/worker/entrypoints.ts
@@ -33,6 +33,8 @@ function importModule(
 	});
 }
 
+const IGNORED_KEYS = ["self", "tailStream"];
+
 /**
  * Create a class extending `superClass` with a `Proxy` as a `prototype`.
  * Unknown accesses on the `prototype` will defer to `getUnknownPrototypeKey()`.
@@ -62,7 +64,7 @@ function createProxyPrototypeClass<
 					return value;
 				}
 				// noinspection SuspiciousTypeOfGuard
-				if (key === "self" || typeof key === "symbol") {
+				if (typeof key === "symbol" || IGNORED_KEYS.includes(key)) {
 					return;
 				}
 				return getUnknownPrototypeKey.call(receiver, key as string);
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +"@cloudflare/vite-plugin": patch
 +---
++
 +Fixes two bugs that were caused by not accounting for an undocumented method on Workers and Durable Objects. `ctx.blockConcurrencyWhile` will now successfully block execution in Durable Objects and invoking Workers will no longer cause unhandled rejections.