New Feature: Create the UI for Actionable Mention Whispers

[ishpaul777]

Details

Fixed Issues

$ #32741
PROPOSAL: #32741 (comment)

Tests

• Verify that no errors appear in the JS console

1. Make sure you have a DM already between userA and userB and userC. This way their mentions will get autofilled.
2. Create a workspace as userA.
3. Create a room on that workspace with any visibility as userA.
4. As userA, mention userB and userC in a message sent in that room. This should trigger an actionable mention whisper to
   be sent to userA (see mockup below).

5. userA can click "Invite them" or "Do nothing". In both these cases, the actionable mention whisper should disappear after a choice is selected. - If "Invite them" was clicked, both userB and userC should have been invited to the room. - If "Do nothing" was clicked, nothing happens.

Offline tests

QA Steps

• Verify that no errors appear in the JS console

1. Make sure you have a DM already between userA and userB and userC. This way their mentions will get autofilled.
2. Create a workspace as userA.
3. Create a room on that workspace with any visibility as userA.
4. As userA, mention userB and userC in a message sent in that room. This should trigger an actionable mention whisper to
   be sent to userA (see mockup below).

5. userA can click "Invite them" or "Do nothing". In both these cases, the actionable mention whisper should disappear after a choice is selected. - If "Invite them" was clicked, both userB and userC should have been invited to the room. - If "Do nothing" was clicked, nothing happens.

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

Screen.Recording.2024-01-02.at.3.18.44.PM.mov

Android: mWeb Chrome

Screen.Recording.2024-01-02.at.2.08.26.PM.mov

iOS: Native

Screen.Recording.2024-01-02.at.1.12.15.PM.mov

iOS: mWeb Safari

Screen.Recording.2024-01-02.at.1.17.47.PM.mov

MacOS: Chrome / Safari

Screen.Recording.2023-12-21.at.4.30.35.AM-1.mov

MacOS: Desktop

[melvin-bot]

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

[jasperhuangg]

Thanks so much for getting this up! Just did a first pass review and everything looks pretty good other than some minor changes.

[ishpaul777]

Thanks for your time reviewing changes, I'll resolve in few hours 🫡

[jasperhuangg]

Thanks for taking a look! Just a few other things that I think we should fix that I didn't catch earlier.

[jasperhuangg]

All yours @rushatgabhane, thanks!

[jasperhuangg]

@ishpaul777 lint failures:

/home/runner/work/App/App/src/components/ReportActionItem/ActionableItemButtons.tsx
Error:   4:1  error  Import "WithLocalizeProps" is only used as types                          @typescript-eslint/consistent-type-imports
Error:   6:1  error  All imports in the declaration are only used as types. Use `import type`  @typescript-eslint/consistent-type-imports

[jasperhuangg]

@rushatgabhane friendly bump on this review

[rushatgabhane]

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 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 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 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.
• I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native

i give up :(
3 hour build time only to show this error.

Android: mWeb Chrome

iOS: Native

Screen.Recording.2024-01-08.at.19.23.31.mov

iOS: mWeb Safari

MacOS: Chrome / Safari

Screen.Recording.2024-01-08.at.18.59.09.mov

Screen.Recording.2024-01-08.at.18.56.02.mov

MacOS: Desktop

[rushatgabhane]

Bug: the whisper of another user is shown, and it can't be dismissed.

Steps:

1. On web, create workspace as user A.
2. Invite user B
3. As user B, mention user C and invite them.
4. Open iOS app as user A.

Expected: whispers of user B aren't shown to user A.
Actual: whispers of user B can be seen by user A. And they cannot be dismissed

Screen.Recording.2024-01-08.at.19.27.05.mov

[jasperhuangg]

@rushatgabhane strange, that seems like a back-end issue. I'm looking into it.

[github-actions]

🧪🧪 Use the links below to test this adhoc build on Android, iOS, Desktop, and Web. Happy testing! 🧪🧪

Android 🤖	iOS 🍎
❌ FAILED ❌	❌ FAILED ❌
The QR code can't be generated, because the android build failed	The QR code can't be generated, because the iOS build failed
Desktop 💻	Web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/33665/NewExpensify.dmg	https://33665.pr-testing.expensify.com

---

👀 View the workflow run that generated this build 👀

[jasperhuangg]

I'm unable to load the App on Android/iOS locally, and it seems our workflows for AdHoc builds are currently broken.

@rushatgabhane Is there any chance you could insert some logs for userA in your testing steps to see what the reportAction looks like? Also, let me know the time stamps when you're running the tests so I can look into logs. Thanks!

[rushatgabhane]

Yeah sure! gimme a moment

[rushatgabhane]

Timestamp - Tue, 09 Jan 2024 04:47:18 GMT

Logging reportAction for userA that is passed to resolveActionableMentionWhisper().
Let me know if I should log anything else

{
  "reportAction": {
    "actionName": "ACTIONABLEMENTIONWHISPER",
    "actorAccountID": 8392101,
    "automatic": false,
    "avatar": "https://d1wpcgnaa73g0y.cloudfront.net/894b50e60056c966d12216005fbcacec8ce5a2c0.png",
    "created": "2024-01-08 13:29:02.318",
    "isAttachment": false,
    "lastModified": "2024-01-08 13:29:02.318",
    "message": [
      {
        "html": "Heads up, <mention-user accountID=10199254></mention-user> isn't a member of this room.",
        "isDeletedParentAction": false,
        "isEdited": false,
        "text": "Heads up,  isn't a member of this room.",
        "type": "COMMENT",
        "whisperedTo": [
          10199263
        ]
      }
    ],
    "originalMessage": {
      "inviteeAccountIDs": [
        10199254
      ],
      "inviteeEmails": [
        "rushatgabhane@gmail.com"
      ],
      "lastModified": "2024-01-08 13:29:02.318",
      "reportID": 1049615772452361,
      "whisperedTo": [
        10199263
      ]
    },
    "person": [
      {
        "style": "strong",
        "text": "concierge@expensify.com",
        "type": "TEXT"
      }
    ],
    "previousReportActionID": "5717327559065192094",
    "reportActionID": "2037044882738399089",
    "reportActionTimestamp": 1704720542318,
    "shouldShow": true,
    "timestamp": 1704720542,
    "whisperedToAccountIDs": [
      10199263
    ]
  }
}

[jasperhuangg]

Interesting, it looks like the accountID of userA is 14762124, and the actionable mention whisper was only whispered to accountID 10199263, but userA still receives the actionable mention whisper. That seems like a back-end issue that I can look into–I've found the logs where it happens.

Regardless, it doesn't seem like we should block this PR on that, since it isn't related to the changes.

Logs of the report action being sent out for posterity

[jasperhuangg]

@rushatgabhane @ishpaul777 I'm CPing a fix to staging that should solve that issue that was pointed out here, we can retest once it's been deployed, I'll let you know.

[rushatgabhane]

@jasperhuangg LGTM!

bug #33665 (comment) not reproducible anymore

[quinthar]

What's the next step on this; who is it waiting on, and when will it happen?

[ishpaul777]

What's the next step on this; who is it waiting on, and when will it happen?

we are awaiting for final review from @jasperhuangg

[jasperhuangg]

woohoo!

[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 https://github.com/jasperhuangg in version: 1.4.25-0 🚀

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

[OSBotify]

🚀 Deployed to production by https://github.com/mountiny in version: 1.4.25-10 🚀

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

[jasperhuangg]

@ishpaul777 I think I missed this when testing, but the actionable mention whispers are still displaying even after being resolved. I see that the Onyx data is correct, can we update the front-end to filter out resolved actionable mention whispers? Sorry I missed this before!

[ishpaul777]

Sure, I fixed the case in #34560 can you review changes, i didn't realize this was a requirement else i should have fixed in this PR, Sorry!