[vitest-pool-workers] Fix Workflow binding's script_name when it matches its own Worker name (#10033)

* fix: make vitest-pool-workers not break if Workflow binding's script_name matches its own Worker name

removing try catch since error gets thrown either way

use userConfigPath instead of redirected one (#10005)

Revert "use userConfigPath instead of redirected one (#10005)"

This reverts commit 5c11fe7.

fix deep import

prettier run

fix: make vitest-pool-workers not break if Workflow binding's script_name matches its own Worker name

* apply suggestions from code review

* code review suggestion: delete script_name instead of replacing it

Author: pombosilva

.changeset/spotty-pants-jog.md

@@ -0,0 +1,5 @@
+---
+"@cloudflare/vitest-pool-workers": patch
+---
+
+Make vitest-pool-workers not break when a Workflow binding script_name matches its Worker name

packages/vitest-pool-workers/src/pool/index.ts

@@ -23,6 +23,7 @@ import {
 } from "miniflare";
 import semverSatisfies from "semver/functions/satisfies.js";
 import { createMethodsRPC } from "vitest/node";
+import { experimental_readRawConfig } from "wrangler";
 import { workerdBuiltinModules } from "../shared/builtin-modules";
 import { createChunkingSocket } from "../shared/chunking-socket";
 import { CompatibilityFlagAssertions } from "./compatibility-flag-assertions";
@@ -328,8 +329,36 @@ function fixupDurableObjectBindingsToSelf(
 	return result;
 }
 
+function getWranglerWorkerName(
+	relativeWranglerConfigPath?: string
+): string | undefined {
+	if (!relativeWranglerConfigPath) {
+		return undefined;
+	}
+	const wranglerConfigObject = experimental_readRawConfig({
+		config: relativeWranglerConfigPath,
+	});
+	return wranglerConfigObject.rawConfig.name;
+}
+
+function updateWorkflowsScriptNames(
+	runnerWorker: WorkerOptions,
+	wranglerWorkerName: string | undefined
+): void {
+	const workflows = runnerWorker.workflows;
+	if (!workflows || wranglerWorkerName === undefined) {
+		return;
+	}
+	for (const workflow of Object.values(workflows)) {
+		if (workflow.scriptName === wranglerWorkerName) {
+			delete workflow.scriptName;
+		}
+	}
+}
+
 function fixupWorkflowBindingsToSelf(
-	worker: SourcelessWorkerOptions
+	worker: SourcelessWorkerOptions,
+	relativeWranglerConfigPath: string | undefined
 ): Set<string> {
 	// TODO(someday): may need to extend this to take into account other workers
 	//  if doing multi-worker tests across workspace projects
@@ -340,8 +369,21 @@ function fixupWorkflowBindingsToSelf(
 	}
 	for (const key of Object.keys(worker.workflows)) {
 		const designator = worker.workflows[key];
+
+		let workerName: string | undefined;
+		// If the designator's scriptName matches its own Worker name,
+		// use that as the worker name, otherwise use the vitest worker's name
+		const wranglerWorkerName = getWranglerWorkerName(
+			relativeWranglerConfigPath
+		);
+		if (wranglerWorkerName && designator.scriptName === wranglerWorkerName) {
+			workerName = wranglerWorkerName;
+		} else {
+			workerName = worker.name;
+		}
+
 		// `designator` hasn't been validated at this point
-		if (isWorkflowDesignatorToSelf(designator, worker.name)) {
+		if (isWorkflowDesignatorToSelf(designator, workerName)) {
 			result.add(designator.className);
 			// Shallow clone to avoid mutating config
 			worker.workflows[key] = {
@@ -448,7 +490,7 @@ function buildProjectWorkerOptions(
 		fixupDurableObjectBindingsToSelf(runnerWorker)
 	).sort();
 	const workflowClassNames = Array.from(
-		fixupWorkflowBindingsToSelf(runnerWorker)
+		fixupWorkflowBindingsToSelf(runnerWorker, relativeWranglerConfigPath)
 	).sort();
 
 	if (
@@ -634,6 +676,13 @@ function buildProjectMiniflareOptions(
 		//  --> single instance with single runner worker
 		// Multiple Workers, Isolated Storage:
 		//  --> multiple instances each with single runner worker
+
+		// Set Workflows scriptName to the runner worker name if it matches the Wrangler worker name
+		const wranglerWorkerName = getWranglerWorkerName(
+			project.options.wrangler?.configPath
+		);
+		updateWorkflowsScriptNames(runnerWorker, wranglerWorkerName);
+
 		return {
 			...SHARED_MINIFLARE_OPTIONS,
 			inspectorPort,
@@ -653,6 +702,12 @@ function buildProjectMiniflareOptions(
 			testWorker.bindings = { ...testWorker.bindings };
 			testWorker.bindings[SELF_NAME_BINDING] = testWorker.name;
 
+			// Set Workflows scriptName to the test worker name if it matches the Wrangler worker name
+			const wranglerWorkerName = getWranglerWorkerName(
+				project.options.wrangler?.configPath
+			);
+			updateWorkflowsScriptNames(testWorker, wranglerWorkerName);
+
 			testWorkers.push(testWorker);
 		}
 		return {