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

Migrate E/App to use PlatformStackNavigation #49937

Open
wants to merge 81 commits into
base: main
Choose a base branch
from

Conversation

chrispader
Copy link
Contributor

@chrispader chrispader commented Sep 30, 2024

@mountiny @ishpaul777 @chiragsalian

Details

This PR migrates the App to use PlatformStackNavigation types and navigator components implemented in #37891

Fixed Issues

$ #37891
PROPOSAL: #37891 (comment)

Tests

Offline tests

Same as 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: 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.Nov.26.2024.Expensify.Dev.mp4
Android: mWeb Chrome
android.web.webm
iOS: Native
ScreenRecording_11-26-2024.15-56-14_1.MP4
iOS: mWeb Safari

Running mWeb in iOS simulator is currently not possible due to this issue:

Screenshot 2024-11-26 at 16 55 00

MacOS: Chrome / Safari
Screen.Recording.2024-11-26.at.15.32.29.mov
MacOS: Desktop
Screen.Recording.2024-11-26.at.15.43.23.mov

@chrispader chrispader requested a review from a team as a code owner September 30, 2024 14:32
@melvin-bot melvin-bot bot requested review from srikarparsi and removed request for a team September 30, 2024 14:32
Copy link

melvin-bot bot commented Sep 30, 2024

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

@chrispader chrispader changed the title [WIP] Use PlatformStackNavigation in E/App (introduce native-stack navigation on native) [WIP] Use PlatformStackNavigation in E/App (introduce native-stack navigation on mobile) Sep 30, 2024
@chrispader chrispader changed the title [WIP] Use PlatformStackNavigation in E/App (introduce native-stack navigation on mobile) [WIP] Migrate E/App to use PlatformStackNavigation Sep 30, 2024
@chrispader chrispader changed the title [WIP] Migrate E/App to use PlatformStackNavigation [HOLD on #37891] Migrate E/App to use PlatformStackNavigation Sep 30, 2024
@chrispader chrispader force-pushed the @chrispader/use-platform-stack-navigation-in-app branch from 3b921d3 to 5701c46 Compare September 30, 2024 16:30
@srikarparsi
Copy link
Contributor

Re-assigning to @chiragsalian and @mountiny for review since it looks like they have more context.

@chrispader
Copy link
Contributor Author

@mountiny or @chiragsalian please from now on create ad-hoc builds from here. I fixed all remaining reported errors yesterday, so we can probably trigger a new build already.

This comment has been minimized.

@chrispader
Copy link
Contributor Author

The ad-hoc iOS build fail is also going to be related to the patch from #49936

@ishpaul777
Copy link
Contributor

@mountiny Please run adhoc builds here when you have a moment, i plan to work on testing this fully today

@mountiny
Copy link
Contributor

mountiny commented Oct 3, 2024

Running

Copy link
Contributor

github-actions bot commented Oct 3, 2024

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

Android 🤖 iOS 🍎
❌ FAILED ❌ ❌ FAILED ❌
The QR code can't be generated, because the android build failed The QR code can't be generated, because the iOS build failed
Desktop 💻 Web 🕸️
❌ FAILED ❌ https://49937.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 👀

@chrispader
Copy link
Contributor Author

@mountiny Please run adhoc builds here when you have a moment, i plan to work on testing this fully today

The PR didn't have the changes to the react-native-vision-camera patches up until now. Please trigger another set of ad-hoc builds :)

@mountiny
Copy link
Contributor

mountiny commented Oct 4, 2024

Copy link
Contributor

github-actions bot commented Oct 4, 2024

@mountiny
Copy link
Contributor

mountiny commented Oct 4, 2024

Bug on the workspace page
IMG_6525

@mountiny
Copy link
Contributor

mountiny commented Oct 4, 2024

@chrispader Looking great! I think there are two things I have noticed:

  1. There is a noticeable delay of idk 0.5s after clicking on the chat row for the animation to start
  2. The chat finder modal is opening from the bottom, we want to keep the same animation we have now in main - animating from left

Copy link
Contributor

Choose a reason for hiding this comment

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

commenting so this shows on my k2 for easy access

@chrispader
Copy link
Contributor Author

chrispader commented Oct 6, 2024

Bug on the workspace page

@chrispader Looking great! I think there are two things I have noticed:

  1. There is a noticeable delay of idk 0.5s after clicking on the chat row for the animation to start
  2. The chat finder modal is opening from the bottom, we want to keep the same animation we have now in main - animating from left

@mountiny Both bugs are fixed!

I couldn't really see a difference between Stack navigator and Native-Stack while testing in this PR: (you meant when clicking on an item in the Sidebar right?)

Stack

Simulator.Screen.Recording.-.iPhone.15.Pro.-.2024-10-06.at.17.38.30.mp4

Native Stack

Simulator.Screen.Recording.-.iPhone.15.Pro.-.2024-10-06.at.20.09.51.mp4

@chrispader
Copy link
Contributor Author

I will be OOO the next week, but i will hand this over to one of our other Margelo engineers. If there are any urgent issues i can also help with that, but i'm not gonna be on my Macbook unfortunately

@ishpaul777
Copy link
Contributor

ishpaul777 commented Oct 6, 2024

I am now available for around ~2 hours i'll pull and start testing this locally

@ishpaul777
Copy link
Contributor

On it 👀

@ishpaul777
Copy link
Contributor

@mountiny @chrispader Issue is fixed 🎉

@mountiny
Copy link
Contributor

yay

@chrispader
Copy link
Contributor Author

I just fixed the last issue #49937 (comment)

@ishpaul777 please confirm that you're also not experiencing this anymore on web.

@mountiny if @ishpaul777 can confirm that this is fixed, i think we're ready to go for final review and merge! 🚀

Copy link
Contributor

🚧 @mountiny has triggered a test build. You can view the workflow run here.

Copy link
Contributor

@ishpaul777
Copy link
Contributor

@ishpaul777 please confirm that you're also not experiencing this anymore on web.

its Fixed 🎉

@ishpaul777
Copy link
Contributor

ishpaul777 commented Nov 26, 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 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-11-26.at.19.41.49.mp4
Android: mWeb Chrome
Screen.Recording.2024-11-26.at.6.57.27.PM.mov
iOS: Native
trim.BC61141C-924D-481E-BC03-7F725DA08347.MOV
iOS: mWeb Safari
trim.63D7EE78-7F4B-42CD-B132-BDF15FB4ABAB.MOV
MacOS: Chrome / Safari
Screen.Recording.2024-11-26.at.7.12.31.PM-1.mov
MacOS: Desktop
Screen.Recording.2024-11-26.at.7.31.46.PM.mov

Copy link

melvin-bot bot commented Nov 26, 2024

🎯 @ishpaul777, thanks for reviewing and testing this PR! 🎉

An E/App issue has been created to issue payment here: #53130.

@ishpaul777
Copy link
Contributor

@chrispader Will you add demo videos in checklist

@chrispader
Copy link
Contributor Author

@chrispader Will you add demo videos in checklist

will do in a sec

@chrispader
Copy link
Contributor Author

@chrispader Will you add demo videos in checklist

@ishpaul777 @mountiny just added screen recordings for all platforms, covering most navigation flows 👍

@mountiny
Copy link
Contributor

Love it, thanks! We just did a new deploy with the edge-to-edge changes included, I would look into mergring this only once we confirm the next deploy is going fine

Copy link
Contributor

🚧 @mountiny has triggered a test build. You can view the workflow run here.

Copy link
Contributor

Copy link
Contributor

@c3024 c3024 left a comment

Choose a reason for hiding this comment

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

Android: Native
stackAndroid-compressed.mp4
Android: mWeb Chrome
stackAndroidmWeb-compressed.mp4
iOS: Native
stackiOS-compressed.mp4
iOS: mWeb Safari
stackiOSmWeb1-compressed.mp4
stackiOSmWeb2.mp4
MacOS: Chrome / Safari
stackChrome.mp4
MacOS: Desktop
stackDesktop1.mp4
stackDesktop2.mp4

Copy link

melvin-bot bot commented Nov 28, 2024

🎯 @c3024, thanks for reviewing and testing this PR! 🎉

An E/App issue has been created to issue payment here: #53264.

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

Successfully merging this pull request may close these issues.