-
Notifications
You must be signed in to change notification settings - Fork 10.5k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
fix: user highlights matching just part of words #33776
Open
sampaiodiego
wants to merge
4
commits into
develop
Choose a base branch
from
fix-user-highlights
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
--- | ||
'@rocket.chat/meteor': patch | ||
--- | ||
|
||
Fix user highlights not matching only whole words |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
21 changes: 21 additions & 0 deletions
21
apps/meteor/app/lib/server/functions/notifications/messageContainsHighlight.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
import type { IMessage } from '@rocket.chat/core-typings'; | ||
import { escapeRegExp } from '@rocket.chat/string-helpers'; | ||
|
||
/** | ||
* Checks if a message contains a user highlight | ||
* | ||
* @param {string} message | ||
* @param {array|undefined} highlights | ||
* | ||
* @returns {boolean} | ||
*/ | ||
export function messageContainsHighlight(message: Pick<IMessage, 'msg'>, highlights: string[] | undefined): boolean { | ||
if (!highlights || highlights.length === 0) { | ||
return false; | ||
} | ||
|
||
return highlights.some((highlight: string) => { | ||
const regexp = new RegExp(`\\b${escapeRegExp(highlight)}\\b`, 'i'); | ||
return regexp.test(message.msg); | ||
}); | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
41 changes: 41 additions & 0 deletions
41
...eteor/tests/unit/app/lib/server/functions/notifications/messageContainsHighlight.tests.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
import { expect } from 'chai'; | ||
import { describe, it } from 'mocha'; | ||
|
||
import { messageContainsHighlight } from '../../../../../../../app/lib/server/functions/notifications/messageContainsHighlight'; | ||
|
||
describe('messageContainsHighlight', () => { | ||
it('should return false for no highlights', async () => { | ||
const message = { | ||
msg: 'regular message', | ||
}; | ||
expect(messageContainsHighlight(message, [])).to.be.false; | ||
}); | ||
|
||
it('should return true when find a highlight in the beggining of the message', async () => { | ||
const message = { | ||
msg: 'highlighted regular message', | ||
}; | ||
expect(messageContainsHighlight(message, ['highlighted'])).to.be.true; | ||
}); | ||
|
||
it('should return true when find a highlight in the end of the message', async () => { | ||
const message = { | ||
msg: 'highlighted regular message', | ||
}; | ||
expect(messageContainsHighlight(message, ['message'])).to.be.true; | ||
}); | ||
|
||
it('should return false if the highlight is just part of the word', async () => { | ||
const message = { | ||
msg: 'highlighted regular message', | ||
}; | ||
expect(messageContainsHighlight(message, ['light'])).to.be.false; | ||
}); | ||
|
||
it('should return true if find one of the multiple highlights', async () => { | ||
const message = { | ||
msg: 'highlighted regular message', | ||
}; | ||
expect(messageContainsHighlight(message, ['high', 'ssage', 'regular', 'light'])).to.be.true; | ||
}); | ||
}); |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This will still make us highlight emojis (
:highlight:
), won't it? 🤔 I wonder if we should take the chance to fix this too (wdyt, do you consider them words too? I've already seem some complaints about this)There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
hmmm.. good point.. let me create a few unit tests
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
updated to not match emojis.. not the prettiest regex but that's the one I could come up with