Perf: PlatormStackNavigation - Use @react-navigation/native-stack on mobile platforms

[kirillzyusko]

Details

Implements a components and types for a PlatformStackNavigation, which uses Stack Navigator on web/desktop/mWeb and Native Stack Navigator on mobile.

There is another PR which migrates the App to use the PlatformStackNavigation API: #49937

Native Stack Navigator provides a way for your app to transition between screens where each new screen is placed on top of a stack. This creates a more natural feel on mobile platforms and improves performance, since native screen transitions don't get blocked if the JS thread is blocked.

This was discussed here: #vip-newdot-performance

Warning

This is a second revision of the implementation. The first one caused a lot of issues, especially when it comes to keyboard appearance on iOS, transition events detection on Android. A successor of #29991

The main difference comparing to the first version of implementation is the fact that now we use native-stack everywhere on mobile. Before, on different stack navigators level we were using different navigators.

Some libraries had to be patched in order for this PR to work:

• feat(iOS): Add slide_from_left transition software-mansion/react-native-screens#2057 <- added slide_from_left transition for Search/Workspace pages
• feat: added integration for InteractionManager with native-stack react-navigation/react-navigation#11887 <- fixed an integration with InteractionManager (used in useSingleExecution hook).
• @react-navigation/core: Exposed types by exporting them and added/adapted some of the generic parameters, so that we can forward navigator's ParamLists
• @react-navigation/native-stack: Add the keyboardHandlingEnabled prop on native-stack
• react-native-screens: Add the ios_from_left animation <- This is already merged upstream but not in any stable release yet

Fixed Issues

$ #37923
$ #29948
PROPOSAL: #29948

Tests

• Open app
• press on search filed
• be sure that:
  • screen transition is from left to right (Android/iOS/mWeb)
  • drawer tranistion is from left to right + content behind drawer is still visible (web)
  • screen search can be loaded (i. e. it's not infinite loading) -> [HOLD for payment 2024-03-07] [Android] infinite loading search screen #37156
• close screen
  • on iOS test that it can be dismissed via gesture from right to left [HOLD for payment 2024-03-14] Gesture to hide the search page should be right to left  #37354 and back button
  • on mWeb iOS it can be dismissed via gesture from left to right and back button
  • on Android can be closed via system gestures and back button
  • on web can be closed via back button
• open any chat
• tap on composer
• go to previous screen
  • on iOS/mWeb iOS do it via gesture from left to right and back button
  • on Android/web do it via back button
• be sure there is no keyboard jumps on previous screen -> [HOLD for payment 2024-06-06] [HOLD #37891] Keyboard jumps around when swiping back from chat to LHN with gesture  #37923
• open chat again
• tap on task
• tap on Assignee
• be sure there is no infinite loading for the screen -> [HOLD for payment 2024-03-07] Android - Task-Tapping assignee shows infinite loading page #37252
• go back to task
• tap on Title
• be sure keyboard is opened automatically -> [HOLD for payment 2024-03-07] [$500] Android - Task - Keyboard does not open after selecting task title #37273
• go back to main page
• tap on user avatar (to open Account settings)
• tap on wallet, tap on "Add bank account"
• tap on "Debit card"
• be sure keyboard gets opened automatically -> [HOLD for payment 2024-03-07] [$500] Android - Wallet - The keyboard does not open automatically when the debit card is opened #37325
• go back to main page
• press "+" in TabBar
• tap Request Money
• enter any amount
• press "Next"
• be sure that on participant screen keyboard appears from the bottom -> [HOLD for payment 2024-03-07] [$500] IOU - Keyboard comes out from right to left on participant screen #37257

Offline tests

Not needed.

QA Steps

• Open app
• press on search field
• be sure that:
  • screen transition is from left to right (Android/iOS/mWeb)
  • drawer tranistion is from left to right + content behind drawer is still visible (web)
  • screen search can be loaded (i. e. it's not infinite loading) -> [HOLD for payment 2024-03-07] [Android] infinite loading search screen #37156
• close screen
  • on iOS test that it can be dismissed via gesture from right to left [HOLD for payment 2024-03-14] Gesture to hide the search page should be right to left  #37354 and back button
  • on mWeb iOS it can be dismissed via gesture from left to right and back button
  • on Android can be closed via system gestures and back button
  • on web can be closed via back button
• open any chat
• tap on composer
• go to previous screen
  • on iOS/mWeb iOS do it via gesture from left to right and back button
  • on Android/web do it via back button
• be sure there is no keyboard jumps on previous screen -> [HOLD for payment 2024-06-06] [HOLD #37891] Keyboard jumps around when swiping back from chat to LHN with gesture  #37923
• open chat again
• tap on task
• tap on Assignee
• be sure there is no infinite loading for the screen -> [HOLD for payment 2024-03-07] Android - Task-Tapping assignee shows infinite loading page #37252
• go back to task
• tap on Title
• be sure keyboard is opened automatically -> [HOLD for payment 2024-03-07] [$500] Android - Task - Keyboard does not open after selecting task title #37273
• go back to main page
• tap on user avatar (to open Account settings)
• tap on wallet, tap on "Add bank account"
• tap on "Debit card"
• be sure keyboard gets opened automatically -> [HOLD for payment 2024-03-07] [$500] Android - Wallet - The keyboard does not open automatically when the debit card is opened #37325
• go back to main page
• press "+" in TabBar
• tap Request Money
• enter any amount
• press "Next"
• be sure that on participant screen keyboard appears from the bottom -> [HOLD for payment 2024-03-07] [$500] IOU - Keyboard comes out from right to left on participant screen #37257

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 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
    • If any non-english text was added/modified, I verified the translation was requested/reviewed 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.js 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 form input styles:
  • I verified that all the inputs inside a form are aligned with each other.
  • I added Design label 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.

Screenshots/Videos

Android: Native

telegram-cloud-document-2-5442872807086113148.mp4

Android: mWeb Chrome

telegram-cloud-document-2-5449560084050887588.mp4

iOS: Native

76cd68bb-6ef8-46d7-9609-cf0ad3964289.mp4

iOS: mWeb Safari

5aa0fca4-72a3-4441-a56f-57da3d095883.mp4

MacOS: Chrome / Safari

a8d30d7e-8aad-4ac0-affe-83ab19584109.mp4

MacOS: Desktop

f6fe3999-d45a-49a2-9e6a-cc5c8e5764d3.mp4

MacOS Chrome (Arc) screen recording attached.

[melvin-bot]

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

[kirillzyusko]

@mountiny I think this PR is ready for review 👀 And from my testing experience - the second version feels much more stable than initial implementation 💪

[mountiny]

@kirillzyusko for easier QA could you please list the test scenarios from the regressions in the PR body? QA will then have easier life once this hits staging

[mountiny]

@cubuspl42 Createing a new build, will you be able to test this one tomorrow?

[github-actions]

🧪🧪 Use the links below to test this adhoc build on Android, iOS, Desktop, and Web. Happy testing! 🧪🧪

Android 🤖	iOS 🍎
https://ad-hoc-expensify-cash.s3.amazonaws.com/android/37891/index.html	https://ad-hoc-expensify-cash.s3.amazonaws.com/ios/37891/index.html
Desktop 💻	Web 🕸️
❌ FAILED ❌	https://37891.pr-testing.expensify.com
The QR code can't be generated, because the Desktop build failed

---

👀 View the workflow run that generated this build 👀

[cubuspl42]

A tough one to review meaningfully. I left one minor comment.

[cubuspl42]

@kirillzyusko I would also appreciate some summary of the testing steps! Especially if you redacted them for clarity.

[kirillzyusko]

@mountiny @cubuspl42 I update test steps 🙌 But you also can test any scenarios that you would like to test 👀

[cubuspl42]

be sure screen transition is from left to right

What I observe: on iOS Native it's right-to-left, on Android Native it's left-to-right. Is this expected? If so, the testing steps should specify it.

[kirillzyusko]

What I observe: on iOS Native it's right-to-left, on Android Native it's left-to-right. Is this expected? If so, the testing steps should specify it.

@cubuspl42 I created a patch for that functionality on iOS, so you'll need to reinstall node_modules and re-assemble app again (because I modified native code). Can you confirm that you did it and still see right-to-left transition on iOS? 👀

[cubuspl42]

My bad! I did as you said, works as expected now in that aspect.

[cubuspl42]

Interestingly, on Android I'm able to go back using a gesture from both sides of the screen. Is it expected?

native-stack-v2-android-compressed.mp4

Actually, always takes two tries. Doesn't feel right.

[kirillzyusko]

Interestingly, on Android I'm able to go back using a gesture from both sides of the screen. Is it expected?

@cubuspl42 Yes. Actually this is system UI and yes, it can be triggered from any horizontal side of the app (i. e. left or right). And it's simply simulation of hardware/software button press (these buttons were widely adopted in Android < 10), but in Android 11 they decided to make navigation bar smaller and replace all buttons (back button/recent apps/home) with gestures.

So when you perform gesture one time - it'll close a keyboard. When you do it a second time - it'll close a screen.

So this is handled on OS level and it's not something that we can prevent (though we can override an action on the gesture and prevent screen from being hidden, but I wouldn't recommend to do that because many android users are using these system gestures to do a quick navigation in the app).

[cubuspl42]

I understand! Makes sense.

[mountiny]

Thanks for chugging along, @cubuspl42 what is your ETA on this one?

[cubuspl42]

I'm resuming the testing, ETA should be < 4h unless something bad is found

[cubuspl42]

@kirillzyusko

You wrote "Not affected" in the Screenshots/Videos on non-Native platforms. Please don't do so in the future in cases like this. Your intention was not to affect these platforms, it's not clear from the change itself that they are not affected.

On a related, but separate topic, the "Tests" sections should be written according to Expensify's "cross-platform 99% of the time" philosophy. Pragmatically speaking, you should note which steps are platform-specfic and you should cover all platforms. Even when it's something as simple as "Ensure that this and this and this interaction (still) works".

[cubuspl42]

Asking about this PR specifcially now: from which side should the search panel enter the screen on mobile web, by design and intention?

[cubuspl42]

On iOS Web, the automatic keyboard opening doesn't work for me. It's not clear if this is a regression or an unrelated known issue. Would you please clarify it?

native-stack-v2-ios-web-compressed.mp4

[ishpaul777]

Sounds like a great plan 👍

[chiragsalian]

• i think we should definitely opt-out of ESLint deprecation checks for this PR, to avoid increasing the scope even more
• Keep this PR as the PR that implements all the code for PlatformStackNavigation, but don't yet change screens and components so that they use the new navigation (which uses native-stack under the hood)
• Create a new PR, which adds all the file changes needed for screens and components to use the new PlatformStackNavigation

These all sound good to me. This way we get things out the door sooner and can build on the pieces iteratively. I'm always a fan of many smaller PRs versus 1 PR to do it all.

[ishpaul777]

Will add bugs from testing in Web In this Comment.

1. RHP animation and positioning is broken

Details

Screen.Recording.2024-09-26.at.12.20.49.AM.mov

2. App crashes when Navigate to bunch of reports in widescreen layout, then resize window to small screen, click back '<' icon until you reach LHN screen click on search icon in bottom tab

Details

Screen.Recording.2024-09-26.at.12.40.09.AM.mov

[chrispader]

Bug 3: After allowing for camera permission in submit expense -> Scan system green light in the notch keeps active unless app is close (Not 100% sure if this is related) reporting since i was not able to reproduce this in staging

This seems to be related to either react-native-vision-camera or react-navigation. Working on fixing this upstream

[mountiny]

Yep, agreed lets split this up to as many small prs as possible and dont worry about the useOnyx check

[ishpaul777]

hey! @mountiny /@chiragsalian can we get new adhoc builds we have few new commits fixing some bugs

[chrispader]

Bug 3: After allowing for camera permission in submit expense -> Scan system green light in the notch keeps active unless app is close (Not 100% sure if this is related) reporting since i was not able to reproduce this in staging

This is now also fixed. There is an issue in [email protected] actually, where the camera session doesn't get de-initialized and recycled, when the (Fabric) view component is unmounted in native-stack. I added a patch file for [email protected].

I created a PR specifically for this change here: #49936

We might want to update react-native-vision-camera to the latest version in a separate PR, since a lot of code regarding New Arch support changed.

[chrispader]

@mountiny @chiragsalian please build new ad-hoc builds from this PR: #49937

[chrispader]

1. RHP animation and positioning is broken

Fixed in 912f01a in #49937

[chrispader]

2. App crashes when Navigate to bunch of reports in widescreen layout, then resize window to small screen, click back '<' icon until you reach LHN screen click on search icon in bottom tab

Fixed in this PR in 225194a