Perf/native stack navigation #29991

hannojg · 2023-10-19T15:34:28Z

Details

Change for the mobile platforms to use the native-stack navigator:

Native Stack Navigator provides a way for your app to transition between screens where each new screen is placed on top of a stack.

With this we will get native screen transitions, which feel better and don't get blocked if the JS thread is blocked.

This was discussed here: #vip-newdot-performance

Changes:

Installed @react-navigation/native-stack
In src/libs/Navigation/PlatformStackNavigation created files for mobile / other platforms that expose the correct navigation package
Adjusted options where needed to use the correct ones.

Note: In some places I didn't explicitly split the options for stack and native-stack usage. Simply because on the native-stack we often times don't need the options that get set, because we rely on the platform default configuration. In addition the names for the options from stack don't exist in native-stack, so they will never really get applied in native-stack.
However, this is more of a design decision. I felt that it will keep the code cleaner, than to separate the options for everything (which means creating two files, where for native it's just an empty object).
Examples of such places:

https://github.com/margelo/expensify-app-fork/blob/27b2a131ccc8d7a9652adc127f67752f6911b447/src/libs/Navigation/AppNavigator/getRootNavigatorScreenOptions.js#L25-L27

Fixed Issues

$ #29948
PROPOSAL: #29948

Tests

Navigate through the app, make sure everything still works

Offline tests

n/a

QA Steps

Navigate through the app, make sure everything still works

PR Author Checklist

Screenshots/Videos

Android: Native

trim.33285B99-69AB-4C2A-A141-B619A4D830C4.MOV

Android: mWeb Chrome

mweb-android.mov

iOS: Native

Simulator_Screen_Recording_-_iPhone_15_Pro_-_2024-02-16_at_17.24.23.mp4

iOS: mWeb Safari

mweb-ios.mp4

MacOS: Chrome / Safari

chrome.mov

MacOS: Desktop

desktop.mov

melvin-bot · 2023-10-19T15:34:35Z

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

…k-navigation

mountiny

cc @adamgrzybowski @WoLewicki could you please review too, look good to me but I think we need to have a discussion about the animations

src/libs/Navigation/AppNavigator/Navigators/Overlay.js

OSBotify · 2023-10-19T18:57:32Z

🧪🧪 Use the links below to test this build in android and iOS. Happy testing! 🧪🧪

android 🤖	iOS 🍎
https://ad-hoc-expensify-cash.s3.amazonaws.com/android/29991/index.html	https://ad-hoc-expensify-cash.s3.amazonaws.com/ios/29991/index.html

desktop 💻	web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/29991/NewExpensify.dmg	https://29991.pr-testing.expensify.com

hannojg · 2023-10-20T11:33:00Z

@mountiny has noted two issues on iOS:

There is a very slight flickering when using the back gesture.
When the keyboard auto opens, and the device is in dark mode, the keyboard has a black background for a short moment.

Flickering issue
Its a native iOS issue, introduced with iOS 17, it is kind of tracked here: react-navigation/react-navigation#11626

There was also this issue on the react-native repo, but it was closed, as its a native iOS issue: facebook/react-native#39411

Native iOS flickering issue (no workaround available):

native-ios-flickering.mp4

Black keyboard
Unfortunately thats also a native iOS issue. I filed a bug report with apple (unfortunately these are private). In the process of creating a tracking ticket at react native or react-navigation!

Native iOS keyboard issue in dark mode (checking if a workaround is possible):

native-ios-black-keybioard.mp4

abdulrahuman5196 · 2023-11-02T14:39:30Z

@hannojg Just gentle check on the status of this issue.

hannojg · 2023-11-02T15:25:53Z

Hey, no update so far, we still have to see if we find a mitigation for the native iOS bugs with keyboard. Unknown timeline for that sorry 🥶

mountiny · 2024-01-25T18:13:22Z

@hannojg Any updates on this one? Could we sync up with main and see how this looks like now?

hannojg · 2024-01-25T18:14:22Z

Kiryl will take this one over next week!!

github-actions · 2024-01-26T18:14:48Z

CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅

kirillzyusko · 2024-01-26T18:24:26Z

I have read the CLA Document and I hereby sign the CLA

kirillzyusko · 2024-01-26T18:24:31Z

recheck

abdulrahuman5196 · 2024-02-21T18:23:21Z

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 approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- 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 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.
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-02-21.at.11.40.39.PM.mp4

Android: mWeb Chrome

Screen.Recording.2024-02-21.at.11.38.25.PM.mp4

iOS: Native

Screen.Recording.2024-02-21.at.11.29.48.PM.mp4

iOS: mWeb Safari

Screen.Recording.2024-02-21.at.11.21.49.PM.mp4

MacOS: Chrome / Safari

Screen.Recording.2024-02-21.at.11.03.01.PM.mp4

MacOS: Desktop

Screen.Recording.2024-02-21.at.11.07.18.PM.mp4

abdulrahuman5196

Changes looks good and works well. Reviewers checklist is also complete.

All yours. @mountiny / @Julesssss

🎀 👀 🎀
C+ Reviewed

OSBotify · 2024-02-22T10:48:17Z

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

OSBotify · 2024-02-26T21:04:17Z

🚀 Deployed to staging by https://github.com/Julesssss in version: 1.4.44-0 🚀

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

situchan · 2024-02-27T11:44:07Z

I suggest to revert this PR until didScreenTransitionEnd issue is fixed in android (either upstream or patch)

kirillzyusko · 2024-02-27T11:55:02Z

@situchan I agree with you - I'll create revert PR soon 👀

kirillzyusko · 2024-02-27T12:48:51Z

@mountiny may I kindly ask you to revert this PR? I think you should have a button "revert" at the bottom of the page?

I'll re-open a PR with all fixes later 👀

situchan · 2024-02-27T13:04:55Z

Straight revert didn't work as there's conflict. Should be reverted manually

…tack-navigation" This reverts commit 5f84683, reversing changes made to d33bf6e.

kirillzyusko · 2024-02-27T14:37:25Z

@situchan @mountiny may I ask you to review these changes? I reverted an original PR + additional fix (I didn't add videos because it's a simple revert).

OSBotify · 2024-02-28T23:52:53Z

🚀 Deployed to production by https://github.com/puneetlath in version: 1.4.44-13 🚀

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

OSBotify · 2024-02-29T00:06:13Z

🚀 Deployed to staging by https://github.com/Julesssss in version: 1.4.45-0 🚀

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

OSBotify · 2024-02-29T23:30:41Z

🚀 Deployed to production by https://github.com/puneetlath in version: 1.4.45-6 🚀

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

hannojg added 5 commits October 19, 2023 14:24

install native-stack

e8f948f

create PlatformStackNavigator with different impls for web & native

b180872

create separate functions

c9b477b

fix right modal options

10179a8

add note about card* property usage

27b2a13

hannojg requested a review from a team as a code owner October 19, 2023 15:34

melvin-bot bot requested review from abdulrahuman5196 and removed request for a team October 19, 2023 15:34

Merge branch 'main' of github.com:Expensify/App into perf/native-stac…

e620d18

…k-navigation

hannojg mentioned this pull request Oct 19, 2023

[$250] LOW: Investigate using native-stack on native platforms instead of stack #29948

Closed

migrate defaultSubRouteOptions

5e5deb4

mountiny assigned hannojg Oct 19, 2023

mountiny added the Ready To Build label Oct 19, 2023

mountiny reviewed Oct 19, 2023

View reviewed changes

src/libs/Navigation/AppNavigator/Navigators/Overlay.js Outdated Show resolved Hide resolved

hannojg added 2 commits October 20, 2023 08:08

change default animation for android

6e49ccf

migrate overlay

08c6181

kirillzyusko added 3 commits January 26, 2024 18:47

Merge branch 'main' into perf/native-stack-navigation

ff0443f

chore: bump to latest version

d0e147e

chore: fixes after merge

21a2dc2

fix: issue#1 with keyboard flickering

50a5c81

abdulrahuman5196 approved these changes Feb 21, 2024

View reviewed changes

melvin-bot bot requested a review from mountiny February 21, 2024 18:58

Julesssss merged commit 5f84683 into Expensify:main Feb 22, 2024
17 checks passed

situchan mentioned this pull request Feb 26, 2024

fix: broken search screen on Android #37155

Merged

49 tasks

github-actions bot mentioned this pull request Feb 26, 2024

Deploy Checklist: New Expensify 2024-02-26 #37224

Closed

youssef-lr mentioned this pull request Feb 27, 2024

[HOLD for payment 2024-03-07] [$500] IOU - Keyboard comes out from right to left on participant screen #37257

Closed

6 tasks

hannojg mentioned this pull request Feb 27, 2024

Investigate workflow job failing on main: e2ePerformanceTests / Run E2E tests in AWS device farm #37070

Closed

s77rt mentioned this pull request Feb 27, 2024

[HOLD for payment 2024-03-07] Android - Task-Tapping assignee shows infinite loading page #37252

Closed

6 tasks

situchan mentioned this pull request Feb 27, 2024

[HOLD for payment 2024-03-07] [$500] Android - Task - Keyboard does not open after selecting task title #37273

Closed

6 tasks

lanitochka17 mentioned this pull request Feb 27, 2024

Web - IOU - There is a delay in sending money #37300

Closed

6 tasks

kirillzyusko added a commit to margelo/expensify-app-fork that referenced this pull request Feb 27, 2024

Revert "Merge pull request Expensify#29991 from margelo/perf/native-s…

a0de651

…tack-navigation" This reverts commit 5f84683, reversing changes made to d33bf6e.

kirillzyusko mentioned this pull request Feb 27, 2024

revert: native stack #37305

Merged

50 tasks

mkhutornyi mentioned this pull request Feb 27, 2024

[$500] iOS - Settings - The keyboard appears with a black background that changes to grey #37301

Closed

6 tasks

This was referenced Feb 28, 2024

[$500] Workspace - The invite message can't fit into the textbox #37406

Closed

[HOLD for payment 2024-03-20] [$500] Settings - I get an "about:blank" page after navigating to the macOS link #37407

Closed

lanitochka17 mentioned this pull request Feb 28, 2024

[$500] Web - Workspace - It's not accepting the SSN for the first time #37442

Closed

6 tasks

github-actions bot mentioned this pull request Feb 28, 2024

Deploy Checklist: New Expensify 2024-02-28 #37459

Closed

91 tasks

mkhutornyi mentioned this pull request Mar 6, 2024

[$500] iOS - Log out - App flashes briefly when logging out #37291

Closed

6 tasks

kirillzyusko mentioned this pull request Mar 12, 2024

[NoQA] Perf: PlatormStackNavigation - Use @react-navigation/native-stack on mobile platforms #37891

Merged

48 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Perf/native stack navigation #29991

Perf/native stack navigation #29991

hannojg commented Oct 19, 2023 •

edited

Loading

melvin-bot bot commented Oct 19, 2023

mountiny left a comment

OSBotify commented Oct 19, 2023

hannojg commented Oct 20, 2023 •

edited

Loading

abdulrahuman5196 commented Nov 2, 2023

hannojg commented Nov 2, 2023

mountiny commented Jan 25, 2024

hannojg commented Jan 25, 2024

github-actions bot commented Jan 26, 2024 •

edited

Loading

kirillzyusko commented Jan 26, 2024

kirillzyusko commented Jan 26, 2024

abdulrahuman5196 commented Feb 21, 2024 •

edited

Loading

abdulrahuman5196 left a comment

OSBotify commented Feb 22, 2024

OSBotify commented Feb 26, 2024

situchan commented Feb 27, 2024

kirillzyusko commented Feb 27, 2024

kirillzyusko commented Feb 27, 2024

situchan commented Feb 27, 2024

kirillzyusko commented Feb 27, 2024

OSBotify commented Feb 28, 2024

OSBotify commented Feb 29, 2024

OSBotify commented Feb 29, 2024

Perf/native stack navigation #29991

Perf/native stack navigation #29991

Conversation

hannojg commented Oct 19, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Oct 19, 2023

mountiny left a comment

Choose a reason for hiding this comment

OSBotify commented Oct 19, 2023

hannojg commented Oct 20, 2023 • edited Loading

abdulrahuman5196 commented Nov 2, 2023

hannojg commented Nov 2, 2023

mountiny commented Jan 25, 2024

hannojg commented Jan 25, 2024

github-actions bot commented Jan 26, 2024 • edited Loading

kirillzyusko commented Jan 26, 2024

kirillzyusko commented Jan 26, 2024

abdulrahuman5196 commented Feb 21, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

abdulrahuman5196 left a comment

Choose a reason for hiding this comment

OSBotify commented Feb 22, 2024

OSBotify commented Feb 26, 2024

situchan commented Feb 27, 2024

kirillzyusko commented Feb 27, 2024

kirillzyusko commented Feb 27, 2024

situchan commented Feb 27, 2024

kirillzyusko commented Feb 27, 2024

OSBotify commented Feb 28, 2024

OSBotify commented Feb 29, 2024

OSBotify commented Feb 29, 2024

hannojg commented Oct 19, 2023 •

edited

Loading

hannojg commented Oct 20, 2023 •

edited

Loading

github-actions bot commented Jan 26, 2024 •

edited

Loading

abdulrahuman5196 commented Feb 21, 2024 •

edited

Loading