feat: internal page links and mentions (#604)

* Work on mentions * fix: properly parse page slug * fix editor suggestion bugs * mentions must start with whitespace * add icon to page mention render * feat: backlinks - WIP * UI - WIP * permissions check * use FTS for page suggestion * cleanup * WIP * page title fallback * feat: handle internal link paste * link styling * WIP * Switch back to LIKE operator for search suggestion * WIP * scope to workspaceId * still create link for pages not found * select necessary columns * cleanups
2026-05-11 00:44:07 +08:00 · 2025-02-14 15:36:44 +00:00
parent 0ef6b1978a
commit e209aaa272
46 changed files with 1679 additions and 101 deletions
@@ -1,10 +1,16 @@
 export enum QueueName {
  EMAIL_QUEUE = '{email-queue}',
-  ATTACHEMENT_QUEUE = '{attachment-queue}',
+  ATTACHMENT_QUEUE = '{attachment-queue}',
+  GENERAL_QUEUE = '{general-queue}',
 }

 export enum QueueJob {
  SEND_EMAIL = 'send-email',
  DELETE_SPACE_ATTACHMENTS = 'delete-space-attachments',
  DELETE_PAGE_ATTACHMENTS = 'delete-page-attachments',
+  PAGE_CONTENT_UPDATE = 'page-content-update',
+
+  PAGE_BACKLINKS = 'page-backlinks',
 }
+
+
@@ -0,0 +1,8 @@
+import { MentionNode } from "../../../common/helpers/prosemirror/utils";
+
+
+export interface IPageBacklinkJob {
+  pageId: string;
+  workspaceId: string;
+  mentions: MentionNode[];
+}
@@ -0,0 +1,129 @@
+import { Logger, OnModuleDestroy } from '@nestjs/common';
+import { OnWorkerEvent, Processor, WorkerHost } from '@nestjs/bullmq';
+import { Job } from 'bullmq';
+import { QueueJob, QueueName } from '../constants';
+import { IPageBacklinkJob } from '../constants/queue.interface';
+import { InjectKysely } from 'nestjs-kysely';
+import { KyselyDB } from '@docmost/db/types/kysely.types';
+import { BacklinkRepo } from '@docmost/db/repos/backlink/backlink.repo';
+import { executeTx } from '@docmost/db/utils';
+
+@Processor(QueueName.GENERAL_QUEUE)
+export class BacklinksProcessor extends WorkerHost implements OnModuleDestroy {
+  private readonly logger = new Logger(BacklinksProcessor.name);
+  constructor(
+    @InjectKysely() private readonly db: KyselyDB,
+    private readonly backlinkRepo: BacklinkRepo,
+  ) {
+    super();
+  }
+
+  async process(job: Job<IPageBacklinkJob, void>): Promise<void> {
+    try {
+      const { pageId, mentions, workspaceId } = job.data;
+
+      switch (job.name) {
+        case QueueJob.PAGE_BACKLINKS:
+          {
+            await executeTx(this.db, async (trx) => {
+              const existingBacklinks = await trx
+                .selectFrom('backlinks')
+                .select('targetPageId')
+                .where('sourcePageId', '=', pageId)
+                .execute();
+
+              if (existingBacklinks.length === 0 && mentions.length === 0) {
+                return;
+              }
+
+              const existingTargetPageIds = existingBacklinks.map(
+                (backlink) => backlink.targetPageId,
+              );
+
+              const targetPageIds = mentions
+                .filter((mention) => mention.entityId !== pageId)
+                .map((mention) => mention.entityId);
+
+              // make sure target pages belong to the same workspace
+              let validTargetPages = [];
+              if (targetPageIds.length > 0) {
+                validTargetPages = await trx
+                  .selectFrom('pages')
+                  .select('id')
+                  .where('id', 'in', targetPageIds)
+                  .where('workspaceId', '=', workspaceId)
+                  .execute();
+              }
+
+              const validTargetPageIds = validTargetPages.map(
+                (page) => page.id,
+              );
+
+              // new backlinks
+              const backlinksToAdd = validTargetPageIds.filter(
+                (id) => !existingTargetPageIds.includes(id),
+              );
+
+              // stale backlinks
+              const backlinksToRemove = existingTargetPageIds.filter(
+                (existingId) => !validTargetPageIds.includes(existingId),
+              );
+
+              // add new backlinks
+              if (backlinksToAdd.length > 0) {
+                const newBacklinks = backlinksToAdd.map((targetPageId) => ({
+                  sourcePageId: pageId,
+                  targetPageId: targetPageId,
+                  workspaceId: workspaceId,
+                }));
+
+                await this.backlinkRepo.insertBacklink(newBacklinks, trx);
+                this.logger.debug(
+                  `Added ${newBacklinks.length} new backlinks to ${pageId}`,
+                );
+              }
+
+              // remove stale backlinks
+              if (backlinksToRemove.length > 0) {
+                await this.db
+                  .deleteFrom('backlinks')
+                  .where('sourcePageId', '=', pageId)
+                  .where('targetPageId', 'in', backlinksToRemove)
+                  .execute();
+
+                this.logger.debug(
+                  `Removed ${backlinksToRemove.length} outdated backlinks from ${pageId}.`,
+                );
+              }
+            });
+          }
+          break;
+      }
+    } catch (err) {
+      throw err;
+    }
+  }
+
+  @OnWorkerEvent('active')
+  onActive(job: Job) {
+    this.logger.debug(`Processing ${job.name} job`);
+  }
+
+  @OnWorkerEvent('failed')
+  onError(job: Job) {
+    this.logger.error(
+      `Error processing ${job.name} job. Reason: ${job.failedReason}`,
+    );
+  }
+
+  @OnWorkerEvent('completed')
+  onCompleted(job: Job) {
+    this.logger.debug(`Completed ${job.name} job`);
+  }
+
+  async onModuleDestroy(): Promise<void> {
+    if (this.worker) {
+      await this.worker.close();
+    }
+  }
+}
@@ -3,6 +3,7 @@ import { BullModule } from '@nestjs/bullmq';
 import { EnvironmentService } from '../environment/environment.service';
 import { createRetryStrategy, parseRedisUrl } from '../../common/helpers';
 import { QueueName } from './constants';
+import { BacklinksProcessor } from "./processors/backlinks.processor";

@Global()
@Module({
@@ -33,9 +34,13 @@ import { QueueName } from './constants';
      name: QueueName.EMAIL_QUEUE,
    }),
    BullModule.registerQueue({
-      name: QueueName.ATTACHEMENT_QUEUE,
+      name: QueueName.ATTACHMENT_QUEUE,
+    }),
+    BullModule.registerQueue({
+      name: QueueName.GENERAL_QUEUE,
    }),
  ],
  exports: [BullModule],
+  providers: [BacklinksProcessor]
 })
 export class QueueModule {}