feat: support accountid attribute in user mentions #26877

samh-nl · 2023-09-06T14:28:29Z

Details

This PR adds support for the account ID to be provided in user mentions.
Usage examples: <mention-user accountID=12345678>@test@test.com</mention-user> or <mention-user accountID=12345678></mention-user>

Fixed Issues

$ #26306
PROPOSAL: #26306 (comment)

Tests

Precondition: The API does not yet support this feature. To allow testing, we can perform a modification here to automatically add the mentions to messages:

const mentionsHTML = [
	'1. <mention-user accountID=12345678>@test@test.com</mention-user> (hidden user: unknown account ID)',
	'2. <mention-user accountID=YOUR OWN ID>@test@test.com</mention-user> (current user provided via account ID)',
	'3. <mention-user accountID=ACCOUNT ID>@test@test.com</mention-user> (other user provided via account ID)',
	'4. <mention-user>@YOUR EMAIL</mention-user> (current user provided via email)',
	'5. <mention-user>@OTHER EMAIL</mention-user> (other user provided via email)',
	'6. <mention-user></mention-user> (no account ID or email)',
];

return <RenderHTML html={`<comment>${mentionsHTML.join('\n')}</comment>`} />;

In the above, change:

12345678 with a random number if you already have an account ID stored with this number. It needs to be new.
YOUR OWN ID with your own account's ID.
ACCOUNT ID with a known account ID (but not yourself and the login field of the account must be filled).
YOUR EMAIL should be changed to your own email address.
OTHER EMAIL should be changed to another account's email address.

Verify precondition

Go to any report that has a message (or post a message if none present).
Verify that the message is replaced with 6 mentions.

Tests

Verify that mentions 1 - 5 display the correct email address, prefixed by '@'.
Verify that pressing on mentions 1 - 5 opens the profile page.
Verify that mention 6 is not shown.
Verify that mention 2 is highlighted in the same color as mention 4.
Make the login field empty of the account of mention 3, e.g. by running (replace 123 with the account ID):

window.Onyx.merge('personalDetailsList', { 123: { login: '' }});

Verify that mention 3 now correctly states the account's name prefixed with @.
Verify that pressing mention 3 still opens the profile page.

Verify that no errors appear in the JS console

Offline tests

Identical to "Tests" section.

QA Steps

Identical to "Tests" section.

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Web

Web.Screen.Recording.2023-09-19.at.11.41.49.mp4

Mobile Web - Chrome

mWeb.Chrome.Screen.Recording.2023-09-19.at.13.46.33.mp4

Mobile Web - Safari

mWeb.Safari.Screen.Recording.2023-09-19.at.12.44.48.mp4

Desktop

Desktop.Screen.Recording.2023-09-19.at.11.57.37.mp4

iOS

Native.iOS.Screen.Recording.2023-09-19.at.12.23.22.mp4

Android

Native.Android.Screen.Recording.2023-09-19.at.13.38.39.mp4

melvin-bot · 2023-09-06T14:28:34Z

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

samh-nl · 2023-09-06T14:40:44Z

@thesahindia One thing I would like to note is that the self-closing syntax, i.e.: <mention-user accountID=12345678 /> is not compatible due to the way HTML is parsed, only certain tags like img, input and br can be self-closed. For others, it will include the content present on the same line inside the tag. So for correct usage it would be best to close it using </mention-user>.

puneetlath · 2023-09-07T22:10:41Z

Oh, hm, that's interesting. So the back-end will have to return it as <mention-user accountID=12345678></mention-user>? That's a bit of a bummer.

Is that specifically a restriction of the renderHTML library we're using?

samh-nl · 2023-09-08T08:31:48Z

It's on the HTML specification level so the default behavior should be the same across renderers. It's explained quite well here: https://developer.mozilla.org/en-US/docs/Glossary/Void_element#self-closing_tags

For the <edited> tag we similarly close it with </edited> despite there being no children (here).

There is a prop htmlParserOptions.recognizeSelfClosing that can be set true (reference). It seems to work well in testing. Please note this would be a non-specific change, i.e. it would allow self-closing of other tags as well.

If you'd like me to pursue, I will incorporate this here, and I will update the tests to cover the extra scenarios involved. There are two usages of the htmlparser2 library where this prop can also be added, however these involve extracting attachments from reports (extractAttachmentsFromReport) or deal with the browser DOM (getHTMLOfSelection), and it would not be relevant there.

puneetlath · 2023-09-08T17:36:56Z

Ok, got it! Thanks for the detailed explanation! Let's go with the way you have it for now. If we want to add the recognizeSelfClosing option later, we can always do so.

puneetlath · 2023-09-11T15:03:49Z

@samh-nl now that the merge freeze is over, please merge main into your branch.

samh-nl · 2023-09-11T20:00:45Z

I have performed the merge.

puneetlath · 2023-09-11T20:30:31Z

Ok great. @thesahindia let us know when you'll be able to review.

thesahindia · 2023-09-12T09:15:13Z

I will review it today.

puneetlath · 2023-09-13T16:37:07Z

@thesahindia bump.

thesahindia · 2023-09-13T18:01:15Z

Hey @puneetlath, sorry for the delay here. I am having some issues with my system and won't be able to look into it soon. Please reassign.

puneetlath · 2023-09-15T16:22:33Z

@situchan bump!

situchan · 2023-09-15T17:53:26Z

Mostly looks good.

If the accountID is not present in the personalDetailsList then we should render the mention as @Hidden

@puneetlath in this case, should we disable navigation to open detail page?

Screen.Recording.2023-09-15.at.11.51.34.PM.mov

situchan · 2023-09-15T18:06:22Z

I am not sure if this is possible case: <mention-user></mention-user>

Screen.Recording.2023-09-16.at.12.05.34.AM.mov

puneetlath · 2023-09-16T21:01:51Z

If the accountID is not present in the personalDetailsList then we should render the mention as @hidden
@puneetlath in this case, should we disable navigation to open detail page?

Yes, if we have the accountID in the mention itself, then we can still open the profile page. Only if for some reason there isn't an accountID present, we shouldn't open the profile page.

I am not sure if this is possible case:

Let's handle it. It shouldn't happen, but let's handle it in case it does.

situchan · 2023-09-16T21:07:33Z

Yes, if we have the accountID in the mention itself, then we can still open the profile page. Only if for some reason there isn't an accountID present, we shouldn't open the profile page.

So what I was asking about the case when accountID exists in mention itself but not exist in personalDetailsList.
In this case, we show @hidden so you meant still open profile page with hidden display in email field, correct?

Let's handle it. It shouldn't happen, but let's handle it in case it does.

So this is the case when neither accountID nor email exists in mention tag. What would be the expected behavior here?
Just render nothing?

situchan · 2023-09-18T12:11:32Z

@samh-nl let's address feedback above

puneetlath · 2023-09-18T12:18:43Z

So what I was asking about the case when accountID exists in mention itself but not exist in personalDetailsList.
In this case, we show @hidden so you meant still open profile page with hidden display in email field, correct?

Yes, let's show @hidden in that scenario and still open the profile page. The profile page should already handle the scenario where the accountID isn't present in personalDetails and will also call the API to get whatever info it can.

puneetlath · 2023-09-18T12:19:10Z

So this is the case when neither accountID nor email exists in mention tag. What would be the expected behavior here?
Just render nothing?

Render nothing makes sense to me for this scenario.

puneetlath · 2023-09-18T12:19:38Z

Good questions.

samh-nl · 2023-09-18T12:24:35Z

Yes, let's show @hidden in that scenario and still open the profile page. The profile page should already handle the scenario where the accountID isn't present in personalDetails and will also call the API to get whatever info it can.

Ok I will change it, the current implementation is based on #26306 (comment).

situchan · 2023-09-18T12:27:10Z

Yes, let's show @hidden in that scenario and still open the profile page. The profile page should already handle the scenario where the accountID isn't present in personalDetails and will also call the API to get whatever info it can.

Ok I will change it, the current implementation is based on #26306 (comment).

I checked that discussion too but it seems odd to me that it's not actionable as mention is colored always.
From user's aspect, I'd like to see that user details (even if nothing to show actually) 😄

samh-nl · 2023-09-19T12:22:08Z

I've merged main into the branch and updated the test steps/videos.

samh-nl · 2023-09-20T14:51:58Z

Bump

situchan · 2023-09-20T14:53:43Z

in a few hrs

puneetlath · 2023-09-21T09:28:55Z

@situchan will you be able to get to this today?

situchan · 2023-09-21T09:36:09Z

@samh-nl

Sometimes infinite loading

Screen.Recording.2023-09-21.at.3.31.52.PM.mov

Also it doesn't make sense to message Hidden

Screen.Recording.2023-09-21.at.3.35.12.PM.mov

situchan · 2023-09-21T09:38:13Z

I think they can be out of scope as not caused by this PR

samh-nl · 2023-09-21T09:53:01Z

Being able to message a Hidden user might make sense if the user is offline and we're unable to determine if the account ID really exists.

puneetlath · 2023-09-21T10:50:07Z

I agree that both of those seem out of scope for this PR.

situchan · 2023-09-21T17:59:03Z

Server is down at the moment - https://expensify.slack.com/archives/C01GTK53T8Q/p1695314249132269
Will checklist once it's back

puneetlath · 2023-09-22T04:45:30Z

Let's try to get this across the finish line today please!

situchan · 2023-09-22T23:01:23Z

Long press on mention doesn't open context menu on native. Works on mWeb
Already existing bug so out of scope

situchan · 2023-09-22T23:02:01Z

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 / Chrome
- iOS / native
- iOS / 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(themeColors.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 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

Web

web.mov

Mobile Web - Chrome

mchrome.mov

Mobile Web - Safari

msafari.mov

Desktop

desktop.mov

iOS

ios.mov

Android

android.mov

situchan

@puneetlath all yours!

puneetlath

Looks good!

OSBotify · 2023-09-25T10:04:51Z

🚀 Deployed to staging by https://github.com/puneetlath in version: 1.3.74-0 🚀

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

kavimuru · 2023-09-25T23:09:49Z

@situchan @thesahindia

Are these QA steps?

Verify that mentions 1 - 5 display the correct email address, prefixed by '@'.
Verify that pressing on mentions 1 - 5 opens the profile page.
Verify that mention 6 is not shown.
Verify that mention 2 is highlighted in the same color as mention 4.
Make the login field empty of the account of mention 3, e.g. by running (replace 123 with the account ID):
window.Onyx.merge('personalDetailsList', { 123: { login: '' }});
Verify that mention 3 now correctly states the account's name prefixed with @.
Verify that pressing mention 3 still opens the profile page.

puneetlath · 2023-09-26T03:08:32Z

@kavimuru actually this will be basically impossible for you to QA, so you can check it off. As long as mentions are continuing to work as expected in the regression tests, we should be good.

jasperhuangg · 2023-09-26T07:42:36Z

Hey @puneetlath @samh-nl. Not sure if you're already aware of this, but I'm not sure if we updated the report previews to support the new accountID based mentions. Is this something on your radar?

samh-nl · 2023-09-26T08:06:19Z

@jasperhuangg I believe in this case we just render message[0].html here so that comes from the BE (and thus would need to be updated there)?

In addition to html, there's also the text attribute in report action messages that is possibly affected.

OSBotify · 2023-09-28T18:47:12Z

🚀 Deployed to production by https://github.com/chiragsalian in version: 1.3.74-3 🚀

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

samh-nl added 3 commits September 5, 2023 14:14

feat: support accountid attribute in user mentions

750ac48

feat: remove navigation and tooltip when hidden

19faf7d

fix: ensure proptype is adhered to

2af817d

samh-nl requested a review from a team as a code owner September 6, 2023 14:28

melvin-bot bot requested review from thesahindia and removed request for a team September 6, 2023 14:28

Merge branch 'main' into fix/issue-26306

8eee6fe

puneetlath requested a review from situchan September 13, 2023 18:30

Merge branch 'main' into fix/issue-26306

ad401ae

situchan approved these changes Sep 22, 2023

View reviewed changes

melvin-bot bot requested a review from puneetlath September 22, 2023 23:02

puneetlath approved these changes Sep 24, 2023

View reviewed changes

puneetlath merged commit 4ea4a55 into Expensify:main Sep 24, 2023
13 checks passed

puneetlath mentioned this pull request Sep 25, 2023

Render room change logs #27898

Closed

58 tasks

This was referenced Sep 25, 2023

Deploy Checklist: New Expensify DUPE 2023-09-25 #28118

Closed

Deploy Checklist: New Expensify 2023-09-25 #28119

Closed

melvin-bot bot mentioned this pull request Sep 28, 2023

[HOLD for payment 2023-10-05] [$1000] Add support for accountIDs in mentions on the client #26306

Closed

trjExpensify mentioned this pull request Oct 2, 2023

[HOLD for payment 2023-10-23] [HOLD for payment 2023-10-23] [HOLD for payment 2023-10-20] [HOLD for payment 2023-10-20] [$500] Assign task - Assign task tooltip is not displaying email and avatar #28626

Closed

6 tasks

francoisl mentioned this pull request Oct 19, 2023

[$500] Room - User mention in the system message after inviting member to the room cannot be copied #29978

Closed

6 tasks

jeremy-croff mentioned this pull request Feb 9, 2024

[$500] LHN shows tag as @email@domain.com instead of @person #36284

Closed

6 tasks

feat: support accountid attribute in user mentions #26877

feat: support accountid attribute in user mentions #26877

Conversation

samh-nl commented Sep 6, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Sep 6, 2023

samh-nl commented Sep 6, 2023

puneetlath commented Sep 7, 2023

samh-nl commented Sep 8, 2023 • edited Loading

puneetlath commented Sep 8, 2023

puneetlath commented Sep 11, 2023

samh-nl commented Sep 11, 2023

puneetlath commented Sep 11, 2023

thesahindia commented Sep 12, 2023

puneetlath commented Sep 13, 2023

thesahindia commented Sep 13, 2023

puneetlath commented Sep 15, 2023

situchan commented Sep 15, 2023

situchan commented Sep 15, 2023

puneetlath commented Sep 16, 2023

situchan commented Sep 16, 2023 • edited Loading

situchan commented Sep 18, 2023

puneetlath commented Sep 18, 2023

puneetlath commented Sep 18, 2023

puneetlath commented Sep 18, 2023

samh-nl commented Sep 18, 2023

situchan commented Sep 18, 2023

samh-nl commented Sep 19, 2023

samh-nl commented Sep 20, 2023

situchan commented Sep 20, 2023

puneetlath commented Sep 21, 2023

situchan commented Sep 21, 2023

situchan commented Sep 21, 2023

samh-nl commented Sep 21, 2023

puneetlath commented Sep 21, 2023

situchan commented Sep 21, 2023

puneetlath commented Sep 22, 2023

situchan commented Sep 22, 2023

situchan commented Sep 22, 2023

Reviewer Checklist

Screenshots/Videos

situchan left a comment

Choose a reason for hiding this comment

puneetlath left a comment

Choose a reason for hiding this comment

OSBotify commented Sep 25, 2023

kavimuru commented Sep 25, 2023

puneetlath commented Sep 26, 2023

jasperhuangg commented Sep 26, 2023 • edited Loading

samh-nl commented Sep 26, 2023 • edited Loading

OSBotify commented Sep 28, 2023

samh-nl commented Sep 6, 2023 •

edited

Loading

samh-nl commented Sep 8, 2023 •

edited

Loading

situchan commented Sep 16, 2023 •

edited

Loading

jasperhuangg commented Sep 26, 2023 •

edited

Loading

samh-nl commented Sep 26, 2023 •

edited

Loading