Skip to content

feat: add visual distinction for workspaces with running startup scripts #18984

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: add visual distinction for workspaces with running startup scripts #18984

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
51 changes: 33 additions & 18 deletions site/src/modules/workspaces/WorkspaceStatusIndicator/WorkspaceStatusIndicator.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,12 +41,24 @@ export const WorkspaceStatusIndicator: FC<WorkspaceStatusIndicatorProps> = ({
let { text, type } = getDisplayWorkspaceStatus(
workspace.latest_build.status,
workspace.latest_build.job,
workspace,
);

if (!workspace.health.healthy) {
type = "warning";
}

// Check if workspace is running but agents are still starting
const isStarting =
workspace.latest_build.status === "running" &&
workspace.latest_build.resources.some((resource) =>
resource.agents?.some(
(agent) =>
agent.lifecycle_state === "starting" ||
agent.lifecycle_state === "created",
),
);

const statusIndicator = (
<StatusIndicator variant={variantByStatusType[type]}>
<StatusIndicatorDot />
Expand All @@ -55,24 +67,27 @@ export const WorkspaceStatusIndicator: FC<WorkspaceStatusIndicatorProps> = ({
</StatusIndicator>
);

if (workspace.health.healthy) {
return statusIndicator;
// Show tooltip for unhealthy or starting workspaces
if (!workspace.health.healthy || isStarting) {
const tooltipMessage = !workspace.health.healthy
? "Your workspace is running but some agents are unhealthy."
: "Your workspace is running but startup scripts are still executing.";

return (
<TooltipProvider>
<Tooltip>
<TooltipTrigger asChild>
<StatusIndicator variant={variantByStatusType[type]}>
<StatusIndicatorDot />
<span className="sr-only">Workspace status:</span> {text}
{children}
</StatusIndicator>
</TooltipTrigger>
<TooltipContent>{tooltipMessage}</TooltipContent>
</Tooltip>
</TooltipProvider>
);
}

return (
<TooltipProvider>
<Tooltip>
<TooltipTrigger asChild>
<StatusIndicator variant={variantByStatusType[type]}>
<StatusIndicatorDot />
<span className="sr-only">Workspace status:</span> {text}
{children}
</StatusIndicator>
</TooltipTrigger>
<TooltipContent>
Your workspace is running but some agents are unhealthy.
</TooltipContent>
</Tooltip>
</TooltipProvider>
);
return statusIndicator;
};
123 changes: 123 additions & 0 deletions site/src/utils/workspace.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ import {
getDisplayVersionStatus,
getDisplayWorkspaceBuildInitiatedBy,
getDisplayWorkspaceTemplateName,
getDisplayWorkspaceStatus,
hasStartingAgents,
isWorkspaceOn,
} from "./workspace";

Expand Down Expand Up @@ -157,4 +159,125 @@ describe("util > workspace", () => {
expect(displayed).toEqual(workspace.template_display_name);
});
});

describe("hasStartingAgents", () => {
it("returns true when agents are starting", () => {
const workspace: TypesGen.Workspace = {
...Mocks.MockWorkspace,
latest_build: {
...Mocks.MockWorkspaceBuild,
resources: [
{
...Mocks.MockWorkspaceResource,
agents: [
{
...Mocks.MockWorkspaceAgent,
lifecycle_state: "starting",
},
],
},
],
},
};
expect(hasStartingAgents(workspace)).toBe(true);
});

it("returns true when agents are created", () => {
const workspace: TypesGen.Workspace = {
...Mocks.MockWorkspace,
latest_build: {
...Mocks.MockWorkspaceBuild,
resources: [
{
...Mocks.MockWorkspaceResource,
agents: [
{
...Mocks.MockWorkspaceAgent,
lifecycle_state: "created",
},
],
},
],
},
};
expect(hasStartingAgents(workspace)).toBe(true);
});

it("returns false when all agents are ready", () => {
const workspace: TypesGen.Workspace = {
...Mocks.MockWorkspace,
latest_build: {
...Mocks.MockWorkspaceBuild,
resources: [
{
...Mocks.MockWorkspaceResource,
agents: [
{
...Mocks.MockWorkspaceAgent,
lifecycle_state: "ready",
},
],
},
],
},
};
expect(hasStartingAgents(workspace)).toBe(false);
});
});

describe("getDisplayWorkspaceStatus with starting agents", () => {
it("shows 'Running (Starting...)' when workspace is running with starting agents", () => {
const workspace: TypesGen.Workspace = {
...Mocks.MockWorkspace,
latest_build: {
...Mocks.MockWorkspaceBuild,
status: "running",
resources: [
{
...Mocks.MockWorkspaceResource,
agents: [
{
...Mocks.MockWorkspaceAgent,
lifecycle_state: "starting",
},
],
},
],
},
};
const status = getDisplayWorkspaceStatus("running", undefined, workspace);
expect(status.text).toBe("Running (Starting...)");
expect(status.type).toBe("active");
});

it("shows 'Running' when workspace is running with all agents ready", () => {
const workspace: TypesGen.Workspace = {
...Mocks.MockWorkspace,
latest_build: {
...Mocks.MockWorkspaceBuild,
status: "running",
resources: [
{
...Mocks.MockWorkspaceResource,
agents: [
{
...Mocks.MockWorkspaceAgent,
lifecycle_state: "ready",
},
],
},
],
},
};
const status = getDisplayWorkspaceStatus("running", undefined, workspace);
expect(status.text).toBe("Running");
expect(status.type).toBe("success");
});

it("shows 'Running' when workspace parameter is not provided", () => {
const status = getDisplayWorkspaceStatus("running", undefined);
expect(status.text).toBe("Running");
expect(status.type).toBe("success");
});
});
});
20 changes: 17 additions & 3 deletions site/src/utils/workspace.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -182,9 +182,21 @@ type DisplayWorkspaceStatus = {
icon: React.ReactNode;
};

// Helper function to check if any agents are still starting
export const hasStartingAgents = (workspace: TypesGen.Workspace): boolean => {
return workspace.latest_build.resources.some((resource) =>
resource.agents?.some(
(agent) =>
agent.lifecycle_state === "starting" ||
agent.lifecycle_state === "created",
),
);
};

export const getDisplayWorkspaceStatus = (
workspaceStatus: TypesGen.WorkspaceStatus,
provisionerJob?: TypesGen.ProvisionerJob,
workspace?: TypesGen.Workspace,
): DisplayWorkspaceStatus => {
switch (workspaceStatus) {
case undefined:
Expand All @@ -194,10 +206,12 @@ export const getDisplayWorkspaceStatus = (
icon: <PillSpinner />,
} as const;
case "running":
// Check if workspace has agents that are still starting
const isStarting = workspace && hasStartingAgents(workspace);
return {
type: "success",
text: "Running",
icon: <PlayIcon />,
type: isStarting ? "active" : "success",
text: isStarting ? "Running (Starting...)" : "Running",
icon: isStarting ? <PillSpinner /> : <PlayIcon />,
} as const;
case "starting":
return {
Expand Down
Loading