Adds support for mentions in room description #45352

rlinoz · 2024-07-12T19:23:55Z

Details

Fixed Issues

#45425
PROPOSAL:

Tests

Create a room
Update the room description mentioning a report and a user, like join #announce and contact @[email protected]
Verify the comment with the description has the report and the user names

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

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

…tion-room-description

github-actions · 2024-07-16T21:49:00Z

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

Android 🤖	iOS 🍎
https://ad-hoc-expensify-cash.s3.amazonaws.com/android/45352/index.html	https://ad-hoc-expensify-cash.s3.amazonaws.com/ios/45352/index.html

Desktop 💻	Web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/45352/NewExpensify.dmg	https://45352.pr-testing.expensify.com

👀 View the workflow run that generated this build 👀

melvin-bot · 2024-07-17T12:11:18Z

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

c3024 · 2024-07-17T13:51:27Z

@rlinoz

This is not related to the changes in this PR but accountID is shown as the user name because here

App/src/libs/Parser.ts

Line 18 in 3710936

    
           accountIDToNameMap[personalDetails.accountID] = personalDetails.login ?? String(personalDetails.accountID);

we are considering only login and accountID even though the displayName, firstName and lastName might be available in personalDetails.

Shall we create an issue for that and fix it before merging the present PR? Or shall we continue working on this and merging this ignoring that?

rlinoz · 2024-07-17T13:57:26Z

Can you help me with reproduction steps? I think it should be fine to fix it in this PR

c3024 · 2024-07-17T14:09:45Z

Change the room description to something that contains a login of a user (who has their name setup) with whom you don't have a chat with already.
The description message shows Hidden now.
Click on the mention below the Welcome to <roomName>
Click on Message in the RHP
Now the names are fetched
Go back to the room
See that the username is shown as accountID

mentionAccountID.mp4

c3024 · 2024-07-17T16:16:32Z

Noting another backend bug here.

The description added at the time of room creation is not saved. Backend resets the description.

Repro steps:

Start Chat > Room > Input some description > Create Room
There is no description below the room the report screen
Click on Header to go to room details page
There is no description here

roomDescriptionWhenCreating.mp4

c3024 · 2024-07-17T16:24:13Z

Tests do not match the changes made in this PR.

The test sis for updating room description and for updating room description, the reportID is already passed to getParsedComment.

RoomDescriptionPage uses this

App/src/pages/RoomDescriptionPage.tsx

Line 46 in da6c35b

    
           Report.updateDescription(report.reportID, report?.description ?? '', description.trim());

and further this

App/src/libs/actions/Report.ts

Line 1996 in da6c35b

const parsedDescription = ReportUtils.getParsedComment(newValue, {reportID});

IMO tests for this PR should be for setting/updating the workspace descriptions and setting the description when creating a room.

…tion-room-description

rlinoz · 2024-07-17T17:13:09Z

I agree I should have updated the updateWorkspaceDescription, let me undo that.

As for creating a new room, we have a bug currently where the description comes back empty, which makes it weird to test it here. The backend PR is fixing that and the test step for that will be there.

But when updating the room description we would get the mention HTML in the update message instead of the mention, so that is why the testing steps are for update.

rlinoz · 2024-07-17T18:33:54Z

The bug with the accountID should be fixed now.

c3024 · 2024-07-18T02:01:27Z

Just checked why login was used here at all. Here @war-in changed it to login instead of displayName.

I think this is useful when copying and pasting the message and the mention is correctly parsed in the composer.

mentionLost.mp4

We use LocalePhoneNumber.formatPhoneNumber for getEffectiveDetails. This breaks the phone number with a space and the parsing of the phone number for the copy paste does not work.

I think we should change the getEffectiveDetails to

return Str.removeSMSDomain(personalDetail?.login ?? '') || personalDetail.displayName;

…tion-room-description

rlinoz · 2024-07-18T21:49:44Z

Interesting, you get different results than I do

As for the copy to clipboard we have that problem in normal comments, we should address that instead of not using the display name, since that is needed sometimes.

Anyway, I will take a better look into all of this tomorrow.

…tion-room-description

rlinoz · 2024-07-29T18:24:30Z

@c3024 I tested the latest version with the same phone number you were using and it seems to work now, we only return the @expensify.sms domain from getEffectiveDisplayName when we don't understand the phone number as a valid one, so maybe something got fixed..

Anyway, I think we only have the copy to clipboard problem, but we already have the same problem if mentioning a SMS user in any comment, so I think we should address that in another issue.

rlinoz · 2024-07-30T19:50:13Z

Ok, I think we are good in every instance here now, let me know if you find anything @c3024

c3024 · 2024-07-31T14:31:04Z

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

mentionAndroid.mov

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

c3024

LGTM!

melvin-bot · 2024-07-31T14:33:30Z

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

melvin-bot · 2024-07-31T14:33:33Z

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

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

Gonals

Tests well! Let's do this!

OSBotify · 2024-07-31T16:21:31Z

✋ 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 · 2024-07-31T19:30:46Z

🚀 Deployed to staging by https://github.com/Gonals in version: 9.0.15-0 🚀

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

OSBotify · 2024-08-02T02:18:40Z

🚀 Deployed to production by https://github.com/roryabraham in version: 9.0.15-9 🚀

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

rayane-djouah · 2024-10-19T17:50:29Z

FYI, this issue (#49407) was a missed case in this PR. We need to verify if the room exists before highlighting its mention. More details can be found in this proposal: #49407 (comment)

adds support for mentions in room description

c27b1cf

rlinoz self-assigned this Jul 12, 2024

rlinoz added 2 commits July 15, 2024 17:37

Merge remote-tracking branch 'origin/main' into rodrigo-fix-reportmen…

8ef1e61

…tion-room-description

Merge remote-tracking branch 'origin/main' into rodrigo-fix-reportmen…

4e434ad

…tion-room-description

rlinoz added the Ready To Build label Jul 16, 2024

rlinoz marked this pull request as ready for review July 17, 2024 12:10

rlinoz requested a review from a team as a code owner July 17, 2024 12:10

melvin-bot bot requested review from blimpich and removed request for a team July 17, 2024 12:11

rlinoz requested a review from c3024 July 17, 2024 12:12

Merge remote-tracking branch 'origin/main' into rodrigo-fix-reportmen…

4ad9ac4

…tion-room-description

fix how to get personal details for mentions

a220893

Merge remote-tracking branch 'origin/main' into rodrigo-fix-reportmen…

e15b8d1

…tion-room-description

rlinoz added 6 commits July 25, 2024 16:52

merge main

e46eada

Merge remote-tracking branch 'origin/main' into rodrigo-fix-reportmen…

8ffffe2

…tion-room-description

parsing room description html

85b7e92

Merge remote-tracking branch 'origin/main' into rodrigo-fix-reportmen…

473b0a1

…tion-room-description

fix lint

7d5e93b

prettier

6065516

fixing copy to clipboard mentions

16d62f2

merge main

8118954

c3024 approved these changes Jul 31, 2024

View reviewed changes

melvin-bot bot requested a review from Gonals July 31, 2024 14:33

melvin-bot bot mentioned this pull request Jul 31, 2024

Payment issue for E/App PR#45352 #46589

Closed

Gonals approved these changes Jul 31, 2024

View reviewed changes

Gonals merged commit f6861e4 into main Jul 31, 2024
15 checks passed

Gonals deleted the rodrigo-fix-reportmention-room-description branch July 31, 2024 16:10

github-actions bot mentioned this pull request Jul 31, 2024

Deploy Checklist: New Expensify 2024-07-31 #46607

Closed

m-natarajan mentioned this pull request Jul 31, 2024

[HOLD] Attachments - Video closes when opening video in full screen right after uploading it #46621

Closed

6 tasks

DylanDylann mentioned this pull request Aug 1, 2024

[$250] Web - Email Mention Displays Number Instead of Email When Edited #46426

Closed

6 tasks

Tony-MK mentioned this pull request Aug 7, 2024

[HOLD for payment][$250] Mention-Numbers are displayed when editing an email mention of a user that is not a contact #45259

Closed

6 tasks

nkdengineer mentioned this pull request Aug 14, 2024

fix: Numbers are displayed when editing an email mention #47024

Merged

49 tasks

rayane-djouah mentioned this pull request Oct 19, 2024

[HOLD for payment 2024-10-25] [$250] Room-Description with mentions shown in preview but after saved disappeared #49407

Closed

5 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adds support for mentions in room description #45352

Adds support for mentions in room description #45352

rlinoz commented Jul 12, 2024 •

edited

Loading

github-actions bot commented Jul 16, 2024

melvin-bot bot commented Jul 17, 2024

c3024 commented Jul 17, 2024 •

edited

Loading

rlinoz commented Jul 17, 2024

c3024 commented Jul 17, 2024 •

edited

Loading

c3024 commented Jul 17, 2024

c3024 commented Jul 17, 2024

rlinoz commented Jul 17, 2024

rlinoz commented Jul 17, 2024

c3024 commented Jul 18, 2024

rlinoz commented Jul 18, 2024

rlinoz commented Jul 29, 2024

rlinoz commented Jul 30, 2024

c3024 commented Jul 31, 2024 •

edited

Loading

c3024 left a comment

melvin-bot bot commented Jul 31, 2024

melvin-bot bot commented Jul 31, 2024

Gonals left a comment

OSBotify commented Jul 31, 2024

OSBotify commented Jul 31, 2024

OSBotify commented Aug 2, 2024

rayane-djouah commented Oct 19, 2024

Adds support for mentions in room description #45352

Adds support for mentions in room description #45352

Conversation

rlinoz commented Jul 12, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

github-actions bot commented Jul 16, 2024

melvin-bot bot commented Jul 17, 2024

c3024 commented Jul 17, 2024 • edited Loading

rlinoz commented Jul 17, 2024

c3024 commented Jul 17, 2024 • edited Loading

c3024 commented Jul 17, 2024

c3024 commented Jul 17, 2024

rlinoz commented Jul 17, 2024

rlinoz commented Jul 17, 2024

c3024 commented Jul 18, 2024

rlinoz commented Jul 18, 2024

rlinoz commented Jul 29, 2024

rlinoz commented Jul 30, 2024

c3024 commented Jul 31, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

c3024 left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Jul 31, 2024

melvin-bot bot commented Jul 31, 2024

Gonals left a comment

Choose a reason for hiding this comment

OSBotify commented Jul 31, 2024

OSBotify commented Jul 31, 2024

OSBotify commented Aug 2, 2024

rayane-djouah commented Oct 19, 2024

rlinoz commented Jul 12, 2024 •

edited

Loading

c3024 commented Jul 17, 2024 •

edited

Loading

c3024 commented Jul 17, 2024 •

edited

Loading

c3024 commented Jul 31, 2024 •

edited

Loading