Introduce API endpoints to mark user notifications as read

Author: Cyperghost

ts/WoltLabSuite/Core/Api/Users/Notifications/MarkAllUserNotificationsAsRead.ts

@@ -0,0 +1,18 @@
+/**
+ * Marks all user notifications as read.
+ *
+ * @author Olaf Braun
+ * @copyright 2001-2025 WoltLab GmbH
+ * @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
+ * @since 6.3
+ * @woltlabExcludeBundle tiny
+ */
+
+import { prepareRequest } from "WoltLabSuite/Core/Ajax/Backend";
+import { fromInfallibleApiRequest } from "WoltLabSuite/Core/Api/Result";
+
+export async function markAllUserNotificationsAsRead(): Promise<[]> {
+  return fromInfallibleApiRequest(() => {
+    return prepareRequest(`${window.WSC_RPC_API_URL}core/users/notifications/mark-all-as-read`).post().fetchAsJson();
+  });
+}

ts/WoltLabSuite/Core/Api/Users/Notifications/MarkUserNotificationAsRead.ts

@@ -0,0 +1,24 @@
+/**
+ * Marks a user notification as read.
+ *
+ * @author Olaf Braun
+ * @copyright 2001-2025 WoltLab GmbH
+ * @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
+ * @since 6.3
+ * @woltlabExcludeBundle tiny
+ */
+
+import { fromInfallibleApiRequest } from "WoltLabSuite/Core/Api/Result";
+import { prepareRequest } from "WoltLabSuite/Core/Ajax/Backend";
+
+type Response = {
+  unreadNotifications: number;
+};
+
+export async function markUserNotificationAsRead(notificationId: number): Promise<Response> {
+  return fromInfallibleApiRequest(() => {
+    return prepareRequest(`${window.WSC_RPC_API_URL}core/users/notifications/${notificationId}/mark-as-read`)
+      .post()
+      .fetchAsJson();
+  });
+}

ts/WoltLabSuite/Core/Controller/User/Notification/List.ts

@@ -8,11 +8,12 @@
  * @woltlabExcludeBundle tiny
  */
 
-import { dboAction } from "WoltLabSuite/Core/Ajax";
 import { confirmationFactory } from "WoltLabSuite/Core/Component/Confirmation";
 import { showDefaultSuccessSnackbar } from "WoltLabSuite/Core/Component/Snackbar";
 import { promiseMutex } from "WoltLabSuite/Core/Helper/PromiseMutex";
 import { getPhrase } from "WoltLabSuite/Core/Language";
+import { markAllUserNotificationsAsRead } from "WoltLabSuite/Core/Api/Users/Notifications/MarkAllUserNotificationsAsRead";
+import { markUserNotificationAsRead } from "WoltLabSuite/Core/Api/Users/Notifications/MarkUserNotificationAsRead";
 
 function initMarkAllAsRead(): void {
   document.querySelector(".jsMarkAllAsConfirmed")?.addEventListener(
@@ -29,7 +30,7 @@ async function markAllAsRead(): Promise<void> {
     return;
   }
 
-  await dboAction("markAllAsConfirmed", "wcf\\data\\user\\notification\\UserNotificationAction").dispatch();
+  await markAllUserNotificationsAsRead();
 
   showDefaultSuccessSnackbar().addEventListener("snackbar:close", () => {
     window.location.reload();
@@ -46,9 +47,7 @@ function initMarkAsRead(): void {
 }
 
 async function markAsRead(element: HTMLElement): Promise<void> {
-  await dboAction("markAsConfirmed", "wcf\\data\\user\\notification\\UserNotificationAction")
-    .objectIds([parseInt(element.dataset.objectId!)])
-    .dispatch();
+  await markUserNotificationAsRead(parseInt(element.dataset.objectId!, 10));
 
   element.querySelector(".notificationListItem__unread")?.remove();
   element.dataset.isRead = "true";

ts/WoltLabSuite/Core/Ui/User/Menu/Data/Notification.ts

@@ -14,6 +14,8 @@ import { registerProvider } from "../Manager";
 import * as Language from "../../../../Language";
 import { enableNotifications } from "../../../../Notification/Handler";
 import { registerServiceWorker, updateNotificationLastReadTime } from "../../../../Notification/ServiceWorker";
+import { markUserNotificationAsRead } from "WoltLabSuite/Core/Api/Users/Notifications/MarkUserNotificationAsRead";
+import { markAllUserNotificationsAsRead } from "WoltLabSuite/Core/Api/Users/Notifications/MarkAllUserNotificationsAsRead";
 
 let originalFavicon = "";
 function setFaviconCounter(counter: number): void {
@@ -277,16 +279,14 @@ class UserMenuDataNotification implements DesktopNotifications, UserMenuProvider
   }
 
   async markAsRead(objectId: number): Promise<void> {
-    const response = (await dboAction("markAsConfirmed", "wcf\\data\\user\\notification\\UserNotificationAction")
-      .objectIds([objectId])
-      .dispatch()) as ResponseMarkAsRead;
+    const { unreadNotifications } = await markUserNotificationAsRead(objectId);
     updateNotificationLastReadTime();
 
-    this.updateCounter(response.totalCount);
+    this.updateCounter(unreadNotifications);
   }
 
   async markAllAsRead(): Promise<void> {
-    await dboAction("markAllAsConfirmed", "wcf\\data\\user\\notification\\UserNotificationAction").dispatch();
+    await markAllUserNotificationsAsRead();
     updateNotificationLastReadTime();
 
     this.updateCounter(0);

wcfsetup/install/files/js/WoltLabSuite/Core/Api/Users/Notifications/MarkAllUserNotificationsAsRead.js

@@ -226,6 +226,8 @@ static function (\wcf\event\endpoint\ControllerCollecting $event) {
             $event->register(new \wcf\system\endpoint\controller\core\users\groups\assignment\EnableAssignment());
             $event->register(new \wcf\system\endpoint\controller\core\users\groups\assignment\DisableAssignment());
             $event->register(new \wcf\system\endpoint\controller\core\users\groups\DeleteGroup());
+            $event->register(new \wcf\system\endpoint\controller\core\users\notifications\MarkUserNotificationAsRead());
+            $event->register(new \wcf\system\endpoint\controller\core\users\notifications\MarkAllUserNotificationsAsRead());
             $event->register(new \wcf\system\endpoint\controller\core\menus\DeleteMenu());
             $event->register(new \wcf\system\endpoint\controller\core\trophies\EnableTrophy());
             $event->register(new \wcf\system\endpoint\controller\core\trophies\DisableTrophy());

wcfsetup/install/files/js/WoltLabSuite/Core/Api/Users/Notifications/MarkUserNotificationAsRead.js

@@ -0,0 +1,85 @@
+<?php
+
+namespace wcf\command\user\notification;
+
+use wcf\event\user\notification\AllUserNotificationsMarkAsRead;
+use wcf\system\database\util\PreparedStatementConditionBuilder;
+use wcf\system\event\EventHandler;
+use wcf\system\user\storage\UserStorageHandler;
+use wcf\system\WCF;
+
+/**
+ * Marks all user notifications as read.
+ *
+ * @author Olaf Braun
+ * @copyright 2001-2025 WoltLab GmbH
+ * @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
+ * @since 6.3
+ */
+final class MarkAllUserNotificationsAsRead
+{
+    public function __construct(
+        private readonly int $userID,
+    ) {}
+
+    public function __invoke(): void
+    {
+        // Step 1) Find the IDs of the unread notifications.
+        // This is done in a separate step, because this allows the UPDATE query to
+        // leverage fine-grained locking of exact rows based off the PRIMARY KEY.
+        // Simply updating all notifications belonging to a specific user will need
+        // to prevent concurrent threads from inserting new notifications for proper
+        // consistency, possibly leading to deadlocks.
+        $notificationIDs = $this->getUnreadNotificationIDs();
+
+        if ($notificationIDs !== []) {
+            // Step 2) Mark the notifications as read.
+            $this->markNotificationsAsRead($notificationIDs);
+        }
+
+        $this->clearCache();
+
+        $event = new AllUserNotificationsMarkAsRead($this->userID);
+        EventHandler::getInstance()->fire($event);
+    }
+
+    /**
+     * @return list<int>
+     */
+    private function getUnreadNotificationIDs(): array
+    {
+        $sql = "SELECT  notificationID
+                FROM    wcf1_user_notification
+                WHERE   userID = ?
+                    AND confirmTime = ?
+                    AND time < ?";
+        $statement = WCF::getDB()->prepare($sql);
+        $statement->execute([
+            $this->userID,
+            0,
+            TIME_NOW,
+        ]);
+
+        return $statement->fetchAll(\PDO::FETCH_COLUMN);
+    }
+
+    /**
+     * @param list<int> $notificationIDs
+     */
+    private function markNotificationsAsRead(array $notificationIDs): void
+    {
+        $condition = new PreparedStatementConditionBuilder();
+        $condition->add('notificationID IN (?)', [$notificationIDs]);
+
+        $sql = "UPDATE  wcf1_user_notification
+                SET     confirmTime = ?
+                {$condition}";
+        $statement = WCF::getDB()->prepare($sql);
+        $statement->execute(\array_merge([TIME_NOW], $condition->getParameters()));
+    }
+
+    private function clearCache(): void
+    {
+        UserStorageHandler::getInstance()->reset([$this->userID], 'userNotificationCount');
+    }
+}