ahtlon/deck
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

Merge pull request #6008 from nextcloud/chore/comments-event-legacy

Browse Source 
chore: Move comments event handler to use proper event dispatcher
This commit is contained in:
Julius Härtl
2024-06-28 16:16:19 +02:00
committed by GitHub
parent a6b31d6a5f 261e6d0362
commit 2f5d39fc5b
3 changed files with 29 additions and 47 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
lib/AppInfo/Application.php
View File

@@ -9,7 +9,6 @@ namespace OCA\Deck\AppInfo;
use Closure; use Closure;
use Exception; use Exception;
use OCA\Circles\Events\CircleDestroyedEvent; use OCA\Circles\Events\CircleDestroyedEvent;
use OCA\Deck\Activity\CommentEventHandler;
use OCA\Deck\Capabilities; use OCA\Deck\Capabilities;
use OCA\Deck\Collaboration\Resources\ResourceProvider; use OCA\Deck\Collaboration\Resources\ResourceProvider;
use OCA\Deck\Collaboration\Resources\ResourceProviderCard; use OCA\Deck\Collaboration\Resources\ResourceProviderCard;
@@ -28,6 +27,7 @@ use OCA\Deck\Event\CardUpdatedEvent;
use OCA\Deck\Event\SessionClosedEvent; use OCA\Deck\Event\SessionClosedEvent;
use OCA\Deck\Event\SessionCreatedEvent; use OCA\Deck\Event\SessionCreatedEvent;
use OCA\Deck\Listeners\BeforeTemplateRenderedListener; use OCA\Deck\Listeners\BeforeTemplateRenderedListener;
use OCA\Deck\Listeners\CommentEventListener;
use OCA\Deck\Listeners\FullTextSearchEventListener; use OCA\Deck\Listeners\FullTextSearchEventListener;
use OCA\Deck\Listeners\LiveUpdateListener; use OCA\Deck\Listeners\LiveUpdateListener;
use OCA\Deck\Listeners\ParticipantCleanupListener; use OCA\Deck\Listeners\ParticipantCleanupListener;
@@ -56,7 +56,7 @@ use OCP\Collaboration\Reference\RenderReferenceEvent;
use OCP\Collaboration\Resources\IProviderManager; use OCP\Collaboration\Resources\IProviderManager;
use OCP\Collaboration\Resources\LoadAdditionalScriptsEvent; use OCP\Collaboration\Resources\LoadAdditionalScriptsEvent;
use OCP\Comments\CommentsEntityEvent; use OCP\Comments\CommentsEntityEvent;
use OCP\Comments\ICommentsManager; use OCP\Comments\CommentsEvent;
use OCP\EventDispatcher\IEventDispatcher; use OCP\EventDispatcher\IEventDispatcher;
use OCP\Group\Events\GroupDeletedEvent; use OCP\Group\Events\GroupDeletedEvent;
use OCP\IConfig; use OCP\IConfig;
@@ -91,7 +91,6 @@ class Application extends App implements IBootstrap {
public function boot(IBootContext $context): void { public function boot(IBootContext $context): void {
$context->injectFn(Closure::fromCallable([$this, 'registerCommentsEntity'])); $context->injectFn(Closure::fromCallable([$this, 'registerCommentsEntity']));
$context->injectFn(Closure::fromCallable([$this, 'registerCommentsEventHandler']));
$context->injectFn(Closure::fromCallable([$this, 'registerCollaborationResources'])); $context->injectFn(Closure::fromCallable([$this, 'registerCollaborationResources']));
$context->injectFn(function (IManager $shareManager) { $context->injectFn(function (IManager $shareManager) {
@@ -141,6 +140,7 @@ class Application extends App implements IBootstrap {
$context->registerEventListener(AclCreatedEvent::class, FullTextSearchEventListener::class); $context->registerEventListener(AclCreatedEvent::class, FullTextSearchEventListener::class);
$context->registerEventListener(AclUpdatedEvent::class, FullTextSearchEventListener::class); $context->registerEventListener(AclUpdatedEvent::class, FullTextSearchEventListener::class);
$context->registerEventListener(AclDeletedEvent::class, FullTextSearchEventListener::class); $context->registerEventListener(AclDeletedEvent::class, FullTextSearchEventListener::class);
$context->registerEventListener(CommentsEvent::class, CommentEventListener::class);
// Handling cache invalidation for collections // Handling cache invalidation for collections
$context->registerEventListener(AclCreatedEvent::class, ResourceListener::class); $context->registerEventListener(AclCreatedEvent::class, ResourceListener::class);
@@ -184,12 +184,6 @@ class Application extends App implements IBootstrap {
}); });
} }
protected function registerCommentsEventHandler(ICommentsManager $commentsManager): void {
$commentsManager->registerEventHandler(function () {
return $this->getContainer()->query(CommentEventHandler::class);
});
}
protected function registerCollaborationResources(IProviderManager $resourceManager): void { protected function registerCollaborationResources(IProviderManager $resourceManager): void {
$resourceManager->registerResourceProvider(ResourceProvider::class); $resourceManager->registerResourceProvider(ResourceProvider::class);
$resourceManager->registerResourceProvider(ResourceProviderCard::class); $resourceManager->registerResourceProvider(ResourceProviderCard::class);

55
lib/Activity/CommentEventHandler.php → lib/Listeners/CommentEventListener.php
View File

@@ -1,43 +1,37 @@
<?php <?php
declare(strict_types=1);
/** /**
* SPDX-FileCopyrightText: 2018 Nextcloud GmbH and Nextcloud contributors * SPDX-FileCopyrightText: 2018 Nextcloud GmbH and Nextcloud contributors
* SPDX-License-Identifier: AGPL-3.0-or-later * SPDX-License-Identifier: AGPL-3.0-or-later
*/ */
namespace OCA\Deck\Activity; namespace OCA\Deck\Listeners;
use OCA\Deck\Activity\ActivityManager;
use OCA\Deck\Db\CardMapper; use OCA\Deck\Db\CardMapper;
use OCA\Deck\Db\ChangeHelper; use OCA\Deck\Db\ChangeHelper;
use OCA\Deck\Notification\NotificationHelper; use OCA\Deck\Notification\NotificationHelper;
use OCP\Comments\CommentsEvent; use OCP\Comments\CommentsEvent;
use OCP\Comments\IComment; use OCP\EventDispatcher\Event;
use OCP\Comments\ICommentsEventHandler; use OCP\EventDispatcher\IEventListener;
class CommentEventHandler implements ICommentsEventHandler { /** @template-implements IEventListener<CommentsEvent|Event> */
class CommentEventListener implements IEventListener {
/** @var ActivityManager */ public function __construct(
private $activityManager; private ActivityManager $activityManager,
private NotificationHelper $notificationHelper,
/** @var NotificationHelper */ private CardMapper $cardMapper,
private $notificationHelper; private ChangeHelper $changeHelper,
) {
/** @var CardMapper */ }
private $cardMapper;
public function handle(Event $event): void {
/** @var ChangeHelper */ if (!$event instanceof CommentsEvent) {
private $changeHelper; return;
public function __construct(ActivityManager $activityManager, NotificationHelper $notificationHelper, CardMapper $cardMapper, ChangeHelper $changeHelper) {
$this->notificationHelper = $notificationHelper;
$this->activityManager = $activityManager;
$this->cardMapper = $cardMapper;
$this->changeHelper = $changeHelper;
} }
/**
* @param CommentsEvent $event
*/
public function handle(CommentsEvent $event) {
if ($event->getComment()->getObjectType() !== 'deckCard') { if ($event->getComment()->getObjectType() !== 'deckCard') {
return; return;
} }
@@ -61,20 +55,13 @@ class CommentEventHandler implements ICommentsEventHandler {
} }
} }
/** private function activityHandler(CommentsEvent $event): void {
* @param CommentsEvent $event
*/
private function activityHandler(CommentsEvent $event) {
/** @var IComment $comment */
$comment = $event->getComment(); $comment = $event->getComment();
$card = $this->cardMapper->find($comment->getObjectId()); $card = $this->cardMapper->find($comment->getObjectId());
$this->activityManager->triggerEvent(ActivityManager::DECK_OBJECT_CARD, $card, ActivityManager::SUBJECT_CARD_COMMENT_CREATE, ['comment' => $comment]); $this->activityManager->triggerEvent(ActivityManager::DECK_OBJECT_CARD, $card, ActivityManager::SUBJECT_CARD_COMMENT_CREATE, ['comment' => $comment]);
} }
/** private function notificationHandler(CommentsEvent $event): void {
* @param CommentsEvent $event
*/
private function notificationHandler(CommentsEvent $event) {
$this->notificationHelper->sendMention($event->getComment()); $this->notificationHelper->sendMention($event->getComment());
} }
} }

9
tests/unit/Activity/CommentEventHandlerTest.php → tests/unit/Listeners/CommentEventListenerTest.php
View File

@@ -21,8 +21,9 @@
* *
*/ */
namespace OCA\Deck\Activity; namespace OCA\Deck\Listeners;
use OCA\Deck\Activity\ActivityManager;
use OCA\Deck\Db\Card; use OCA\Deck\Db\Card;
use OCA\Deck\Db\CardMapper; use OCA\Deck\Db\CardMapper;
use OCA\Deck\Db\ChangeHelper; use OCA\Deck\Db\ChangeHelper;
@@ -31,9 +32,9 @@ use OCP\Comments\CommentsEvent;
use OCP\Comments\IComment; use OCP\Comments\IComment;
use PHPUnit\Framework\TestCase; use PHPUnit\Framework\TestCase;
class CommentEventHandlerTest extends TestCase { class CommentEventListenerTest extends TestCase {
/** @var CommentEventHandler */ /** @var CommentEventListener */
private $commentEventHandler; private $commentEventHandler;
/** @var ActivityManager */ /** @var ActivityManager */
private $activityManager; private $activityManager;
@@ -49,7 +50,7 @@ class CommentEventHandlerTest extends TestCase {
$this->notificationHelper = $this->createMock(NotificationHelper::class); $this->notificationHelper = $this->createMock(NotificationHelper::class);
$this->cardMapper = $this->createMock(CardMapper::class); $this->cardMapper = $this->createMock(CardMapper::class);
$this->changeHelper = $this->createMock(ChangeHelper::class); $this->changeHelper = $this->createMock(ChangeHelper::class);
$this->commentEventHandler = new CommentEventHandler( $this->commentEventHandler = new CommentEventListener(
$this->activityManager, $this->activityManager,
$this->notificationHelper, $this->notificationHelper,
$this->cardMapper, $this->cardMapper,