[Onboarding - Stage 1] Onboarding Flow

[MaciejSWM]

Details

In order to invoke the Onboarding Flow, replace a button of your choice in the app:

onPress={() => Navigation.navigate(ROUTES.ONBOARDING_PERSONAL_DETAILS)}

Or a direct invoke using URL:
https://dev.new.expensify.com:8082/onboarding

Fixed Issues

$ https://github.com/Expensify/Expensify/issues/351581
PROPOSAL:

Tests

1. Navigate to the onboarding flow by manually navigating to '/onboarding' or overwriting a button.
2. Input a name and a surname in the input fields, press continue button.
3. Click on any of the displayed options and press continue.
4. Verify that a video modal pops up with the app explaination video, if you're on desktop you should also get auto-navigated to the concierge report.
5. Verify that you've received the correct message in the concierge report (it depends on the purpose you've chosen).

• Verify that no errors appear in the JS console

Offline tests

1. Navigate to the onboarding flow by manually navigating to '/onboarding' or overwriting a button.
2. Input a name and a surname in the input fields, press continue button.
3. Click on any of the displayed options and press continue.
4. Instead of a video, the modal should display a lottie animation when in offline mode. The rest of the flow should stay the same.

QA Steps

Account creation -> Name + surname screen

1. Go to staging.new.expensify.com
2. Log in and navigate through Profile > About > Troubleshoot and press the 'Navigate' button next to Onboarding flow label
3. Verify the onboarding modal shows up
4. Verify you land on the Name + surname portion of the onboarding modal
5. Verify there's no 'X' to close the modal
6. Verify modal cannot be dismissed by clicking outside of it or by any other method
7. Verify refreshing the page does not dismiss the modal
8. Verify any input typed in the name and surname fields is kept between page refreshes
9. Verify clicking on Continue presents an error if either name or surname is empty
10. Verify " " (space) is a valid character to put in the name or surname field and it is treated as a valid name/surname (see top-level doc for explanation)
11. Verify clicking Continue takes you to the What do you want to do today? screen if Name + surname fields are correctly filled

Account creation -> Name + surname screen -> What do you want to do today? screen

1. Go to staging.new.expensify.com
2. Log in and navigate through Profile > About > Troubleshoot and press the 'Navigate' button next to Onboarding flow label
3. Fill in name and surname and hit Continue
4. Land on What do you want to do today? screen
5. Verify there's no 'X' to close the modal
6. Verify modal cannot be dismissed by clicking outside of it or by any other method
7. Verify refreshing the page does not dismiss the modal
8. Verify refreshing the page brings you back to the What do you want to do today? screen, as opposed to bringing you back to the Name + surname screen
9. Hitting Continue when no option is selected shows an error
10. Verify only a single option can be selected from multiple options presented
11. Verify chosen option is persisted between page refreshes
12. Verify pressing Back button navigates back to the Name + surname screen, and restores previously input name and surname

Account creation -> Onboarding modal completed -> Chats

1. Go to staging.new.expensify.com
2. Log in and navigate through Profile > About > Troubleshoot and press the 'Navigate' button next to Onboarding flow label
3. Fill in name and surname and hit Continue
4. Select any option in the What do you want to do today? Screen and hit Continue
5. Onboarding modal closes and two things happen almost simultaneously:
6. Concierge message comes in
7. Verify a concierge message is received and the content of this message matches purpose selected in the onboarding modal (see high level for purpose⇔concierge mapping)
8. [Web only] Verify newest message from concierge is opened in the central panel
9. [Mobile only] Verify user lands on the chats screen, but the newest message is not automatically opened
10. Video modal shows up
11. Verify after a small delay video modal is shown
12. Verify video modal can be dismissed at any time by clicking on the grayed out area or by clicking on the Let's go button
13. Verify video autostarts
14. Verify video shows no controls except for the volume slider
15. Verify video shows progress bar in the bottom
16. Verify video can be paused/resumed by clicking anywhere on the video
17. Verify video plays in a loop
18. Verify on page refresh the onboarding video disappears, even if user did not close it explicitly
19. Verify when going offline video keeps playing if it already buffered enough data

Account creation -> Onboarding modal completed -> [Offline mode] Onboarding video

1. Go to staging.new.expensify.com
2. Log in and navigate through Profile > About > Troubleshoot and press the 'Navigate' button next to Onboarding flow label
3. Fill in name and surname and hit Continue
4. Select any option in the What do you want to do today? Screen and hit Continue
5. Onboarding modal closes
6. Verify after a small delay video modal is shown
7. Verify instead of the video, a lottie animation is shown
8. Verify dismissing the onboarding video modal works like in online mode
9. Verify switching from offline to online hides the lottie animation and shows the video. The video starts loading immediately and autoplays. From this point test the video like in online mode.

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

Screenshots/Videos

Android: Native

ANDROID-NATIVE.mov

Android: mWeb Chrome

ANDROID-CHROME.mov

iOS: Native

IOS-NATIVE.mov

iOS: mWeb Safari

IOS-SAFARI.mov

MacOS: Chrome / Safari

CHROME.mov

MacOS: Desktop

DESKTOP.mov

[melvin-bot]

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

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

[mountiny]

Thanks everyone for bringing this across!!!

I am going to go ahead and merge this to unblock the Stage 2 works

[mountiny]

thank you

[OSBotify]

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

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

[OSBotify]

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

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

[OSBotify]

🚀 Deployed to production by https://github.com/Julesssss in version: 1.4.61-8 🚀

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

[allgandalf]

We should had passed one more property numberOfLinesTitle here and set it to 0, this way we would have avoided the truncation of sentence in the onboarding modal, this caused #43804, but i also know that this was a large enough PR and the bug would not have been easily noticed

[hoangzinh]

Coming from #45619, there were some console errors we missed handling when showing the welcome video during the onboarding flow. Details is here #45619 (comment)

[jjcoffee]

Coming from #48930, we missed adding NAVIGATORS.ONBOARDING_MODAL_NAVIGATOR here (exclude from nonModalRoutes and include in modalRoutes):

App/src/libs/Navigation/AppNavigator/createCustomStackNavigator/CustomRouter.ts

Lines 19 to 20 in bbe7d38

	const nonModalRoutes = state.routes.filter((route) => route.name !== NAVIGATORS.RIGHT_MODAL_NAVIGATOR && route.name !== NAVIGATORS.LEFT_MODAL_NAVIGATOR);
	const modalRoutes = state.routes.filter((route) => route.name === NAVIGATORS.RIGHT_MODAL_NAVIGATOR || route.name === NAVIGATORS.LEFT_MODAL_NAVIGATOR);