Adds support for waitForEvent step type (#8981)

Author: Caio-Nogueira

.changeset/swift-hairs-run.md

@@ -0,0 +1,5 @@
+---
+"wrangler": minor
+---
+
+Adds support for waitForEvent step type

packages/wrangler/src/__tests__/workflows.test.ts

@@ -322,6 +322,14 @@ describe("wrangler workflows", () => {
 				},
 				versionId: "14707576-2549-4848-82ed-f68f8a1b47c7",
 				steps: [
+					{
+						type: "waitForEvent",
+						end: "2021-01-01T00:00:00Z",
+						name: "event",
+						finished: true,
+						output: {},
+						start: "2021-01-01T00:00:00Z",
+					},
 					{
 						attempts: [
 							{
@@ -374,11 +382,24 @@ describe("wrangler workflows", () => {
 
 			await runWrangler(`workflows instances describe some-workflow bar`);
 			expect(std.out).toMatchInlineSnapshot(`
-"┌───────────────────────┬───────────────────────┬───────────┬────────────┬────────────────┐
-│ Start                 │ End                   │ Duration  │ State      │ Error          │
-├───────────────────────┼───────────────────────┼───────────┼────────────┼────────────────┤
-│ 1/1/2021, 12:00:00 AM │ 1/1/2021, 12:00:00 AM │ 0 seconds │ ✅ Success │ string: string │
-└───────────────────────┴───────────────────────┴───────────┴────────────┴────────────────┘"
+				"  Name:      event
+				  Type:      👀 Waiting for event
+				  Start:     1/1/2021, 12:00:00 AM
+				  End:       1/1/2021, 12:00:00 AM
+				  Duration:  0 seconds
+				  Output:    {}
+				  Name:      string
+				  Type:      🎯 Step
+				  Start:     1/1/2021, 12:00:00 AM
+				  End:       1/1/2021, 12:00:00 AM
+				  Duration:  0 seconds
+				  Success:   ✅ Yes
+				  Output:    {}
+				┌───────────────────────┬───────────────────────┬───────────┬────────────┬────────────────┐
+				│ Start                 │ End                   │ Duration  │ State      │ Error          │
+				├───────────────────────┼───────────────────────┼───────────┼────────────┼────────────────┤
+				│ 1/1/2021, 12:00:00 AM │ 1/1/2021, 12:00:00 AM │ 0 seconds │ ✅ Success │ string: string │
+				└───────────────────────┴───────────────────────┴───────────┴────────────┴────────────────┘"
 			`);
 		});
 	});

packages/wrangler/src/workflows/commands/instances/describe.ts

@@ -22,6 +22,7 @@ import type {
 	InstanceStatusAndLogs,
 	InstanceStepLog,
 	InstanceTerminateLog,
+	InstanceWaitForEventLog,
 } from "../../types";
 
 export const workflowsInstancesDescribeCommand = createCommand({
@@ -140,12 +141,20 @@ export const workflowsInstancesDescribeCommand = createCommand({
 
 function logStep(
 	args: typeof workflowsInstancesDescribeCommand.args,
-	step: InstanceStepLog | InstanceSleepLog | InstanceTerminateLog
+	step:
+		| InstanceStepLog
+		| InstanceSleepLog
+		| InstanceTerminateLog
+		| InstanceWaitForEventLog
 ) {
 	logRaw("");
 	const formattedStep: Record<string, string> = {};
 
-	if (step.type == "sleep" || step.type == "step") {
+	if (
+		step.type == "sleep" ||
+		step.type == "step" ||
+		step.type == "waitForEvent"
+	) {
 		formattedStep.Name = step.name;
 		formattedStep.Type = emojifyStepType(step.type);
 
@@ -197,6 +206,9 @@ function logStep(
 					`${retryDate.toLocaleString()} (in ${formatDistanceToNowStrict(retryDate)} from now)`;
 			}
 		}
+	}
+
+	if (step.type == "step" || step.type == "waitForEvent") {
 		if (step.output !== undefined && args.stepOutput) {
 			let output: string;
 			try {
@@ -212,7 +224,7 @@ function logStep(
 		}
 	}
 
-	logRaw(formatLabelledValues(formattedStep, { indentationCount: 2 }));
+	logger.log(formatLabelledValues(formattedStep, { indentationCount: 2 }));
 
 	if (step.type == "step") {
 		const prettyAttempts = step.attempts.map((val) => {

packages/wrangler/src/workflows/types.ts

@@ -91,6 +91,16 @@ export type InstanceTerminateLog = {
 	};
 };
 
+export type InstanceWaitForEventLog = {
+	name: string;
+	start: string;
+	end: string;
+	finished: boolean;
+	error: { name: string; message: string } | null;
+	output: unknown;
+	type: "waitForEvent";
+};
+
 export type InstanceStatusAndLogs = {
 	status: InstanceStatus;
 	params: Record<string, unknown>;
@@ -101,7 +111,12 @@ export type InstanceStatusAndLogs = {
 	queued: string;
 	start: string | null;
 	end: string | null;
-	steps: (InstanceStepLog | InstanceSleepLog | InstanceTerminateLog)[];
+	steps: (
+		| InstanceStepLog
+		| InstanceSleepLog
+		| InstanceTerminateLog
+		| InstanceWaitForEventLog
+	)[];
 	success: boolean | null;
 	error: { name: string; message: string } | null;
 };

packages/wrangler/src/workflows/utils.ts

@@ -47,6 +47,8 @@ export const emojifyStepType = (type: string) => {
 			return "💤 Sleeping";
 		case "termination":
 			return "🚫 Termination";
+		case "waitForEvent":
+			return "👀 Waiting for event";
 		default:
 			return "❓ Unknown";
 	}