App icon indicating copy to clipboard operation
App copied to clipboard
verified publisher icon Expensify

[Onboarding - Stage 1] Onboarding Flow

Open MaciejSWM opened this issue 1 year ago • 54 comments

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).
  • [x] 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

  • [x] I linked the correct issue in the ### Fixed Issues section above
  • [x] I wrote clear testing steps that cover the changes made in this PR
    • [x] I added steps for local testing in the Tests section
    • [x] I added steps for the expected offline behavior in the Offline steps section
    • [x] I added steps for Staging and/or Production testing in the QA steps section
    • [x] I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
    • [x] 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)
    • [x] 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).
  • [x] I included screenshots or videos for tests on all platforms
  • [x] I ran the tests on all platforms & verified they passed on:
    • [x] Android: Native
    • [x] Android: mWeb Chrome
    • [x] iOS: Native
    • [x] iOS: mWeb Safari
    • [x] MacOS: Chrome / Safari
    • [x] MacOS: Desktop
  • [x] 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)
  • [x] I followed proper code patterns (see Reviewing the code)
    • [x] 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)
    • [x] I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
    • [x] I verified that comments were added to code that is not self explanatory
    • [x] 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.
    • [x] I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
      • [x] 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:
    • [x] I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • [x] 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.
    • [x] 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.
    • [x] I verified the JSDocs style guidelines (in STYLE.md) were followed
  • [x] If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • [x] I followed the guidelines as stated in the Review Guidelines
  • [x] 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)
  • [x] I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • [x] 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
  • [x] I verified that if a function's arguments changed that all usages have also been updated correctly
  • [x] If any new file was added I verified that:
    • [x] 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
  • [x] If a new CSS style is added I verified that:
    • [x] A similar style doesn't already exist
    • [x] The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG))
  • [x] 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.
  • [x] 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)
  • [x] 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.
  • [x] 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.
  • [x] If the PR modifies the form input styles:
    • [x] I verified that all the inputs inside a form are aligned with each other.
    • [x] I added Design label so the design team can review the changes.
  • [x] 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.
  • [x] 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

https://github.com/Expensify/App/assets/88325488/e2387481-805e-4552-8599-ebaa3ca9e30f

Android: mWeb Chrome

https://github.com/Expensify/App/assets/88325488/a2d9c716-9b93-463c-aa58-a369b2babcc7

iOS: Native

https://github.com/Expensify/App/assets/88325488/1e14c222-cca8-4507-bf97-0894c9d43498

iOS: mWeb Safari

https://github.com/Expensify/App/assets/88325488/34b2625f-e941-4800-8f8d-8ff37d4fc203

MacOS: Chrome / Safari

https://github.com/Expensify/App/assets/88325488/47479b53-a32a-4c79-a819-95741cffdfc6

MacOS: Desktop

https://github.com/Expensify/App/assets/88325488/9ac435b1-96c2-447a-92ba-831909e43c53

MaciejSWM avatar Mar 05 '24 11:03 MaciejSWM

Hey! I see that you made changes to our Form component. Make sure to update the docs in FORMS.md accordingly. Cheers!

melvin-bot[bot] avatar Mar 05 '24 11:03 melvin-bot[bot]

👋 can you link the draft PR to the correct parent issue for tracking please, @MaciejSWM?

trjExpensify avatar Mar 05 '24 16:03 trjExpensify

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

melvin-bot[bot] avatar Mar 08 '24 20:03 melvin-bot[bot]

Hi @MaciejSWM I found some bugs on Web:

Bug 1: When press outside the modal Expected:

“Please input your first name to continue” - if either input is empty and they press outside the modal, or they press continue “Please press continue to get set up” - if either/both inputs are filled and they press outside the modal

Actual: It selects the "Continue" button text

https://github.com/Expensify/App/assets/9639873/7a6d03ac-c788-4776-9df6-6a060fda880f

Bug 2: The Back button is hidden

https://github.com/Expensify/App/assets/9639873/e219c9de-a986-4050-967a-0575cd5c1892

Bug 3: The loading icon in Global create intro video step is displayed out of the modal

https://github.com/Expensify/App/assets/9639873/19fa1947-da1a-4a40-850a-0c88653afe6e

hoangzinh avatar Mar 09 '24 19:03 hoangzinh

On native Bug 4: [IOS]: Console warning when change playing position

https://github.com/Expensify/App/assets/9639873/ed8c3bfd-7954-4ec0-8b72-4a45e32cbb5b

hoangzinh avatar Mar 09 '24 19:03 hoangzinh

Bug 5: On page refresh, the onboarding video is still showing Expected:

Verify on page refresh the onboarding video disappears, even if user did not close it explicitly

https://github.com/Expensify/App/assets/9639873/05073b16-c748-490d-82ce-a7f6fd58ed64

hoangzinh avatar Mar 09 '24 21:03 hoangzinh

I pushed a version where the old onboarding modal is still shown to the user by default. This newly implemented onboarding flow will be only accessible by a direct URL. Replacement of the old modal and deletion of its code will be part of consecutive PR. This is done so that we can rollout in a calmer way and to reduce PR size

MaciejSWM avatar Mar 11 '24 18:03 MaciejSWM

Bug 5: On page refresh, the onboarding video is still showing Expected:

Verify on page refresh the onboarding video disappears, even if user did not close it explicitly

Screen.Recording.2024-03-10.at.04.32.37.bug.5.mov

@hoangzinh We will go for something different here. We will stay on the video player page if user refreshes the page. Slack thread: https://swmansion.slack.com/archives/C036QM0SLJK/p1710357737464679?thread_ts=1710353718.972939&cid=C036QM0SLJK

MaciejSWM avatar Mar 13 '24 19:03 MaciejSWM

@MaciejSWM please let me know when it's ready for the next review/test

hoangzinh avatar Mar 15 '24 10:03 hoangzinh

@hoangzinh regarding Bug 4 - Michal Skalka confirmed that this warning exists on main as well, so not going to fix it here.

MaciejSWM avatar Mar 18 '24 13:03 MaciejSWM

@hoangzinh ready for re-review

MaciejSWM avatar Mar 18 '24 17:03 MaciejSWM

Hi @MaciejSWM just wanna confirm a requirement here

If the user tries to advance without completing the fields, we’ll show the user the following errors:

  • “Please press continue to get set up” - if either/both inputs are filled and they press outside the modal

Is it still our requirement or we gonna remove it?

hoangzinh avatar Mar 19 '24 12:03 hoangzinh

Bug 1: Failed this test step

In What do you want to do today? screen: Verify an error message shows up if user tries to click outside of the of the modal (content of message in the detailed section)

Bug 2: What do you want to do today? screen still displays + it doesn't navigate to concierge when video modal shows up

https://github.com/Expensify/App/assets/9639873/f7952b45-091d-467b-8529-e8bc7ab4f7ba

Bug 3: Lottie animation is not shown up in Offline mode

https://github.com/Expensify/App/assets/9639873/d86bb4da-fb6c-43aa-b548-2a11eed563a0

hoangzinh avatar Mar 19 '24 12:03 hoangzinh

Hi @MaciejSWM just wanna confirm a requirement here

If the user tries to advance without completing the fields, we’ll show the user the following errors:

  • “Please press continue to get set up” - if either/both inputs are filled and they press outside the modal

Is it still our requirement or we gonna remove it?

Not going to be part of this PR

MaciejSWM avatar Mar 19 '24 19:03 MaciejSWM

Trying to replicate Bug 2 and 3, but seems like at least bug 2 has been tackled previously, have you pulled the latest code changes?

MaciejSWM avatar Mar 19 '24 19:03 MaciejSWM

Commented regarding bug 3 here: https://swmansion.slack.com/archives/C036QM0SLJK/p1710882711522549

Regarding bug 2: Wondering if this is a valid account in the app? It has no concierge chat. I'm trying to come up with a clean solution but everything seems to involve some messy solutions that might just cover an invalid app state.

MaciejSWM avatar Mar 19 '24 22:03 MaciejSWM

Regarding bug 2: I'll prepare the following:

if (!Report.getConciergeChatReportID()) {
            Navigation.resetToHome();
        }

MaciejSWM avatar Mar 19 '24 22:03 MaciejSWM

Ready for re-review. Fixes bug 2, leaves bug 3 as is to be fixed globally

MaciejSWM avatar Mar 19 '24 22:03 MaciejSWM

Haven't done a full review but gave it a spin, it looks really good.

One weird bug I encountered was that the volume slider on the intro video can somehow drag the whole modal around the page:

https://github.com/Expensify/App/assets/2229301/801763e7-50f4-43f9-b0a6-10513e625533

francoisl avatar Mar 20 '24 06:03 francoisl

Pushed a fix @francoisl

MaciejSWM avatar Mar 20 '24 07:03 MaciejSWM

Bug 6: On "What do you want to do today?" screen, unable to go to next step in IOS Safari

Screenshot 2024-03-20 at 21 06 15

hoangzinh avatar Mar 20 '24 14:03 hoangzinh

@MaciejSWM when you're ready, can you add the test and QA steps please?

francoisl avatar Mar 21 '24 18:03 francoisl

@MaciejSWM looks good so far. Could you add QA tests + complete PR checklist? Thanks

hoangzinh avatar Mar 22 '24 14:03 hoangzinh

Thanks @francoisl @hoangzinh. Super good feeling to have it close to merge. Next week I'm on holidays so I'll leave it for @cdOut to fill the checklist + QA steps. Thanks all!

MaciejSWM avatar Mar 22 '24 18:03 MaciejSWM

@cdOut can you please fill out the QA tests and complete PR checklist? It looks like we're pretty close.

danielrvidal avatar Mar 25 '24 16:03 danielrvidal

@cdOut Hi! wIt will be great to merge that because is needed for Stage 2 and we are ready to start implementing that. Maybe is enough to paste steps from the implementation details?

Account creation -> Name + surname screen
Go to staging.new.expensify.com
Register as a new user to the app
Verify the onboarding modal shows up
Verify you land on the Name + surname portion of the onboarding modal
Verify there’s no ‘X’ to close the modal
Verify modal cannot be dismissed by clicking outside of it or by any other method
Verify an error message shows up if user tries to click outside of the of the modal (content of message in the detailed section)
Verify refreshing the page does not dismiss the modal
Verify any input typed in the name and surname fields is kept between page refreshes
Verify clicking on Continue presents an error if either name or surname is empty
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)
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
Go to staging.new.expensify.com
Register as a new user to the app
Fill in name and surname and hit Continue
Land on What do you want to do today? screen
Verify there’s no ‘X’ to close the modal
Verify modal cannot be dismissed by clicking outside of it or by any other method
Verify an error message shows up if user tries to click outside of the of the modal (content of message in the detailed section)
Verify refreshing the page does not dismiss the modal
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
Hitting Continue when no option is selected shows an error
Verify only a single option can be selected from multiple options presented
Verify chosen option is persisted between page refreshes
Verify pressing Back button navigates back to the Name + surname screen, and restores previously input name and surname

Account creation -> Onboarding modal completed -> Chats
Go to staging.new.expensify.com
Register as a new user to the app
Fill in name and surname and hit Continue
Select any option in the What do you want to do today? Screen and hit Continue
Onboarding modal closes and two things happen almost simultaneously:
Concierge message comes in
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)
[Web only] Verify newest message from concierge is opened in the central panel
[Mobile only] Verify user lands on the chats screen, but the newest message is not automatically opened
Video modal shows up
Verify after a small delay video modal is shown
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
Verify video autostarts
Verify video shows no controls
Verify video shows progress bar in the bottom
Verify video can be paused/resumed by clicking anywhere on the video
Verify video plays in a loop
Verify on page refresh the onboarding video disappears, even if user did not close it explicitly
Verify when going offline video keeps playing if it already buffered enough data

Account creation -> Onboarding modal completed -> [Offline mode] Onboarding video
Go to staging.new.expensify.com
Register as a new user to the app
Fill in name and surname and hit Continue
Select any option in the What do you want to do today? Screen and hit Continue
Onboarding modal closes
Verify after a small delay video modal is shown
Verify instead of the video, a lottie animation is shown
Verify dismissing the onboarding video modal works like in online mode
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.

barttom avatar Mar 26 '24 11:03 barttom

@francoisl since I am not the creator of this PR, I am unable to edit the description. I'll put the videos + QA and testing steps here in the comment, I will also send them to you in plaintext and when you have time you can update the description.

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).
  • [x] 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

  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. On wider screens when an overlay is present, make sure pressing it does not disengage the onboarding flow. We require the user to finish providing their full name and a purpose before hiding it. You can however hide the video modal when pressing on the overlay.
  5. 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.
  6. Verify that you've received the correct message in the concierge report (it depends on the purpose you've chosen).
  • [x] Verify that no errors appear in the JS console

Screenshots/Videos

Android: Native

https://github.com/Expensify/App/assets/88325488/e2387481-805e-4552-8599-ebaa3ca9e30f

Android: mWeb Chrome

https://github.com/Expensify/App/assets/88325488/a2d9c716-9b93-463c-aa58-a369b2babcc7

iOS: Native

https://github.com/Expensify/App/assets/88325488/1e14c222-cca8-4507-bf97-0894c9d43498

iOS: mWeb Safari

https://github.com/Expensify/App/assets/88325488/34b2625f-e941-4800-8f8d-8ff37d4fc203

MacOS: Chrome / Safari

https://github.com/Expensify/App/assets/88325488/47479b53-a32a-4c79-a819-95741cffdfc6

MacOS: Desktop

https://github.com/Expensify/App/assets/88325488/9ac435b1-96c2-447a-92ba-831909e43c53

cdOut avatar Mar 26 '24 12:03 cdOut

@barttom thank you but I've already created them so no need. I've retested it again while re-recording videos for all platforms and fixed any remaining style bugs so we should be clear to merge it anytime soon.

cdOut avatar Mar 26 '24 12:03 cdOut

Hi @cdOut why don't we add existing test cases in design doc here https://github.com/Expensify/App/pull/37733#issuecomment-2020198085? I think your QA tests are not fully tested yet.

hoangzinh avatar Mar 26 '24 15:03 hoangzinh

@hoangzinh @cdOut it looks like we're so close! Do you mind outlining a numbered list of the next steps for us to start testing on staging and assign out who is doing each step? Is there any way we can get this on staging today or tomorrow? Let me know how I can help!

danielrvidal avatar Mar 26 '24 16:03 danielrvidal