Skip to content

chore(site): refactor dormant badge and add stories #12555

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 1 commit into from
Mar 12, 2024
Merged

chore(site): refactor dormant badge and add stories #12555

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
41 changes: 41 additions & 0 deletions site/src/modules/workspaces/WorkspaceDormantBadge/WorkspaceDormantBadge.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
import type { Meta, StoryObj } from "@storybook/react";
import { userEvent, within } from "@storybook/test";
import { MockDormantWorkspace } from "testHelpers/entities";
import { WorkspaceDormantBadge } from "./WorkspaceDormantBadge";

const meta: Meta<typeof WorkspaceDormantBadge> = {
title: "modules/workspaces/WorkspaceDormantBadge",
component: WorkspaceDormantBadge,
args: {
workspace: MockDormantWorkspace,
},
};

export default meta;
type Story = StoryObj<typeof WorkspaceDormantBadge>;

export const Default: Story = {
play: async ({ canvasElement, step }) => {
const canvas = within(canvasElement);

await step("Open tooltip", async () => {
await userEvent.hover(canvas.getByRole("status"));
});
},
};

export const DeletingAt: Story = {
args: {
workspace: {
...MockDormantWorkspace,
deleting_at: "2024-03-12T14:17:12.196Z",
},
},
play: async ({ canvasElement, step }) => {
const canvas = within(canvasElement);

await step("Open tooltip", async () => {
await userEvent.hover(canvas.getByRole("status"));
});
},
};
58 changes: 58 additions & 0 deletions site/src/modules/workspaces/WorkspaceDormantBadge/WorkspaceDormantBadge.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
import AutoDeleteIcon from "@mui/icons-material/AutoDelete";
import RecyclingIcon from "@mui/icons-material/Recycling";
import Tooltip from "@mui/material/Tooltip";
import { formatDistanceToNow } from "date-fns";
import type { FC } from "react";
import type { Workspace } from "api/typesGenerated";
import { Pill } from "components/Pill/Pill";

export type WorkspaceDormantBadgeProps = {
workspace: Workspace;
};

export const WorkspaceDormantBadge: FC<WorkspaceDormantBadgeProps> = ({
workspace,
}) => {
const formatDate = (dateStr: string): string => {
const date = new Date(dateStr);
return date.toLocaleDateString(undefined, {
month: "long",
day: "numeric",
year: "numeric",
hour: "numeric",
minute: "numeric",
});
};

return workspace.deleting_at ? (
<Tooltip
title={
<>
This workspace has not been used for{" "}
{formatDistanceToNow(Date.parse(workspace.last_used_at))} and has been
marked dormant. It is scheduled to be deleted on{" "}
{formatDate(workspace.deleting_at)}.
</>
}
>
<Pill role="status" icon={<AutoDeleteIcon />} type="error">
Deletion Pending
</Pill>
</Tooltip>
) : (
<Tooltip
title={
<>
This workspace has not been used for{" "}
{formatDistanceToNow(Date.parse(workspace.last_used_at))} and has been
marked dormant. It is not scheduled for auto-deletion but will become
a candidate if auto-deletion is enabled on this template.
</>
}
>
<Pill role="status" icon={<RecyclingIcon />} type="warning">
Dormant
</Pill>
</Tooltip>
);
};
34 changes: 0 additions & 34 deletions site/src/modules/workspaces/WorkspaceStatusBadge/DormantDeletionText.tsx
View file
Open in desktop

This file was deleted.

103 changes: 0 additions & 103 deletions site/src/modules/workspaces/WorkspaceStatusBadge/WorkspaceStatusBadge.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,14 @@
import AutoDeleteIcon from "@mui/icons-material/AutoDelete";
import ErrorOutline from "@mui/icons-material/ErrorOutline";
import RecyclingIcon from "@mui/icons-material/Recycling";
import Tooltip, {
type TooltipProps,
tooltipClasses,
} from "@mui/material/Tooltip";
import { formatDistanceToNow } from "date-fns";
import type { FC, ReactNode } from "react";
import type { Workspace } from "api/typesGenerated";
import { ChooseOne, Cond } from "components/Conditionals/ChooseOne";
import { Pill } from "components/Pill/Pill";
import { useClassName } from "hooks/useClassName";
import { getDisplayWorkspaceStatus } from "utils/workspace";
import { DormantDeletionText } from "./DormantDeletionText";

export type WorkspaceStatusBadgeProps = {
workspace: Workspace;
Expand Down Expand Up @@ -73,105 +69,6 @@ export const WorkspaceStatusBadge: FC<WorkspaceStatusBadgeProps> = ({
);
};

export type DormantStatusBadgeProps = {
workspace: Workspace;
className?: string;
};

export const DormantStatusBadge: FC<DormantStatusBadgeProps> = ({
workspace,
className,
}) => {
if (!workspace.dormant_at) {
return null;
}

const formatDate = (dateStr: string): string => {
const date = new Date(dateStr);
return date.toLocaleDateString(undefined, {
month: "long",
day: "numeric",
year: "numeric",
hour: "numeric",
minute: "numeric",
});
};

return workspace.deleting_at ? (
<Tooltip
title={
<>
This workspace has not been used for{" "}
{formatDistanceToNow(Date.parse(workspace.last_used_at))} and has been
marked dormant. It is scheduled to be deleted on{" "}
{formatDate(workspace.deleting_at)}.
</>
}
>
<Pill
role="status"
className={className}
icon={<AutoDeleteIcon />}
type="error"
>
Deletion Pending
</Pill>
</Tooltip>
) : (
<Tooltip
title={
<>
This workspace has not been used for{" "}
{formatDistanceToNow(Date.parse(workspace.last_used_at))} and has been
marked dormant. It is not scheduled for auto-deletion but will become
a candidate if auto-deletion is enabled on this template.
</>
}
>
<Pill
role="status"
className={className}
icon={<RecyclingIcon />}
type="warning"
>
Dormant
</Pill>
</Tooltip>
);
};

export const WorkspaceStatusText: FC<WorkspaceStatusBadgeProps> = ({
workspace,
className,
}) => {
const { text, type } = getDisplayWorkspaceStatus(
workspace.latest_build.status,
);

return (
<ChooseOne>
<Cond condition={Boolean(DormantDeletionText({ workspace }))}>
<DormantDeletionText workspace={workspace} />
</Cond>
<Cond>
<span
role="status"
data-testid="build-status"
className={className}
css={(theme) => ({
fontWeight: 600,
color: type
? theme.roles[type].fill.solid
: theme.experimental.l1.text,
})}
>
{text}
</span>
</Cond>
</ChooseOne>
);
};

const FailureTooltip: FC<TooltipProps> = ({ children, ...tooltipProps }) => {
const popper = useClassName(
(css, theme) => css`
Expand Down
8 changes: 3 additions & 5 deletions site/src/pages/WorkspacesPage/WorkspacesTable.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,9 @@ import {
TableRowSkeleton,
} from "components/TableLoader/TableLoader";
import { useClickableTableRow } from "hooks/useClickableTableRow";
import { WorkspaceDormantBadge } from "modules/workspaces/WorkspaceDormantBadge/WorkspaceDormantBadge";
import { WorkspaceOutdatedTooltip } from "modules/workspaces/WorkspaceOutdatedTooltip/WorkspaceOutdatedTooltip";
import {
DormantStatusBadge,
WorkspaceStatusBadge,
} from "modules/workspaces/WorkspaceStatusBadge/WorkspaceStatusBadge";
import { WorkspaceStatusBadge } from "modules/workspaces/WorkspaceStatusBadge/WorkspaceStatusBadge";
import { LastUsed } from "pages/WorkspacesPage/LastUsed";
import { getDisplayWorkspaceTemplateName } from "utils/workspace";
import { WorkspacesEmpty } from "./WorkspacesEmpty";
Expand Down Expand Up @@ -214,7 +212,7 @@ export const WorkspacesTable: FC<WorkspacesTableProps> = ({
/>
)}
{workspace.dormant_at && (
<DormantStatusBadge workspace={workspace} />
<WorkspaceDormantBadge workspace={workspace} />
)}
</div>
</TableCell>
Expand Down