Skip to content

feat: display legacy idp mappings in idp sync settings #14866

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 2 commits into from
Sep 27, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import {
MockGroup2,
MockGroupSyncSettings,
MockGroupSyncSettings2,
MockLegacyMappingGroupSyncSettings,
MockOrganization,
MockRoleSyncSettings,
} from "testHelpers/entities";
Expand Down Expand Up @@ -74,3 +75,14 @@ export const MissingGroups: Story = {
error: undefined,
},
};

export const WithLegacyMapping: Story = {
args: {
groupSyncSettings: MockLegacyMappingGroupSyncSettings,
roleSyncSettings: MockRoleSyncSettings,
groups: [MockGroup, MockGroup2],
groupsMap,
organization: MockOrganization,
error: undefined,
},
};
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import TableCell from "@mui/material/TableCell";
import TableContainer from "@mui/material/TableContainer";
import TableHead from "@mui/material/TableHead";
import TableRow from "@mui/material/TableRow";
import Link from "@mui/material/Link";
import type {
Group,
GroupSyncSettings,
Expand All @@ -31,6 +32,13 @@ import { MONOSPACE_FONT_FAMILY } from "theme/constants";
import { docs } from "utils/docs";
import { ExportPolicyButton } from "./ExportPolicyButton";
import { IdpPillList } from "./IdpPillList";
import {
HelpTooltip,
HelpTooltipContent,
HelpTooltipText,
HelpTooltipTitle,
HelpTooltipTrigger,
} from "components/HelpTooltip/HelpTooltip";

interface IdpSyncPageViewProps {
groupSyncSettings: GroupSyncSettings | undefined;
Expand Down Expand Up @@ -60,6 +68,9 @@ export const IdpSyncPageView: FC<IdpSyncPageViewProps> = ({
const groupMappingCount = groupSyncSettings?.mapping
? Object.entries(groupSyncSettings.mapping).length
: 0;
const legacyGroupMappingCount = groupSyncSettings?.legacy_group_name_mapping
? Object.entries(groupSyncSettings.legacy_group_name_mapping).length
: 0;
const roleMappingCount = roleSyncSettings?.mapping
? Object.entries(roleSyncSettings.mapping).length
: 0;
Expand Down Expand Up @@ -88,22 +99,22 @@ export const IdpSyncPageView: FC<IdpSyncPageViewProps> = ({
{tab === "groups" ? (
<>
<div css={styles.fields}>
<Stack direction={"row"} alignItems={"center"} spacing={6}>
<Stack direction="row" alignItems="center" spacing={6}>
<IdpField
name={"Sync Field"}
name="Sync Field"
fieldText={groupSyncSettings?.field}
showDisabled
/>
<IdpField
name={"Regex Filter"}
name="Regex Filter"
fieldText={
typeof groupSyncSettings?.regex_filter === "string"
? groupSyncSettings.regex_filter
: "none"
}
/>
<IdpField
name={"Auto Create"}
name="Auto Create"
fieldText={
groupSyncSettings?.field
? String(groupSyncSettings?.auto_create_missing_groups)
Expand All @@ -126,10 +137,7 @@ export const IdpSyncPageView: FC<IdpSyncPageViewProps> = ({
/>
</Stack>
<Stack spacing={6}>
<IdpMappingTable
type="Group"
isEmpty={Boolean(groupMappingCount === 0)}
>
<IdpMappingTable type="Group" isEmpty={groupMappingCount === 0}>
{groupSyncSettings?.mapping &&
Object.entries(groupSyncSettings.mapping)
.sort()
Expand All @@ -141,13 +149,32 @@ export const IdpSyncPageView: FC<IdpSyncPageViewProps> = ({
/>
))}
</IdpMappingTable>
{groupSyncSettings?.legacy_group_name_mapping && (
<section>
<LegacyGroupSyncHeader />
<IdpMappingTable
type="Group"
isEmpty={legacyGroupMappingCount === 0}
>
{Object.entries(groupSyncSettings.legacy_group_name_mapping)
.sort()
.map(([idpGroup, groupId]) => (
<GroupRow
key={idpGroup}
idpGroup={idpGroup}
coderGroup={getGroupNames([groupId])}
/>
))}
</IdpMappingTable>
</section>
)}
</Stack>
</>
) : (
<>
<div css={styles.fields}>
<IdpField
name={"Sync Field"}
name="Sync Field"
fieldText={roleSyncSettings?.field}
showDisabled
/>
Expand All @@ -165,10 +192,7 @@ export const IdpSyncPageView: FC<IdpSyncPageViewProps> = ({
type="roles"
/>
</Stack>
<IdpMappingTable
type="Role"
isEmpty={Boolean(roleMappingCount === 0)}
>
<IdpMappingTable type="Role" isEmpty={roleMappingCount === 0}>
{roleSyncSettings?.mapping &&
Object.entries(roleSyncSettings.mapping)
.sort()
Expand Down Expand Up @@ -268,7 +292,7 @@ const IdpMappingTable: FC<IdpMappingTableProps> = ({
<Table>
<TableHead>
<TableRow>
<TableCell width="45%">Idp {type}</TableCell>
<TableCell width="45%">IdP {type}</TableCell>
Copy link
Contributor

Choose a reason for hiding this comment

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

good catch!

<TableCell width="55%">Coder {type}</TableCell>
</TableRow>
</TableHead>
Expand Down Expand Up @@ -359,12 +383,43 @@ const TableLoader = () => {
);
};

const LegacyGroupSyncHeader: FC = () => {
return (
<h4
css={{
fontSize: 20,
fontWeight: 500,
}}
>
<Stack direction="row" alignItems="end" spacing={1}>
<span>Legacy Group Sync Settings</span>
<HelpTooltip>
<HelpTooltipTrigger />
<HelpTooltipContent>
<HelpTooltipTitle>Legacy Group Sync Settings</HelpTooltipTitle>
<HelpTooltipText>
These settings were configured using environment variables, and
only apply to the default organization. It is now recommended to
configure IdP sync via the CLI, which enables sync to be
configured for any organization, and for those settings to be
persisted without manually setting environment variables.{" "}
<Link href={docs("/admin/auth#group-sync-enterprise")}>
Learn more&hellip;
</Link>
</HelpTooltipText>
</HelpTooltipContent>
</HelpTooltip>
</Stack>
</h4>
);
};

const styles = {
fieldText: (theme) => ({
fieldText: {
fontFamily: MONOSPACE_FONT_FAMILY,
whiteSpace: "nowrap",
paddingBottom: ".02rem",
}),
},
fieldLabel: (theme) => ({
color: theme.palette.text.secondary,
}),
Expand Down
9 changes: 9 additions & 0 deletions site/src/testHelpers/entities.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2618,6 +2618,15 @@ export const MockGroupSyncSettings: TypesGen.GroupSyncSettings = {
auto_create_missing_groups: false,
};

export const MockLegacyMappingGroupSyncSettings: TypesGen.GroupSyncSettings = {
...MockGroupSyncSettings,
mapping: {},
legacy_group_name_mapping: {
"idp-group-1": "fbd2116a-8961-4954-87ae-e4575bd29ce0",
"idp-group-2": "13de3eb4-9b4f-49e7-b0f8-0c3728a0d2e2",
},
};

export const MockGroupSyncSettings2: TypesGen.GroupSyncSettings = {
field: "group-test",
mapping: {
Expand Down
Loading