chore: Refactor worker, emails and data cleanup to task system (#3337)

* Refactor worker, all emails on task system * fix * lint * fix: Remove a bunch of expect-error comments in related tests * refactor: Move work from utils.gc into tasks * test * Add tracing to tasks and processors fix: DebounceProcessor triggering on all events Event.add -> Event.schedule
2022-04-06 16:48:28 -07:00
parent 9c766362ed
commit dbfdcd6d23
41 changed files with 729 additions and 444 deletions
--- a/server/queues/processors/BacklinksProcessor.ts
+++ b/server/queues/processors/BacklinksProcessor.ts
@@ -0,0 +1,168 @@
+import { Op } from "sequelize";
+import { APM } from "@server/logging/tracing";
+import { Document, Backlink, Team } from "@server/models";
+import { Event, DocumentEvent, RevisionEvent } from "@server/types";
+import parseDocumentIds from "@server/utils/parseDocumentIds";
+import slugify from "@server/utils/slugify";
+import BaseProcessor from "./BaseProcessor";
+
+@APM.trace()
+export default class BacklinksProcessor extends BaseProcessor {
+  static applicableEvents: Event["name"][] = [
+    "documents.publish",
+    "documents.update",
+    "documents.title_change",
+    "documents.delete",
+  ];
+
+  async perform(event: DocumentEvent | RevisionEvent) {
+    switch (event.name) {
+      case "documents.publish": {
+        const document = await Document.findByPk(event.documentId);
+        if (!document) {
+          return;
+        }
+        const linkIds = parseDocumentIds(document.text);
+        await Promise.all(
+          linkIds.map(async (linkId) => {
+            const linkedDocument = await Document.findByPk(linkId);
+
+            if (!linkedDocument || linkedDocument.id === event.documentId) {
+              return;
+            }
+
+            await Backlink.findOrCreate({
+              where: {
+                documentId: linkedDocument.id,
+                reverseDocumentId: event.documentId,
+              },
+              defaults: {
+                userId: document.lastModifiedById,
+              },
+            });
+          })
+        );
+        break;
+      }
+
+      case "documents.update": {
+        const document = await Document.findByPk(event.documentId);
+        if (!document) {
+          return;
+        }
+
+        // backlinks are only created for published documents
+        if (!document.publishedAt) {
+          return;
+        }
+
+        const linkIds = parseDocumentIds(document.text);
+        const linkedDocumentIds: string[] = [];
+
+        // create or find existing backlink records for referenced docs
+        await Promise.all(
+          linkIds.map(async (linkId) => {
+            const linkedDocument = await Document.findByPk(linkId);
+
+            if (!linkedDocument || linkedDocument.id === event.documentId) {
+              return;
+            }
+
+            await Backlink.findOrCreate({
+              where: {
+                documentId: linkedDocument.id,
+                reverseDocumentId: event.documentId,
+              },
+              defaults: {
+                userId: document.lastModifiedById,
+              },
+            });
+            linkedDocumentIds.push(linkedDocument.id);
+          })
+        );
+
+        // delete any backlinks that no longer exist
+        await Backlink.destroy({
+          where: {
+            documentId: {
+              [Op.notIn]: linkedDocumentIds,
+            },
+            reverseDocumentId: event.documentId,
+          },
+        });
+        break;
+      }
+
+      case "documents.title_change": {
+        // might as well check
+        const { title, previousTitle } = event.data;
+        if (!previousTitle || title === previousTitle) {
+          break;
+        }
+
+        const document = await Document.findByPk(event.documentId);
+        if (!document) {
+          return;
+        }
+
+        // TODO: Handle re-writing of titles into CRDT
+        const team = await Team.findByPk(document.teamId);
+
+        if (team?.collaborativeEditing) {
+          break;
+        }
+
+        // update any link titles in documents that lead to this one
+        const backlinks = await Backlink.findAll({
+          where: {
+            documentId: event.documentId,
+          },
+          include: [
+            {
+              model: Document,
+              as: "reverseDocument",
+            },
+          ],
+        });
+        await Promise.all(
+          backlinks.map(async (backlink) => {
+            const previousUrl = `/doc/${slugify(previousTitle)}-${
+              document.urlId
+            }`;
+
+            // find links in the other document that lead to this one and have
+            // the old title as anchor text. Go ahead and update those to the
+            // new title automatically
+            backlink.reverseDocument.text = backlink.reverseDocument.text.replace(
+              `[${previousTitle}](${previousUrl})`,
+              `[${title}](${document.url})`
+            );
+            await backlink.reverseDocument.save({
+              silent: true,
+              hooks: false,
+            });
+          })
+        );
+        break;
+      }
+
+      case "documents.delete": {
+        await Backlink.destroy({
+          where: {
+            [Op.or]: [
+              {
+                reverseDocumentId: event.documentId,
+              },
+              {
+                documentId: event.documentId,
+              },
+            ],
+          },
+        });
+        break;
+      }
+
+      default:
+    }
+  }
+}