Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 210 commits into from
Oct 9, 2024

Conversation

kirillzyusko
Copy link
Contributor

@kirillzyusko kirillzyusko commented Mar 7, 2024

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:

Fixed Issues

$ #37923
$ #29948
PROPOSAL: #29948

Tests

No specific tests steps as this PR is not putting the new navigator in use yet. The testing will be done here #49937

Offline tests

Not needed.

QA Steps

No specific tests steps as this PR is not putting the new navigator in use yet. The testing will be done here #49937

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.

This comment has been minimized.

Copy link

melvin-bot bot commented Mar 12, 2024

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

@melvin-bot melvin-bot bot requested a review from cubuspl42 March 12, 2024 16:30
@kirillzyusko
Copy link
Contributor Author

@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
Copy link
Contributor

@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
Copy link
Contributor

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

Copy link
Contributor

🧪🧪 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
Android iOS
Desktop 💻 Web 🕸️
❌ FAILED ❌ https://37891.pr-testing.expensify.com
The QR code can't be generated, because the Desktop build failed Web

👀 View the workflow run that generated this build 👀

@cubuspl42
Copy link
Contributor

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

@cubuspl42
Copy link
Contributor

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

@kirillzyusko
Copy link
Contributor Author

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

@cubuspl42
Copy link
Contributor

cubuspl42 commented Mar 14, 2024

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
Copy link
Contributor Author

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
Copy link
Contributor

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

@cubuspl42
Copy link
Contributor

cubuspl42 commented Mar 14, 2024

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
Copy link
Contributor Author

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
Copy link
Contributor

I understand! Makes sense.

@mountiny
Copy link
Contributor

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

@cubuspl42
Copy link
Contributor

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

@cubuspl42
Copy link
Contributor

@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
Copy link
Contributor

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

@cubuspl42
Copy link
Contributor

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

@adamgrzybowski
Copy link
Contributor

I reviewed the PR and I haven't found any change request candidates. Great job! 💪

@ishpaul777
Copy link
Contributor

ishpaul777 commented Oct 8, 2024

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
WhatsApp.Video.2024-10-09.at.1.03.21.AM.mp4
Android: mWeb Chrome
iOS: Native
ScreenRecording_10-09-2024.00-27-42_1.MP4
iOS: mWeb Safari
Screen.Recording.2024-10-08.at.11.46.24.PM.mov
MacOS: Chrome / Safari
Screen.Recording.2024-10-08.at.11.01.55.PM-1.mov
MacOS: Desktop
Screen.Recording.2024-10-09.at.12.53.38.AM-1.mov

native?: NativeOnlyNavigationOptions;

keyboardHandlingEnabled?: boolean;
animation?: 'slide_from_left' | 'slide_from_right' | 'modal' | 'none';
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we have more transition animantions in src/libs/Navigation/PlatformStackNavigation/navigationOptions/animation/index.ts we dont need it here ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ishpaul777 I think this type is used only inside withAnimation function and these 4 types acts as preset (for them we return animation + gesture-direction for example)

So I think they are kind of independent and I didn't refactor this part. Does it make sense?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

okay makes sense, Thanks for clarifying!

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

these options for animation is what the user/developer used in order for the PlatformStackNavigation to translate into platform specific navigation options.

We must keep these props in the type (animations, presentation)

Copy link
Contributor

github-actions bot commented Oct 8, 2024

@melvin-bot melvin-bot bot requested a review from mountiny October 9, 2024 09:53
if (selectedTab === SCREENS.HOME) {
return;
}
const route = activeWorkspaceID ? (`/w/${activeWorkspaceID}/${ROUTES.HOME}` as Route) : ROUTES.HOME;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is possible to put /w/${activeWorkspaceID}/${ROUTES.HOME} on ROUTES.ts?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@fabioh8010 again, I think it's copied/pasted code, so not sure if we need to do that 🙈

And additionally - is it possible to create dynamic routes in ROUTES.ts? Or we want to add two routes and use ternary operator in BottomTabBar.tsx and choose between two routes?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Answered here

// There should always be WORKSPACE.INITIAL screen in the state to make sure go back works properly if we deeplinkg to a subpage of settings.
if (!isAtLeastOneInState(state, SCREENS.WORKSPACE.INITIAL)) {
// @ts-expect-error Updating read only property
// noinspection JSConstantReassignment
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What's the purpose of // noinspection JSConstantReassignment?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@fabioh8010 I think it's a copy-past of another code that was already present in the codebase.

We copied it, so now we have kind of two copies of this code, but I wouldn't worry too much, because in the second PR we will remove the original code 👀

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Answered here

src/types/utils/Substract.ts Outdated Show resolved Hide resolved
@chrispader
Copy link
Contributor

i agree with @kirillzyusko that we shouldn't add extra types for the animations defined in navigationOptions directory. these are platform specific navigation options, the user just has to set animation to one of these (4) variants

Copy link
Contributor

@fabioh8010 fabioh8010 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved from TS side

@kirillzyusko
Copy link
Contributor Author

@mountiny do we wait a review from someone else? 👀

Copy link
Contributor

@mountiny mountiny left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

return slideFromLeft as PlatformSpecificNavigationOptions;
case Animations.SLIDE_FROM_RIGHT:
return slideFromRight as PlatformSpecificNavigationOptions;
case 'modal':
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would be nice to have this as const too

Copy link
Contributor

@chiragsalian chiragsalian left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice, code LGTM. Great work here. Im hype for the performance gains with this 🙂

@chiragsalian
Copy link
Contributor

Gonna proceed and merge to keep this moving. Vit left a minor comment but we can address it in the follow up PR.

@chiragsalian chiragsalian merged commit 00b7426 into Expensify:main Oct 9, 2024
23 checks passed
@OSBotify
Copy link
Contributor

OSBotify commented Oct 9, 2024

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

Copy link
Contributor

github-actions bot commented Oct 9, 2024

🚀 Deployed to staging by https://github.com/chiragsalian in version: 9.0.47-1 🚀

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

@mountiny mountiny changed the title Perf: PlatormStackNavigation - Use @react-navigation/native-stack on mobile platforms [NoQA] Perf: PlatormStackNavigation - Use @react-navigation/native-stack on mobile platforms Oct 10, 2024
Copy link
Contributor

🚀 Deployed to production by https://github.com/thienlnam in version: 9.0.47-4 🚀

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Development

Successfully merging this pull request may close these issues.