chore(site): reduce fetch interval on workspaces page (#18725)

johnstcn · web-flow · commit 1195f3102536 · 2025-07-08T11:00:05.000+01:00
Relates to coder/internal#720 * Reduces workspaces data refetch interval if no builds are pending * Sets `refetchOnWindowFocus: always` to mitigate impact of reduced polling duration
diff --git a/site/src/pages/WorkspacesPage/WorkspacesPage.tsx b/site/src/pages/WorkspacesPage/WorkspacesPage.tsx
@@ -2,7 +2,7 @@ import { getErrorDetail, getErrorMessage } from "api/errors";
 import { workspacePermissionsByOrganization } from "api/queries/organizations";
 import { templates } from "api/queries/templates";
 import { workspaces } from "api/queries/workspaces";
-import type { Workspace } from "api/typesGenerated";
+import type { Workspace, WorkspaceStatus } from "api/typesGenerated";
 import { useFilter } from "components/Filter/Filter";
 import { useUserFilterMenu } from "components/Filter/UserFilter";
 import { displayError } from "components/GlobalSnackbar/utils";
@@ -22,6 +22,18 @@ import { WorkspacesPageView } from "./WorkspacesPageView";
 import { useBatchActions } from "./batchActions";
 import { useStatusFilterMenu, useTemplateFilterMenu } from "./filter/menus";
 
+// To reduce the number of fetches, we reduce the fetch interval if there are no
+// active workspace builds.
+const ACTIVE_BUILD_STATUSES: WorkspaceStatus[] = [
+	"canceling",
+	"deleting",
+	"pending",
+	"starting",
+	"stopping",
+];
+const ACTIVE_BUILDS_REFRESH_INTERVAL = 5_000;
+const NO_ACTIVE_BUILDS_REFRESH_INTERVAL = 30_000;
+
 function useSafeSearchParams() {
 	// Have to wrap setSearchParams because React Router doesn't make sure that
 	// the function's memory reference stays stable on each render, even though
@@ -78,8 +90,23 @@ const WorkspacesPage: FC = () => {
 	const { data, error, refetch } = useQuery({
 		...workspacesQueryOptions,
 		refetchInterval: ({ state }) => {
-			return state.error ? false : 5_000;
+			if (state.error) return false;
+
+			// Default to 5s interval until first fetch completes
+			if (!state.data) return ACTIVE_BUILDS_REFRESH_INTERVAL;
+
+			// Check if any workspace has an active build
+			const hasActiveBuilds = state.data.workspaces?.some((workspace) => {
+				const status = workspace.latest_build.status;
+				return ACTIVE_BUILD_STATUSES.includes(status);
+			});
+
+			// Poll every 5s if there are active builds, otherwise every 30s
+			return hasActiveBuilds
+				? ACTIVE_BUILDS_REFRESH_INTERVAL
+				: NO_ACTIVE_BUILDS_REFRESH_INTERVAL;
 		},
+		refetchOnWindowFocus: "always",
 	});
 
 	const [checkedWorkspaces, setCheckedWorkspaces] = useState<
