IBX-9060: Added bulk mark-as-read functionality for user notifications

tbialcz · tbialcz · commit 8414b4a70d3b · 2025-08-05T12:19:20.000+02:00
diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -41394,12 +41394,6 @@ parameters:
 			count: 1
 			path: tests/integration/Core/Repository/LanguageServiceAuthorizationTest.php
 
-		-
-			message: '#^Comparison operation "\<" between int\<70400, 80499\> and 50400 is always false\.$#'
-			identifier: smaller.alwaysFalse
-			count: 1
-			path: tests/integration/Core/Repository/LanguageServiceMaximumSupportedLanguagesTest.php
-
 		-
 			message: '#^Method Ibexa\\Tests\\Integration\\Core\\Repository\\LanguageServiceMaximumSupportedLanguagesTest\:\:testCreateMaximumLanguageLimit\(\) has no return type specified\.$#'
 			identifier: missingType.return
@@ -41412,12 +41406,6 @@ parameters:
 			count: 1
 			path: tests/integration/Core/Repository/LanguageServiceMaximumSupportedLanguagesTest.php
 
-		-
-			message: '#^Result of && is always false\.$#'
-			identifier: booleanAnd.alwaysFalse
-			count: 1
-			path: tests/integration/Core/Repository/LanguageServiceMaximumSupportedLanguagesTest.php
-
 		-
 			message: '#^Call to method PHPUnit\\Framework\\Assert\:\:assertInstanceOf\(\) with ''Ibexa\\\\Contracts\\\\Core\\\\Repository\\\\Values\\\\Content\\\\Language'' and Ibexa\\Contracts\\Core\\Repository\\Values\\Content\\Language will always evaluate to true\.$#'
 			identifier: method.alreadyNarrowedType
diff --git a/src/contracts/Persistence/Notification/Handler.php b/src/contracts/Persistence/Notification/Handler.php
@@ -33,6 +33,18 @@ public function createNotification(CreateStruct $createStruct): Notification;
      */
     public function updateNotification(APINotification $notification, UpdateStruct $updateStruct): Notification;
 
+    /**
+     * @param int[] $notificationIds
+     *
+     * @return int[]
+     */
+    public function bulkUpdateUserNotifications(
+        int $ownerId,
+        UpdateStruct $updateStruct,
+        bool $pendingOnly = false,
+        array $notificationIds = []
+    ): array;
+
     /**
      * Count users unread Notifications.
      *
diff --git a/src/contracts/Repository/Decorator/NotificationServiceDecorator.php b/src/contracts/Repository/Decorator/NotificationServiceDecorator.php
@@ -41,6 +41,14 @@ public function getNotification(int $notificationId): Notification
         return $this->innerService->getNotification($notificationId);
     }
 
+    /**
+     * @param int[] $notificationIds
+     */
+    public function markUserNotificationsAsRead(array $notificationIds = []): void
+    {
+        $this->innerService->markUserNotificationsAsRead($notificationIds);
+    }
+
     public function markNotificationAsRead(Notification $notification): void
     {
         $this->innerService->markNotificationAsRead($notification);
diff --git a/src/contracts/Repository/NotificationService.php b/src/contracts/Repository/NotificationService.php
@@ -34,6 +34,11 @@ public function findNotifications(?NotificationQuery $query = null): Notificatio
      */
     public function getNotification(int $notificationId): Notification;
 
+    /**
+     * @param int[] $notificationIds
+     */
+    public function markUserNotificationsAsRead(array $notificationIds = []): void;
+
     /**
      * Mark notification as read so it no longer bother the user.
      *
diff --git a/src/lib/Persistence/Cache/NotificationHandler.php b/src/lib/Persistence/Cache/NotificationHandler.php
@@ -38,6 +38,37 @@ public function createNotification(CreateStruct $createStruct): Notification
         return $this->persistenceHandler->notificationHandler()->createNotification($createStruct);
     }
 
+    public function bulkUpdateUserNotifications(
+        int $ownerId,
+        UpdateStruct $updateStruct,
+        bool $pendingOnly = false,
+        array $notificationIds = []
+    ): array {
+        $this->logger->logCall(__METHOD__, [
+            'userId' => $ownerId,
+            'notificationIds' => $notificationIds,
+        ]);
+
+        $updatedNotificationIds = $this->persistenceHandler
+            ->notificationHandler()
+            ->bulkUpdateUserNotifications($ownerId, $updateStruct, $pendingOnly, $notificationIds);
+
+        $cacheKeys = array_map(
+            fn (int $id) => $this->cacheIdentifierGenerator->generateKey(self::NOTIFICATION_IDENTIFIER, [$id], true),
+            $updatedNotificationIds
+        );
+
+        $cacheKeys[] = $this->cacheIdentifierGenerator->generateKey(
+            self::NOTIFICATION_PENDING_COUNT_IDENTIFIER,
+            [$ownerId],
+            true
+        );
+
+        $this->cache->deleteItems($cacheKeys);
+
+        return $updatedNotificationIds;
+    }
+
     /**
      * {@inheritdoc}
      */
diff --git a/src/lib/Persistence/Legacy/Notification/Gateway.php b/src/lib/Persistence/Legacy/Notification/Gateway.php
@@ -42,6 +42,17 @@ abstract public function getNotificationById(int $notificationId): array;
      */
     abstract public function updateNotification(Notification $notification): void;
 
+    /**
+     * @param int[] $notificationIds
+     *
+     * @return int[]
+     */
+    abstract public function bulkUpdateUserNotifications(
+        Notification $notification,
+        bool $pendingOnly = false,
+        array $notificationIds = []
+    ): array;
+
     abstract public function countUserNotifications(int $userId, ?NotificationQuery $query = null): int;
 
     /**
diff --git a/src/lib/Persistence/Legacy/Notification/Gateway/DoctrineDatabase.php b/src/lib/Persistence/Legacy/Notification/Gateway/DoctrineDatabase.php
@@ -82,6 +82,62 @@ public function getNotificationById(int $notificationId): array
         return $query->execute()->fetchAllAssociative();
     }
 
+    /**
+     * @param int[] $notificationIds
+     *
+     * @return int[]
+     */
+    public function bulkUpdateUserNotifications(
+        Notification $notification,
+        bool $pendingOnly = false,
+        array $notificationIds = []
+    ): array {
+        if (!is_int($notification->ownerId) || $notification->ownerId <= 0) {
+            throw new InvalidArgumentException('ownerId', 'Cannot bulk update notifications without valid ownerId');
+        }
+
+        $queryBuilder = $this->connection->createQueryBuilder();
+        $queryBuilder
+            ->select(self::COLUMN_ID)
+            ->from(self::TABLE_NOTIFICATION)
+            ->andWhere($queryBuilder->expr()->eq(self::COLUMN_OWNER_ID, ':ownerId'))
+            ->setParameter(':ownerId', $notification->ownerId, PDO::PARAM_INT);
+
+        if ($pendingOnly) {
+            $queryBuilder->andWhere($queryBuilder->expr()->eq(self::COLUMN_IS_PENDING, ':isPendingFlag'))
+                ->setParameter(':isPendingFlag', true, PDO::PARAM_BOOL);
+        }
+
+        if (!empty($notificationIds)) {
+            $queryBuilder->andWhere(
+                $queryBuilder->expr()->in(
+                    self::COLUMN_ID,
+                    array_map('strval', $notificationIds)
+                )
+            );
+        }
+
+        $rows = $queryBuilder->execute()->fetchAllAssociative();
+        if (empty($rows)) {
+            return [];
+        }
+
+        $idsToUpdate = array_map('intval', array_column($rows, self::COLUMN_ID));
+
+        $updateQuery = $this->connection->createQueryBuilder();
+        $updateQuery
+            ->update(self::TABLE_NOTIFICATION)
+            ->set(self::COLUMN_IS_PENDING, ':is_pending')
+            ->andWhere(
+                $updateQuery->expr()->in(self::COLUMN_ID, array_map('strval', $idsToUpdate))
+            )
+            ->setParameter(':is_pending', $notification->isPending, PDO::PARAM_BOOL);
+
+        $updateQuery->execute();
+
+        return $idsToUpdate;
+    }
+
     public function updateNotification(Notification $notification): void
     {
         if (!isset($notification->id) || !is_numeric($notification->id)) {
@@ -113,7 +169,7 @@ public function countUserNotifications(int $userId, ?NotificationQuery $query =
             $this->applyFilters($queryBuilder, $query->getCriteria());
         }
 
-        return (int)$queryBuilder->execute()->fetchColumn();
+        return (int)$queryBuilder->execute()->fetchOne();
     }
 
     public function countUserPendingNotifications(int $userId): int
diff --git a/src/lib/Persistence/Legacy/Notification/Gateway/ExceptionConversion.php b/src/lib/Persistence/Legacy/Notification/Gateway/ExceptionConversion.php
@@ -44,6 +44,15 @@ public function getNotificationById(int $notificationId): array
         }
     }
 
+    public function bulkUpdateUserNotifications(Notification $notification, bool $pendingOnly = false, array $notificationIds = []): array
+    {
+        try {
+            return $this->innerGateway->bulkUpdateUserNotifications($notification, $pendingOnly, $notificationIds);
+        } catch (DBALException | PDOException $e) {
+            throw DatabaseException::wrap($e);
+        }
+    }
+
     public function updateNotification(Notification $notification): void
     {
         try {
diff --git a/src/lib/Persistence/Legacy/Notification/Handler.php b/src/lib/Persistence/Legacy/Notification/Handler.php
@@ -72,6 +72,18 @@ public function getNotificationById(int $notificationId): Notification
         return reset($notification);
     }
 
+    public function bulkUpdateUserNotifications(
+        int $ownerId,
+        UpdateStruct $updateStruct,
+        bool $pendingOnly = false,
+        array $notificationIds = []
+    ): array {
+        $notification = $this->mapper->createNotificationFromUpdateStruct($updateStruct);
+        $notification->ownerId = $ownerId;
+
+        return $this->gateway->bulkUpdateUserNotifications($notification, $pendingOnly, $notificationIds);
+    }
+
     /**
      * {@inheritdoc}
      *
diff --git a/src/lib/Repository/NotificationService.php b/src/lib/Repository/NotificationService.php
@@ -109,6 +109,18 @@ public function getNotification(int $notificationId): APINotification
         return $this->buildDomainObject($notification);
     }
 
+    /**
+     * @param int[] $notificationIds
+     */
+    public function markUserNotificationsAsRead(array $notificationIds = []): void
+    {
+        $currentUserId = $this->getCurrentUserId();
+        $updateStruct = new UpdateStruct();
+        $updateStruct->isPending = false;
+
+        $this->persistenceHandler->bulkUpdateUserNotifications($currentUserId, $updateStruct, true, $notificationIds);
+    }
+
     public function markNotificationAsRead(APINotification $notification): void
     {
         $currentUserId = $this->getCurrentUserId();
diff --git a/src/lib/Repository/SiteAccessAware/NotificationService.php b/src/lib/Repository/SiteAccessAware/NotificationService.php
@@ -50,6 +50,14 @@ public function getNotification(int $notificationId): Notification
         return $this->service->getNotification($notificationId);
     }
 
+    /**
+     * @param int[] $notificationIds
+     */
+    public function markUserNotificationsAsRead(array $notificationIds = []): void
+    {
+        $this->service->markUserNotificationsAsRead($notificationIds);
+    }
+
     /**
      * Mark notification as read so it no longer bother the user.
      *
diff --git a/tests/integration/Core/Repository/LanguageServiceMaximumSupportedLanguagesTest.php b/tests/integration/Core/Repository/LanguageServiceMaximumSupportedLanguagesTest.php
@@ -6,8 +6,6 @@
  */
 namespace Ibexa\Tests\Integration\Core\Repository;
 
-use Ibexa\Contracts\Core\Test\Repository\SetupFactory\Legacy as LegacySetupFactory;
-
 /**
  * Test case for maximum number of languages supported in the LanguageService.
  *
@@ -35,14 +33,6 @@ protected function setUp(): void
         $languageCreate = $this->languageService->newLanguageCreateStruct();
         $languageCreate->enabled = true;
 
-        // SKIP If using sqlite, PHP 5.3 and 64bit, tests will fail as int column seems to be limited to 32bit on 64bit
-        if (\PHP_VERSION_ID < 50400 && PHP_INT_SIZE === 8) {
-            $setupFactory = $this->getSetupFactory();
-            if ($setupFactory instanceof LegacySetupFactory && $setupFactory->getDB() === 'sqlite') {
-                $this->markTestSkipped('Skip on Sqlite, PHP 5.3 and 64bit, as int column is limited to 32bit on 64bit');
-            }
-        }
-
         // Create as much languages as possible
         for ($i = count($this->languageService->loadLanguages()) + 1; $i <= 8 * PHP_INT_SIZE - 2; ++$i) {
             $languageCreate->name = "Language $i";
diff --git a/tests/integration/Core/Repository/NotificationServiceTest.php b/tests/integration/Core/Repository/NotificationServiceTest.php
@@ -69,6 +69,20 @@ public function testGetNotification(): void
         $this->assertEquals($notificationId, $notification->id);
     }
 
+    public function testMarkUserNotificationsAsRead(): void
+    {
+        $repository = $this->getRepository();
+        $notificationService = $repository->getNotificationService();
+
+        $pendingCountBefore = $notificationService->getPendingNotificationCount();
+        $this->assertGreaterThan(0, $pendingCountBefore);
+
+        $notificationService->markUserNotificationsAsRead();
+
+        $pendingCountAfter = $notificationService->getPendingNotificationCount();
+        $this->assertEquals(0, $pendingCountAfter);
+    }
+
     public function testMarkNotificationAsRead(): void
     {
         $repository = $this->getRepository();
diff --git a/tests/lib/Persistence/Cache/NotificationHandlerTest.php b/tests/lib/Persistence/Cache/NotificationHandlerTest.php
@@ -100,6 +100,29 @@ public function providerForUnCachedMethods(): array
             [
                 'findUserNotifications', [$ownerId, new NotificationQuery([], 0, 25)], null, null, null, null, [],
             ],
+            [
+                'bulkUpdateUserNotifications',
+                [
+                    $ownerId,
+                    new UpdateStruct(['isPending' => false]),
+                    true,
+                ],
+                null,
+                [
+                    ['notification', [1], true],
+                    ['notification', [2], true],
+                    ['notification', [3], true],
+                    ['notification_pending_count', [$ownerId], true],
+                ],
+                null,
+                [
+                    'ibx-n-1',
+                    'ibx-n-2',
+                    'ibx-n-3',
+                    'ibx-npc-' . $ownerId,
+                ],
+                [1, 2, 3],
+            ],
         ];
     }
 
diff --git a/tests/lib/Persistence/Legacy/Notification/Gateway/DoctrineDatabaseTest.php b/tests/lib/Persistence/Legacy/Notification/Gateway/DoctrineDatabaseTest.php
@@ -251,6 +251,28 @@ private function loadNotification(int $id): array
 
         return is_array($data) ? $data : [];
     }
+
+    public function testBulkUpdateUserNotifications(): void
+    {
+        $notification = new Notification([
+            'ownerId' => self::EXISTING_NOTIFICATION_DATA['owner_id'],
+            'isPending' => false,
+        ]);
+
+        $updatedIds = $this->getGateway()->bulkUpdateUserNotifications($notification);
+
+        self::assertIsArray($updatedIds);
+        self::assertNotEmpty($updatedIds);
+
+        foreach ($updatedIds as $id) {
+            self::assertIsInt($id);
+        }
+
+        foreach ($updatedIds as $id) {
+            $data = $this->loadNotification($id);
+            self::assertEquals('0', (string) $data['is_pending']);
+        }
+    }
 }
 
 class_alias(DoctrineDatabaseTest::class, 'eZ\Publish\Core\Persistence\Legacy\Tests\Notification\Gateway\DoctrineDatabaseTest');
diff --git a/tests/lib/Persistence/Legacy/Notification/HandlerTest.php b/tests/lib/Persistence/Legacy/Notification/HandlerTest.php
diff --git a/tests/lib/Repository/Decorator/NotificationServiceDecoratorTest.php b/tests/lib/Repository/Decorator/NotificationServiceDecoratorTest.php

Original file line number	Diff line number	Diff line change
`@@ -41,6 +41,14 @@ public function getNotification(int $notificationId): Notification`
`41`	`41`	`return $this->innerService->getNotification($notificationId);`
`42`	`42`	`}`
`43`	`43`
	`44`	`+ /**`
	`45`	`+ * @param int[] $notificationIds`
	`46`	`+ */`
	`47`	`+ public function markUserNotificationsAsRead(array $notificationIds = []): void`
	`48`	`+ {`
	`49`	`+ $this->innerService->markUserNotificationsAsRead($notificationIds);`
	`50`	`+ }`
	`51`	`+`
`44`	`52`	`public function markNotificationAsRead(Notification $notification): void`
`45`	`53`	`{`
`46`	`54`	`$this->innerService->markNotificationAsRead($notification);`
Original file line number	Diff line number	Diff line change
`@@ -44,6 +44,15 @@ public function getNotificationById(int $notificationId): array`
`44`	`44`	`}`
`45`	`45`	`}`
`46`	`46`
	`47`	`+ public function bulkUpdateUserNotifications(Notification $notification, bool $pendingOnly = false, array $notificationIds = []): array`
	`48`	`+ {`
	`49`	`+ try {`
	`50`	`+ return $this->innerGateway->bulkUpdateUserNotifications($notification, $pendingOnly, $notificationIds);`
	`51`	`+ } catch (DBALException \| PDOException $e) {`
	`52`	`+ throw DatabaseException::wrap($e);`
	`53`	`+ }`
	`54`	`+ }`
	`55`	`+`
`47`	`56`	`public function updateNotification(Notification $notification): void`
`48`	`57`	`{`
`49`	`58`	`try {`