[Search v1] Fix desynchronized bottom tab and central pane after goBack to the Search #43998

adamgrzybowski · 2024-06-19T13:45:16Z

Details

Sometimes we will navigate to central pane with different matching bottom tab. In this case matching bottom tab will be pushed on the bottom tab stack.

We need to modify goBack function to take this into account. We will check if the central pane under the one that we want to pop matches current bottom tab. If not, we will look for the proper bottom tab screen and pop to it's index.

Fixed Issues

$ #43407
PROPOSAL:

Tests

Verify that no errors appear in the JS console

Offline tests

QA Steps

Verify that no errors appear in the JS console

This is test for the reported issue

Launch New Expensify app
Go to workspace chat
Submit an expense
Go to Search
Tap on the submitted expense
Tap on the header subtitle to return to the main chat
Tap on the back button
You should be on the Search page

This one was found later. The root cause is exactly the same.

Go to Search screen
Add expense to a workspace
Go back
You should be on the Search page

PR Author Checklist

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

ios.mov

iOS: mWeb Safari

iosWeb.mov

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

melvin-bot · 2024-06-19T13:45:21Z

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

adamgrzybowski · 2024-06-19T14:03:33Z

src/libs/Navigation/Navigation.ts

-    // Allow CentralPane to use UP with fallback route if the path is not found in root navigator.
-    if (isCentralPaneFocused && fallbackRoute && distanceFromPathInRootNavigator === -1) {
-        navigate(fallbackRoute, CONST.NAVIGATION.TYPE.UP);
-        return;
+    if (isCentralPaneFocused && fallbackRoute) {
+        // Allow CentralPane to use UP with fallback route if the path is not found in root navigator.
+        if (distanceFromPathInRootNavigator === -1) {
+            navigate(fallbackRoute, CONST.NAVIGATION.TYPE.UP);
+            return;
+        }
+
+        // Add possibility to go back more than one screen in root navigator if that screen is on the stack.
+        if (distanceFromPathInRootNavigator > 0) {
+            navigationRef.current.dispatch(StackActions.pop(distanceFromPathInRootNavigator));
+            return;
+        }


This change is cosmetic only. It won't change behaviour. I just realised that the ifs are similar.

luacmartins

LGTM

luacmartins · 2024-06-19T17:57:12Z

@getusha all yours

adamgrzybowski · 2024-06-21T08:49:34Z

Hey @getusha how it's going with review?

getusha · 2024-06-21T11:37:08Z

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 the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
- 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.js 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.
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.2024-07-09.at.5.22.09.in.the.afternoon.mov

Android: mWeb Chrome

Screen.Recording.2024-07-09.at.5.07.01.in.the.afternoon.mov

iOS: Native

Screen.Recording.2024-07-09.at.5.19.00.in.the.afternoon.mov

iOS: mWeb Safari

Screen.Recording.2024-07-09.at.5.04.11.in.the.afternoon.mov

MacOS: Chrome / Safari

Screen.Recording.2024-07-09.at.4.56.16.in.the.afternoon.mov

MacOS: Desktop

Screen.Recording.2024-07-09.at.5.38.40.in.the.afternoon.mov

getusha · 2024-06-21T12:21:06Z

@adamgrzybowski i am able to reproduce the issue after applying your solution

Screen.Recording.2024-06-21.at.3.19.44.in.the.afternoon.mov

adamgrzybowski · 2024-06-21T15:16:31Z

@getusha I am trying to reproduce the problem you showed and I can't. Do you see anything I may be doing wrong?

Screen.Recording.2024-06-21.at.17.14.31.mov

luacmartins · 2024-06-21T18:51:30Z

Hmm I'm also still able to reproduce the issue. What am I doing wrong? I confirmed that I'm on your branch and ran npm i && npm run web

Screen.Recording.2024-06-21.at.12.50.43.PM.mov

luacmartins

Changing my approval since the issue is still reproducible

adamgrzybowski · 2024-06-24T16:03:01Z

@luacmartins @getusha okay I managed to reproduce it with a different account. Weird stuff happening 😄 I will continue my investigation tomorrow.

luacmartins · 2024-06-24T19:00:00Z

Thanks @adamgrzybowski !

luacmartins

Waiting on @adamgrzybowski to address this comment

luacmartins · 2024-06-25T16:36:06Z

@adamgrzybowski any luck addressing #43998 (comment)?

adamgrzybowski · 2024-06-25T16:38:47Z

Moved forward with the investigation but don't have a solution yet. I hope to resolve that tomorrow.

luacmartins · 2024-06-27T15:13:38Z

@adamgrzybowski any updates on this one?

adamgrzybowski · 2024-06-27T15:37:10Z

I have been busy with higher priority tasks and helping people as many new navigation issues were created. Things are slowly looking better so I'll be able to get back to it soon

adamgrzybowski · 2024-07-03T12:12:55Z

@luacmartins @getusha Hey guys, I merged the newest main and couldn't reproduce the above mentioned problem. I asked a few other people to do the same and still no reproduction. Could you please check if you can reproduce it once again? Thanks!

luacmartins · 2024-07-03T23:34:44Z

Sorry, I was focused on Search v2.1 today and didn't get to this review. I'll do it tomorrow. In the meantime, @getusha could you please review this as your top priority?

getusha · 2024-07-04T09:43:23Z

Following the QA steps, when pressing the back button:

The first time (after a reload), it will navigate you back to the LHN.
After that, it will navigate you back to the search page.

Is this something we should fix? @luacmartins @adamgrzybowski

Screen.Recording.2024-07-04.at.12.37.52.in.the.afternoon.mov

adamgrzybowski · 2024-07-04T10:32:35Z

@getusha good catch! I will take a look into this one

BrtqKr · 2024-07-08T12:12:39Z

@getusha @luacmartins it seems like the issue is caused by the strict mode. If it's enabled the navigation root useEffect is triggererd twice

    useEffect(() => {
        if (firstRenderRef.current) {
            setupCustomAndroidBackHandler();

            // we don't want to make the report back button go back to LHN if the user
            // started on the small screen so we don't set it on the first render
            // making it only work on consecutive changes of the screen size
            firstRenderRef.current = false;
            return;
        }
        if (!isSmallScreenWidth) {
            return;
        }
        Navigation.setShouldPopAllStateOnUP();
    }, [isSmallScreenWidth]);

which sets setShouldPopAllStateOnUP to true (it's not the first render, so it gets set to true), which in effect is causing the goBack function to include a case meant for the screen size change.

We'll discuss it with @adamgrzybowski, but it looks like applying this flag based on the screen size directly it should work as expected, excluding the bug

…ne-bottomtab-sync

luacmartins · 2024-07-08T15:46:43Z

@BrtqKr thanks for the explanation. Let me know when the PR is ready for review again.

BrtqKr · 2024-07-09T08:29:56Z

@luacmartins it's ready

getusha

LGTM & tests well!

OSBotify · 2024-07-10T11:19:26Z

🚀 Deployed to staging by https://github.com/luacmartins in version: 9.0.6-0 🚀

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

OSBotify · 2024-07-10T11:36:40Z

🚀 Deployed to staging by https://github.com/luacmartins in version: 9.0.6-0 🚀

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

kbecciv · 2024-07-10T21:38:45Z

This PR is failing because of issue #43407

The issue is reproducible in: all Platforms

1720622974638.screen-20240710-174850.mp4

1720621362292.Screen_Recording_2024-07-10_at_17.18.38.mp4

1720621938171.Screen_Recording_2024-07-10_at_17.28.43.mp4

1720622708191.screen-20240710-174403.mp4

1720630236386.RPReplay_Final1720630143.mp4

OSBotify · 2024-07-11T10:16:55Z

🚀 Cherry-picked to staging by https://github.com/Julesssss in version: 9.0.6-1 🚀

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

@Expensify/applauseleads please QA this PR and check it off on the deploy checklist if it passes.

OSBotify · 2024-07-11T10:36:31Z

🚀 Cherry-picked to staging by https://github.com/Julesssss in version: 9.0.6-1 🚀

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

@Expensify/applauseleads please QA this PR and check it off on the deploy checklist if it passes.

adamgrzybowski · 2024-07-12T08:07:15Z

This PR is failing because of issue #43407
The issue is reproducible in: all Platforms

@kbecciv You mean something is still wrong with this part of the app?

OSBotify · 2024-07-15T20:19:23Z

🚀 Deployed to production by https://github.com/thienlnam in version: 9.0.6-8 🚀

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

OSBotify · 2024-07-17T00:18:22Z

🚀 Deployed to production by https://github.com/thienlnam in version: 9.0.7-8 🚀

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

fix sync central pane with bottom tab in go back

9a25fc8

adamgrzybowski requested a review from a team as a code owner June 19, 2024 13:45

melvin-bot bot removed the request for review from a team June 19, 2024 13:45

melvin-bot bot requested a review from getusha June 19, 2024 13:45

adamgrzybowski commented Jun 19, 2024

View reviewed changes

WojtekBoman approved these changes Jun 19, 2024

View reviewed changes

luacmartins self-requested a review June 19, 2024 17:18

luacmartins approved these changes Jun 19, 2024

View reviewed changes

adamgrzybowski mentioned this pull request Jun 20, 2024

[Search v1] Report screen in RHP is removed from navigation history after navigating to the chat in CentralPane #44001

Merged

50 tasks

luacmartins self-requested a review June 21, 2024 18:52

luacmartins reviewed Jun 21, 2024

View reviewed changes

luacmartins self-requested a review June 21, 2024 18:52

luacmartins requested changes Jun 24, 2024

View reviewed changes

Merge branch 'main' into fix-go-back-centralpane-bottomtab-sync

1db43df

Merge branch 'main' into fix-go-back-centralpane-bottomtab-sync

81a9cbc

adjust condition to work with strict mode

b91b32c

BrtqKr added 2 commits July 8, 2024 14:16

add remaining use cases

a11b734

Merge remote-tracking branch 'origin/main' into fix-go-back-centralpa…

cb087fc

…ne-bottomtab-sync

prettier run

812621e

adamgrzybowski requested a review from luacmartins July 9, 2024 08:26

Kicu mentioned this pull request Jul 9, 2024

Wrong bottom navigation icon is highlighted #44512

Closed

6 tasks

getusha approved these changes Jul 9, 2024

View reviewed changes

luacmartins approved these changes Jul 9, 2024

View reviewed changes

luacmartins merged commit 9dc762d into Expensify:main Jul 9, 2024
15 checks passed

github-actions bot mentioned this pull request Jul 10, 2024

Deploy Checklist: New Expensify 2024-07-10 #45144

Closed

luacmartins mentioned this pull request Jul 22, 2024

[HOLD for payment 2024-07-23] [$250] [Search v1] - App returns to LHN from transaction thread in Search while Search is highlighted #43407

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Search v1] Fix desynchronized bottom tab and central pane after goBack to the Search #43998

[Search v1] Fix desynchronized bottom tab and central pane after goBack to the Search #43998

adamgrzybowski commented Jun 19, 2024

melvin-bot bot commented Jun 19, 2024

adamgrzybowski Jun 19, 2024

luacmartins left a comment

luacmartins commented Jun 19, 2024

adamgrzybowski commented Jun 21, 2024

getusha commented Jun 21, 2024 •

edited

Loading

getusha commented Jun 21, 2024

adamgrzybowski commented Jun 21, 2024

luacmartins commented Jun 21, 2024

luacmartins left a comment

adamgrzybowski commented Jun 24, 2024

luacmartins commented Jun 24, 2024

luacmartins left a comment

luacmartins commented Jun 25, 2024

adamgrzybowski commented Jun 25, 2024

luacmartins commented Jun 27, 2024

adamgrzybowski commented Jun 27, 2024

adamgrzybowski commented Jul 3, 2024

luacmartins commented Jul 3, 2024

getusha commented Jul 4, 2024

adamgrzybowski commented Jul 4, 2024

BrtqKr commented Jul 8, 2024 •

edited

Loading

luacmartins commented Jul 8, 2024

BrtqKr commented Jul 9, 2024

getusha left a comment

OSBotify commented Jul 10, 2024

OSBotify commented Jul 10, 2024

kbecciv commented Jul 10, 2024

OSBotify commented Jul 11, 2024

OSBotify commented Jul 11, 2024

adamgrzybowski commented Jul 12, 2024

OSBotify commented Jul 15, 2024

OSBotify commented Jul 17, 2024

[Search v1] Fix desynchronized bottom tab and central pane after goBack to the Search #43998

[Search v1] Fix desynchronized bottom tab and central pane after goBack to the Search #43998

Conversation

adamgrzybowski commented Jun 19, 2024

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Jun 19, 2024

adamgrzybowski Jun 19, 2024

Choose a reason for hiding this comment

luacmartins left a comment

Choose a reason for hiding this comment

luacmartins commented Jun 19, 2024

adamgrzybowski commented Jun 21, 2024

getusha commented Jun 21, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

getusha commented Jun 21, 2024

adamgrzybowski commented Jun 21, 2024

luacmartins commented Jun 21, 2024

luacmartins left a comment

Choose a reason for hiding this comment

adamgrzybowski commented Jun 24, 2024

luacmartins commented Jun 24, 2024

luacmartins left a comment

Choose a reason for hiding this comment

luacmartins commented Jun 25, 2024

adamgrzybowski commented Jun 25, 2024

luacmartins commented Jun 27, 2024

adamgrzybowski commented Jun 27, 2024

adamgrzybowski commented Jul 3, 2024

luacmartins commented Jul 3, 2024

getusha commented Jul 4, 2024

adamgrzybowski commented Jul 4, 2024

BrtqKr commented Jul 8, 2024 • edited Loading

luacmartins commented Jul 8, 2024

BrtqKr commented Jul 9, 2024

getusha left a comment

Choose a reason for hiding this comment

OSBotify commented Jul 10, 2024

OSBotify commented Jul 10, 2024

kbecciv commented Jul 10, 2024

OSBotify commented Jul 11, 2024

OSBotify commented Jul 11, 2024

adamgrzybowski commented Jul 12, 2024

OSBotify commented Jul 15, 2024

OSBotify commented Jul 17, 2024

getusha commented Jun 21, 2024 •

edited

Loading

BrtqKr commented Jul 8, 2024 •

edited

Loading