The open alternative to Salesforce, designed for AI.
TypeScript crmcrm-systemcustomergood-first-issuegraphqlhacktoberfestjavascriptmarketingmonoreponestjsopen-sourcepostgresqlreactreactjssalestypescriptweb
fix(front): preserve multi-record selection in side-panel components (#27041)
Wael Antar3930fe4cf0b1
diff --git a/packages/twenty-front/src/modules/command-menu-item/hooks/__tests__/useCommandMenuItemClick.test.tsx b/packages/twenty-front/src/modules/command-menu-item/hooks/__tests__/useCommandMenuItemClick.test.tsxindex bcb51d60739..9379808fb22 100644--- a/packages/twenty-front/src/modules/command-menu-item/hooks/__tests__/useCommandMenuItemClick.test.tsx+++ b/packages/twenty-front/src/modules/command-menu-item/hooks/__tests__/useCommandMenuItemClick.test.tsx@@ -1,5 +1,6 @@import { act, renderHook } from '@testing-library/react';import { type ReactNode } from 'react';+import { createStore, Provider as JotaiProvider } from 'jotai';import { type CommandMenuContextApi } from 'twenty-shared/types';import { IconApps } from 'twenty-ui/icon';@@ -7,6 +8,7 @@ import { EMPTY_COMMAND_MENU_CONTEXT_API } from '@/command-menu-item/constants/Emimport { CommandMenuContext } from '@/command-menu-item/contexts/CommandMenuContext';import { useCommandMenuItemClick } from '@/command-menu-item/hooks/useCommandMenuItemClick';import { CommandMenuItemContainerType } from '@/command-menu-item/types/CommandMenuItemContainerType';+import { contextStoreTargetedRecordsRuleComponentState } from '@/context-store/states/contextStoreTargetedRecordsRuleComponentState';import { type CommandMenuItemDefinition } from '@/command-menu-item/types/CommandMenuItemDefinition';const mockOpenFrontComponentInSidePanel = jest.fn();@@ -57,22 +59,35 @@ const FRONT_COMPONENT_COMMAND_MENU_ITEM = {},} as CommandMenuItemDefinition;-const getWrapper =- (commandMenuContextApi: CommandMenuContextApi) =>- ({ children }: { children: ReactNode }) => (- <CommandMenuContext.Provider- value={{- containerType: CommandMenuItemContainerType.CommandMenuList,- displayType: 'listItem',- commandMenuItems: [],- commandMenuContextApi,- isInPreviewMode: false,- }}- >- {children}- </CommandMenuContext.Provider>+const getWrapper = (+ commandMenuContextApi: CommandMenuContextApi,+ selectedRecordIds: string[],+) => {+ const store = createStore();+ store.set(+ contextStoreTargetedRecordsRuleComponentState.atomFamily({+ instanceId: 'context-store-instance-id',+ }),+ { mode: 'selection', selectedRecordIds },);+ return ({ children }: { children: ReactNode }) => (+ <JotaiProvider store={store}>+ <CommandMenuContext.Provider+ value={{+ containerType: CommandMenuItemContainerType.CommandMenuList,+ displayType: 'listItem',+ commandMenuItems: [],+ commandMenuContextApi,+ isInPreviewMode: false,+ }}+ >+ {children}+ </CommandMenuContext.Provider>+ </JotaiProvider>+ );+};+describe('useCommandMenuItemClick', () => {beforeEach(() => {jest.clearAllMocks();@@ -83,33 +98,47 @@ describe('useCommandMenuItemClick', () => {description: 'the object and the record when one record is selected',objectMetadataItem: { nameSingular: 'company' },selectedRecordIds: ['record-1'],+ storedRecordIds: ['record-1'],expectedRecordContext: {objectNameSingular: 'company',- recordId: 'record-1',+ selectedRecordIds: ['record-1'],},},{description: 'the object when several records are selected',objectMetadataItem: { nameSingular: 'company' },selectedRecordIds: ['record-1', 'record-2'],+ storedRecordIds: ['record-1', 'record-2'],+ expectedRecordContext: {+ objectNameSingular: 'company',+ selectedRecordIds: ['record-1', 'record-2'],+ },+ },+ {+ description: 'selected records missing from the record store',+ objectMetadataItem: { nameSingular: 'company' },+ selectedRecordIds: ['record-1', 'record-2'],+ storedRecordIds: ['record-1'],expectedRecordContext: {objectNameSingular: 'company',- recordId: undefined,+ selectedRecordIds: ['record-1', 'record-2'],},},{description: 'the object when no record is selected',objectMetadataItem: { nameSingular: 'company' },selectedRecordIds: [],+ storedRecordIds: [],expectedRecordContext: {objectNameSingular: 'company',- recordId: undefined,+ selectedRecordIds: [],},},{description: 'no record context outside an object',objectMetadataItem: {},selectedRecordIds: ['record-1'],+ storedRecordIds: ['record-1'],expectedRecordContext: undefined,},])(@@ -117,6 +146,7 @@ describe('useCommandMenuItemClick', () => {async ({objectMetadataItem,selectedRecordIds,+ storedRecordIds,expectedRecordContext,}) => {const { result } = renderHook(@@ -127,14 +157,17 @@ describe('useCommandMenuItemClick', () => {label: 'Open front component',}),{- wrapper: getWrapper({- ...EMPTY_COMMAND_MENU_CONTEXT_API,- objectMetadataItem,- selectedRecords: selectedRecordIds.map((id) => ({- id,- __typename: 'Company',- })),- }),+ wrapper: getWrapper(+ {+ ...EMPTY_COMMAND_MENU_CONTEXT_API,+ objectMetadataItem,+ selectedRecords: storedRecordIds.map((id) => ({+ id,+ __typename: 'Company',+ })),+ },+ selectedRecordIds,+ ),},);diff --git a/packages/twenty-front/src/modules/command-menu-item/hooks/useCommandMenuItemClick.ts b/packages/twenty-front/src/modules/command-menu-item/hooks/useCommandMenuItemClick.tsindex a79f13cf592..287bd44f7e9 100644--- a/packages/twenty-front/src/modules/command-menu-item/hooks/useCommandMenuItemClick.ts+++ b/packages/twenty-front/src/modules/command-menu-item/hooks/useCommandMenuItemClick.ts@@ -7,10 +7,12 @@ import { isEngineCommandMountedFamilySelector } from '@/command-menu-item/engineimport { useCloseCommandMenu } from '@/command-menu-item/hooks/useCloseCommandMenu';import { commandMenuItemProgressFamilyState } from '@/command-menu-item/states/commandMenuItemProgressFamilyState';import { ContextStoreComponentInstanceContext } from '@/context-store/states/contexts/ContextStoreComponentInstanceContext';+import { contextStoreTargetedRecordsRuleComponentState } from '@/context-store/states/contextStoreTargetedRecordsRuleComponentState';import { useOpenFrontComponentInSidePanel } from '@/side-panel/hooks/useOpenFrontComponentInSidePanel';import { useAvailableComponentInstanceIdOrThrow } from '@/ui/utilities/state/component-state/hooks/useAvailableComponentInstanceIdOrThrow';import { useAtomFamilySelectorValue } from '@/ui/utilities/state/jotai/hooks/useAtomFamilySelectorValue';import { useAtomFamilyStateValue } from '@/ui/utilities/state/jotai/hooks/useAtomFamilyStateValue';+import { useAtomComponentStateValue } from '@/ui/utilities/state/jotai/hooks/useAtomComponentStateValue';import { isValidElement, useContext } from 'react';import { ENGINE_COMPONENT_KEY_COMPONENT_MAP } from '@/command-menu-item/engine-command/constants/EngineComponentKeyHeadlessComponentMap';import { ExportRecordsCommand } from '@/command-menu-item/engine-command/record/components/ExportRecordsCommand';@@ -37,6 +39,10 @@ export const useCommandMenuItemClick = ({const contextStoreInstanceId = useAvailableComponentInstanceIdOrThrow(ContextStoreComponentInstanceContext,);+ const contextStoreTargetedRecordsRule = useAtomComponentStateValue(+ contextStoreTargetedRecordsRuleComponentState,+ contextStoreInstanceId,+ );const isMounted = useAtomFamilySelectorValue(isEngineCommandMountedFamilySelector,@@ -110,10 +116,7 @@ export const useCommandMenuItemClick = ({}if (isFrontComponent && isDefined(item.frontComponentId)) {- const { selectedRecords, objectMetadataItem } = commandMenuContextApi;-- const recordId =- selectedRecords.length === 1 ? selectedRecords[0].id : undefined;+ const { objectMetadataItem } = commandMenuContextApi;const objectNameSingular = objectMetadataItem.nameSingular as| string@@ -126,7 +129,13 @@ export const useCommandMenuItemClick = ({pageTitle: label,pageIcon: Icon,recordContext: isDefined(objectNameSingular)- ? { objectNameSingular, recordId }+ ? {+ objectNameSingular,+ selectedRecordIds:+ contextStoreTargetedRecordsRule.mode === 'selection'+ ? contextStoreTargetedRecordsRule.selectedRecordIds+ : [],+ }: undefined,});}diff --git a/packages/twenty-front/src/modules/front-components/hooks/__tests__/useFrontComponentExecutionContext.test.tsx b/packages/twenty-front/src/modules/front-components/hooks/__tests__/useFrontComponentExecutionContext.test.tsxindex f10052b468b..e6d6458f93a 100644--- a/packages/twenty-front/src/modules/front-components/hooks/__tests__/useFrontComponentExecutionContext.test.tsx+++ b/packages/twenty-front/src/modules/front-components/hooks/__tests__/useFrontComponentExecutionContext.test.tsx@@ -170,19 +170,25 @@ jest.mock('@/file/hooks/useDirectFileUpload', () => ({}),}));-jest.mock('twenty-front-component-renderer', () => ({- buildFrontComponentStorageNamespace: ({- applicationId,- userId,- }: {- applicationId: string;- userId: string;- }) => `frontComponentStorage:${applicationId}:${userId}:`,- setFrontComponentStorageItem: (...args: unknown[]) => mockStorageSet(...args),- deleteFrontComponentStorageItem: (...args: unknown[]) =>- mockStorageDelete(...args),- clearFrontComponentStorage: (...args: unknown[]) => mockStorageClear(...args),-}));+jest.mock(+ 'twenty-front-component-renderer',+ () => ({+ buildFrontComponentStorageNamespace: ({+ applicationId,+ userId,+ }: {+ applicationId: string;+ userId: string;+ }) => `frontComponentStorage:${applicationId}:${userId}:`,+ setFrontComponentStorageItem: (...args: unknown[]) =>+ mockStorageSet(...args),+ deleteFrontComponentStorageItem: (...args: unknown[]) =>+ mockStorageDelete(...args),+ clearFrontComponentStorage: (...args: unknown[]) =>+ mockStorageClear(...args),+ }),+ { virtual: true },+);jest.mock('@/page-layout/utils/setRecordPageActiveTabId', () => ({setRecordPageActiveTabId: (params: unknown) =>@@ -867,7 +873,70 @@ describe('useFrontComponentExecutionContext', () => {pageTitle: 'My Component',pageIcon: 'icon-IconBolt',resetNavigationStack: undefined,- recordContext: { recordId: 'lead-1', objectNameSingular: 'lead' },+ recordContext: {+ selectedRecordIds: ['lead-1'],+ objectNameSingular: 'lead',+ },+ });+ });++ it('should pass multiple selected record ids to a front component', async () => {+ const { result } = renderUseFrontComponentExecutionContext({+ frontComponentId: FRONT_COMPONENT_ID,+ });++ await act(async () => {+ await result.current.frontComponentHostCommunicationApi.openSidePanelPage(+ {+ page: SidePanelPages.ViewFrontComponent,+ frontComponentId: 'fc-1',+ pageTitle: 'My Component',+ pageIcon: 'IconBolt',+ selectedRecordIds: ['lead-1', 'lead-2'],+ objectNameSingular: 'lead',+ },+ );+ });++ expect(mockOpenFrontComponentInSidePanel).toHaveBeenCalledTimes(1);+ expect(mockOpenFrontComponentInSidePanel).toHaveBeenCalledWith({+ frontComponentId: 'fc-1',+ pageTitle: 'My Component',+ pageIcon: 'icon-IconBolt',+ resetNavigationStack: undefined,+ recordContext: {+ selectedRecordIds: ['lead-1', 'lead-2'],+ objectNameSingular: 'lead',+ },+ });+ });++ it('should retain selected ids without an object name', async () => {+ const { result } = renderUseFrontComponentExecutionContext({+ frontComponentId: FRONT_COMPONENT_ID,+ });++ await act(async () => {+ await result.current.frontComponentHostCommunicationApi.openSidePanelPage(+ {+ page: SidePanelPages.ViewFrontComponent,+ frontComponentId: 'fc-1',+ pageTitle: 'My Component',+ selectedRecordIds: ['lead-1', 'lead-2'],+ },+ );+ });++ expect(mockOpenFrontComponentInSidePanel).toHaveBeenCalledTimes(1);+ expect(mockOpenFrontComponentInSidePanel).toHaveBeenCalledWith({+ frontComponentId: 'fc-1',+ pageTitle: 'My Component',+ pageIcon: 'icon-undefined',+ resetNavigationStack: undefined,+ recordContext: {+ objectNameSingular: undefined,+ selectedRecordIds: ['lead-1', 'lead-2'],+ },});});@@ -893,7 +962,10 @@ describe('useFrontComponentExecutionContext', () => {pageTitle: 'My Component',pageIcon: 'icon-IconBolt',resetNavigationStack: undefined,- recordContext: { objectNameSingular: 'lead', recordId: undefined },+ recordContext: {+ objectNameSingular: 'lead',+ selectedRecordIds: undefined,+ },});});});diff --git a/packages/twenty-front/src/modules/front-components/hooks/useFrontComponentExecutionContext.ts b/packages/twenty-front/src/modules/front-components/hooks/useFrontComponentExecutionContext.tsindex 33e66ba29e9..12f6c0328df 100644--- a/packages/twenty-front/src/modules/front-components/hooks/useFrontComponentExecutionContext.ts+++ b/packages/twenty-front/src/modules/front-components/hooks/useFrontComponentExecutionContext.ts@@ -353,12 +353,17 @@ export const useFrontComponentExecutionContext = ({}if (params.page === SidePanelPages.ViewFrontComponent) {- const recordContext = isDefined(params.objectNameSingular)- ? {- objectNameSingular: params.objectNameSingular,- recordId: params.recordId,- }- : undefined;+ const recordContext =+ isDefined(params.objectNameSingular) ||+ isDefined(params.selectedRecordIds) ||+ isDefined(params.recordId)+ ? {+ objectNameSingular: params.objectNameSingular,+ selectedRecordIds:+ params.selectedRecordIds ??+ (isDefined(params.recordId) ? [params.recordId] : undefined),+ }+ : undefined;openFrontComponentInSidePanel({frontComponentId: params.frontComponentId,diff --git a/packages/twenty-front/src/modules/side-panel/pages/front-component/components/SidePanelFrontComponentPage.tsx b/packages/twenty-front/src/modules/side-panel/pages/front-component/components/SidePanelFrontComponentPage.tsxindex d703d010ae5..2fec6981fac 100644--- a/packages/twenty-front/src/modules/side-panel/pages/front-component/components/SidePanelFrontComponentPage.tsx+++ b/packages/twenty-front/src/modules/side-panel/pages/front-component/components/SidePanelFrontComponentPage.tsx@@ -25,17 +25,13 @@ export const SidePanelFrontComponentPage = () => {return null;}- const selectedRecordIds = isDefined(- viewableFrontComponentRecordContext?.recordId,- )- ? [viewableFrontComponentRecordContext.recordId]- : undefined;-return (<Suspense fallback={<FrontComponentSkeletonLoader />}><FrontComponentRendererfrontComponentId={viewableFrontComponentId}- selectedRecordIds={selectedRecordIds}+ selectedRecordIds={+ viewableFrontComponentRecordContext?.selectedRecordIds+ }objectNameSingular={viewableFrontComponentRecordContext?.objectNameSingular}diff --git a/packages/twenty-front/src/modules/side-panel/pages/front-component/components/__tests__/SidePanelFrontComponentPage.test.tsx b/packages/twenty-front/src/modules/side-panel/pages/front-component/components/__tests__/SidePanelFrontComponentPage.test.tsxindex 1cd4520e0d6..ce365779b04 100644--- a/packages/twenty-front/src/modules/side-panel/pages/front-component/components/__tests__/SidePanelFrontComponentPage.test.tsx+++ b/packages/twenty-front/src/modules/side-panel/pages/front-component/components/__tests__/SidePanelFrontComponentPage.test.tsx@@ -62,11 +62,27 @@ describe('SidePanelFrontComponentPage', () => {it.each([{description: 'the record and its object',- recordContext: { objectNameSingular: 'company', recordId: 'record-id' },+ recordContext: {+ objectNameSingular: 'company',+ selectedRecordIds: ['record-id'],+ },expectedContent: 'front-component-id:company:record-id',},{- description: 'the object when no single record is selected',+ description: 'every selected record and its object',+ recordContext: {+ objectNameSingular: 'company',+ selectedRecordIds: ['record-1', 'record-2'],+ },+ expectedContent: 'front-component-id:company:record-1,record-2',+ },+ {+ description: 'selected records without an object name',+ recordContext: { selectedRecordIds: ['record-1', 'record-2'] },+ expectedContent: 'front-component-id:no object:record-1,record-2',+ },+ {+ description: 'the object when no record is selected',recordContext: { objectNameSingular: 'company' },expectedContent: 'front-component-id:company:no records',},diff --git a/packages/twenty-front/src/modules/side-panel/pages/front-component/types/FrontComponentRecordContext.ts b/packages/twenty-front/src/modules/side-panel/pages/front-component/types/FrontComponentRecordContext.tsindex 22ccbb292d5..c8a0a9e2421 100644--- a/packages/twenty-front/src/modules/side-panel/pages/front-component/types/FrontComponentRecordContext.ts+++ b/packages/twenty-front/src/modules/side-panel/pages/front-component/types/FrontComponentRecordContext.ts@@ -1,4 +1,4 @@export type FrontComponentRecordContext = {- objectNameSingular: string;- recordId?: string;+ objectNameSingular?: string;+ selectedRecordIds?: string[];};diff --git a/packages/twenty-sdk/src/sdk/front-component/globals/frontComponentHostCommunicationApi.ts b/packages/twenty-sdk/src/sdk/front-component/globals/frontComponentHostCommunicationApi.tsindex 9099b5389af..0b8857dcdc4 100644--- a/packages/twenty-sdk/src/sdk/front-component/globals/frontComponentHostCommunicationApi.ts+++ b/packages/twenty-sdk/src/sdk/front-component/globals/frontComponentHostCommunicationApi.ts@@ -54,6 +54,7 @@ type OpenPurposeBuiltSidePanelPageParams =page: SidePanelPages.ViewFrontComponent;frontComponentId: string;recordId?: string;+ selectedRecordIds?: string[];objectNameSingular?: string;pageTitle: string;pageIcon?: string;