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

[Guided Setup: Stage 3] Send the Onboarding Message After Sign-In #46052

Merged

Conversation

cdOut
Copy link
Contributor

@cdOut cdOut commented Jul 23, 2024

Details

Added logic for sending onboarding messages through concierge after sign-in through a magic link sent via email for multiple cases.

Fixed Issues

$ #45044
PROPOSAL:

Tests

Workspace Non-admin:

  1. On the first account create or use an existing worspace
  2. Add a member using an email add an account that you know doesn't exist yet
  3. Make sure the account you've invited is set as just a Member
  4. Proceed to your email and press on the link on the bottom of the invitation email you've received
  5. Confirm that that a Concierge message appears and it shows the correct content, as well as an onboarding video.

Workspace Admin:

  1. On the first account create or use an existing worspace
  2. Add a member using an email add an account that you know doesn't exist yet
  3. Press on the newly invited user and make sure that his role is set to Admin
  4. Proceed to your email and press on the link on the bottom of the invitation email you've received
  5. Confirm that that a Concierge message appears and it shows the correct content, as well as an onboarding video.

DM / Group Chat:

  1. On the first account create or use an existing DM or Group Chat
  2. Add a member using an email add an account that you know doesn't exist yet, in the case of the room you can add by mentioning the user
  3. Proceed to your email and press on the link on the bottom of the invitation email you've received
  4. Confirm that that a Concierge message appears and it shows the correct content, as well as an onboarding video. Make sure the Start a chat is checked off & struck through.

User-created Room:

  1. On the first account create or use an existing user-created room
  2. Add a member using an email add an account that you know doesn't exist yet, do it by mentioning the gmail in the room chat
  3. Proceed to your email and press on the link on the bottom of the invitation email you've received
  4. Confirm that that a Concierge message appears and it shows the correct content, as well as an onboarding video.
  • Verify that no errors appear in the JS console

Offline tests

QA Steps

  • 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

MacOS: Chrome / Safari

Workspace Admin

WEB.WORKSPACE.ADMIN.low.res.mov

Workspace Non-Admin

WEB.WORKSPACE.NON-ADMIN.low.res.mov

@cdOut cdOut marked this pull request as ready for review July 29, 2024 07:38
@cdOut cdOut requested a review from a team as a code owner July 29, 2024 07:38
@melvin-bot melvin-bot bot requested review from getusha and removed request for a team July 29, 2024 07:38
Copy link

melvin-bot bot commented Jul 29, 2024

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

@trjExpensify
Copy link
Contributor

👋 @getusha can you review this one today, please? Thanks!

@getusha
Copy link
Contributor

getusha commented Jul 29, 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

Android: Native

Workspace Admin

screen-recording-2024-09-26-at-45054-in-the-afternoon_GAIw0CSx.mp4

Workspace Non-Admin

Screen.Recording.2024-09-26.at.4.58.14.in.the.afternoon.mov
Android: mWeb Chrome

Workspace Admin

Screenshot 2024-09-26 at 4 38 34 in the afternoon

Workspace Non-Admin

Screenshot 2024-09-26 at 4 24 59 in the afternoon

iOS: Native

Workspace Admin

Screen.Recording.2024-09-26.at.5.11.22.in.the.afternoon.mov
iOS: mWeb Safari

Workspace Admin

Screenshot 2024-09-26 at 4 33 56 in the afternoon

Workspace Non-Admin

Screenshot 2024-09-26 at 4 31 35 in the afternoon

MacOS: Chrome / Safari

Workspace Non-Admin

screen-recording-2024-09-25-at-101910-in-the-morning_QRIpKXNH.mp4

Workspace Admin

Screen.Recording.2024-09-25.at.6.37.21.in.the.evening.mov

User-created Room / DM / Group Chat:

Screenshot 2024-09-25 at 9 47 50 at night

MacOS: Desktop

Workspace Non-Admin

Screenshot 2024-09-26 at 4 29 46 in the afternoon

User-created Room / DM / Group Chat:

Screenshot 2024-09-26 at 4 32 30 in the afternoon

src/CONST.ts Outdated
@@ -4297,7 +4332,7 @@ const CONST = {
type: 'meetGuide',
autoCompleted: false,
title: 'Meet your setup specialist',
description: ({adminsRoomLink}: {adminsRoomLink: string}) =>
Copy link
Contributor

Choose a reason for hiding this comment

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

Why is this?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@kosmydel who originally worked on this wanted to have better typescript checks for the message types so this has been removed in favor of adding a satisfies Record<OnboardingPurposeType, OnboardingMessageType> to the whole message CONST definition just to be clear that the values defined there are correct.

src/libs/actions/Report.ts Outdated Show resolved Hide resolved
src/libs/actions/Report.ts Outdated Show resolved Hide resolved
src/libs/actions/Report.ts Outdated Show resolved Hide resolved
src/libs/actions/Report.ts Outdated Show resolved Hide resolved
@getusha
Copy link
Contributor

getusha commented Jul 30, 2024

Not able to get an invitation email after inviting new member to a workspace, is it working for you? @cdOut

@cdOut
Copy link
Contributor Author

cdOut commented Jul 30, 2024

@getusha I've cleaned up the code after your review.

I did not encounter an issue with receiving the invitation emails, no. Did you check after by logging into the invited account if they are even being properly added to said workspace?

@trjExpensify
Copy link
Contributor

@getusha let me know what email address you used to invite and invited.

@getusha
Copy link
Contributor

getusha commented Jul 30, 2024

Automated Tests

@cdOut Is this planned to be worked on separately? #45044

And lets make sure we are covering the cases in the feature description in test steps.

@cdOut
Copy link
Contributor Author

cdOut commented Jul 30, 2024

Automated Tests
@cdOut Is this planned to be worked on separately? #45044

@deetergp should the automated tests for it be added here or handled separately?

And lets make sure we are covering the cases in the feature description in test steps.

Also I'm fairly sure all the cases are handled in test steps, I've separated them into three different sections.

@deetergp
Copy link
Contributor

deetergp commented Nov 8, 2024

@getusha That pesky console error keeps popping back up and is on the back end. Let's not hold on that.

@getusha
Copy link
Contributor

getusha commented Nov 8, 2024

DM / Group Chat:

  1. On the first account create or use an existing DM or Group Chat
  2. Add a member using an email add an account that you know doesn't exist yet, in the case of the room you can add by mentioning the user
  3. Proceed to your email and press on the link on the bottom of the invitation email you've received
  4. Confirm that that a Concierge message appears and it shows the correct content, as well as an onboarding video. Make sure the Start a chat is checked off & struck through.

Not getting emails for this flow anymore ^, i got one the first time which didn't look right @deetergp

Screenshot 2024-11-08 at 10 07 27 at night

Edit: same with rooms, i tried with different account as well

@trjExpensify
Copy link
Contributor

@trjExpensify the Hey 👋 seems duplicate in the case of admin invitation, does it look fine to you?

Hm, it looks a bit weird. @danielrvidal I'll defer to you though.

@deetergp
Copy link
Contributor

deetergp commented Nov 8, 2024

@getusha For DM & Group Chats, did you add a comment in either chat?

@danielrvidal
Copy link
Contributor

@getusha good find. I think we should remove the "Hey ✋" at the beginning of the admin copy and just start with "As an admin..."

Let's please make that update.

@deetergp
Copy link
Contributor

@getusha To elaborate on my previous comment, for DMs & Group Chats, you might need to add a comment in the chat as the inviting user after inviting the new user, then wait for the normal "notify offline users of activity" time to elapse, which is about 10 minutes. They should get sent immediately, but we have a regression that is preventing that from happening, but it shouldn't hold this PR up. If you do the above and still do not get an invitation, then that's a new regression… But they should send.

@zfurtak
Copy link
Contributor

zfurtak commented Nov 12, 2024

Hi, I updated the admin message and merged latest main. Are we good to merge or do we want to dig into above issues? 🔍

cc: @deetergp @getusha

@blazejkustra
Copy link
Contributor

@getusha Could you finalize Reviewer Checklist? I think we are good to merge this 😄

@deetergp
Copy link
Contributor

@getusha I just went through testing DMs & Group Chat invites and in both cases, I had to add a comment after inviting the new user and then wait ten minutes in order for it to send a notification, but in both cases it sent. In the case of the DM, the link worked and the onboarding messages were created. In the case of Group Chat the link took me to a "Magic code expired" page, which is a regression, but if I signed in again as the user, requesting a new magic code, the onboarding messages were sent.

The regression should not hold us up and will be dealt with separately, let's get this merged!

Copy link
Contributor

@getusha getusha left a comment

Choose a reason for hiding this comment

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

LGTM, thanks!

@melvin-bot melvin-bot bot requested a review from deetergp November 13, 2024 06:10
Copy link
Contributor

@deetergp deetergp left a comment

Choose a reason for hiding this comment

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

Woohoo! LGTM 🎉

@deetergp deetergp merged commit e6b4167 into Expensify:main Nov 13, 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.

Copy link
Contributor

🚀 Deployed to staging by https://github.com/deetergp in version: 9.0.62-0 🚀

platform result
🤖 android 🤖 success ✅
🖥 desktop 🖥 success ✅
🍎 iOS 🍎 failure ❌
🕸 web 🕸 success ✅
🤖🔄 android HybridApp 🤖🔄 failure ❌
🍎🔄 iOS HybridApp 🍎🔄 failure ❌

@IuliiaHerets
Copy link

IuliiaHerets commented Nov 14, 2024

This PR is failing because of issues #52540 and #52546

@blazejkustra
Copy link
Contributor

blazejkustra commented Nov 14, 2024

This PR is failing because of issues #52540 and #52546

@IuliiaHerets These are known issues, check the comment above: #46052 (comment)

@deetergp I'm guessing both are backend issues, so please handle it internally. If you need help on the FE side, let me know 🙇

@deetergp
Copy link
Contributor

@IuliiaHerets Both issues are known, though I don't think we had GHs for them till now, so thanks for that. We will definitely want to add regression tests for both of them. But for now, use the workarounds from the comment @blazejkustra mentioned to verify that the onboarding messages are sent.

Copy link
Contributor

🚀 Deployed to production by https://github.com/mountiny in version: 9.0.62-4 🚀

platform result
🤖 android 🤖 success ✅
🖥 desktop 🖥 success ✅
🍎 iOS 🍎 success ✅
🕸 web 🕸 success ✅
🤖🔄 android HybridApp 🤖🔄 skipped 🚫
🍎🔄 iOS HybridApp 🍎🔄 skipped 🚫


const isInviteOnboardingComplete = introSelected?.isInviteOnboardingComplete ?? false;

if (introSelected && !isInviteOnboardingComplete) {
Copy link
Contributor

@allgandalf allgandalf Nov 25, 2024

Choose a reason for hiding this comment

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

We should had also checked if the onboarding has been completed, this missed implementation caused the messages to be duplicated. This caused #52543

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.

10 participants