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

[Feat] Implement room mention actionable whisper #41406

Merged
merged 11 commits into from
May 6, 2024

Conversation

fedirjh
Copy link
Contributor

@fedirjh fedirjh commented May 1, 2024

Details

cc @rlinoz @rushatgabhane

Fixed Issues

$ #39508
#39546

Tests

  1. Open App and navigate to any chat room
  2. Create a new thread
  3. Tag a non-existing user in the thread
  4. Verify a mention whisper is displayed
  5. Copy the thread id and run this code in the chrome console
async function convertMentionToReport(reportId) {
  const actions = await Onyx.get('reportActions_'+reportId);
  const action = Object.values(actions).filter(({actionName}) => actionName === 'ACTIONABLEMENTIONWHISPER')
  if (action.length) {
    Onyx.merge('reportActions_' + reportId, {
      [action[0].reportActionID]: {
        actionName: 'ACTIONABLEREPORTMENTIONWHISPER'
      }});
  }
}
await convertMentionToReport(id) // thread id from step 5
  1. Verify the whisper buttons are updated
  2. Press create it and verify there is a command call to ResolveActionableReportMentionWhisper
  3. Verify that the whisper disappear
  • 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

Android: Native Screenshot 2024-05-01 at 1 19 14 PM
Android: mWeb Chrome Screenshot 2024-05-01 at 1 16 47 PM
iOS: Native Screenshot 2024-05-01 at 1 14 27 PM
iOS: mWeb Safari Screenshot 2024-05-01 at 1 06 28 PM
MacOS: Chrome / Safari Screenshot 2024-05-01 at 10 22 11 AM
CleanShot.2024-05-01.at.12.32.47.mp4
MacOS: Desktop Screenshot 2024-05-01 at 1 22 12 PM
CleanShot.2024-05-01.at.13.32.21.mp4

…ion in 'Report.ts' by removing redundant message data.
This commit refactors the functions and conditions related to actionable whispers in report actions. The changes aim to improve the code's maintainability by reducing complexity and improving readability, which will make future modifications to this part of the codebase easier.
@rlinoz rlinoz self-requested a review May 1, 2024 13:50
@rlinoz
Copy link
Contributor

rlinoz commented May 1, 2024

Sorry, I updated the GH but forgot about the doc, can we rename to ACTIONABLE_REPORT_MENTION_WHISPER instead of ROOM?

…tion'.

This change occurred in various files across the application, including action handlers, type definitions, API parameters, and translations.
@fedirjh
Copy link
Contributor Author

fedirjh commented May 1, 2024

Sorry, I updated the GH but forgot about the doc, can we rename to ACTIONABLE_REPORT_MENTION_WHISPER instead of ROOM?

@rlinoz I updated all methods and components to reflect the new name. Let me know if that works.

@fedirjh fedirjh marked this pull request as ready for review May 1, 2024 17:42
@fedirjh fedirjh requested a review from a team as a code owner May 1, 2024 17:42
@melvin-bot melvin-bot bot requested review from ishpaul777 and removed request for a team May 1, 2024 17:42
Copy link

melvin-bot bot commented May 1, 2024

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

@ishpaul777
Copy link
Contributor

ishpaul777 commented May 1, 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

WhatsApp Image 2024-05-02 at 1 48 46 AM

Android: mWeb Chrome

WhatsApp Image 2024-05-02 at 1 48 45 AM

iOS: Native Screenshot 2024-05-02 at 1 29 26 AM
iOS: mWeb Safari
Screen.Recording.2024-05-02.at.1.03.35.AM.mov
MacOS: Chrome / Safari
Screen.Recording.2024-05-02.at.1.04.08.AM.mov
MacOS: Desktop
Screen.Recording.2024-05-02.at.2.08.44.AM.mov

@ishpaul777
Copy link
Contributor

ishpaul777 commented May 1, 2024

hey @fedirjh how do i test this for native device? (where do i run the onyx merge command to change ACTIONABLEMENTIONWHISPER to ACTIONABLEREPORTMENTIONWHISPER)

@fedirjh
Copy link
Contributor Author

fedirjh commented May 1, 2024

Hey @ishpaul777 . I just added the code inside the Expensify.js file.

@ishpaul777
Copy link
Contributor

oh okay! but how do you get this whisper if BE is not ready yet

Screenshot 2024-05-02 at 12 33 47 AM

@fedirjh
Copy link
Contributor Author

fedirjh commented May 1, 2024

@ishpaul777 I just built it manually. I cloned the mention whisper report action object and updated the data.

@rlinoz
Copy link
Contributor

rlinoz commented May 1, 2024

Just a quick updated, I am finishing the automated tests in the backend then I will provide a .env so we can test this properly.

Copy link
Contributor

@rlinoz rlinoz left a comment

Choose a reason for hiding this comment

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

It is working pretty well, just some minor things.

src/CONST.ts Outdated Show resolved Hide resolved
src/pages/home/report/ReportActionItem.tsx Outdated Show resolved Hide resolved
src/languages/es.ts Outdated Show resolved Hide resolved
…iles

Replaced 'YES' and 'NO' resolutions for actionable report mentions with 'CREATE' and 'NOTHING' respectively. This improves the clarity of the mentioned actions across the application.
@fedirjh fedirjh requested a review from rlinoz May 2, 2024 18:14
Copy link
Contributor

@rlinoz rlinoz left a comment

Choose a reason for hiding this comment

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

Just one more update, other than that I think we are good!

src/languages/en.ts Outdated Show resolved Hide resolved
@melvin-bot melvin-bot bot requested a review from rlinoz May 3, 2024 19:20
@rlinoz rlinoz merged commit 8962677 into Expensify:main May 6, 2024
15 of 17 checks passed
@OSBotify
Copy link
Contributor

OSBotify commented May 6, 2024

✋ 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
Copy link
Contributor

OSBotify commented May 9, 2024

🚀 Deployed to production by https://github.com/marcaaron in version: 1.4.71-6 🚀

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

@fedirjh fedirjh deleted the room-mention-actionable-whisper branch May 9, 2024 12:43
@ishpaul777
Copy link
Contributor

ishpaul777 commented Aug 12, 2024

👋 This PR introduced the room-mention actionable whispers but we dont hide it from LHN subtext once resolved, this has caused #43737

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.

4 participants