feat: notifications (#1947)

* feat: notifications
* feat: watchers

* improvements

* handle page move for watchers

* make watchers non-blocking

* more

apps/server/src/core/notification/dto/notification.dto.ts

@@ -0,0 +1,13 @@
+import { IsArray, IsOptional, IsUUID } from 'class-validator';
+
+export class NotificationIdDto {
+  @IsUUID()
+  notificationId: string;
+}
+
+export class MarkNotificationsReadDto {
+  @IsArray()
+  @IsUUID(undefined, { each: true })
+  @IsOptional()
+  notificationIds?: string[];
+}

apps/server/src/core/notification/notification.constants.ts

@@ -0,0 +1,9 @@
+export const NotificationType = {
+  COMMENT_USER_MENTION: 'comment.user_mention',
+  COMMENT_CREATED: 'comment.created',
+  COMMENT_RESOLVED: 'comment.resolved',
+  PAGE_USER_MENTION: 'page.user_mention',
+} as const;
+
+export type NotificationType =
+  (typeof NotificationType)[keyof typeof NotificationType];

apps/server/src/core/notification/notification.controller.ts

@@ -0,0 +1,56 @@
+import {
+  Body,
+  Controller,
+  HttpCode,
+  HttpStatus,
+  Post,
+  UseGuards,
+} from '@nestjs/common';
+import { NotificationService } from './notification.service';
+import { AuthUser } from '../../common/decorators/auth-user.decorator';
+import { JwtAuthGuard } from '../../common/guards/jwt-auth.guard';
+import { PaginationOptions } from '@docmost/db/pagination/pagination-options';
+import { User } from '@docmost/db/types/entity.types';
+import { MarkNotificationsReadDto } from './dto/notification.dto';
+
+@UseGuards(JwtAuthGuard)
+@Controller('notifications')
+export class NotificationController {
+  constructor(private readonly notificationService: NotificationService) {}
+
+  @HttpCode(HttpStatus.OK)
+  @Post('/')
+  async getNotifications(
+    @Body() pagination: PaginationOptions,
+    @AuthUser() user: User,
+  ) {
+    return this.notificationService.findByUserId(user.id, pagination);
+  }
+
+  @HttpCode(HttpStatus.OK)
+  @Post('unread-count')
+  async getUnreadCount(@AuthUser() user: User) {
+    const count = await this.notificationService.getUnreadCount(user.id);
+    return { count };
+  }
+
+  @HttpCode(HttpStatus.OK)
+  @Post('mark-read')
+  async markAsRead(
+    @Body() dto: MarkNotificationsReadDto,
+    @AuthUser() user: User,
+  ) {
+    if (dto.notificationIds?.length) {
+      await this.notificationService.markMultipleAsRead(
+        dto.notificationIds,
+        user.id,
+      );
+    }
+  }
+
+  @HttpCode(HttpStatus.OK)
+  @Post('mark-all-read')
+  async markAllAsRead(@AuthUser() user: User) {
+    await this.notificationService.markAllAsRead(user.id);
+  }
+}

apps/server/src/core/notification/notification.module.ts

@@ -0,0 +1,20 @@
+import { Module } from '@nestjs/common';
+import { NotificationService } from './notification.service';
+import { NotificationController } from './notification.controller';
+import { NotificationProcessor } from './notification.processor';
+import { CommentNotificationService } from './services/comment.notification';
+import { PageNotificationService } from './services/page.notification';
+import { WsModule } from '../../ws/ws.module';
+
+@Module({
+  imports: [WsModule],
+  controllers: [NotificationController],
+  providers: [
+    NotificationService,
+    NotificationProcessor,
+    CommentNotificationService,
+    PageNotificationService,
+  ],
+  exports: [NotificationService],
+})
+export class NotificationModule {}

apps/server/src/core/notification/notification.processor.ts

@@ -0,0 +1,101 @@
+import { Logger, OnModuleDestroy } from '@nestjs/common';
+import { OnWorkerEvent, Processor, WorkerHost } from '@nestjs/bullmq';
+import { Job } from 'bullmq';
+import { InjectKysely } from 'nestjs-kysely';
+import { KyselyDB } from '@docmost/db/types/kysely.types';
+import { QueueJob, QueueName } from '../../integrations/queue/constants';
+import {
+  ICommentNotificationJob,
+  ICommentResolvedNotificationJob,
+  IPageMentionNotificationJob,
+} from '../../integrations/queue/constants/queue.interface';
+import { CommentNotificationService } from './services/comment.notification';
+import { PageNotificationService } from './services/page.notification';
+import { DomainService } from '../../integrations/environment/domain.service';
+
+@Processor(QueueName.NOTIFICATION_QUEUE)
+export class NotificationProcessor
+  extends WorkerHost
+  implements OnModuleDestroy
+{
+  private readonly logger = new Logger(NotificationProcessor.name);
+
+  constructor(
+    private readonly commentNotificationService: CommentNotificationService,
+    private readonly pageNotificationService: PageNotificationService,
+    private readonly domainService: DomainService,
+    @InjectKysely() private readonly db: KyselyDB,
+  ) {
+    super();
+  }
+
+  async process(
+    job: Job<
+      | ICommentNotificationJob
+      | ICommentResolvedNotificationJob
+      | IPageMentionNotificationJob,
+      void
+    >,
+  ): Promise<void> {
+    try {
+      const workspaceId = (job.data as { workspaceId: string }).workspaceId;
+      const appUrl = await this.getWorkspaceUrl(workspaceId);
+
+      switch (job.name) {
+        case QueueJob.COMMENT_NOTIFICATION: {
+          await this.commentNotificationService.processComment(
+            job.data as ICommentNotificationJob,
+            appUrl,
+          );
+          break;
+        }
+
+        case QueueJob.COMMENT_RESOLVED_NOTIFICATION: {
+          await this.commentNotificationService.processResolved(
+            job.data as ICommentResolvedNotificationJob,
+            appUrl,
+          );
+          break;
+        }
+
+        case QueueJob.PAGE_MENTION_NOTIFICATION: {
+          await this.pageNotificationService.processPageMention(
+            job.data as IPageMentionNotificationJob,
+            appUrl,
+          );
+          break;
+        }
+
+        default:
+          this.logger.warn(`Unknown notification job: ${job.name}`);
+      }
+    } catch (err: unknown) {
+      const message = err instanceof Error ? err.message : 'Unknown error';
+      this.logger.error(`Failed to process ${job.name}: ${message}`);
+      throw err;
+    }
+  }
+
+  private async getWorkspaceUrl(workspaceId: string): Promise<string> {
+    const workspace = await this.db
+      .selectFrom('workspaces')
+      .select('hostname')
+      .where('id', '=', workspaceId)
+      .executeTakeFirst();
+
+    return this.domainService.getUrl(workspace?.hostname);
+  }
+
+  @OnWorkerEvent('failed')
+  onError(job: Job) {
+    this.logger.error(
+      `Error processing ${job.name} job. Reason: ${job.failedReason}`,
+    );
+  }
+
+  async onModuleDestroy(): Promise<void> {
+    if (this.worker) {
+      await this.worker.close();
+    }
+  }
+}

apps/server/src/core/notification/notification.service.ts

@@ -0,0 +1,80 @@
+import { Injectable, Logger } from '@nestjs/common';
+import { InjectKysely } from 'nestjs-kysely';
+import { KyselyDB } from '@docmost/db/types/kysely.types';
+import { NotificationRepo } from '@docmost/db/repos/notification/notification.repo';
+import { InsertableNotification } from '@docmost/db/types/entity.types';
+import { PaginationOptions } from '@docmost/db/pagination/pagination-options';
+import { WsGateway } from '../../ws/ws.gateway';
+import { MailService } from '../../integrations/mail/mail.service';
+
+@Injectable()
+export class NotificationService {
+  private readonly logger = new Logger(NotificationService.name);
+
+  constructor(
+    private readonly notificationRepo: NotificationRepo,
+    private readonly wsGateway: WsGateway,
+    private readonly mailService: MailService,
+    @InjectKysely() private readonly db: KyselyDB,
+  ) {}
+
+  async create(data: InsertableNotification) {
+    const notification = await this.notificationRepo.insert(data);
+
+    this.wsGateway.server
+      .to(`user-${data.userId}`)
+      .emit('notification', { id: notification.id, type: notification.type });
+
+    return notification;
+  }
+
+  async findByUserId(userId: string, pagination: PaginationOptions) {
+    return this.notificationRepo.findByUserId(userId, pagination);
+  }
+
+  async getUnreadCount(userId: string) {
+    return this.notificationRepo.getUnreadCount(userId);
+  }
+
+  async markAsRead(notificationId: string, userId: string) {
+    return this.notificationRepo.markAsRead(notificationId, userId);
+  }
+
+  async markMultipleAsRead(notificationIds: string[], userId: string) {
+    return this.notificationRepo.markMultipleAsRead(notificationIds, userId);
+  }
+
+  async markAllAsRead(userId: string) {
+    return this.notificationRepo.markAllAsRead(userId);
+  }
+
+  async queueEmail(
+    userId: string,
+    notificationId: string,
+    subject: string,
+    template: any,
+  ) {
+    try {
+      const user = await this.db
+        .selectFrom('users')
+        .select(['email'])
+        .where('id', '=', userId)
+        .where('deletedAt', 'is', null)
+        .executeTakeFirst();
+
+      if (!user?.email) return;
+
+      await this.mailService.sendToQueue({
+        to: user.email,
+        subject,
+        template,
+        notificationId,
+      });
+    } catch (err: unknown) {
+      const message = err instanceof Error ? err.message : 'Unknown error';
+      this.logger.error(
+        `Failed to queue email for notification ${notificationId}: ${message}`,
+      );
+    }
+  }
+}

apps/server/src/core/notification/services/comment.notification.ts

@@ -0,0 +1,219 @@
+import { Injectable, Logger } from '@nestjs/common';
+import { InjectKysely } from 'nestjs-kysely';
+import { KyselyDB } from '@docmost/db/types/kysely.types';
+import {
+  ICommentNotificationJob,
+  ICommentResolvedNotificationJob,
+} from '../../../integrations/queue/constants/queue.interface';
+import { NotificationService } from '../notification.service';
+import { NotificationType } from '../notification.constants';
+import { SpaceMemberRepo } from '@docmost/db/repos/space/space-member.repo';
+import { WatcherRepo } from '@docmost/db/repos/watcher/watcher.repo';
+import { CommentMentionEmail } from '@docmost/transactional/emails/comment-mention-email';
+import { CommentCreateEmail } from '@docmost/transactional/emails/comment-created-email';
+import { CommentResolvedEmail } from '@docmost/transactional/emails/comment-resolved-email';
+import { getPageTitle } from '../../../common/helpers';
+
+@Injectable()
+export class CommentNotificationService {
+  private readonly logger = new Logger(CommentNotificationService.name);
+
+  constructor(
+    @InjectKysely() private readonly db: KyselyDB,
+    private readonly notificationService: NotificationService,
+    private readonly spaceMemberRepo: SpaceMemberRepo,
+    private readonly watcherRepo: WatcherRepo,
+  ) {}
+
+  async processComment(data: ICommentNotificationJob, appUrl: string) {
+    const {
+      commentId,
+      parentCommentId,
+      pageId,
+      spaceId,
+      workspaceId,
+      actorId,
+      mentionedUserIds,
+      notifyWatchers,
+    } = data;
+
+    const context = await this.getCommentContext(
+      actorId,
+      pageId,
+      spaceId,
+      commentId,
+      appUrl,
+    );
+    if (!context) return;
+
+    const { actor, pageTitle, pageUrl } = context;
+    const notifiedUserIds = new Set<string>();
+    notifiedUserIds.add(actorId);
+
+    const recipientIds = parentCommentId
+      ? await this.getThreadParticipantIds(parentCommentId)
+      : notifyWatchers
+        ? await this.watcherRepo.getPageWatcherIds(pageId)
+        : [];
+
+    const allCandidateIds = [
+      ...new Set([...mentionedUserIds, ...recipientIds]),
+    ];
+    const usersWithAccess =
+      await this.spaceMemberRepo.getUserIdsWithSpaceAccess(
+        allCandidateIds,
+        spaceId,
+      );
+
+    for (const userId of mentionedUserIds) {
+      if (!usersWithAccess.has(userId)) continue;
+
+      const notification = await this.notificationService.create({
+        userId,
+        workspaceId,
+        type: NotificationType.COMMENT_USER_MENTION,
+        actorId,
+        pageId,
+        spaceId,
+        commentId,
+      });
+
+      await this.notificationService.queueEmail(
+        userId,
+        notification.id,
+        `${actor.name} mentioned you in a comment`,
+        CommentMentionEmail({ actorName: actor.name, pageTitle, pageUrl }),
+      );
+
+      notifiedUserIds.add(userId);
+    }
+
+    for (const recipientId of recipientIds) {
+      if (notifiedUserIds.has(recipientId)) continue;
+      if (!usersWithAccess.has(recipientId)) continue;
+
+      const notification = await this.notificationService.create({
+        userId: recipientId,
+        workspaceId,
+        type: NotificationType.COMMENT_CREATED,
+        actorId,
+        pageId,
+        spaceId,
+        commentId,
+      });
+
+      await this.notificationService.queueEmail(
+        recipientId,
+        notification.id,
+        `${actor.name} commented on ${pageTitle}`,
+        CommentCreateEmail({ actorName: actor.name, pageTitle, pageUrl }),
+      );
+    }
+  }
+
+  async processResolved(data: ICommentResolvedNotificationJob, appUrl: string) {
+    const {
+      commentId,
+      commentCreatorId,
+      pageId,
+      spaceId,
+      workspaceId,
+      actorId,
+    } = data;
+
+    if (commentCreatorId === actorId) return;
+
+    const context = await this.getCommentContext(
+      actorId,
+      pageId,
+      spaceId,
+      commentId,
+      appUrl,
+    );
+    if (!context) return;
+
+    const { actor, pageTitle, pageUrl } = context;
+
+    const roles = await this.spaceMemberRepo.getUserSpaceRoles(
+      commentCreatorId,
+      spaceId,
+    );
+
+    if (!roles) {
+      this.logger.debug(
+        `Skipping resolved notification for user ${commentCreatorId}: no access to space ${spaceId}`,
+      );
+      return;
+    }
+
+    const notification = await this.notificationService.create({
+      userId: commentCreatorId,
+      workspaceId,
+      type: NotificationType.COMMENT_RESOLVED,
+      actorId,
+      pageId,
+      spaceId,
+      commentId,
+    });
+
+    const subject = `${actor.name} resolved a comment on ${pageTitle}`;
+
+    await this.notificationService.queueEmail(
+      commentCreatorId,
+      notification.id,
+      subject,
+      CommentResolvedEmail({ actorName: actor.name, pageTitle, pageUrl }),
+    );
+  }
+
+  private async getThreadParticipantIds(
+    parentCommentId: string,
+  ): Promise<string[]> {
+    const participants = await this.db
+      .selectFrom('comments')
+      .select('creatorId')
+      .where((eb) =>
+        eb.or([
+          eb('id', '=', parentCommentId),
+          eb('parentCommentId', '=', parentCommentId),
+        ]),
+      )
+      .execute();
+
+    return [...new Set(participants.map((p) => p.creatorId))];
+  }
+
+  private async getCommentContext(
+    actorId: string,
+    pageId: string,
+    spaceId: string,
+    commentId: string,
+    appUrl: string,
+  ) {
+    const [actor, page, space] = await Promise.all([
+      this.db
+        .selectFrom('users')
+        .select(['id', 'name'])
+        .where('id', '=', actorId)
+        .executeTakeFirst(),
+      this.db
+        .selectFrom('pages')
+        .select(['id', 'title', 'slugId'])
+        .where('id', '=', pageId)
+        .executeTakeFirst(),
+      this.db
+        .selectFrom('spaces')
+        .select(['id', 'slug'])
+        .where('id', '=', spaceId)
+        .executeTakeFirst(),
+    ]);
+
+    if (!actor || !page || !space) {
+      return null;
+    }
+
+    const pageUrl = `${appUrl}/s/${space.slug}/p/${page.slugId}`;
+
+    return { actor, pageTitle: getPageTitle(page.title), pageUrl };
+  }
+}

apps/server/src/core/notification/services/page.notification.ts

@@ -0,0 +1,132 @@
+import { Injectable } from '@nestjs/common';
+import { InjectKysely } from 'nestjs-kysely';
+import { KyselyDB } from '@docmost/db/types/kysely.types';
+import { IPageMentionNotificationJob } from '../../../integrations/queue/constants/queue.interface';
+import { NotificationService } from '../notification.service';
+import { NotificationType } from '../notification.constants';
+import { SpaceMemberRepo } from '@docmost/db/repos/space/space-member.repo';
+import { PageMentionEmail } from '@docmost/transactional/emails/page-mention-email';
+import { getPageTitle } from '../../../common/helpers';
+
+@Injectable()
+export class PageNotificationService {
+  constructor(
+    @InjectKysely() private readonly db: KyselyDB,
+    private readonly notificationService: NotificationService,
+    private readonly spaceMemberRepo: SpaceMemberRepo,
+  ) {}
+
+  async processPageMention(data: IPageMentionNotificationJob, appUrl: string) {
+    const { userMentions, oldMentionedUserIds, pageId, spaceId, workspaceId } =
+      data;
+
+    const oldIds = new Set(oldMentionedUserIds);
+    const newMentions = userMentions.filter(
+      (m) => !oldIds.has(m.userId) && m.creatorId !== m.userId,
+    );
+
+    if (newMentions.length === 0) return;
+
+    const candidateUserIds = newMentions.map((m) => m.userId);
+    const usersWithAccess =
+      await this.spaceMemberRepo.getUserIdsWithSpaceAccess(
+        candidateUserIds,
+        spaceId,
+      );
+
+    const accessibleMentions = newMentions.filter((m) =>
+      usersWithAccess.has(m.userId),
+    );
+    if (accessibleMentions.length === 0) return;
+
+    const mentionsByCreator = new Map<
+      string,
+      { userId: string; mentionId: string }[]
+    >();
+    for (const m of accessibleMentions) {
+      const list = mentionsByCreator.get(m.creatorId) || [];
+      list.push({ userId: m.userId, mentionId: m.mentionId });
+      mentionsByCreator.set(m.creatorId, list);
+    }
+
+    for (const [actorId, mentions] of mentionsByCreator) {
+      await this.notifyMentionedUsers(
+        mentions,
+        actorId,
+        pageId,
+        spaceId,
+        workspaceId,
+        appUrl,
+      );
+    }
+  }
+
+  private async notifyMentionedUsers(
+    mentions: { userId: string; mentionId: string }[],
+    actorId: string,
+    pageId: string,
+    spaceId: string,
+    workspaceId: string,
+    appUrl: string,
+  ) {
+    const context = await this.getPageContext(actorId, pageId, spaceId, appUrl);
+    if (!context) return;
+
+    const { actor, pageTitle, basePageUrl } = context;
+
+    for (const { userId, mentionId } of mentions) {
+      const notification = await this.notificationService.create({
+        userId,
+        workspaceId,
+        type: NotificationType.PAGE_USER_MENTION,
+        actorId,
+        pageId,
+        spaceId,
+        data: { mentionId },
+      });
+
+      const pageUrl = `${basePageUrl}`;
+      const subject = `${actor.name} mentioned you in ${pageTitle}`;
+
+      await this.notificationService.queueEmail(
+        userId,
+        notification.id,
+        subject,
+        PageMentionEmail({ actorName: actor.name, pageTitle, pageUrl }),
+      );
+    }
+  }
+
+  private async getPageContext(
+    actorId: string,
+    pageId: string,
+    spaceId: string,
+    appUrl: string,
+  ) {
+    const [actor, page, space] = await Promise.all([
+      this.db
+        .selectFrom('users')
+        .select(['id', 'name'])
+        .where('id', '=', actorId)
+        .executeTakeFirst(),
+      this.db
+        .selectFrom('pages')
+        .select(['id', 'title', 'slugId'])
+        .where('id', '=', pageId)
+        .executeTakeFirst(),
+      this.db
+        .selectFrom('spaces')
+        .select(['id', 'slug'])
+        .where('id', '=', spaceId)
+        .executeTakeFirst(),
+    ]);
+
+    if (!actor || !page || !space) {
+      return null;
+    }
+
+    const basePageUrl = `${appUrl}/s/${space.slug}/p/${page.slugId}`;
+
+    return { actor, pageTitle: getPageTitle(page.title), basePageUrl };
+  }
+}