FIX: Not found page shows briefly when deleting a track expense

[ikevin127]

Explanation of Change

We're reverting the changes implemented by PR #51920 as the changes caused this issue - more details in the proposal.

Fixed Issues

$ #53301
PROPOSAL: #53301 (comment)

Tests

1. Login into the app with any account.
2. Open self DM.
3. Create a new track expense.
4. Open the expense report.
5. Click on the report header to open report Details page, then and click Delete expense.
6. Confirm deletion and verify that It's not here page doesn't show up when the expense is being deleted.

Note

Since PR #53301 was fixing issue #51388 scenario but also an additional test case mentioned in #53301 (comment), besides our issue's tests - we need to ensure the 2 additional tests are passing as well.

Test for issue #51388:

Precondition: Go to profile icon (Settings) -> Troubleshoot > enable Debug mode.

1. Login into the app with any account.
2. Create a new workspace.
3. Tap on the new workspace report to open it.
4. Send a message.
5. Click on the report header to open report Details page, then and click Debug.
6. Scroll down to tap Delete.
7. Verify that the app doesn't get stuck on a blank page.

Test for scenario mentioned in #53301 (comment):

Precondition: Create a new #room with Private visibility.

1. User A invite user B to the room.
2. User B open the room report and clicks on header to open room's Details page.
3. User A removes B from room.
4. Verify that User B is not stuck on a blank page once removed from the room.

• Verify that no errors appear in the JS console

Offline tests

Same as QA Steps.

QA Steps

1. Login into the app with any account.
2. Open self DM.
3. Create a new track expense.
4. Open the expense report.
5. Click on the report header to open report Details page, then and click Delete expense.
6. Confirm deletion and verify that It's not here page doesn't show up when the expense is being deleted.

Note

Since PR #53301 was fixing issue #51388 scenario but also an additional test case mentioned in #53301 (comment), besides our issue's tests - we need to ensure the 2 additional tests are passing as well.

Test for issue #51388:

Precondition: Go to profile icon (Settings) -> Troubleshoot > enable Debug mode.

1. Login into the app with any account.
2. Create a new workspace.
3. Tap on the new workspace report to open it.
4. Send a message.
5. Click on the report header to open report Details page, then and click Debug.
6. Scroll down to tap Delete.
7. Verify that the app doesn't get stuck on a blank page.

Test for scenario mentioned in #53301 (comment):

Precondition: Create a new #room with Private visibility.

1. User A invite user B to the room.
2. User B open the room report and clicks on header to open room's Details page.
3. User A removes B from room.
4. Verify that User B is not stuck on a blank page once removed from the room.

• Verify that no errors appear in the JS console

PR Author Checklist

• I linked the correct issue in the ### Fixed Issues section above
• I wrote clear testing steps that cover the changes made in this PR
  • I added steps for local testing in the Tests section
  • I added steps for the expected offline behavior in the Offline steps section
  • I added steps for Staging and/or Production testing in the QA steps section
  • I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
  • I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
  • I tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
• I included screenshots or videos for tests on all platforms
• I ran the tests on all platforms & verified they passed on:
  • Android: Native
  • Android: mWeb Chrome
  • iOS: Native
  • iOS: mWeb Safari
  • MacOS: Chrome / Safari
  • MacOS: Desktop
• I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
• I followed proper code patterns (see Reviewing the code)
  • I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick)
  • I verified that comments were added to code that is not self explanatory
  • I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
  • I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
    • If any non-english text was added/modified, I used JaimeGPT to get English > Spanish translation. I then posted it in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
  • I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
  • I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
  • I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
  • I verified the JSDocs style guidelines (in STYLE.md) were followed
• If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
• I followed the guidelines as stated in the Review Guidelines
• I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
• I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
• I verified any variables that can be defined as constants (ie. in CONST.ts or at the top of the file that uses the constant) are defined as such
• I verified that if a function's arguments changed that all usages have also been updated correctly
• If any new file was added I verified that:
  • The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
• If a new CSS style is added I verified that:
  • A similar style doesn't already exist
  • The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG))
• If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
• If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
• If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
• If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
• If the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
  • I verified that all the inputs inside a form are aligned with each other.
  • I added Design label and/or tagged @Expensify/design so the design team can review the changes.
• If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
• I added unit tests for any new feature or bug fix in this PR to help automatically prevent regressions in this user flow.
• If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.

Screenshots/Videos

Android: Native

android.mp4

Android: mWeb Chrome

android-mweb.mp4

iOS: Native

ios.mp4

iOS: mWeb Safari

ios-mweb.mp4

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

[melvin-bot]

@shubham1206agra Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

[shubham1206agra]

@ikevin127 #51388 is failing for me

Screen.Recording.2024-12-10.at.6.13.04.PM.mov

[ikevin127]

@shubham1206agra I looked into the blank screen issue and this is what I found, related to this block:

App/src/pages/Debug/Report/DebugReportPage.tsx

Line 148 in 082e14b

navigateToConciergeChatAndDeleteReport(reportID, true, true);

which is calling:

function navigateToConciergeChatAndDeleteReport(reportID: string, shouldPopToTop = false, shouldDeleteChildReports = false) {
    // Dismiss the current report screen and replace it with Concierge Chat
    if (shouldPopToTop) {                                    // |
        Navigation.setShouldPopAllStateOnUP(true);           // |
    }                                                        // |  -> these 4 likes are responsible from going back from the
    Navigation.goBack(undefined, undefined, shouldPopToTop); // |  -> Debug - Report page after `Delete` confirmation
    navigateToConciergeChat();    // |  -> this is resonsible for navigating to the Concierge report
    InteractionManager.runAfterInteractions(() => {
        deleteReport(reportID, shouldDeleteChildReports);
    });
}

The issue here is that, because we removed the !isFocused check from the WithReportOrNotFound to fix the other issues, and because the navigateToConciergeChatAndDeleteReport only goes back and pops the route from the stack one time, there's 2 routes that we're left with in the stack behind the Concierce route we just pushed:

1. ReportDetailsPage (1st in stack behind Concierge) - this is the blank page observed when going back from Concierge
2. ReportScreen (2nd in stack behind ReportDetailsPage) - which would show a dismissable skeleton loading page in place of the now deleted report (navigateToConciergeChatAndDeleteReport -> deleteReport)

In order to deal with this issue while keeping the !isFocused check removed from the WithReportOrNotFound, I performed the following changes:

1. In navigateToConciergeChatAndDeleteReport added a new variable called shouldPopTwice which is false by default, implementing the following logic (of which pattern we also use here on Android to pop 2 screens from the stack):

-function navigateToConciergeChatAndDeleteReport(reportID: string, shouldPopToTop = false, shouldDeleteChildReports = false) {
+function navigateToConciergeChatAndDeleteReport(reportID: string, shouldPopToTop = false, shouldDeleteChildReports = false, shouldPopTwice = false) {
     // Dismiss the current report screen and replace it with Concierge Chat
     if (shouldPopToTop) {
         Navigation.setShouldPopAllStateOnUP(true);
     }
     Navigation.goBack(undefined, undefined, shouldPopToTop);
+    // When in Debug Mode and Delete report in DebugReportPage we need to pop
+    // two screens from the navigation stack before we navigate to concierge:
+    // ReportDetailsPage and ReportScreen, otherwise when going back from Concierge
+    // we'll see report skeleton page of deleted report.
+    if (shouldPopTwice) {
+        navigationRef.dispatch({...StackActions.pop()});
+        navigationRef.dispatch({...StackActions.pop()});
+    }
     navigateToConciergeChat();
     InteractionManager.runAfterInteractions(() => {
         deleteReport(reportID, shouldDeleteChildReports);

2. In ReportDetailsPage, pass the 2nd argument as false since we don't need the shouldPopToTop logic anymore, and pass the 3rd argument (shouldPopTwice) as true to the navigateToConciergeChatAndDeleteReport.

This will work in the following way:

• Navigation.goBack still in place but without shouldPopToTop will go back from Debug - Report page after Delete confirmation
• the 2 pops will remove ReportDetailsPage and ReportScreen from the stack, leaving us on the Concierge report without the deleted report pages in the stack

This fixes the issue with Debug mode delete report blank page or skeleton loading page when going back from the Concierge report, which will go back to Home (all chats) in all platforms or whatever the stack route behind Concierge report was before, proof from iOS: Native:

ios.mp4

[ikevin127]

@shubham1206agra Ready for review once again! Addressed the mentioned issue in #53408 (comment).

[shubham1206agra]

@ikevin127 Is there a reason why shouldPopToTop does not work?

[ikevin127]

@shubham1206agra It works, but only for popping the first screen aka Debug - Report after we confirm Delete, the other 2 report related screens remaining in the stack and causing the blank page and skeleton loading screen issues.

The reason why I went with the new prop is because of backwards compatibility since the function is used in other components as well and I wouldn't want to break any of the previous functionality.

[shubham1206agra]

but only for popping the first screen aka Debug

@ikevin127 It should pop all the screens. Let me see why this is happening.

[ikevin127]

@shubham1206agra Indeed, popToTop should pop all but for some reason it's not working:

/**
   * Pop to the first route in the stack, dismissing all other screens.
   */
  popToTop(): void;

Looks like navigateToConciergeChatAndDeleteReport is the only function that's using the Navigation.goBack 3rd argument shouldPopToTop and it's not working as expected.

I'll look into this again tomorrow, I'm thinking there might be a problem with the way we call popToTop on this line:

App/src/libs/Navigation/Navigation.ts

Line 214 in 082e14b

navigationRef.current?.dispatch(StackActions.popToTop());

I noticed that most of the dispatch calls with StackActions are called with spread operator, example from resetToHome:

App/src/libs/Navigation/Navigation.ts

Lines 304 to 311 in 082e14b

	function resetToHome() {
	const rootState = navigationRef.getRootState();
	const bottomTabKey = rootState.routes.find((item: NavigationStateRoute) => item.name === NAVIGATORS.BOTTOM_TAB_NAVIGATOR)?.state?.key;
	if (bottomTabKey) {
	navigationRef.dispatch({...StackActions.popToTop(), target: bottomTabKey});
	}
	navigationRef.dispatch({...StackActions.popToTop(), target: rootState.key});
	}

and also passing a target. Will attempt to see if I can fix the Navigation.goBack function when it comes to the shouldPopToTop logic.

Edit

I confirm that fixes the issue:

    if (shouldPopToTop) {
        if (shouldPopAllStateOnUP) {
            const rootState = navigationRef.getRootState(); // <- new line
            shouldPopAllStateOnUP = false;
            navigationRef.current?.dispatch({...StackActions.popToTop(), target: rootState.key}); // <- changed line
            return;
        }
    }

Will revert the last commit and apply this fix instead.

[ikevin127]

@shubham1206agra I reverted that previous commit and fixed Navigation.goBack's shouldPopToTop logic instead, as described in #53408 (comment). Ready for review once again, if you find any other issues please let me know and will address again tomorrow.