feat(server): notification system (#10053)

closes CLOUD-52
2026-07-18 18:46:19 +08:00 · 2025-03-06 15:25:05 +00:00
parent 81694a1144
commit 7302c4f954
20 changed files with 2356 additions and 14 deletions
@@ -0,0 +1,407 @@
+import { randomUUID } from 'node:crypto';
+import { mock } from 'node:test';
+
+import ava, { TestFn } from 'ava';
+
+import { createTestingModule, type TestingModule } from '../../__tests__/utils';
+import { Config } from '../../base/config';
+import {
+  Models,
+  NotificationLevel,
+  NotificationType,
+  User,
+  Workspace,
+} from '../../models';
+
+interface Context {
+  config: Config;
+  module: TestingModule;
+  models: Models;
+}
+
+const test = ava as TestFn<Context>;
+
+test.before(async t => {
+  const module = await createTestingModule();
+
+  t.context.models = module.get(Models);
+  t.context.config = module.get(Config);
+  t.context.module = module;
+});
+
+let user: User;
+let createdBy: User;
+let workspace: Workspace;
+let docId: string;
+
+test.beforeEach(async t => {
+  await t.context.module.initTestingDB();
+  user = await t.context.models.user.create({
+    email: 'test@affine.pro',
+  });
+  createdBy = await t.context.models.user.create({
+    email: 'createdBy@affine.pro',
+  });
+  workspace = await t.context.models.workspace.create(user.id);
+  docId = randomUUID();
+  await t.context.models.doc.upsert({
+    spaceId: user.id,
+    docId,
+    blob: Buffer.from('hello'),
+    timestamp: Date.now(),
+    editorId: user.id,
+  });
+});
+
+test.afterEach.always(() => {
+  mock.reset();
+  mock.timers.reset();
+});
+
+test.after(async t => {
+  await t.context.module.close();
+});
+
+test('should create a mention notification with default level', async t => {
+  const notification = await t.context.models.notification.createMention({
+    userId: user.id,
+    body: {
+      workspaceId: workspace.id,
+      doc: {
+        id: docId,
+        title: 'doc-title',
+        blockId: 'blockId',
+      },
+      createdByUserId: createdBy.id,
+    },
+  });
+  t.is(notification.level, NotificationLevel.Default);
+  t.is(notification.body.workspaceId, workspace.id);
+  t.is(notification.body.doc.id, docId);
+  t.is(notification.body.doc.title, 'doc-title');
+  t.is(notification.body.doc.blockId, 'blockId');
+  t.is(notification.body.createdByUserId, createdBy.id);
+  t.is(notification.type, NotificationType.Mention);
+  t.is(notification.read, false);
+});
+
+test('should create a mention notification with custom level', async t => {
+  const notification = await t.context.models.notification.createMention({
+    userId: user.id,
+    body: {
+      workspaceId: workspace.id,
+      doc: {
+        id: docId,
+        title: 'doc-title',
+        elementId: 'elementId',
+      },
+      createdByUserId: createdBy.id,
+    },
+    level: NotificationLevel.High,
+  });
+  t.is(notification.level, NotificationLevel.High);
+  t.is(notification.body.workspaceId, workspace.id);
+  t.is(notification.body.doc.id, docId);
+  t.is(notification.body.doc.title, 'doc-title');
+  t.is(notification.body.doc.elementId, 'elementId');
+  t.is(notification.body.createdByUserId, createdBy.id);
+  t.is(notification.type, NotificationType.Mention);
+  t.is(notification.read, false);
+});
+
+test('should mark a mention notification as read', async t => {
+  const notification = await t.context.models.notification.createMention({
+    userId: user.id,
+    body: {
+      workspaceId: workspace.id,
+      doc: {
+        id: docId,
+        title: 'doc-title',
+        blockId: 'blockId',
+      },
+      createdByUserId: createdBy.id,
+    },
+  });
+  t.is(notification.read, false);
+  await t.context.models.notification.markAsRead(notification.id, user.id);
+  const updatedNotification = await t.context.models.notification.get(
+    notification.id
+  );
+  t.is(updatedNotification!.read, true);
+});
+
+test('should create an invite notification', async t => {
+  const inviteId = randomUUID();
+  const notification = await t.context.models.notification.createInvitation({
+    userId: user.id,
+    body: {
+      workspaceId: workspace.id,
+      createdByUserId: createdBy.id,
+      inviteId,
+    },
+  });
+  t.is(notification.type, NotificationType.Invitation);
+  t.is(notification.body.workspaceId, workspace.id);
+  t.is(notification.body.createdByUserId, createdBy.id);
+  t.is(notification.body.inviteId, inviteId);
+  t.is(notification.read, false);
+});
+
+test('should mark an invite notification as read', async t => {
+  const inviteId = randomUUID();
+  const notification = await t.context.models.notification.createInvitation({
+    userId: user.id,
+    body: {
+      workspaceId: workspace.id,
+      createdByUserId: createdBy.id,
+      inviteId,
+    },
+  });
+  t.is(notification.read, false);
+  await t.context.models.notification.markAsRead(notification.id, user.id);
+  const updatedNotification = await t.context.models.notification.get(
+    notification.id
+  );
+  t.is(updatedNotification!.read, true);
+});
+
+test('should find many notifications by user id, order by createdAt descending', async t => {
+  const notification1 = await t.context.models.notification.createMention({
+    userId: user.id,
+    body: {
+      workspaceId: workspace.id,
+      doc: {
+        id: docId,
+        title: 'doc-title',
+        blockId: 'blockId',
+      },
+      createdByUserId: createdBy.id,
+    },
+  });
+  const inviteId = randomUUID();
+  const notification2 = await t.context.models.notification.createInvitation({
+    userId: user.id,
+    body: {
+      workspaceId: workspace.id,
+      createdByUserId: createdBy.id,
+      inviteId,
+    },
+  });
+  const notifications = await t.context.models.notification.findManyByUserId(
+    user.id
+  );
+  t.is(notifications.length, 2);
+  t.is(notifications[0].id, notification2.id);
+  t.is(notifications[1].id, notification1.id);
+});
+
+test('should find many notifications by user id, filter read notifications', async t => {
+  const notification1 = await t.context.models.notification.createMention({
+    userId: user.id,
+    body: {
+      workspaceId: workspace.id,
+      doc: {
+        id: docId,
+        title: 'doc-title',
+        blockId: 'blockId',
+      },
+      createdByUserId: createdBy.id,
+    },
+  });
+  const inviteId = randomUUID();
+  const notification2 = await t.context.models.notification.createInvitation({
+    userId: user.id,
+    body: {
+      workspaceId: workspace.id,
+      createdByUserId: createdBy.id,
+      inviteId,
+    },
+  });
+  await t.context.models.notification.markAsRead(notification2.id, user.id);
+  const notifications = await t.context.models.notification.findManyByUserId(
+    user.id
+  );
+  t.is(notifications.length, 1);
+  t.is(notifications[0].id, notification1.id);
+});
+
+test('should clean expired notifications', async t => {
+  const notification = await t.context.models.notification.createMention({
+    userId: user.id,
+    body: {
+      workspaceId: workspace.id,
+      doc: {
+        id: docId,
+        title: 'doc-title',
+        blockId: 'blockId',
+      },
+      createdByUserId: createdBy.id,
+    },
+  });
+  t.truthy(notification);
+  let notifications = await t.context.models.notification.findManyByUserId(
+    user.id
+  );
+  t.is(notifications.length, 1);
+  let count = await t.context.models.notification.cleanExpiredNotifications();
+  t.is(count, 0);
+  notifications = await t.context.models.notification.findManyByUserId(user.id);
+  t.is(notifications.length, 1);
+  t.is(notifications[0].id, notification.id);
+
+  await t.context.models.notification.markAsRead(notification.id, user.id);
+  // wait for 1 year
+  mock.timers.enable({
+    apis: ['Date'],
+    now: Date.now() + 1000 * 60 * 60 * 24 * 365,
+  });
+  count = await t.context.models.notification.cleanExpiredNotifications();
+  t.is(count, 1);
+  notifications = await t.context.models.notification.findManyByUserId(user.id);
+  t.is(notifications.length, 0);
+});
+
+test('should not clean unexpired notifications', async t => {
+  const notification = await t.context.models.notification.createMention({
+    userId: user.id,
+    body: {
+      workspaceId: workspace.id,
+      doc: {
+        id: docId,
+        title: 'doc-title',
+        blockId: 'blockId',
+      },
+      createdByUserId: createdBy.id,
+    },
+  });
+  let count = await t.context.models.notification.cleanExpiredNotifications();
+  t.is(count, 0);
+  await t.context.models.notification.markAsRead(notification.id, user.id);
+  count = await t.context.models.notification.cleanExpiredNotifications();
+  t.is(count, 0);
+});
+
+test('should find many notifications by user id, order by createdAt descending, with pagination', async t => {
+  const notification1 = await t.context.models.notification.createMention({
+    userId: user.id,
+    body: {
+      workspaceId: workspace.id,
+      doc: {
+        id: docId,
+        title: 'doc-title',
+        blockId: 'blockId',
+      },
+      createdByUserId: createdBy.id,
+    },
+  });
+  const notification2 = await t.context.models.notification.createInvitation({
+    userId: user.id,
+    body: {
+      workspaceId: workspace.id,
+      createdByUserId: createdBy.id,
+      inviteId: randomUUID(),
+    },
+  });
+  const notification3 = await t.context.models.notification.createInvitation({
+    userId: user.id,
+    body: {
+      workspaceId: workspace.id,
+      createdByUserId: createdBy.id,
+      inviteId: randomUUID(),
+    },
+  });
+  const notification4 = await t.context.models.notification.createInvitation({
+    userId: user.id,
+    body: {
+      workspaceId: workspace.id,
+      createdByUserId: createdBy.id,
+      inviteId: randomUUID(),
+    },
+  });
+  const notifications = await t.context.models.notification.findManyByUserId(
+    user.id,
+    {
+      offset: 0,
+      first: 2,
+    }
+  );
+  t.is(notifications.length, 2);
+  t.is(notifications[0].id, notification4.id);
+  t.is(notifications[1].id, notification3.id);
+  const notifications2 = await t.context.models.notification.findManyByUserId(
+    user.id,
+    {
+      offset: 2,
+      first: 2,
+    }
+  );
+  t.is(notifications2.length, 2);
+  t.is(notifications2[0].id, notification2.id);
+  t.is(notifications2[1].id, notification1.id);
+  const notifications3 = await t.context.models.notification.findManyByUserId(
+    user.id,
+    {
+      offset: 4,
+      first: 2,
+    }
+  );
+  t.is(notifications3.length, 0);
+});
+
+test('should count notifications by user id, exclude read notifications', async t => {
+  const notification1 = await t.context.models.notification.createMention({
+    userId: user.id,
+    body: {
+      workspaceId: workspace.id,
+      doc: {
+        id: docId,
+        title: 'doc-title',
+        blockId: 'blockId',
+      },
+      createdByUserId: createdBy.id,
+    },
+  });
+  t.truthy(notification1);
+  const notification2 = await t.context.models.notification.createInvitation({
+    userId: user.id,
+    body: {
+      workspaceId: workspace.id,
+      createdByUserId: createdBy.id,
+      inviteId: randomUUID(),
+    },
+  });
+  t.truthy(notification2);
+  await t.context.models.notification.markAsRead(notification2.id, user.id);
+  const count = await t.context.models.notification.countByUserId(user.id);
+  t.is(count, 1);
+});
+
+test('should count notifications by user id, include read notifications', async t => {
+  const notification1 = await t.context.models.notification.createMention({
+    userId: user.id,
+    body: {
+      workspaceId: workspace.id,
+      doc: {
+        id: docId,
+        title: 'doc-title',
+        blockId: 'blockId',
+      },
+      createdByUserId: createdBy.id,
+    },
+  });
+  t.truthy(notification1);
+  const notification2 = await t.context.models.notification.createInvitation({
+    userId: user.id,
+    body: {
+      workspaceId: workspace.id,
+      createdByUserId: createdBy.id,
+      inviteId: randomUUID(),
+    },
+  });
+  t.truthy(notification2);
+  await t.context.models.notification.markAsRead(notification2.id, user.id);
+  const count = await t.context.models.notification.countByUserId(user.id, {
+    includeRead: true,
+  });
+  t.is(count, 2);
+});