@swm/navigation refactor

[WoLewicki]

Details

Copy of #18605 with the newest main branch merged.

Fixed Issues

$ #19665

Tests

Most of the regression testing will come from Applause running through the App tests and logging any navigation errors (unusual results). Since there are virtually limitless combinations and flows within the App, we will only create a couple specific ones which we will ask Applause to go through and we can use to test the PRs. We would also ask QA to run full regression on the main PR before we merge these changes.

Note: For all of these, we should test them on all platforms (except resizing on mobile)

Deep link to authenticated page when signed out (pending route)

1. In Notes app for example, write a link to Settings page: https://new.expensify.com/settings
2. Be signed out on the testing device
3. Click on the link
4. Verify you have been navigated to the sign in flow
5. Sign in
6. Verify you have been correctly navigated to the Settings page after signing in

Deep link from notification

1. Have the App in the background on your testing device signed into User A account
2. From User B account, send a message to to User A
3. As user A, click on the new message notification
4. Verify the App has opened and you have been navigated to the correct chat

Correct Back button behavior when deep linking

1. Be signed in to the App on you testing device
2. In Notes app for example, write a link to Settings page: https://new.expensify.com/settings
3. Click on the link and verify you have been navigated to the Setting page
4. Click back button (either in desktop web or Android physical back button)
5. Verify you have been navigated to the Notes app (or wherever you have clicked the link on)

Smooth navigation after resizing

1. On web, in wide layout, sign in and navigate to the Concierge chat
2. Resize the browser window so its narrow enough so it switches to the mobile layout
3. Verify that you are in the Concierge chat
4. Click the UP button
5. Verify you have been navigated to the LHN
6. Navigate to Settings page
7. Resize the window back to wide view
8. Verify the Settings page is open in the RHP
9. Verify you can see the Concierge chat in the background

Verify Up button behavior after navigating to a nested page

1. Send a message which includes this link to someone: https://new.expensify.com/settings/about
2. Click on the link from the message
3. Verify you have been navigated to the About page
4. Click Back button (either browser back button or Android physical back button)
5. Verify you have been navigated back to the chat
6. Click the link again to get to the About page
7. Click the Up button
8. Verify you have been navigated to the Settings page
9. Click the Up button again
10. Verify you have been navigated to the original chat

Test all deep links

Note: We had issues with deep links recently and to prevent this we will add new regression tests which will test all the possible deep link routes in the App. We won't write them down here as it's not tightly connected to the core idea of this doc, but noting it here so we don’t forget about this.

• Verify that no errors appear in the JS console

Offline tests

QA Steps

Same as tests

• 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 / Chrome
  • iOS / native
  • iOS / 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 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 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 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(themeColors.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 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

web.mp4

Mobile Web - Chrome

mobile_chrome.mp4

Mobile Web - Safari

mobile_safari.mp4

Desktop

desktop.mov

iOS

ios.mp4

Android

android.mp4

[0xmiroslav]

These are actually same. We can deprecate one.

[0xmiroslav]

Critical bug on iOS safari:

Arrow navigation doesn't work at all. When click < , it creates new tab instead of going back.

Screen.Recording.2023-06-06.at.10.55.41.PM.mov

[mountiny]

@0xmiroslav Do you have reproduction steps? I cannot seem to reproduce

RPReplay_Final1686085681.mp4

[OSBotify]

🚀 Deployed to staging by https://github.com/mountiny in version: 1.3.25-1 🚀

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

[roryabraham]

Also, why is withWindowDimensions used here? I don't see any uses of the props. Is it just so it re-renders on resize? Or could we remove it?

[adamgrzybowski]

Good catch! I think that may be some leftovers. I am going to remove it and test if everything is working correctly, but it should be okay

[OSBotify]

🚀 Deployed to production by https://github.com/roryabraham in version: 1.3.25-8 🚀

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

[s77rt]

This caused a regression #20709. We should have kept using getNavigationModalCardStyle. We modified this function in #19682 but that change was not caught after we merged main 24d3f34#diff-5b711055e18a2a6ec042cebe121391e826554644d2965d3365250d90d5d39c32

[allroundexperts]

This change caused #22813. The above change worked well in normal flow but when opening through a deep link, the back button wasn't working as expected.