Skip to content

feat: show warning on unrecognized idp group and role mapping claims #16485

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 25 commits into from
Feb 7, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
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
2 changes: 1 addition & 1 deletion site/src/api/api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -804,7 +804,7 @@ class ApiMethods {
) => {
const params = new URLSearchParams();
params.set("claimField", field);
const response = await this.axios.get<TypesGen.Response>(
const response = await this.axios.get<readonly string[]>(
`/api/v2/organizations/${organization}/settings/idpsync/field-values?${params}`,
);
return response.data;
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import type { Meta, StoryObj } from "@storybook/react";
import { userEvent, within } from "@storybook/test";
import { expect, userEvent, within } from "@storybook/test";
import {
MockOrganization,
MockOrganization2,
Expand Down Expand Up @@ -45,10 +45,16 @@ export const MissingGroups: Story = {
},
};

export const MissingClaim: Story = {
export const MissingClaims: Story = {
args: {
claimFieldValues: [],
},
play: async ({ canvasElement }) => {
const user = userEvent.setup();
const warning = canvasElement.querySelector(".lucide-triangle-alert")!;
expect(warning).not.toBe(null);
await user.hover(warning);
},
};

export const AssignDefaultOrgWarningDialog: Story = {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
import { TooltipProvider } from "@radix-ui/react-tooltip";
import type {
Organization,
OrganizationSyncSettings,
Expand Down Expand Up @@ -30,7 +29,6 @@ import {
type Option,
} from "components/MultiSelectCombobox/MultiSelectCombobox";
import { Spinner } from "components/Spinner/Spinner";
import { Stack } from "components/Stack/Stack";
import { Switch } from "components/Switch/Switch";
import {
Table,
Expand All @@ -42,6 +40,7 @@ import {
import {
Tooltip,
TooltipContent,
TooltipProvider,
TooltipTrigger,
} from "components/Tooltip/Tooltip";
import { useFormik } from "formik";
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,14 @@ import {
} from "components/MultiSelectCombobox/MultiSelectCombobox";
import { Spinner } from "components/Spinner/Spinner";
import { Switch } from "components/Switch/Switch";
import {
Tooltip,
TooltipContent,
TooltipProvider,
TooltipTrigger,
} from "components/Tooltip/Tooltip";
import { useFormik } from "formik";
import { Plus, Trash } from "lucide-react";
import { Plus, Trash, TriangleAlert } from "lucide-react";
import { type FC, useId, useState } from "react";
import { docs } from "utils/docs";
import { isUUID } from "utils/uuid";
Expand All @@ -32,16 +38,6 @@ import { ExportPolicyButton } from "./ExportPolicyButton";
import { IdpMappingTable } from "./IdpMappingTable";
import { IdpPillList } from "./IdpPillList";

interface IdpGroupSyncFormProps {
groupSyncSettings: GroupSyncSettings;
groupsMap: Map<string, string>;
groups: Group[];
groupMappingCount: number;
legacyGroupMappingCount: number;
organization: Organization;
onSubmit: (data: GroupSyncSettings) => void;
}

const groupSyncValidationSchema = Yup.object({
field: Yup.string().trim(),
regex_filter: Yup.string().trim(),
Expand All @@ -65,15 +61,27 @@ const groupSyncValidationSchema = Yup.object({
.default({}),
});

export const IdpGroupSyncForm = ({
interface IdpGroupSyncFormProps {
groupSyncSettings: GroupSyncSettings;
claimFieldValues: readonly string[] | undefined;
groupsMap: Map<string, string>;
groups: Group[];
groupMappingCount: number;
legacyGroupMappingCount: number;
organization: Organization;
onSubmit: (data: GroupSyncSettings) => void;
}

export const IdpGroupSyncForm: FC<IdpGroupSyncFormProps> = ({
groupSyncSettings,
claimFieldValues,
groupMappingCount,
legacyGroupMappingCount,
groups,
groupsMap,
organization,
onSubmit,
}: IdpGroupSyncFormProps) => {
}) => {
const form = useFormik<GroupSyncSettings>({
initialValues: {
field: groupSyncSettings?.field ?? "",
Expand Down Expand Up @@ -270,6 +278,7 @@ export const IdpGroupSyncForm = ({
<GroupRow
key={idpGroup}
idpGroup={idpGroup}
exists={claimFieldValues?.includes(idpGroup)}
coderGroup={getGroupNames(groups)}
onDelete={handleDelete}
/>
Expand All @@ -288,6 +297,7 @@ export const IdpGroupSyncForm = ({
<GroupRow
key={groupId}
idpGroup={idpGroup}
exists={claimFieldValues?.includes(idpGroup)}
coderGroup={getGroupNames([groupId])}
onDelete={handleDelete}
/>
Expand All @@ -303,17 +313,48 @@ export const IdpGroupSyncForm = ({

interface GroupRowProps {
idpGroup: string;
exists: boolean | undefined;
coderGroup: readonly string[];
onDelete: (idpOrg: string) => void;
}

const GroupRow: FC<GroupRowProps> = ({ idpGroup, coderGroup, onDelete }) => {
const GroupRow: FC<GroupRowProps> = ({
idpGroup,
exists = true,
coderGroup,
onDelete,
}) => {
return (
<TableRow data-testid={`group-${idpGroup}`}>
<TableCell>{idpGroup}</TableCell>
<TableCell>
<div className="flex flex-row items-center gap-2 text-content-primary">
{idpGroup}
{!exists && (
<TooltipProvider>
<Tooltip>
<TooltipTrigger asChild>
<TriangleAlert className="size-icon-xs cursor-pointer text-content-warning" />
</TooltipTrigger>
<TooltipContent
align="start"
alignOffset={-8}
sideOffset={8}
className="p-2 text-xs text-content-secondary max-w-sm"
>
This value has not be seen in the specified claim field
before. You might want to check your IdP configuration and
ensure that this value is not misspelled.
</TooltipContent>
</Tooltip>
</TooltipProvider>
)}
</div>
</TableCell>

<TableCell>
<IdpPillList roles={coderGroup} />
</TableCell>

<TableCell>
<Button
variant="outline"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,22 +9,20 @@ import {
type Option,
} from "components/MultiSelectCombobox/MultiSelectCombobox";
import { Spinner } from "components/Spinner/Spinner";
import {
Tooltip,
TooltipContent,
TooltipProvider,
TooltipTrigger,
} from "components/Tooltip/Tooltip";
import { useFormik } from "formik";
import { Plus, Trash } from "lucide-react";
import { Plus, Trash, TriangleAlert } from "lucide-react";
import { type FC, useId, useState } from "react";
import * as Yup from "yup";
import { ExportPolicyButton } from "./ExportPolicyButton";
import { IdpMappingTable } from "./IdpMappingTable";
import { IdpPillList } from "./IdpPillList";

interface IdpRoleSyncFormProps {
roleSyncSettings: RoleSyncSettings;
roleMappingCount: number;
organization: Organization;
roles: Role[];
onSubmit: (data: RoleSyncSettings) => void;
}

const roleSyncValidationSchema = Yup.object({
field: Yup.string().trim(),
regex_filter: Yup.string().trim(),
Expand All @@ -48,13 +46,23 @@ const roleSyncValidationSchema = Yup.object({
.default({}),
});

export const IdpRoleSyncForm = ({
interface IdpRoleSyncFormProps {
roleSyncSettings: RoleSyncSettings;
claimFieldValues: readonly string[] | undefined;
roleMappingCount: number;
organization: Organization;
roles: Role[];
onSubmit: (data: RoleSyncSettings) => void;
}

export const IdpRoleSyncForm: FC<IdpRoleSyncFormProps> = ({
roleSyncSettings,
claimFieldValues,
roleMappingCount,
organization,
roles,
onSubmit,
}: IdpRoleSyncFormProps) => {
}) => {
const form = useFormik<RoleSyncSettings>({
initialValues: {
field: roleSyncSettings?.field ?? "",
Expand Down Expand Up @@ -210,6 +218,7 @@ export const IdpRoleSyncForm = ({
<RoleRow
key={idpRole}
idpRole={idpRole}
exists={claimFieldValues?.includes(idpRole)}
coderRoles={roles}
onDelete={handleDelete}
/>
Expand All @@ -222,17 +231,48 @@ export const IdpRoleSyncForm = ({

interface RoleRowProps {
idpRole: string;
exists: boolean | undefined;
coderRoles: readonly string[];
onDelete: (idpOrg: string) => void;
}

const RoleRow: FC<RoleRowProps> = ({ idpRole, coderRoles, onDelete }) => {
const RoleRow: FC<RoleRowProps> = ({
idpRole,
exists = true,
coderRoles,
onDelete,
}) => {
return (
<TableRow data-testid={`role-${idpRole}`}>
<TableCell>{idpRole}</TableCell>
<TableCell>
<div className="flex flex-row items-center gap-2 text-content-primary">
{idpRole}
{!exists && (
<TooltipProvider>
<Tooltip>
<TooltipTrigger asChild>
<TriangleAlert className="size-icon-xs cursor-pointer text-content-warning" />
</TooltipTrigger>
<TooltipContent
align="start"
alignOffset={-8}
sideOffset={8}
className="p-2 text-xs text-content-secondary max-w-sm"
>
This value has not be seen in the specified claim field
before. You might want to check your IdP configuration and
ensure that this value is not misspelled.
</TooltipContent>
</Tooltip>
</TooltipProvider>
)}
</div>
</TableCell>

<TableCell>
<IdpPillList roles={coderRoles} />
</TableCell>

<TableCell>
<Button
variant="outline"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ import { getErrorMessage } from "api/errors";
import { groupsByOrganization } from "api/queries/groups";
import {
groupIdpSyncSettings,
organizationIdpSyncClaimFieldValues,
patchGroupSyncSettings,
patchRoleSyncSettings,
roleIdpSyncSettings,
Expand All @@ -17,8 +18,8 @@ import { useFeatureVisibility } from "modules/dashboard/useFeatureVisibility";
import { useOrganizationSettings } from "modules/management/OrganizationSettingsLayout";
import type { FC } from "react";
import { Helmet } from "react-helmet-async";
import { useMutation, useQueries, useQueryClient } from "react-query";
import { useParams } from "react-router-dom";
import { useMutation, useQueries, useQuery, useQueryClient } from "react-query";
import { useParams, useSearchParams } from "react-router-dom";
import { docs } from "utils/docs";
import { pageTitle } from "utils/page";
import IdpSyncPageView from "./IdpSyncPageView";
Expand Down Expand Up @@ -47,6 +48,19 @@ export const IdpSyncPage: FC = () => {
],
});

const [searchParams] = useSearchParams();
const tab = searchParams.get("tab") || "groups";
const field =
tab === "groups"
? groupIdpSyncSettingsQuery.data?.field
: roleIdpSyncSettingsQuery.data?.field;

const fieldValuesQuery = useQuery(
field
? organizationIdpSyncClaimFieldValues(organizationName, field)
: { enabled: false },
);

if (!organization) {
return <EmptyState message="Organization not found" />;
}
Expand Down Expand Up @@ -99,8 +113,10 @@ export const IdpSyncPage: FC = () => {
</Cond>
<Cond>
<IdpSyncPageView
tab={tab}
groupSyncSettings={groupIdpSyncSettingsQuery.data}
roleSyncSettings={roleIdpSyncSettingsQuery.data}
claimFieldValues={fieldValuesQuery.data}
groups={groupsQuery.data}
groupsMap={groupsMap}
roles={rolesQuery.data}
Expand Down
Loading
Loading