Skip to content
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.

Sign up for GitHub

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

[stable20] Mention sub name users #5051

Merged
merged 3 commits into from
Jan 29, 2021
Merged

[stable20] Mention sub name users #5051

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
152fd2f
Fix mentioning users with subnames
nickvergessen Jan 28, 2021
4c3857f
Add an integration test for sub and subname mentions
nickvergessen Jan 28, 2021
416b93d
Add unit tests for subname mentions
danxuliu Jan 28, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 8 additions & 5 deletions lib/Chat/Parser/UserMention.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,11 @@ public function parseMessage(Message $chatMessage): void {
$mentionTypeCount = [];

$mentions = $comment->getMentions();
// TODO This can be removed once getMentions() returns sorted results (Nextcloud 21+)
usort($mentions, static function ($m1, $m2) {
return mb_strlen($m2['id']) <=> mb_strlen($m1['id']);
});

foreach ($mentions as $mention) {
if ($mention['type'] === 'user' && $mention['id'] === 'all') {
$mention['type'] = 'call';
Expand All @@ -101,12 +106,10 @@ public function parseMessage(Message $chatMessage): void {
// index of the mentions of that type.
$mentionParameterId = 'mention-' . $mention['type'] . $mentionTypeCount[$mention['type']];

if (strpos($mention['id'], ' ') !== false || strpos($mention['id'], 'guest/') === 0) {
$placeholder = '@"' . $mention['id'] . '"';
} else {
$placeholder = '@' . $mention['id'];
$message = str_replace('@"' . $mention['id'] . '"', '{' . $mentionParameterId . '}', $message);
if (strpos($mention['id'], ' ') === false && strpos($mention['id'], 'guest/') !== 0) {
$message = str_replace('@' . $mention['id'], '{' . $mentionParameterId . '}', $message);
}
$message = str_replace($placeholder, '{' . $mentionParameterId . '}', $message);

if ($mention['type'] === 'call') {
$messageParameters[$mentionParameterId] = [
Expand Down
12 changes: 12 additions & 0 deletions tests/integration/features/chat/rich-messages.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ Feature: chat/public
Given user "participant1" exists
Given user "participant2" exists
Given user "participant3" exists
Given user "participant3a" exists

Scenario: message without enrichable references has empty parameters
Given user "participant1" creates room "public room"
Expand Down Expand Up @@ -48,3 +49,14 @@ Feature: chat/public
Then user "participant1" sees the following messages in room "public room" with 200
| room | actorType | actorId | actorDisplayName | message | messageParameters |
| public room | users | participant1 | participant1-displayname | Mention to {mention-user1}, @unknownUser, {mention-user1} again and {mention-user2} | {"mention-user1":{"type":"user","id":"participant2","name":"participant2-displayname"},"mention-user2":{"type":"user","id":"participant3","name":"participant3-displayname"}} |

Scenario: message with mentions of subname users (uid1 is fully part of uid2)
Given user "participant1" creates room "public room"
| roomType | 3 |
| roomName | room |
When user "participant1" sends message "Mention to @participant3 and @participant3a" to room "public room" with 201
When user "participant1" sends message "Mention to @participant3a and @participant3" to room "public room" with 201
Then user "participant1" sees the following messages in room "public room" with 200
| room | actorType | actorId | actorDisplayName | message | messageParameters |
| public room | users | participant1 | participant1-displayname | Mention to {mention-user1} and {mention-user2} | {"mention-user1":{"type":"user","id":"participant3a","name":"participant3a-displayname"},"mention-user2":{"type":"user","id":"participant3","name":"participant3-displayname"}} |
| public room | users | participant1 | participant1-displayname | Mention to {mention-user2} and {mention-user1} | {"mention-user1":{"type":"user","id":"participant3a","name":"participant3a-displayname"},"mention-user2":{"type":"user","id":"participant3","name":"participant3-displayname"}} |
87 changes: 79 additions & 8 deletions tests/php/Chat/Parser/UserMentionTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -174,6 +174,80 @@ public function testGetRichMessageWithDuplicatedMention() {
$this->assertEquals($expectedMessageParameters, $chatMessage->getMessageParameters());
}

public function dataGetRichMessageWithMentionsFullyIncludedInOtherMentions() {
// Based on valid characters from server/lib/private/User/Manager.php
return [
['testUser', 'testUser1', false],
['testUser', 'testUser1', true],
['testUser', 'testUser_1', false],
['testUser', 'testUser_1', true],
['testUser', 'testUser.1', false],
['testUser', 'testUser.1', true],
['testUser', 'testUser@1', false],
['testUser', 'testUser@1', true],
['testUser', 'testUser-1', false],
['testUser', 'testUser-1', true],
['testUser', 'testUser\'1', false],
['testUser', 'testUser\'1', true],
];
}

/**
* @dataProvider dataGetRichMessageWithMentionsFullyIncludedInOtherMentions
*/
public function testGetRichMessageWithMentionsFullyIncludedInOtherMentions(string $baseId, string $longerId, bool $quoted) {
$mentions = [
['type' => 'user', 'id' => $baseId],
['type' => 'user', 'id' => $longerId],
];
$comment = $this->newComment($mentions);

$this->commentsManager->expects($this->exactly(2))
->method('resolveDisplayName')
->willReturnCallback(function ($type, $id) {
return $id . ' display name';
});

$this->userManager->expects($this->exactly(2))
->method('get')
->withConsecutive(
[$longerId],
[$baseId]
)
->willReturn($this->createMock(IUser::class));

/** @var Room|MockObject $room */
$room = $this->createMock(Room::class);
/** @var Participant|MockObject $participant */
$participant = $this->createMock(Participant::class);
/** @var IL10N|MockObject $l */
$l = $this->createMock(IL10N::class);
$chatMessage = new Message($room, $participant, $comment, $l);
if ($quoted) {
$chatMessage->setMessage('Mention to @"' . $baseId . '" and @"' . $longerId . '"', []);
} else {
$chatMessage->setMessage('Mention to @' . $baseId . ' and @' . $longerId, []);
}

$this->parser->parseMessage($chatMessage);

$expectedMessageParameters = [
'mention-user1' => [
'type' => 'user',
'id' => $longerId,
'name' => $longerId . ' display name'
],
'mention-user2' => [
'type' => 'user',
'id' => $baseId,
'name' => $baseId . ' display name'
],
];

$this->assertEquals('Mention to {mention-user2} and {mention-user1}', $chatMessage->getMessage());
$this->assertEquals($expectedMessageParameters, $chatMessage->getMessageParameters());
}

public function testGetRichMessageWithSeveralMentions() {
$mentions = [
['type'=>'user', 'id'=>'testUser1'],
Expand Down Expand Up @@ -249,15 +323,12 @@ public function testGetRichMessageWithNonExistingUserMention() {
->with('user', 'testUser')
->willReturn('testUser display name');

$this->userManager->expects($this->at(0))
->method('get')
->with('me')
->willReturn(null);

$this->userManager->expects($this->at(1))
$this->userManager->expects($this->exactly(2))
->method('get')
->with('testUser')
->willReturn($this->createMock(IUser::class));
->willReturnMap([
['me', null],
['testUser', $this->createMock(IUser::class)],
]);

/** @var Room|MockObject $room */
$room = $this->createMock(Room::class);
Expand Down