Skip to content

feat(site): add a provisioner warning to workspace builds #15686

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 32 commits into from
Dec 11, 2024
Merged
Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
1c08ee4
add alert for workspace provisioning
SasSwart Nov 29, 2024
6bd9e00
Merge remote-tracking branch 'origin/main' into jjs/workspace-provisi…
SasSwart Dec 3, 2024
ad9725e
Add provisioner health warning to workspace page
SasSwart Dec 4, 2024
0056301
Add back build logs component
SasSwart Dec 5, 2024
cbeb0dd
make fmt
SasSwart Dec 5, 2024
32aec0b
remove defunct props
SasSwart Dec 5, 2024
79896b2
review notes, documentation and make fmt
SasSwart Dec 5, 2024
319bfce
lint
SasSwart Dec 5, 2024
3d34844
make fmt
SasSwart Dec 5, 2024
ffb5934
review notes
SasSwart Dec 5, 2024
a3c4726
expose provisioner daemons for pending jobs via the api
SasSwart Dec 9, 2024
18412e0
Merge remote-tracking branch 'origin' into jjs/workspace-provisioner-…
SasSwart Dec 9, 2024
ec57690
add back a function that went missing somehow
SasSwart Dec 9, 2024
53cc203
use the correct sqlc version
SasSwart Dec 9, 2024
5fac5ba
fix tests
SasSwart Dec 9, 2024
81fc829
fix tests
SasSwart Dec 9, 2024
dcf12b5
fix tests
SasSwart Dec 9, 2024
fcd7e2e
fix tests
SasSwart Dec 9, 2024
aa5fa4e
update golden files
SasSwart Dec 9, 2024
528b187
Rename new query
SasSwart Dec 9, 2024
d222432
make gen
SasSwart Dec 9, 2024
7b46ffe
make gen
SasSwart Dec 9, 2024
4ccf5d4
add workspaceloadingpage
SasSwart Dec 10, 2024
b954c93
make fmt
SasSwart Dec 10, 2024
38a9b21
fix provisioner warning display on workspace builds
SasSwart Dec 10, 2024
db62476
use the correct loader in the workspace page
SasSwart Dec 10, 2024
5885197
add tests
SasSwart Dec 11, 2024
f91c8ff
show workspace build logs at the appropriate time
SasSwart Dec 11, 2024
ad95c07
update dbmem to match provisioner daemon queries
SasSwart Dec 11, 2024
d2e1612
fix authz test
SasSwart Dec 11, 2024
c9bb07d
fix tests
SasSwart Dec 11, 2024
feaec5a
make gen
SasSwart Dec 11, 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
22 changes: 21 additions & 1 deletion site/src/modules/provisioners/ProvisionerAlert.stories.tsx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import type { Meta, StoryObj } from "@storybook/react";
import { chromatic } from "testHelpers/chromatic";
import { ProvisionerAlert } from "./ProvisionerAlert";
import { AlertVariant, ProvisionerAlert } from "./ProvisionerAlert";

const meta: Meta<typeof ProvisionerAlert> = {
title: "modules/provisioners/ProvisionerAlert",
Expand All @@ -21,6 +21,26 @@ export default meta;
type Story = StoryObj<typeof ProvisionerAlert>;

export const Info: Story = {};

export const InfoStyledForLogs: Story = {
args: {
variant: AlertVariant.Inline,
},
};

export const Warning: Story = {
args: {
severity: "warning",
},
};

export const WarningStyledForLogs: Story = {
args: {
severity: "warning",
variant: AlertVariant.Inline,
},
};

export const NullTags: Story = {
args: {
tags: undefined,
Expand Down
42 changes: 31 additions & 11 deletions site/src/modules/provisioners/ProvisionerAlert.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -4,31 +4,51 @@ import { AlertDetail } from "components/Alert/Alert";
import { Stack } from "components/Stack/Stack";
import { ProvisionerTag } from "modules/provisioners/ProvisionerTag";
import type { FC } from "react";
import type { Theme } from "@emotion/react";

export enum AlertVariant {
// Alerts are usually styled with a full rounded border and meant to use as a visually distinct element of the page.
// The Standalone variant conforms to this styling.
Standalone = "Standalone",
// We show these same alerts in environments such as log drawers where we stream the logs from builds.
// In this case the full border is incongruent with the surroundings of the component.
// The Inline variant replaces the full rounded border with a left border and a divider so that it complements the surroundings.
Inline = "Inline",
}

interface ProvisionerAlertProps {
title: string;
detail: string;
severity: AlertColor;
tags: Record<string, string>;
variant?: AlertVariant;
}

const getAlertStyles = (variant: AlertVariant, severity: AlertColor) => {
switch (variant) {
case AlertVariant.Inline:
return {
css: (theme: Theme) => ({
borderRadius: 0,
border: 0,
borderBottom: `1px solid ${theme.palette.divider}`,
borderLeft: `2px solid ${theme.palette[severity].main}`,
}),
};
default:
return {};
}
};

export const ProvisionerAlert: FC<ProvisionerAlertProps> = ({
title,
detail,
severity,
tags,
variant = AlertVariant.Standalone,
}) => {
return (
<Alert
severity={severity}
css={(theme) => {
return {
borderRadius: 0,
border: 0,
borderBottom: `1px solid ${theme.palette.divider}`,
borderLeft: `2px solid ${theme.palette[severity].main}`,
};
}}
>
<Alert severity={severity} {...getAlertStyles(variant, severity)}>
<AlertTitle>{title}</AlertTitle>
<AlertDetail>
<div>{detail}</div>
Expand Down
16 changes: 16 additions & 0 deletions site/src/modules/provisioners/ProvisionerStatusAlert.stories.tsx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import type { Meta, StoryObj } from "@storybook/react";
import { chromatic } from "testHelpers/chromatic";
import { MockTemplateVersion } from "testHelpers/entities";
import { AlertVariant } from "./ProvisionerAlert";
import { ProvisionerStatusAlert } from "./ProvisionerStatusAlert";

const meta: Meta<typeof ProvisionerStatusAlert> = {
Expand Down Expand Up @@ -47,9 +48,24 @@ export const NoMatchingProvisioners: Story = {
},
};

export const NoMatchingProvisionersInLogs: Story = {
args: {
matchingProvisioners: 0,
variant: AlertVariant.Inline,
},
};

export const NoAvailableProvisioners: Story = {
args: {
matchingProvisioners: 1,
availableProvisioners: 0,
},
};

export const NoAvailableProvisionersInLogs: Story = {
args: {
matchingProvisioners: 1,
availableProvisioners: 0,
variant: AlertVariant.Inline,
},
};
5 changes: 4 additions & 1 deletion site/src/modules/provisioners/ProvisionerStatusAlert.tsx
Original file line number Diff line number Diff line change
@@ -1,17 +1,19 @@
import type { AlertColor } from "components/Alert/Alert";
import type { FC } from "react";
import { ProvisionerAlert } from "./ProvisionerAlert";
import { AlertVariant, ProvisionerAlert } from "./ProvisionerAlert";

interface ProvisionerStatusAlertProps {
matchingProvisioners: number | undefined;
availableProvisioners: number | undefined;
tags: Record<string, string>;
variant?: AlertVariant;
}

export const ProvisionerStatusAlert: FC<ProvisionerStatusAlertProps> = ({
matchingProvisioners,
availableProvisioners,
tags,
variant = AlertVariant.Standalone,
}) => {
let title: string;
let detail: string;
Expand Down Expand Up @@ -42,6 +44,7 @@ export const ProvisionerStatusAlert: FC<ProvisionerStatusAlertProps> = ({
detail={detail}
severity={severity}
tags={tags}
variant={variant}
/>
);
};
2 changes: 2 additions & 0 deletions site/src/pages/CreateTemplatePage/BuildLogsDrawer.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import { visuallyHidden } from "@mui/utils";
import { JobError } from "api/queries/templates";
import type { TemplateVersion } from "api/typesGenerated";
import { Loader } from "components/Loader/Loader";
import { AlertVariant } from "modules/provisioners/ProvisionerAlert";
import { ProvisionerStatusAlert } from "modules/provisioners/ProvisionerStatusAlert";
import { useWatchVersionLogs } from "modules/templates/useWatchVersionLogs";
import { WorkspaceBuildLogs } from "modules/workspaces/WorkspaceBuildLogs/WorkspaceBuildLogs";
Expand Down Expand Up @@ -94,6 +95,7 @@ export const BuildLogsDrawer: FC<BuildLogsDrawerProps> = ({
matchingProvisioners={matchingProvisioners}
availableProvisioners={availableProvisioners}
tags={templateVersion?.job.tags ?? {}}
variant={AlertVariant.Inline}
/>
<Loader />
</>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ import {
import { Loader } from "components/Loader/Loader";
import { linkToTemplate, useLinks } from "modules/navigation";
import { ProvisionerAlert } from "modules/provisioners/ProvisionerAlert";
import { AlertVariant } from "modules/provisioners/ProvisionerAlert";
import { ProvisionerStatusAlert } from "modules/provisioners/ProvisionerStatusAlert";
import { TemplateFileTree } from "modules/templates/TemplateFiles/TemplateFileTree";
import { isBinaryData } from "modules/templates/TemplateFiles/isBinaryData";
Expand Down Expand Up @@ -593,6 +594,7 @@ export const TemplateVersionEditor: FC<TemplateVersionEditorProps> = ({
detail={templateVersion.job.error}
severity="error"
tags={templateVersion.job.tags}
variant={AlertVariant.Inline}
/>
</div>
) : (
Expand All @@ -602,6 +604,7 @@ export const TemplateVersionEditor: FC<TemplateVersionEditorProps> = ({
matchingProvisioners={matchingProvisioners}
availableProvisioners={availableProvisioners}
tags={templateVersion.job.tags}
variant={AlertVariant.Inline}
/>
<Loader css={{ height: "100%" }} />
</>
Expand Down
45 changes: 45 additions & 0 deletions site/src/pages/WorkspacePage/Workspace.stories.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,51 @@ export const PendingInQueue: Story = {
},
};

export const PendingWithNoProvisioners: Story = {
args: {
...Running.args,
workspace: {
...Mocks.MockPendingWorkspace,
latest_build: {
...Mocks.MockPendingWorkspace.latest_build,
matched_provisioners: {
count: 0,
available: 0,
},
},
},
},
};

export const PendingWithNoAvailableProvisioners: Story = {
args: {
...Running.args,
workspace: {
...Mocks.MockPendingWorkspace,
latest_build: {
...Mocks.MockPendingWorkspace.latest_build,
matched_provisioners: {
count: 1,
available: 0,
},
},
},
},
};

export const PendingWithUndefinedProvisioners: Story = {
args: {
...Running.args,
workspace: {
...Mocks.MockPendingWorkspace,
latest_build: {
...Mocks.MockPendingWorkspace.latest_build,
matched_provisioners: undefined,
},
},
},
};

export const Starting: Story = {
args: {
...Running.args,
Expand Down
20 changes: 20 additions & 0 deletions site/src/pages/WorkspacePage/Workspace.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import type * as TypesGen from "api/typesGenerated";
import { Alert, AlertDetail } from "components/Alert/Alert";
import { SidebarIconButton } from "components/FullPageLayout/Sidebar";
import { useSearchParamsKey } from "hooks/useSearchParamsKey";
import { ProvisionerStatusAlert } from "modules/provisioners/ProvisionerStatusAlert";
import { AgentRow } from "modules/resources/AgentRow";
import { WorkspaceTimings } from "modules/workspaces/WorkspaceTiming/WorkspaceTimings";
import type { FC } from "react";
Expand Down Expand Up @@ -108,6 +109,13 @@ export const Workspace: FC<WorkspaceProps> = ({
(r) => resourceOptionValue(r) === resourcesNav.value,
);

const provisionersHealthy =
(workspace.latest_build.matched_provisioners?.available ?? 0) > 0;
const shouldShowProvisionerAlert =
workspace.latest_build.status === "pending" &&
!provisionersHealthy &&
!buildLogs;

return (
<div
css={{
Expand Down Expand Up @@ -208,6 +216,18 @@ export const Workspace: FC<WorkspaceProps> = ({
/>
)}

{shouldShowProvisionerAlert && (
<ProvisionerStatusAlert
matchingProvisioners={
workspace.latest_build.matched_provisioners?.count
}
availableProvisioners={
workspace.latest_build.matched_provisioners?.available ?? 0
}
tags={workspace.latest_build.job.tags}
/>
)}

{workspace.latest_build.job.error && (
<Alert severity="error">
<AlertTitle>Workspace build failed</AlertTitle>
Expand Down
4 changes: 4 additions & 0 deletions site/src/testHelpers/entities.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1199,6 +1199,10 @@ export const MockWorkspaceBuild: TypesGen.WorkspaceBuild = {
resources: [MockWorkspaceResource],
status: "running",
daily_cost: 20,
matched_provisioners: {
count: 1,
available: 1,
},
};

export const MockWorkspaceBuildAutostart: TypesGen.WorkspaceBuild = {
Expand Down
Loading