fix: opened tab/status is not preserved after switching between pages by nkdengineer · Pull Request #58053 · Expensify/App

nkdengineer · 2025-03-08T15:33:57Z

Explanation of Change

fix: opened tab/status is not preserved after switching between pages

Fixed Issues

$ #57986
PROPOSAL: #57986 (comment)

Tests

Open Reports
Open any tab/status
Open Settings
Open Reports again
Verify that the tab/status is preserved

Verify that no errors appear in the JS console

Offline tests

Same

QA Steps

// TODO: These must be filled out, or the issue title must include "[No QA]."

Open Reports
Open any tab/status
Open Settings
Open Reports again
Verify that the tab/status is preserved

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Screen.Recording.2025-03-08.at.22.17.25.mov

Android: mWeb Chrome

Screen.Recording.2025-03-08.at.22.22.00.mov

iOS: Native

Screen.Recording.2025-03-08.at.22.22.45.mov

iOS: mWeb Safari

Screen.Recording.2025-03-08.at.22.23.40.mov

MacOS: Chrome / Safari

Screen.Recording.2025-03-08.at.22.13.42.mov

MacOS: Desktop

Screen.Recording.2025-03-08.at.22.26.57.mov

melvin-bot · 2025-03-08T16:03:21Z

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

allgandalf · 2025-03-08T18:11:09Z

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 that the composer does not automatically focus or open the keyboard on mobile unless explicitly intended. This includes checking that returning the app from the background does not unexpectedly open the keyboard.
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

Screen.Recording.2025-03-10.at.11.12.38.PM.mov

Android: mWeb Chrome

Screen.Recording.2025-03-10.at.11.05.44.PM.mov

iOS: Native

Screen.Recording.2025-03-10.at.11.03.48.PM.mov

iOS: mWeb Safari

Screen.Recording.2025-03-09.at.12.38.15.AM.mov

MacOS: Chrome / Safari

Screen.Recording.2025-03-09.at.12.36.31.AM.mov

MacOS: Desktop

Screen.Recording.2025-03-09.at.12.39.36.AM.mov

allgandalf · 2025-03-08T19:11:17Z

Bug: The option resets if we visit profile after settings and then go back to search:

Screen.Recording.2025-03-09.at.12.40.41.AM.mov

allgandalf · 2025-03-08T19:11:58Z

Production:

Screen.Recording.2025-03-09.at.12.41.44.AM.mov

src/components/Navigation/BottomTabBar/index.tsx

Kicu · 2025-03-10T07:25:56Z

src/components/Navigation/BottomTabBar/index.tsx

            const defaultCannedQuery = buildCannedSearchQuery();
+
+            const rootState = navigationRef.getRootState() as State<RootNavigatorParamList>;
+            const lastSearchNavigator = rootState.routes.findLast((route) => route.name === NAVIGATORS.SEARCH_FULLSCREEN_NAVIGATOR);


Here's the fix for preserving state when navigating from BottomBar:

Suggested change

const lastSearchNavigator = rootState.routes.findLast((route) => route.name === NAVIGATORS.SEARCH_FULLSCREEN_NAVIGATOR);

const lastSearchNavigator = rootState.routes.findLast((route) => route.name === NAVIGATORS.SEARCH_FULLSCREEN_NAVIGATOR);

const lastSearchNavigatorState = lastSearchNavigator && lastSearchNavigator.state && lastSearchNavigator.key ? getPreservedSplitNavigatorState(lastSearchNavigator?.key) : undefined;

const lastSearchRoute = lastSearchNavigatorState?.routes.findLast((route) => route.name === SCREENS.SEARCH.ROOT);

This solution came from @WojtekBoman - thanks!

A few words about it:
previously Search was "flat" so we didn't need to do any extra steps to try and preserve it's state. The route with params was on the top level of navigation so it worked.
Now we need this extra steps of finding the last search route within the navigator to grab the query.

If you are able to improve the dirty logic expression that I did lastSearchNavigator && lastSearchNavigator.state && lastSearchNavigator.key then feel free 😅

src/components/Navigation/BottomTabBar/index.tsx

Kicu · 2025-03-10T10:12:12Z

@nkdengineer
So we need 2 extra changes:

in order to have parentRoute available, please use it same as here: https://github.com/Expensify/App/blob/main/src/libs/Navigation/AppNavigator/Navigators/ReportsSplitNavigator.tsx#L49
in the long check that I proposed, we should not check for lastSearchNavigator.state becasue it will be empty.

So the way this mechanism works is that navigators will get unmounted to save memory, if they are covered with other navigators in stack. However we will have the navigator.key prop available (but no state). That is why state is saved in preserveSplitNavigatorState

SO in our case

            const lastSearchNavigatorState = lastSearchNavigator && lastSearchNavigator.key ? getPreservedSplitNavigatorState(lastSearchNavigator?.key) : undefined;

this line should now work, and parentRoute will not be undefined. I have tested and it works on my end.

In addition you can remove the word Split from usePreserveSplitNavigatorState - so that it is named simply usePreserveNavigatorState.

Fingers crossed that this works :)

nkdengineer · 2025-03-10T10:13:47Z

Greate, I will give an update soon.

mountiny

Thanks, not gonna CP this but lets test this properly in staging

OSBotify · 2025-03-10T20:15:32Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

github-actions · 2025-03-10T21:37:43Z

🚀 Deployed to staging by https://github.com/mountiny in version: 9.1.11-1 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅
🤖🔄 android HybridApp 🤖🔄	success ✅
🍎🔄 iOS HybridApp 🍎🔄	success ✅

github-actions · 2025-03-14T01:09:47Z

🚀 Deployed to production by https://github.com/mountiny in version: 9.1.12-7 🚀

platform	result
🤖 android 🤖	true ❌
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅
🤖🔄 android HybridApp 🤖🔄	failure ❌
🍎🔄 iOS HybridApp 🍎🔄	failure ❌

nkdengineer added 3 commits March 8, 2025 22:29

fix: opened tab/status is not preserved after switching between pages

877d956

remove log

faab493

fix prettier

74be692

nkdengineer marked this pull request as ready for review March 8, 2025 16:03

nkdengineer requested a review from a team as a code owner March 8, 2025 16:03

melvin-bot bot requested a review from allgandalf March 8, 2025 16:03

melvin-bot bot removed the request for review from a team March 8, 2025 16:03

mountiny assigned nkdengineer Mar 8, 2025

mountiny changed the title ~~fix: opened tab/status is not preserved after switching between pages~~ [CP Staging] fix: opened tab/status is not preserved after switching between pages Mar 8, 2025

WojtekBoman reviewed Mar 10, 2025

View reviewed changes

src/components/Navigation/BottomTabBar/index.tsx Outdated Show resolved Hide resolved

Kicu reviewed Mar 10, 2025

View reviewed changes

nkdengineer added 2 commits March 10, 2025 14:37

Merge branch 'main' into fix/57986

9efa3ab

remove unused code

dff16ed

update preserve state for search full navigator

7c2970f

allgandalf approved these changes Mar 10, 2025

View reviewed changes

melvin-bot bot requested a review from mountiny March 10, 2025 17:45

mountiny changed the title ~~[CP Staging] fix: opened tab/status is not preserved after switching between pages~~ fix: opened tab/status is not preserved after switching between pages Mar 10, 2025

mountiny approved these changes Mar 10, 2025

View reviewed changes

mountiny merged commit 465d8fa into Expensify:main Mar 10, 2025
18 checks passed

github-actions bot mentioned this pull request Mar 10, 2025

Deploy Checklist: New Expensify 2025-03-10 #58124

Closed

melvin-bot bot mentioned this pull request Mar 14, 2025

[Due for payment 2025-03-21] [$125] Reports- Opened tab/status is not preserved after switching between pages #57986

Closed

8 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: opened tab/status is not preserved after switching between pages#58053

fix: opened tab/status is not preserved after switching between pages#58053
mountiny merged 6 commits intoExpensify:mainfrom
nkdengineer:fix/57986

nkdengineer commented Mar 8, 2025

Uh oh!

melvin-bot bot commented Mar 8, 2025

Uh oh!

allgandalf commented Mar 8, 2025 •

edited

Loading

Uh oh!

allgandalf commented Mar 8, 2025

Uh oh!

allgandalf commented Mar 8, 2025

Uh oh!

Uh oh!

Kicu Mar 10, 2025

Uh oh!

Uh oh!

Kicu commented Mar 10, 2025

Uh oh!

nkdengineer commented Mar 10, 2025

Uh oh!

mountiny left a comment

Uh oh!

Uh oh!

OSBotify commented Mar 10, 2025

Uh oh!

github-actions bot commented Mar 10, 2025

Uh oh!

github-actions bot commented Mar 14, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Conversation

nkdengineer commented Mar 8, 2025

Explanation of Change

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot bot commented Mar 8, 2025

Uh oh!

allgandalf commented Mar 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

allgandalf commented Mar 8, 2025

Uh oh!

allgandalf commented Mar 8, 2025

Uh oh!

Uh oh!

Kicu Mar 10, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Kicu commented Mar 10, 2025

Uh oh!

nkdengineer commented Mar 10, 2025

Uh oh!

mountiny left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

OSBotify commented Mar 10, 2025

Uh oh!

github-actions bot commented Mar 10, 2025

Uh oh!

github-actions bot commented Mar 14, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

allgandalf commented Mar 8, 2025 •

edited

Loading