Skip to content

The open alternative to Salesforce, designed for AI.

Enable async CSV export progress behind a workspace flag (#25968)

Weikobaf3e66e87dc
diff --git a/packages/twenty-front/codegen-metadata.cjs b/packages/twenty-front/codegen-metadata.cjs
index 88d41dc8537..85b0f35b938 100644
--- a/packages/twenty-front/codegen-metadata.cjs
+++ b/packages/twenty-front/codegen-metadata.cjs
@@ -41,6 +41,7 @@ module.exports = {
'./src/modules/dashboards/graphql/**/*.{ts,tsx}',
'./src/modules/page-layout/graphql/**/*.{ts,tsx}',
'./src/modules/marketplace/graphql/**/*.{ts,tsx}',
+ './src/modules/record-export/graphql/**/*.{ts,tsx}',
'./src/modules/metadata-store/graphql/**/*.{ts,tsx}',
'./src/modules/sse-db-event/graphql/**/*.{ts,tsx}',
'./src/modules/geo-map/graphql-query/*.{ts,tsx}',
diff --git a/packages/twenty-front/src/generated-metadata/graphql.ts b/packages/twenty-front/src/generated-metadata/graphql.ts
index e22740afcac..3d6b081593e 100644
--- a/packages/twenty-front/src/generated-metadata/graphql.ts
+++ b/packages/twenty-front/src/generated-metadata/graphql.ts
@@ -8959,6 +8959,13 @@ export type PieChartDataQueryVariables = Exact<{
export type PieChartDataQuery = { __typename?: 'Query', pieChartData: { __typename?: 'PieChartData', showLegend: boolean, showDataLabels: boolean, showCenterMetric: boolean, hasTooManyGroups: boolean, formattedToRawLookup: any, data: Array<{ __typename?: 'PieChartDataItem', key: string, value: number }> } };
+export type ExportRecordsSubscriptionVariables = Exact<{
+ input: CreateRecordExportInput;
+}>;
+
+
+export type ExportRecordsSubscription = { __typename?: 'Subscription', exportRecords: { __typename?: 'RecordExport', id: string, filename: string, status: RecordExportStatus, processedRecordCount: number, totalRecordCount?: number | null, errorMessage?: string | null, downloadUrl?: string | null } };
+
export type CreateEmailGroupChannelMutationVariables = Exact<{
input: CreateEmailGroupChannelInput;
}>;
@@ -10262,6 +10269,7 @@ export const CallRecordingIdForCalendarEventDocument = {"kind":"Document","defin
export const BarChartDataDocument = {"kind":"Document","definitions":[{"kind":"OperationDefinition","operation":"query","name":{"kind":"Name","value":"BarChartData"},"variableDefinitions":[{"kind":"VariableDefinition","variable":{"kind":"Variable","name":{"kind":"Name","value":"input"}},"type":{"kind":"NonNullType","type":{"kind":"NamedType","name":{"kind":"Name","value":"BarChartDataInput"}}}}],"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"barChartData"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"input"},"value":{"kind":"Variable","name":{"kind":"Name","value":"input"}}}],"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"data"}},{"kind":"Field","name":{"kind":"Name","value":"indexBy"}},{"kind":"Field","name":{"kind":"Name","value":"keys"}},{"kind":"Field","name":{"kind":"Name","value":"series"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"key"}},{"kind":"Field","name":{"kind":"Name","value":"label"}}]}},{"kind":"Field","name":{"kind":"Name","value":"xAxisLabel"}},{"kind":"Field","name":{"kind":"Name","value":"yAxisLabel"}},{"kind":"Field","name":{"kind":"Name","value":"showLegend"}},{"kind":"Field","name":{"kind":"Name","value":"showDataLabels"}},{"kind":"Field","name":{"kind":"Name","value":"layout"}},{"kind":"Field","name":{"kind":"Name","value":"groupMode"}},{"kind":"Field","name":{"kind":"Name","value":"hasTooManyGroups"}},{"kind":"Field","name":{"kind":"Name","value":"formattedToRawLookup"}}]}}]}}]} as unknown as DocumentNode<BarChartDataQuery, BarChartDataQueryVariables>;
export const LineChartDataDocument = {"kind":"Document","definitions":[{"kind":"OperationDefinition","operation":"query","name":{"kind":"Name","value":"LineChartData"},"variableDefinitions":[{"kind":"VariableDefinition","variable":{"kind":"Variable","name":{"kind":"Name","value":"input"}},"type":{"kind":"NonNullType","type":{"kind":"NamedType","name":{"kind":"Name","value":"LineChartDataInput"}}}}],"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"lineChartData"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"input"},"value":{"kind":"Variable","name":{"kind":"Name","value":"input"}}}],"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"series"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"key"}},{"kind":"Field","name":{"kind":"Name","value":"label"}},{"kind":"Field","name":{"kind":"Name","value":"data"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"x"}},{"kind":"Field","name":{"kind":"Name","value":"y"}}]}}]}},{"kind":"Field","name":{"kind":"Name","value":"xAxisLabel"}},{"kind":"Field","name":{"kind":"Name","value":"yAxisLabel"}},{"kind":"Field","name":{"kind":"Name","value":"showLegend"}},{"kind":"Field","name":{"kind":"Name","value":"showDataLabels"}},{"kind":"Field","name":{"kind":"Name","value":"hasTooManyGroups"}},{"kind":"Field","name":{"kind":"Name","value":"formattedToRawLookup"}}]}}]}}]} as unknown as DocumentNode<LineChartDataQuery, LineChartDataQueryVariables>;
export const PieChartDataDocument = {"kind":"Document","definitions":[{"kind":"OperationDefinition","operation":"query","name":{"kind":"Name","value":"PieChartData"},"variableDefinitions":[{"kind":"VariableDefinition","variable":{"kind":"Variable","name":{"kind":"Name","value":"input"}},"type":{"kind":"NonNullType","type":{"kind":"NamedType","name":{"kind":"Name","value":"PieChartDataInput"}}}}],"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"pieChartData"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"input"},"value":{"kind":"Variable","name":{"kind":"Name","value":"input"}}}],"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"data"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"key"}},{"kind":"Field","name":{"kind":"Name","value":"value"}}]}},{"kind":"Field","name":{"kind":"Name","value":"showLegend"}},{"kind":"Field","name":{"kind":"Name","value":"showDataLabels"}},{"kind":"Field","name":{"kind":"Name","value":"showCenterMetric"}},{"kind":"Field","name":{"kind":"Name","value":"hasTooManyGroups"}},{"kind":"Field","name":{"kind":"Name","value":"formattedToRawLookup"}}]}}]}}]} as unknown as DocumentNode<PieChartDataQuery, PieChartDataQueryVariables>;
+export const ExportRecordsDocument = {"kind":"Document","definitions":[{"kind":"OperationDefinition","operation":"subscription","name":{"kind":"Name","value":"ExportRecords"},"variableDefinitions":[{"kind":"VariableDefinition","variable":{"kind":"Variable","name":{"kind":"Name","value":"input"}},"type":{"kind":"NonNullType","type":{"kind":"NamedType","name":{"kind":"Name","value":"CreateRecordExportInput"}}}}],"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"exportRecords"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"input"},"value":{"kind":"Variable","name":{"kind":"Name","value":"input"}}}],"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"id"}},{"kind":"Field","name":{"kind":"Name","value":"filename"}},{"kind":"Field","name":{"kind":"Name","value":"status"}},{"kind":"Field","name":{"kind":"Name","value":"processedRecordCount"}},{"kind":"Field","name":{"kind":"Name","value":"totalRecordCount"}},{"kind":"Field","name":{"kind":"Name","value":"errorMessage"}},{"kind":"Field","name":{"kind":"Name","value":"downloadUrl"}}]}}]}}]} as unknown as DocumentNode<ExportRecordsSubscription, ExportRecordsSubscriptionVariables>;
export const CreateEmailGroupChannelDocument = {"kind":"Document","definitions":[{"kind":"OperationDefinition","operation":"mutation","name":{"kind":"Name","value":"CreateEmailGroupChannel"},"variableDefinitions":[{"kind":"VariableDefinition","variable":{"kind":"Variable","name":{"kind":"Name","value":"input"}},"type":{"kind":"NonNullType","type":{"kind":"NamedType","name":{"kind":"Name","value":"CreateEmailGroupChannelInput"}}}}],"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"createEmailGroupChannel"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"input"},"value":{"kind":"Variable","name":{"kind":"Name","value":"input"}}}],"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"messageChannel"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"id"}},{"kind":"Field","name":{"kind":"Name","value":"handle"}},{"kind":"Field","name":{"kind":"Name","value":"visibility"}},{"kind":"Field","name":{"kind":"Name","value":"type"}},{"kind":"Field","name":{"kind":"Name","value":"isSyncEnabled"}},{"kind":"Field","name":{"kind":"Name","value":"excludeGroupEmails"}},{"kind":"Field","name":{"kind":"Name","value":"contactAutoCreationPolicy"}}]}},{"kind":"Field","name":{"kind":"Name","value":"forwardingAddress"}}]}}]}}]} as unknown as DocumentNode<CreateEmailGroupChannelMutation, CreateEmailGroupChannelMutationVariables>;
export const DeleteConnectedAccountDocument = {"kind":"Document","definitions":[{"kind":"OperationDefinition","operation":"mutation","name":{"kind":"Name","value":"DeleteConnectedAccount"},"variableDefinitions":[{"kind":"VariableDefinition","variable":{"kind":"Variable","name":{"kind":"Name","value":"id"}},"type":{"kind":"NonNullType","type":{"kind":"NamedType","name":{"kind":"Name","value":"UUID"}}}}],"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"deleteConnectedAccount"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"id"},"value":{"kind":"Variable","name":{"kind":"Name","value":"id"}}}],"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"id"}}]}}]}}]} as unknown as DocumentNode<DeleteConnectedAccountMutation, DeleteConnectedAccountMutationVariables>;
export const DeleteEmailGroupChannelDocument = {"kind":"Document","definitions":[{"kind":"OperationDefinition","operation":"mutation","name":{"kind":"Name","value":"DeleteEmailGroupChannel"},"variableDefinitions":[{"kind":"VariableDefinition","variable":{"kind":"Variable","name":{"kind":"Name","value":"id"}},"type":{"kind":"NonNullType","type":{"kind":"NamedType","name":{"kind":"Name","value":"UUID"}}}}],"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"deleteEmailGroupChannel"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"id"},"value":{"kind":"Variable","name":{"kind":"Name","value":"id"}}}],"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"id"}}]}}]}}]} as unknown as DocumentNode<DeleteEmailGroupChannelMutation, DeleteEmailGroupChannelMutationVariables>;
diff --git a/packages/twenty-front/src/modules/command-menu-item/display/components/CommandListItemLoader.tsx b/packages/twenty-front/src/modules/command-menu-item/display/components/CommandListItemLoader.tsx
index 80b52b95f59..643dbb7cb8a 100644
--- a/packages/twenty-front/src/modules/command-menu-item/display/components/CommandListItemLoader.tsx
+++ b/packages/twenty-front/src/modules/command-menu-item/display/components/CommandListItemLoader.tsx
@@ -1,4 +1,5 @@
import { styled } from '@linaria/react';
+import { getCommandMenuItemProgressLabel } from '@/command-menu-item/utils/getCommandMenuItemProgressLabel';
import { Loader } from 'twenty-ui/primitives/feedback';
import { themeCssVariables } from 'twenty-ui/theme-constants';
@@ -17,7 +18,9 @@ const StyledProgressText = styled.span`
export const CommandListItemLoader = ({ progress }: { progress: number }) => {
return (
<StyledContainer>
- <StyledProgressText>{Math.round(progress)}%</StyledProgressText>
+ <StyledProgressText>
+ {getCommandMenuItemProgressLabel(progress)}
+ </StyledProgressText>
<Loader />
</StyledContainer>
);
diff --git a/packages/twenty-front/src/modules/command-menu-item/display/components/CommandMenuItemRenderer.tsx b/packages/twenty-front/src/modules/command-menu-item/display/components/CommandMenuItemRenderer.tsx
index cb99084e50d..81801852be6 100644
--- a/packages/twenty-front/src/modules/command-menu-item/display/components/CommandMenuItemRenderer.tsx
+++ b/packages/twenty-front/src/modules/command-menu-item/display/components/CommandMenuItemRenderer.tsx
@@ -1,3 +1,4 @@
+import { useIsFeatureEnabled } from '@/workspace/hooks/useIsFeatureEnabled';
import { type CommandMenuItemDefinition } from '@/command-menu-item/types/CommandMenuItemDefinition';
import { AppMenuItem } from '@/applications/components/AppMenuItem';
import { useIsThirdPartyApplication } from '@/applications/hooks/useIsThirdPartyApplication';
@@ -19,6 +20,7 @@ import { assertUnreachable, isDefined } from 'twenty-shared/utils';
import { useIcons } from 'twenty-ui/icon';
import { Loader } from 'twenty-ui/primitives/feedback';
import { MenuItem } from 'twenty-ui/primitives/navigation';
+import { FeatureFlagKey } from '~/generated-metadata/graphql';
const StyledPreviewWrapper = styled.div`
cursor: not-allowed;
@@ -41,6 +43,9 @@ const CommandMenuItemButtonRenderer = ({
isPrimaryAction = false,
shouldHideLabel = false,
}: CommandMenuItemButtonRendererProps) => {
+ const isAsyncCsvExportEnabled = useIsFeatureEnabled(
+ FeatureFlagKey.IS_ASYNC_CSV_EXPORT_ENABLED,
+ );
const { commandMenuContextApi, isInPreviewMode } =
useContext(CommandMenuContext);
const { getIcon } = useIcons();
@@ -52,11 +57,12 @@ const CommandMenuItemButtonRenderer = ({
const Icon = getIcon(iconKey, COMMAND_MENU_DEFAULT_ICON);
- const { handleClick, disabled } = useCommandMenuItemClick({
- item,
- Icon,
- label,
- });
+ const { handleClick, disabled, progress, showDisabledLoader } =
+ useCommandMenuItemClick({
+ item,
+ Icon,
+ label,
+ });
const command = {
key: item.id,
@@ -83,6 +89,8 @@ const CommandMenuItemButtonRenderer = ({
command={command}
onClick={disabled ? undefined : handleClick}
disabled={disabled}
+ progress={isAsyncCsvExportEnabled ? progress : undefined}
+ loading={isAsyncCsvExportEnabled && showDisabledLoader}
isPrimaryAction={isPrimaryAction}
shouldHideLabel={shouldHideLabel}
/>
@@ -95,6 +103,9 @@ const CommandMenuItemSelectableRenderer = ({
}: CommandMenuItemRendererProps & {
displayType: 'listItem' | 'dropdownItem';
}) => {
+ const isAsyncCsvExportEnabled = useIsFeatureEnabled(
+ FeatureFlagKey.IS_ASYNC_CSV_EXPORT_ENABLED,
+ );
const { commandMenuContextApi } = useContext(CommandMenuContext);
const { getIcon } = useIcons();
@@ -128,7 +139,7 @@ const CommandMenuItemSelectableRenderer = ({
};
const loaderComponent =
- disabled && showDisabledLoader ? (
+ isAsyncCsvExportEnabled && disabled && showDisabledLoader ? (
isDefined(progress) ? (
<CommandListItemLoader progress={progress} />
) : (
@@ -174,6 +185,7 @@ const CommandMenuItemSelectableRenderer = ({
LeftIcon={Icon}
onClick={onItemClick}
text={label}
+ RightComponent={loaderComponent}
disabled={disabled}
/>
</SelectableListItem>
diff --git a/packages/twenty-front/src/modules/command-menu-item/engine-command/record/components/ExportRecordsCommand.tsx b/packages/twenty-front/src/modules/command-menu-item/engine-command/record/components/ExportRecordsCommand.tsx
index 5fd590fd0ed..088fb23cf8e 100644
--- a/packages/twenty-front/src/modules/command-menu-item/engine-command/record/components/ExportRecordsCommand.tsx
+++ b/packages/twenty-front/src/modules/command-menu-item/engine-command/record/components/ExportRecordsCommand.tsx
@@ -1,3 +1,7 @@
+import { RecordExportConnectionEffect } from '@/record-export/components/RecordExportConnectionEffect';
+import { useRecordIndexAsyncExportRecords } from '@/object-record/record-index/export/hooks/useRecordIndexAsyncExportRecords';
+import { useIsFeatureEnabled } from '@/workspace/hooks/useIsFeatureEnabled';
+import { FeatureFlagKey } from '~/generated-metadata/graphql';
import { HeadlessEngineCommandWrapperEffect } from '@/command-menu-item/engine-command/components/HeadlessEngineCommandWrapperEffect';
import { useHeadlessCommandContextApi } from '@/command-menu-item/engine-command/hooks/useHeadlessCommandContextApi';
import { CommandComponentInstanceContext } from '@/command-menu-item/engine-command/states/contexts/CommandComponentInstanceContext';
@@ -43,6 +47,28 @@ const ExportIndexRecordsContent = ({
return <HeadlessEngineCommandWrapperEffect execute={download} />;
};
+const ExportAsyncIndexRecordsContent = ({
+ objectMetadataItem,
+ recordIndexId,
+ onProgress,
+}: {
+ objectMetadataItem: EnrichedObjectMetadataItem;
+ recordIndexId: string;
+ onProgress: (progress: number) => void;
+}) => {
+ const { download, cancel } = useRecordIndexAsyncExportRecords({
+ objectMetadataItem,
+ recordIndexId,
+ onProgress,
+ });
+ return (
+ <>
+ <RecordExportConnectionEffect cancel={cancel} />
+ <HeadlessEngineCommandWrapperEffect execute={download} />
+ </>
+ );
+};
+
const ExportShowRecordContent = ({
objectMetadataItem,
recordId,
@@ -61,6 +87,9 @@ const ExportShowRecordContent = ({
};
export const ExportRecordsCommand = () => {
+ const isAsyncCsvExportEnabled = useIsFeatureEnabled(
+ FeatureFlagKey.IS_ASYNC_CSV_EXPORT_ENABLED,
+ );
const { objectMetadataItem, recordIndexId, selectedRecords } =
useHeadlessCommandContextApi();
@@ -99,11 +128,19 @@ export const ExportRecordsCommand = () => {
<ViewComponentInstanceContext.Provider
value={{ instanceId: recordIndexId }}
>
- <ExportIndexRecordsContent
- objectMetadataItem={objectMetadataItem}
- recordIndexId={recordIndexId}
- setCommandMenuItemProgress={setCommandMenuItemProgress}
- />
+ {isAsyncCsvExportEnabled ? (
+ <ExportAsyncIndexRecordsContent
+ objectMetadataItem={objectMetadataItem}
+ recordIndexId={recordIndexId}
+ onProgress={setCommandMenuItemProgress}
+ />
+ ) : (
+ <ExportIndexRecordsContent
+ objectMetadataItem={objectMetadataItem}
+ recordIndexId={recordIndexId}
+ setCommandMenuItemProgress={setCommandMenuItemProgress}
+ />
+ )}
</ViewComponentInstanceContext.Provider>
);
};
diff --git a/packages/twenty-front/src/modules/command-menu-item/engine-command/record/components/__tests__/ExportRecordsCommand.test.tsx b/packages/twenty-front/src/modules/command-menu-item/engine-command/record/components/__tests__/ExportRecordsCommand.test.tsx
new file mode 100644
index 00000000000..2d266b5cce4
--- /dev/null
+++ b/packages/twenty-front/src/modules/command-menu-item/engine-command/record/components/__tests__/ExportRecordsCommand.test.tsx
@@ -0,0 +1,114 @@
+import { currentWorkspaceState } from '@/auth/states/currentWorkspaceState';
+import { ExportRecordsCommand } from '@/command-menu-item/engine-command/record/components/ExportRecordsCommand';
+import { CommandComponentInstanceContext } from '@/command-menu-item/engine-command/states/contexts/CommandComponentInstanceContext';
+import { render, waitFor } from '@testing-library/react';
+import { type ReactNode } from 'react';
+import { FeatureFlagKey } from '~/generated-metadata/graphql';
+import { getJestMetadataAndApolloMocksWrapper } from '~/testing/jest/getJestMetadataAndApolloMocksWrapper';
+import { mockCurrentWorkspace } from '~/testing/mock-data/users';
+import { getMockObjectMetadataItemOrThrow } from '~/testing/utils/getMockObjectMetadataItemOrThrow';
+
+const mockSynchronousDownload = jest.fn().mockResolvedValue(undefined);
+const mockAsyncDownload = jest.fn().mockResolvedValue(undefined);
+const mockCancelAsyncDownload = jest.fn();
+const mockSingleRecordDownload = jest.fn().mockResolvedValue(undefined);
+const mockObjectMetadataItem = getMockObjectMetadataItemOrThrow('person');
+let mockRecordIndexId: string | undefined;
+
+jest.mock(
+ '@/command-menu-item/engine-command/hooks/useHeadlessCommandContextApi',
+ () => ({
+ useHeadlessCommandContextApi: () => ({
+ objectMetadataItem: mockObjectMetadataItem,
+ recordIndexId: mockRecordIndexId,
+ selectedRecords: [{ id: 'selected-record' }],
+ }),
+ }),
+);
+jest.mock(
+ '@/object-record/record-index/export/hooks/useRecordIndexExportRecords',
+ () => ({
+ useRecordIndexExportRecords: () => ({
+ download: mockSynchronousDownload,
+ progress: {},
+ }),
+ }),
+);
+jest.mock(
+ '@/object-record/record-index/export/hooks/useRecordIndexAsyncExportRecords',
+ () => ({
+ useRecordIndexAsyncExportRecords: () => ({
+ download: mockAsyncDownload,
+ cancel: mockCancelAsyncDownload,
+ }),
+ }),
+);
+jest.mock('@/object-record/record-show/hooks/useExportSingleRecord', () => ({
+ useExportSingleRecord: () => ({ download: mockSingleRecordDownload }),
+}));
+
+const renderExport = (enabled?: boolean) => {
+ const Wrapper = getJestMetadataAndApolloMocksWrapper({
+ apolloMocks: [],
+ onInitializeJotaiStore: (store) => {
+ store.set(currentWorkspaceState.atom, {
+ ...mockCurrentWorkspace,
+ featureFlags:
+ enabled === undefined
+ ? []
+ : [
+ {
+ key: FeatureFlagKey.IS_ASYNC_CSV_EXPORT_ENABLED,
+ value: enabled,
+ },
+ ],
+ });
+ },
+ });
+ return render(<ExportRecordsCommand />, {
+ wrapper: ({ children }: { children: ReactNode }) => (
+ <Wrapper>
+ <CommandComponentInstanceContext.Provider
+ value={{ instanceId: 'export-command' }}
+ >
+ {children}
+ </CommandComponentInstanceContext.Provider>
+ </Wrapper>
+ ),
+ });
+};
+
+beforeEach(() => {
+ jest.useRealTimers();
+ jest.clearAllMocks();
+ mockRecordIndexId = 'record-index';
+});
+
+it.each([undefined, false, true])(
+ 'selects the export path when the workspace flag is %s',
+ async (enabled) => {
+ renderExport(enabled);
+ await waitFor(() =>
+ expect(
+ enabled ? mockAsyncDownload : mockSynchronousDownload,
+ ).toHaveBeenCalledTimes(1),
+ );
+ expect(
+ enabled ? mockSynchronousDownload : mockAsyncDownload,
+ ).not.toHaveBeenCalled();
+ expect(mockSingleRecordDownload).not.toHaveBeenCalled();
+ },
+);
+
+it.each([false, true])(
+ 'keeps single-record export when the workspace flag is %s',
+ async (enabled) => {
+ mockRecordIndexId = undefined;
+ renderExport(enabled);
+ await waitFor(() =>
+ expect(mockSingleRecordDownload).toHaveBeenCalledTimes(1),
+ );
+ expect(mockAsyncDownload).not.toHaveBeenCalled();
+ expect(mockSynchronousDownload).not.toHaveBeenCalled();
+ },
+);
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.ts
index ee252628e23..cab80a52936 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
@@ -1,3 +1,4 @@
+import { useIsFeatureEnabled } from '@/workspace/hooks/useIsFeatureEnabled';
import { type CommandMenuItemDefinition } from '@/command-menu-item/types/CommandMenuItemDefinition';
import { CommandMenuContext } from '@/command-menu-item/contexts/CommandMenuContext';
import { useMountCommand } from '@/command-menu-item/engine-command/hooks/useMountCommand';
@@ -10,9 +11,12 @@ import { useOpenFrontComponentInSidePanel } from '@/side-panel/hooks/useOpenFron
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 { useContext } from 'react';
+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';
import { isDefined } from 'twenty-shared/utils';
import { type IconComponent } from 'twenty-ui/icon';
+import { FeatureFlagKey } from '~/generated-metadata/graphql';
export const useCommandMenuItemClick = ({
item,
@@ -23,6 +27,9 @@ export const useCommandMenuItemClick = ({
Icon: IconComponent;
label: string;
}) => {
+ const isAsyncCsvExportEnabled = useIsFeatureEnabled(
+ FeatureFlagKey.IS_ASYNC_CSV_EXPORT_ENABLED,
+ );
const { commandMenuContextApi } = useContext(CommandMenuContext);
const mountCommand = useMountCommand();
const { openFrontComponentInSidePanel } = useOpenFrontComponentInSidePanel();
@@ -71,7 +78,15 @@ export const useCommandMenuItemClick = ({
return;
}
- closeCommandMenu();
+ const engineComponent = isDefined(item.engineComponentKey)
+ ? ENGINE_COMPONENT_KEY_COMPONENT_MAP[item.engineComponentKey]
+ : undefined;
+ const isExport =
+ isValidElement(engineComponent) &&
+ engineComponent.type === ExportRecordsCommand;
+ if (!isExport || !isAsyncCsvExportEnabled) {
+ closeCommandMenu();
+ }
await mountCommand({
engineCommandId: item.id,
diff --git a/packages/twenty-front/src/modules/command-menu-item/utils/__tests__/getCommandMenuItemProgressLabel.test.ts b/packages/twenty-front/src/modules/command-menu-item/utils/__tests__/getCommandMenuItemProgressLabel.test.ts
new file mode 100644
index 00000000000..6b780320d80
--- /dev/null
+++ b/packages/twenty-front/src/modules/command-menu-item/utils/__tests__/getCommandMenuItemProgressLabel.test.ts
@@ -0,0 +1,13 @@
+import { getCommandMenuItemProgressLabel } from '@/command-menu-item/utils/getCommandMenuItemProgressLabel';
+
+describe('getCommandMenuItemProgressLabel', () => {
+ it.each([
+ { progress: undefined, expected: 'Preparing…' },
+ { progress: 0, expected: 'Preparing…' },
+ { progress: 0.6, expected: '1%' },
+ { progress: 42.4, expected: '42%' },
+ { progress: 100, expected: '100%' },
+ ])('formats $progress as $expected', ({ progress, expected }) => {
+ expect(getCommandMenuItemProgressLabel(progress)).toBe(expected);
+ });
+});
diff --git a/packages/twenty-front/src/modules/command-menu-item/utils/getCommandMenuItemProgressLabel.ts b/packages/twenty-front/src/modules/command-menu-item/utils/getCommandMenuItemProgressLabel.ts
new file mode 100644
index 00000000000..e68f2d9eea7
--- /dev/null
+++ b/packages/twenty-front/src/modules/command-menu-item/utils/getCommandMenuItemProgressLabel.ts
@@ -0,0 +1,7 @@
+import { t } from '@lingui/core/macro';
+import { isDefined } from 'twenty-shared/utils';
+
+export const getCommandMenuItemProgressLabel = (progress?: number): string =>
+ isDefined(progress) && progress > 0
+ ? `${Math.round(progress)}%`
+ : t`Preparing…`;
diff --git a/packages/twenty-front/src/modules/command-menu/components/CommandMenuButton.tsx b/packages/twenty-front/src/modules/command-menu/components/CommandMenuButton.tsx
index 298037da3e3..f714517686b 100644
--- a/packages/twenty-front/src/modules/command-menu/components/CommandMenuButton.tsx
+++ b/packages/twenty-front/src/modules/command-menu/components/CommandMenuButton.tsx
@@ -1,3 +1,4 @@
+import { getCommandMenuButtonLabel } from '@/command-menu/utils/getCommandMenuButtonLabel';
import { NavigationButton } from '@/ui/input/components/NavigationButton';
import { TooltipDelay } from '@/ui/layout/tooltip/constants/TooltipDelay';
@@ -21,6 +22,8 @@ export type CommandMenuButtonProps = {
onClick?: (event?: MouseEvent<HTMLElement>) => void;
to?: string;
disabled?: boolean;
+ progress?: number;
+ loading?: boolean;
isPrimaryAction?: boolean;
shouldHideLabel?: boolean;
};
@@ -30,6 +33,8 @@ export const CommandMenuButton = ({
onClick,
to,
disabled = false,
+ progress,
+ loading = false,
isPrimaryAction = false,
shouldHideLabel = false,
}: CommandMenuButtonProps) => {
@@ -39,10 +44,12 @@ export const CommandMenuButton = ({
? `${command.label} (${hotKeys.join(' → ')})`
: command.label;
- const resolvedShortLabel =
- isDefined(command.shortLabel) && !shouldHideLabel
- ? command.shortLabel
- : undefined;
+ const resolvedShortLabel = getCommandMenuButtonLabel({
+ shortLabel: command.shortLabel,
+ isLoading: loading,
+ progress,
+ shouldHideLabel,
+ });
const buttonAccent =
isPrimaryAction || command.isPrimaryCTA === true ? 'blue' : 'default';
@@ -63,6 +70,7 @@ export const CommandMenuButton = ({
to={to}
onClick={onClick}
disabled={disabled}
+ loading={loading && !isDefined(progress)}
aria-label={command.label}
variant={buttonAccent === 'blue' ? 'solid' : 'outline'}
color={buttonAccent === 'blue' ? 'accent' : 'neutral'}
diff --git a/packages/twenty-front/src/modules/command-menu/components/__tests__/CommandMenuButton.test.tsx b/packages/twenty-front/src/modules/command-menu/components/__tests__/CommandMenuButton.test.tsx
index e28bd5383a6..ac63797cd85 100644
--- a/packages/twenty-front/src/modules/command-menu/components/__tests__/CommandMenuButton.test.tsx
+++ b/packages/twenty-front/src/modules/command-menu/components/__tests__/CommandMenuButton.test.tsx
@@ -2,7 +2,7 @@ import { CommandMenuButton } from '@/command-menu/components/CommandMenuButton';
import { render, screen } from '@testing-library/react';
import userEvent from '@testing-library/user-event';
import { MemoryRouter } from 'react-router-dom';
-import { IconSearch } from 'twenty-ui/icon';
+import { IconDownload, IconSearch } from 'twenty-ui/icon';
describe('CommandMenuButton', () => {
it.each([
@@ -53,3 +53,41 @@ describe('CommandMenuButton', () => {
},
);
});
+
+it('shows a disabled percentage button during export and restores the action afterward', async () => {
+ const onClick = jest.fn();
+ const command = {
+ key: 'export',
+ label: 'Export',
+ shortLabel: 'Export',
+ Icon: IconDownload,
+ };
+ const { rerender } = render(
+ <CommandMenuButton
+ command={command}
+ onClick={onClick}
+ disabled
+ loading
+ progress={0}
+ />,
+ );
+ const button = screen.getByRole('button', { name: 'Export' });
+ expect(button).toBeDisabled();
+ expect(button).toHaveTextContent('Preparing…');
+ rerender(
+ <CommandMenuButton
+ command={command}
+ onClick={onClick}
+ disabled
+ loading
+ progress={42}
+ />,
+ );
+ expect(button).toHaveTextContent('42%');
+ await userEvent.click(button);
+ expect(onClick).not.toHaveBeenCalled();
+ rerender(<CommandMenuButton command={command} onClick={onClick} />);
+ expect(screen.getByRole('button', { name: 'Export' })).toBeEnabled();
+ await userEvent.click(screen.getByRole('button', { name: 'Export' }));
+ expect(onClick).toHaveBeenCalledTimes(1);
+});
diff --git a/packages/twenty-front/src/modules/command-menu/utils/__tests__/getCommandMenuButtonLabel.test.ts b/packages/twenty-front/src/modules/command-menu/utils/__tests__/getCommandMenuButtonLabel.test.ts
new file mode 100644
index 00000000000..b20630428b9
--- /dev/null
+++ b/packages/twenty-front/src/modules/command-menu/utils/__tests__/getCommandMenuButtonLabel.test.ts
@@ -0,0 +1,47 @@
+import { getCommandMenuButtonLabel } from '@/command-menu/utils/getCommandMenuButtonLabel';
+
+describe('getCommandMenuButtonLabel', () => {
+ it.each([
+ { progress: undefined, expected: 'Preparing…' },
+ { progress: 0, expected: 'Preparing…' },
+ { progress: 42.6, expected: '43%' },
+ { progress: 100, expected: '100%' },
+ ])(
+ 'shows $expected while loading even when the label is hidden',
+ ({ progress, expected }) => {
+ expect(
+ getCommandMenuButtonLabel({
+ shortLabel: 'Export',
+ isLoading: true,
+ progress,
+ shouldHideLabel: true,
+ }),
+ ).toBe(expected);
+ },
+ );
+
+ it('hides the idle label even if progress remains', () => {
+ expect(
+ getCommandMenuButtonLabel({
+ shortLabel: 'Export',
+ isLoading: false,
+ progress: 100,
+ shouldHideLabel: true,
+ }),
+ ).toBeUndefined();
+ });
+
+ it.each(['Export', '', null, undefined])(
+ 'restores the idle label %s',
+ (shortLabel) => {
+ expect(
+ getCommandMenuButtonLabel({
+ shortLabel,
+ isLoading: false,
+ progress: 100,
+ shouldHideLabel: false,
+ }),
+ ).toBe(shortLabel ?? undefined);
+ },
+ );
+});
diff --git a/packages/twenty-front/src/modules/command-menu/utils/getCommandMenuButtonLabel.ts b/packages/twenty-front/src/modules/command-menu/utils/getCommandMenuButtonLabel.ts
new file mode 100644
index 00000000000..97d6b4b75ed
--- /dev/null
+++ b/packages/twenty-front/src/modules/command-menu/utils/getCommandMenuButtonLabel.ts
@@ -0,0 +1,24 @@
+import { getCommandMenuItemProgressLabel } from '@/command-menu-item/utils/getCommandMenuItemProgressLabel';
+import { type Nullable } from 'twenty-shared/types';
+
+export const getCommandMenuButtonLabel = ({
+ shortLabel,
+ isLoading,
+ progress,
+ shouldHideLabel,
+}: {
+ shortLabel?: Nullable<string>;
+ isLoading: boolean;
+ progress?: number;
+ shouldHideLabel: boolean;
+}): string | undefined => {
+ if (isLoading) {
+ return getCommandMenuItemProgressLabel(progress);
+ }
+
+ if (shouldHideLabel) {
+ return undefined;
+ }
+
+ return shortLabel ?? undefined;
+};
diff --git a/packages/twenty-front/src/modules/object-record/record-index/export/hooks/__tests__/useRecordIndexExportParameters.test.ts b/packages/twenty-front/src/modules/object-record/record-index/export/hooks/__tests__/useRecordIndexExportParameters.test.ts
new file mode 100644
index 00000000000..95245772977
--- /dev/null
+++ b/packages/twenty-front/src/modules/object-record/record-index/export/hooks/__tests__/useRecordIndexExportParameters.test.ts
@@ -0,0 +1,114 @@
+import { type ContextStoreTargetedRecordsRule } from '@/context-store/states/contextStoreTargetedRecordsRuleComponentState';
+import { currentRecordFieldsComponentState } from '@/object-record/record-field/states/currentRecordFieldsComponentState';
+import { useRecordIndexExportParameters } from '@/object-record/record-index/export/hooks/useRecordIndexExportParameters';
+import { renderHook } from '@testing-library/react';
+import { getJestMetadataAndApolloMocksAndCommandMenuWrapper } from '~/testing/jest/getJestMetadataAndApolloMocksAndCommandMenuWrapper';
+import { getMockObjectMetadataItemOrThrow } from '~/testing/utils/getMockObjectMetadataItemOrThrow';
+
+jest.mock(
+ '@/object-record/record-index/hooks/useFindManyRecordIndexTableParams',
+ () => ({
+ useFindManyRecordIndexTableParams: () => ({
+ filter: { city: { eq: 'Paris' } },
+ orderBy: [{ city: 'AscNullsFirst' }],
+ }),
+ }),
+);
+
+jest.mock(
+ '@/object-record/object-options-dropdown/hooks/useObjectOptionsForBoard',
+ () => ({
+ useObjectOptionsForBoard: () => ({ hiddenBoardFields: [] }),
+ }),
+);
+
+describe('useRecordIndexExportParameters', () => {
+ const objectMetadataItem = getMockObjectMetadataItemOrThrow('person');
+ const name = objectMetadataItem.fields.find(
+ (field) => field.name === 'name',
+ )!;
+ const city = objectMetadataItem.fields.find(
+ (field) => field.name === 'city',
+ )!;
+ const email = objectMetadataItem.fields.find(
+ (field) => field.name === 'emails',
+ )!;
+
+ const exportParameters = (selection: ContextStoreTargetedRecordsRule) => {
+ const wrapper = getJestMetadataAndApolloMocksAndCommandMenuWrapper({
+ apolloMocks: [],
+ componentInstanceId: 'recordIndexId',
+ contextStoreTargetedRecordsRule: selection,
+ contextStoreCurrentObjectMetadataNameSingular: 'person',
+ onInitializeJotaiStore: (store) => {
+ store.set(
+ currentRecordFieldsComponentState.atomFamily({
+ instanceId: 'recordIndexId',
+ }),
+ [
+ {
+ id: 'name-column',
+ fieldMetadataItemId: name.id,
+ position: 1,
+ isVisible: true,
+ size: 100,
+ },
+ {
+ id: 'city-column',
+ fieldMetadataItemId: city.id,
+ position: 0,
+ isVisible: true,
+ size: 100,
+ },
+ {
+ id: 'email-column',
+ fieldMetadataItemId: email.id,
+ position: 2,
+ isVisible: false,
+ size: 100,
+ },
+ ],
+ );
+ },
+ });
+ return renderHook(
+ () =>
+ useRecordIndexExportParameters({
+ objectMetadataItem,
+ recordIndexId: 'recordIndexId',
+ }),
+ { wrapper },
+ ).result;
+ };
+
+ it('captures the current view filter, sort and visible column order', () => {
+ const result = exportParameters({
+ mode: 'selection',
+ selectedRecordIds: [],
+ });
+ expect(result.current).toEqual({
+ objectMetadataId: objectMetadataItem.id,
+ filter: { city: { eq: 'Paris' } },
+ orderBy: [{ city: 'AscNullsFirst' }],
+ fieldMetadataIds: [city.id, name.id],
+ });
+ });
+
+ it('exports only explicitly selected records', () => {
+ const result = exportParameters({
+ mode: 'selection',
+ selectedRecordIds: ['first', 'second'],
+ });
+ expect(result.current.filter).toEqual({ id: { in: ['first', 'second'] } });
+ });
+
+ it('preserves exclusions when all records are selected', () => {
+ const result = exportParameters({
+ mode: 'exclusion',
+ excludedRecordIds: ['excluded'],
+ });
+ expect(result.current.filter).toEqual({
+ and: expect.arrayContaining([{ not: { id: { in: ['excluded'] } } }]),
+ });
+ });
+});
diff --git a/packages/twenty-front/src/modules/object-record/record-index/export/hooks/useRecordIndexAsyncExportRecords.ts b/packages/twenty-front/src/modules/object-record/record-index/export/hooks/useRecordIndexAsyncExportRecords.ts
new file mode 100644
index 00000000000..61d2934e620
--- /dev/null
+++ b/packages/twenty-front/src/modules/object-record/record-index/export/hooks/useRecordIndexAsyncExportRecords.ts
@@ -0,0 +1,28 @@
+import { type EnrichedObjectMetadataItem } from '@/object-metadata/types/EnrichedObjectMetadataItem';
+import { useRecordIndexExportParameters } from '@/object-record/record-index/export/hooks/useRecordIndexExportParameters';
+import { createRecordExportConnection } from '@/record-export/utils/createRecordExportConnection';
+import { useState } from 'react';
+import { type ViewType } from '@/views/types/ViewType';
+
+export const useRecordIndexAsyncExportRecords = ({
+ objectMetadataItem,
+ recordIndexId,
+ viewType,
+ onProgress,
+}: {
+ objectMetadataItem: EnrichedObjectMetadataItem;
+ recordIndexId: string;
+ viewType?: ViewType;
+ onProgress?: (progress: number) => void;
+}) => {
+ const parameters = useRecordIndexExportParameters({
+ objectMetadataItem,
+ recordIndexId,
+ viewType,
+ });
+ const [connection] = useState(createRecordExportConnection);
+ return {
+ download: () => connection.exportRecords({ input: parameters, onProgress }),
+ cancel: connection.cancel,
+ };
+};
diff --git a/packages/twenty-front/src/modules/object-record/record-index/export/hooks/useRecordIndexExportParameters.ts b/packages/twenty-front/src/modules/object-record/record-index/export/hooks/useRecordIndexExportParameters.ts
new file mode 100644
index 00000000000..53a10caf634
--- /dev/null
+++ b/packages/twenty-front/src/modules/object-record/record-index/export/hooks/useRecordIndexExportParameters.ts
@@ -0,0 +1,141 @@
+import { type FieldMetadata } from '@/object-record/record-field/ui/types/FieldMetadata';
+import { type ColumnDefinition } from '@/object-record/record-table/types/ColumnDefinition';
+
+import { contextStoreAnyFieldFilterValueComponentState } from '@/context-store/states/contextStoreAnyFieldFilterValueComponentState';
+import { contextStoreFilterGroupsComponentState } from '@/context-store/states/contextStoreFilterGroupsComponentState';
+import { contextStoreFiltersComponentState } from '@/context-store/states/contextStoreFiltersComponentState';
+import { contextStoreTargetedRecordsRuleComponentState } from '@/context-store/states/contextStoreTargetedRecordsRuleComponentState';
+import { computeContextStoreFilters } from '@/context-store/utils/computeContextStoreFilters';
+import { flattenedFieldMetadataItemsSelector } from '@/object-metadata/states/flattenedFieldMetadataItemsSelector';
+import { type EnrichedObjectMetadataItem } from '@/object-metadata/types/EnrichedObjectMetadataItem';
+import { useObjectOptionsForBoard } from '@/object-record/object-options-dropdown/hooks/useObjectOptionsForBoard';
+import { visibleRecordFieldsComponentSelector } from '@/object-record/record-field/states/visibleRecordFieldsComponentSelector';
+import { type RecordField } from '@/object-record/record-field/types/RecordField';
+import { useFilterValueDependencies } from '@/object-record/record-filter/hooks/useFilterValueDependencies';
+import { useFindManyRecordIndexTableParams } from '@/object-record/record-index/hooks/useFindManyRecordIndexTableParams';
+import { recordIndexGroupFieldMetadataItemComponentState } from '@/object-record/record-index/states/recordIndexGroupFieldMetadataComponentState';
+import { useAtomComponentSelectorValue } from '@/ui/utilities/state/jotai/hooks/useAtomComponentSelectorValue';
+import { useAtomComponentStateValue } from '@/ui/utilities/state/jotai/hooks/useAtomComponentStateValue';
+import { useAtomStateValue } from '@/ui/utilities/state/jotai/hooks/useAtomStateValue';
+import { ViewType } from '@/views/types/ViewType';
+import { isDefined } from 'twenty-shared/utils';
+
+export const useRecordIndexExportParameters = ({
+ objectMetadataItem,
+ recordIndexId,
+ viewType = ViewType.TABLE,
+}: {
+ objectMetadataItem: EnrichedObjectMetadataItem;
+ recordIndexId: string;
+ viewType?: ViewType;
+}) => {
+ const { hiddenBoardFields } = useObjectOptionsForBoard({
+ objectNameSingular: objectMetadataItem.nameSingular,
+ recordBoardId: recordIndexId,
+ viewBarId: recordIndexId,
+ });
+
+ const recordIndexGroupFieldMetadataItem = useAtomComponentStateValue(
+ recordIndexGroupFieldMetadataItemComponentState,
+ recordIndexId,
+ );
+
+ const hiddenKanbanFieldColumn = hiddenBoardFields.find(
+ (column) =>
+ column.metadata.fieldName === recordIndexGroupFieldMetadataItem?.name,
+ );
+
+ const contextStoreTargetedRecordsRule = useAtomComponentStateValue(
+ contextStoreTargetedRecordsRuleComponentState,
+ );
+
+ const contextStoreFilters = useAtomComponentStateValue(
+ contextStoreFiltersComponentState,
+ );
+
+ const contextStoreFilterGroups = useAtomComponentStateValue(
+ contextStoreFilterGroupsComponentState,
+ );
+
+ const contextStoreAnyFieldFilterValue = useAtomComponentStateValue(
+ contextStoreAnyFieldFilterValueComponentState,
+ );
+
+ const { filterValueDependencies } = useFilterValueDependencies();
+
+ const flattenedFieldMetadataItems = useAtomStateValue(
+ flattenedFieldMetadataItemsSelector,
+ );
+
+ const findManyRecordsParams = useFindManyRecordIndexTableParams(
+ objectMetadataItem.nameSingular,
+ recordIndexId,
+ );
+
+ const isEmptySelection =
+ contextStoreTargetedRecordsRule.mode === 'selection' &&
+ contextStoreTargetedRecordsRule.selectedRecordIds.length === 0;
+
+ const contextStoreFilter = computeContextStoreFilters({
+ contextStoreTargetedRecordsRule,
+ contextStoreFilters,
+ contextStoreFilterGroups,
+ objectMetadataItem,
+ fieldMetadataItems: flattenedFieldMetadataItems,
+ filterValueDependencies,
+ contextStoreAnyFieldFilterValue,
+ });
+
+ const queryFilter = isEmptySelection
+ ? findManyRecordsParams.filter
+ : contextStoreFilter;
+
+ const visibleRecordFields = useAtomComponentSelectorValue(
+ visibleRecordFieldsComponentSelector,
+ recordIndexId,
+ );
+
+ const finalColumns: Pick<
+ ColumnDefinition<FieldMetadata>,
+ 'label' | 'type' | 'metadata'
+ >[] = [
+ ...visibleRecordFields
+ .map((field: RecordField) => {
+ const fieldMetadataItem = objectMetadataItem.fields.find(
+ (fieldMetadataItem) =>
+ fieldMetadataItem.id === field.fieldMetadataItemId,
+ );
+
+ if (!isDefined(fieldMetadataItem)) {
+ return null;
+ }
+
+ return {
+ label: fieldMetadataItem.label,
+ type: fieldMetadataItem.type,
+ metadata: {
+ fieldName: fieldMetadataItem.name,
+ relationType: fieldMetadataItem.relation?.type,
+ },
+ };
+ })
+ .filter(isDefined),
+ ...(hiddenKanbanFieldColumn && viewType === ViewType.KANBAN
+ ? [hiddenKanbanFieldColumn]
+ : []),
+ ];
+
+ return {
+ objectMetadataId: objectMetadataItem.id,
+ filter: queryFilter,
+ orderBy: findManyRecordsParams.orderBy,
+ fieldMetadataIds: finalColumns
+ .map(
+ (column) =>
+ objectMetadataItem.fields.find(
+ (field) => field.name === column.metadata.fieldName,
+ )?.id,
+ )
+ .filter(isDefined),
+ };
+};
diff --git a/packages/twenty-front/src/modules/record-export/components/RecordExportConnectionEffect.tsx b/packages/twenty-front/src/modules/record-export/components/RecordExportConnectionEffect.tsx
new file mode 100644
index 00000000000..1d65b063739
--- /dev/null
+++ b/packages/twenty-front/src/modules/record-export/components/RecordExportConnectionEffect.tsx
@@ -0,0 +1,19 @@
+import { useEffect } from 'react';
+
+type RecordExportConnectionEffectProps = {
+ cancel: () => void;
+};
+
+export const RecordExportConnectionEffect = ({
+ cancel,
+}: RecordExportConnectionEffectProps) => {
+ useEffect(() => {
+ window.addEventListener('pagehide', cancel);
+ return () => {
+ window.removeEventListener('pagehide', cancel);
+ cancel();
+ };
+ }, [cancel]);
+
+ return null;
+};
diff --git a/packages/twenty-front/src/modules/record-export/components/__stories__/RecordExportConnectionEffect.stories.tsx b/packages/twenty-front/src/modules/record-export/components/__stories__/RecordExportConnectionEffect.stories.tsx
new file mode 100644
index 00000000000..6b8632cde64
--- /dev/null
+++ b/packages/twenty-front/src/modules/record-export/components/__stories__/RecordExportConnectionEffect.stories.tsx
@@ -0,0 +1,171 @@
+import { CommandMenuButton } from '@/command-menu/components/CommandMenuButton';
+import { RecordExportConnectionEffect } from '@/record-export/components/RecordExportConnectionEffect';
+import { createRecordExportConnection } from '@/record-export/utils/createRecordExportConnection';
+import { type Meta, type StoryObj } from '@storybook/react-vite';
+import { http, HttpResponse } from 'msw';
+import { useState } from 'react';
+import { expect, spyOn, userEvent, waitFor, within } from 'storybook/test';
+import { IconFileExport } from 'twenty-ui/icon';
+import { REACT_APP_SERVER_BASE_URL } from '~/config';
+import { RecordExportStatus } from '~/generated-metadata/graphql';
+
+const ExportExample = () => {
+ const [connection] = useState(createRecordExportConnection);
+ const [isConnected, setIsConnected] = useState(true);
+ const [isExporting, setIsExporting] = useState(false);
+ const [progress, setProgress] = useState(0);
+ const [error, setError] = useState<string>();
+ const download = async () => {
+ setIsExporting(true);
+ setError(undefined);
+ try {
+ await connection.exportRecords({
+ input: { objectMetadataId: 'person', fieldMetadataIds: ['name'] },
+ onProgress: setProgress,
+ });
+ } catch (error) {
+ setError(error instanceof Error ? error.message : String(error));
+ } finally {
+ setIsExporting(false);
+ }
+ };
+ return (
+ <>
+ {isConnected && (
+ <RecordExportConnectionEffect cancel={connection.cancel} />
+ )}
+ <CommandMenuButton
+ command={{
+ key: 'export',
+ label: 'Export',
+ shortLabel: 'Export',
+ Icon: IconFileExport,
+ }}
+ onClick={download}
+ disabled={isExporting}
+ loading={isExporting}
+ progress={progress}
+ />
+ <button onClick={() => setIsConnected(false)}>Unmount connection</button>
+ {error && <p role="alert">{error}</p>}
+ </>
+ );
+};
+
+const exportHandler = (finish: 'completed' | 'interrupted' | 'wait') =>
+ http.post(`${REACT_APP_SERVER_BASE_URL}/metadata`, () => {
+ const encoder = new TextEncoder();
+ const event = (status: RecordExportStatus) =>
+ encoder.encode(
+ `event: next\ndata: ${JSON.stringify({
+ data: {
+ exportRecords: {
+ id: 'export',
+ filename: 'person.csv',
+ status,
+ processedRecordCount: 42,
+ totalRecordCount: 100,
+ downloadUrl:
+ status === RecordExportStatus.COMPLETED
+ ? '/record-exports/export/download?token=token'
+ : null,
+ },
+ },
+ })}\n\n`,
+ );
+ const body = new ReadableStream({
+ async start(controller) {
+ controller.enqueue(event(RecordExportStatus.PROCESSING));
+ if (finish === 'wait') {
+ return;
+ }
+ await new Promise((resolve) => setTimeout(resolve, 1000));
+ if (finish === 'completed') {
+ controller.enqueue(event(RecordExportStatus.COMPLETED));
+ }
+ controller.enqueue(encoder.encode('event: complete\ndata: null\n\n'));
+ controller.close();
+ },
+ });
+ return new HttpResponse(body, {
+ headers: { 'Content-Type': 'text/event-stream' },
+ });
+ });
+
+const meta: Meta<typeof ExportExample> = {
+ title: 'Modules/RecordExport/Connection',
+ component: ExportExample,
+};
+export default meta;
+type Story = StoryObj<typeof ExportExample>;
+
+export const AutomaticDownload: Story = {
+ parameters: { msw: { handlers: [exportHandler('completed')] } },
+ play: async ({ canvasElement }) => {
+ const canvas = within(canvasElement);
+ const download = spyOn(
+ HTMLAnchorElement.prototype,
+ 'click',
+ ).mockImplementation(() => {});
+ try {
+ await userEvent.click(canvas.getByRole('button', { name: 'Export' }));
+ await canvas.findByText('42%');
+ expect(canvas.getByRole('button', { name: 'Export' })).toBeDisabled();
+ expect(download).not.toHaveBeenCalled();
+ await waitFor(() => expect(download).toHaveBeenCalledTimes(1), {
+ timeout: 5000,
+ });
+ expect(download.mock.instances[0]).toHaveAttribute(
+ 'href',
+ '/record-exports/export/download?token=token',
+ );
+ await waitFor(() =>
+ expect(canvas.getByRole('button', { name: 'Export' })).toBeEnabled(),
+ );
+ } finally {
+ download.mockRestore();
+ }
+ },
+};
+
+export const Interrupted: Story = {
+ parameters: { msw: { handlers: [exportHandler('interrupted')] } },
+ play: async ({ canvasElement }) => {
+ const canvas = within(canvasElement);
+ await userEvent.click(canvas.getByRole('button', { name: 'Export' }));
+ expect(
+ await canvas.findByRole('alert', {}, { timeout: 5000 }),
+ ).toHaveTextContent('export was interrupted');
+ expect(canvas.getByRole('button', { name: 'Export' })).toBeEnabled();
+ },
+};
+
+export const Unmount: Story = {
+ parameters: { msw: { handlers: [exportHandler('wait')] } },
+ play: async ({ canvasElement }) => {
+ const canvas = within(canvasElement);
+ await userEvent.click(canvas.getByRole('button', { name: 'Export' }));
+ await canvas.findByText('42%');
+ await userEvent.click(
+ canvas.getByRole('button', { name: 'Unmount connection' }),
+ );
+ await waitFor(() =>
+ expect(canvas.getByRole('button', { name: 'Export' })).toBeEnabled(),
+ );
+ expect(canvas.queryByRole('alert')).not.toBeInTheDocument();
+ },
+};
+
+export const PageHide: Story = {
+ parameters: { msw: { handlers: [exportHandler('wait')] } },
+ play: async ({ canvasElement }) => {
+ const canvas = within(canvasElement);
+ await userEvent.click(canvas.getByRole('button', { name: 'Export' }));
+ await canvas.findByText('42%');
+ window.dispatchEvent(new Event('pagehide'));
+ await waitFor(() =>
+ expect(canvas.getByRole('button', { name: 'Export' })).toBeEnabled(),
+ );
+ expect(canvas.queryByRole('alert')).not.toBeInTheDocument();
+ },
+};
diff --git a/packages/twenty-front/src/modules/record-export/graphql/exportRecords.ts b/packages/twenty-front/src/modules/record-export/graphql/exportRecords.ts
new file mode 100644
index 00000000000..2119abae02e
--- /dev/null
+++ b/packages/twenty-front/src/modules/record-export/graphql/exportRecords.ts
@@ -0,0 +1,15 @@
+import { gql } from '@apollo/client';
+
+export const EXPORT_RECORDS = gql`
+ subscription ExportRecords($input: CreateRecordExportInput!) {
+ exportRecords(input: $input) {
+ id
+ filename
+ status
+ processedRecordCount
+ totalRecordCount
+ errorMessage
+ downloadUrl
+ }
+ }
+`;
diff --git a/packages/twenty-front/src/modules/record-export/utils/__tests__/getRecordExportUpdateOrThrow.test.ts b/packages/twenty-front/src/modules/record-export/utils/__tests__/getRecordExportUpdateOrThrow.test.ts
new file mode 100644
index 00000000000..33df08f3042
--- /dev/null
+++ b/packages/twenty-front/src/modules/record-export/utils/__tests__/getRecordExportUpdateOrThrow.test.ts
@@ -0,0 +1,52 @@
+import { getRecordExportUpdateOrThrow } from '@/record-export/utils/getRecordExportUpdateOrThrow';
+import { RecordExportStatus } from '~/generated-metadata/graphql';
+
+const recordExport = {
+ id: 'export',
+ filename: 'person.csv',
+ status: RecordExportStatus.PROCESSING,
+ processedRecordCount: 42,
+ totalRecordCount: 100,
+};
+
+describe('getRecordExportUpdateOrThrow', () => {
+ it.each([
+ { totalRecordCount: null, processedRecordCount: 0, progress: 0 },
+ { totalRecordCount: 0, processedRecordCount: 0, progress: 0 },
+ { totalRecordCount: 100, processedRecordCount: 42, progress: 42 },
+ { totalRecordCount: 100, processedRecordCount: 100, progress: 99 },
+ { totalRecordCount: 100, processedRecordCount: 110, progress: 99 },
+ ])(
+ 'reports $progress percent before the file is ready',
+ ({ progress, ...counts }) => {
+ expect(
+ getRecordExportUpdateOrThrow({ ...recordExport, ...counts }),
+ ).toEqual({
+ progress,
+ });
+ },
+ );
+
+ it('downloads only a completed export with a URL', () => {
+ const completed = { ...recordExport, status: RecordExportStatus.COMPLETED };
+ expect(() => getRecordExportUpdateOrThrow(completed)).toThrow(
+ 'could not be downloaded',
+ );
+ expect(
+ getRecordExportUpdateOrThrow({ ...completed, downloadUrl: '/download' }),
+ ).toEqual({
+ progress: 100,
+ download: { url: '/download', filename: 'person.csv' },
+ });
+ });
+
+ it('surfaces the server failure', () => {
+ expect(() =>
+ getRecordExportUpdateOrThrow({
+ ...recordExport,
+ status: RecordExportStatus.FAILED,
+ errorMessage: 'Permission revoked',
+ }),
+ ).toThrow('Permission revoked');
+ });
+});
diff --git a/packages/twenty-front/src/modules/record-export/utils/createRecordExportConnection.ts b/packages/twenty-front/src/modules/record-export/utils/createRecordExportConnection.ts
new file mode 100644
index 00000000000..17c24ce20f5
--- /dev/null
+++ b/packages/twenty-front/src/modules/record-export/utils/createRecordExportConnection.ts
@@ -0,0 +1,90 @@
+import { getRecordExportUpdateOrThrow } from '@/record-export/utils/getRecordExportUpdateOrThrow';
+import { t } from '@lingui/core/macro';
+import { print } from 'graphql';
+import { createClient } from 'graphql-sse';
+import { isDefined } from 'twenty-shared/utils';
+import { REACT_APP_SERVER_BASE_URL } from '~/config';
+import {
+ ExportRecordsDocument,
+ type CreateRecordExportInput,
+ type ExportRecordsSubscription,
+} from '~/generated-metadata/graphql';
+
+export const createRecordExportConnection = () => {
+ let cancel: (() => void) | undefined;
+
+ const exportRecords = ({
+ input,
+ onProgress,
+ }: {
+ input: CreateRecordExportInput;
+ onProgress?: (progress: number) => void;
+ }): Promise<void> => {
+ cancel?.();
+ onProgress?.(0);
+ const client = createClient({
+ url: `${REACT_APP_SERVER_BASE_URL}/metadata`,
+ credentials: 'include',
+ retryAttempts: 0,
+ });
+
+ return new Promise<void>((resolve, reject) => {
+ let isSettled = false;
+ const finish = (error?: Error) => {
+ if (isSettled) {
+ return;
+ }
+ isSettled = true;
+ client.dispose();
+ cancel = undefined;
+ if (isDefined(error)) {
+ reject(error);
+ } else {
+ resolve();
+ }
+ };
+ cancel = () => finish();
+ client.subscribe<ExportRecordsSubscription>(
+ { query: print(ExportRecordsDocument), variables: { input } },
+ {
+ next: ({ data, errors }) => {
+ if (isSettled) {
+ return;
+ }
+ if (isDefined(errors) && errors.length > 0) {
+ finish(new Error(errors[0].message));
+ return;
+ }
+ const recordExport = data?.exportRecords;
+ if (!isDefined(recordExport)) {
+ return;
+ }
+ try {
+ const update = getRecordExportUpdateOrThrow(recordExport);
+ onProgress?.(update.progress);
+ if (isDefined(update.download)) {
+ const link = document.createElement('a');
+ link.href = update.download.url;
+ link.download = update.download.filename;
+ document.body.appendChild(link);
+ link.click();
+ link.remove();
+ finish();
+ }
+ } catch (error) {
+ finish(error instanceof Error ? error : new Error(String(error)));
+ }
+ },
+ error: () =>
+ finish(
+ new Error(t`The export connection was lost. Please try again.`),
+ ),
+ complete: () =>
+ finish(new Error(t`The export was interrupted. Please try again.`)),
+ },
+ );
+ });
+ };
+
+ return { exportRecords, cancel: () => cancel?.() };
+};
diff --git a/packages/twenty-front/src/modules/record-export/utils/getRecordExportUpdateOrThrow.ts b/packages/twenty-front/src/modules/record-export/utils/getRecordExportUpdateOrThrow.ts
new file mode 100644
index 00000000000..1797b11bb4b
--- /dev/null
+++ b/packages/twenty-front/src/modules/record-export/utils/getRecordExportUpdateOrThrow.ts
@@ -0,0 +1,38 @@
+import { t } from '@lingui/core/macro';
+import { isDefined } from 'twenty-shared/utils';
+import {
+ RecordExportStatus,
+ type ExportRecordsSubscription,
+} from '~/generated-metadata/graphql';
+
+export const getRecordExportUpdateOrThrow = (
+ recordExport: ExportRecordsSubscription['exportRecords'],
+): { progress: number; download?: { url: string; filename: string } } => {
+ if (recordExport.status === RecordExportStatus.FAILED) {
+ throw new Error(
+ recordExport.errorMessage ?? t`The export failed. Please try again.`,
+ );
+ }
+ if (recordExport.status === RecordExportStatus.COMPLETED) {
+ if (!isDefined(recordExport.downloadUrl)) {
+ throw new Error(t`The export could not be downloaded. Please try again.`);
+ }
+ return {
+ progress: 100,
+ download: {
+ url: recordExport.downloadUrl,
+ filename: recordExport.filename,
+ },
+ };
+ }
+ const total = recordExport.totalRecordCount;
+ return {
+ progress:
+ isDefined(total) && total > 0
+ ? Math.min(
+ 99,
+ Math.round((recordExport.processedRecordCount / total) * 100),
+ )
+ : 0,
+ };
+};
diff --git a/packages/twenty-front/src/modules/settings/admin-panel/constants/SettingsAdminFeatureFlagMetadata.ts b/packages/twenty-front/src/modules/settings/admin-panel/constants/SettingsAdminFeatureFlagMetadata.ts
index da415b9f597..5d6540815e6 100644
--- a/packages/twenty-front/src/modules/settings/admin-panel/constants/SettingsAdminFeatureFlagMetadata.ts
+++ b/packages/twenty-front/src/modules/settings/admin-panel/constants/SettingsAdminFeatureFlagMetadata.ts
@@ -10,6 +10,10 @@ export const SETTINGS_ADMIN_FEATURE_FLAG_METADATA: Partial<
{ label: MessageDescriptor; description: MessageDescriptor }
>
> = {
+ [FeatureFlagKey.IS_ASYNC_CSV_EXPORT_ENABLED]: {
+ label: msg`Async CSV export`,
+ description: msg`Generate CSV exports in the background with progress and automatic downloads.`,
+ },
[FeatureFlagKey.IS_APP_CLAIMING_ENABLED]: {
label: msg`App claiming`,
description: msg`Allow developers to claim ownership of applications.`,