Skip to content

chore(site): remove workspace build machine #9813

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.

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 1 commit into from
Sep 22, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
12 changes: 6 additions & 6 deletions site/src/api/api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -792,11 +792,11 @@ export const getWorkspaceBuildByNumber = async (
};

export const getWorkspaceBuildLogs = async (
buildname: string,
buildId: string,
before: Date,
): Promise<TypesGen.ProvisionerJobLog[]> => {
const response = await axios.get<TypesGen.ProvisionerJobLog[]>(
`/api/v2/workspacebuilds/${buildname}/logs?before=${before.getTime()}`,
`/api/v2/workspacebuilds/${buildId}/logs?before=${before.getTime()}`,
);
return response.data;
};
Expand Down Expand Up @@ -1432,8 +1432,8 @@ export const watchWorkspaceAgentLogs = (
type WatchBuildLogsByBuildIdOptions = {
after?: number;
onMessage: (log: TypesGen.ProvisionerJobLog) => void;
onDone: () => void;
onError: (error: Error) => void;
onDone?: () => void;
onError?: (error: Error) => void;
};
export const watchBuildLogsByBuildId = (
buildId: string,
Expand All @@ -1454,12 +1454,12 @@ export const watchBuildLogsByBuildId = (
onMessage(JSON.parse(event.data) as TypesGen.ProvisionerJobLog),
);
socket.addEventListener("error", () => {
onError(new Error("Connection for logs failed."));
onError && onError(new Error("Connection for logs failed."));
socket.close();
});
socket.addEventListener("close", () => {
// When the socket closes, logs have finished streaming!
onDone();
onDone && onDone();
});
return socket;
};
Expand Down
13 changes: 13 additions & 0 deletions site/src/api/queries/workspaceBuilds.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
import * as API from "api/api";

export const workspaceBuildByNumber = (
username: string,
workspaceName: string,
buildNumber: number,
) => {
return {
queryKey: [username, workspaceName, "workspaceBuild", buildNumber],
queryFn: () =>
API.getWorkspaceBuildByNumber(username, workspaceName, buildNumber),
};
};
39 changes: 39 additions & 0 deletions site/src/hooks/useWorkspaceBuildLogs.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
import { watchBuildLogsByBuildId } from "api/api";
import { ProvisionerJobLog } from "api/typesGenerated";
import { displayError } from "components/GlobalSnackbar/utils";
import { useState, useEffect } from "react";

// buildId is optional because sometimes the build is not loaded yet
export const useWorkspaceBuildLogs = (buildId?: string) => {
const [logs, setLogs] = useState<ProvisionerJobLog[]>();
useEffect(() => {
if (!buildId) {
return;
}

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

const socket = watchBuildLogsByBuildId(buildId, {
// Retrieve all the logs
after: -1,
onMessage: (log) => {
setLogs((previousLogs) => {
if (!previousLogs) {
return [log];
}
return [...previousLogs, log];
});
},
onError: () => {
displayError("Error on getting the build logs");
},
});

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

return logs;
};
20 changes: 9 additions & 11 deletions site/src/pages/WorkspaceBuildPage/WorkspaceBuildPage.tsx
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
import { useMachine } from "@xstate/react";
import { FC, useEffect } from "react";
import { FC } from "react";
import { Helmet } from "react-helmet-async";
import { useParams } from "react-router-dom";
import { pageTitle } from "../../utils/page";
import { workspaceBuildMachine } from "../../xServices/workspaceBuild/workspaceBuildXService";
import { pageTitle } from "utils/page";
import { WorkspaceBuildPageView } from "./WorkspaceBuildPageView";
import { useQuery } from "@tanstack/react-query";
import { getWorkspaceBuilds } from "api/api";
import dayjs from "dayjs";
import { workspaceBuildByNumber } from "api/queries/workspaceBuilds";
import { useWorkspaceBuildLogs } from "hooks/useWorkspaceBuildLogs";

export const WorkspaceBuildPage: FC = () => {
const params = useParams() as {
Expand All @@ -18,10 +18,11 @@ export const WorkspaceBuildPage: FC = () => {
const workspaceName = params.workspace;
const buildNumber = Number(params.buildNumber);
const username = params.username.replace("@", "");
const [buildState, send] = useMachine(workspaceBuildMachine, {
context: { username, workspaceName, buildNumber, timeCursor: new Date() },
const wsBuildQuery = useQuery({
...workspaceBuildByNumber(username, workspaceName, buildNumber),
keepPreviousData: true,
});
const { logs, build } = buildState.context;
const build = wsBuildQuery.data;
const { data: builds } = useQuery({
queryKey: ["builds", username, build?.workspace_id],
queryFn: () => {
Expand All @@ -32,10 +33,7 @@ export const WorkspaceBuildPage: FC = () => {
},
enabled: Boolean(build),
});

useEffect(() => {
send("RESET", { buildNumber, timeCursor: new Date() });
}, [buildNumber, send]);
const logs = useWorkspaceBuildLogs(build?.id);

return (
<>
Expand Down
25 changes: 3 additions & 22 deletions site/src/pages/WorkspacePage/WorkspaceReadyPage.tsx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { useActor, useMachine } from "@xstate/react";
import { useActor } from "@xstate/react";
import { useDashboard } from "components/Dashboard/DashboardProvider";
import dayjs from "dayjs";
import { useFeatureVisibility } from "hooks/useFeatureVisibility";
Expand Down Expand Up @@ -28,12 +28,12 @@ import {
ConfirmDialog,
ConfirmDialogProps,
} from "components/Dialogs/ConfirmDialog/ConfirmDialog";
import { workspaceBuildMachine } from "xServices/workspaceBuild/workspaceBuildXService";
import * as TypesGen from "api/typesGenerated";
import { WorkspaceBuildLogsSection } from "./WorkspaceBuildLogsSection";
import { templateVersion, templateVersions } from "api/queries/templates";
import { Alert } from "components/Alert/Alert";
import { Stack } from "components/Stack/Stack";
import { useWorkspaceBuildLogs } from "hooks/useWorkspaceBuildLogs";

interface WorkspaceReadyPageProps {
workspaceState: StateFrom<typeof workspaceMachine>;
Expand Down Expand Up @@ -91,7 +91,7 @@ export const WorkspaceReadyPage = ({
enabled: workspace.outdated,
});

const buildLogs = useBuildLogs(workspace);
const buildLogs = useWorkspaceBuildLogs(workspace.latest_build.id);
const shouldDisplayBuildLogs =
hasJobError(workspace) ||
["canceling", "deleting", "pending", "starting", "stopping"].includes(
Expand Down Expand Up @@ -285,22 +285,3 @@ const WarningDialog: FC<
> = (props) => {
return <ConfirmDialog type="info" hideCancel={false} {...props} />;
};

const useBuildLogs = (workspace: TypesGen.Workspace) => {
const buildNumber = workspace.latest_build.build_number;
const [buildState, buildSend] = useMachine(workspaceBuildMachine, {
context: {
buildNumber,
username: workspace.owner_name,
workspaceName: workspace.name,
timeCursor: new Date(),
},
});
const { logs } = buildState.context;

useEffect(() => {
buildSend({ type: "RESET", buildNumber, timeCursor: new Date() });
}, [buildNumber, buildSend]);

return logs;
};
173 changes: 0 additions & 173 deletions site/src/xServices/workspaceBuild/workspaceBuildXService.ts

This file was deleted.