The open alternative to Salesforce, designed for AI.
TypeScript crmcrm-systemcustomergood-first-issuegraphqlhacktoberfestjavascriptmarketingmonoreponestjsopen-sourcepostgresqlreactreactjssalestypescriptweb
Resolve the side panel context store object from the panel location (#25586)
Raphaël Bosi0db59f8dccc8
diff --git a/packages/twenty-front/src/modules/context-store/components/RouteContextStoreProvider.tsx b/packages/twenty-front/src/modules/context-store/components/RouteContextStoreProvider.tsxindex db155a89b53..07bc0754dee 100644--- a/packages/twenty-front/src/modules/context-store/components/RouteContextStoreProvider.tsx+++ b/packages/twenty-front/src/modules/context-store/components/RouteContextStoreProvider.tsx@@ -1,3 +1,4 @@+import { useWorkspaceRouteObjects } from '@/app/routing/components/WorkspaceRouteObjectsProvider';import { RouteContextStoreProviderEffect } from '@/context-store/components/RouteContextStoreProviderEffect';import { metadataStoreState } from '@/metadata-store/states/metadataStoreState';import { useIsSettingsPage } from '@/navigation/hooks/useIsSettingsPage';@@ -6,7 +7,7 @@ import { objectMetadataItemsSelector } from '@/object-metadata/states/objectMetaimport { useAtomFamilyStateValue } from '@/ui/utilities/state/jotai/hooks/useAtomFamilyStateValue';import { useAtomStateValue } from '@/ui/utilities/state/jotai/hooks/useAtomStateValue';import { viewsSelector } from '@/views/states/selectors/viewsSelector';-import { useLocation, useParams, useSearchParams } from 'react-router-dom';+import { matchRoutes, useLocation, useSearchParams } from 'react-router-dom';import { AppPath } from 'twenty-shared/types';import { isDefined } from 'twenty-shared/utils';import { ViewKey, ViewType } from '~/generated-metadata/graphql';@@ -39,6 +40,7 @@ const getViewId = (export const RouteContextStoreProvider = () => {const location = useLocation();+ const routeObjects = useWorkspaceRouteObjects();const isRecordIndexPage = isMatchingLocation(location,AppPath.RecordIndexPage,@@ -48,8 +50,9 @@ export const RouteContextStoreProvider = () => {const isAiChatPage = isMatchingLocation(location, AppPath.AiChat);const isSettingsPage = useIsSettingsPage();- const objectNamePlural = useParams().objectNamePlural ?? '';- const objectNameSingular = useParams().objectNameSingular ?? '';+ const routeParams = matchRoutes(routeObjects, location)?.at(-1)?.params;+ const objectNamePlural = routeParams?.objectNamePlural;+ const objectNameSingular = routeParams?.objectNameSingular;const [searchParams] = useSearchParams();const viewIdQueryParamRaw = searchParams.get('viewId');diff --git a/packages/twenty-front/src/modules/context-store/components/__tests__/RouteContextStoreProvider.test.tsx b/packages/twenty-front/src/modules/context-store/components/__tests__/RouteContextStoreProvider.test.tsxindex 9792470d111..7d200a3ff5a 100644--- a/packages/twenty-front/src/modules/context-store/components/__tests__/RouteContextStoreProvider.test.tsx+++ b/packages/twenty-front/src/modules/context-store/components/__tests__/RouteContextStoreProvider.test.tsx@@ -1,26 +1,11 @@+import { WorkspaceRouteObjectsContext } from '@/app/routing/components/WorkspaceRouteObjectsProvider';+import { type WorkspaceRouteObject } from '@/app/routing/types/WorkspaceRouteObject';+import { getWorkspaceRouteObjectsForSurface } from '@/app/routing/utils/getWorkspaceRouteObjectsForSurface';import { RouteContextStoreProvider } from '@/context-store/components/RouteContextStoreProvider';import { render, screen } from '@testing-library/react';--let mockViewIdQueryParam = 'company-view';--jest.mock('react-router-dom', () => ({- ...jest.requireActual('react-router-dom'),- useLocation: () => ({- pathname: '/objects/companies',- search: `?viewId=${mockViewIdQueryParam}`,- hash: '',- state: null,- key: 'test',- }),- useParams: () => ({ objectNamePlural: 'companies' }),- useSearchParams: () => [- new URLSearchParams(`viewId=${mockViewIdQueryParam}`),- ],-}));--jest.mock('@/navigation/hooks/useIsSettingsPage', () => ({- useIsSettingsPage: () => false,-}));+import { type ReactNode } from 'react';+import { MemoryRouter, Outlet, useRoutes } from 'react-router-dom';+import { AppPath, SettingsPath } from 'twenty-shared/types';jest.mock('@/navigation/hooks/useLastVisitedView', () => ({useLastVisitedView: () => ({@@ -45,6 +30,16 @@ jest.mock('@/ui/utilities/state/jotai/hooks/useAtomStateValue', () => ({namePlural: 'companies',nameSingular: 'company',},+ {+ id: 'person-object',+ namePlural: 'people',+ nameSingular: 'person',+ },+ {+ id: 'new-object',+ namePlural: 'new',+ nameSingular: 'new',+ },]: [{@@ -71,33 +66,130 @@ jest.mock('@/ui/utilities/state/jotai/hooks/useAtomFamilyStateValue', () => ({}));jest.mock('@/context-store/components/RouteContextStoreProviderEffect', () => ({- RouteContextStoreProviderEffect: ({ viewId }: { viewId?: string }) => (- <div data-testid="context-view" data-view-id={viewId} />+ RouteContextStoreProviderEffect: ({+ viewId,+ objectMetadataItem,+ }: {+ viewId?: string;+ objectMetadataItem?: { id: string };+ }) => (+ <div+ data-testid="route-context-store"+ data-view-id={viewId}+ data-object-metadata-id={objectMetadataItem?.id}+ />),}));-describe('RouteContextStoreProvider view selection', () => {- beforeEach(() => {- mockViewIdQueryParam = 'company-view';- });+const MAIN_AND_SIDE_PANEL = ['main', 'side-panel'] as const;++const routeObjects: WorkspaceRouteObject[] = [+ {+ path: AppPath.RecordIndexPage,+ element: null,+ handle: { workspaceSurfaces: MAIN_AND_SIDE_PANEL },+ },+ {+ path: AppPath.RecordShowPage,+ element: null,+ handle: { workspaceSurfaces: MAIN_AND_SIDE_PANEL },+ },+ {+ path: `/${AppPath.Settings}`,+ element: <Outlet />,+ children: [+ { path: SettingsPath.NewObject, element: null },+ { path: SettingsPath.ObjectNewFieldSelect, element: null },+ ],+ },+];++const mainSurfaceRouteObjects = getWorkspaceRouteObjectsForSurface(+ routeObjects,+ 'main',+);++const sidePanelRouteObjects = getWorkspaceRouteObjectsForSurface(+ routeObjects,+ 'side-panel',+);++const MainSurfaceLayout = () => (+ <>+ <RouteContextStoreProvider />+ <Outlet />+ </>+);++const MainSurfaceRoutes = () =>+ useRoutes([+ { element: <MainSurfaceLayout />, children: mainSurfaceRouteObjects },+ ]);++const SidePanelHostLayout = () => (+ <>+ <Outlet />+ {useRoutes(sidePanelRouteObjects, '/object/person/record-1')}+ </>+);+const SidePanelHostRoutes = () =>+ useRoutes([+ { element: <SidePanelHostLayout />, children: mainSurfaceRouteObjects },+ ]);++const renderAt = (initialEntry: string, children: ReactNode) =>+ render(+ <WorkspaceRouteObjectsContext.Provider value={routeObjects}>+ <MemoryRouter initialEntries={[initialEntry]}>{children}</MemoryRouter>+ </WorkspaceRouteObjectsContext.Provider>,+ );++describe('RouteContextStoreProvider', () => {it('accepts a query-param view owned by the route object', () => {- render(<RouteContextStoreProvider />);+ renderAt('/objects/companies?viewId=company-view', <MainSurfaceRoutes />);- expect(screen.getByTestId('context-view')).toHaveAttribute(+ expect(screen.getByTestId('route-context-store')).toHaveAttribute('data-view-id','company-view',);});it('falls back when the query-param view belongs to another object', () => {- mockViewIdQueryParam = 'person-view';+ renderAt('/objects/companies?viewId=person-view', <MainSurfaceRoutes />);- render(<RouteContextStoreProvider />);-- expect(screen.getByTestId('context-view')).toHaveAttribute(+ expect(screen.getByTestId('route-context-store')).toHaveAttribute('data-view-id','company-index-view',);});++ it('resolves the object on settings object pages', () => {+ renderAt(+ '/settings/objects/companies/new-field/select',+ <MainSurfaceRoutes />,+ );++ expect(screen.getByTestId('route-context-store')).toHaveAttribute(+ 'data-object-metadata-id',+ 'company-object',+ );+ });++ it('does not read a static settings segment as an object name', () => {+ renderAt('/settings/objects/new', <MainSurfaceRoutes />);++ expect(screen.getByTestId('route-context-store')).not.toHaveAttribute(+ 'data-object-metadata-id',+ );+ });++ it('resolves the side panel object from the panel location rather than the main surface route params', () => {+ renderAt('/objects/companies', <SidePanelHostRoutes />);++ expect(screen.getByTestId('route-context-store')).toHaveAttribute(+ 'data-object-metadata-id',+ 'person-object',+ );+ });});diff --git a/packages/twenty-front/src/testing/decorators/PageDecorator.tsx b/packages/twenty-front/src/testing/decorators/PageDecorator.tsxindex a82e45cd9e5..c7e17a6ef88 100644--- a/packages/twenty-front/src/testing/decorators/PageDecorator.tsx+++ b/packages/twenty-front/src/testing/decorators/PageDecorator.tsx@@ -3,12 +3,9 @@ import { loadDevMessages } from '@apollo/client/dev';import { type Decorator } from '@storybook/react-vite';import { Provider as JotaiProvider } from 'jotai';import { HelmetProvider } from '@dr.pogodin/react-helmet';-import {- createMemoryRouter,- createRoutesFromElements,- Route,- RouterProvider,-} from 'react-router-dom';+import { createMemoryRouter, RouterProvider } from 'react-router-dom';+import { WorkspaceRouteObjectsProvider } from '@/app/routing/components/WorkspaceRouteObjectsProvider';+import { type WorkspaceRouteObject } from '@/app/routing/types/WorkspaceRouteObject';import { ClientConfigProviderEffect } from '@/client-config/components/ClientConfigProviderEffect';import { MinimalMetadataGate } from '@/metadata-store/components/MinimalMetadataGate';import { ApolloCoreClientMockedProvider } from '@/object-metadata/hooks/__mocks__/ApolloCoreClientMockedProvider';@@ -141,24 +138,30 @@ const createRouter = ({pathname: string;}[];initialIndex?: number;-}) =>- createMemoryRouter(- createRoutesFromElements(- <Route element={<Providers />}>- <Route element={<DefaultLayout />}>- <Route path={args.routePath} element={<Story />} />- {args.additionalRoutes?.map((route) => (- <Route- key={route}- path={route}- element={<div>Navigated to {route}</div>}- />- ))}- </Route>- </Route>,- ),+}) => {+ const routeObjects: WorkspaceRouteObject[] = [+ { path: args.routePath, element: <Story /> },+ ...(args.additionalRoutes ?? []).map((route) => ({+ path: route,+ element: <div>Navigated to {route}</div>,+ })),+ ];++ return createMemoryRouter(+ [+ {+ element: <WorkspaceRouteObjectsProvider routeObjects={routeObjects} />,+ children: [+ {+ element: <Providers />,+ children: [{ element: <DefaultLayout />, children: routeObjects }],+ },+ ],+ },+ ],{ initialEntries, initialIndex },);+};export const PageDecorator: Decorator<{routePath: string;