feat: follow-up changes on BEP #22641

Signed-off-by: Heikki Hellgren <heikki.hellgren@op.fi>

plugins/notifications-backend/migrations/20231215_init.js

@@ -19,14 +19,17 @@ exports.up = async function up(knex) {
     table.uuid('id').primary();
     table.string('userRef').notNullable();
     table.string('title').notNullable();
-    table.text('description').notNullable();
+    table.text('description').nullable();
+    table.text('severity').notNullable();
     table.text('link').notNullable();
+    table.text('origin').notNullable();
+    table.text('scope').nullable();
     table.text('topic').nullable();
     table.datetime('created').defaultTo(knex.fn.now()).notNullable();
     table.datetime('updated').nullable();
     table.datetime('read').nullable();
     table.datetime('done').nullable();
-    table.boolean('saved').defaultTo(false).notNullable();
+    table.datetime('saved').nullable();
   });
 };
 

plugins/notifications-backend/src/database/DatabaseNotificationsStore.ts

@@ -95,7 +95,7 @@ export class DatabaseNotificationsStore implements NotificationsStore {
       }
     }
 
-    if ('ids' in options && options.ids) {
+    if (options.ids) {
       query.whereIn('id', options.ids);
     }
 
@@ -131,13 +131,15 @@ export class DatabaseNotificationsStore implements NotificationsStore {
     };
   }
 
-  async getExistingTopicNotification(options: {
+  async getExistingScopeNotification(options: {
     user_ref: string;
-    topic: string;
+    scope: string;
+    origin: string;
   }) {
     const query = this.db('notifications')
       .where('userRef', options.user_ref)
-      .where('topic', options.topic)
+      .where('scope', options.scope)
+      .where('origin', options.origin)
       .select('*')
       .limit(1);
 
@@ -156,11 +158,12 @@ export class DatabaseNotificationsStore implements NotificationsStore {
       .where('id', options.id)
       .where('userRef', options.notification.userRef);
     const rows = await query.update({
-      title: options.notification.title,
-      description: options.notification.description,
-      link: options.notification.link,
-      topic: options.notification.topic,
+      title: options.notification.payload.title,
+      description: options.notification.payload.description,
+      link: options.notification.payload.link,
+      topic: options.notification.payload.topic,
       updated: options.notification.created,
+      severity: options.notification.payload.severity,
       read: null,
       done: null,
     });
@@ -205,11 +208,11 @@ export class DatabaseNotificationsStore implements NotificationsStore {
 
   async markSaved(options: NotificationModifyOptions): Promise<void> {
     const notificationQuery = this.getNotificationsBaseQuery(options);
-    await notificationQuery.update({ saved: true });
+    await notificationQuery.update({ saved: new Date() });
   }
 
   async markUnsaved(options: NotificationModifyOptions): Promise<void> {
     const notificationQuery = this.getNotificationsBaseQuery(options);
-    await notificationQuery.update({ saved: false });
+    await notificationQuery.update({ saved: null });
   }
 }

plugins/notifications-backend/src/database/NotificationsStore.ts

@@ -23,6 +23,8 @@ import {
 /** @public */
 export type NotificationGetOptions = {
   user_ref: string;
+
+  ids?: string[];
   type?: NotificationType;
   offset?: number;
   limit?: number;
@@ -40,9 +42,10 @@ export interface NotificationsStore {
 
   saveNotification(notification: Notification): Promise<void>;
 
-  getExistingTopicNotification(options: {
+  getExistingScopeNotification(options: {
     user_ref: string;
-    topic: string;
+    scope: string;
+    origin: string;
   }): Promise<Notification | null>;
 
   restoreExistingNotification(options: {

plugins/notifications-backend/src/service/router.ts

@@ -209,104 +209,67 @@ export async function createRouter(
     res.send(status);
   });
 
-  router.post('/done', async (req, res) => {
+  router.post('/update', async (req, res) => {
     const user = await getUser(req);
-    const { ids } = req.body;
+    const { ids, done, read, saved } = req.body;
     if (!ids || !Array.isArray(ids)) {
       res.status(400).send();
       return;
     }
-    await store.markDone({ user_ref: user, ids });
+    if (done === true) {
+      await store.markDone({ user_ref: user, ids });
+      if (signalService) {
+        await signalService.publish({
+          recipients: [user],
+          message: { action: 'done', notification_ids: ids },
+          channel: 'notifications',
+        });
+      }
+    } else if (done === false) {
+      await store.markUndone({ user_ref: user, ids });
+      if (signalService) {
+        await signalService.publish({
+          recipients: [user],
+          message: { action: 'undone', notification_ids: ids },
+          channel: 'notifications',
+        });
+      }
+    }
 
-    if (signalService) {
-      await signalService.publish({
-        recipients: [user],
-        message: { action: 'done', notification_ids: ids },
-        channel: 'notifications',
-      });
-    }
-    res.status(200).send({ ids });
-  });
+    if (read === true) {
+      await store.markRead({ user_ref: user, ids });
 
-  router.post('/undo', async (req, res) => {
-    const user = await getUser(req);
-    const { ids } = req.body;
-    if (!ids || !Array.isArray(ids)) {
-      res.status(400).send();
-      return;
-    }
-    await store.markUndone({ user_ref: user, ids });
-    if (signalService) {
-      await signalService.publish({
-        recipients: [user],
-        message: { action: 'undone', notification_ids: ids },
-        channel: 'notifications',
-      });
-    }
-    res.status(200).send({ ids });
-  });
+      if (signalService) {
+        await signalService.publish({
+          recipients: [user],
+          message: { action: 'mark_read', notification_ids: ids },
+          channel: 'notifications',
+        });
+      }
+    } else if (read === false) {
+      await store.markUnread({ user_ref: user, ids });
 
-  router.post('/read', async (req, res) => {
-    const user = await getUser(req);
-    const { ids } = req.body;
-    if (!ids || !Array.isArray(ids)) {
-      res.status(400).send();
-      return;
+      if (signalService) {
+        await signalService.publish({
+          recipients: [user],
+          message: { action: 'mark_unread', notification_ids: ids },
+          channel: 'notifications',
+        });
+      }
     }
-    await store.markRead({ user_ref: user, ids });
 
-    if (signalService) {
-      await signalService.publish({
-        recipients: [user],
-        message: { action: 'mark_read', notification_ids: ids },
-        channel: 'notifications',
-      });
+    if (saved === true) {
+      await store.markSaved({ user_ref: user, ids });
+    } else if (saved === false) {
+      await store.markUnsaved({ user_ref: user, ids });
     }
-    res.status(200).send({ ids });
-  });
 
-  router.post('/unread', async (req, res) => {
-    const user = await getUser(req);
-    const { ids } = req.body;
-    if (!ids || !Array.isArray(ids)) {
-      res.status(400).send();
-      return;
-    }
-    await store.markUnread({ user_ref: user, ids });
-    if (signalService) {
-      await signalService.publish({
-        recipients: [user],
-        message: { action: 'mark_unread', notification_ids: ids },
-        channel: 'notifications',
-      });
-    }
-    res.status(200).send({ ids });
-  });
-
-  router.post('/save', async (req, res) => {
-    const user = await getUser(req);
-    const { ids } = req.body;
-    if (!ids || !Array.isArray(ids)) {
-      res.status(400).send();
-      return;
-    }
-    await store.markSaved({ user_ref: user, ids });
-    res.status(200).send({ ids });
-  });
-
-  router.post('/unsave', async (req, res) => {
-    const user = await getUser(req);
-    const { ids } = req.body;
-    if (!ids || !Array.isArray(ids)) {
-      res.status(400).send();
-      return;
-    }
-    await store.markUnsaved({ user_ref: user, ids });
-    res.status(200).send({ ids });
+    const notifications = await store.getNotifications({ ids, user_ref: user });
+    res.status(200).send(notifications);
   });
 
   router.post('/notifications', async (req, res) => {
-    const { receivers, title, description, link, topic } = req.body;
+    const { recipients, origin, payload } = req.body;
     const notifications = [];
     let users = [];
 
@@ -318,9 +281,17 @@ export async function createRouter(
       return;
     }
 
+    const { title, link, description, scope } = payload;
+
+    if (!recipients || !title || !origin || !link) {
+      logger.error(`Invalid notification request received`);
+      res.status(400).send();
+      return;
+    }
+
     let entityRef = null;
-    if (receivers.entityRef && receivers.type === 'entity') {
-      entityRef = receivers.entityRef;
+    if (recipients.entityRef && recipients.type === 'entity') {
+      entityRef = recipients.entityRef;
     }
 
     try {
@@ -331,13 +302,13 @@ export async function createRouter(
       return;
     }
 
-    const baseNotification = {
-      title,
-      description,
-      link,
-      topic,
+    const baseNotification: Omit<Notification, 'id' | 'userRef'> = {
+      payload: {
+        ...payload,
+        severity: payload.severity ?? 'normal',
+      },
+      origin,
       created: new Date(),
-      saved: false,
     };
 
     for (const user of users) {
@@ -349,10 +320,11 @@ export async function createRouter(
       const notification = await decorateNotification(userNotification);
 
       let existingNotification;
-      if (topic) {
-        existingNotification = await store.getExistingTopicNotification({
+      if (scope) {
+        existingNotification = await store.getExistingScopeNotification({
           user_ref: user,
-          topic,
+          scope,
+          origin,
         });
       }