0f2af6a6cb
## Recoil to Jotai Migration — PR 13: Workflow, Page Layout, AI, Activities, Settings, SSE & Remaining Modules ### Summary This is the 13th PR in the [14-PR migration series](packages/twenty-front/src/modules/ui/utilities/state/jotai/MIGRATION_PLAN.md) to replace Recoil with Jotai as the state management library in `twenty-front`. This PR migrates the remaining consumer code across all modules — updating ~1,076 files with ~10k insertions/deletions. ### What changed **New Jotai infrastructure (13 new files):** - `createComponentSelectorV2` and `createComponentFamilySelectorV2` — instance-scoped derived atoms, replacing Recoil's component selectors - 6 new hooks: `useRecoilComponentSelectorValueV2`, `useRecoilComponentFamilySelectorValueV2`, `useRecoilComponentSelectorCallbackStateV2`, `useRecoilComponentFamilySelectorCallbackStateV2`, `useRecoilComponentStateCallbackStateV2`, `useRecoilComponentFamilyStateCallbackStateV2` - New types: `ComponentSelectorV2`, `ComponentFamilySelectorV2`, `SelectorCallbacksV2` - Extended `buildGetHelper` to support the new selector patterns **State definition migrations:** - `createState()` → `createStateV2()` (Jotai `atom()`) - `createFamilyState()` → `createFamilyStateV2()` (Jotai `atom()` with family cache) - Recoil `selector`/`selectorFamily` → Jotai derived `atom()` via V2 utilities **Hook migrations (~2,400 removed, ~1,545 added V2 equivalents):** - `useRecoilValue` → `useRecoilValueV2` - `useRecoilState` → `useRecoilStateV2` - `useSetRecoilState` → `useSetRecoilStateV2` - `useRecoilCallback` → `useCallback` + `jotaiStore.get/set` - `useRecoilComponentValue` → `useRecoilComponentValueV2` - `useSetRecoilComponentState` → `useSetRecoilComponentStateV2` - `useRecoilComponentFamilyValue` → `useRecoilComponentFamilyValueV2` / `useFamilySelectorValueV2` - ~397 direct `import from 'recoil'` removed **Deleted files (9 files):** - `dateLocaleState.ts` — consolidated - `currentAIChatThreadTitleStateV2.ts` — renamed to replace the original - `isCommandMenuOpenedState.ts` — removed - `filesFieldUploadState.ts` — replaced by V2 - `recordStoreFamilySelector.ts`, `recordStoreFieldValueSelector.ts`, `recordStoreRecordsSelector.ts` — replaced by V2 equivalents - `settingsAllRolesSelector.ts` — replaced by `useSettingsAllRoles` hook - `settingsRoleIdsStateV2.ts` — consolidated **Modules migrated:** - Workflow (diagram, steps, variables, filters) - Page Layout (widgets, fields, graph, tabs) - AI (chat, agents, browsing context) - Activities (rich text editor, targets, timeline) - Action Menu (single/multiple record actions) - Command Menu (navigation, history, pages, workflow) - Context Store - Record Board, Record Table, Record Calendar, Record Index - Record Field, Record Filter, Record Sort, Record Group - Record Drag, Record Picker, Record Store - Views (view bar, view picker, filters, sorts) - Settings (roles, permissions, SSO, security, data model, developers, domains) - SSE (event streams, subscriptions) - Spreadsheet Import - Auth, Favorites, Front Components, Information Banner
176 lines
5.8 KiB
TypeScript
176 lines
5.8 KiB
TypeScript
import { Action } from '@/action-menu/actions/components/Action';
|
|
import { ActionScope } from '@/action-menu/actions/types/ActionScope';
|
|
import { ActionType } from '@/action-menu/actions/types/ActionType';
|
|
import { ActionMenuContext } from '@/action-menu/contexts/ActionMenuContext';
|
|
import { HeadlessFrontComponentAction } from '@/action-menu/actions/display/components/HeadlessFrontComponentAction';
|
|
import { useOpenFrontComponentInCommandMenu } from '@/command-menu/hooks/useOpenFrontComponentInCommandMenu';
|
|
import { contextStoreCurrentObjectMetadataItemIdComponentState } from '@/context-store/states/contextStoreCurrentObjectMetadataItemIdComponentState';
|
|
import { contextStoreIsPageInEditModeComponentState } from '@/context-store/states/contextStoreIsPageInEditModeComponentState';
|
|
import { contextStoreTargetedRecordsRuleComponentState } from '@/context-store/states/contextStoreTargetedRecordsRuleComponentState';
|
|
import { useMountHeadlessFrontComponent } from '@/front-components/hooks/useMountHeadlessFrontComponent';
|
|
import { useRecoilComponentValueV2 } from '@/ui/utilities/state/jotai/hooks/useRecoilComponentValueV2';
|
|
import { useIsFeatureEnabled } from '@/workspace/hooks/useIsFeatureEnabled';
|
|
import { useContext } from 'react';
|
|
import { isDefined } from 'twenty-shared/utils';
|
|
import { type IconComponent, useIcons } from 'twenty-ui/display';
|
|
|
|
import { COMMAND_MENU_DEFAULT_ICON } from '@/workflow/workflow-trigger/constants/CommandMenuDefaultIcon';
|
|
import {
|
|
type CommandMenuItemFieldsFragment,
|
|
CommandMenuItemAvailabilityType,
|
|
FeatureFlagKey,
|
|
useFindManyCommandMenuItemsQuery,
|
|
} from '~/generated-metadata/graphql';
|
|
|
|
type CommandMenuItemWithFrontComponent = CommandMenuItemFieldsFragment & {
|
|
frontComponentId: string;
|
|
};
|
|
|
|
type BuildActionFromItemParams = {
|
|
item: CommandMenuItemWithFrontComponent;
|
|
scope: ActionScope;
|
|
index: number;
|
|
isPinned: boolean;
|
|
getIcon: ReturnType<typeof useIcons>['getIcon'];
|
|
openFrontComponentInCommandMenu: (params: {
|
|
frontComponentId: string;
|
|
pageTitle: string;
|
|
pageIcon: IconComponent;
|
|
}) => void;
|
|
mountHeadlessFrontComponent: (frontComponentId: string) => void;
|
|
};
|
|
|
|
const buildActionFromItem = ({
|
|
item,
|
|
scope,
|
|
index,
|
|
isPinned,
|
|
getIcon,
|
|
openFrontComponentInCommandMenu,
|
|
mountHeadlessFrontComponent,
|
|
}: BuildActionFromItemParams) => {
|
|
const displayLabel = item.label;
|
|
|
|
const Icon = getIcon(item.icon, COMMAND_MENU_DEFAULT_ICON);
|
|
|
|
const isHeadless = item.frontComponent?.isHeadless === true;
|
|
|
|
const handleClick = () => {
|
|
if (isHeadless) {
|
|
mountHeadlessFrontComponent(item.frontComponentId);
|
|
} else {
|
|
openFrontComponentInCommandMenu({
|
|
frontComponentId: item.frontComponentId,
|
|
pageTitle: displayLabel,
|
|
pageIcon: Icon,
|
|
});
|
|
}
|
|
};
|
|
|
|
return {
|
|
type: ActionType.FrontComponent,
|
|
key: `command-menu-item-front-component-${item.id}`,
|
|
scope,
|
|
label: displayLabel,
|
|
shortLabel: displayLabel,
|
|
position: index,
|
|
isPinned,
|
|
Icon,
|
|
shouldBeRegistered: () => true,
|
|
component: isHeadless ? (
|
|
<HeadlessFrontComponentAction
|
|
frontComponentId={item.frontComponentId}
|
|
onClick={handleClick}
|
|
/>
|
|
) : (
|
|
<Action onClick={handleClick} />
|
|
),
|
|
};
|
|
};
|
|
|
|
export const useCommandMenuItemFrontComponentActions = () => {
|
|
const { getIcon } = useIcons();
|
|
const { openFrontComponentInCommandMenu } =
|
|
useOpenFrontComponentInCommandMenu();
|
|
const mountHeadlessFrontComponent = useMountHeadlessFrontComponent();
|
|
|
|
const isPageInEditMode = useRecoilComponentValueV2(
|
|
contextStoreIsPageInEditModeComponentState,
|
|
);
|
|
|
|
const { actionMenuType } = useContext(ActionMenuContext);
|
|
|
|
const currentObjectMetadataItemId = useRecoilComponentValueV2(
|
|
contextStoreCurrentObjectMetadataItemIdComponentState,
|
|
);
|
|
|
|
const targetedRecordsRule = useRecoilComponentValueV2(
|
|
contextStoreTargetedRecordsRuleComponentState,
|
|
);
|
|
|
|
const isCommandMenuItemEnabled = useIsFeatureEnabled(
|
|
FeatureFlagKey.IS_COMMAND_MENU_ITEM_ENABLED,
|
|
);
|
|
|
|
const { data } = useFindManyCommandMenuItemsQuery({
|
|
skip:
|
|
!isCommandMenuItemEnabled ||
|
|
(actionMenuType !== 'command-menu' &&
|
|
actionMenuType !== 'command-menu-show-page-action-menu-dropdown'),
|
|
});
|
|
|
|
const frontComponentItems =
|
|
data?.commandMenuItems?.filter(
|
|
(item): item is CommandMenuItemWithFrontComponent =>
|
|
isDefined(item.frontComponentId),
|
|
) ?? [];
|
|
|
|
const selectedRecordCount =
|
|
targetedRecordsRule.mode === 'selection'
|
|
? targetedRecordsRule.selectedRecordIds.length
|
|
: 0;
|
|
|
|
const objectMatches = (item: CommandMenuItemWithFrontComponent) =>
|
|
!isDefined(item.availabilityObjectMetadataId) ||
|
|
item.availabilityObjectMetadataId === currentObjectMetadataItemId;
|
|
|
|
const globalItems = frontComponentItems.filter(
|
|
(item) => item.availabilityType === CommandMenuItemAvailabilityType.GLOBAL,
|
|
);
|
|
|
|
const recordScopedItems = frontComponentItems.filter((item) => {
|
|
if (!objectMatches(item)) return false;
|
|
if (item.availabilityType === CommandMenuItemAvailabilityType.SINGLE_RECORD)
|
|
return selectedRecordCount === 1;
|
|
if (item.availabilityType === CommandMenuItemAvailabilityType.BULK_RECORDS)
|
|
return selectedRecordCount >= 1;
|
|
return false;
|
|
});
|
|
|
|
const globalActions = globalItems.map((item, index) =>
|
|
buildActionFromItem({
|
|
item,
|
|
scope: ActionScope.Global,
|
|
index,
|
|
isPinned: !isPageInEditMode && item.isPinned,
|
|
getIcon,
|
|
openFrontComponentInCommandMenu,
|
|
mountHeadlessFrontComponent,
|
|
}),
|
|
);
|
|
|
|
const recordScopedActions = recordScopedItems.map((item, index) =>
|
|
buildActionFromItem({
|
|
item,
|
|
scope: ActionScope.RecordSelection,
|
|
index,
|
|
isPinned: !isPageInEditMode && item.isPinned,
|
|
getIcon,
|
|
openFrontComponentInCommandMenu,
|
|
mountHeadlessFrontComponent,
|
|
}),
|
|
);
|
|
|
|
return [...globalActions, ...recordScopedActions];
|
|
};
|