fix: room chat - whisper displays 1 mention when 2 mentions are send in specific way

[NJ-2020]

Fixed Issues

$ Expensify/App#46299
PROPOSAL: Expensify/App#46299 (comment)

Tests

1. What unit/integration tests cover your change? What autoQA tests cover your change?
2. What tests did you perform that validates your changed worked?
3. Go to Expensify App
4. Tap on a room chat
5. Mention 2 user with minus sign in between i.e #user1-#user2
6. Verify that whisper display 2 user

QA

1. What does QA need to do to validate your changes?
2. What areas to they need to test for regressions?
3. Same as Tests

Details

Tests

1. Go to Expensify App
2. Tap on a room chat
3. Mention 2 user with minus sign in between i.e #user1-#user2
4. Verify that whisper display 2 user

• Verify that no errors appear in the JS console

Offline tests

Same as Tests

QA Steps

Same as Tests

• 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

[rojiphil]

@NJ-2020 Can you please fill in the PR Author Checklist and follow the contributing guidelines as mentioned here and here.
The PR Author Checklist must be the contents of the PR description.

[NJ-2020]

@rojiphil Done

[NJ-2020]

I remove the minus sign - after 0-9 because it will match any word containing minus sign - meaning

If we not remove the minus sign - and we type #user1-#user2 the output will be:
#user1- #user2

After removing:
#user1 #user2

[NJ-2020]

I think if we remove the - minus sign it will cause other issue like:
typing #room-test the mention-report tag will only wrap #room

But if we don't remove the - minus sign it will show like this #user1- #user2 if we type #user1-#user2

[rlinoz]

Tests are failling actually

[NJ-2020]

Yes because the minus sign is removed after 0-9

[rojiphil]

Yes because the minus sign is removed after 0-9

@NJ-2020 It does not look correct to remove the hyphen.

[rojiphil]

I am not sure why we need to look for the characters in [^ \n*~_] before the actual group name starts with #. Since a room mention is a string that starts with the '#' symbol, can we not use # for negative lookbehind i.e. something like shown below?
@NJ-2020 @rlinoz What do you think?

[rlinoz]

I believe the problem with that approach is that it would match things we don't really want, like # inside links working as anchor, like this:

I don't know why we ever allowed _ though, which make sme think that maybe we can just remove that.

[rojiphil]

I believe the problem with that approach is that it would match things we don't really want, like # inside links working as anchor, like this

Yeah, that makes sense.

I don't know why we ever allowed _ though, which make me think that maybe we can just remove that.

Ah! So, we can ignore # as starting symbol for the room name if it is preceded by _ or -. Instead, the valid ones are space, newline, star, and tilde symbols. If # is preceded by any of these, we will consider this to be the start of a room name. This makes sense.
And sorry as I missed this point when it was mentioned in the issue here.

[NJ-2020]

Sorry for the delay
So should I remove the minus sign - and the underscore _ here

expensify-common/lib/ExpensiMark.ts

Line 306 in e97172c

regex: /(?<![^ \n*~_-])(#[\p{Ll}0-9]{1,99})(?![^<]*(?:<\/pre>|<\/code>|<\/a>))/gimu,

Just to make sure?

[rojiphil]

Sorry for the delay
So should I remove the minus sign - and the underscore _ here

yes. That's correct. Also, we should revert the change here as that's expected.

[NJ-2020]

Done

[rojiphil]

@NJ-2020 The tests are failing. Did we break anything? Please check.

[NJ-2020]

Ah!, I know why we include the underscore inside the reportMentions regex, we include the underscore because we want to allow user to type italic room name

expensify-common/__tests__/ExpensiMark-HTML-test.js

Lines 2266 to 2269 in f11184e

	test('room mention with italic, bold and strikethrough styles', () => {
	const testString =
	'#room' +
	' _#room_' +

expensify-common/__tests__/ExpensiMark-HTML-test.js

Lines 2285 to 2287 in f11184e

	const resultString =
	'<mention-report>#room</mention-report>' +
	' <em><mention-report>#room</mention-report></em>' +

As we can see the expected result if we put the underscore before and after the room name it should show in italic way i.e _#room_ should show #room

cc: @rojiphil @rlinoz

[rlinoz]

Ah that makes sense, let me investigate a little then I will get back to this.

[rlinoz]

I did some testing I think this fixes it: (?<=^|[ \n][*~_]?)

The idea is to match the special characters only if they are preceded by newline/space.

Let me know what you think @rojiphil @NJ-2020

[rlinoz]

friendly bump @rojiphil @NJ-2020

[rojiphil]

I did some testing I think this fixes it: (?<=^|[ \n][*~_]?)

The idea is to match the special characters only if they are preceded by newline/space.

@rlinoz Sorry for the delayed response. I just tried the regex and here are the results. Looks fine to me.
Curious to know though on what our inbuilt test cases would think of this.

[NJ-2020]

@rlinoz Sorry for the delay

The idea is to match the special characters only if they are preceded by newline/space.

I think it will not fix the issue, because it will match any room name if they are preceded by newline/space, so when we type _#room_ it will not match the room name because the room name preceded by underscore instead of newline/space, while we want to allow user to type italic room name by using underscore before and after the room name

expensify-common/__tests__/ExpensiMark-HTML-test.js

Lines 2266 to 2269 in f11184e

	test('room mention with italic, bold and strikethrough styles', () => {
	const testString =
	'#room' +
	' _#room_' +

expensify-common/__tests__/ExpensiMark-HTML-test.js

Lines 2285 to 2287 in f11184e

	const resultString =
	'<mention-report>#room</mention-report>' +
	' <em><mention-report>#room</mention-report></em>' +

But I don't know why when I tested inside the regexr website it matches the room name

Please let me know if I miss something here

[rlinoz]

@NJ-2020 ah yeah, you are right, that is because there was a mistake not accounting for special characters at the beginning of the line, thats why tests passed but your test on Chrome didn't work, we have no test where special characters are at the beginning I guess

I think this new one should do it:

/(?<=^[*~_]?|[ \n][*~_]?)(#[\p{Ll}0-9-]{1,99})(?![^<]*(?:<\/pre>|<\/code>|<\/a>))/gimu

[NJ-2020]

@rojiphil Yes, Looks good to me

[NJ-2020]

Sorry ^ accidently mistaken, I meant @rlinoz

[rojiphil]

@NJ-2020 On making the regex changes directly in node_modules\expensify-common and testing with #4856₹&_#7553, #7553 does get ignored as expected. However, the background color still shows in the composer for #7553. Can you please check this? Here is a test video demonstrating this.

46299-background-issue.mp4

[NJ-2020]

@rojiphil It's because we did not update the react-native-live-markdown/parser
We will fix this later by bumping the expensify-common to the latest version and rebuild the react-native-live-markdown/parser again

[rojiphil]

It's because we did not update the react-native-live-markdown/parser

Ah ok. Got it. Thanks. Changes LGTM.
Since the version of expensify-common in latest E/App main is 2.0.94 whereas the latest version of expensify-common is 2.0.99 we can get this merged first as the changes will not be reflected in latest E/App main until we bump up the version there.

[rojiphil]

We will fix this later by bumping the expensify-common to the latest version and rebuild the react-native-live-markdown/parser again

And the next PR would be as mentioned above.

Finally, PR on E/App would be raised to update the expensify-common and react-native-live-markdown versions.
We can upload the test videos and complete the checklist in the App PR.

Does this sound like the plan for us?

[rojiphil]

@rlinoz Over to you for final review.

[github-actions]

🚀Published to npm in v2.0.100