The open alternative to Salesforce, designed for AI.
TypeScript crmcrm-systemcustomergood-first-issuegraphqlhacktoberfestjavascriptmarketingmonoreponestjsopen-sourcepostgresqlreactreactjssalestypescriptweb
Allow object permissions while creating a role (#27292)
Weiko365adc4054a1
diff --git a/packages/twenty-front/src/modules/settings/roles/components/SettingsRoleRouteGuard.tsx b/packages/twenty-front/src/modules/settings/roles/components/SettingsRoleRouteGuard.tsxindex 097e6a49041..8aebcc2f5db 100644--- a/packages/twenty-front/src/modules/settings/roles/components/SettingsRoleRouteGuard.tsx+++ b/packages/twenty-front/src/modules/settings/roles/components/SettingsRoleRouteGuard.tsx@@ -3,9 +3,13 @@ import { type ReactNode } from 'react';import { WorkspaceRouteUnavailable } from '@/app/routing/components/WorkspaceRouteUnavailable';import { SettingsSkeletonLoader } from '@/settings/components/SettingsSkeletonLoader';import { SettingsRolesQueryEffect } from '@/settings/roles/components/SettingsRolesQueryEffect';+import { settingsDraftRoleFamilyState } from '@/settings/roles/states/settingsDraftRoleFamilyState';+import { settingsPersistedRoleFamilyState } from '@/settings/roles/states/settingsPersistedRoleFamilyState';import { settingsRoleIdsState } from '@/settings/roles/states/settingsRoleIdsState';import { settingsRolesIsLoadingState } from '@/settings/roles/states/settingsRolesIsLoadingState';+import { useAtomFamilyStateValue } from '@/ui/utilities/state/jotai/hooks/useAtomFamilyStateValue';import { useAtomStateValue } from '@/ui/utilities/state/jotai/hooks/useAtomStateValue';+import { isDefined } from 'twenty-shared/utils';export const SettingsRoleRouteGuard = ({roleId,@@ -16,10 +20,21 @@ export const SettingsRoleRouteGuard = ({}) => {const settingsRoleIds = useAtomStateValue(settingsRoleIdsState);const settingsRolesIsLoading = useAtomStateValue(settingsRolesIsLoadingState);+ const settingsDraftRole = useAtomFamilyStateValue(+ settingsDraftRoleFamilyState,+ roleId,+ );+ const settingsPersistedRole = useAtomFamilyStateValue(+ settingsPersistedRoleFamilyState,+ roleId,+ );++ const isUnsavedRole =+ settingsDraftRole.id === roleId && !isDefined(settingsPersistedRole);const guardedChildren = settingsRolesIsLoading ? (<SettingsSkeletonLoader />- ) : settingsRoleIds.includes(roleId) ? (+ ) : settingsRoleIds.includes(roleId) || isUnsavedRole ? (children) : (<WorkspaceRouteUnavailable />diff --git a/packages/twenty-front/src/modules/settings/roles/components/__tests__/SettingsRoleRouteGuard.test.tsx b/packages/twenty-front/src/modules/settings/roles/components/__tests__/SettingsRoleRouteGuard.test.tsxindex 7c1a5c52a4c..f655ad80ea0 100644--- a/packages/twenty-front/src/modules/settings/roles/components/__tests__/SettingsRoleRouteGuard.test.tsx+++ b/packages/twenty-front/src/modules/settings/roles/components/__tests__/SettingsRoleRouteGuard.test.tsx@@ -2,8 +2,13 @@ import { render, screen } from '@testing-library/react';import { createStore, Provider as JotaiProvider } from 'jotai';import { SettingsRoleRouteGuard } from '@/settings/roles/components/SettingsRoleRouteGuard';+import { settingsDraftRoleFamilyState } from '@/settings/roles/states/settingsDraftRoleFamilyState';+import { settingsPersistedRoleFamilyState } from '@/settings/roles/states/settingsPersistedRoleFamilyState';import { settingsRoleIdsState } from '@/settings/roles/states/settingsRoleIdsState';import { settingsRolesIsLoadingState } from '@/settings/roles/states/settingsRolesIsLoadingState';+import { type RoleWithPartialMembers } from '@/settings/roles/types/RoleWithPartialMembers';+import { RoutedFlowStateScopeContext } from '@/ui/utilities/state/contexts/RoutedFlowStateScopeContext';+import { mockedRoles } from '~/testing/mock-data/generated/metadata/roles/mock-roles-data';import {WorkspaceSurfaceContext,type WorkspaceSurfaceContextValue,@@ -20,14 +25,31 @@ jest.mock('@/app/routing/components/WorkspaceRouteUnavailable', () => ({const renderGuard = ({surface,roleIds,+ draftRole,+ persistedRole,+ draftScopeId,}: {surface: WorkspaceSurfaceContextValue['type'];roleIds: string[];+ draftRole?: RoleWithPartialMembers;+ persistedRole?: RoleWithPartialMembers;+ draftScopeId?: string;}) => {const store = createStore();+ const scopeId = surface === 'side-panel' ? 'role-creation-flow' : null;store.set(settingsRoleIdsState.atom, roleIds);store.set(settingsRolesIsLoadingState.atom, false);+ if (draftRole) {+ store.set(+ settingsDraftRoleFamilyState.getAtom('role-1', draftScopeId ?? scopeId),+ draftRole,+ );+ }+ store.set(+ settingsPersistedRoleFamilyState.atomFamily('role-1'),+ persistedRole,+ );render(<JotaiProvider store={store}>@@ -38,15 +60,61 @@ const renderGuard = ({ownsRouteLocation: true,}}>- <SettingsRoleRouteGuard roleId="role-1">- <div data-testid="role-page" />- </SettingsRoleRouteGuard>+ <RoutedFlowStateScopeContext.Provider value={scopeId}>+ <SettingsRoleRouteGuard roleId="role-1">+ <div data-testid="role-page" />+ </SettingsRoleRouteGuard>+ </RoutedFlowStateScopeContext.Provider></WorkspaceSurfaceContext.Provider></JotaiProvider>,);};describe('SettingsRoleRouteGuard', () => {+ it.each(['main', 'side-panel'] as const)(+ 'allows an unsaved role to reach its permission editor on %s',+ (surface) => {+ renderGuard({+ surface,+ roleIds: [],+ draftRole: { ...mockedRoles[0], id: 'role-1' },+ });++ expect(screen.getByTestId('role-page')).toBeInTheDocument();+ expect(screen.queryByTestId('route-unavailable')).not.toBeInTheDocument();+ },+ );++ it('does not use a stale draft to reopen a previously persisted role', () => {+ const role = { ...mockedRoles[0], id: 'role-1' };++ renderGuard({+ surface: 'main',+ roleIds: [],+ draftRole: role,+ persistedRole: role,+ });++ expect(screen.getByTestId('route-unavailable')).toBeInTheDocument();+ });++ it('does not allow a draft from another creation flow', () => {+ renderGuard({+ surface: 'side-panel',+ roleIds: [],+ draftRole: { ...mockedRoles[0], id: 'role-1' },+ draftScopeId: 'another-flow',+ });++ expect(screen.getByTestId('route-unavailable')).toBeInTheDocument();+ });++ it('allows a persisted role', () => {+ renderGuard({ surface: 'main', roleIds: ['role-1'] });++ expect(screen.getByTestId('role-page')).toBeInTheDocument();+ });+it('contains a missing role in the side panel', () => {renderGuard({ surface: 'side-panel', roleIds: [] });diff --git a/packages/twenty-front/src/modules/settings/roles/constants/DefaultSettingsDraftRole.ts b/packages/twenty-front/src/modules/settings/roles/constants/DefaultSettingsDraftRole.tsnew file mode 100644index 00000000000..1f54eff4d67--- /dev/null+++ b/packages/twenty-front/src/modules/settings/roles/constants/DefaultSettingsDraftRole.ts@@ -0,0 +1,27 @@+import { type RoleWithPartialMembers } from '@/settings/roles/types/RoleWithPartialMembers';++export const DEFAULT_SETTINGS_DRAFT_ROLE: RoleWithPartialMembers = {+ __typename: 'Role',+ id: '',+ label: '',+ description: '',+ icon: '',+ canDestroyAllObjectRecords: false,+ canReadAllObjectRecords: false,+ canSoftDeleteAllObjectRecords: false,+ canUpdateAllObjectRecords: false,+ canUpdateAllSettings: false,+ canAccessAllTools: false,+ isEditable: false,+ workspaceMembers: [],+ permissionFlags: [],+ objectPermissions: [],+ fieldPermissions: [],+ rowLevelPermissionPredicates: [],+ rowLevelPermissionPredicateGroups: [],+ canBeAssignedToAgents: false,+ canBeAssignedToApiKeys: false,+ canBeAssignedToUsers: false,+ agents: [],+ apiKeys: [],+};diff --git a/packages/twenty-front/src/modules/settings/roles/role/components/SettingsRole.tsx b/packages/twenty-front/src/modules/settings/roles/role/components/SettingsRole.tsxindex 08706cb1ff6..3980dbe9b6f 100644--- a/packages/twenty-front/src/modules/settings/roles/role/components/SettingsRole.tsx+++ b/packages/twenty-front/src/modules/settings/roles/role/components/SettingsRole.tsx@@ -3,6 +3,7 @@ import { SaveAndCancelButtons } from '@/settings/components/SaveAndCancelButtonsimport { SettingsPageContainer } from '@/settings/components/SettingsPageContainer';import { SettingsPageLayout } from '@/settings/components/layout/SettingsPageLayout';import { SettingsTabBar } from '@/settings/components/layout/SettingsTabBar';+import { DEFAULT_SETTINGS_DRAFT_ROLE } from '@/settings/roles/constants/DefaultSettingsDraftRole';import { SettingsRoleAssignment } from '@/settings/roles/role-assignment/components/SettingsRoleAssignment';import { SettingsRolePermissions } from '@/settings/roles/role-permissions/components/SettingsRolePermissions';import { SettingsRoleSettings } from '@/settings/roles/role-settings/components/SettingsRoleSettings';@@ -102,6 +103,7 @@ export const SettingsRole = ({ roleId, isCreateMode }: SettingsRoleProps) => {const handleCancel = () => {if (isCreateMode) {+ setSettingsDraftRole(DEFAULT_SETTINGS_DRAFT_ROLE);navigateSettings(SettingsPath.Roles);return;}diff --git a/packages/twenty-front/src/modules/settings/roles/role/components/__tests__/SettingsRole.test.tsx b/packages/twenty-front/src/modules/settings/roles/role/components/__tests__/SettingsRole.test.tsxindex aa49cc70b24..2b14836c44a 100644--- a/packages/twenty-front/src/modules/settings/roles/role/components/__tests__/SettingsRole.test.tsx+++ b/packages/twenty-front/src/modules/settings/roles/role/components/__tests__/SettingsRole.test.tsx@@ -5,15 +5,28 @@ import userEvent from '@testing-library/user-event';import { createStore, Provider as JotaiProvider } from 'jotai';import { type ReactNode } from 'react';import { MemoryRouter } from 'react-router-dom';+import { SettingsPath } from 'twenty-shared/types';+import { SettingsRoleRouteGuard } from '@/settings/roles/components/SettingsRoleRouteGuard';import { SettingsRole } from '@/settings/roles/role/components/SettingsRole';import { settingsDraftRoleFamilyState } from '@/settings/roles/states/settingsDraftRoleFamilyState';import { settingsPersistedRoleFamilyState } from '@/settings/roles/states/settingsPersistedRoleFamilyState';+import { settingsRolesIsLoadingState } from '@/settings/roles/states/settingsRolesIsLoadingState';import { type RoleWithPartialMembers } from '@/settings/roles/types/RoleWithPartialMembers';+import { RoutedFlowStateScopeContext } from '@/ui/utilities/state/contexts/RoutedFlowStateScopeContext';const mockSaveDraftRoleToDB = jest.fn();const mockLoadCurrentUser = jest.fn();const mockEnqueueToast = jest.fn();+const mockNavigateSettings = jest.fn();++jest.mock('@/settings/roles/components/SettingsRolesQueryEffect', () => ({+ SettingsRolesQueryEffect: () => null,+}));++jest.mock('@/app/routing/components/WorkspaceRouteUnavailable', () => ({+ WorkspaceRouteUnavailable: () => <div>Role unavailable</div>,+}));jest.mock('@/settings/roles/role/hooks/useSaveDraftRoleToDB', () => ({useSaveDraftRoleToDB: () => ({ saveDraftRoleToDB: mockSaveDraftRoleToDB }),@@ -24,7 +37,7 @@ jest.mock('@/users/hooks/useLoadCurrentUser', () => ({}));jest.mock('~/hooks/useNavigateSettings', () => ({- useNavigateSettings: () => jest.fn(),+ useNavigateSettings: () => mockNavigateSettings,}));jest.mock('twenty-ui/components', () => ({@@ -101,27 +114,39 @@ const PERSISTED_ROLE: RoleWithPartialMembers = {rowLevelPermissionPredicateGroups: [],};-const renderSettingsRole = ({ draftLabel }: { draftLabel: string }) => {+const renderSettingsRole = ({+ draftLabel,+ isCreateMode = false,+ scopeId = null,+}: {+ draftLabel: string;+ isCreateMode?: boolean;+ scopeId?: string | null;+}) => {const store = createStore();store.set(settingsPersistedRoleFamilyState.atomFamily(ROLE_ID),- PERSISTED_ROLE,+ isCreateMode ? undefined : PERSISTED_ROLE,);- store.set(settingsDraftRoleFamilyState.atomFamily(ROLE_ID), {+ store.set(settingsDraftRoleFamilyState.getAtom(ROLE_ID, scopeId), {...PERSISTED_ROLE,label: draftLabel,});- render(+ const rendered = render(<I18nProvider i18n={i18n}><MemoryRouter><JotaiProvider store={store}>- <SettingsRole roleId={ROLE_ID} isCreateMode={false} />+ <RoutedFlowStateScopeContext.Provider value={scopeId}>+ <SettingsRole roleId={ROLE_ID} isCreateMode={isCreateMode} />+ </RoutedFlowStateScopeContext.Provider></JotaiProvider></MemoryRouter></I18nProvider>,);++ return { ...rendered, store };};describe('SettingsRole', () => {@@ -129,6 +154,53 @@ describe('SettingsRole', () => {jest.resetAllMocks();});+ it.each([null, 'role-creation-flow'])(+ 'should prevent a canceled draft from reopening in scope %s',+ async (scopeId) => {+ const user = userEvent.setup();+ const { store, unmount } = renderSettingsRole({+ draftLabel: 'Canceled role',+ isCreateMode: true,+ scopeId,+ });++ await user.click(screen.getByRole('button', { name: 'Cancel' }));++ expect(mockNavigateSettings).toHaveBeenCalledTimes(1);+ expect(mockNavigateSettings).toHaveBeenCalledWith(SettingsPath.Roles);+ expect(mockSaveDraftRoleToDB).not.toHaveBeenCalled();++ unmount();+ store.set(settingsRolesIsLoadingState.atom, false);++ render(+ <JotaiProvider store={store}>+ <RoutedFlowStateScopeContext.Provider value={scopeId}>+ <SettingsRoleRouteGuard roleId={ROLE_ID}>+ <div>Role editor</div>+ </SettingsRoleRouteGuard>+ </RoutedFlowStateScopeContext.Provider>+ </JotaiProvider>,+ );++ expect(screen.getByText('Role unavailable')).toBeInTheDocument();+ expect(screen.queryByText('Role editor')).not.toBeInTheDocument();+ },+ );++ it('should restore the persisted role when canceling edits', async () => {+ const user = userEvent.setup();+ const { store } = renderSettingsRole({ draftLabel: 'Changed role' });++ await user.click(screen.getByRole('button', { name: 'Cancel' }));++ expect(store.get(settingsDraftRoleFamilyState.atomFamily(ROLE_ID))).toEqual(+ PERSISTED_ROLE,+ );+ expect(mockNavigateSettings).not.toHaveBeenCalled();+ expect(mockSaveDraftRoleToDB).not.toHaveBeenCalled();+ });+it('should leave the save button usable when saving is rejected because the role name is empty', async () => {const user = userEvent.setup();diff --git a/packages/twenty-front/src/modules/settings/roles/states/settingsDraftRoleFamilyState.ts b/packages/twenty-front/src/modules/settings/roles/states/settingsDraftRoleFamilyState.tsindex 82e4b1d6673..9d00d873b7b 100644--- a/packages/twenty-front/src/modules/settings/roles/states/settingsDraftRoleFamilyState.ts+++ b/packages/twenty-front/src/modules/settings/roles/states/settingsDraftRoleFamilyState.ts@@ -1,5 +1,6 @@import { createAtomFamilyState } from '@/ui/utilities/state/jotai/utils/createAtomFamilyState';import { type RoleWithPartialMembers } from '@/settings/roles/types/RoleWithPartialMembers';+import { DEFAULT_SETTINGS_DRAFT_ROLE } from '@/settings/roles/constants/DefaultSettingsDraftRole';export const settingsDraftRoleFamilyState = createAtomFamilyState<RoleWithPartialMembers,@@ -7,29 +8,5 @@ export const settingsDraftRoleFamilyState = createAtomFamilyState<>({key: 'settingsDraftRoleFamilyState',scope: 'routed-flow',- defaultValue: {- __typename: 'Role',- id: '',- label: '',- description: '',- icon: '',- canDestroyAllObjectRecords: false,- canReadAllObjectRecords: false,- canSoftDeleteAllObjectRecords: false,- canUpdateAllObjectRecords: false,- canUpdateAllSettings: false,- canAccessAllTools: false,- isEditable: false,- workspaceMembers: [],- permissionFlags: [],- objectPermissions: [],- fieldPermissions: [],- rowLevelPermissionPredicates: [],- rowLevelPermissionPredicateGroups: [],- canBeAssignedToAgents: false,- canBeAssignedToApiKeys: false,- canBeAssignedToUsers: false,- agents: [],- apiKeys: [],- },+ defaultValue: DEFAULT_SETTINGS_DRAFT_ROLE,});