[Mentions v2] Support mentions in editing comments by war-in · Pull Request #40565 · Expensify/App

war-in · 2024-04-19T13:14:37Z

Details

Fixed Issues

$ #39550
PROPOSAL:

Tests

Go to a room
Create a comment with user and room mentions
Click on Edit comment
Verify that all mentions are in the edit view
Modify comment by adding at least one user and one room mentions (you can remove some mentions too)
Save the comment
Verify that all previous and new mentions are there
Open some Private notes and verify that editing mentions works correctly

Offline tests

QA Steps

Go to a room
Create a comment with user and room mentions
Click on Edit comment
Verify that all mentions are in the edit view
Modify comment by adding at least one user and one room mentions
Save the comment
Verify that all previous and new mentions are there
Open some Private notes and verify that editing mentions works correctly

PR Author Checklist

Screenshots/Videos

Android: Native

android.-.native.mov

Android: mWeb Chrome

Screen.Recording.Apr.22.mov

iOS: Native

ios.-.native.mov

iOS: mWeb Safari

ios.-.web.mov

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

package.json

war-in · 2024-04-19T13:22:04Z

src/libs/OnyxAwareParser.ts

+            return;
+        }
+
+        reportIDToNameMap[report.reportID] = report.reportName ?? report.displayName ?? report.reportID;


Not sure if we should fallback to id, but we did it before so should be fine

Yes, I think it makes sense to fallback to reportID. And if we would prefer reportID to empty string "", then we can use logical OR || and add comment to disable lint check

// eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing

Out of curiosity, do you know when displayName is filled?

tbh I don't know 😅 It's useful for the users but I'm not sure about the rooms

src/libs/OnyxAwareParser.ts

# Conflicts: # src/libs/ReportUtils.ts

robertKozik

LGTM, lets wait for the expensify-common PR merge.
and the task on which we are holding :D

melvin-bot · 2024-04-23T11:01:11Z

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

# Conflicts: # src/pages/tasks/NewTaskDetailsPage.tsx

abdulrahuman5196 · 2024-04-29T12:33:27Z

I am assuming this PR is on hold. Do let me know otherwise or once it comes to review

# Conflicts: # src/libs/ReportUtils.ts

# Conflicts: # src/libs/ReportUtils.ts # src/pages/tasks/TaskDescriptionPage.tsx

war-in · 2024-05-23T10:37:42Z

I am assuming this PR is on hold. Do let me know otherwise or once it comes to review

@abdulrahuman5196 PR is ready for review :)

#39550 (comment)

…editing

blazejkustra · 2024-06-05T18:02:32Z

@war-in #42387 was just merged 🚀

# Conflicts: # src/components/LHNOptionsList/OptionRowLHN.tsx # src/hooks/useCopySelectionHelper.ts # src/hooks/useHtmlPaste/index.ts # src/pages/PrivateNotes/PrivateNotesEditPage.tsx # src/pages/RoomDescriptionPage.tsx # src/pages/home/report/ContextMenu/ContextMenuActions.tsx # src/pages/home/report/ReportActionCompose/ComposerWithSuggestions/ComposerWithSuggestions.tsx # src/pages/home/report/ReportActionItemMessageEdit.tsx # src/pages/tasks/TaskDescriptionPage.tsx # src/pages/workspace/taxes/NamePage.tsx

war-in · 2024-06-07T10:05:46Z

@eh2077 I've just merged the main and all issues should be fixed 🎉 It's ready for review now :)

eh2077 · 2024-06-07T11:09:06Z

I'm working on the checklist

eh2077 · 2024-06-07T14:03:12Z

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

0-android.mp4

Android: mWeb Chrome

0-mobile-chrome.mp4

iOS: Native

0-ios.mp4

iOS: mWeb Safari

0-mobile-safari.mp4

MacOS: Chrome / Safari

0-web.mp4

MacOS: Desktop

0-desktop.mp4

war-in · 2024-06-10T09:12:51Z

@eh2077 can I assume you're approving this PR? 🤔

If so, should @rlinoz review it now?

eh2077

LGTM!

rlinoz · 2024-06-10T18:03:08Z

I was doing some tests and it looks like we re=render everything that uses OnyxAwareParser when we get a new report or a personal detail, I am a little worried about the performance, what do you think @war-in @robertKozik @eh2077?

Am I missing something?

war-in · 2024-06-11T12:41:55Z

@rlinoz That's a good question but I think we have to connect Onyx this way. Do you maybe have an idea of passing arguments which will not cause rerenders?

rlinoz · 2024-06-11T21:09:24Z

Yeah, I played with this a lot today and didn't get to a good solution. Anyway, I believe that a user don't get new reports frequently enough for this to matter, so I think we should be good.

The other option is to fetch only the personal details and reports for a particular message, but that is costly as well and we will have to fetch for ever parsed message, even if we got the same data for a previous one.

eh2077 · 2024-06-12T15:32:30Z

Yeah, I played with this a lot today and didn't get to a good solution. Anyway, I believe that a user don't get new reports frequently enough for this to matter, so I think we should be good.

Yes, I also agree to move the first version of this feature forward.

The other option is to fetch only the personal details and reports for a particular message, but that is costly as well and we will have to fetch for ever parsed message, even if we got the same data for a previous one.

Just continue to brainstorm on @rlinoz 's idea about improving the potential performance issue. I'm not sure if we have considered just saving the text needed in the <mention-report> tag, like

<mention-report reportID="1234" text="#room-name" />

So, we won't need to pass the map. But then we'll need to update <mention-report> (reportAction) after editing room name.

war-in · 2024-06-14T08:51:23Z

Just continue to brainstorm on @rlinoz 's idea about improving the potential performance issue. I'm not sure if we have considered just saving the text needed in the tag, like
<mention-report reportID="1234" text="#room-name" />
So, we won't need to pass the map. But then we'll need to update (reportAction) after editing room name.

I think the mention with ID was an idea from the design doc. Probably @rlinoz could give more details on it.
However, we would have to change expensify-common too :/

# Conflicts: # src/libs/ReportUtils.ts

eh2077 · 2024-06-14T14:20:36Z

<mention-report reportID="1234" text="#room-name" />

As the text can be changed by the user over time, we'll need to check and map it to the correct text by ID. That being said, saving the text in the tag doesn’t seem to offer any advantages.

OSBotify · 2024-06-14T23:16:12Z

🚀 Deployed to staging by https://github.com/rlinoz in version: 1.4.84-0 🚀

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

OSBotify · 2024-06-17T23:48:25Z

🚀 Deployed to production by https://github.com/AndrewGable in version: 1.4.84-3 🚀

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

aimane-chnaif · 2024-09-10T07:50:47Z

src/libs/OnyxAwareParser.ts

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


It doesn't make sense to use accountID as fallback.
Later, it caused #45259.
We fixed it by setting it as empty string as fallback to show "Hidden"

robertKozik and others added 3 commits April 19, 2024 11:11

introduce OnyxAwareParser

f7275e0

Merge branch 'refs/heads/main' into mention-editing

959af6b

parser.htmlTo -> parseHtmlTo

7b3fe65

war-in commented Apr 19, 2024

View reviewed changes

package.json Outdated Show resolved Hide resolved

add fallback when displayName does not exist

baf2a8c

war-in commented Apr 19, 2024

View reviewed changes

src/libs/OnyxAwareParser.ts Outdated Show resolved Hide resolved

war-in added 2 commits April 19, 2024 15:25

bring back removed trim

63a7098

Merge branch 'refs/heads/main' into mention-editing

94e4adf

# Conflicts: # src/libs/ReportUtils.ts

robertKozik approved these changes Apr 22, 2024

View reviewed changes

war-in added 2 commits April 23, 2024 12:57

Merge branch 'refs/heads/main' into mention-editing

de7ddaf

update expensify-common

8daba9d

war-in marked this pull request as ready for review April 23, 2024 11:01

war-in requested a review from a team as a code owner April 23, 2024 11:01

melvin-bot bot requested review from abdulrahuman5196 and removed request for a team April 23, 2024 11:01

war-in added 3 commits April 26, 2024 09:32

Merge branch 'refs/heads/main' into mention-editing

d2bb72f

# Conflicts: # src/pages/tasks/NewTaskDetailsPage.tsx

Merge branch 'refs/heads/main' into mention-editing

1f08080

fix failing typecheck

46a1f6e

hungvu193 mentioned this pull request May 8, 2024

[HOLD FOR #40565][$250] Chat - Mention is not displayed in compose box when editing a message #41793

Closed

6 tasks

c3024 mentioned this pull request May 11, 2024

Fix manually copied and pasted user mention turns into user profile hyperlink #42016

Merged

50 tasks

war-in added 3 commits May 13, 2024 12:52

Merge branch 'refs/heads/main' into mention-editing

1828050

# Conflicts: # src/libs/ReportUtils.ts

Merge branch 'refs/heads/main' into mention-editing

2dc7236

# Conflicts: # src/libs/ReportUtils.ts # src/pages/tasks/TaskDescriptionPage.tsx

remove leftovers

98c0acf

robertKozik mentioned this pull request May 13, 2024

[HOLD for payment 2024-07-24] [$250] Group chat - User mention is not copied when copying "made an admin" whisper to clipboard #40477

Closed

6 tasks

replace htmlToText in OptionRowLHN

dafa5a4

lakchote mentioned this pull request May 20, 2024

[HOLD for payment 2024-07-24] [$250] Room - Room mention is not copied to clipboard and editor is empty when editing room mention #40403

Closed

6 tasks

Merge remote-tracking branch 'refs/remotes/origin/main' into mention-…

01aa522

…editing

war-in mentioned this pull request Jun 3, 2024

[HOLD for payment 2024-06-11] App crashes due to trying to access accountIdToName prop in epensimark on an undefined variable #42161

Closed

use personalDetails.login as account name

a8fbfa6

war-in added 2 commits June 7, 2024 10:17

allow passing custom extras to OnyxAwareParser

f0b59c0

eh2077 approved these changes Jun 10, 2024

View reviewed changes

war-in mentioned this pull request Jun 11, 2024

[HOLD for payment 2024-06-28] [HOLD for payment 2024-06-24] [HOLD Mentions v2] Support mentions in editing comments #39550

Closed

Merge branch 'refs/heads/main' into mention-editing

8846545

# Conflicts: # src/libs/ReportUtils.ts

rlinoz approved these changes Jun 14, 2024

View reviewed changes

rlinoz merged commit f703ae0 into Expensify:main Jun 14, 2024

github-actions bot mentioned this pull request Jun 14, 2024

Deploy Checklist: New Expensify 2024-06-14 #43793

Closed

53 tasks

ahmedGaber93 mentioned this pull request Jun 18, 2024

[$250] Chat - Phone number mention in edit comment shows @expensify.sms #40969

Closed

6 tasks

war-in deleted the mention-editing branch June 24, 2024 09:49

carlosmiceli mentioned this pull request Jun 25, 2024

[HOLD for payment 2024-07-10] [HOLD for payment 2024-07-02] Mention - Report mention #admins is not styled when editing comment in room chat #42521

Closed

6 tasks

c3024 mentioned this pull request Jul 18, 2024

Adds support for mentions in room description #45352

Merged

50 tasks

nkdengineer mentioned this pull request Jul 25, 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

aimane-chnaif reviewed Sep 10, 2024

View reviewed changes

Conversation

war-in commented Apr 19, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

Uh oh!

war-in Apr 19, 2024

Choose a reason for hiding this comment

Uh oh!

eh2077 May 30, 2024

Choose a reason for hiding this comment

Uh oh!

rlinoz Jun 10, 2024

Choose a reason for hiding this comment

Uh oh!

war-in Jun 10, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

robertKozik left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

melvin-bot bot commented Apr 23, 2024

Uh oh!

abdulrahuman5196 commented Apr 29, 2024

Uh oh!

war-in commented May 23, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

blazejkustra commented Jun 5, 2024

Uh oh!

war-in commented Jun 7, 2024

Uh oh!

eh2077 commented Jun 7, 2024

Uh oh!

eh2077 commented Jun 7, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

war-in commented Jun 10, 2024

Uh oh!

eh2077 left a comment

Choose a reason for hiding this comment

Uh oh!

rlinoz commented Jun 10, 2024

Uh oh!

war-in commented Jun 11, 2024

Uh oh!

rlinoz commented Jun 11, 2024

Uh oh!

eh2077 commented Jun 12, 2024

Uh oh!

war-in commented Jun 14, 2024

Uh oh!

eh2077 commented Jun 14, 2024

Uh oh!

OSBotify commented Jun 14, 2024

Uh oh!

OSBotify commented Jun 17, 2024

Uh oh!

aimane-chnaif Sep 10, 2024

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

war-in commented Apr 19, 2024 •

edited

Loading

robertKozik left a comment •

edited

Loading

war-in commented May 23, 2024 •

edited

Loading

eh2077 commented Jun 7, 2024 •

edited

Loading