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

Tasks for guided setup #39951

Merged
merged 69 commits into from
Apr 21, 2024

Conversation

rezkiy37
Copy link
Contributor

@rezkiy37 rezkiy37 commented Apr 9, 2024

Details

The PR introduces new onboarding flow. The app uses the new API command CompleteGuidedSetup and pass new tasks and message's optimistic data, on behalf of Concierge. After, the app redirects user to root screen.

Fixed Issues

$ #38771
PROPOSAL: N/A

Tests

Note: To test with an existing user, you can initiate the flow from Settings > Troubleshoot > Onboarding Flow.

With the creation of a workspace (Track business expenses..., Manage my team’s...)

  1. Open the app with an entire new user.
  2. Verify that the "What do you want to do today?" modal appears.
  3. Select any tutorial.
  4. Click on "Continue".
  5. Verify that the "What’s your name?" modal appears.
  6. Enter any names.
  7. Click on "Continue".
  8. Verify that the "Where do you work?" modal appears.
  9. Enter any name.
  10. Click on "Continue".
  11. Verify that the app redirects to the home page.
  12. Open the Concierge chat.
  13. Verify that the app has generated the proper messages.
  14. Verify that the app has created a workspace with the previously entered name.
  15. Verify that attachment messages are replaced with videos, once the backend sends an update.

Without the creation of a workspace (others)

  1. Open the app with an entire new user.
  2. Verify that the "What do you want to do today?" modal appears.
  3. Select any tutorial.
  4. Click on "Continue".
  5. Verify that the "What’s your name?" modal appears.
  6. Enter any names.
  7. Click on "Continue".
  8. Verify that the app redirects to the home page.
  9. Open the Concierge chat.
  10. Verify that the app has generated the proper messages.
  11. Verify that attachment messages are replaced with videos, once the backend sends an update.
  • Verify that no errors appear in the JS console

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
Android.mp4
Android: mWeb Chrome
Android.Chrome.mp4
iOS: Native
iOS: mWeb Safari
IOS.Safari.mp4
MacOS: Chrome / Safari
Chrome.Track.mp4
Chrome.Chat.mp4
MacOS: Desktop
Desktop.mp4

barttom and others added 30 commits April 5, 2024 12:52
@rayane-djouah
Copy link
Contributor

rayane-djouah commented Apr 19, 2024

Update:

PR is LGTM, and tests well.

We are waiting now for a response regarding #39951 (comment) and #39951 (comment).
And there are merge conflicts that need to be fixed.

Also, There are known backend bugs #39951 (comment) and #39951 (comment), but these should be NAB for this PR.

@rayane-djouah
Copy link
Contributor

Also, cc'ing @Expensify/design to review the PR

@mountiny
Copy link
Contributor

Also, There are known backend bugs #39951 (comment) and #39951 (comment), but these should be NAB for this PR.

Yep noting these are known

We are moving to using a new NVP: nvp_onboarding and actually I have added it only to the new command as I forgot we have two different commands for now, so in the enablement PR #39687 the onboarding is not considered as done 🤦 once finished, only here since the api command is different.

I think that the changes here are minor and we could merge this first and then retest the enablement of the flow.

@rayane-djouah could you complete the checklist?

Copy link
Contributor

@rayane-djouah rayane-djouah left a comment

Choose a reason for hiding this comment

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

LGTM

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.

Non blocking comments, I would love to get this merged to main before we enable the onboarding flow

@@ -369,7 +369,7 @@ function AuthScreens({session, lastOpenedPublicRoomID, initialLastUpdateIDApplie
/>
<RootStack.Screen
name={NAVIGATORS.ONBOARDING_MODAL_NAVIGATOR}
options={onboardingScreenOptions}
options={screenOptions.fullScreen}
Copy link
Contributor

Choose a reason for hiding this comment

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

This is I assume only for testing now, right?

Copy link
Contributor

Choose a reason for hiding this comment

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

I'm not sure about this one, onboardingScreenOptions come from here

const onboardingScreenOptions = useMemo(() => screenOptions.onboardingModalNavigator(shouldUseNarrowLayout), [screenOptions, shouldUseNarrowLayout]);

Copy link
Contributor

Choose a reason for hiding this comment

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

We can handle that in the follow up PR. thanks

src/libs/actions/Report.ts Show resolved Hide resolved
src/pages/OnboardingWork/BaseOnboardingWork.tsx Outdated Show resolved Hide resolved
@mountiny
Copy link
Contributor

Thank you very much! I have tested this out and we are going to move the finishing touches to the Enablement PR.

I think we need to remove the videos for phase 1

Screen.Recording.2024-04-21.at.22.24.12.mp4

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.

Thanks @fabioh8010 for help ❤️

this PR should not influence the user experience on main. The flow is going to be enabled in this PR #39687 and we are going to work on Monday to clean everything up

@mountiny mountiny merged commit 77a3c12 into Expensify:main Apr 21, 2024
16 checks passed
@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.

@lanitochka17
Copy link

@rezkiy37 Hello
"What do you want to do today?" modal isn't appearing for a new user
Is this not implemented yet or is it a issue?

image
Thank you

@rezkiy37
Copy link
Contributor Author

@rezkiy37 Hello

"What do you want to do today?" modal isn't appearing for a new user

Is this not implemented yet or is it a issue?

image

Thank you

Hey, this flow depends on the backend value. As I know guys are fixing it now.
cc @mountiny

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/mountiny in version: 1.4.64-6 🚀

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

Comment on lines +61 to +64
// Only navigate to concierge chat when central pane is visible
// Otherwise stay on the chats screen.
if (isSmallScreenWidth) {
Navigation.navigate(ROUTES.HOME);
Copy link
Contributor

Choose a reason for hiding this comment

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

@rezkiy37 , why did we navigate to HOME instead of Concierge on small devices ? We have a GH issue here which has expected result that we should always navigate to concierge on all devices, was this intentional ? c.c. @mountiny and @rayane-djouah as they seem to have reviewed the PR

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, it was intentional. The doc says:

In the component OnboardingPurpose we can find a method that sends a message as the Concierge persona. After this action, the user should be able to see the video modal and be navigated to the root screen.

Copy link
Contributor

Choose a reason for hiding this comment

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

Cool thanks a lot 🙏

if (networkTimeSkew > 0) {
return getDBTime(new Date().valueOf() + networkTimeSkew);
return getDBTime(new Date(timestamp).valueOf() + networkTimeSkew);
Copy link
Member

Choose a reason for hiding this comment

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

Looks like this caused an issue #40724 preventing chat to scroll on new messages. When timestamp is not passed new Date('').valueOf() becomes NaN.

Copy link
Contributor

Choose a reason for hiding this comment

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

Thanks!

onyxMethod: Onyx.METHOD.MERGE,
key: `${ONYXKEYS.COLLECTION.REPORT}${targetChatReportID}`,
value: {
lastMentionedTime: DateUtils.getDBTime(),
Copy link
Contributor

Choose a reason for hiding this comment

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

We haven't provided lastVisibleActionCreated optimistically for the target chat Report here, so the Concierge chat can auto scroll to the bottom after onboarding process. #52025

Comment on lines +3786 to +3787
tasks: [
{
Copy link
Contributor

Choose a reason for hiding this comment

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

We did not include selfGuidedTourTask in the tasks if the tour purpose is combinedTrackSubmitOnboardingChoices.PERSONAL_SPEND leading to this issue.

Copy link
Contributor

Choose a reason for hiding this comment

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

@brunovjk Actually, the issue was introduced by this PR: #51153. The tour links did not exist when we implemented this PR.

Copy link
Contributor

Choose a reason for hiding this comment

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

Sorry for that and thanks a lot for tracking. I will post i there

Copy link
Contributor

Choose a reason for hiding this comment

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

No problem! :)

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

Successfully merging this pull request may close these issues.