Skip to content

Inject room and attendee into chat notifier #6959

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

Merged
nickvergessen merged 2 commits into from
Mar 15, 2022
Merged

Inject room and attendee into chat notifier #6959

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2080e40
Inject the room instead of querying it over and over again
nickvergessen Mar 4, 2022
c92c703
Inject the attendee as well when loaded already
nickvergessen Mar 4, 2022
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
51 changes: 26 additions & 25 deletions lib/Chat/Notifier.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@
namespace OCA\Talk\Chat;

use OCA\Talk\Exceptions\ParticipantNotFoundException;
use OCA\Talk\Exceptions\RoomNotFoundException;
use OCA\Talk\Files\Util;
use OCA\Talk\Manager;
use OCA\Talk\Model\Attendee;
Expand Down Expand Up @@ -94,7 +93,7 @@ public function __construct(INotificationManager $notificationManager,
* @param array[] $alreadyNotifiedUsers
* @psalm-param array<int, array{id: string, type: string}> $alreadyNotifiedUsers
* @return string[] Users that were mentioned
* @psalm-return array<int, array{id: string, type: string}>
* @psalm-return array<int, array{id: string, type: string, ?attendee: Attendee}>
*/
public function notifyMentionedUsers(Room $chat, IComment $comment, array $alreadyNotifiedUsers): array {
$usersToNotify = $this->getUsersToNotify($chat, $comment, $alreadyNotifiedUsers);
Expand All @@ -104,8 +103,9 @@ public function notifyMentionedUsers(Room $chat, IComment $comment, array $alrea
}
$notification = $this->createNotification($chat, $comment, 'mention');
$shouldFlush = $this->notificationManager->defer();

foreach ($usersToNotify as $mentionedUser) {
if ($this->shouldMentionedUserBeNotified($mentionedUser['id'], $comment)) {
if ($this->shouldMentionedUserBeNotified($mentionedUser['id'], $comment, $chat, $mentionedUser['attendee'] ?? null)) {
$notification->setUser($mentionedUser['id']);
$this->notificationManager->notify($notification);
$alreadyNotifiedUsers[] = $mentionedUser;
Expand All @@ -125,7 +125,7 @@ public function notifyMentionedUsers(Room $chat, IComment $comment, array $alrea
* @param array $alreadyNotifiedUsers
* @psalm-param array<int, array{id: string, type: string}> $alreadyNotifiedUsers
* @return array
* @psalm-return array<int, array{id: string, type: string}>
* @psalm-return array<int, array{id: string, type: string, ?attendee: Attendee}>
*/
private function getUsersToNotify(Room $chat, IComment $comment, array $alreadyNotifiedUsers): array {
$usersToNotify = $this->getMentionedUsers($comment);
Expand Down Expand Up @@ -159,7 +159,7 @@ private function removeAlreadyNotifiedUsers(array $usersToNotify, array $already
* @param array $list
* @psalm-param array<int, array{id: string, type: string}> $list
* @return array
* @psalm-return array<int, array{id: string, type: string}>
* @psalm-return array<int, array{id: string, type: string, ?attendee: Attendee}>
*/
private function addMentionAllToList(Room $chat, array $list): array {
$usersToNotify = array_filter($list, static function (array $user): bool {
Expand All @@ -170,18 +170,19 @@ private function addMentionAllToList(Room $chat, array $list): array {
return $usersToNotify;
}

$chatParticipants = $this->participantService->getActorsByType($chat, Attendee::ACTOR_USERS);
foreach ($chatParticipants as $participant) {
$alreadyAddedToNotify = array_filter($list, static function ($user) use ($participant): bool {
return $user['id'] === $participant->getActorId();
$attendees = $this->participantService->getActorsByType($chat, Attendee::ACTOR_USERS);
foreach ($attendees as $attendee) {
$alreadyAddedToNotify = array_filter($list, static function ($user) use ($attendee): bool {
return $user['id'] === $attendee->getActorId();
});
if (!empty($alreadyAddedToNotify)) {
continue;
}

$usersToNotify[] = [
'id' => $participant->getActorId(),
'type' => $participant->getActorType()
'id' => $attendee->getActorId(),
'type' => $attendee->getActorType(),
'attendee' => $attendee,
];
}

Expand Down Expand Up @@ -210,7 +211,7 @@ public function notifyReplyToAuthor(Room $chat, IComment $comment, IComment $rep
return [];
}

if (!$this->shouldMentionedUserBeNotified($replyTo->getActorId(), $comment)) {
if (!$this->shouldMentionedUserBeNotified($replyTo->getActorId(), $comment, $chat)) {
return [];
}

Expand Down Expand Up @@ -238,7 +239,7 @@ public function notifyReplyToAuthor(Room $chat, IComment $comment, IComment $rep
* @param Room $chat
* @param IComment $comment
* @param array[] $alreadyNotifiedUsers
* @psalm-param array<int, array{id: string, type: string}> $alreadyNotifiedUsers
* @psalm-param array<int, array{id: string, type: string, ?attendee: Attendee}> $alreadyNotifiedUsers
*/
public function notifyOtherParticipant(Room $chat, IComment $comment, array $alreadyNotifiedUsers): void {
$participants = $this->participantService->getParticipantsByNotificationLevel($chat, Participant::NOTIFY_ALWAYS);
Expand Down Expand Up @@ -426,27 +427,27 @@ protected function getDefaultGroupNotification(): int {
*
* @param string $userId
* @param IComment $comment
* @param Room $room
* @param Attendee|null $attendee
* @return bool
*/
protected function shouldMentionedUserBeNotified(string $userId, IComment $comment): bool {
protected function shouldMentionedUserBeNotified(string $userId, IComment $comment, Room $room, ?Attendee $attendee = null): bool {
if ($comment->getActorType() === Attendee::ACTOR_USERS && $userId === $comment->getActorId()) {
// Do not notify the user if they mentioned themselves
return false;
}

if (!$this->userManager->userExists($userId)) {
return false;
}

try {
$room = $this->manager->getRoomById((int) $comment->getObjectId());
} catch (RoomNotFoundException $e) {
return false;
}
if (!$attendee instanceof Attendee) {
if (!$this->userManager->userExists($userId)) {
return false;
}

try {
$participant = $room->getParticipant($userId, false);
$notificationLevel = $participant->getAttendee()->getNotificationLevel();
$participant = $room->getParticipant($userId, false);
$attendee = $participant->getAttendee();
}

$notificationLevel = $attendee->getNotificationLevel();
if ($notificationLevel === Participant::NOTIFY_DEFAULT) {
if ($room->getType() === Room::TYPE_ONE_TO_ONE) {
$notificationLevel = Participant::NOTIFY_ALWAYS;
Expand Down
10 changes: 9 additions & 1 deletion tests/php/Chat/NotifierTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -341,7 +341,15 @@ public function testAddMentionAllToList(array $usersToNotify, array $participant
->willReturn($participants);

$actual = $this->invokePrivate($this->getNotifier(), 'addMentionAllToList', [$room, $usersToNotify]);
$this->assertEqualsCanonicalizing($return, $actual);
$this->assertCount(count($return), $actual);
foreach ($actual as $key => $value) {
$this->assertIsArray($value);
if (key_exists('attendee', $value)) {
$this->assertInstanceOf(Attendee::class, $value['attendee']);
unset($value['attendee']);
}
$this->assertEqualsCanonicalizing($return[$key], $value);
}
}

public function dataAddMentionAllToList(): array {
Expand Down