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

Refactor NewDot and HybridApp onboarding flow #49586

Merged
merged 29 commits into from
Sep 30, 2024

Conversation

blazejkustra
Copy link
Contributor

@blazejkustra blazejkustra commented Sep 23, 2024

Details

HybridApp PR: Adjust OldDot to new fix of NewDot onboarding

While working on #49499, I noticed how complicated the current onboarding logic is:

Current onboarding issues
  • First of all there are two onboarding flows:

    • HybridApp onboarding that displays Explanation Modal - it is triggered from the top file Expensify.tsx with some conditional logic that is unnecessary complicated
      • Once HybridApp onboarding is completed, NewDot onboarding is triggered conditionally, this time from ExplanationModal.tsx
    • NewDot onboarding that displays Onboarding Modal - it is triggered from BottomTabNavigator but only if HybridApp module isn't available (also the logic is quite complex)
  • There is no single source of truth on how onboarding should behave, instead it is scattered across the codebase making this refactor quite hard, these files affect onboarding:

    • Expensify.tsx
    • ExplanationModal.tsx
    • OnboardingModalNavigator.tsx
    • BottomTabBar.tsx
  • Currently we are relying on the backend to change the value for NVP_ONBOARDING, which obviously works in most cases, but when being offline this causes NVP_ONBOARDING to never change even after onboarding completion.

    • But after optimistic update the modal is unmounted right away due to the logic in OnboardingModalNavigator.tsx that returns null when NewDot onboarding is completed
    • Currently the animation only works because the request takes more time than dismissModal
  • NAVIGATORS.ONBOARDING_MODAL_NAVIGATOR is always mounted while the screens inside are rendered conditionally - which is anti-pattern - that's why after consulting with @adamgrzybowski we decided to hide or display the whole navigator from AuthScreens

This PR aims to bring all the logic into one place useOnboardingFlow which controls the whole onboarding flow, making it much more simple.

Fixed Issues

$ #49499
PROPOSAL: N/A

Tests

  • Sign in as a new user, verify that onboarding modal is displayed
    • Verify that the animation is smooth when the modal is dismissed
    • After completing the onboarding verify that you cannot access onboarding anymore (by linking to it)
    • Try different cases, like refreshing when completing onboarding flow
  • Sign in again, verify onboarding isn't displayed
  • Create an account on OldDot, and then login on NewDot, verify onboarding isn't displayed
  • Verify deeplinking, with/without finished onboarding
  • Try to break the onboarding, QAs are great at it 😅

Hybrid App Tests (No QA)

  1. Explanation modal
  • Create an account in NewDot, and finish the onboarding
  • Login on HybridApp, transition from OldDot to NewDot
  • Verify onboarding modal is NOT shown
  • Verify explanation modal is NOT shown
  1. NewDot Onboarding
  • Create an account in NewDot without finishing onboarding
  • Login on HybridApp, transition from OldDot to NewDot
  • Verify onboarding modal is shown
  1. HybridApp explanation modal
  • Create an account in HybridApp
  • Transition from OldDot to NewDot
  • Verify explanation modal is shown

Offline tests

  • Verify the onboarding works well when offline, after completing it and refreshing the page user should no longer see the modal

QA Steps

Same as tests

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

iOS: Native
Simulator.Screen.Recording.-.iPhone.taki.SE.-.2024-09-30.at.16.28.40.mp4
MacOS: Chrome / Safari
Screen.Recording.2024-09-30.at.16.29.13.mov

@allgandalf
Copy link
Contributor

This branch has conflicts @blazejkustra can you take a look

@blazejkustra blazejkustra changed the title Refactor completeOnboarding function to update onboarding status when offline Refactor NewDot and HybridApp onboarding flow Sep 26, 2024
@allgandalf
Copy link
Contributor

However, onboarding changed so much that I wouldn't rely on the Manual Tests section from these 😅

Umm, fair point, I will see testrails just in case we have better coverage there.

My email would be: [email protected]

@mountiny
Copy link
Contributor

Thread for better discussion here

Copy link
Contributor

@lanitochka17
Copy link

If you haven’t already, check out our contributing guidelines for onboarding and email [email protected] to request to join our Slack channel!


Onboarding - App opens /r/undefined when opening onboarding steps after onboarding is done

Version Number: 9.0.40-4
Reproducible in staging?: N
Reproducible in production?: N
If this was caught during regression testing, add the test name, ID and link from TestRail: N/A
Issue reported by: Applause - Internal Team

Action Performed:

  1. Go to https://49586.pr-testing.expensify.com/
  2. Log in with a new gmail account
  3. Select any option on the onboarding modal
  4. Copy https://49586.pr-testing.expensify.com/onboarding/personal-details
    link
  5. Complete the onboarding
  6. Go to https://49586.pr-testing.expensify.com/onboarding/personal-details

Expected Result:

App will return to any report because the onboarding is complete

Actual Result:

App redirects to https://49586.pr-testing.expensify.com/r/undefined
when navigating to onboarding personal details steps after onboarding is complete

Workaround:

Unknown

Platforms:

Which of our officially supported platforms is this issue occurring on?

  • Android: Native
  • Android: mWeb Chrome
  • iOS: Native
  • iOS: mWeb Safari
  • MacOS: Chrome / Safari
  • MacOS: Desktop

Screenshots/Videos

Bug6617639_1727458929014.20240928_013704.mp4
Upwork Automation - Do Not Edit

    @lanitochka17
    Copy link

    lanitochka17 commented Sep 27, 2024

    If you haven’t already, check out our contributing guidelines for onboarding and email [email protected] to request to join our Slack channel!


    Sign in – Blank page opens when log in as a user with 2FA

    Version Number: 9.0.40-4
    Reproducible in staging?: N
    Reproducible in production?: N
    If this was caught during regression testing, add the test name, ID and link from TestRail: N/A
    Issue reported by: Applause - Internal Team

    Action Performed:

    1. Go to https://49586.pr-testing.expensify.com/
    2. Log in as a Gmail user with set up 2FA

    Expected Result:

    Inbox opens

    Actual Result:

    Blank page opens

    Workaround:

    Unknown

    Platforms:

    Which of our officially supported platforms is this issue occurring on?

    • Android: Native
    • Android: mWeb Chrome
    • iOS: Native
    • iOS: mWeb Safari
    • MacOS: Chrome / Safari
    • MacOS: Desktop

    Screenshots/Videos

    Bug6617650_1727459574481.And.1.mp4

    @blazejkustra
    Copy link
    Contributor Author

    Onboarding - App opens /r/undefined when opening onboarding steps after onboarding is done

    This is connected to a bigger regression that was introduced in AuthScreens withOnyx migration.

    After reverting locally it works fine:

    Screen.Recording.2024-09-30.at.15.07.23.mov

    @blazejkustra
    Copy link
    Contributor Author

    Actually it was just reverted, so I'm going to focus on the other error now 👀

    @blazejkustra
    Copy link
    Contributor Author

    blazejkustra commented Sep 30, 2024

    As for the other bug: Sign in – Blank page opens when log in as a user with 2FA

    It's reproducible on the newest main (only on bad internet speed), so I wouldn't say it's connected to this refactor.

    Screen.Recording.2024-09-30.at.15.39.59.mov

    @blazejkustra
    Copy link
    Contributor Author

    blazejkustra commented Sep 30, 2024

    The issue isn't as visible on the main because of the above revert, but it hasn't been fully resolved either.

    Regardless, this PR isn't the source of these bugs, so you can continue reviewing, @allgandalf. 🚀

    Copy link
    Contributor

    @allgandalf allgandalf left a comment

    Choose a reason for hiding this comment

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

    This code looks great, thanks for all the hard work and the refactor, code is so much clearer now, I only have a few comments, I will start with the checklist in the meantime

    src/Expensify.tsx Show resolved Hide resolved
    src/libs/onboardingSelectors.ts Show resolved Hide resolved
    Comment on lines +30 to +31
    // Backend might return strings instead of booleans
    if (typeof completedHybridAppOnboarding === 'string') {
    Copy link
    Contributor

    Choose a reason for hiding this comment

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

    sorry, but why exactly this ? There might be a fixed type right on the BE ? This is a safe typecheck but still thinking 🤔

    Copy link
    Contributor Author

    @blazejkustra blazejkustra Sep 30, 2024

    Choose a reason for hiding this comment

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

    This is copied over from src/libs/actions/Welcome/index.ts, BE sends completedHybridAppOnboarding as a 'true' | 'false' sometimes, and we need to handle them accordingly 😄

    @allgandalf
    Copy link
    Contributor

    allgandalf commented Sep 30, 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

    MacOS: Chrome / Safari
    Screen.Recording.2024-09-30.at.8.14.54.PM.mov
    Screen.Recording.2024-09-30.at.8.22.14.PM.mov
    Screen.Recording.2024-09-30.at.8.20.14.PM.mov
    MacOS: Desktop
    Screen.Recording.2024-09-30.at.8.36.09.PM.mov
    Android: Native
    Screen.Recording.2024-09-30.at.8.43.27.PM.mov
    Android: mWeb Chrome
    Screen.Recording.2024-09-30.at.8.45.37.PM.mov
    iOS: Native
    Screen.Recording.2024-09-30.at.8.37.47.PM.mov
    iOS: mWeb Safari
    Screen.Recording.2024-09-30.at.8.28.40.PM.mov

    Copy link
    Contributor

    @allgandalf allgandalf left a comment

    Choose a reason for hiding this comment

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

    Great work @blazejkustra 🙇 , This looks great to me, lets get the refactor through 🚀

    @blazejkustra
    Copy link
    Contributor Author

    All yours @mountiny @carlosmiceli 🙌

    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.

    Changes look good to me, thanks!

    @mountiny
    Copy link
    Contributor

    We are going to skip the Changed files ESLint check / Changed files ESLint check action because this is already a complicated refactor so additionally migrating to useOnyx would add too much scope and risk of regressions

    @mountiny mountiny merged commit fbe4025 into Expensify:main Sep 30, 2024
    17 of 22 checks passed
    Copy link

    melvin-bot bot commented Sep 30, 2024

    @mountiny looks like this was merged without a test passing. Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

    @mountiny
    Copy link
    Contributor

    Not emergency, explained above

    @OSBotify
    Copy link
    Contributor

    ✋ 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

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

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

    Copy link
    Contributor

    github-actions bot commented Oct 2, 2024

    🚀 Deployed to production by https://github.com/jasperhuangg in version: 9.0.42-3 🚀

    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
    None yet
    Development

    Successfully merging this pull request may close these issues.

    8 participants