Fix workflows binding to create a workflow without arguments & miss match instance.id between wrangler local dev and production (#7225)

* fix workflows binding to create a workflow without arguments

* prettify cleanup

* added changeset

* Update packages/workflows-shared/src/binding.ts

Accepted setting default values

Co-authored-by: Somhairle MacLeòid <[email protected]>

* pretttify run

* Update packages/workflows-shared/src/binding.ts

Co-authored-by: Skye <[email protected]>

* try to get instance.id

* new try

* pretty

* - ensure .id is available on handle, syncronously

* prettify

* updated changeset

* reverted workflows fixture

* better changeset

* reverted constructor sugar as per code review

* added regression test to the workflows fixture test

* prettify

---------

Co-authored-by: Somhairle MacLeòid <[email protected]>
Co-authored-by: Skye <[email protected]>

Author: 3 people

.changeset/nasty-monkeys-heal.md

@@ -0,0 +1,6 @@
+---
+"@cloudflare/workflows-shared": patch
+---
+
+- Fix workflows binding to create a workflow without arguments
+- Fix workflows instance.id not working the same way in wrangler local dev as it does in production

fixtures/workflow/src/index.ts

@@ -45,7 +45,11 @@ export default class extends WorkerEntrypoint<Env> {
 
 		let handle: WorkflowInstance;
 		if (url.pathname === "/create") {
-			handle = await this.env.WORKFLOW.create({ id });
+			if (id === null) {
+				handle = await this.env.WORKFLOW.create();
+			} else {
+				handle = await this.env.WORKFLOW.create({ id });
+			}
 		} else {
 			handle = await this.env.WORKFLOW.get(id);
 		}

fixtures/workflow/tests/index.test.ts

@@ -40,7 +40,7 @@ describe("Workflows", () => {
 		}
 	}
 
-	it("creates a workflow", async ({ expect }) => {
+	it("creates a workflow with id", async ({ expect }) => {
 		await expect(
 			fetchJson(`http://${ip}:${port}/create?workflowName=test`)
 		).resolves.toEqual({
@@ -75,4 +75,11 @@ describe("Workflows", () => {
 			{ timeout: 5000 }
 		);
 	});
+
+	it("creates a workflow without id", async ({ expect }) => {
+		await expect(fetchJson(`http://${ip}:${port}/create`)).resolves.toEqual({
+			status: "running",
+			output: [],
+		});
+	});
 });

packages/workflows-shared/src/binding.ts

@@ -14,12 +14,9 @@ type Env = {
 // this.env.WORKFLOW is WorkflowBinding
 export class WorkflowBinding extends WorkerEntrypoint<Env> implements Workflow {
 	public async create({
-		id,
-		params,
-	}: WorkflowInstanceCreateOptions): Promise<WorkflowInstance> {
-		if (!id) {
-			id = crypto.randomUUID();
-		}
+		id = crypto.randomUUID(),
+		params = {},
+	}: WorkflowInstanceCreateOptions = {}): Promise<WorkflowInstance> {
 		const stubId = this.env.ENGINE.idFromName(id);
 		const stub = this.env.ENGINE.get(stubId);
 
@@ -34,13 +31,37 @@ export class WorkflowBinding extends WorkerEntrypoint<Env> implements Workflow {
 			}
 		);
 
-		return new WorkflowHandle(id, stub);
+		const handle = new WorkflowHandle(id, stub);
+		return {
+			id: id,
+			pause: handle.pause.bind(handle),
+			resume: handle.resume.bind(handle),
+			terminate: handle.terminate.bind(handle),
+			restart: handle.restart.bind(handle),
+			status: handle.status.bind(handle),
+		};
 	}
 
 	public async get(id: string): Promise<WorkflowInstance> {
-		const stubId = this.env.ENGINE.idFromName(id);
-		const stub = this.env.ENGINE.get(stubId);
-		return new WorkflowHandle(id, stub);
+		const engineStubId = this.env.ENGINE.idFromName(id);
+		const engineStub = this.env.ENGINE.get(engineStubId);
+
+		const handle = new WorkflowHandle(id, engineStub);
+
+		try {
+			await handle.status();
+		} catch (e) {
+			throw new Error("instance.not_found");
+		}
+
+		return {
+			id: id,
+			pause: handle.pause.bind(handle),
+			resume: handle.resume.bind(handle),
+			terminate: handle.terminate.bind(handle),
+			restart: handle.restart.bind(handle),
+			status: handle.status.bind(handle),
+		};
 	}
 }