Skip to content

fix: use correct permissions for CRUD of custom roles #16854

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 2 commits into from
Mar 10, 2025
Merged

fix: use correct permissions for CRUD of custom roles #16854

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0622979
fix: use correct permissions for CRUD of custom roles
jaaydenh Mar 7, 2025
72cfd9c
chore: improve readability
jaaydenh Mar 10, 2025
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
3 changes: 3 additions & 0 deletions site/src/modules/permissions/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@ export type Permissions = {

export type PermissionName = keyof typeof permissionChecks;

/**
* Site-wide permission checks
*/
export const permissionChecks = {
viewAllUsers: {
object: {
Expand Down
14 changes: 14 additions & 0 deletions site/src/modules/permissions/organizations.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,20 @@ export const organizationPermissionChecks = (organizationId: string) =>
},
action: "create",
},
updateOrgRoles: {
object: {
resource_type: "assign_org_role",
organization_id: organizationId,
},
action: "update",
},
deleteOrgRoles: {
object: {
resource_type: "assign_org_role",
organization_id: organizationId,
},
action: "delete",
},
viewProvisioners: {
object: {
resource_type: "provisioner_daemon",
Expand Down
6 changes: 3 additions & 3 deletions site/src/pages/OrganizationSettingsPage/CustomRolesPage/CreateEditRolePage.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,9 @@ export const CreateEditRolePage: FC = () => {
return (
<RequirePermission
isFeatureVisible={
organizationPermissions.assignOrgRoles ||
organizationPermissions.createOrgRoles
role
? organizationPermissions.updateOrgRoles
: organizationPermissions.createOrgRoles
}
>
<Helmet>
Expand Down Expand Up @@ -87,7 +88,6 @@ export const CreateEditRolePage: FC = () => {
: createOrganizationRoleMutation.isLoading
}
organizationName={organizationName}
canAssignOrgRole={organizationPermissions.assignOrgRoles}
/>
</RequirePermission>
);
Expand Down
2 changes: 0 additions & 2 deletions site/src/pages/OrganizationSettingsPage/CustomRolesPage/CreateEditRolePageView.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@ export const Default: Story = {
error: undefined,
isLoading: false,
organizationName: "my-org",
canAssignOrgRole: true,
},
};

Expand Down Expand Up @@ -81,7 +80,6 @@ export const InvalidCharsError: Story = {
export const CannotEditRoleName: Story = {
args: {
...Default.args,
canAssignOrgRole: false,
},
};

Expand Down
60 changes: 27 additions & 33 deletions site/src/pages/OrganizationSettingsPage/CustomRolesPage/CreateEditRolePageView.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,6 @@ export type CreateEditRolePageViewProps = {
error?: unknown;
isLoading: boolean;
organizationName: string;
canAssignOrgRole: boolean;
allResources?: boolean;
};

Expand All @@ -53,7 +52,6 @@ export const CreateEditRolePageView: FC<CreateEditRolePageViewProps> = ({
error,
isLoading,
organizationName,
canAssignOrgRole,
allResources = false,
}) => {
const navigate = useNavigate();
Expand Down Expand Up @@ -84,26 +82,24 @@ export const CreateEditRolePageView: FC<CreateEditRolePageViewProps> = ({
title={`${role ? "Edit" : "Create"} Custom Role`}
description="Set a name and permissions for this role."
/>
{canAssignOrgRole && (
<div className="flex space-x-2 items-center">
<Button
variant="outline"
onClick={() => {
navigate(`/organizations/${organizationName}/roles`);
}}
>
Cancel
</Button>
<Button
onClick={() => {
form.handleSubmit();
}}
>
<Spinner loading={isLoading} />
{role !== undefined ? "Save" : "Create Role"}
</Button>
</div>
)}
<div className="flex space-x-2 items-center">
<Button
variant="outline"
onClick={() => {
navigate(`/organizations/${organizationName}/roles`);
}}
>
Cancel
</Button>
<Button
onClick={() => {
form.handleSubmit();
}}
>
<Spinner loading={isLoading} />
{role !== undefined ? "Save" : "Create Role"}
</Button>
</div>
</Stack>

<VerticalForm onSubmit={form.handleSubmit}>
Expand Down Expand Up @@ -135,18 +131,16 @@ export const CreateEditRolePageView: FC<CreateEditRolePageViewProps> = ({
allResources={allResources}
/>
</FormFields>
{canAssignOrgRole && (
<FormFooter>
<Button onClick={onCancel} variant="outline">
Cancel
</Button>
<FormFooter>
<Button onClick={onCancel} variant="outline">
Cancel
</Button>

<Button type="submit" disabled={isLoading}>
<Spinner loading={isLoading} />
{role ? "Save role" : "Create Role"}
</Button>
</FormFooter>
)}
<Button type="submit" disabled={isLoading}>
<Spinner loading={isLoading} />
{role ? "Save role" : "Create Role"}
</Button>
</FormFooter>
</VerticalForm>
</>
);
Expand Down
3 changes: 2 additions & 1 deletion site/src/pages/OrganizationSettingsPage/CustomRolesPage/CustomRolesPage.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,8 +81,9 @@ export const CustomRolesPage: FC = () => {
builtInRoles={builtInRoles}
customRoles={customRoles}
onDeleteRole={setRoleToDelete}
canAssignOrgRole={organizationPermissions?.assignOrgRoles ?? false}
canCreateOrgRole={organizationPermissions?.createOrgRoles ?? false}
canUpdateOrgRole={organizationPermissions?.updateOrgRoles ?? false}
canDeleteOrgRole={organizationPermissions?.deleteOrgRoles ?? false}
isCustomRolesEnabled={isCustomRolesEnabled}
/>

Expand Down
4 changes: 1 addition & 3 deletions site/src/pages/OrganizationSettingsPage/CustomRolesPage/CustomRolesPageView.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ const meta: Meta<typeof CustomRolesPageView> = {
args: {
builtInRoles: [MockRoleWithOrgPermissions],
customRoles: [MockRoleWithOrgPermissions],
canAssignOrgRole: true,
canCreateOrgRole: true,
isCustomRolesEnabled: true,
},
Expand All @@ -31,7 +30,7 @@ export const NotEnabled: Story = {
export const NotEnabledEmptyTable: Story = {
args: {
customRoles: [],
canAssignOrgRole: true,
canCreateOrgRole: true,
isCustomRolesEnabled: false,
},
};
Expand All @@ -58,7 +57,6 @@ export const EmptyDisplayName: Story = {
export const EmptyTableUserWithoutPermission: Story = {
args: {
customRoles: [],
canAssignOrgRole: false,
canCreateOrgRole: false,
},
};
Expand Down
59 changes: 39 additions & 20 deletions site/src/pages/OrganizationSettingsPage/CustomRolesPage/CustomRolesPageView.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,17 +34,19 @@ interface CustomRolesPageViewProps {
builtInRoles: AssignableRoles[] | undefined;
customRoles: AssignableRoles[] | undefined;
onDeleteRole: (role: Role) => void;
canAssignOrgRole: boolean;
canCreateOrgRole: boolean;
canUpdateOrgRole: boolean;
canDeleteOrgRole: boolean;
isCustomRolesEnabled: boolean;
}

export const CustomRolesPageView: FC<CustomRolesPageViewProps> = ({
builtInRoles,
customRoles,
onDeleteRole,
canAssignOrgRole,
canCreateOrgRole,
canUpdateOrgRole,
canDeleteOrgRole,
isCustomRolesEnabled,
}) => {
return (
Expand Down Expand Up @@ -77,7 +79,9 @@ export const CustomRolesPageView: FC<CustomRolesPageViewProps> = ({
<RoleTable
roles={customRoles}
isCustomRolesEnabled={isCustomRolesEnabled}
canAssignOrgRole={canAssignOrgRole}
canCreateOrgRole={canCreateOrgRole}
canUpdateOrgRole={canUpdateOrgRole}
canDeleteOrgRole={canDeleteOrgRole}
onDeleteRole={onDeleteRole}
/>
<span>
Expand All @@ -90,7 +94,9 @@ export const CustomRolesPageView: FC<CustomRolesPageViewProps> = ({
<RoleTable
roles={builtInRoles}
isCustomRolesEnabled={isCustomRolesEnabled}
canAssignOrgRole={canAssignOrgRole}
canCreateOrgRole={canCreateOrgRole}
canUpdateOrgRole={canUpdateOrgRole}
canDeleteOrgRole={canDeleteOrgRole}
onDeleteRole={onDeleteRole}
/>
</Stack>
Expand All @@ -100,15 +106,19 @@ export const CustomRolesPageView: FC<CustomRolesPageViewProps> = ({
interface RoleTableProps {
roles: AssignableRoles[] | undefined;
isCustomRolesEnabled: boolean;
canAssignOrgRole: boolean;
canCreateOrgRole: boolean;
canUpdateOrgRole: boolean;
canDeleteOrgRole: boolean;
onDeleteRole: (role: Role) => void;
}

const RoleTable: FC<RoleTableProps> = ({
roles,
isCustomRolesEnabled,
canCreateOrgRole,
canUpdateOrgRole,
canDeleteOrgRole,
onDeleteRole,
canAssignOrgRole,
}) => {
const isLoading = roles === undefined;
const isEmpty = Boolean(roles && roles.length === 0);
Expand All @@ -134,14 +144,14 @@ const RoleTable: FC<RoleTableProps> = ({
<EmptyState
message="No custom roles yet"
description={
canAssignOrgRole && isCustomRolesEnabled
canCreateOrgRole && isCustomRolesEnabled
? "Create your first custom role"
: !isCustomRolesEnabled
? "Upgrade to a premium license to create a custom role"
: "You don't have permission to create a custom role"
}
cta={
canAssignOrgRole &&
canCreateOrgRole &&
isCustomRolesEnabled && (
<Button
component={RouterLink}
Expand All @@ -165,7 +175,8 @@ const RoleTable: FC<RoleTableProps> = ({
<RoleRow
key={role.name}
role={role}
canAssignOrgRole={canAssignOrgRole}
canUpdateOrgRole={canUpdateOrgRole}
canDeleteOrgRole={canDeleteOrgRole}
onDelete={() => onDeleteRole(role)}
/>
))}
Expand All @@ -179,11 +190,17 @@ const RoleTable: FC<RoleTableProps> = ({

interface RoleRowProps {
role: AssignableRoles;
canUpdateOrgRole: boolean;
canDeleteOrgRole: boolean;
onDelete: () => void;
canAssignOrgRole: boolean;
}

const RoleRow: FC<RoleRowProps> = ({ role, onDelete, canAssignOrgRole }) => {
const RoleRow: FC<RoleRowProps> = ({
role,
onDelete,
canUpdateOrgRole,
canDeleteOrgRole,
}) => {
const navigate = useNavigate();

return (
Expand All @@ -195,20 +212,22 @@ const RoleRow: FC<RoleRowProps> = ({ role, onDelete, canAssignOrgRole }) => {
</TableCell>

<TableCell>
{!role.built_in && (
{!role.built_in && (canUpdateOrgRole || canDeleteOrgRole) && (
<MoreMenu>
<MoreMenuTrigger>
<ThreeDotsButton />
</MoreMenuTrigger>
<MoreMenuContent>
<MoreMenuItem
onClick={() => {
navigate(role.name);
}}
>
Edit
</MoreMenuItem>
{canAssignOrgRole && (
{canUpdateOrgRole && (
<MoreMenuItem
onClick={() => {
navigate(role.name);
}}
>
Edit
</MoreMenuItem>
)}
{canDeleteOrgRole && (
<MoreMenuItem danger onClick={onDelete}>
Delete&hellip;
</MoreMenuItem>
Expand Down
4 changes: 4 additions & 0 deletions site/src/testHelpers/entities.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2900,6 +2900,8 @@ export const MockOrganizationPermissions: OrganizationPermissions = {
viewOrgRoles: true,
createOrgRoles: true,
assignOrgRoles: true,
updateOrgRoles: true,
deleteOrgRoles: true,
viewProvisioners: true,
viewProvisionerJobs: true,
viewIdpSyncSettings: true,
Expand All @@ -2916,6 +2918,8 @@ export const MockNoOrganizationPermissions: OrganizationPermissions = {
viewOrgRoles: false,
createOrgRoles: false,
assignOrgRoles: false,
updateOrgRoles: false,
deleteOrgRoles: false,
viewProvisioners: false,
viewProvisionerJobs: false,
viewIdpSyncSettings: false,
Expand Down
Loading