IBX-9060: Added mark as unread functionality for notifications

src/contracts/Repository/Decorator/NotificationServiceDecorator.php

@@ -40,6 +40,11 @@ public function markNotificationAsRead(Notification $notification): void
         $this->innerService->markNotificationAsRead($notification);
     }
 
+    public function markNotificationAsUnread(Notification $notification): void
+    {
+        $this->innerService->markNotificationAsUnread($notification);
+    }
+
     public function getPendingNotificationCount(): int
     {
         return $this->innerService->getPendingNotificationCount();

src/contracts/Repository/Events/Notification/BeforeMarkNotificationAsUnreadEvent.php

@@ -0,0 +1,28 @@
+<?php
+
+/**
+ * @copyright Copyright (C) Ibexa AS. All rights reserved.
+ * @license For full copyright and license information view LICENSE file distributed with this source code.
+ */
+declare(strict_types=1);
+
+namespace Ibexa\Contracts\Core\Repository\Events\Notification;
+
+use Ibexa\Contracts\Core\Repository\Event\BeforeEvent;
+use Ibexa\Contracts\Core\Repository\Values\Notification\Notification;
+
+final class BeforeMarkNotificationAsUnreadEvent extends BeforeEvent
+{
+    /** @var \Ibexa\Contracts\Core\Repository\Values\Notification\Notification */
+    private $notification;
+
+    public function __construct(Notification $notification)
+    {
+        $this->notification = $notification;
+    }
+
+    public function getNotification(): Notification
+    {
+        return $this->notification;
+    }
+}

src/contracts/Repository/Events/Notification/MarkNotificationAsUnreadEvent.php

@@ -0,0 +1,28 @@
+<?php
+
+/**
+ * @copyright Copyright (C) Ibexa AS. All rights reserved.
+ * @license For full copyright and license information view LICENSE file distributed with this source code.
+ */
+declare(strict_types=1);
+
+namespace Ibexa\Contracts\Core\Repository\Events\Notification;
+
+use Ibexa\Contracts\Core\Repository\Event\AfterEvent;
+use Ibexa\Contracts\Core\Repository\Values\Notification\Notification;
+
+final class MarkNotificationAsUnreadEvent extends AfterEvent
+{
+    /** @var \Ibexa\Contracts\Core\Repository\Values\Notification\Notification */
+    private $notification;
+
+    public function __construct(Notification $notification)
+    {
+        $this->notification = $notification;
+    }
+
+    public function getNotification(): Notification
+    {
+        return $this->notification;
+    }
+}

src/contracts/Repository/NotificationService.php

@@ -49,6 +49,16 @@ public function getNotification(int $notificationId): Notification;
      */
     public function markNotificationAsRead(Notification $notification): void;
 
+    /**
+     * Mark notification as unread so it no longer bother the user.
+     *
+     * @param \Ibexa\Contracts\Core\Repository\Values\Notification\Notification $notification
+     *
+     * @throws \Ibexa\Contracts\Core\Repository\Exceptions\NotFoundException
+     * @throws \Ibexa\Contracts\Core\Repository\Exceptions\UnauthorizedException
+     */
+    public function markNotificationAsUnread(Notification $notification): void;
+
     /**
      * Get count of unread users notifications.
      *

src/lib/Event/NotificationService.php

@@ -12,9 +12,11 @@
 use Ibexa\Contracts\Core\Repository\Events\Notification\BeforeCreateNotificationEvent;
 use Ibexa\Contracts\Core\Repository\Events\Notification\BeforeDeleteNotificationEvent;
 use Ibexa\Contracts\Core\Repository\Events\Notification\BeforeMarkNotificationAsReadEvent;
+use Ibexa\Contracts\Core\Repository\Events\Notification\BeforeMarkNotificationAsUnreadEvent;
 use Ibexa\Contracts\Core\Repository\Events\Notification\CreateNotificationEvent;
 use Ibexa\Contracts\Core\Repository\Events\Notification\DeleteNotificationEvent;
 use Ibexa\Contracts\Core\Repository\Events\Notification\MarkNotificationAsReadEvent;
+use Ibexa\Contracts\Core\Repository\Events\Notification\MarkNotificationAsUnreadEvent;
 use Ibexa\Contracts\Core\Repository\NotificationService as NotificationServiceInterface;
 use Ibexa\Contracts\Core\Repository\Values\Notification\CreateStruct;
 use Ibexa\Contracts\Core\Repository\Values\Notification\Notification;
@@ -52,6 +54,24 @@ public function markNotificationAsRead(Notification $notification): void
         );
     }
 
+    public function markNotificationAsUnread(Notification $notification): void
+    {
+        $eventData = [$notification];
+
+        $beforeEvent = new BeforeMarkNotificationAsUnreadEvent(...$eventData);
+
+        $this->eventDispatcher->dispatch($beforeEvent);
+        if ($beforeEvent->isPropagationStopped()) {
+            return;
+        }
+
+        $this->innerService->markNotificationAsUnread($notification);
+
+        $this->eventDispatcher->dispatch(
+            new MarkNotificationAsUnreadEvent(...$eventData)
+        );
+    }
+
     public function createNotification(CreateStruct $createStruct): Notification
     {
         $eventData = [$createStruct];

src/lib/Repository/NotificationService.php

@@ -112,7 +112,7 @@
         }
 
         if ($notification->ownerId !== $currentUserId) {
             throw new UnauthorizedException($notification->id, 'Notification');
         }
 
         if (!$notification->isPending) {
@@ -125,6 +125,31 @@
         $this->persistenceHandler->updateNotification($notification, $updateStruct);
     }
 
+    /**
+     * {@inheritdoc}
+     */
+    public function markNotificationAsUnread(APINotification $notification): void
+    {
+        $currentUserId = $this->getCurrentUserId();
+
+        if (!$notification->id) {
+            throw new NotFoundException('Notification', $notification->id);
+        }
+
+        if ($notification->ownerId !== $currentUserId) {
+            throw new UnauthorizedException($notification->id, 'Notification');
+        }
+
+        if ($notification->isPending) {
+            return;
+        }
+
+        $updateStruct = new UpdateStruct();
+        $updateStruct->isPending = true;
+
+        $this->persistenceHandler->updateNotification($notification, $updateStruct);
+    }
+
     /**
      * {@inheritdoc}
      */

src/lib/Repository/SiteAccessAware/NotificationService.php

@@ -62,6 +62,16 @@ public function markNotificationAsRead(Notification $notification): void
         $this->service->markNotificationAsRead($notification);
     }
 
+    /**
+     * Mark notification as unread so it no longer bother the user.
+     *
+     * @param \Ibexa\Contracts\Core\Repository\Values\Notification\Notification $notification
+     */
+    public function markNotificationAsUnread(Notification $notification): void
+    {
+        $this->service->markNotificationAsUnread($notification);
+    }
+
     /**
      * Get count of unread users notifications.
      *

tests/integration/Core/Repository/NotificationServiceTest.php

@@ -77,6 +77,25 @@
         $this->assertFalse($notification->isPending);
     }
 
+    /**
+     * @covers \Ibexa\Contracts\Core\Repository\NotificationService::markNotificationAsUnread()
+     */
+    public function testMarkNotificationAsUnread()
+    {
+        $repository = $this->getRepository();
+
+        $notificationId = $this->generateId('notification', 5);
+        /* BEGIN: Use Case */
+        $notificationService = $repository->getNotificationService();
+
+        $notification = $notificationService->getNotification($notificationId);
+        $notificationService->markNotificationAsUnread($notification);
+        $notification = $notificationService->getNotification($notificationId);
+        /* END: Use Case */
+
+        self::assertTrue($notification->isPending);
+    }
+
     /**
      * @covers \Ibexa\Contracts\Core\Repository\NotificationService::getPendingNotificationCount()
      */

tests/lib/Event/NotificationServiceTest.php

@@ -9,9 +9,11 @@
 use Ibexa\Contracts\Core\Repository\Events\Notification\BeforeCreateNotificationEvent;
 use Ibexa\Contracts\Core\Repository\Events\Notification\BeforeDeleteNotificationEvent;
 use Ibexa\Contracts\Core\Repository\Events\Notification\BeforeMarkNotificationAsReadEvent;
+use Ibexa\Contracts\Core\Repository\Events\Notification\BeforeMarkNotificationAsUnreadEvent;
 use Ibexa\Contracts\Core\Repository\Events\Notification\CreateNotificationEvent;
 use Ibexa\Contracts\Core\Repository\Events\Notification\DeleteNotificationEvent;
 use Ibexa\Contracts\Core\Repository\Events\Notification\MarkNotificationAsReadEvent;
+use Ibexa\Contracts\Core\Repository\Events\Notification\MarkNotificationAsUnreadEvent;
 use Ibexa\Contracts\Core\Repository\NotificationService as NotificationServiceInterface;
 use Ibexa\Contracts\Core\Repository\Values\Notification\CreateStruct;
 use Ibexa\Contracts\Core\Repository\Values\Notification\Notification;
@@ -200,6 +202,31 @@
         $this->assertSame([], $traceableEventDispatcher->getNotCalledListeners());
     }
 
+    public function testMarkNotificationAsUnreadEvents()
+    {
+        $traceableEventDispatcher = $this->getEventDispatcher(
+            BeforeMarkNotificationAsUnreadEvent::class,
+            MarkNotificationAsUnreadEvent::class
+        );
+
+        $parameters = [
+            $this->createMock(Notification::class),
+        ];
+
+        $innerServiceMock = $this->createMock(NotificationServiceInterface::class);
+
+        $service = new NotificationService($innerServiceMock, $traceableEventDispatcher);
+        $service->markNotificationAsUnread(...$parameters);
+
+        $calledListeners = $this->getListenersStack($traceableEventDispatcher->getCalledListeners());
+
+        self::assertSame($calledListeners, [
+            [BeforeMarkNotificationAsUnreadEvent::class, 0],
+            [MarkNotificationAsUnreadEvent::class, 0],
+        ]);
+        self::assertSame([], $traceableEventDispatcher->getNotCalledListeners());
+    }
+
     public function testMarkNotificationAsReadStopPropagationInBeforeEvents()
     {
         $traceableEventDispatcher = $this->getEventDispatcher(
@@ -231,6 +258,38 @@
             [MarkNotificationAsReadEvent::class, 0],
         ]);
     }
+
+    public function testMarkNotificationAsUnreadStopPropagationInBeforeEvents()
+    {
+        $traceableEventDispatcher = $this->getEventDispatcher(
+            BeforeMarkNotificationAsUnreadEvent::class,
+            MarkNotificationAsUnreadEvent::class
+        );
+
+        $parameters = [
+            $this->createMock(Notification::class),
+        ];
+
+        $innerServiceMock = $this->createMock(NotificationServiceInterface::class);
+
+        $traceableEventDispatcher->addListener(BeforeMarkNotificationAsUnreadEvent::class, static function (BeforeMarkNotificationAsUnreadEvent $event) {
+            $event->stopPropagation();
+        }, 10);
+
+        $service = new NotificationService($innerServiceMock, $traceableEventDispatcher);
+        $service->markNotificationAsUnread(...$parameters);
+
+        $calledListeners = $this->getListenersStack($traceableEventDispatcher->getCalledListeners());
+        $notCalledListeners = $this->getListenersStack($traceableEventDispatcher->getNotCalledListeners());
+
+        self::assertSame($calledListeners, [
+            [BeforeMarkNotificationAsUnreadEvent::class, 10],
+        ]);
+        self::assertSame($notCalledListeners, [
+            [BeforeMarkNotificationAsUnreadEvent::class, 0],
+            [MarkNotificationAsUnreadEvent::class, 0],
+        ]);
+    }
 }
 
 class_alias(NotificationServiceTest::class, 'eZ\Publish\Core\Event\Tests\NotificationServiceTest');

tests/lib/Repository/Decorator/NotificationServiceDecoratorTest.php

@@ -67,6 +67,18 @@
         $decoratedService->markNotificationAsRead(...$parameters);
     }
 
+    public function testMarkNotificationAsUnreadDecorator()
+    {
+        $serviceMock = $this->createServiceMock();
+        $decoratedService = $this->createDecorator($serviceMock);
+
+        $parameters = [$this->createMock(Notification::class)];
+
+        $serviceMock->expects(self::once())->method('markNotificationAsunread')->with(...$parameters);
+
+        $decoratedService->markNotificationAsunread(...$parameters);
+    }
+
     public function testGetPendingNotificationCountDecorator()
     {
         $serviceMock = $this->createServiceMock();