fix(ui): mentions highlighting escaping username #2362
Conversation
WalkthroughUpdated MessageX.replaceMentions to escape the username in the mention-matching RegExp using RegExp.escape(userName ?? ''), changing the pattern from '@($userId|$userName)' to '@( Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
Tip 🔌 Remote MCP (Model Context Protocol) integration is now available!Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats. 📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 💡 Knowledge Base configuration:
You can enable these sources in your CodeRabbit configuration. 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (10)
✨ Finishing Touches🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
geweald
changed the title
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
packages/stream_chat_flutter/lib/src/utils/extensions.dart (1)
385-400: Optional: prevent double-matching inside the generated Markdown and tighten token boundariesToday, after one user is replaced with "@name", the next user’s regex can still match the "@name" inside the square brackets because the pattern isn’t boundary-aware. Consider constraining matches to mention token boundaries and avoiding "[": for example:
- Prepend a single-char negative lookbehind to avoid links:
(?<!\[)- Optionally require start or whitespace before "@":
(?<!\S)- Optionally add an end boundary (word boundary or whitespace/punct/end): e.g.,
(?:\b|$|(?=[\s\.,:;!?\)\]\}]))Illustrative pattern (keep behavior if you prefer current liberal matching):
final mentionRe = RegExp( '(?<!\\[)(?<!\\S)@($alternatives)(?=\$|\\b|[\\s\\.,:;!\\?\\)\\]\\}])' );Happy to wire this into the current code if you want to harden matching further.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
packages/stream_chat_flutter/lib/src/utils/extensions.dart(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (10)
- GitHub Check: conventional_pr_title
- GitHub Check: stream_chat_localizations
- GitHub Check: stream_chat_flutter
- GitHub Check: stream_chat_flutter_core
- GitHub Check: stream_chat
- GitHub Check: stream_chat_persistence
- GitHub Check: analyze_legacy_versions
- GitHub Check: build (android)
- GitHub Check: test
- GitHub Check: build (ios)
| RegExp('@($userId|${RegExp.escape(userName)})'), | ||
| '[@$userName]($userId)', | ||
| ); |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Escape both id and name + handle nullable usernames to avoid compile error and regex over-matching
- user.name is nullable; passing it to RegExp.escape(...) will fail at compile time (String? → String).
- userId isn’t escaped; if it contains regex metacharacters (e.g., . + ?), the pattern will over-match.
- When user.name is null/empty, the current replacement renders "null" in the output.
Apply this focused change in-place to both branches:
- RegExp('@($userId|${RegExp.escape(userName)})'),
- '[@$userName]($userId)',
+ RegExp('@(${RegExp.escape(userId)}${(userName?.isNotEmpty ?? false) ? '|${RegExp.escape(userName!)}' : ''})'),
+ '[@${(userName?.isNotEmpty ?? false) ? userName! : userId}]($userId)',- RegExp('@($userId|${RegExp.escape(userName)})'),
- '@$userName',
+ RegExp('@(${RegExp.escape(userId)}${(userName?.isNotEmpty ?? false) ? '|${RegExp.escape(userName!)}' : ''})'),
+ '@${(userName?.isNotEmpty ?? false) ? userName! : userId}',This:
- Keeps the username alternative only when present to avoid an empty alternation.
- Escapes both id and name.
- Falls back to id in the rendered label when name is null/empty.
Also applies to: 396-398
Submit a pull request
Linear: FLU-
Github Issue: #
CLA
Description of the pull request
Highlighting usernames was broken when usernames with characters breaking regexp (eg. Tester (X))
Screenshots / Videos
Summary by CodeRabbit