Merge pull request Expensify#87963 from software-mansion-labs/korytko/perf/refactor-orchestrator-telemetry

[Performance] Refactor: Extract SubmitExpenseOrchestrator + centralize telemetry

Author: grgia

src/CONST/index.ts

@@ -2022,6 +2022,7 @@ const CONST = {
         ATTRIBUTE_IS_FROM_GLOBAL_CREATE: 'is_from_global_create',
         /** Sentry span attribute: follow-up action taken after submit (e.g. dismiss_modal_and_open_report, navigate_to_search). */
         ATTRIBUTE_SUBMIT_FOLLOW_UP_ACTION: 'submit_follow_up_action',
+        ATTRIBUTE_FAST_PATH_HANDLER: 'fast_path_handler',
         ATTRIBUTE_COMMAND: 'command',
         ATTRIBUTE_JSON_CODE: 'json_code',
         ATTRIBUTE_COLD_START: 'cold_start',
@@ -2035,6 +2036,19 @@ const CONST = {
             NAVIGATE_TO_SEARCH: 'navigate_to_search',
             DISMISS_MODAL_ONLY: 'dismiss_modal_only',
         },
+        FAST_PATH_HANDLER: {
+            SEARCH_PRE_INSERT: 'search_pre_insert',
+            REPORT_PRE_INSERT: 'report_pre_insert',
+            DISMISS_MODAL: 'dismiss_modal',
+            REPORT_IN_RHP_DISMISS: 'report_in_rhp_dismiss',
+            SEARCH_DISMISS: 'search_dismiss',
+            DEFAULT: 'default',
+        },
+        SUBMIT_OPTIMIZATION: {
+            PRE_INSERT: 'pre_insert',
+            DISMISS_FIRST: 'dismiss_first',
+            DEFERRED_WRITE: 'deferred_write',
+        },
         /** Trigger for useSubmitToDestinationVisible: end span on focus vs on layout. */
         SUBMIT_TO_DESTINATION_VISIBLE_TRIGGER: {
             FOCUS: 'focus',

src/hooks/useEndSubmitNavigationSpans.ts

@@ -0,0 +1,59 @@
+import {useCallback, useRef} from 'react';
+import {endSubmitFollowUpActionSpan, getPendingSubmitFollowUpAction} from '@libs/telemetry/submitFollowUpAction';
+import CONST from '@src/CONST';
+
+type Options = {
+    requireLayout?: boolean;
+};
+
+/**
+ * Shared callback for ending submit-expense navigation spans on Search pages.
+ *
+ * - `requireLayout: true` (narrow): dual-gate requiring both focus + layout signals
+ *   before ending, except for DISMISS_MODAL_ONLY where focus alone suffices (the page
+ *   is already mounted and laid out so onLayout won't re-fire).
+ * - `requireLayout: false` (wide): ends immediately on any signal (pre-insert is
+ *   narrow-only so the dual-gate isn't needed).
+ */
+function useEndSubmitNavigationSpans({requireLayout = true}: Options = {}): (wasListEmpty: boolean, source: 'focus' | 'layout') => void {
+    const hadFocusRef = useRef(false);
+    const hadLayoutRef = useRef(false);
+
+    return useCallback(
+        (wasListEmpty: boolean, source: 'focus' | 'layout') => {
+            if (requireLayout) {
+                if (source === 'focus') {
+                    hadFocusRef.current = true;
+                } else {
+                    hadLayoutRef.current = true;
+                }
+
+                const pendingForGate = getPendingSubmitFollowUpAction();
+                const isDismissOnly = pendingForGate?.followUpAction === CONST.TELEMETRY.SUBMIT_FOLLOW_UP_ACTION.DISMISS_MODAL_ONLY;
+                const hasBothSignals = hadFocusRef.current && hadLayoutRef.current;
+                const hasFocusOnly = hadFocusRef.current && isDismissOnly;
+
+                if (!hasBothSignals && !hasFocusOnly) {
+                    return;
+                }
+
+                hadFocusRef.current = false;
+                hadLayoutRef.current = false;
+            }
+
+            // Re-read after the gate check - the value is synchronous module state so it
+            // can't change between the two reads in the same tick, but reading once here
+            // keeps the logic self-contained for the actual end-span decision.
+            const pending = getPendingSubmitFollowUpAction();
+            if (pending && pending.followUpAction !== CONST.TELEMETRY.SUBMIT_FOLLOW_UP_ACTION.DISMISS_MODAL_AND_OPEN_REPORT) {
+                endSubmitFollowUpActionSpan(pending.followUpAction, undefined, {
+                    [CONST.TELEMETRY.ATTRIBUTE_IS_WARM]: true,
+                    [CONST.TELEMETRY.ATTRIBUTE_WAS_LIST_EMPTY]: wasListEmpty,
+                });
+            }
+        },
+        [requireLayout],
+    );
+}
+
+export default useEndSubmitNavigationSpans;

src/libs/Navigation/Navigation.ts

@@ -1050,6 +1050,10 @@ function getIsFullscreenPreInsertedUnderRHP() {
     return isFullscreenPreInsertedUnderRHP;
 }
 
+function getPreInsertedFullscreenRouteName() {
+    return preInsertedFullscreenRouteName;
+}
+
 function clearFullscreenPreInsertedFlag() {
     isFullscreenPreInsertedUnderRHP = false;
     preInsertedFullscreenRouteName = undefined;
@@ -1166,6 +1170,7 @@ export default {
     revealRouteBeforeDismissingModal,
     preInsertFullscreenUnderRHP,
     getIsFullscreenPreInsertedUnderRHP,
+    getPreInsertedFullscreenRouteName,
     clearFullscreenPreInsertedFlag,
     removePreInsertedFullscreenIfNeeded,
     getTopmostSearchReportID,

src/libs/Navigation/helpers/dismissModalAndOpenReportInInboxTab.ts

@@ -1,8 +1,7 @@
 import {InteractionManager} from 'react-native';
 import getIsNarrowLayout from '@libs/getIsNarrowLayout';
 import Navigation, {navigationRef} from '@libs/Navigation/Navigation';
-import {getSpan} from '@libs/telemetry/activeSpans';
-import {endSubmitFollowUpActionSpan, setPendingSubmitFollowUpAction} from '@libs/telemetry/submitFollowUpAction';
+import {endSubmitFollowUpActionSpan, isTracking as isSubmitTracking, setPendingSubmitFollowUpAction} from '@libs/telemetry/submitFollowUpAction';
 import CONST from '@src/CONST';
 import ROUTES from '@src/ROUTES';
 import isReportOpenInRHP from './isReportOpenInRHP';
@@ -16,15 +15,15 @@ import setNavigationActionToMicrotaskQueue from './setNavigationActionToMicrotas
  */
 function dismissModalAndOpenReportInInboxTab(reportID: string | undefined, isInvoice: boolean | undefined, hasMultipleTransactions: boolean) {
     const rootState = navigationRef.getRootState();
-    const hasSubmitToDestinationVisibleSpan = !!getSpan(CONST.TELEMETRY.SPAN_SUBMIT_TO_DESTINATION_VISIBLE);
+    const hasActiveTracking = isSubmitTracking();
 
     if (!isInvoice && isReportOpenInRHP(rootState)) {
         const rhpKey = rootState.routes.at(-1)?.state?.key;
         if (rhpKey) {
             const isSuperWideRHP = isReportOpenInSuperWideRHP(rootState);
 
-            // submit_follow_up_action: only set when the span was started.
-            if (hasSubmitToDestinationVisibleSpan) {
+            // submit_follow_up_action: only set when tracking is active.
+            if (hasActiveTracking) {
                 if (isSuperWideRHP) {
                     setPendingSubmitFollowUpAction(CONST.TELEMETRY.SUBMIT_FOLLOW_UP_ACTION.DISMISS_MODAL_ONLY, reportID);
                 } else if (hasMultipleTransactions && reportID) {
@@ -58,19 +57,19 @@ function dismissModalAndOpenReportInInboxTab(reportID: string | undefined, isInv
         }
     }
     if (isSearchTopmostFullScreenRoute() || !reportID) {
-        if (hasSubmitToDestinationVisibleSpan) {
+        if (hasActiveTracking) {
             setPendingSubmitFollowUpAction(CONST.TELEMETRY.SUBMIT_FOLLOW_UP_ACTION.DISMISS_MODAL_ONLY);
         }
         Navigation.dismissModal();
-        if (hasSubmitToDestinationVisibleSpan) {
+        if (hasActiveTracking) {
             // eslint-disable-next-line @typescript-eslint/no-deprecated -- we need to wait for the modal to be dismissed before marking the span
             InteractionManager.runAfterInteractions(() => {
                 endSubmitFollowUpActionSpan(CONST.TELEMETRY.SUBMIT_FOLLOW_UP_ACTION.DISMISS_MODAL_ONLY);
             });
         }
         return;
     }
-    if (hasSubmitToDestinationVisibleSpan) {
+    if (hasActiveTracking) {
         Navigation.dismissModalWithReport({reportID}, undefined, {
             onBeforeNavigate: (willOpenReport) => {
                 setPendingSubmitFollowUpAction(

src/libs/actions/IOU/SendMoney.ts

@@ -19,7 +19,7 @@ import {
     getParsedComment,
 } from '@libs/ReportUtils';
 import playSound, {SOUNDS} from '@libs/Sound';
-import {startSpan} from '@libs/telemetry/activeSpans';
+import {startTracking} from '@libs/telemetry/submitFollowUpAction';
 import {buildOptimisticTransaction} from '@libs/TransactionUtils';
 import {notifyNewAction} from '@userActions/Report';
 import CONST from '@src/CONST';
@@ -510,17 +510,16 @@ function sendMoneyElsewhere({report, quickAction, amount, currency, comment, cur
         optimisticChatReportID,
         currentUserAccountID,
     });
-    startSpan(CONST.TELEMETRY.SPAN_SUBMIT_TO_DESTINATION_VISIBLE, {
-        name: 'submit-to-destination-visible',
-        op: CONST.TELEMETRY.SPAN_SUBMIT_TO_DESTINATION_VISIBLE,
-        attributes: {
-            [CONST.TELEMETRY.ATTRIBUTE_SCENARIO]: CONST.TELEMETRY.SUBMIT_EXPENSE_SCENARIO.SEND_MONEY,
-            [CONST.TELEMETRY.ATTRIBUTE_HAS_RECEIPT]: !!receipt,
-            [CONST.TELEMETRY.ATTRIBUTE_IS_FROM_GLOBAL_CREATE]: isEmptyObject(report) || !report?.reportID,
-            [CONST.TELEMETRY.ATTRIBUTE_IOU_TYPE]: CONST.IOU.TYPE.PAY,
-            [CONST.TELEMETRY.ATTRIBUTE_IOU_REQUEST_TYPE]: 'pay',
+    startTracking(
+        {
+            scenario: CONST.TELEMETRY.SUBMIT_EXPENSE_SCENARIO.SEND_MONEY,
+            iouType: CONST.IOU.TYPE.PAY,
+            requestType: 'pay',
+            isFromGlobalCreate: isEmptyObject(report) || !report?.reportID,
+            hasReceipt: !!receipt,
         },
-    });
+        {skipSubmitExpenseSpan: true},
+    );
     playSound(SOUNDS.DONE);
     API.write(WRITE_COMMANDS.SEND_MONEY_ELSEWHERE, params, {optimisticData, successData, failureData});
 
@@ -543,17 +542,16 @@ function sendMoneyWithWallet({report, quickAction, amount, currency, comment, cu
         optimisticChatReportID,
         currentUserAccountID,
     });
-    startSpan(CONST.TELEMETRY.SPAN_SUBMIT_TO_DESTINATION_VISIBLE, {
-        name: 'submit-to-destination-visible',
-        op: CONST.TELEMETRY.SPAN_SUBMIT_TO_DESTINATION_VISIBLE,
-        attributes: {
-            [CONST.TELEMETRY.ATTRIBUTE_SCENARIO]: CONST.TELEMETRY.SUBMIT_EXPENSE_SCENARIO.SEND_MONEY,
-            [CONST.TELEMETRY.ATTRIBUTE_HAS_RECEIPT]: !!receipt,
-            [CONST.TELEMETRY.ATTRIBUTE_IS_FROM_GLOBAL_CREATE]: isEmptyObject(report) || !report?.reportID,
-            [CONST.TELEMETRY.ATTRIBUTE_IOU_TYPE]: CONST.IOU.TYPE.PAY,
-            [CONST.TELEMETRY.ATTRIBUTE_IOU_REQUEST_TYPE]: 'pay',
+    startTracking(
+        {
+            scenario: CONST.TELEMETRY.SUBMIT_EXPENSE_SCENARIO.SEND_MONEY,
+            iouType: CONST.IOU.TYPE.PAY,
+            requestType: 'pay',
+            isFromGlobalCreate: isEmptyObject(report) || !report?.reportID,
+            hasReceipt: !!receipt,
         },
-    });
+        {skipSubmitExpenseSpan: true},
+    );
     playSound(SOUNDS.DONE);
     API.write(WRITE_COMMANDS.SEND_MONEY_WITH_WALLET, params, {optimisticData, successData, failureData});
 

src/libs/actions/IOU/Split.ts

@@ -59,8 +59,7 @@ import {
     updateReportPreview,
 } from '@libs/ReportUtils';
 import playSound, {SOUNDS} from '@libs/Sound';
-import {getSpan} from '@libs/telemetry/activeSpans';
-import {setPendingSubmitFollowUpAction} from '@libs/telemetry/submitFollowUpAction';
+import {isTracking, setPendingSubmitFollowUpAction} from '@libs/telemetry/submitFollowUpAction';
 import {
     buildOptimisticTransaction,
     getAmount,
@@ -2291,7 +2290,7 @@ function updateSplitTransactionsFromSplitExpensesFlow(params: UpdateSplitTransac
 
     const targetReportID = params.expenseReport?.reportID ?? String(CONST.DEFAULT_NUMBER_ID);
 
-    if (getSpan(CONST.TELEMETRY.SPAN_SUBMIT_TO_DESTINATION_VISIBLE)) {
+    if (isTracking()) {
         setPendingSubmitFollowUpAction(CONST.TELEMETRY.SUBMIT_FOLLOW_UP_ACTION.DISMISS_MODAL_AND_OPEN_REPORT, targetReportID);
     }
     Navigation.dismissModalWithReport({reportID: targetReportID});