Link to NewDot concierge from HelpDot

[roryabraham]

Details

• Adds two UI components to the new help site:

  • This card that appears at the bottom of every page:

    

  • This concierge icon that appears in the LHN:

    

• Also adds a utility route in NewDot /concierge that will take you to your concierge chat or the sign in screen if you're not authenticated

Fixed Issues

$ https://github.com/Expensify/Expensify/issues/216743 https://github.com/Expensify/Expensify/issues/216744

Tests

1. Run NewDot web locally and sign in
2. Close the NewDot tab.
3. Run the HelpDot site and go to http://localhost:4000/main.html
4. Click on the concierge icon in the LHN of HelpDot
5. Verify that you are taken to your concierge chat in NewDot in a new tab.
6. Close the NewDot tab.
7. Back in HelpDot, click on Send a message
8. Verify that you are taken to your concierge chat in NewDot in a new tab.
9. Sign out of NewDot and close the tab.
10. Back in HelpDot, click on the concierge icon in the LHN.
11. Verify that you are taken to the NewDot sign-in screen in a new tab.
12. Close the NewDot tab.
13. Back in HelpDot, click on the Send a message
14. Verify that you are taken to the NewDot sign-in screen in a new tab.

• Verify that no errors appear in the JS console

PR Review Checklist

Contributor (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 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 included screenshots or videos for tests on all platforms
• I ran the tests on all platforms & verified they passed on:
  • iOS / native
  • Android / native
  • iOS / Safari
  • Android / Chrome
  • MacOS / Chrome
  • 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 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 was added in all src/languages/* files
  • I verified any copy / text that was added to the app is correct English and approved by marketing by tagging the marketing team 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
• 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 */
  • Any functional components have the displayName property
  • 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 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(themeColors.componentBG)
• 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.
• I have checked off every checkbox in the PR author checklist, including those that don't apply to this PR.

PR Reviewer Checklist

The Contributor+ will copy/paste it into a new comment and complete it after the author checklist is completed

• 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 verified tests pass on all platforms & I tested again on:
  • iOS / native
  • Android / native
  • iOS / Safari
  • Android / Chrome
  • MacOS / Chrome
  • 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 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 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 was added in all src/languages/* files
  • I verified any copy / text that was added to the app is correct English and approved by marketing by tagging the marketing team 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 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 */
  • Any functional components have the displayName property
  • 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 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(themeColors.componentBG)
• 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.
• I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

QA Steps

1. Sign in to New Expensify
2. Close New Expensify
3. Go to https://help.expensify.com/main.html
4. Click on the concierge icon in the LHN of HelpDot
5. Verify that you are taken to your concierge chat in NewDot in a new tab (or in the app, if you're using a mobile device and have the app installed).
6. Close New Expensify
7. Back in HelpDot, click on Send a message
8. Verify that you are taken to your concierge chat in NewDot in a new tab (or in the app, if you're using a mobile device and have the app installed).
9. Sign out of New Expensify.
10. Close New Expensify.
11. Back in HelpDot, click on the concierge icon in the LHN.
12. Verify that you are taken to the NewDot sign-in screen in a new tab (or in the app, if you're using a mobile device and have the app installed).
13. Close New Expensify
14. Back in HelpDot, click on the Send a message
15. Verify that you are taken to the NewDot sign-in screen in a new tab (or in the app, if you're using a mobile device and have the app installed).

• @Expensify/applauseleads also please add these steps to the regression test suite. We normally won't do QA on the Help site, but in this case I think it's valuable to test this flow because it tests a deeplink route into the main app.

• Verify that no errors appear in the JS console

Screenshots

Web

Mobile Web

Desktop

n/a

iOS

n/a

Android

n/a

[roryabraham]

Also cc @johnmlee101 because we were talking about this concierge "utility route" in another context last week. I went ahead and implemented it here, which might save you some trouble in your design doc.

[roryabraham]

Going to tag in @michelle-thompson for a design review too

[michelle-thompson]

For the concierge card on mobile, can we stack all the elements vertically? In other words, can we move the button underneath the copy?

[roryabraham]

Also @michelle-thompson I did what you asked too 🙂

Mobile
iPad
iPad Pro
Desktop

Edit: Fixed the empty LHN bug in the above screenshots:

[amyevans]

LGTM, will let other reviewers chime in

[marcochavezf]

Thanks for working on this Rory! Looks great!

Just a minor issue, the logo in the index and 404 page is a bit broken, but seems it can be fixed here and here by changing id="icon" to class="icon". If you want I can address that change as a follow-up PR (along with the NAB comments that @amyevans added) 🙂

[marcochavezf]

❤️

[roryabraham]

Updated and ready for review

[roryabraham]

@michelle-thompson all yours for another design review 🙂

[OSBotify]

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

[OSBotify]

🚀 Deployed to staging by @michelle-thompson in version: 1.1.90-0 🚀

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

[Beamanator]

Tests passing on Staging 👍

[roryabraham]

This was also deployed to staging. Deploy comments were broken for one cycle