fix(site): watch build logs while job is pending or running (#15341)

ethanndickson · web-flow · commit 8b5a18cadee6 · 2024-11-06T01:20:27.000+11:00
Closes #15292. Currently, if the frontend never sees a build job enter 'running', it'll never end up watching the logs. If we start watching the logs earlier we're able to catch cases where the job goes `pending` -> `failed`, such as when the build fails immediately.
diff --git a/site/src/modules/templates/useWatchVersionLogs.ts b/site/src/modules/templates/useWatchVersionLogs.ts
@@ -20,7 +20,10 @@ export const useWatchVersionLogs = (
 			return;
 		}
 
-		if (templateVersionStatus !== "running") {
+		if (
+			templateVersionStatus !== "running" &&
+			templateVersionStatus !== "pending"
+		) {
 			return;
 		}
 
diff --git a/site/src/pages/TemplateVersionEditorPage/TemplateVersionEditorPage.test.tsx b/site/src/pages/TemplateVersionEditorPage/TemplateVersionEditorPage.test.tsx
@@ -324,14 +324,13 @@ test("display pending badge and update it to running when status changes", async
 		},
 	};
 
-	let calls = 0;
+	let running = false;
 	server.use(
 		http.get(
 			"/api/v2/organizations/:org/templates/:template/versions/:version",
 			() => {
-				calls += 1;
 				return HttpResponse.json(
-					calls > 1 ? MockRunningTemplateVersion : MockPendingTemplateVersion,
+					running ? MockRunningTemplateVersion : MockPendingTemplateVersion,
 				);
 			},
 		),
@@ -348,6 +347,10 @@ test("display pending badge and update it to running when status changes", async
 	const status = await screen.findByRole("status");
 	expect(status).toHaveTextContent("Pending");
 
+	// Manually update the endpoint, as to not rely on the editor page
+	// making a specific number of requests.
+	running = true;
+
 	await waitFor(
 		() => {
 			expect(status).toHaveTextContent("Running");

Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,10 @@ export const useWatchVersionLogs = (`
`20`	`20`	`return;`
`21`	`21`	`}`
`22`	`22`
`23`		`- if (templateVersionStatus !== "running") {`
	`23`	`+ if (`
	`24`	`+ templateVersionStatus !== "running" &&`
	`25`	`+ templateVersionStatus !== "pending"`
	`26`	`+ ) {`
`24`	`27`	`return;`
`25`	`28`	`}`
`26`	`29`