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

Update chat with account manager banner #52682

Merged
merged 10 commits into from
Nov 28, 2024

Conversation

mkzie2
Copy link
Contributor

@mkzie2 mkzie2 commented Nov 17, 2024

Explanation of Change

Fixed Issues

$ #51433
PROPOSAL: #51433 (comment)

Tests

  1. Open Concierge chat.
  2. Verify that the banner is updated and displayed correctly.
  • Verify that no errors appear in the JS console

Offline tests

Same

QA Steps

  • Requirement: Have a validated domain admin account

  • Add someone as the “Account Manager” via Concierge tool

  • Have a domain admin log into NewDot and navigate to the Concierge chat

  • Verify there is a “Chat now” button

  • Tap the button and verify they are brought to the chat with the Account Manager

  • 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 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
Screen.Recording.2024-11-18.at.18.04.27.mov
Android: mWeb Chrome
Screen.Recording.2024-11-18.at.18.03.25.mov
iOS: Native
Screen.Recording.2024-11-19.at.00.53.49.mov
iOS: mWeb Safari
Screen.Recording.2024-11-19.at.00.59.59.mov
MacOS: Chrome / Safari
Screen.Recording.2024-11-18.at.16.14.23.mov
MacOS: Desktop
Screen.Recording.2024-11-19.at.01.03.30.mov

@danielrvidal
Copy link
Contributor

danielrvidal commented Nov 18, 2024

@allgandalf was asking for help on the translation but their proposal works great for the translation:

en: Need something specific? Chat with your account manager
es: ¿Necesitas algo específico? Habla con tu gerente de cuenta.
en: Chat now
es: Chatear ahora

@allgandalf
Copy link
Contributor

@mkzie2 do you think you can get this one ready for review today?

@mkzie2 mkzie2 marked this pull request as ready for review November 19, 2024 10:16
@mkzie2 mkzie2 requested review from a team as code owners November 19, 2024 10:16
@melvin-bot melvin-bot bot requested review from allgandalf and removed request for a team November 19, 2024 10:16
Copy link

melvin-bot bot commented Nov 19, 2024

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

@mkzie2
Copy link
Contributor Author

mkzie2 commented Nov 19, 2024

@allgandalf This PR is ready.

@shawnborton
Copy link
Contributor

I don't think the banner is supposed to have a hover state:
CleanShot 2024-11-19 at 05 20 06@2x

Let's check with the @Expensify/design though, but I think we should remove that (no background color change, don't change the color of the icon either).

Also from @dannymcclain 's mock, it looks like maybe the gap between the green button and the close icon should be slightly larger (add 4px more). Here is the mock:
image

@allgandalf
Copy link
Contributor

@mkzie2 please make the changes ^ and then perhaps we should run an AdHoc build to test better @shawnborton ?

@allgandalf
Copy link
Contributor

@mkzie2 why do we go to self-dm when we click chat to accounts manager?

Also testing steps are not clear, will this banner appear forever ?

Copy link
Contributor

@allgandalf allgandalf left a comment

Choose a reason for hiding this comment

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

Please address the feedback

src/components/Banner.tsx Outdated Show resolved Hide resolved
src/languages/params.ts Outdated Show resolved Hide resolved
src/pages/home/ReportScreen.tsx Show resolved Hide resolved
src/pages/home/ReportScreen.tsx Outdated Show resolved Hide resolved
src/pages/home/ReportScreen.tsx Outdated Show resolved Hide resolved
src/pages/home/ReportScreen.tsx Outdated Show resolved Hide resolved
src/pages/home/ReportScreen.tsx Outdated Show resolved Hide resolved
src/pages/home/ReportScreen.tsx Outdated Show resolved Hide resolved
src/styles/index.ts Show resolved Hide resolved
@mkzie2
Copy link
Contributor Author

mkzie2 commented Nov 19, 2024

@allgandalf Regarding #52682 (comment), I mocked accountManagerReportID to be self DM report ID, so in the screenshots the button navigates to self DM.

@allgandalf
Copy link
Contributor

Please read the expected behaviour below:

Screenshot 2024-11-19 at 4 24 48 PM

@mkzie2
Copy link
Contributor Author

mkzie2 commented Nov 19, 2024

@allgandalf I updated.

Please read the expected behaviour below:

I only mocked accountManagerReportID to be self DM, not changing any logics in open account manager report. In the case account has an actual AM, it should work correctly.

@allgandalf
Copy link
Contributor

@marcaaron how do we get to the AM DM on development? current we get directed to self-dm

@marcaaron
Copy link
Contributor

@marcaaron how do we get to the AM DM on development? current we get directed to self-dm

Looks like there's an ONYXKEYS.ACCOUNT_MANAGER_REPORT_ID. We can set that to be a reportID of a random 1:1 chat or something to that effect?

@allgandalf
Copy link
Contributor

@marcaaron @shawnborton can any of you trigger an ADHOC build please, lets test this

@shawnborton
Copy link
Contributor

Will run the test build now for you 🚀

Copy link
Contributor

🚧 @shawnborton has triggered a test build. You can view the workflow run here.

@allgandalf
Copy link
Contributor

@mkzie2 can you please share a reproducible steps video on the ad hoc build showing how to bring the banner up and the redirection to chat please

@mkzie2
Copy link
Contributor Author

mkzie2 commented Nov 21, 2024

@marcaaron How can we create an account with an account manager cc @allgandalf

@marcaaron
Copy link
Contributor

I'm confused by the question. Can we not use the trick that I mentioned already and set any reportID manually in the Onyx data?

@marcaaron
Copy link
Contributor

@allgandalf @mkzie2 let's pull out the stops here?

Having this show up is not so easy because you need a validated private domain and we would also need to add an account manager for you. We likely have test accounts for internal use. @danielrvidal might be able to set something up for us, but I'd recommend just hardcoding something for test purposes and then we can send this to QA for further testing.

@mkzie2
Copy link
Contributor Author

mkzie2 commented Nov 21, 2024

@mkzie2 can you please share a reproducible steps video on the ad hoc build showing how to bring the banner up and the redirection to chat please

@marcaaron C+ is requesting me for testing on the ad hoc build why I'm asking about this question. About the dev env, yeah we can test by hardcoding.

@allgandalf
Copy link
Contributor

We likely have test accounts for internal use.

All cool, I will complete the checklist then, thanks :))

@danielrvidal
Copy link
Contributor

@allgandalf are you all good to keep making progress or do you need anything from me?

@allgandalf
Copy link
Contributor

@allgandalf are you all good to keep making progress or do you need anything from me?

All good, i was waiting for a comment to get addressed, completing the checklist now

@allgandalf
Copy link
Contributor

allgandalf commented Nov 26, 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 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 Screenshot 2024-11-26 at 4 45 44 PM
Android: mWeb Chrome Screenshot 2024-11-26 at 4 46 48 PM
iOS: Native Screenshot 2024-11-26 at 4 40 32 PM
iOS: mWeb Safari Screenshot 2024-11-26 at 4 41 42 PM
MacOS: Chrome / Safari Screenshot 2024-11-26 at 4 33 50 PM
MacOS: Desktop Screenshot 2024-11-26 at 4 38 05 PM

@allgandalf
Copy link
Contributor

@mkzie2 please update the QA steps to have the following:

Precondition:

  • The logged in account should have account Manager assigned

@allgandalf
Copy link
Contributor

Also please mark this PR as : [Internal QA]

Copy link
Contributor

@allgandalf allgandalf left a comment

Choose a reason for hiding this comment

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

Design wise LGTM, lets internal QA this and check the functionality 🚀

@melvin-bot melvin-bot bot requested a review from marcaaron November 26, 2024 11:17
@@ -113,6 +115,9 @@ function ReportScreen({route, currentReportID = '', navigation}: ReportScreenPro
const [modal] = useOnyx(ONYXKEYS.MODAL);
const [isComposerFullSize] = useOnyx(`${ONYXKEYS.COLLECTION.REPORT_IS_COMPOSER_FULL_SIZE}${reportIDFromRoute}`, {initialValue: false});
const [accountManagerReportID] = useOnyx(ONYXKEYS.ACCOUNT_MANAGER_REPORT_ID, {initialValue: ''});
// If accountManagerReportID is an empty string, using ?? can crash the app.
// eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing
Copy link
Contributor

Choose a reason for hiding this comment

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

@marcaaron we needed to do this because accountManagerReportID can be an empty string which is a valid string in javascript, using ?? would have never fallen us back to -1

Copy link
Contributor

@marcaaron marcaaron left a comment

Choose a reason for hiding this comment

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

LGTM but let's fix all the abbreviations and change "am" to "accountManager" wherever it appears.

@@ -39,6 +39,7 @@ import type {
ChangeTypeParams,
CharacterLengthLimitParams,
CharacterLimitParams,
ChatWithAMParams,
Copy link
Contributor

Choose a reason for hiding this comment

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

I would prefer if this was ChatWithAccountManagerParams and everywhere else we do am changed to accountManager

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@marcaaron I updated.

Copy link
Contributor

@marcaaron marcaaron left a comment

Choose a reason for hiding this comment

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

Amazing, thanks for the changes!

@marcaaron marcaaron merged commit 10a7be8 into Expensify:main Nov 28, 2024
17 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/marcaaron in version: 9.0.68-0 🚀

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

@kavimuru
Copy link

@mountiny is this internal QA #52682 (comment)?

@allgandalf
Copy link
Contributor

allgandalf commented Nov 28, 2024

Yes this one is Internal QA, sorry for not updating the title :) I asked this to be marked as Internal here but couldn't follow up c.c. @marcaaron

@mountiny mountiny added the InternalQA This pull request required internal QA label Nov 29, 2024
@mountiny
Copy link
Contributor

Seems like the internal QA is quite tricky, the changes are quite simple so I feel like we do not have to hold deploy on this in case the QA is not by the time to deploy

Copy link
Contributor

🚀 Deployed to production by https://github.com/mountiny in version: 9.0.68-7 🚀

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
InternalQA This pull request required internal QA Ready To Build
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants