Skip to content

The open alternative to Salesforce, designed for AI.

feat(roles): gate custom role creation behind the CUSTOM_ROLES entitlement (#29014)

Etienne2f96a07eae17
diff --git a/packages/twenty-apps/examples/document-generator/src/roles/default-role.ts b/packages/twenty-apps/examples/document-generator/src/roles/default-role.ts
index 1520b82dcd1..2477fd44ee2 100644
--- a/packages/twenty-apps/examples/document-generator/src/roles/default-role.ts
+++ b/packages/twenty-apps/examples/document-generator/src/roles/default-role.ts
@@ -18,5 +18,7 @@ export default defineApplicationRole({
canDestroyAllObjectRecords: false,
canAccessAllTools: true,
canBeAssignedToAgents: true,
+ canBeAssignedToUsers: false,
+ canBeAssignedToApiKeys: false,
permissionFlagUniversalIdentifiers: [SystemPermissionFlag.UPLOAD_FILE],
});
diff --git a/packages/twenty-apps/examples/hello-world/src/roles/default-role.ts b/packages/twenty-apps/examples/hello-world/src/roles/default-role.ts
index b01bd37721b..554e0d5163e 100644
--- a/packages/twenty-apps/examples/hello-world/src/roles/default-role.ts
+++ b/packages/twenty-apps/examples/hello-world/src/roles/default-role.ts
@@ -11,4 +11,6 @@ export default defineRole({
canUpdateAllObjectRecords: true,
canSoftDeleteAllObjectRecords: true,
canDestroyAllObjectRecords: false,
+ canBeAssignedToUsers: false,
+ canBeAssignedToApiKeys: false,
});
diff --git a/packages/twenty-cli/app-template/src/default-role.ts b/packages/twenty-cli/app-template/src/default-role.ts
index a6abf654453..a819c573f1a 100644
--- a/packages/twenty-cli/app-template/src/default-role.ts
+++ b/packages/twenty-cli/app-template/src/default-role.ts
@@ -13,4 +13,6 @@ export default defineApplicationRole({
canUpdateAllObjectRecords: true,
canSoftDeleteAllObjectRecords: true,
canDestroyAllObjectRecords: false,
+ canBeAssignedToUsers: false,
+ canBeAssignedToApiKeys: false,
});
diff --git a/packages/twenty-docs/developers/extend/apps/config/roles.mdx b/packages/twenty-docs/developers/extend/apps/config/roles.mdx
index acae9d56e1e..821625eafa0 100644
--- a/packages/twenty-docs/developers/extend/apps/config/roles.mdx
+++ b/packages/twenty-docs/developers/extend/apps/config/roles.mdx
@@ -217,6 +217,7 @@ Notes:
- Exactly **one** `defineApplicationRole(...)` is allowed per app — the manifest build will fail if it finds more than one.
- Use `defineRole()` (not `defineApplicationRole()`) for any **additional** roles your app ships.
- Setting `defaultRoleUniversalIdentifier` explicitly on `defineApplication()` is still supported for backward compatibility, but is deprecated in favor of `defineApplicationRole()`. The identifier must match a role your app defines, or the build fails.
+- A role that workspace members or API keys can be assigned (`canBeAssignedToUsers` or `canBeAssignedToApiKeys`, both `true` when omitted) is a custom role and requires the **Organization plan or above**: on other plans the install is refused. Keep both `false` on roles that only your app and its agents run as.
### Agent roles
diff --git a/packages/twenty-front/src/modules/settings/roles/components/SettingsRolesList.tsx b/packages/twenty-front/src/modules/settings/roles/components/SettingsRolesList.tsx
index d31713231f7..ae9182eb86e 100644
--- a/packages/twenty-front/src/modules/settings/roles/components/SettingsRolesList.tsx
+++ b/packages/twenty-front/src/modules/settings/roles/components/SettingsRolesList.tsx
@@ -1,4 +1,6 @@
import { useInstalledApplications } from '@/applications/hooks/useInstalledApplications';
+import { currentWorkspaceState } from '@/auth/states/currentWorkspaceState';
+import { OrganizationAdornment } from '@/settings/enterprise/components/OrganizationAdornment';
import { SettingsRolesTableHeader } from '@/settings/roles/components/SettingsRolesTableHeader';
import { SettingsRolesTableRow } from '@/settings/roles/components/SettingsRolesTableRow';
import { useSettingsAllRoles } from '@/settings/roles/hooks/useSettingsAllRoles';
@@ -9,6 +11,8 @@ import { DropdownRoot } from '@/ui/layout/dropdown/components/DropdownRoot';
import { Table } from '@/ui/layout/table/components/Table';
import { TableCell } from '@/ui/layout/table/components/TableCell';
import { TableFooter } from '@/ui/layout/table/components/TableFooter';
+import { useAtomStateValue } from '@/ui/utilities/state/jotai/hooks/useAtomStateValue';
+import { checkIfBillingEntitlementIsEnabledOnWorkspace } from '@/workspace/utils/checkIfBillingEntitlementIsEnabledOnWorkspace';
import { styled } from '@linaria/react';
import { t } from '@lingui/core/macro';
import { useState } from 'react';
@@ -27,6 +31,7 @@ import {
} from 'twenty-ui/icon';
import { Button } from 'twenty-ui/primitives/input';
import { themeCssVariables } from 'twenty-ui/theme';
+import { BillingEntitlementKey } from '~/generated-metadata/graphql';
import { useNavigateSettings } from '~/hooks/useNavigateSettings';
import { sortByAscString } from '~/utils/array/sortByAscString';
@@ -46,6 +51,12 @@ const StyledSearchInputContainer = styled.div`
flex: 1;
`;
+const StyledCreateRoleContainer = styled.div`
+ align-items: center;
+ display: flex;
+ gap: ${themeCssVariables.spacing[2]};
+`;
+
export const SettingsRolesList = () => {
const navigateSettings = useNavigateSettings();
const [searchTerm, setSearchTerm] = useState('');
@@ -55,6 +66,13 @@ export const SettingsRolesList = () => {
const settingsAllRoles = useSettingsAllRoles();
const installedApplications = useInstalledApplications();
+ const currentWorkspace = useAtomStateValue(currentWorkspaceState);
+
+ const hasCustomRolesEntitlement =
+ checkIfBillingEntitlementIsEnabledOnWorkspace(
+ BillingEntitlementKey.CUSTOM_ROLES,
+ currentWorkspace,
+ );
const installedApplicationByDefaultRoleId = new Map(
installedApplications
@@ -159,12 +177,20 @@ export const SettingsRolesList = () => {
</StyledTableRows>
</Table>
<TableFooter>
- <Button
- startIcon={<IconPlus />}
- size="sm"
- onClick={() => navigateSettings(SettingsPath.RoleCreate)}
- variant="outline"
- >{t`Create Role`}</Button>
+ <StyledCreateRoleContainer>
+ {!hasCustomRolesEntitlement && (
+ <OrganizationAdornment
+ tooltipContent={t`Upgrade to Organization to create custom roles`}
+ />
+ )}
+ <Button
+ startIcon={<IconPlus />}
+ size="sm"
+ onClick={() => navigateSettings(SettingsPath.RoleCreate)}
+ variant="outline"
+ disabled={!hasCustomRolesEntitlement}
+ >{t`Create Role`}</Button>
+ </StyledCreateRoleContainer>
</TableFooter>
</Section.Root>
);
diff --git a/packages/twenty-front/src/modules/settings/roles/components/__stories__/SettingsRolesList.stories.tsx b/packages/twenty-front/src/modules/settings/roles/components/__stories__/SettingsRolesList.stories.tsx
index f93dc9a341c..8fc9855334c 100644
--- a/packages/twenty-front/src/modules/settings/roles/components/__stories__/SettingsRolesList.stories.tsx
+++ b/packages/twenty-front/src/modules/settings/roles/components/__stories__/SettingsRolesList.stories.tsx
@@ -1,12 +1,15 @@
import { type Meta, type StoryObj } from '@storybook/react-vite';
import { expect, userEvent, waitFor, within } from 'storybook/test';
+import { currentWorkspaceState } from '@/auth/states/currentWorkspaceState';
import { SettingsRolesList } from '@/settings/roles/components/SettingsRolesList';
import { settingsPersistedRoleFamilyState } from '@/settings/roles/states/settingsPersistedRoleFamilyState';
import { settingsRoleIdsState } from '@/settings/roles/states/settingsRoleIdsState';
import { jotaiStore } from '@/ui/utilities/state/jotai/jotaiStore';
+import { BillingEntitlementKey } from '~/generated-metadata/graphql';
import { ComponentWithRouterDecorator } from '~/testing/decorators/ComponentWithRouterDecorator';
import { mockedRoles } from '~/testing/mock-data/generated/metadata/roles/mock-roles-data';
+import { mockCurrentWorkspace } from '~/testing/mock-data/users';
const ROLES = [
...mockedRoles,
@@ -89,3 +92,39 @@ export const FilterPanelTogglesStayOpen: Story = {
await waitFor(() => expect(trigger).toHaveFocus());
},
};
+
+export const CreateRoleWithCustomRolesEntitlement: Story = {
+ beforeEach: () => {
+ jotaiStore.set(currentWorkspaceState.atom, {
+ ...mockCurrentWorkspace,
+ billingEntitlements: [
+ { key: BillingEntitlementKey.CUSTOM_ROLES, value: true },
+ ],
+ });
+ },
+ play: async ({ canvasElement }) => {
+ const canvas = within(canvasElement);
+
+ expect(
+ await canvas.findByRole('button', { name: 'Create Role' }),
+ ).toBeEnabled();
+ expect(canvas.queryByText('Organization')).not.toBeInTheDocument();
+ },
+};
+
+export const CreateRoleWithoutCustomRolesEntitlement: Story = {
+ beforeEach: () => {
+ jotaiStore.set(currentWorkspaceState.atom, {
+ ...mockCurrentWorkspace,
+ billingEntitlements: [],
+ });
+ },
+ play: async ({ canvasElement }) => {
+ const canvas = within(canvasElement);
+
+ expect(
+ await canvas.findByRole('button', { name: 'Create Role' }),
+ ).toBeDisabled();
+ expect(canvas.getByText('Organization')).toBeVisible();
+ },
+};
diff --git a/packages/twenty-server/src/engine/metadata-modules/permissions/permissions.exception.ts b/packages/twenty-server/src/engine/metadata-modules/permissions/permissions.exception.ts
index e62dad3dc67..08a84cee69a 100644
--- a/packages/twenty-server/src/engine/metadata-modules/permissions/permissions.exception.ts
+++ b/packages/twenty-server/src/engine/metadata-modules/permissions/permissions.exception.ts
@@ -196,6 +196,7 @@ export enum PermissionsExceptionMessage {
ROLE_NOT_EDITABLE = 'Role is not editable',
DEFAULT_ROLE_CANNOT_BE_DELETED = 'Default role cannot be deleted',
MEMBER_ROLE_CANNOT_BE_DELETED = 'Member role cannot be deleted',
+ CUSTOM_ROLES_NOT_ENTITLED = 'Custom roles require the Organization plan',
CANNOT_ADD_OBJECT_PERMISSION_ON_SYSTEM_OBJECT = 'Cannot add object permission on system object',
CANNOT_ADD_FIELD_PERMISSION_ON_SYSTEM_OBJECT = 'Cannot add field permission on system object',
CANNOT_GIVE_WRITING_PERMISSION_ON_NON_READABLE_OBJECT = 'Cannot give update permission to non-readable object',
diff --git a/packages/twenty-server/src/engine/metadata-modules/role/constants/non-custom-role-universal-identifiers.constant.ts b/packages/twenty-server/src/engine/metadata-modules/role/constants/non-custom-role-universal-identifiers.constant.ts
new file mode 100644
index 00000000000..fabdda93f63
--- /dev/null
+++ b/packages/twenty-server/src/engine/metadata-modules/role/constants/non-custom-role-universal-identifiers.constant.ts
@@ -0,0 +1,8 @@
+import { MEMBER_ROLE_UNIVERSAL_IDENTIFIER } from 'twenty-shared/constants';
+
+import { STANDARD_ROLE } from 'src/engine/workspace-manager/twenty-standard-application/constants/standard-role.constant';
+
+export const NON_CUSTOM_ROLE_UNIVERSAL_IDENTIFIERS = [
+ STANDARD_ROLE.admin.universalIdentifier,
+ MEMBER_ROLE_UNIVERSAL_IDENTIFIER,
+];
diff --git a/packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-builder/validators/services/flat-role-validator.service.ts b/packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-builder/validators/services/flat-role-validator.service.ts
index fb78104a2cc..d3fd445121f 100644
--- a/packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-builder/validators/services/flat-role-validator.service.ts
+++ b/packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-builder/validators/services/flat-role-validator.service.ts
@@ -14,7 +14,9 @@ import { type FailedFlatEntityValidation } from 'src/engine/workspace-manager/wo
import { getEmptyFlatEntityValidationError } from 'src/engine/workspace-manager/workspace-migration/workspace-migration-builder/builders/utils/get-flat-entity-validation-error.util';
import { type FlatEntityUpdateValidationArgs } from 'src/engine/workspace-manager/workspace-migration/workspace-migration-builder/types/universal-flat-entity-update-validation-args.type';
import { type UniversalFlatEntityValidationArgs } from 'src/engine/workspace-manager/workspace-migration/workspace-migration-builder/types/universal-flat-entity-validation-args.type';
+import { doesRoleRequireCustomRolesEntitlement } from 'src/engine/workspace-manager/workspace-migration/workspace-migration-builder/validators/utils/does-role-require-custom-roles-entitlement.util';
import { getRoleNotEditableErrors } from 'src/engine/workspace-manager/workspace-migration/workspace-migration-builder/validators/utils/get-role-not-editable-errors.util';
+import { validateRoleIsEntitled } from 'src/engine/workspace-manager/workspace-migration/workspace-migration-builder/validators/utils/validate-role-is-entitled.util';
import { validateRoleLabelUniqueness } from 'src/engine/workspace-manager/workspace-migration/workspace-migration-builder/validators/utils/validate-role-label-uniqueness.util';
import { validateRoleReadWritePermissionsConsistency } from 'src/engine/workspace-manager/workspace-migration/workspace-migration-builder/validators/utils/validate-role-read-write-permissions-consistency.util';
import { validateRoleRequiredPropertiesAreDefined } from 'src/engine/workspace-manager/workspace-migration/workspace-migration-builder/validators/utils/validate-role-required-properties-are-defined.util';
@@ -26,6 +28,8 @@ export class FlatRoleValidatorService {
optimisticFlatEntityMapsAndRelatedFlatEntityMaps: {
flatRoleMaps: optimisticFlatRoleMaps,
},
+ additionalCacheDataMaps: { billingEntitlements },
+ buildOptions,
}: UniversalFlatEntityValidationArgs<
typeof ALL_METADATA_NAME.role
>): FailedFlatEntityValidation<'role', 'create'> {
@@ -61,6 +65,14 @@ export class FlatRoleValidatorService {
}),
);
+ validationResult.errors.push(
+ ...validateRoleIsEntitled({
+ flatRole: flatEntityToValidate,
+ billingEntitlements,
+ buildOptions,
+ }),
+ );
+
return validationResult;
}
@@ -124,6 +136,7 @@ export class FlatRoleValidatorService {
optimisticFlatEntityMapsAndRelatedFlatEntityMaps: {
flatRoleMaps: optimisticFlatRoleMaps,
},
+ additionalCacheDataMaps: { billingEntitlements },
buildOptions,
}: FlatEntityUpdateValidationArgs<
typeof ALL_METADATA_NAME.role
@@ -190,6 +203,16 @@ export class FlatRoleValidatorService {
}),
);
+ if (!doesRoleRequireCustomRolesEntitlement(fromFlatRole)) {
+ validationResult.errors.push(
+ ...validateRoleIsEntitled({
+ flatRole: toFlatRole,
+ billingEntitlements,
+ buildOptions,
+ }),
+ );
+ }
+
return validationResult;
}
}
diff --git a/packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-builder/validators/utils/__tests__/does-role-require-custom-roles-entitlement.util.spec.ts b/packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-builder/validators/utils/__tests__/does-role-require-custom-roles-entitlement.util.spec.ts
new file mode 100644
index 00000000000..efe257a1ec8
--- /dev/null
+++ b/packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-builder/validators/utils/__tests__/does-role-require-custom-roles-entitlement.util.spec.ts
@@ -0,0 +1,29 @@
+import { MEMBER_ROLE_UNIVERSAL_IDENTIFIER } from 'twenty-shared/constants';
+
+import { doesRoleRequireCustomRolesEntitlement } from 'src/engine/workspace-manager/workspace-migration/workspace-migration-builder/validators/utils/does-role-require-custom-roles-entitlement.util';
+
+const CUSTOM_ROLE = {
+ universalIdentifier: '6f1c2a54-91d3-4b7e-a0f2-3c8d5e7b9a10',
+ canBeAssignedToUsers: true,
+ canBeAssignedToApiKeys: true,
+};
+
+describe('doesRoleRequireCustomRolesEntitlement', () => {
+ it('should require it for a role only API keys can be assigned', () => {
+ expect(
+ doesRoleRequireCustomRolesEntitlement({
+ ...CUSTOM_ROLE,
+ canBeAssignedToUsers: false,
+ }),
+ ).toBe(true);
+ });
+
+ it('should not require it for Member', () => {
+ expect(
+ doesRoleRequireCustomRolesEntitlement({
+ ...CUSTOM_ROLE,
+ universalIdentifier: MEMBER_ROLE_UNIVERSAL_IDENTIFIER,
+ }),
+ ).toBe(false);
+ });
+});
diff --git a/packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-builder/validators/utils/does-role-require-custom-roles-entitlement.util.ts b/packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-builder/validators/utils/does-role-require-custom-roles-entitlement.util.ts
new file mode 100644
index 00000000000..261f9bd446b
--- /dev/null
+++ b/packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-builder/validators/utils/does-role-require-custom-roles-entitlement.util.ts
@@ -0,0 +1,17 @@
+import { NON_CUSTOM_ROLE_UNIVERSAL_IDENTIFIERS } from 'src/engine/metadata-modules/role/constants/non-custom-role-universal-identifiers.constant';
+import { type UniversalFlatRole } from 'src/engine/workspace-manager/workspace-migration/universal-flat-entity/types/universal-flat-role.type';
+
+export const doesRoleRequireCustomRolesEntitlement = (
+ flatRole: Pick<
+ UniversalFlatRole,
+ 'universalIdentifier' | 'canBeAssignedToUsers' | 'canBeAssignedToApiKeys'
+ >,
+): boolean => {
+ if (
+ NON_CUSTOM_ROLE_UNIVERSAL_IDENTIFIERS.includes(flatRole.universalIdentifier)
+ ) {
+ return false;
+ }
+
+ return flatRole.canBeAssignedToUsers || flatRole.canBeAssignedToApiKeys;
+};
diff --git a/packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-builder/validators/utils/validate-flat-role-target-role-is-entitled.util.ts b/packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-builder/validators/utils/validate-flat-role-target-role-is-entitled.util.ts
index b8d98ef00f7..7c4b917c927 100644
--- a/packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-builder/validators/utils/validate-flat-role-target-role-is-entitled.util.ts
+++ b/packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-builder/validators/utils/validate-flat-role-target-role-is-entitled.util.ts
@@ -1,21 +1,15 @@
import { msg, t } from '@lingui/core/macro';
-import { MEMBER_ROLE_UNIVERSAL_IDENTIFIER } from 'twenty-shared/constants';
import { isDefined } from 'twenty-shared/utils';
import { BillingEntitlementKey } from 'src/engine/core-modules/billing/enums/billing-entitlement-key.enum';
import { type BillingEntitlements } from 'src/engine/core-modules/billing/types/billing-entitlements.type';
+import { NON_CUSTOM_ROLE_UNIVERSAL_IDENTIFIERS } from 'src/engine/metadata-modules/role/constants/non-custom-role-universal-identifiers.constant';
import { RoleTargetExceptionCode } from 'src/engine/metadata-modules/role/exceptions/role-target.exception';
-import { STANDARD_ROLE } from 'src/engine/workspace-manager/twenty-standard-application/constants/standard-role.constant';
import { type UniversalFlatRoleTarget } from 'src/engine/workspace-manager/workspace-migration/universal-flat-entity/types/universal-flat-role-target.type';
import { type UniversalFlatRole } from 'src/engine/workspace-manager/workspace-migration/universal-flat-entity/types/universal-flat-role.type';
import { type FlatEntityValidationError } from 'src/engine/workspace-manager/workspace-migration/workspace-migration-builder/builders/types/failed-flat-entity-validation.type';
import { type WorkspaceMigrationBuilderOptions } from 'src/engine/workspace-manager/workspace-migration/workspace-migration-builder/types/workspace-migration-builder-options.type';
-const ROLE_UNIVERSAL_IDENTIFIERS_ASSIGNABLE_WITHOUT_ENTITLEMENT = [
- STANDARD_ROLE.admin.universalIdentifier,
- MEMBER_ROLE_UNIVERSAL_IDENTIFIER,
-];
-
type ValidateFlatRoleTargetRoleIsEntitledArgs = {
flatRole: Pick<UniversalFlatRole, 'universalIdentifier' | 'label'>;
flatRoleTarget: Pick<UniversalFlatRoleTarget, 'agentUniversalIdentifier'>;
@@ -34,7 +28,7 @@ export const validateFlatRoleTargetRoleIsEntitled = ({
if (
buildOptions.isSystemBuild ||
isDefined(flatRoleTarget.agentUniversalIdentifier) ||
- ROLE_UNIVERSAL_IDENTIFIERS_ASSIGNABLE_WITHOUT_ENTITLEMENT.includes(
+ NON_CUSTOM_ROLE_UNIVERSAL_IDENTIFIERS.includes(
flatRole.universalIdentifier,
) ||
billingEntitlements[BillingEntitlementKey.CUSTOM_ROLES]
diff --git a/packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-builder/validators/utils/validate-role-is-entitled.util.ts b/packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-builder/validators/utils/validate-role-is-entitled.util.ts
new file mode 100644
index 00000000000..0e7f2cf9d9c
--- /dev/null
+++ b/packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-builder/validators/utils/validate-role-is-entitled.util.ts
@@ -0,0 +1,41 @@
+import { msg } from '@lingui/core/macro';
+
+import { BillingEntitlementKey } from 'src/engine/core-modules/billing/enums/billing-entitlement-key.enum';
+import { type BillingEntitlements } from 'src/engine/core-modules/billing/types/billing-entitlements.type';
+import {
+ PermissionsExceptionCode,
+ PermissionsExceptionMessage,
+} from 'src/engine/metadata-modules/permissions/permissions.exception';
+import { type UniversalFlatRole } from 'src/engine/workspace-manager/workspace-migration/universal-flat-entity/types/universal-flat-role.type';
+import { type FlatEntityValidationError } from 'src/engine/workspace-manager/workspace-migration/workspace-migration-builder/builders/types/failed-flat-entity-validation.type';
+import { type WorkspaceMigrationBuilderOptions } from 'src/engine/workspace-manager/workspace-migration/workspace-migration-builder/types/workspace-migration-builder-options.type';
+import { doesRoleRequireCustomRolesEntitlement } from 'src/engine/workspace-manager/workspace-migration/workspace-migration-builder/validators/utils/does-role-require-custom-roles-entitlement.util';
+
+export const validateRoleIsEntitled = ({
+ flatRole,
+ billingEntitlements,
+ buildOptions,
+}: {
+ flatRole: Pick<
+ UniversalFlatRole,
+ 'universalIdentifier' | 'canBeAssignedToUsers' | 'canBeAssignedToApiKeys'
+ >;
+ billingEntitlements: BillingEntitlements;
+ buildOptions: Pick<WorkspaceMigrationBuilderOptions, 'isSystemBuild'>;
+}): FlatEntityValidationError[] => {
+ if (
+ buildOptions.isSystemBuild ||
+ !doesRoleRequireCustomRolesEntitlement(flatRole) ||
+ billingEntitlements[BillingEntitlementKey.CUSTOM_ROLES]
+ ) {
+ return [];
+ }
+
+ return [
+ {
+ code: PermissionsExceptionCode.CUSTOM_ROLES_NOT_ENTITLED,
+ message: PermissionsExceptionMessage.CUSTOM_ROLES_NOT_ENTITLED,
+ userFriendlyMessage: msg`Custom roles are part of the Organization plan.`,
+ },
+ ];
+};
diff --git a/packages/twenty-server/test/integration/metadata/suites/role/__snapshots__/failing-custom-role-assignment-without-entitlement.integration-spec.ts.snap b/packages/twenty-server/test/integration/metadata/suites/role/__snapshots__/failing-custom-role-assignment-without-entitlement.integration-spec.ts.snap
index 22369bd9c81..167ded3c32f 100644
--- a/packages/twenty-server/test/integration/metadata/suites/role/__snapshots__/failing-custom-role-assignment-without-entitlement.integration-spec.ts.snap
+++ b/packages/twenty-server/test/integration/metadata/suites/role/__snapshots__/failing-custom-role-assignment-without-entitlement.integration-spec.ts.snap
@@ -36,6 +36,42 @@ exports[`Custom role assignment without the custom roles entitlement should refu
}
`;
+exports[`Custom role assignment without the custom roles entitlement should refuse creating a role that members or API keys can be assigned 1`] = `
+{
+ "extensions": {
+ "code": "METADATA_VALIDATION_FAILED",
+ "errors": {
+ "role": [
+ {
+ "errors": [
+ {
+ "code": "CUSTOM_ROLES_NOT_ENTITLED",
+ "message": "Custom roles require the Organization plan",
+ "userFriendlyMessage": "Custom roles are part of the Organization plan.",
+ },
+ ],
+ "flatEntityMinimalInformation": {
+ "label": "Unentitled custom role",
+ "universalIdentifier": Any<String>,
+ },
+ "metadataName": "role",
+ "status": "fail",
+ "type": "create",
+ },
+ ],
+ },
+ "message": "Validation failed for 1 role",
+ "summary": {
+ "role": 1,
+ "totalErrors": 1,
+ },
+ "userFriendlyMessage": "Custom roles are part of the Organization plan.",
+ },
+ "message": "Multiple validation errors occurred while creating role",
+ "name": "GraphQLError",
+}
+`;
+
exports[`Custom role assignment without the custom roles entitlement should refuse creating an API key with a custom role 1`] = `
{
"extensions": {
@@ -70,3 +106,38 @@ exports[`Custom role assignment without the custom roles entitlement should refu
"name": "GraphQLError",
}
`;
+
+exports[`Custom role assignment without the custom roles entitlement should refuse making an agent-only role assignable to members 1`] = `
+{
+ "extensions": {
+ "code": "METADATA_VALIDATION_FAILED",
+ "errors": {
+ "role": [
+ {
+ "errors": [
+ {
+ "code": "CUSTOM_ROLES_NOT_ENTITLED",
+ "message": "Custom roles require the Organization plan",
+ "userFriendlyMessage": "Custom roles are part of the Organization plan.",
+ },
+ ],
+ "flatEntityMinimalInformation": {
+ "universalIdentifier": Any<String>,
+ },
+ "metadataName": "role",
+ "status": "fail",
+ "type": "update",
+ },
+ ],
+ },
+ "message": "Validation failed for 1 role",
+ "summary": {
+ "role": 1,
+ "totalErrors": 1,
+ },
+ "userFriendlyMessage": "Custom roles are part of the Organization plan.",
+ },
+ "message": "Multiple validation errors occurred while updating role",
+ "name": "GraphQLError",
+}
+`;
diff --git a/packages/twenty-server/test/integration/metadata/suites/role/failing-custom-role-assignment-without-entitlement.integration-spec.ts b/packages/twenty-server/test/integration/metadata/suites/role/failing-custom-role-assignment-without-entitlement.integration-spec.ts
index 98639ae72a7..0841c8a8f1c 100644
--- a/packages/twenty-server/test/integration/metadata/suites/role/failing-custom-role-assignment-without-entitlement.integration-spec.ts
+++ b/packages/twenty-server/test/integration/metadata/suites/role/failing-custom-role-assignment-without-entitlement.integration-spec.ts
@@ -7,6 +7,7 @@ import { deleteOneAgent } from 'test/integration/metadata/suites/agent/utils/del
import { createOneRole } from 'test/integration/metadata/suites/role/utils/create-one-role.util';
import { deleteOneRole } from 'test/integration/metadata/suites/role/utils/delete-one-role.util';
import { findOneRoleByLabel } from 'test/integration/metadata/suites/role/utils/find-one-role-by-label.util';
+import { updateOneRole } from 'test/integration/metadata/suites/role/utils/update-one-role.util';
import { updateWorkspaceMemberRole } from 'test/integration/metadata/suites/role/utils/update-workspace-member-role.util';
import { makeMetadataApiRequest } from 'test/integration/metadata/suites/utils/make-metadata-api-request.util';
import { getAppProviderByClassName } from 'test/integration/utils/get-app-provider-by-class-name.util';
@@ -95,6 +96,54 @@ describe('Custom role assignment without the custom roles entitlement', () => {
expectOneNotInternalServerErrorSnapshot({ errors });
});
+ it('should refuse creating a role that members or API keys can be assigned', async () => {
+ const { errors } = await createOneRole({
+ expectToFail: true,
+ input: { label: 'Unentitled custom role' },
+ });
+
+ expectOneNotInternalServerErrorSnapshot({ errors });
+ });
+
+ it('should refuse making an agent-only role assignable to members', async () => {
+ const { data } = await createOneRole({
+ expectToFail: false,
+ input: {
+ label: 'Agent role made assignable',
+ canBeAssignedToUsers: false,
+ canBeAssignedToAgents: true,
+ canBeAssignedToApiKeys: false,
+ },
+ });
+
+ const { errors } = await updateOneRole({
+ expectToFail: true,
+ input: {
+ idToUpdate: data.createOneRole.id,
+ updatePayload: { canBeAssignedToUsers: true },
+ },
+ });
+
+ await deleteOneRole({
+ expectToFail: false,
+ input: { idToDelete: data.createOneRole.id },
+ });
+
+ expectOneNotInternalServerErrorSnapshot({ errors });
+ });
+
+ it('should still update a custom role that members can already be assigned', async () => {
+ const { errors } = await updateOneRole({
+ expectToFail: false,
+ input: {
+ idToUpdate: customRoleId,
+ updatePayload: { description: 'Edited without the entitlement' },
+ },
+ });
+
+ expect(errors).toBeUndefined();
+ });
+
describe('when a new user joins with a custom role', () => {
let userWorkspaceService: UserWorkspaceService;
let workspace: WorkspaceEntity;
@@ -192,6 +241,7 @@ describe('Custom role assignment without the custom roles entitlement', () => {
label: 'Agent only role',
canBeAssignedToUsers: false,
canBeAssignedToAgents: true,
+ canBeAssignedToApiKeys: false,
},
});