Show latest instance by default

Author: Caio-Nogueira

.changeset/yummy-dolls-rescue.md

@@ -0,0 +1,5 @@
+---
+"wrangler": minor
+---
+
+Show latest instance by dafault on `workflows instances describe` command

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

@@ -142,7 +142,7 @@ describe("wrangler workflows", () => {
 
 				COMMANDS
 				  wrangler workflows instances list <name>            Instance related commands (list, describe, terminate, pause, resume)
-				  wrangler workflows instances describe <name> <id>   Describe a workflow instance - see its logs, retries and errors
+				  wrangler workflows instances describe <name> [id]   Describe a workflow instance - see its logs, retries and errors
 				  wrangler workflows instances terminate <name> <id>  Terminate a workflow instance
 				  wrangler workflows instances pause <name> <id>      Pause a workflow instance
 				  wrangler workflows instances resume <name> <id>     Resume a workflow instance
@@ -314,6 +314,18 @@ describe("wrangler workflows", () => {
 						});
 					},
 					{ once: true }
+				),
+				http.get(
+					`*/accounts/:accountId/workflows/some-workflow/instances`,
+					async () => {
+						return HttpResponse.json({
+							success: true,
+							errors: [],
+							messages: [],
+							result: [mockResponse],
+						});
+					},
+					{ once: true }
 				)
 			);
 		};
@@ -328,6 +340,20 @@ describe("wrangler workflows", () => {
 │ Start                 │ End                   │ Duration  │ State      │ Error          │
 ├───────────────────────┼───────────────────────┼───────────┼────────────┼────────────────┤
 │ 1/1/2021, 12:00:00 AM │ 1/1/2021, 12:00:00 AM │ 0 seconds │ ✅ Success │ string: string │
+└───────────────────────┴───────────────────────┴───────────┴────────────┴────────────────┘"
+			`);
+		});
+
+		it("should describe the latest instance if none is given", async () => {
+			writeWranglerConfig();
+			await mockDescribeInstances();
+
+			await runWrangler(`workflows instances describe some-workflow`);
+			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 │
 └───────────────────────┴───────────────────────┴───────────┴────────────┴────────────────┘"
 			`);
 		});
@@ -360,7 +386,7 @@ describe("wrangler workflows", () => {
 
 			await runWrangler(`workflows instances pause some-workflow bar`);
 			expect(std.info).toMatchInlineSnapshot(
-				`"⏸️ The instance \\"bar\\" from some-workflow was paused successfully"`
+				`"⏸️ The instance "bar" from some-workflow was paused successfully"`
 			);
 		});
 	});
@@ -392,7 +418,7 @@ describe("wrangler workflows", () => {
 
 			await runWrangler(`workflows instances resume some-workflow bar`);
 			expect(std.info).toMatchInlineSnapshot(
-				`"🔄 The instance \\"bar\\" from some-workflow was resumed successfully"`
+				`"🔄 The instance "bar" from some-workflow was resumed successfully"`
 			);
 		});
 	});
@@ -424,7 +450,7 @@ describe("wrangler workflows", () => {
 
 			await runWrangler(`workflows instances terminate some-workflow bar`);
 			expect(std.info).toMatchInlineSnapshot(
-				`"🥷 The instance \\"bar\\" from some-workflow was terminated successfully"`
+				`"🥷 The instance "bar" from some-workflow was terminated successfully"`
 			);
 		});
 	});
@@ -436,7 +462,7 @@ describe("wrangler workflows", () => {
 
 			await runWrangler(`workflows instances terminate-all some-workflow`);
 			expect(std.info).toMatchInlineSnapshot(
-				`"🥷 A job to terminate instances from Workflow \\"some-workflow\\"  has been started. It might take a few minutes to complete."`
+				`"🥷 A job to terminate instances from Workflow "some-workflow"  has been started. It might take a few minutes to complete."`
 			);
 		});
 
@@ -446,7 +472,7 @@ describe("wrangler workflows", () => {
 
 			await runWrangler(`workflows instances terminate-all some-workflow`);
 			expect(std.info).toMatchInlineSnapshot(
-				`"🥷 A job to terminate instances from Workflow \\"some-workflow\\"  has been started. It might take a few minutes to complete."`
+				`"🥷 A job to terminate instances from Workflow "some-workflow"  has been started. It might take a few minutes to complete."`
 			);
 		});
 
@@ -458,7 +484,7 @@ describe("wrangler workflows", () => {
 				`workflows instances terminate-all some-workflow --status queued`
 			);
 			expect(std.info).toMatchInlineSnapshot(
-				`"🥷 A job to terminate instances from Workflow \\"some-workflow\\" with status \\"queued\\" has been started. It might take a few minutes to complete."`
+				`"🥷 A job to terminate instances from Workflow "some-workflow" with status "queued" has been started. It might take a few minutes to complete."`
 			);
 		});
 
@@ -474,7 +500,7 @@ describe("wrangler workflows", () => {
 				`workflows instances terminate-all some-workflow --status queued`
 			);
 			expect(std.info).toMatchInlineSnapshot(
-				`"🥷 A job to terminate instances from Workflow \\"some-workflow\\" with status \\"queued\\" is already running. It might take a few minutes to complete."`
+				`"🥷 A job to terminate instances from Workflow "some-workflow" with status "queued" is already running. It might take a few minutes to complete."`
 			);
 		});
 
@@ -489,7 +515,7 @@ describe("wrangler workflows", () => {
 			);
 			expect(std.err).toMatchInlineSnapshot(
 				`
-				"[31mX [41;31m[[41;97mERROR[41;31m][0m [1mProvided status \\"not-a-status\\" is not valid, it must be one of the following: queued, running, paused, waitingForPause, waiting.[0m
+				"[31mX [41;31m[[41;97mERROR[41;31m][0m [1mProvided status "not-a-status" is not valid, it must be one of the following: queued, running, paused, waitingForPause, waiting.[0m
 
 				"
 			`
@@ -527,7 +553,7 @@ describe("wrangler workflows", () => {
 			await runWrangler(`workflows trigger some-workflow`);
 			expect(std);
 			expect(std.info).toMatchInlineSnapshot(
-				`"🚀 Workflow instance \\"3c70754a-8435-4498-92ad-22e2e2c90853\\" has been queued successfully"`
+				`"🚀 Workflow instance "3c70754a-8435-4498-92ad-22e2e2c90853" has been queued successfully"`
 			);
 		});
 	});
@@ -541,7 +567,7 @@ describe("wrangler workflows", () => {
 			await runWrangler(`workflows delete some-workflow`);
 			expect(std.out).toMatchInlineSnapshot(
 				`
-				"✅ Workflow \\"some-workflow\\" removed successfully.
+				"✅ Workflow "some-workflow" removed successfully.
 				 Note that running instances might take a few minutes to be properly terminated."
 			`
 			);

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

@@ -43,7 +43,8 @@ export const workflowsInstancesDescribeCommand = createCommand({
 			describe:
 				"ID of the instance - instead of an UUID you can type 'latest' to get the latest instance and describe it",
 			type: "string",
-			demandOption: true,
+			demandOption: false,
+			default: "latest",
 		},
 		"step-output": {
 			describe:
@@ -77,6 +78,7 @@ export const workflowsInstancesDescribeCommand = createCommand({
 				return;
 			}
 
+			logRaw("Describing latest instance:");
 			id = instances[0].id;
 		}