Skip to content

fix: improve provisioner details layout and show count line #14749

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 6 commits into from
Sep 20, 2024
Merged

fix: improve provisioner details layout and show count line #14749

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
1ba2ae1
きれい
aslilac Sep 20, 2024
d8b8884
とても大きい
aslilac Sep 20, 2024
70d0b7d
improve storybook test
aslilac Sep 20, 2024
cee2cbc
ボタン
aslilac Sep 20, 2024
669afbe
アイコンの名前
aslilac Sep 20, 2024
d3469a9
ジェ
aslilac Sep 20, 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
53 changes: 37 additions & 16 deletions site/src/modules/provisioners/ProvisionerGroup.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import { type Interpolation, type Theme, useTheme } from "@emotion/react";
import Business from "@mui/icons-material/Business";
import Person from "@mui/icons-material/Person";
import BusinessIcon from "@mui/icons-material/Business";
import PersonIcon from "@mui/icons-material/Person";
import TagIcon from "@mui/icons-material/Sell";
import Button from "@mui/material/Button";
import Link from "@mui/material/Link";
import Tooltip from "@mui/material/Tooltip";
Expand All @@ -21,6 +22,7 @@ import {
} from "components/Popover/Popover";
import { Stack } from "components/Stack/Stack";
import { StatusIndicator } from "components/StatusIndicator/StatusIndicator";
import isEqual from "lodash/isEqual";
import { type FC, useState } from "react";
import { createDayString } from "utils/createDayString";
import { docs } from "utils/docs";
Expand All @@ -30,14 +32,16 @@ type ProvisionerGroupType = "builtin" | "psk" | "key";

interface ProvisionerGroupProps {
readonly buildInfo?: BuildInfoResponse;
readonly keyName?: string;
readonly keyName: string;
readonly keyTags: Record<string, string>;
readonly type: ProvisionerGroupType;
readonly provisioners: readonly ProvisionerDaemon[];
}
Comment on lines 33 to 39
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a reason why we haven't been using the Readonly utility type more? I can't help but feel like this is a little less typing for just as much type-safety. Plus, I don't think any of our code will ever need to take advantage of interface merging

type ProvisionerGroupProps = Readonly<{
  buildInfo?: BuildInfoResponse;
  keyName: string;
  keyTags: Readonly<Record<string, string>>;
  type: ProvisionerGroupType;
  provisioners: readonly ProvisionerDaemon[];
}>

I know our entire API types file uses interfaces, but I'm a little fussed about that, since it's all auto-generated

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah, I've just been trying something 🤷‍♀️ idek if we get any benefit out of it when we immediately destructure the props off of the object in the component


export const ProvisionerGroup: FC<ProvisionerGroupProps> = ({
buildInfo,
keyName,
keyTags,
type,
provisioners,
}) => {
Expand All @@ -61,7 +65,7 @@ export const ProvisionerGroup: FC<ProvisionerGroupProps> = ({
provisioners.length === 1
? "1 provisioner"
: `${provisioners.length} provisioners`;
const extraTags = Object.entries(firstProvisioner.tags).filter(
const extraTags = Object.entries(keyTags).filter(
([key]) => key !== "scope" && key !== "owner",
);

Expand Down Expand Up @@ -90,6 +94,10 @@ export const ProvisionerGroup: FC<ProvisionerGroupProps> = ({
? "1 provisioner"
: `${provisionersWithWarnings} provisioners`;

const hasMultipleTagVariants =
type === "psk" &&
provisioners.some((it) => !isEqual(it.tags, { scope: "organization" }));

return (
<div
css={[
Expand Down Expand Up @@ -153,14 +161,26 @@ export const ProvisionerGroup: FC<ProvisionerGroupProps> = ({
justifyContent: "right",
}}
>
<Tooltip title="Scope">
<Pill
size="lg"
icon={daemonScope === "organization" ? <Business /> : <Person />}
>
<span css={{ textTransform: "capitalize" }}>{daemonScope}</span>
{!hasMultipleTagVariants ? (
<Tooltip title="Scope">
<Pill
size="lg"
icon={
daemonScope === "organization" ? (
<BusinessIcon />
) : (
<PersonIcon />
)
}
>
<span css={{ textTransform: "capitalize" }}>{daemonScope}</span>
</Pill>
</Tooltip>
) : (
<Pill size="lg" icon={<TagIcon />}>
Multiple tags
</Pill>
</Tooltip>
)}
{type === "key" &&
extraTags.map(([key, value]) => (
<ProvisionerTag key={key} tagName={key} tagValue={value} />
Expand All @@ -172,9 +192,9 @@ export const ProvisionerGroup: FC<ProvisionerGroupProps> = ({
<div
css={{
padding: "0 24px 24px",
display: "flex",
display: "grid",
gap: 12,
flexWrap: "wrap",
gridTemplateColumns: "repeat(auto-fill, minmax(385px, 1fr))",
}}
>
{provisionersWithWarningInfo.map((provisioner) => (
Expand All @@ -186,7 +206,6 @@ export const ProvisionerGroup: FC<ProvisionerGroupProps> = ({
border: `1px solid ${theme.palette.divider}`,
fontSize: 14,
padding: "14px 18px",
width: 375,
},
provisioner.warningCount > 0 && styles.warningBorder,
]}
Expand Down Expand Up @@ -222,7 +241,7 @@ export const ProvisionerGroup: FC<ProvisionerGroupProps> = ({
)}
</span>
</div>
{type === "psk" && (
{hasMultipleTagVariants && (
<PskProvisionerTags tags={provisioner.tags} />
)}
</Stack>
Expand Down Expand Up @@ -317,7 +336,8 @@ interface PskProvisionerTagsProps {

const PskProvisionerTags: FC<PskProvisionerTagsProps> = ({ tags }) => {
const daemonScope = tags.scope || "organization";
const iconScope = daemonScope === "organization" ? <Business /> : <Person />;
const iconScope =
daemonScope === "organization" ? <BusinessIcon /> : <PersonIcon />;

const extraTags = Object.entries(tags).filter(
([tag]) => tag !== "scope" && tag !== "owner",
Expand All @@ -343,6 +363,7 @@ const PskProvisionerTags: FC<PskProvisionerTagsProps> = ({ tags }) => {
css={{
"& .MuiPaper-root": {
padding: 20,
minWidth: "unset",
maxWidth: 340,
width: "fit-content",
},
Expand Down
58 changes: 46 additions & 12 deletions site/src/pages/ManagementSettingsPage/OrganizationProvisionersPageView.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import type { Meta, StoryObj } from "@storybook/react";
import { screen, userEvent } from "@storybook/test";
import {
MockBuildInfo,
MockProvisioner,
Expand Down Expand Up @@ -38,7 +39,11 @@ export const Provisioners: Story = {
],
},
{
key: { ...MockProvisionerKey, id: "ジャイデン", name: "ジャイデン" },
key: MockProvisionerPskKey,
daemons: [MockProvisioner, MockProvisioner2],
},
{
key: { ...MockProvisionerKey, id: "ジェイデン", name: "ジェイデン" },
daemons: [MockProvisioner, MockProvisioner2],
},
{
Expand All @@ -53,21 +58,50 @@ export const Provisioners: Story = {
],
},
{
key: { ...MockProvisionerKey, id: "ケイラ", name: "ケイラ" },
daemons: [
{
...MockProvisioner,
tags: {
...MockProvisioner.tags,
都市: "ユタ",
きっぷ: "yes",
ちいさい: "no",
},
key: {
...MockProvisionerKey,
id: "ケイラ",
name: "ケイラ",
tags: {
...MockProvisioner.tags,
都市: "ユタ",
きっぷ: "yes",
ちいさい: "no",
},
],
},
daemons: Array.from({ length: 117 }, (_, i) => ({
...MockProvisioner,
id: `ケイラ-${i}`,
name: `ケイラ-${i}`,
})),
},
],
},
play: async ({ step }) => {
await step("open all details", async () => {
const expandButtons = await screen.findAllByRole("button", {
name: "Show provisioner details",
});
for (const it of expandButtons) {
await userEvent.click(it);
}
});

await step("close uninteresting/large details", async () => {
const collapseButtons = await screen.findAllByRole("button", {
name: "Hide provisioner details",
});

await userEvent.click(collapseButtons[2]);
await userEvent.click(collapseButtons[3]);
await userEvent.click(collapseButtons[5]);
});

await step("show version popover", async () => {
const outOfDate = await screen.findByText("Out of date");
await userEvent.hover(outOfDate);
});
},
};

export const Empty: Story = {
Expand Down
51 changes: 35 additions & 16 deletions site/src/pages/ManagementSettingsPage/OrganizationProvisionersPageView.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,17 @@ export const OrganizationProvisionersPageView: FC<
> = ({ buildInfo, provisioners }) => {
const isEmpty = provisioners.every((group) => group.daemons.length === 0);

const provisionerGroupsCount = provisioners.length;
const provisionersCount = provisioners.reduce(
(a, group) => a + group.daemons.length,
0,
);

return (
<div>
<PageHeader
// The deployment settings layout already has padding.
css={{ paddingTop: 0 }}
css={{ paddingTop: 0, paddingBottom: 12 }}
actions={
<Button
endIcon={<OpenInNewIcon />}
Expand All @@ -42,22 +48,34 @@ export const OrganizationProvisionersPageView: FC<
>
<PageHeaderTitle>Provisioners</PageHeaderTitle>
</PageHeader>
{isEmpty ? (
<EmptyState
message="No provisioners"
description="A provisioner is required before you can create templates and workspaces. You can connect your first provisioner by following our documentation."
cta={
<Button
endIcon={<OpenInNewIcon />}
target="_blank"
href={docs("/admin/provisioners")}
>
Show me how to create a provisioner
</Button>
}
/>
) : (
<div
css={(theme) => ({
margin: 0,
fontSize: 12,
paddingBottom: 18,
color: theme.palette.text.secondary,
})}
>
Showing {provisionerGroupsCount} groups and {provisionersCount}{" "}
provisioners
</div>
)}
<Stack spacing={4.5}>
{isEmpty && (
<EmptyState
message="No provisioners"
description="A provisioner is required before you can create templates and workspaces. You can connect your first provisioner by following our documentation."
cta={
<Button
endIcon={<OpenInNewIcon />}
target="_blank"
href={docs("/admin/provisioners")}
>
Show me how to create a provisioner
</Button>
}
/>
)}
{provisioners.map((group) => {
const type = getGroupType(group.key);

Expand All @@ -74,6 +92,7 @@ export const OrganizationProvisionersPageView: FC<
key={group.key.id}
buildInfo={buildInfo}
keyName={group.key.name}
keyTags={group.key.tags}
type={type}
provisioners={group.daemons}
/>
Expand Down
Loading