[No QA] 17885 custom user mentions renderer #18167

robertKozik · 2023-04-28T20:45:16Z

Details

This PR adds custom renderer used for user mentions inside chats

Fixed Issues

$ #17885
PROPOSAL:https://docs.google.com/document/d/1vhvpwQDStA0lcsI0Z33pXOKPM6nXGRuplvQTFBWvCyA/edit#heading=h.5lyudapet5j6

Tests

Prerequisites: ExpensiMark changes are applied locally and app is in offline mode

open chat
type the message user mention ( its '@' followed with primary login - mail of the user) and send it
Properly rendered mention should appear in chat message with blue-ish background
type the message which mention your account
Properly rendered mention should appear in chat message with green-ish background

Verify that no errors appear in the JS console

Offline tests

same as above

QA Steps

same as above

In addition to mention testing, we need to check that code is rendering in chat properly, to check that there is no regression problems:

open chat
type the message with code block (code is the fragment between backticks f.e. `code block`) and send it
Properly rendered code block with rounded corners and horizontal padding should appear in chat message

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 / Chrome
- iOS / native
- iOS / 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 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 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

MelvinBot · 2023-05-03T15:47:16Z

@puneetlath @parasharrajat One of you needs to 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]

src/components/HTMLEngineProvider/HTMLRenderers/MentionUserRenderer.js

parasharrajat · 2023-05-03T15:51:01Z

src/components/HTMLEngineProvider/HTMLRenderers/MentionUserRenderer.js

+                // eslint-disable-next-line react/jsx-props-no-spreading
+                {...defaultRendererProps}
+                color={themeColors.textSupporting}
+                style={[props.style, {backgroundColor}]}


No inline styles, we can move the whole logic of bg calculation to the Styleutils and use it here.

parasharrajat · 2023-05-03T15:52:37Z

src/components/HTMLEngineProvider/HTMLRenderers/MentionUserRenderer.js

+    const backgroundColor = isOurMention ? themeColors.ourMentionBG : themeColors.mentionBG;
+
+    return (
+        <Tooltip containerStyles={[styles.dInline]} text={loginWhithoutLeadingAt}>


Suggested change

<Tooltip containerStyles={[styles.dInline]} text={loginWhithoutLeadingAt}>

<Tooltip containerStyles={[styles.dInline]} text={loginWhithoutLeadingAt}>

Instead of containerStyles you can use absolute prop.

src/components/HTMLEngineProvider/HTMLRenderers/index.js

parasharrajat · 2023-05-03T15:54:16Z

src/styles/styles.js

+        'mention-user': {
+            borderRadius: variables.componentBorderRadiusSmall,
+            paddingHorizontal: 2,
+        },


We don't have to define the styles for this tag instead just use it in the Text element in the Rendered as it seems. Not sure if this works the same but if yes why not.

puneetlath · 2023-05-03T16:08:55Z

@shawnborton could you review as well for design please 😄

puneetlath

Just some minor comments. Overall looking really good!

puneetlath · 2023-05-03T15:59:23Z

src/components/HTMLEngineProvider/HTMLRenderers/MentionUserRenderer.js

+            <Text
+                // eslint-disable-next-line react/jsx-props-no-spreading
+                {...defaultRendererProps}
+                color={themeColors.textSupporting}


This should use mentionText or ourMentionText right?

src/components/HTMLEngineProvider/HTMLRenderers/index.js

puneetlath · 2023-05-03T16:08:26Z

src/styles/themes/default.js

+    mentionText: colors.blue200,
+    mentionBG: colors.blue700,
+    ourMentionText: colors.green200,
+    ourMentionBG: colors.green700,


In the design doc we said these should be:

mentionText: colors.blue100 mentionBG: colors.blue600 ourMentionText: colors.green100 ourMentionBG: colors.green600

In case those aren't defined:

blue100: #BOD9FF

blue600: #0164BF

green100: #B1F2D6

green600: #008C59

shawnborton · 2023-05-03T16:20:55Z

Looks like the corners are not round on iOS:

Also, can we get more screenshots here that aren't just all offline mode?

shawnborton · 2023-05-03T16:21:23Z

It also seems like the baseline of the text inside of the mention doesn't align to the baseline of the text outside of the mention. Ideally they should line up perfectly.

puneetlath · 2023-05-03T16:26:24Z

@robertKozik you shouldn't need to test in offline mode anymore. The update to make it so that we don't strip the <mention-user> html tags is on staging.

puneetlath · 2023-05-03T16:28:24Z

@shawnborton here's a screenshot from web from my own testing in non-offline mode.

parasharrajat · 2023-05-03T16:41:56Z

It also seems like the baseline of the text inside of the mention doesn't align to the baseline of the text outside of the mention. Ideally they should line up perfectly.

This will be solved with #18167 (comment)

shawnborton · 2023-05-03T16:47:38Z

Web looks pretty good other than the colors being off.

parasharrajat · 2023-05-03T17:17:40Z

Why blueish color is removed after a few secs? I don't see the yellow color when I mention my email.

puneetlath · 2023-05-03T17:22:46Z

@parasharrajat can you include a video of what you're seeing?

puneetlath · 2023-05-03T17:28:11Z

@parasharrajat also, are you making sure to use staging server.

parasharrajat · 2023-05-03T18:32:41Z

Here is the video. I missed using the staging server. Can we please add that step to the Tests? and I don't think QA can test this due to code changes being needed. Should this be No QA?

Now I can't tag myself.

Screen.Recording.2023-05-04.at.12.01.00.AM.mov

puneetlath · 2023-05-03T18:46:27Z

Should this be No QA

Good call

I missed using the staging server. Can we please add that step to the Tests?

Yes, sounds good. Whenever the next back-end deploy happens (hopefully today) you'll be able to test this on staging or production

Now I can't tag myself.

Ah interesting. @getusha it looks like our regex doesn't like email addresses with periods in them

parasharrajat · 2023-05-03T18:50:59Z

I see, I also thought that the mention parsing is not part of this PR. Let me see if I can test it with a different account.

getusha · 2023-05-03T18:52:11Z

Ah interesting. @getusha it looks like our regex doesn't like email addresses with periods in them

Sure i will update it once more,
Also we should handle emails that has + in the middle? like test+new@gmail.com

puneetlath · 2023-05-03T19:01:17Z

@getusha maybe we should just use the isValidEmail regex since it should already account for these cases.

Update JsDoc comment for MentionUserRenderer propTypes Co-authored-by: Rajat Parashar <parasharrajat@users.noreply.github.com>

puneetlath · 2023-05-05T16:31:56Z

Code looks good to me. So if the checklist tests well for you @parasharrajat I think we'll be good to merge.

parasharrajat · 2023-05-05T16:48:33Z

Screenshots

🔲 iOS / native

🔲 iOS / Safari

🔲 MacOS / Desktop

#### 🔲 MacOS / Chrome

#### 🔲 Android / Chrome

#### 🔲 Android / native

parasharrajat

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 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.

cc: @puneetlath

🎀 👀 🎀 C+ reviewed

puneetlath · 2023-05-05T17:05:18Z

Awesome!

melvin-bot · 2023-05-05T17:05:28Z

Congrats, that’s your 5th PR merged! 🎉 Do you know about the ContributorPlus role? It’s an opportunity to earn more in the Expensify Open Source community. Keep up the great work - thanks!

OSBotify · 2023-05-05T17:12:56Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

parasharrajat · 2023-05-05T17:22:13Z

Lol, I am not seeing the strings on the Android App. Is it only me?

puneetlath · 2023-05-05T17:22:47Z

What do you mean?

parasharrajat · 2023-05-05T17:27:29Z

Sorry, I mean I am not seeing. Trying to clean build the app. It might be a cache because it was working fine 2 hours before.

parasharrajat · 2023-05-05T17:30:48Z

It does seem like an issue. Compare the following screenshots with others to see that mentions are not rendering on Android.

parasharrajat · 2023-05-05T17:35:14Z

@robertKozik Can you please check this?

getusha · 2023-05-05T17:36:23Z

Yes, there is an issue a text using WrapperText is not appearing on android

parasharrajat · 2023-05-05T17:38:42Z

@getusha Why is that? Any idea?

getusha · 2023-05-05T17:44:09Z

@parasharrajat here is the issue #17441
We are using InlineCodeBlock here, currently it is not being visible on android, so it is not related to this PR.

parasharrajat · 2023-05-05T17:45:00Z

Ok, I found the issue #17441. Damn it! I think we will have to revert the PR because mentions won't work on Android. I remember that it was rendering on Android perfectly fine a few months back. What changed?

puneetlath · 2023-05-05T17:49:04Z

Ah, damn!

puneetlath · 2023-05-05T17:49:40Z

PR to revert: #18490

getusha · 2023-05-05T17:52:52Z

Ok, I found the issue #17441. Damn it! I think we will have to revert the PR because mentions won't work on Android. I remember that it was rendering on Android perfectly fine a few months back. What changed?

Tried to investigate and it doesn't seem to be a change from our codebase it might be from our react-native fork. i am not sure

parasharrajat · 2023-05-05T17:54:58Z

Something changed with RN upgrades. Not sure which PR or version but def an RN upgrade.

robertKozik · 2023-05-05T18:01:24Z

That escalated quickly 😮 I don't know how that happened, but sorry for that all reverting problem 😢

OSBotify · 2023-05-05T20:02:05Z

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

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

OSBotify · 2023-05-09T04:04:40Z

🚀 Deployed to production by https://github.com/roryabraham in version: 1.3.12-0 🚀

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

robertKozik added 3 commits May 3, 2023 15:17

create styles for mentions

e0a1fa3

create custom rendere for user mentions

edf6c26

register custom user mentions renderer

b237150

robertKozik force-pushed the 17885_custom_user_mentions_renderer branch from 9a9f781 to b237150 Compare May 3, 2023 15:44

robertKozik marked this pull request as ready for review May 3, 2023 15:47

robertKozik requested a review from a team as a code owner May 3, 2023 15:47

melvin-bot bot requested review from parasharrajat and puneetlath and removed request for a team May 3, 2023 15:47

parasharrajat suggested changes May 3, 2023

View reviewed changes

puneetlath requested a review from shawnborton May 3, 2023 16:08

puneetlath requested changes May 3, 2023

View reviewed changes

puneetlath changed the title ~~17885 custom user mentions renderer~~ [No QA] 17885 custom user mentions renderer May 3, 2023

hoist mention styling to styleUtils file

2841609

Update JsDoc comment

efcbfae

Update JsDoc comment for MentionUserRenderer propTypes Co-authored-by: Rajat Parashar <parasharrajat@users.noreply.github.com>

puneetlath approved these changes May 5, 2023

View reviewed changes

parasharrajat approved these changes May 5, 2023

View reviewed changes

puneetlath merged commit 563900d into Expensify:main May 5, 2023

puneetlath mentioned this pull request May 5, 2023

Revert "[No QA] 17885 custom user mentions renderer" #18490

Merged

55 tasks

OSBotify mentioned this pull request May 5, 2023

Deploy Checklist: New Expensify 2023-05-05 #18498

Closed

31 tasks

melvin-bot bot mentioned this pull request May 9, 2023

[HOLD for payment 2023-05-16] Add custom renderer for user mentions #17885

Closed

This was referenced May 18, 2023

[HOLD for payment 2023-06-01] [$1000] Mentions are being rendered inside of code and codefence #18983

Closed

[HOLD for payment 2023-06-01] [$1000] Link conflict when using a mentioned contact as an anchor text #18857

Closed

	<Tooltip containerStyles={[styles.dInline]} text={loginWhithoutLeadingAt}>
	<Tooltip containerStyles={[styles.dInline]} text={loginWhithoutLeadingAt}>

[No QA] 17885 custom user mentions renderer #18167

[No QA] 17885 custom user mentions renderer #18167

Conversation

robertKozik commented Apr 28, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

MelvinBot commented May 3, 2023

parasharrajat May 3, 2023

Choose a reason for hiding this comment

parasharrajat May 3, 2023

Choose a reason for hiding this comment

parasharrajat May 3, 2023

Choose a reason for hiding this comment

puneetlath commented May 3, 2023

puneetlath left a comment

Choose a reason for hiding this comment

puneetlath May 3, 2023

Choose a reason for hiding this comment

puneetlath May 3, 2023

Choose a reason for hiding this comment

shawnborton commented May 3, 2023

shawnborton commented May 3, 2023

puneetlath commented May 3, 2023

puneetlath commented May 3, 2023

parasharrajat commented May 3, 2023

shawnborton commented May 3, 2023

parasharrajat commented May 3, 2023

puneetlath commented May 3, 2023

puneetlath commented May 3, 2023

parasharrajat commented May 3, 2023 • edited Loading

puneetlath commented May 3, 2023 • edited Loading

parasharrajat commented May 3, 2023

getusha commented May 3, 2023

puneetlath commented May 3, 2023

puneetlath commented May 5, 2023

parasharrajat commented May 5, 2023 • edited Loading

Screenshots

🔲 iOS / native

🔲 iOS / Safari

🔲 MacOS / Desktop

parasharrajat left a comment

Choose a reason for hiding this comment

Reviewer Checklist

puneetlath commented May 5, 2023

melvin-bot bot commented May 5, 2023

OSBotify commented May 5, 2023

parasharrajat commented May 5, 2023 • edited Loading

puneetlath commented May 5, 2023

parasharrajat commented May 5, 2023

parasharrajat commented May 5, 2023 • edited Loading

parasharrajat commented May 5, 2023

getusha commented May 5, 2023

parasharrajat commented May 5, 2023

getusha commented May 5, 2023

parasharrajat commented May 5, 2023

puneetlath commented May 5, 2023

puneetlath commented May 5, 2023

getusha commented May 5, 2023

parasharrajat commented May 5, 2023

robertKozik commented May 5, 2023

OSBotify commented May 5, 2023

OSBotify commented May 9, 2023

robertKozik commented Apr 28, 2023 •

edited

Loading

parasharrajat commented May 3, 2023 •

edited

Loading

puneetlath commented May 3, 2023 •

edited

Loading

parasharrajat commented May 5, 2023 •

edited

Loading

parasharrajat commented May 5, 2023 •

edited

Loading

parasharrajat commented May 5, 2023 •

edited

Loading