Skip to content

feat: group provisioners by authentication method #14580

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 17, 2024
Merged

feat: group provisioners by authentication method #14580

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
665c9b3
work
aslilac Sep 5, 2024
4558b44
do the stuff
aslilac Sep 6, 2024
fcd8614
🧹
aslilac Sep 6, 2024
401eab3
Merge branch 'main' into group-provisioners
aslilac Sep 17, 2024
716b257
hook up to api
aslilac Sep 17, 2024
a1b7cbd
:)
aslilac Sep 17, 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
1 change: 1 addition & 0 deletions site/src/modules/provisioners/Provisioner.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,7 @@ export const Provisioner: FC<ProvisionerProps> = ({
display: "flex",
flexWrap: "wrap",
gap: 12,
justifyContent: "right",
}}
>
<Tooltip title="Scope">
Expand Down
213 changes: 213 additions & 0 deletions site/src/modules/provisioners/ProvisionerGroup.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,213 @@
import { useTheme } from "@emotion/react";
import Business from "@mui/icons-material/Business";
import Person from "@mui/icons-material/Person";
import Button from "@mui/material/Button";
import Tooltip from "@mui/material/Tooltip";
import type { BuildInfoResponse, ProvisionerDaemon } from "api/typesGenerated";
import { DropdownArrow } from "components/DropdownArrow/DropdownArrow";
import { Pill } from "components/Pill/Pill";
import { type FC, useState } from "react";
import { createDayString } from "utils/createDayString";
import { ProvisionerTag } from "./ProvisionerTag";

type ProvisionerGroupType = "builtin" | "psk" | "key";

interface ProvisionerGroupProps {
readonly buildInfo?: BuildInfoResponse;
readonly keyName?: string;
readonly type: ProvisionerGroupType;
readonly provisioners: ProvisionerDaemon[];
}

export const ProvisionerGroup: FC<ProvisionerGroupProps> = ({
buildInfo,
keyName,
type,
provisioners,
}) => {
const [provisioner] = provisioners;
Copy link
Member

Choose a reason for hiding this comment

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

Should there be a check to make sure that the provisioners array isn't empty, or is that basically guaranteed not to happen?

If there are multiple provisioners, is there anything implied by the order they appear in? As in, is the first provisioner always the "main" one?

Copy link
Member Author

Choose a reason for hiding this comment

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

currently, it should never be passed an empty provisioners array, but I'm gonna refactor this to make it nicer.

const theme = useTheme();

const [showDetails, setShowDetails] = useState(false);

const daemonScope = provisioner.tags.scope || "organization";
const iconScope = daemonScope === "organization" ? <Business /> : <Person />;

const provisionerVersion = provisioner.version;
const allProvisionersAreSameVersion = provisioners.every(
(provisioner) => provisioner.version === provisionerVersion,
);
const upToDate =
allProvisionersAreSameVersion && buildInfo?.version === provisioner.version;
const provisionerCount =
provisioners.length === 1
? "1 provisioner"
: `${provisioners.length} provisioners`;

const extraTags = Object.entries(provisioner.tags).filter(
([key]) => key !== "scope" && key !== "owner",
);

return (
<div
css={{
borderRadius: 8,
border: `1px solid ${theme.palette.divider}`,
fontSize: 14,
}}
>
<header
css={{
padding: 24,
display: "flex",
alignItems: "center",
justifyContenxt: "space-between",
gap: 24,
}}
>
<div
css={{
display: "flex",
alignItems: "center",
gap: 24,
objectFit: "fill",
}}
>
{type === "builtin" && (
<div css={{ lineHeight: "160%" }}>
<h4 css={{ fontWeight: 500, margin: 0 }}>
Built-in provisioners
</h4>
<span css={{ color: theme.palette.text.secondary }}>
{provisionerCount} &mdash; Built-in
</span>
</div>
)}
{type === "psk" && (
<div css={{ lineHeight: "160%" }}>
<h4 css={{ fontWeight: 500, margin: 0 }}>PSK provisioners</h4>
<span css={{ color: theme.palette.text.secondary }}>
{provisionerCount} &mdash;{" "}
{allProvisionersAreSameVersion ? (
<code>{provisionerVersion}</code>
) : (
<span>Multiple versions</span>
)}
</span>
</div>
)}
{type === "key" && (
<div css={{ lineHeight: "160%" }}>
<h4 css={{ fontWeight: 500, margin: 0 }}>
Key group &ndash; {keyName}
</h4>
<span css={{ color: theme.palette.text.secondary }}>
{provisionerCount} &mdash;{" "}
{allProvisionersAreSameVersion ? (
<code>{provisionerVersion}</code>
) : (
<span>Multiple versions</span>
)}
</span>
</div>
)}
</div>
<div
css={{
marginLeft: "auto",
display: "flex",
flexWrap: "wrap",
gap: 12,
justifyContent: "right",
}}
>
<Tooltip title="Scope">
<Pill size="lg" icon={iconScope}>
<span
css={{
":first-letter": { textTransform: "uppercase" },
}}
>
{daemonScope}
</span>
</Pill>
</Tooltip>
{type === "key" &&
extraTags.map(([key, value]) => (
<ProvisionerTag key={key} tagName={key} tagValue={value} />
))}
</div>
</header>

{showDetails && (
<div
css={{
padding: "0 24px 24px",
display: "flex",
gap: 12,
flexWrap: "wrap",
}}
>
{provisioners.map((provisioner) => (
<div
key={provisioner.id}
css={{
borderRadius: 8,
border: `1px solid ${theme.palette.divider}`,
fontSize: 14,
padding: "12px 18px",
width: 310,
}}
>
<div css={{ lineHeight: "160%" }}>
<h4 css={{ fontWeight: 500, margin: 0 }}>{provisioner.name}</h4>
<span css={{ color: theme.palette.text.secondary }}>
{type === "builtin" ? (
<span>Built-in</span>
) : (
<>
{upToDate ? "Up to date" : provisioner.version} &mdash;{" "}
{provisioner.last_seen_at && (
<span data-chromatic="ignore">
Last seen {createDayString(provisioner.last_seen_at)}
</span>
)}
</>
)}
</span>
</div>
</div>
))}
</div>
)}

<div
css={{
borderTop: `1px solid ${theme.palette.divider}`,
display: "flex",
alignItems: "center",
justifyContent: "space-between",
padding: "8px 8px 8px 24px",
fontSize: 12,
color: theme.palette.text.secondary,
}}
>
<span>No warnings from {provisionerCount}</span>
<Button
variant="text"
css={{
display: "flex",
alignItems: "center",
gap: 4,
color: theme.roles.info.text,
fontSize: "inherit",
}}
onClick={() => setShowDetails((it) => !it)}
>
{showDetails ? "Hide" : "Show"} provisioner details{" "}
<DropdownArrow close={showDetails} />
</Button>
</div>
</div>
);
};
59 changes: 56 additions & 3 deletions site/src/pages/ManagementSettingsPage/OrganizationProvisionersPage.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,24 +1,72 @@
import { buildInfo } from "api/queries/buildInfo";
import {
organizationsPermissions,
provisionerDaemons,
} from "api/queries/organizations";
import type { Organization } from "api/typesGenerated";
import type { Organization, ProvisionerDaemon } from "api/typesGenerated";
import { ErrorAlert } from "components/Alert/ErrorAlert";
import { EmptyState } from "components/EmptyState/EmptyState";
import { Loader } from "components/Loader/Loader";
import { useEmbeddedMetadata } from "hooks/useEmbeddedMetadata";
import NotFoundPage from "pages/404Page/404Page";
import type { FC } from "react";
import { useQuery } from "react-query";
import { useParams } from "react-router-dom";
import { useOrganizationSettings } from "./ManagementSettingsLayout";
import { OrganizationProvisionersPageView } from "./OrganizationProvisionersPageView";
import {
OrganizationProvisionersPageView,
type ProvisionersByGroup,
} from "./OrganizationProvisionersPageView";

const ProvisionerKeyIDBuiltIn = "00000000-0000-0000-0000-000000000001";
const ProvisionerKeyIDUserAuth = "00000000-0000-0000-0000-000000000002";
const ProvisionerKeyIDPSK = "00000000-0000-0000-0000-000000000003";

function groupProvisioners(
provisioners: readonly ProvisionerDaemon[],
): ProvisionersByGroup {
const groups: ProvisionersByGroup = {
builtin: [],
psk: [],
userAuth: [],
keys: new Map(),
};
// NOTE: I'll fix this at the end of the PR chain
const keyName = "TODO";

for (const it of provisioners) {
if (it.key_id === ProvisionerKeyIDBuiltIn) {
groups.builtin.push(it);
continue;
}
if (it.key_id === ProvisionerKeyIDPSK) {
groups.psk.push(it);
continue;
}
if (it.key_id === ProvisionerKeyIDUserAuth) {
groups.userAuth.push(it);
continue;
}

const keyGroup = groups.keys.get(keyName) ?? [];
if (!groups.keys.has(keyName)) {
groups.keys.set(keyName, keyGroup);
}
keyGroup.push(it);
}

return groups;
}

const OrganizationProvisionersPage: FC = () => {
const { organization: organizationName } = useParams() as {
organization: string;
};
const { organizations } = useOrganizationSettings();

const { metadata } = useEmbeddedMetadata();
const buildInfoQuery = useQuery(buildInfo(metadata["build-info"]));

const organization = organizations
? getOrganizationByName(organizations, organizationName)
: undefined;
Expand Down Expand Up @@ -54,7 +102,12 @@ const OrganizationProvisionersPage: FC = () => {
return <NotFoundPage />;
}

return <OrganizationProvisionersPageView provisioners={provisioners} />;
return (
<OrganizationProvisionersPageView
buildInfo={buildInfoQuery.data}
provisioners={groupProvisioners(provisioners)}
/>
);
};

export default OrganizationProvisionersPage;
Expand Down
48 changes: 34 additions & 14 deletions site/src/pages/ManagementSettingsPage/OrganizationProvisionersPageView.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,29 +1,49 @@
import type { Meta, StoryObj } from "@storybook/react";
import { MockProvisioner, MockUserProvisioner } from "testHelpers/entities";
import {
MockBuildInfo,
MockProvisioner,
MockProvisioner2,
MockProvisionerWithTags,
MockUserProvisioner,
} from "testHelpers/entities";
import { OrganizationProvisionersPageView } from "./OrganizationProvisionersPageView";

const meta: Meta<typeof OrganizationProvisionersPageView> = {
title: "pages/OrganizationProvisionersPage",
component: OrganizationProvisionersPageView,
args: {
buildInfo: MockBuildInfo,
},
};

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

export const Provisioners: Story = {
args: {
provisioners: [
MockProvisioner,
MockUserProvisioner,
{
...MockProvisioner,
tags: {
...MockProvisioner.tags,
都市: "ユタ",
きっぷ: "yes",
ちいさい: "no",
},
},
],
provisioners: {
builtin: [MockProvisioner, MockProvisioner2],
psk: [MockProvisioner, MockUserProvisioner, MockProvisionerWithTags],
userAuth: [],
keys: new Map([
[
"ケイラ",
[
{
...MockProvisioner,
tags: {
...MockProvisioner.tags,
都市: "ユタ",
きっぷ: "yes",
ちいさい: "no",
},
warnings: [
{ code: "EUNKNOWN", message: "私は日本語が話せません" },
],
},
],
],
]),
},
},
};
Loading
Loading