Merge pull request Expensify#90706 from truph01/feat/90295

[NO QA] feat: Add ExportDownload Onyx foundation and shared export action functions

Author: mollfpr

src/CONST/index.ts

@@ -455,6 +455,14 @@ const CONST = {
         MAX_LENGTH: 83,
     },
 
+    EXPORT_DOWNLOAD: {
+        STATE: {
+            PREPARING: 'preparing',
+            READY: 'ready',
+            FAILED: 'failed',
+        },
+    },
+
     EXPORT_LABELS: {
         NETSUITE: 'NetSuite',
         QBO: 'QuickBooks Online',

src/ONYXKEYS.ts

@@ -729,6 +729,7 @@ const ONYXKEYS = {
         ATTACHMENT: 'attachment_',
         DOMAIN: 'domain_',
         DOWNLOAD: 'download_',
+        EXPORT_DOWNLOAD: 'nvp_exportDownload_',
         POLICY: 'policy_',
         POLICY_DRAFTS: 'policyDrafts_',
         POLICY_JOIN_MEMBER: 'policyJoinMember_',
@@ -1301,6 +1302,7 @@ type OnyxCollectionValuesMapping = {
     [ONYXKEYS.COLLECTION.ATTACHMENT]: OnyxTypes.Attachment;
     [ONYXKEYS.COLLECTION.DOMAIN]: OnyxTypes.Domain;
     [ONYXKEYS.COLLECTION.DOWNLOAD]: OnyxTypes.Download;
+    [ONYXKEYS.COLLECTION.EXPORT_DOWNLOAD]: OnyxTypes.ExportDownload;
     [ONYXKEYS.COLLECTION.POLICY]: OnyxTypes.Policy;
     [ONYXKEYS.COLLECTION.POLICY_DRAFTS]: OnyxTypes.Policy;
     [ONYXKEYS.COLLECTION.POLICY_CATEGORIES]: OnyxTypes.PolicyCategories;

src/libs/API/parameters/ClearExportDownloadParams.ts

@@ -0,0 +1,5 @@
+type ClearExportDownloadParams = {
+    exportID: string;
+};
+
+export default ClearExportDownloadParams;

src/libs/API/parameters/SendExportFileFromConciergeParams.ts

@@ -0,0 +1,5 @@
+type SendExportFileFromConciergeParams = {
+    exportID: string;
+};
+
+export default SendExportFileFromConciergeParams;

src/libs/API/parameters/index.ts

@@ -545,3 +545,5 @@ export type {default as UpdateAgentNameParams} from './UpdateAgentNameParams';
 export type {default as UpdateAgentPromptParams} from './UpdateAgentPromptParams';
 export type {default as UpdateAgentAvatarParams} from './UpdateAgentAvatarParams';
 export type {default as DeleteAgentParams} from './DeleteAgentParams';
+export type {default as SendExportFileFromConciergeParams} from './SendExportFileFromConciergeParams';
+export type {default as ClearExportDownloadParams} from './ClearExportDownloadParams';

src/libs/API/types.ts

@@ -619,6 +619,8 @@ const WRITE_COMMANDS = {
     UPDATE_AGENT_PROMPT: 'UpdateAgentPrompt',
     UPDATE_AGENT_AVATAR: 'UpdateAgentAvatar',
     DELETE_AGENT: 'DeleteAgent',
+    SEND_EXPORT_FILE_FROM_CONCIERGE: 'SendExportFileFromConcierge',
+    CLEAR_EXPORT_DOWNLOAD: 'ClearExportDownload',
 } as const;
 
 type WriteCommand = ValueOf<typeof WRITE_COMMANDS>;
@@ -1260,6 +1262,8 @@ type WriteCommandParameters = {
     [WRITE_COMMANDS.UPDATE_AGENT_PROMPT]: Parameters.UpdateAgentPromptParams;
     [WRITE_COMMANDS.UPDATE_AGENT_AVATAR]: Parameters.UpdateAgentAvatarParams;
     [WRITE_COMMANDS.DELETE_AGENT]: Parameters.DeleteAgentParams;
+    [WRITE_COMMANDS.SEND_EXPORT_FILE_FROM_CONCIERGE]: Parameters.SendExportFileFromConciergeParams;
+    [WRITE_COMMANDS.CLEAR_EXPORT_DOWNLOAD]: Parameters.ClearExportDownloadParams;
 };
 
 const READ_COMMANDS = {

src/libs/Navigation/AppNavigator/AuthScreensInitHandler.tsx

@@ -20,6 +20,7 @@ import {endSpan, getSpan, startSpan} from '@libs/telemetry/activeSpans';
 import {getSearchParamFromUrl} from '@libs/Url';
 import * as App from '@userActions/App';
 import * as Download from '@userActions/Download';
+import {clearStaleExportDownloads} from '@userActions/Export';
 import * as Report from '@userActions/Report';
 import * as Session from '@userActions/Session';
 import * as User from '@userActions/User';
@@ -140,6 +141,7 @@ function AuthScreensInitHandler() {
         );
 
         Download.clearDownloads();
+        clearStaleExportDownloads();
 
         return () => {
             Session.cleanupSession();

src/libs/actions/Export.ts

@@ -0,0 +1,77 @@
+import type {OnyxEntry} from 'react-native-onyx';
+import Onyx from 'react-native-onyx';
+import {write} from '@libs/API';
+import {WRITE_COMMANDS} from '@libs/API/types';
+import CONST from '@src/CONST';
+import ONYXKEYS from '@src/ONYXKEYS';
+import type ExportDownload from '@src/types/onyx/ExportDownload';
+import type {AnyOnyxUpdate} from '@src/types/onyx/Request';
+
+function sendExportFileFromConcierge(exportID: string, exportDownload: OnyxEntry<ExportDownload>) {
+    const onyxKey = `${ONYXKEYS.COLLECTION.EXPORT_DOWNLOAD}${exportID}` as const;
+
+    const optimisticData: AnyOnyxUpdate[] = [
+        {
+            onyxMethod: Onyx.METHOD.MERGE,
+            key: onyxKey,
+            value: {shouldSendFromConcierge: true},
+        },
+    ];
+
+    const failureData: AnyOnyxUpdate[] = [
+        {
+            onyxMethod: Onyx.METHOD.MERGE,
+            key: onyxKey,
+            value: {shouldSendFromConcierge: exportDownload?.shouldSendFromConcierge ?? null},
+        },
+    ];
+
+    write(WRITE_COMMANDS.SEND_EXPORT_FILE_FROM_CONCIERGE, {exportID}, {optimisticData, failureData});
+}
+
+function clearExportDownload(exportID: string, exportDownload: OnyxEntry<ExportDownload>) {
+    const onyxKey = `${ONYXKEYS.COLLECTION.EXPORT_DOWNLOAD}${exportID}` as const;
+
+    const optimisticData: AnyOnyxUpdate[] = [
+        {
+            onyxMethod: Onyx.METHOD.SET,
+            key: onyxKey,
+            value: null,
+        },
+    ];
+
+    const failureData: AnyOnyxUpdate[] = [
+        {
+            onyxMethod: Onyx.METHOD.SET,
+            key: onyxKey,
+            value: exportDownload ?? null,
+        },
+    ];
+
+    write(WRITE_COMMANDS.CLEAR_EXPORT_DOWNLOAD, {exportID}, {optimisticData, failureData});
+}
+
+function clearStaleExportDownloads() {
+    // Uses connectWithoutView instead of useOnyx to avoid subscribing the caller component
+    // to the entire collection, which would cause unnecessary re-renders on every change.
+    const connectionID = Onyx.connectWithoutView({
+        key: ONYXKEYS.COLLECTION.EXPORT_DOWNLOAD,
+        waitForCollectionCallback: true,
+        callback: (exportDownloads) => {
+            Onyx.disconnect(connectionID);
+            if (!exportDownloads) {
+                return;
+            }
+            for (const key of Object.keys(exportDownloads)) {
+                const exportDownload = exportDownloads[key];
+                if (!exportDownload || exportDownload.state === CONST.EXPORT_DOWNLOAD.STATE.PREPARING) {
+                    continue;
+                }
+                const exportID = key.replace(ONYXKEYS.COLLECTION.EXPORT_DOWNLOAD, '');
+                clearExportDownload(exportID, exportDownload);
+            }
+        },
+    });
+}
+
+export {sendExportFileFromConcierge, clearExportDownload, clearStaleExportDownloads};

src/types/onyx/ExportDownload.ts

@@ -0,0 +1,22 @@
+import type {ValueOf} from 'type-fest';
+import type CONST from '@src/CONST';
+
+/** Possible states of an export download */
+type ExportDownloadState = ValueOf<typeof CONST.EXPORT_DOWNLOAD.STATE>;
+
+/** Model of an export download entry */
+type ExportDownload = {
+    /** Current state of the export download */
+    state: ExportDownloadState;
+
+    /** Number of reports included in the export (PDF exports only) */
+    reportCount?: number;
+
+    /** Number of reports that failed to export (PDF exports only) */
+    failedReportCount?: number;
+
+    /** Whether the export file should be sent from Concierge */
+    shouldSendFromConcierge?: boolean;
+};
+
+export default ExportDownload;

src/types/onyx/index.ts

@@ -70,6 +70,7 @@ import type ExpenseRule from './ExpenseRule';
 import type ExpensifyCardBankAccountMetadata from './ExpensifyCardBankAccountMetadata';
 import type ExpensifyCardSettings from './ExpensifyCardSettings';
 import type {ExpensifyCardSettingsBase, NestedExpensifyCardSettings} from './ExpensifyCardSettings';
+import type ExportDownload from './ExportDownload';
 import type ExportTemplate from './ExportTemplate';
 import type FrequentlyUsedEmoji from './FrequentlyUsedEmoji';
 import type {FundList} from './Fund';
@@ -221,6 +222,7 @@ export type {
     DismissedReferralBanners,
     Domain,
     Download,
+    ExportDownload,
     DuplicateWorkspace,
     CopyPolicySettings,
     WorkspaceCardsList,