Show short mentions and current user mention in MarkdownTextInput with styling by Kicu · Pull Request #54037 · Expensify/App

Kicu · 2024-12-12T15:05:14Z

Explanation of Change

This PR introduces short mentions to the App. These are mentions of style @ + first part of user email (or login), ex: @john.doe, @user123.

We are only highlighting a login (short-mention) for users that we have already interacted with in the app.
The reason is that there is no place other than local Onyx data to get knowledge whether a string like: @some.body is an actual login of Expensify user or just a random string. So a user types in a login of someone he has never interacted with it will not be highlighted.

This PR builds upon (and uses):

live-markdown change: Add support for short mentions from ExpensiMark react-native-live-markdown#592
expensify-common change: Add handling short mentions tags to ExpensiMark expensify-common#824
worklets in live-markdown: Support custom parsing logic (pass worklet as parser prop) react-native-live-markdown#439

Details:

we consume the new mention-short tag from ExpensiMark and inside worklet we compare the mention with the actual list of user logins
if a user login matches, then we treat it as correct mention and apply styling (mention-user style in LiveMarkdown)
if a login doesn't match, we strip any styling from it so we get plain text (just like we would get before this PR)
the list of all available user logins are based on Onyx data and can be very long; because of that sharedValue is used to pass the list to a worklet.

~~IMPORTANT:~~
~~this PR should be merged together with this Hybrid bump: https://github.com/Expensify/Mobile-Expensify/pull/13451~~
no Hybrid changes required

Fixed Issues

$ #38025
PROPOSAL:

Tests

Open composer on any chat
use autocomplete list to mention someone - the short mention should be styled with blue background and work
manually type in any first part of email of a person you know* - it should get blue background
mention yourself and it should have green background

we are only able to highlight a short-mention of user that you previously had an interaction in expensify

Offline tests

QA Steps

Same as Tests

PR Author Checklist

Screenshots/Videos

Android: Native

rec-mention-andr.mp4

Android: mWeb Chrome

iOS: Native

rec-mention-ios.mp4

iOS: mWeb Safari

rec-mention-ios-web.mp4

MacOS: Chrome / Safari

rec-mention-web.mp4

MacOS: Desktop

Kicu · 2025-01-09T13:25:52Z

This PR is currently awaiting merge and release of: Expensify/expensify-common#824

Kicu · 2025-02-06T11:04:21Z

Update with description how to test this here: #38025 (comment)

shubham1206agra · 2025-02-18T08:17:55Z

Screen.Recording.2025-02-18.at.1.46.45.PM.mov

@Kicu Can you please check this and verify if we need to change something in clipboard?

Kicu · 2025-02-21T13:05:14Z

@shubham1206agra So in this task I focused only on the part of adding styling to short-mentions in the Live markdown input.
As far as I can see, there is some some code that runs on submitting, and all these "short mentions" are change to full version when being send to backend. Check my screen:

So after they're back from backend, we get full emails and that is what we see on your video. I believe everything related to copy-to-clipboard from this point would be working same as before.
Whether this behaviour (highlighting short mention -> but sending full mention to api) is correct or we want to change it I don't know - perhaps @puneetlath can give his opinion?

puneetlath · 2025-02-24T16:24:05Z

Sending as full mention to the API seems correct to me. That's what the back-end expects. The short mention is just a rendering thing on the client, not something the back-end is aware of.

Kicu · 2025-02-27T12:30:43Z

There seems to be some problems with publishing to npm: https://github.com/Expensify/expensify-common/actions/runs/13502875291

I've pinged people on slack and will be waiting till this gets solved. Once the version is published I will make this PR reviewable (probably next week).
Sorry this is taking so long 😅

puneetlath · 2025-03-03T16:54:22Z

Ah gotcha. Were you able to get the help you needed on the npm publishing issue? Would you mind linking the Slack thread here?

Kicu · 2025-03-04T09:37:39Z

@puneetlath yeah the newest version of expensify-common is now published.
I plan to have this PR ready for final review today or tomorrow 🚀

github-actions · 2025-03-04T15:27:51Z

⚠️ This PR is possibly changing native code, it may cause problems with HybridApp. Please run an AdHoc build to verify that HybridApp will not break. ⚠️

puneetlath · 2025-03-04T15:52:54Z

Great!

Kicu · 2025-03-14T08:48:58Z

@shubham1206agra I pused a commit fixing the green long mention highlighting.
Here's what I tested:

Screen.Recording.2025-03-14.at.09.43.32.mov

As for the rest minor bugs:

On editing the comment, the short mention expands into full emails

same as on prod

There is a warning

About reanimated warning: I'm not sure what causes it. I asked @tomekzaw who works with reanimated to take a quick look at the code and he didn't see anything wrong with sharedValue usage in this PR. I checked on production and I noticed that we have a similar warning running when you open Search (cmd+k) - which uses similar code. We could probably create an issue to investigate this.

I think these are small enough that we could merge this PR.

I have a lot of work with ReportsView in here: #57508 - so if you find any other bugs then I can only work on them once I'm done with the other task.
Again sorry it's taking so long and thanks!

src/components/RNMarkdownTextInput.tsx

shubham1206agra · 2025-03-14T13:47:41Z

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 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.ts 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.
For any bug fix or new feature in this PR, I verified that sufficient unit tests are included to prevent regressions in this flow.
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

Screen.Recording.2025-03-13.at.7.20.45.PM.mov

Android: mWeb Chrome

Screen.Recording.2025-03-13.at.6.23.51.PM.mov

iOS: Native

Screen.Recording.2025-03-13.at.6.51.53.PM.mov

iOS: mWeb Safari

Screen.Recording.2025-03-13.at.6.14.48.PM.mov

MacOS: Chrome / Safari

Screen.Recording.2025-03-13.at.6.07.07.PM.mov

MacOS: Desktop

Screen.Recording.2025-03-13.at.6.39.54.PM.mov

Co-authored-by: Shubham Agrawal <58412969+shubham1206agra@users.noreply.github.com>

github-actions · 2025-03-14T14:07:07Z

⚠️ This PR is possibly changing native code and/or updating libraries, it may cause problems with HybridApp. Please check if any patch updates are required in the HybridApp repo and run an AdHoc build to verify that HybridApp will not break. Ask Contributor Plus for help if you are not sure how to handle this. ⚠️

thienlnam

@puneetlath Will leave final approve / merge to you

github-actions · 2025-03-17T07:32:56Z

⚠️ This PR is possibly changing native code and/or updating libraries, it may cause problems with HybridApp. Please check if any patch updates are required in the HybridApp repo and run an AdHoc build to verify that HybridApp will not break. Ask Contributor Plus for help if you are not sure how to handle this. ⚠️

Kicu · 2025-03-17T07:35:26Z

~~I see some tests failing~~ - tests fixed
~~please remember that if you want to merge this, then this should be merged alongside https://github.com/Expensify/Mobile-Expensify/pull/13451~~ merging another PR no longer needed

github-actions · 2025-03-17T07:56:47Z

⚠️ This PR is possibly changing native code and/or updating libraries, it may cause problems with HybridApp. Please check if any patch updates are required in the HybridApp repo and run an AdHoc build to verify that HybridApp will not break. Ask Contributor Plus for help if you are not sure how to handle this. ⚠️

mountiny · 2025-03-17T17:27:18Z

Sorry, wrong PR

github-actions · 2025-03-18T06:53:11Z

⚠️ This PR is possibly changing native code and/or updating libraries, it may cause problems with HybridApp. Please check if any patch updates are required in the HybridApp repo and run an AdHoc build to verify that HybridApp will not break. Ask Contributor Plus for help if you are not sure how to handle this. ⚠️

OSBotify · 2025-03-19T16:08:47Z

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

github-actions · 2025-03-20T15:36:24Z

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

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

github-actions · 2025-03-21T22:20:26Z

🚀 Deployed to production by https://github.com/luacmartins in version: 9.1.16-4 🚀

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

Kicu force-pushed the kicu/38025-green-mention branch 2 times, most recently from b85d761 to a140a7f Compare December 16, 2024 10:02

Kicu force-pushed the kicu/38025-green-mention branch 2 times, most recently from f179eee to 4ddb91e Compare December 31, 2024 09:46

Kicu changed the title ~~WIP Show current user mention in MarkdownTextInput with green outline~~ [WIP] Show current user mention in MarkdownTextInput with green outline Dec 31, 2024

Kicu force-pushed the kicu/38025-green-mention branch from 4ddb91e to 8a8e5cd Compare December 31, 2024 10:15

Kicu mentioned this pull request Dec 31, 2024

[Due for payment 2025-03-28] Render shortened mentions with blue/green outline in live markdown preview #38025

Closed

Kicu force-pushed the kicu/38025-green-mention branch 5 times, most recently from d88cb60 to 43cf3f3 Compare January 9, 2025 13:23

Kicu force-pushed the kicu/38025-green-mention branch from 43cf3f3 to eca0668 Compare January 13, 2025 09:01

Kicu changed the title ~~[WIP] Show current user mention in MarkdownTextInput with green outline~~ Show current user mention in MarkdownTextInput with green outline Jan 13, 2025

Kicu changed the title ~~Show current user mention in MarkdownTextInput with green outline~~ Show short mentions and current user mention in MarkdownTextInput with styling Jan 13, 2025

Kicu force-pushed the kicu/38025-green-mention branch from eca0668 to 508c4a3 Compare January 20, 2025 12:01

shubham1206agra mentioned this pull request Jan 27, 2025

Add handling short mentions tags to ExpensiMark Expensify/expensify-common#824

Merged

Kicu force-pushed the kicu/38025-green-mention branch from 508c4a3 to d09c805 Compare February 5, 2025 16:08

Kicu force-pushed the kicu/38025-green-mention branch from d09c805 to 6801386 Compare March 4, 2025 15:27

shubham1206agra mentioned this pull request Mar 5, 2025

[Due for payment 2025-07-25] [$500] Mention disappears when including 's #50724

Closed

6 tasks

shubham1206agra reviewed Mar 14, 2025

View reviewed changes

src/components/RNMarkdownTextInput.tsx Outdated Show resolved Hide resolved

fix runOnLiveMarkdownRuntime called in RNMarkdownTextInputWithRef

de55a2b

Co-authored-by: Shubham Agrawal <58412969+shubham1206agra@users.noreply.github.com>

shubham1206agra approved these changes Mar 14, 2025

View reviewed changes

melvin-bot bot requested a review from thienlnam March 14, 2025 14:07

thienlnam previously approved these changes Mar 15, 2025

View reviewed changes

Merge branch 'main' into kicu/38025-green-mention

c351507

Always mock runOnLiveMarkdownRuntime fn

9b5e29d

Kicu dismissed thienlnam’s stale review via 9b5e29d March 17, 2025 07:56

mountiny requested review from luacmartins and mountiny March 17, 2025 15:57

mountiny assigned Kicu Mar 17, 2025

mountiny removed request for luacmartins and mountiny March 17, 2025 17:27

Fix missing call to worklet shared value in SearchAutocompleteInput

7a4bc4f

puneetlath approved these changes Mar 19, 2025

View reviewed changes

puneetlath merged commit 4318f0f into Expensify:main Mar 19, 2025
25 checks passed

github-actions bot mentioned this pull request Mar 20, 2025

Deploy Checklist: New Expensify 2025-03-20 #58801

Closed

72 tasks

lakchote mentioned this pull request Mar 21, 2025

[Due for payment 2025-04-07] Mention - Mention disappears briefly in chat view after sending text with mention #58887

Closed

8 tasks

MariaHCD mentioned this pull request Mar 21, 2025

[Due for payment 2025-04-07] [$250] Mention - Field preview does not show @gmail.com when field supports live mark down #58893

Closed

8 tasks

Conversation

Kicu commented Dec 12, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Explanation of Change

Details:

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

Kicu commented Jan 9, 2025

Uh oh!

Kicu commented Feb 6, 2025

Uh oh!

shubham1206agra commented Feb 18, 2025

Uh oh!

Kicu commented Feb 21, 2025

Uh oh!

puneetlath commented Feb 24, 2025

Uh oh!

Kicu commented Feb 27, 2025

Uh oh!

puneetlath commented Mar 3, 2025

Uh oh!

Kicu commented Mar 4, 2025

Uh oh!

github-actions bot commented Mar 4, 2025

Uh oh!

puneetlath commented Mar 4, 2025

Uh oh!

Kicu commented Mar 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

shubham1206agra commented Mar 14, 2025

Reviewer Checklist

Screenshots/Videos

Uh oh!

github-actions bot commented Mar 14, 2025

Uh oh!

thienlnam left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Mar 17, 2025

Uh oh!

Kicu commented Mar 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Mar 17, 2025

Uh oh!

mountiny commented Mar 17, 2025

Uh oh!

github-actions bot commented Mar 18, 2025

Uh oh!

Uh oh!

OSBotify commented Mar 19, 2025

Uh oh!

github-actions bot commented Mar 20, 2025

Uh oh!

github-actions bot commented Mar 21, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

Kicu commented Dec 12, 2024 •

edited

Loading

Kicu commented Mar 14, 2025 •

edited

Loading

Kicu commented Mar 17, 2025 •

edited

Loading