Skip to content

feat(site): display builds logs by default #11597

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 12, 2024
+18 −14
Merged

feat(site): display builds logs by default #11597

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
68c7b3f
feat(site): display builds logs by default
BrunoQuaresma Jan 12, 2024
be252bd
Close websocket when finishes
BrunoQuaresma Jan 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 13 additions & 7 deletions site/src/hooks/useWorkspaceBuildLogs.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,20 +1,26 @@
import { watchBuildLogsByBuildId } from "api/api";
import { ProvisionerJobLog } from "api/typesGenerated";
import { displayError } from "components/GlobalSnackbar/utils";
import { useState, useEffect } from "react";
import { useState, useEffect, useRef } from "react";

// buildId is optional because sometimes the build is not loaded yet
export const useWorkspaceBuildLogs = (buildId?: string) => {
export const useWorkspaceBuildLogs = (
// buildId is optional because sometimes the build is not loaded yet
buildId: string | undefined,
enabled: boolean = true,
) => {
const [logs, setLogs] = useState<ProvisionerJobLog[]>();
const socket = useRef<WebSocket>();

useEffect(() => {
if (!buildId) {
if (!buildId || !enabled) {
socket.current?.close();
return;
}

// Every time this hook is called reset the values
setLogs(undefined);

const socket = watchBuildLogsByBuildId(buildId, {
socket.current = watchBuildLogsByBuildId(buildId, {
// Retrieve all the logs
after: -1,
onMessage: (log) => {
Expand All @@ -31,9 +37,9 @@ export const useWorkspaceBuildLogs = (buildId?: string) => {
});

return () => {
socket.close();
socket.current?.close();
};
}, [buildId]);
}, [buildId, enabled]);

return logs;
};
12 changes: 5 additions & 7 deletions site/src/pages/WorkspacePage/WorkspaceReadyPage.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ import { Helmet } from "react-helmet-async";
import { useNavigate } from "react-router-dom";
import { Workspace } from "./Workspace";
import { pageTitle } from "utils/page";
import { hasJobError } from "utils/workspace";
import { UpdateBuildParametersDialog } from "./UpdateBuildParametersDialog";
import { ChangeVersionDialog } from "./ChangeVersionDialog";
import { useMutation, useQuery, useQueryClient } from "react-query";
Expand Down Expand Up @@ -67,12 +66,11 @@ export const WorkspaceReadyPage = ({
});

// Build logs
const buildLogs = useWorkspaceBuildLogs(workspace.latest_build.id);
const shouldDisplayBuildLogs =
hasJobError(workspace) ||
["canceling", "deleting", "pending", "starting", "stopping"].includes(
workspace.latest_build.status,
);
const shouldDisplayBuildLogs = workspace.latest_build.status !== "running";
const buildLogs = useWorkspaceBuildLogs(
workspace.latest_build.id,
shouldDisplayBuildLogs,
);

// Restart
const [confirmingRestart, setConfirmingRestart] = useState<{
Expand Down