Merge pull request Expensify#89094 from truph01/fix/88499

fix: Fix back navigation trap after deleting expense from DM

Author: rlinoz

src/components/ParentNavigationSubtitle.tsx

@@ -103,15 +103,21 @@ function ParentNavigationSubtitle({
     const isReportInRHP = currentRoute.name === SCREENS.RIGHT_MODAL.SEARCH_REPORT;
     const hasAccessToParentReport = currentReport?.hasParentAccess !== false;
     const {currentFullScreenRoute, currentFocusedNavigator} = useRootNavigationState((state) => {
-        const fullScreenRoute = state?.routes?.findLast((route) => isFullScreenName(route.name));
+        // Find the tab navigator, which wraps all full-screen navigators
+        const tabNavigatorRoute = state?.routes?.findLast((route) => route.name === NAVIGATORS.TAB_NAVIGATOR);
+        const tabState = tabNavigatorRoute?.state;
 
-        // We need to track which navigator is focused to handle parent report navigation correctly:
-        // if we are in RHP, and parent report is opened in RHP, we want to go back to the parent report
-        const focusedNavigator = state?.routes
-            ? state.routes.findLast((route) => {
-                  return route.state?.routes && route.state.routes.length > 0;
-              })
-            : undefined;
+        // Get the active (focused) tab from the tab navigator as the current full-screen route
+        // and fall back to the previous root-level full-screen lookup for states without tab nesting.
+        const fullScreenRoute = tabState ? tabState.routes?.[tabState.index ?? 0] : state?.routes?.findLast((route) => isFullScreenName(route.name));
+
+        // Find the outermost navigator that currently has an active screen stack
+        const lastNavigatorWithRoutes = state?.routes ? state.routes.findLast((route) => route.state?.routes && route.state.routes.length > 0) : undefined;
+
+        // If the tab navigator is focused, resolve to the active tab's navigator so that
+        // focusedNavigatorState reflects the split navigator's screen stack (not the tab list).
+        // If RHP is focused, use the RHP route directly so RHP-specific checks work correctly.
+        const focusedNavigator = lastNavigatorWithRoutes?.name === NAVIGATORS.TAB_NAVIGATOR ? fullScreenRoute : lastNavigatorWithRoutes;
 
         return {
             currentFullScreenRoute: fullScreenRoute,
@@ -188,6 +194,24 @@ function ParentNavigationSubtitle({
             }
         }
 
+        // If the parent report is already the previous screen in the main stack, go back to it
+        // and update its params instead of pushing a new instance. Without this check, repeatedly
+        // tapping the subtitle link builds up a [DM, Expense, DM, Expense, …] stack that traps
+        // the user after an expense is deleted.
+        if ((currentReportIndex ?? 0) > 0 && focusedNavigatorState?.key && currentFocusedNavigator?.name === NAVIGATORS.REPORTS_SPLIT_NAVIGATOR) {
+            const prevRoute = focusedNavigatorState.routes[(currentReportIndex ?? 0) - 1];
+            const prevRouteReportID = prevRoute?.params && 'reportID' in prevRoute.params ? String(prevRoute.params.reportID) : undefined;
+
+            if (prevRouteReportID === parentReportID && prevRoute?.key) {
+                if (isVisibleAction && parentReportActionID) {
+                    // Set params on the background screen first so it is already correct when revealed.
+                    Navigation.setParams({reportActionID: parentReportActionID}, prevRoute.key, focusedNavigatorState.key);
+                }
+                Navigation.goBack();
+                return;
+            }
+        }
+
         if (isVisibleAction) {
             Navigation.navigate(ROUTES.REPORT_WITH_ID.getRoute(parentReportID, parentReportActionID));
         } else {

tests/ui/ParentNavigationSubtitleTest.tsx

@@ -2,12 +2,20 @@ import type {RouteProp} from '@react-navigation/native';
 import {fireEvent, render, screen} from '@testing-library/react-native';
 import React from 'react';
 import Navigation from '@libs/Navigation/Navigation';
+import {isReportActionVisible} from '@libs/ReportActionsUtils';
 import ParentNavigationSubtitle from '../../src/components/ParentNavigationSubtitle';
+import NAVIGATORS from '../../src/NAVIGATORS';
+import SCREENS from '../../src/SCREENS';
 
 jest.mock('@libs/Navigation/Navigation');
 
+jest.mock('@libs/ReportActionsUtils', () => ({
+    getReportAction: jest.fn(() => undefined),
+    isReportActionVisible: jest.fn(() => false),
+}));
+
 const mockUseRootNavigationState = jest.fn();
-jest.mock('@src/hooks/useRootNavigationState', () => ({
+jest.mock('@hooks/useRootNavigationState', () => ({
     // eslint-disable-next-line @typescript-eslint/naming-convention
     __esModule: true,
     default: (selector?: (state: unknown) => unknown) => mockUseRootNavigationState(selector) as unknown,
@@ -24,11 +32,51 @@ jest.mock('@react-navigation/native', () => {
     };
 });
 
+/** Root state with TabNavigator → Reports split stack [parent DM, expense]; index on expense (matches issue #88499 stack). */
+function getMockRootStateWithReportsSplitStack(parentReportID: string, expenseReportID: string) {
+    const parentRoute = {
+        name: SCREENS.REPORT,
+        params: {reportID: parentReportID},
+        key: 'route-parent-key',
+    };
+    const expenseRoute = {
+        name: SCREENS.REPORT,
+        params: {reportID: expenseReportID},
+        key: 'route-expense-key',
+    };
+    return {
+        routes: [
+            {
+                name: NAVIGATORS.TAB_NAVIGATOR,
+                key: 'tab-root-key',
+                state: {
+                    index: 0,
+                    routes: [
+                        {
+                            name: NAVIGATORS.REPORTS_SPLIT_NAVIGATOR,
+                            key: 'reports-split-route-key',
+                            state: {
+                                key: 'reports-split-state-key',
+                                index: 1,
+                                routes: [parentRoute, expenseRoute],
+                            },
+                        },
+                    ],
+                },
+            },
+        ],
+    };
+}
+
 describe('ParentNavigationSubtitle', () => {
     beforeEach(() => {
         jest.clearAllMocks();
+        jest.mocked(isReportActionVisible).mockReturnValue(false);
         Navigation.getTopmostReportId = jest.fn();
         Navigation.dismissModal = jest.fn();
+        Navigation.goBack = jest.fn();
+        Navigation.setParams = jest.fn();
+        Navigation.navigate = jest.fn();
     });
 
     it('if the parent report is already displayed underneath RHP, simply dismiss the modal', () => {
@@ -130,4 +178,109 @@ describe('ParentNavigationSubtitle', () => {
         fireEvent(clickableElement, 'press', mockEvent);
         expect(Navigation.dismissModal).not.toHaveBeenCalled();
     });
+
+    it('goes back without navigating when parent report is already the previous route in Reports split stack under Tab navigator', () => {
+        const parentReportID = 'parent-report';
+        const expenseReportID = 'expense-report';
+        const reportName = 'Parent chat';
+        const workspaceName = 'Workspace';
+
+        mockUseRoute.mockReturnValue({name: SCREENS.REPORT} as AnyRoute);
+        mockUseRootNavigationState.mockImplementation((selector?: (state: unknown) => unknown) => {
+            const mockState = getMockRootStateWithReportsSplitStack(parentReportID, expenseReportID);
+            if (selector) {
+                return selector(mockState);
+            }
+            return undefined;
+        });
+
+        render(
+            <ParentNavigationSubtitle
+                parentNavigationSubtitleData={{reportName, workspaceName}}
+                parentReportID={parentReportID}
+                reportID={expenseReportID}
+            />,
+        );
+
+        fireEvent(screen.getByTestId('parent-navigation-subtitle-link'), 'press', {
+            preventDefault: jest.fn(),
+            stopPropagation: jest.fn(),
+            nativeEvent: {},
+        });
+
+        expect(Navigation.goBack).toHaveBeenCalled();
+        expect(Navigation.navigate).not.toHaveBeenCalled();
+        expect(Navigation.setParams).not.toHaveBeenCalled();
+    });
+
+    it('sets reportActionID on the previous route then goes back when the parent action is visible', () => {
+        const parentReportID = 'parent-report';
+        const expenseReportID = 'expense-report';
+        const parentReportActionID = 'action-999';
+        const reportName = 'Parent chat';
+        const workspaceName = 'Workspace';
+
+        jest.mocked(isReportActionVisible).mockReturnValue(true);
+
+        mockUseRoute.mockReturnValue({name: SCREENS.REPORT} as AnyRoute);
+        mockUseRootNavigationState.mockImplementation((selector?: (state: unknown) => unknown) => {
+            const mockState = getMockRootStateWithReportsSplitStack(parentReportID, expenseReportID);
+            if (selector) {
+                return selector(mockState);
+            }
+            return undefined;
+        });
+
+        render(
+            <ParentNavigationSubtitle
+                parentNavigationSubtitleData={{reportName, workspaceName}}
+                parentReportID={parentReportID}
+                parentReportActionID={parentReportActionID}
+                reportID={expenseReportID}
+            />,
+        );
+
+        fireEvent(screen.getByTestId('parent-navigation-subtitle-link'), 'press', {
+            preventDefault: jest.fn(),
+            stopPropagation: jest.fn(),
+            nativeEvent: {},
+        });
+
+        expect(Navigation.setParams).toHaveBeenCalledWith({reportActionID: parentReportActionID}, 'route-parent-key', 'reports-split-state-key');
+        expect(Navigation.goBack).toHaveBeenCalled();
+        expect(Navigation.navigate).not.toHaveBeenCalled();
+    });
+
+    it('navigates forward when the previous stack route is not the parent report', () => {
+        const parentReportID = 'parent-report';
+        const expenseReportID = 'expense-report';
+        const reportName = 'Parent chat';
+        const workspaceName = 'Workspace';
+
+        mockUseRoute.mockReturnValue({name: SCREENS.REPORT} as AnyRoute);
+        mockUseRootNavigationState.mockImplementation((selector?: (state: unknown) => unknown) => {
+            const mockState = getMockRootStateWithReportsSplitStack('other-report', expenseReportID);
+            if (selector) {
+                return selector(mockState);
+            }
+            return undefined;
+        });
+
+        render(
+            <ParentNavigationSubtitle
+                parentNavigationSubtitleData={{reportName, workspaceName}}
+                parentReportID={parentReportID}
+                reportID={expenseReportID}
+            />,
+        );
+
+        fireEvent(screen.getByTestId('parent-navigation-subtitle-link'), 'press', {
+            preventDefault: jest.fn(),
+            stopPropagation: jest.fn(),
+            nativeEvent: {},
+        });
+
+        expect(Navigation.goBack).not.toHaveBeenCalled();
+        expect(Navigation.navigate).toHaveBeenCalled();
+    });
 });