Skip to content

The open alternative to Salesforce, designed for AI.

fix(roles): explain a role deletion refused because the default role cannot take its API keys or agents (#28348)

Etienne09bf84ea7096
diff --git a/packages/twenty-front/src/modules/settings/roles/role-settings/components/SettingsRoleSettings.tsx b/packages/twenty-front/src/modules/settings/roles/role-settings/components/SettingsRoleSettings.tsx
index 758b868b5f3..0e8d8cc15bc 100644
--- a/packages/twenty-front/src/modules/settings/roles/role-settings/components/SettingsRoleSettings.tsx
+++ b/packages/twenty-front/src/modules/settings/roles/role-settings/components/SettingsRoleSettings.tsx
@@ -56,13 +56,30 @@ export const SettingsRoleSettings = ({
const isMemberRole =
settingsDraftRole.universalIdentifier === MEMBER_ROLE_UNIVERSAL_IDENTIFIER;
- const isDefaultRole = currentWorkspace?.defaultRole?.id === roleId;
+ const defaultRole = currentWorkspace?.defaultRole;
+ const isDefaultRole = defaultRole?.id === roleId;
+ const hasTargetsDefaultRoleCannotTake =
+ isEditable &&
+ ((defaultRole?.canBeAssignedToApiKeys === false &&
+ settingsDraftRole.apiKeys.length > 0) ||
+ (defaultRole?.canBeAssignedToAgents === false &&
+ settingsDraftRole.agents.length > 0));
- const deleteRoleDescription = isMemberRole
- ? t`The Member role cannot be deleted`
- : isDefaultRole
- ? t`The default role cannot be deleted. Choose another default role first`
- : t`Delete this role and assign a new role to its members`;
+ const getDeleteRoleDescription = () => {
+ if (isMemberRole) {
+ return t`The Member role cannot be deleted`;
+ }
+
+ if (isDefaultRole) {
+ return t`The default role cannot be deleted. Choose another default role first`;
+ }
+
+ if (hasTargetsDefaultRoleCannotTake) {
+ return t`The default role cannot be assigned to this role's API keys or agents. Reassign them to another role first`;
+ }
+
+ return t`Delete this role and assign a new role to its members`;
+ };
const descriptionTextAreaId = `${roleId}-description`;
const nameTextInputId = `${roleId}-name`;
@@ -134,14 +151,19 @@ export const SettingsRoleSettings = ({
<Section.Root>
<Section.Header
title={t`Danger zone`}
- description={deleteRoleDescription}
+ description={getDeleteRoleDescription()}
/>
<Button
size="sm"
onClick={() => {
openDialog(ROLE_SETTINGS_DELETE_ROLE_CONFIRMATION_MODAL_ID);
}}
- disabled={!isEditable || isMemberRole || isDefaultRole}
+ disabled={
+ !isEditable ||
+ isMemberRole ||
+ isDefaultRole ||
+ hasTargetsDefaultRoleCannotTake
+ }
variant="outline"
color="danger"
>{t`Delete role`}</Button>
diff --git a/packages/twenty-front/src/modules/settings/roles/role-settings/components/stories/SettingsRoleSettings.stories.tsx b/packages/twenty-front/src/modules/settings/roles/role-settings/components/stories/SettingsRoleSettings.stories.tsx
index e7d4793d9bf..5202cb0fd91 100644
--- a/packages/twenty-front/src/modules/settings/roles/role-settings/components/stories/SettingsRoleSettings.stories.tsx
+++ b/packages/twenty-front/src/modules/settings/roles/role-settings/components/stories/SettingsRoleSettings.stories.tsx
@@ -61,7 +61,7 @@ type Story = StoryObj<typeof SettingsRoleSettingsWrapper>;
export const Default: Story = {
args: {
- roleId: mockedRoles[0].id,
+ roleId: mockedRoles[2].id,
isEditable: true,
isCreateMode: false,
},
@@ -133,3 +133,23 @@ export const WorkspaceDefaultRole: Story = {
).toBeVisible();
},
};
+
+export const RoleWithApiKeyTheDefaultRoleCannotTake: Story = {
+ args: {
+ roleId: mockedRoles[0].id,
+ isEditable: true,
+ isCreateMode: false,
+ },
+ play: async ({ canvasElement }) => {
+ const canvas = within(canvasElement);
+
+ expect(
+ await canvas.findByRole('button', { name: /Delete role/ }),
+ ).toBeDisabled();
+ expect(
+ canvas.getByText(
+ "The default role cannot be assigned to this role's API keys or agents. Reassign them to another role first",
+ ),
+ ).toBeVisible();
+ },
+};
diff --git a/packages/twenty-front/src/modules/settings/roles/role/components/SettingsRoleDraftSyncEffect.tsx b/packages/twenty-front/src/modules/settings/roles/role/components/SettingsRoleDraftSyncEffect.tsx
index 992eaa63f8c..ec57e6331de 100644
--- a/packages/twenty-front/src/modules/settings/roles/role/components/SettingsRoleDraftSyncEffect.tsx
+++ b/packages/twenty-front/src/modules/settings/roles/role/components/SettingsRoleDraftSyncEffect.tsx
@@ -46,11 +46,18 @@ export const SettingsRoleDraftSyncEffect = ({
isDefined(draftRoleBase) &&
isDeeplyEqual(currentDraftRole, draftRoleBase);
- if (
- (isUninitialized || hasNoUnsavedChanges) &&
- !isDeeplyEqual(currentDraftRole, settingsPersistedRole)
- ) {
- store.set(draftRoleAtom, settingsPersistedRole);
+ const nextDraftRole =
+ isUninitialized || hasNoUnsavedChanges
+ ? settingsPersistedRole
+ : {
+ ...currentDraftRole,
+ workspaceMembers: settingsPersistedRole.workspaceMembers,
+ agents: settingsPersistedRole.agents,
+ apiKeys: settingsPersistedRole.apiKeys,
+ };
+
+ if (!isDeeplyEqual(currentDraftRole, nextDraftRole)) {
+ store.set(draftRoleAtom, nextDraftRole);
}
if (!isDeeplyEqual(draftRoleBase, settingsPersistedRole)) {
diff --git a/packages/twenty-server/src/engine/core-modules/tool-provider/utils/is-user-facing-tool-execution-error.util.ts b/packages/twenty-server/src/engine/core-modules/tool-provider/utils/is-user-facing-tool-execution-error.util.ts
index a08957a575e..58e5c080de5 100644
--- a/packages/twenty-server/src/engine/core-modules/tool-provider/utils/is-user-facing-tool-execution-error.util.ts
+++ b/packages/twenty-server/src/engine/core-modules/tool-provider/utils/is-user-facing-tool-execution-error.util.ts
@@ -91,6 +91,7 @@ const USER_FACING_PERMISSIONS_EXCEPTION_CODES = [
PermissionsExceptionCode.CANNOT_REVOKE_OWN_SETTINGS_ACCESS,
PermissionsExceptionCode.CANNOT_DELETE_LAST_ADMIN_USER,
PermissionsExceptionCode.ROLE_NOT_EDITABLE,
+ PermissionsExceptionCode.DEFAULT_ROLE_CANNOT_BE_DELETED,
PermissionsExceptionCode.CANNOT_ADD_OBJECT_PERMISSION_ON_SYSTEM_OBJECT,
PermissionsExceptionCode.CANNOT_ADD_FIELD_PERMISSION_ON_SYSTEM_OBJECT,
PermissionsExceptionCode.INVALID_ARG,
diff --git a/packages/twenty-server/src/engine/metadata-modules/permissions/utils/permission-graphql-api-exception-handler.util.ts b/packages/twenty-server/src/engine/metadata-modules/permissions/utils/permission-graphql-api-exception-handler.util.ts
index 1afe8614039..fd01ac03345 100644
--- a/packages/twenty-server/src/engine/metadata-modules/permissions/utils/permission-graphql-api-exception-handler.util.ts
+++ b/packages/twenty-server/src/engine/metadata-modules/permissions/utils/permission-graphql-api-exception-handler.util.ts
@@ -33,6 +33,7 @@ export const permissionGraphqlApiExceptionHandler = (
case PermissionsExceptionCode.CANNOT_REVOKE_OWN_SETTINGS_ACCESS:
case PermissionsExceptionCode.CANNOT_DELETE_LAST_ADMIN_USER:
case PermissionsExceptionCode.ROLE_NOT_EDITABLE:
+ case PermissionsExceptionCode.DEFAULT_ROLE_CANNOT_BE_DELETED:
case PermissionsExceptionCode.MEMBER_ROLE_CANNOT_BE_DELETED:
case PermissionsExceptionCode.CANNOT_ADD_OBJECT_PERMISSION_ON_SYSTEM_OBJECT:
case PermissionsExceptionCode.CANNOT_ADD_FIELD_PERMISSION_ON_SYSTEM_OBJECT:
@@ -60,7 +61,6 @@ export const permissionGraphqlApiExceptionHandler = (
case PermissionsExceptionCode.TOO_MANY_ADMIN_CANDIDATES:
case PermissionsExceptionCode.USER_WORKSPACE_ALREADY_HAS_ROLE:
case PermissionsExceptionCode.ADMIN_ROLE_NOT_FOUND:
- case PermissionsExceptionCode.DEFAULT_ROLE_CANNOT_BE_DELETED:
case PermissionsExceptionCode.WORKSPACE_MEMBER_NOT_FOUND:
case PermissionsExceptionCode.UNKNOWN_OPERATION_NAME:
case PermissionsExceptionCode.UNKNOWN_REQUIRED_PERMISSION:
diff --git a/packages/twenty-server/src/engine/metadata-modules/permissions/utils/permission-rest-api-exception-code-to-http-status.util.ts b/packages/twenty-server/src/engine/metadata-modules/permissions/utils/permission-rest-api-exception-code-to-http-status.util.ts
index 0aad87bc0c6..d675e31e5cf 100644
--- a/packages/twenty-server/src/engine/metadata-modules/permissions/utils/permission-rest-api-exception-code-to-http-status.util.ts
+++ b/packages/twenty-server/src/engine/metadata-modules/permissions/utils/permission-rest-api-exception-code-to-http-status.util.ts
@@ -15,6 +15,7 @@ export const permissionRestApiExceptionCodeToHttpStatus = (
case PermissionsExceptionCode.CANNOT_REVOKE_OWN_SETTINGS_ACCESS:
case PermissionsExceptionCode.CANNOT_DELETE_LAST_ADMIN_USER:
case PermissionsExceptionCode.ROLE_NOT_EDITABLE:
+ case PermissionsExceptionCode.DEFAULT_ROLE_CANNOT_BE_DELETED:
case PermissionsExceptionCode.MEMBER_ROLE_CANNOT_BE_DELETED:
case PermissionsExceptionCode.CANNOT_ADD_OBJECT_PERMISSION_ON_SYSTEM_OBJECT:
case PermissionsExceptionCode.CANNOT_ADD_FIELD_PERMISSION_ON_SYSTEM_OBJECT:
@@ -42,7 +43,6 @@ export const permissionRestApiExceptionCodeToHttpStatus = (
case PermissionsExceptionCode.TOO_MANY_ADMIN_CANDIDATES:
case PermissionsExceptionCode.USER_WORKSPACE_ALREADY_HAS_ROLE:
case PermissionsExceptionCode.ADMIN_ROLE_NOT_FOUND:
- case PermissionsExceptionCode.DEFAULT_ROLE_CANNOT_BE_DELETED:
case PermissionsExceptionCode.WORKSPACE_MEMBER_NOT_FOUND:
case PermissionsExceptionCode.UNKNOWN_OPERATION_NAME:
case PermissionsExceptionCode.UNKNOWN_REQUIRED_PERMISSION:
diff --git a/packages/twenty-server/src/engine/metadata-modules/role/role.service.ts b/packages/twenty-server/src/engine/metadata-modules/role/role.service.ts
index 440e19277bb..4c4e501bf94 100644
--- a/packages/twenty-server/src/engine/metadata-modules/role/role.service.ts
+++ b/packages/twenty-server/src/engine/metadata-modules/role/role.service.ts
@@ -542,6 +542,13 @@ export class RoleService {
const activeApiKeyIds = new Set(activeApiKeys.flat().map(({ id }) => id));
+ const softDeletedAgentIds = new Set(
+ Object.values(flatAgentMaps.byUniversalIdentifier)
+ .filter(isDefined)
+ .filter(({ deletedAt }) => isDefined(deletedAt))
+ .map(({ id }) => id),
+ );
+
const flatRoleTargetsToDelete = Object.values(
flatRoleTargetMaps.byUniversalIdentifier,
).filter(
@@ -558,7 +565,9 @@ export class RoleService {
if (
!isDefined(targetId) ||
(targetMetadataForeignKey === 'apiKeyId' &&
- !activeApiKeyIds.has(targetId))
+ !activeApiKeyIds.has(targetId)) ||
+ (targetMetadataForeignKey === 'agentId' &&
+ softDeletedAgentIds.has(targetId))
) {
return [];
}
diff --git a/packages/twenty-server/test/integration/metadata/suites/role/__snapshots__/failing-delete-one-role.integration-spec.ts.snap b/packages/twenty-server/test/integration/metadata/suites/role/__snapshots__/failing-delete-one-role.integration-spec.ts.snap
index 496b789a6ab..40de8edb7b9 100644
--- a/packages/twenty-server/test/integration/metadata/suites/role/__snapshots__/failing-delete-one-role.integration-spec.ts.snap
+++ b/packages/twenty-server/test/integration/metadata/suites/role/__snapshots__/failing-delete-one-role.integration-spec.ts.snap
@@ -74,11 +74,12 @@ exports[`Role deletion should fail when deleting the workspace default role (Mem
[
{
"extensions": {
- "code": "INTERNAL_SERVER_ERROR",
- "exceptionEventId": Any<String>,
+ "code": "FORBIDDEN",
+ "subCode": "DEFAULT_ROLE_CANNOT_BE_DELETED",
"userFriendlyMessage": "The default role cannot be deleted as it is required for the workspace to function properly.",
},
"message": "Default role cannot be deleted",
+ "name": "ForbiddenError",
},
]
`;