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.

Sign up for GitHub

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

Jump to bottom

Simplify the RootNavigator structure #42582

Merged
merged 34 commits into from
Jun 25, 2024
Merged

Simplify the RootNavigator structure #42582

merged 34 commits into from
Jun 25, 2024

Conversation

WojtekBoman
Copy link
Contributor

@WojtekBoman WojtekBoman commented May 24, 2024 •
edited
Loading

Details

This PR refactors an approach of storing CentralPane screens in the navigation stack. In the old approach all screens displayed in CentralPane are wrapped by CentralPaneNavigator, in this PR this wrapper has been removed, screens are stored directly in the navigation stack.

Fixed Issues

$ #42507
PROPOSAL:

Tests

  • Verify that no errors appear in the JS console
  • Verify if central pane screens are displayed correctly and animations and deeplinks work fine
    Pages to test:
  • SCREENS.SETTINGS.WORKSPACES,
  • SCREENS.SETTINGS.PREFERENCES.ROOT,
  • SCREENS.SETTINGS.SECURITY,
  • SCREENS.SETTINGS.PROFILE.ROOT,
  • SCREENS.SETTINGS.WALLET.ROOT,
  • SCREENS.SETTINGS.ABOUT,
  • SCREENS.SETTINGS.TROUBLESHOOT,
  • SCREENS.SETTINGS.SAVE_THE_WORLD,
  • SCREENS.SETTINGS.SUBSCRIPTION.ROOT,
  • SCREENS.SEARCH.CENTRAL_PANE,
  • SCREENS.REPORT

Offline tests

QA Steps

  • Verify that no errors appear in the JS console

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 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.

Screenshots/Videos

Android: Native
Screen.Recording.2024-06-04.at.16.09.05.mov
Android: mWeb Chrome
Screen.Recording.2024-06-04.at.16.43.40.mov
iOS: Native
Screen.Recording.2024-06-04.at.16.35.18.mov
iOS: mWeb Safari
Screen.Recording.2024-06-04.at.16.01.39.mov
MacOS: Chrome / Safari
Screen.Recording.2024-06-04.at.14.55.10.mov
MacOS: Desktop
Screen.Recording.2024-06-04.at.15.57.29.mov

@WojtekBoman WojtekBoman changed the title Nav/flatten central pane Simplify the RootNavigator structure May 24, 2024
adamgrzybowski
adamgrzybowski reviewed May 27, 2024
View reviewed changes
src/libs/Navigation/linkTo.ts Outdated
@@ -128,10 +129,10 @@ export default function linkTo(navigation: NavigationContainerRef<RootStackParam
while ((current = root.getParent())) {
root = current;
}
// debugger;
Copy link
Contributor

Choose a reason for hiding this comment

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

🧹

adamgrzybowski
adamgrzybowski reviewed Jun 4, 2024
View reviewed changes
src/components/withPrepareCentralPaneScreen/index.native.tsx
import React from 'react';
import getComponentDisplayName from '@libs/getComponentDisplayName';
import FreezeWrapper from '@libs/Navigation/FreezeWrapper';

Copy link
Contributor

Choose a reason for hiding this comment

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

We probably need some comments here and in the other file about what preparing means for native and web.

adamgrzybowski
adamgrzybowski reviewed Jun 4, 2024
View reviewed changes
src/libs/Navigation/AppNavigator/AuthScreens.tsx Outdated
@@ -284,20 +286,26 @@ function AuthScreens({session, lastOpenedPublicRoomID, initialLastUpdateIDApplie
// eslint-disable-next-line react-hooks/exhaustive-deps
}, []);

const CentralPaneNameOptions = {
Copy link
Contributor

Choose a reason for hiding this comment

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

I am wondering if this name is good for this structure

@adamgrzybowski
Copy link
Contributor

Looks great to me 💪 Good job!

@WojtekBoman WojtekBoman marked this pull request as ready for review June 4, 2024 15:31
@WojtekBoman WojtekBoman requested a review from a team as a code owner June 4, 2024 15:31
@melvin-bot melvin-bot bot requested review from hoangzinh and removed request for a team June 4, 2024 15:31
@melvin-bot Melvin Bot
Copy link

melvin-bot bot commented Jun 4, 2024

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

@WojtekBoman WojtekBoman mentioned this pull request Jun 4, 2024
Closed
@mountiny
Copy link
Contributor

mountiny commented Jun 4, 2024

running a build

@adamgrzybowski
Copy link
Contributor

Hi @dominictb! The test you added recently is failing after our changes. I tested this case manually and it all looks fine. I am trying to figure out what is wrong but I can't figure it out. Could you please take a look? 🙏

@dominictb
Copy link
Contributor

@adamgrzybowski is it urgent? I'll need to wrap up other things before I get back to this.

If it is urgent, I suggest you can temporarily skip the test and we can look into that later?

@adamgrzybowski
Copy link
Contributor

It would be great to merge these changes to avoid more conflicts etc. But maybe we could tackle this test later. @mountiny What do you think?

@hoangzinh
Copy link
Contributor

hoangzinh commented Jun 21, 2024 •
edited
Loading

Confirmed that the fix in PR #42742 still work wells in this PR

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

@mountiny
Copy link
Contributor

@WojtekBoman @adamgrzybowski sorry there is more conflicts

@dominictb it would be great to get this fixd before merging.

@dominictb
Copy link
Contributor

@mountiny @WojtekBoman seems like my PR is reverted here: #44247. So I think you guys can merge this and I'll look into the test as a separate issue. Sorry for blocking you!

@WojtekBoman
Copy link
Contributor Author

@mountiny Conflicts solved and all checks passed :)

mountiny
mountiny previously approved these changes Jun 25, 2024
View reviewed changes
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.

These pesky conflicts

mountiny
mountiny approved these changes Jun 25, 2024
View reviewed changes
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.

Going to merge this to hopefully prevent any other conflicts but lets be on a look out for regressions

@mountiny mountiny merged commit 0bcd005 into Expensify:main Jun 25, 2024
14 checks passed
This was referenced Jun 25, 2024
Closed
Closed
Closed
@jjcoffee jjcoffee mentioned this pull request Jun 25, 2024
Merged
50 tasks
@github-actions github-actions bot mentioned this pull request Jun 25, 2024
Closed
92 tasks
@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/mountiny in version: 9.0.2-0 🚀

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

@roryabraham
Copy link
Contributor

We discovered a potential problem with this PR when it made some automated UI tests that we're adding in another PR start failing.

Actions taken

  1. Open report A
  2. Click link to report B

Expected result

OpenReport is called once for report A and once for reportB

Actual result

OpenReport is called twice for reportA and once for report B.

note: This likely happens because ReportScreen remounts for report A.

@bernhardoj bernhardoj mentioned this pull request Jun 26, 2024
Closed
6 tasks
@yuwenmemon
Copy link
Contributor

This caused the regression here: #44422 (Discussion)

@OSBotify
Copy link
Contributor

OSBotify commented Jul 3, 2024

🚀 Deployed to production by https://github.com/jasperhuangg in version: 9.0.3-7 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/Julesssss in version: 9.0.5-13 🚀

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

ZhenjaHorbach
ZhenjaHorbach reviewed Jul 10, 2024
View reviewed changes
src/libs/Navigation/AppNavigator/CENTRAL_PANE_SCREENS.tsx

type Screens = Partial<Record<CentralPaneName, () => React.ComponentType>>;

const CENTRAL_PANE_SCREENS = {
Copy link
Contributor

@ZhenjaHorbach ZhenjaHorbach Jul 10, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

BugZero Checklist

These changes caused this issue
This issue was caused by invoking withPrepareCentralPaneScreen HOC multiple times in CENTRAL_PANE_SCREENS.tsx

@ZhenjaHorbach ZhenjaHorbach mentioned this pull request Jul 10, 2024
Closed
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@adamgrzybowski adamgrzybowski adamgrzybowski left review comments

@ZhenjaHorbach ZhenjaHorbach ZhenjaHorbach left review comments

@hoangzinh hoangzinh hoangzinh approved these changes

@mountiny mountiny mountiny approved these changes

Assignees

@WojtekBoman WojtekBoman

Labels
Ready To Build
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
9 participants
@WojtekBoman @adamgrzybowski @mountiny @hoangzinh @dominictb @OSBotify @roryabraham @yuwenmemon @ZhenjaHorbach