Add review suggestions (miniflare do plugin, dispose introspectors)

Author: pombosilva

packages/miniflare/src/plugins/do/index.ts

@@ -34,7 +34,7 @@ export const DurableObjectsOptionsSchema = z.object({
 					unsafeUniqueKey: z
 						.union([z.string(), z.literal(kUnsafeEphemeralUniqueKey)])
 						.optional(),
-					unsafeScriptName: z.string().optional(),
+					unsafeScriptName: z.boolean().optional(),
 					// Prevents the Durable Object being evicted.
 					unsafePreventEviction: z.boolean().optional(),
 					remoteProxyConnectionString: z
@@ -72,7 +72,7 @@ export function normaliseDurableObject(
 			: undefined;
 	const serviceName =
 		isObject && designator.unsafeScriptName
-			? designator.unsafeScriptName
+			? designator.scriptName
 			: scriptName
 				? getUserServiceName(scriptName)
 				: undefined;

packages/miniflare/src/plugins/workflows/index.ts

@@ -106,9 +106,7 @@ export const WORKFLOWS_PLUGIN: Plugin<
 								className: "Engine",
 								enableSql: true,
 								uniqueKey,
-								// Note(osilva): the engine should not be prevented from eviction if we wish
-								// to abort it during tests (vitest-pool-workers)
-								// preventEviction: true,
+								preventEviction: true,
 							},
 						],
 						durableObjectStorage: {

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

@@ -538,7 +538,8 @@ Workflows defined in project: ${workflowClassNames.join(", ")}`);
 		const engineName = `${WORKFLOW_ENGINE_BINDING}${value.name.toUpperCase()}`;
 		runnerWorker.durableObjects[engineName] = {
 			className: "Engine",
-			unsafeScriptName: `workflows:${value.name}`,
+			scriptName: `workflows:${value.name}`,
+			unsafeScriptName: true,
 			unsafeUniqueKey: `miniflare-workflows-${value.name}`,
 		};
 	}

packages/vitest-pool-workers/src/worker/workflows.ts

@@ -103,6 +103,10 @@ class WorkflowInstanceIntrospectorHandle
 			// do nothing because we want to clean up this instance
 		}
 	}
+
+	async [Symbol.asyncDispose](): Promise<void> {
+		await this.cleanUp();
+	}
 }
 
 // See public facing `cloudflare:test` types for docs
@@ -111,7 +115,7 @@ export interface WorkflowIntrospector {
 
 	get(): WorkflowInstanceIntrospector[];
 
-	cleanUp(): void;
+	cleanUp(): Promise<void>;
 }
 
 export async function introspectWorkflow(
@@ -250,9 +254,17 @@ class WorkflowIntrospectorHandle implements WorkflowIntrospector {
 		return this.#instanceIntrospectors;
 	}
 
-	cleanUp(): void {
+	async cleanUp(): Promise<void> {
+		// also cleans all instance introspectors
+		await Promise.all(
+			this.#instanceIntrospectors.map((introspector) => introspector.cleanUp())
+		);
 		this.#modifierCallbacks = [];
 		this.#instanceIntrospectors = [];
 		this.#cleanupCallback();
 	}
+
+	async [Symbol.asyncDispose](): Promise<void> {
+		await this.cleanUp();
+	}
 }

packages/vitest-pool-workers/types/cloudflare-test.d.ts

@@ -200,12 +200,28 @@ declare module "cloudflare:test" {
 		waitForStatus(status: InstanceStatus["status"]): Promise<void>;
 
 		/**
-		 * Cleans up the Workflow instance.
+		 * Cleans the Workflow instance introspector.
+		 *
 		 * This is crucial for ensuring test isolation by preventing state from
-		 * leaking between tests. It's best practice to call this in an `afterEach`
-		 * hook or at the end of every test.
+		 * leaking between tests. It should be called at the end or after each test.
 		 */
 		cleanUp(): Promise<void>;
+
+		/**
+		 * An alias for {@link cleanUp} to support automatic disposal with the `using` keyword.
+		 * This is an alternative to calling `cleanUp()` in an `afterEach` hook.
+		 *
+		 * @see {@link cleanUp}
+		 * @example
+		 * it('my workflow test', async () => {
+		 * await using instance = await introspectWorkflowInstance(env.WORKFLOW, "123456");
+		 *
+		 * // ... your test logic ...
+		 *
+		 * // .cleanUp() is automatically called here at the end of the scope
+		 * });
+		 */
+		[Symbol.asyncDispose](): Promise<void>;
 	}
 
 	/**
@@ -406,19 +422,42 @@ declare module "cloudflare:test" {
 		 * @param fn - An async callback that receives a `WorkflowInstanceModifier` object.
 		 */
 		modifyAll(fn: (m: WorkflowInstanceModifier) => Promise<void>): void;
+
 		/**
-		 * Returns all `WorkflowInstanceIntrospectors` from Workflow instances
+		 * Returns all `WorkflowInstanceIntrospector`s from Workflow instances
 		 * created after calling `introspectWorkflow`.
 		 */
 		get(): WorkflowInstanceIntrospector[];
 
 		/**
-		 * Cleans up the Workflow introspector.
-		 * This is crucial for ensuring that the introspection of a Workflow does
-		 * not get persisted across tests.
-		 * Call this in an `afterEach` hook or at the end of every test.
+		 *
+		 * Cleans the introspector and every `WorkflowInstanceIntrospector` from Workflow
+		 * instances created after calling `introspectWorkflow`.
+		 *
+		 * This function is essential for test isolation, ensuring that results from one
+		 * test do not leak into the next. It should be called at the end or after each test.
+		 *
+		 * **Note:** After cleanup, `introspectWorkflow()` must be called again to begin
+		 * a new introspection.
+		 *
+		 */
+		cleanUp(): Promise<void>;
+
+		/**
+		 * An alias for {@link cleanUp} to support automatic disposal with the `using` keyword.
+		 * This is an alternative to calling `cleanUp()` in an `afterEach` hook.
+		 *
+		 * @see {@link cleanUp}
+		 * @example
+		 * it('my workflow test', async () => {
+		 * await using workflowIntrospector = await introspectWorkflow(env.WORKFLOW);
+		 *
+		 * // ... your test logic ...
+		 *
+		 * // .cleanUp() is automatically called here at the end of the scope
+		 * });
 		 */
-		cleanUp(): void;
+		[Symbol.asyncDispose](): Promise<void>;
 	}
 
 	// Only require `params` and `data` to be specified if they're non-empty