Capability to mention users in a document (#4838)

* feat: mention user

* fix: trigger api call on every letter typed

* fix: this allows command menu to re-render upon props change, shouldComponentUpdate prevented re-rendering when necessary

* fix: add node

* fix: mention node styling

* fix: Caret not visible after inserting mention

* fix: apply mentionRule

* fix: label is to be obtained from content, not attrs

* feat: add mentions table and model

* fix: typo

* fix: make all mention nodes visible in shared doc

* feat: parse mention ids from doc text

* feat: MentionsProcessor

* feat: documents.publish tests

* feat: tests for MentionsProcessor

* feat: schedule notifs for mentions

* fix: get rid of Mention model

* fix: put actor id and mention id in raw md

* Revert "fix: put actor id and mention id in raw md"

This reverts commit 3bb8a22e3c560971dccad6d2f82266256bcb2d96.

* Revert "Revert "fix: put actor id and mention id in raw md""

This reverts commit 3c5b36c40cebf147663908cf27d0dce6488adfad.

* fix: review

* fix: no need of set

* fix: show avatar

* fix: get rid of eventName

* fix: font-weight

* fix: prioritize mention notifs

* fix: store id in md

* fix: no need of prepending m

* fix: fetchPage

* fix: Avatars incorrect color

* fix: remove scanRE

* fix: test

* fix: include alphabet other than latin

* lockfile

* fix: regex should test for letters, marks and digits

---------

Co-authored-by: Tom Moor <tom.moor@gmail.com>

server/utils/parseMentions.test.ts

@@ -0,0 +1,30 @@
+import { buildDocument } from "@server/test/factories";
+import parseMentions from "./parseMentions";
+
+it("should not parse normal links as mentions", async () => {
+  const document = await buildDocument({
+    text: `# Header
+
+[link not mention](http://google.com)`,
+  });
+  const result = parseMentions(document);
+  expect(result.length).toBe(0);
+});
+
+it("should return an array of mentions", async () => {
+  const document = await buildDocument({
+    text: `# Header
+
+@[Alan Kay](mention://2767ba0e-ac5c-4533-b9cf-4f5fc456600e/user/34095ac1-c808-45c0-8c6e-6c554497de64) :wink:
+
+More text
+
+@[Bret Victor](mention://34095ac1-c808-45c0-8c6e-6c554497de64/user/2767ba0e-ac5c-4533-b9cf-4f5fc456600e) :fire:`,
+  });
+  const result = parseMentions(document);
+  expect(result.length).toBe(2);
+  expect(result[0].id).toBe("2767ba0e-ac5c-4533-b9cf-4f5fc456600e");
+  expect(result[1].id).toBe("34095ac1-c808-45c0-8c6e-6c554497de64");
+  expect(result[0].modelId).toBe("34095ac1-c808-45c0-8c6e-6c554497de64");
+  expect(result[1].modelId).toBe("2767ba0e-ac5c-4533-b9cf-4f5fc456600e");
+});

server/utils/parseMentions.ts

@@ -0,0 +1,35 @@
+import { Node } from "prosemirror-model";
+import { Document, Revision } from "@server/models";
+import DocumentHelper from "@server/models/helpers/DocumentHelper";
+
+/**
+ * Parse a list of mentions contained in a document or revision
+ *
+ * @param document Document or Revision
+ * @returns An array of mentions in passed document or revision
+ */
+export default function parseMentions(
+  document: Document | Revision
+): Record<string, string>[] {
+  const node = DocumentHelper.toProsemirror(document);
+  const mentions: Record<string, string>[] = [];
+
+  function findMentions(node: Node) {
+    if (
+      node.type.name === "mention" &&
+      !mentions.some((m) => m.id === node.attrs.id)
+    ) {
+      mentions.push(node.attrs);
+    }
+
+    if (!node.content.size) {
+      return;
+    }
+
+    node.content.descendants(findMentions);
+  }
+
+  findMentions(node);
+
+  return mentions;
+}