fix: back button returns to expense report after submitting track expense #53065

daledah · 2024-11-25T14:12:23Z

Explanation of Change

Fixed Issues

$ #52189
PROPOSAL: #52189 (comment)

Tests

Open self DM
Track an expense
Open expense report
Click header -> Submit to someone
Submit the expense
Press back button
Verify that: User is navigated to self DM

Verify that no errors appear in the JS console

Offline tests

QA Steps

Open self DM
Track an expense
Open expense report
Click header -> Submit to someone
Submit the expense
Press back button
Verify that: User is navigated to self DM

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Screen.Recording.2024-12-04.at.11.39.28.mov

Android: mWeb Chrome

Screen.Recording.2024-12-04.at.11.40.08.mov

iOS: Native

Screen.Recording.2024-12-04.at.11.44.00.mov

iOS: mWeb Safari

Screen.Recording.2024-12-04.at.11.45.16.mov

MacOS: Chrome / Safari

Screen.Recording.2024-12-04.at.11.46.13.mp4

MacOS: Desktop

Screen.Recording.2024-12-04.at.11.50.11.mp4

…ense

melvin-bot · 2024-12-04T08:36:08Z

@eVoloshchak 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]

daledah · 2024-12-10T16:07:55Z

friendly bump @eVoloshchak

eVoloshchak · 2024-12-29T18:13:40Z

src/libs/actions/IOU.ts

+
+    const trackReport = Navigation.getPreviousTrackReport(linkedTrackedExpenseReportAction?.childReportID);
+    if (trackReport?.key) {
+        Navigation.isNavigationReady().then(() => Navigation.removeScreenByKey(trackReport.key));


We're calling isNavigationReady() twice (first from here and then from inside the removeScreenByKey method itself). Is this intentional?

I added the call isNavigationReady to fix the bug below with browser back button:

Screen.Recording.2025-01-07.at.23.37.22.mov

@eVoloshchak I just updated the function logics, we don't need to use isNavigationReady here anymore.

eVoloshchak · 2025-01-29T11:58:57Z

Reviewer Checklist

I have verified the author checklist is complete (all boxes are checked off).
I verified the correct issue is linked in the ### Fixed Issues section above
I verified testing steps are clear and they cover the changes made in this PR
- I verified the steps for local testing are in the Tests section
- I verified the steps for Staging and/or Production testing are in the QA steps section
- I verified the steps cover any possible 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 checked that screenshots or videos are included for tests on all platforms
I included screenshots or videos for tests on all platforms
I verified tests pass on all platforms & I tested again on:
- Android: Native
- Android: mWeb Chrome
- iOS: Native
- iOS: mWeb Safari
- MacOS: Chrome / Safari
- MacOS: Desktop
If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
I verified proper code patterns were followed (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
- 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 verified that this PR follows the guidelines as stated in the Review Guidelines
I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
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
If a new component is created I verified that:
- A similar component doesn't exist in the codebase
- All props are defined accurately and each prop has a /** comment above it */
- The file is named correctly
- The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
- The only data being stored in the state is data necessary for rendering and nothing else
- For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
- Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
- All JSX used for rendering exists in the render method
- The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
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.
For any bug fix or new feature in this PR, I verified that sufficient unit tests are included to prevent regressions in this 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.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

eVoloshchak · 2025-01-29T12:03:47Z

src/libs/actions/IOU.ts

+
+    const trackReport = Navigation.getPreviousTrackReport(linkedTrackedExpenseReportAction?.childReportID);
+    if (trackReport?.key) {
+        Navigation.isNavigationReady().then(() => Navigation.removeScreenByKey(trackReport.key));


Can we move .isNavigationReady() to removeScreenByKey function itself? That way we won't have to call it each time manually

In this PR I implemented the same logic without isNavigationReady, so I think we shouldn't move it to removeScreenByKey

eVoloshchak · 2025-01-29T12:09:57Z

src/libs/Navigation/Navigation.ts

@@ -428,6 +428,13 @@ function getTopMostCentralPaneRouteFromRootState() {
    return getTopmostCentralPaneRoute(navigationRef.getRootState() as State<RootStackParamList>);
 }

+function getPreviousTrackReport(reportID?: string) {


There might be a better name for this. The method is universal, it doesn't get the previous track report, it gets the track report route by reportID

eVoloshchak · 2025-01-29T12:14:02Z

src/libs/Navigation/Navigation.ts

+    if (!reportID) {
+        return null;
+    }
+    return navigationRef.getRootState().routes.find((r) => r.name === SCREENS.REPORT && !!r.params && 'reportID' in r.params && r.params.reportID === reportID);


Suggested change

return navigationRef.getRootState().routes.find((r) => r.name === SCREENS.REPORT && !!r.params && 'reportID' in r.params && r.params.reportID === reportID);

return navigationRef.getRootState().routes.find((route) => route.name === SCREENS.REPORT && !!route.params && 'reportID' in route.params && route.params.reportID === reportID);

eVoloshchak · 2025-01-29T12:17:44Z

src/libs/Navigation/Navigation.ts

+    const state = navigationRef.getRootState();
+    const routes = state.routes.filter((item) => item.key !== key);
+
+    navigationRef.current?.dispatch(() => {


Suggested change

navigationRef.current?.dispatch(() => {

isNavigationReady().then(() => {

navigationRef.dispatch((state) => {

const routes = state.routes.filter((item) => item.key !== key);

daledah · 2025-01-31T04:29:44Z

@eVoloshchak I updated

daledah added 5 commits November 25, 2024 21:07

fix: back button returns to expense report after submitting track exp…

24fcb4a

…ense

fix: handle back button on chrome

9a9ed9a

fix: IOUTest

430609a

fix: IOUTest

e67221c

fix: lint

14f77f9

daledah marked this pull request as ready for review December 4, 2024 08:36

daledah requested a review from a team as a code owner December 4, 2024 08:36

melvin-bot bot requested a review from eVoloshchak December 4, 2024 08:36

melvin-bot bot removed the request for review from a team December 4, 2024 08:36

Merge branch 'main' into fix/52189

9b5e599

This was referenced Dec 20, 2024

[$125] Android - Track expense - On deleting track expense, user navigated to expense details page briefly #54058

Open

[$250] Track expense - Back button returns to expense report after submitting track expense #52189

Open

Merge branch 'main' into fix/52189

5e1b5d4

eVoloshchak reviewed Dec 29, 2024

View reviewed changes

daledah added 2 commits January 13, 2025 17:37

fix: update removeScreenByKey

1f8b4c6

Merge branch 'main' into fix/52189

89dceb3

eVoloshchak suggested changes Jan 29, 2025

View reviewed changes

daledah added 2 commits January 31, 2025 11:27

Merge branch 'main' into fix/52189

e176bd6

refactor: change functions names

21c9f01

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: back button returns to expense report after submitting track expense #53065

fix: back button returns to expense report after submitting track expense #53065

daledah commented Nov 25, 2024 •

edited

Loading

melvin-bot bot commented Dec 4, 2024

daledah commented Dec 10, 2024

eVoloshchak Dec 29, 2024

daledah Jan 7, 2025

daledah Jan 15, 2025

eVoloshchak commented Jan 29, 2025 •

edited

Loading

eVoloshchak Jan 29, 2025

daledah Jan 31, 2025

eVoloshchak Jan 29, 2025

eVoloshchak Jan 29, 2025

eVoloshchak Jan 29, 2025

daledah commented Jan 31, 2025

	return navigationRef.getRootState().routes.find((r) => r.name === SCREENS.REPORT && !!r.params && 'reportID' in r.params && r.params.reportID === reportID);
	return navigationRef.getRootState().routes.find((route) => route.name === SCREENS.REPORT && !!route.params && 'reportID' in route.params && route.params.reportID === reportID);

fix: back button returns to expense report after submitting track expense #53065

Are you sure you want to change the base?

fix: back button returns to expense report after submitting track expense #53065

Conversation

daledah commented Nov 25, 2024 • edited Loading

Explanation of Change

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Dec 4, 2024

daledah commented Dec 10, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

eVoloshchak commented Jan 29, 2025 • edited Loading

Reviewer Checklist

Screenshots/Videos

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

daledah commented Jan 31, 2025

daledah commented Nov 25, 2024 •

edited

Loading

eVoloshchak commented Jan 29, 2025 •

edited

Loading