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

Add full screen engagement modal to NewDot #32154

Merged
merged 108 commits into from
Jan 23, 2024

Conversation

stitesExpensify
Copy link
Contributor

@stitesExpensify stitesExpensify commented Nov 28, 2023

Details

Creates a new Engagement Modal that pops up for new users on the site, and sends concierge messages related to their choices

Fixed Issues

$ https://github.com/Expensify/Expensify/issues/335513
$ #33324
PROPOSAL: n/a

Tests

New Account

  1. Create a new account on NewDot
  2. Make sure you see the engagement modal
  3. Choose any option
  4. Make sure that concierge sends you a message based on that option (on mobile, you should be brought to the concierge chat page)
  5. Sign out and back in
  6. Make sure the message is still there and that the modal does not re-appear
  7. Repeat this for all options

Existing Account

  1. Log into an account that is on a workspace already
  2. Make sure that the modal does not appear

Completed on OldDot

  1. Create a new account on OldDot
  2. Wait for the RHP to pop up
  3. Select any option
  4. Sign into newDot on the same account
  5. Make sure that the modal does not appear

Closed on OldDot

  1. Create a new account on OldDot
  2. Wait for the RHP to pop up
  3. Select the x in the top right
  4. Sign into newDot on the same account
  5. Make sure that the modal does not appear

Closed on NewDot

  1. Create a new account on NewDot
  2. Click the x on the modal
  3. Refresh the page
  4. Make sure that the modal does not re-appear
  • Verify that no errors appear in the JS console

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

Android: Native 2023-12-20_10-42-11
Android: mWeb Chrome
iOS: Native 2023-12-19_17-45-26 2023-12-19_17-46-22
iOS: mWeb Safari 2023-12-20_09-46-35
MacOS: Chrome / Safari 2023-12-19_18-20-03 2023-12-19_18-20-32
MacOS: Desktop 2023-12-19_18-29-38 2023-12-19_18-29-43

@situchan
Copy link
Contributor

Looks good except these minor style issues.

We can either add top padding or remove border radius on mWeb

mchrome

Android: modal overlap with status bar

android

iOS looks good:

ios

@marcaaron
Copy link
Contributor

@situchan can you check the reviewer checklist to see why it is failing? Looks like maybe a few more checkboxes have been added.

@situchan
Copy link
Contributor

@situchan can you check the reviewer checklist to see why it is failing? Looks like maybe a few more checkboxes have been added.

It was caused by old checklist which should be removed

Copy link
Contributor

@situchan situchan left a comment

Choose a reason for hiding this comment

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

I think this is expected.
If signup with deeplink (i.e. /settings/preferences), no engagement modal opens. It shows Preferences page directly

Screen.Recording.2024-01-23.at.3.11.21.AM.mov

const navigationState = navigation.getState();
const routes = navigationState.routes;
const currentRoute = routes[navigationState.index];
if (currentRoute && NAVIGATORS.CENTRAL_PANE_NAVIGATOR !== currentRoute.name && currentRoute.name !== SCREENS.HOME) {
Copy link
Contributor

Choose a reason for hiding this comment

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

Can you please add context behind this logic?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

If there is a route, we don't want to show the modal unless the page we're on is home or the central pane navigator

Copy link
Contributor

Choose a reason for hiding this comment

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

ok so #32154 (review) is correct. Just wanted to confirm 🙂

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yep that's correct! Thanks for double checking :)

@melvin-bot melvin-bot bot requested a review from youssef-lr January 22, 2024 21:15
Copy link

melvin-bot bot commented Jan 22, 2024

@youssef-lr 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]

Copy link

melvin-bot bot commented Jan 22, 2024

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

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

@situchan
Copy link
Contributor

My reviewer checklist is ignored because of old one

@Expensify Expensify deleted a comment from bondydaa Jan 23, 2024
@marcaaron
Copy link
Contributor

My reviewer checklist is ignored because of #32154 (comment)

Deleted it (sorry @bondydaa - for posterity, Bondy did a great job with the checklist 💪)

@marcaaron marcaaron removed the request for review from youssef-lr January 23, 2024 03:39
@stitesExpensify stitesExpensify merged commit 74f1163 into main Jan 23, 2024
17 of 22 checks passed
@stitesExpensify stitesExpensify deleted the stites-purposeForExpensify branch January 23, 2024 16:59
@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.

@stitesExpensify
Copy link
Contributor Author

Thank you all for all of the reviews! I'm shipping this as is, I don't think that the minor style issues are worth delaying this any further given we wanted to get this out a long time ago!

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/thienlnam in version: 1.4.31-7 🚀

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

if (!Policy.isAdminOfFreePolicy(allPolicies ?? undefined) && !isDisplayingWorkspaceRoute) {
showCreateMenu();
// we will show the engagement modal.
if (!Policy.isAdminOfFreePolicy(allPolicies ?? undefined) && !isExitingToWorkspaceRoute && !hasSelectedChoice && !hasDismissedModal && Object.keys(allPolicies ?? {}).length === 1) {
Copy link
Contributor

Choose a reason for hiding this comment

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

@stitesExpensify Why do we need to check Object.keys(allPolicies ?? {}).length === 1 in here?

Copy link
Contributor

Choose a reason for hiding this comment

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

Pretty sure it's because everyone should at least have a personal policy. So if you have some other policy on top of that then we're not trying to engage you as a new user.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

^ This

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