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>
2023-03-07 04:24:57 +05:30
parent 09435ed798
commit de031b365c
18 changed files with 704 additions and 20 deletions
--- a/server/emails/templates/MentionNotificationEmail.tsx
+++ b/server/emails/templates/MentionNotificationEmail.tsx
@@ -0,0 +1,83 @@
+import * as React from "react";
+import { Document } from "@server/models";
+import BaseEmail from "./BaseEmail";
+import Body from "./components/Body";
+import Button from "./components/Button";
+import EmailTemplate from "./components/EmailLayout";
+import Header from "./components/Header";
+import Heading from "./components/Heading";
+
+type InputProps = {
+  to: string;
+  documentId: string;
+  actorName: string;
+  teamUrl: string;
+  mentionId: string;
+};
+
+type BeforeSend = {
+  document: Document;
+};
+
+type Props = InputProps & BeforeSend;
+
+/**
+ * Email sent to a user when someone mentions them in a doucment
+ */
+export default class MentionNotificationEmail extends BaseEmail<
+  InputProps,
+  BeforeSend
+> {
+  protected async beforeSend({ documentId }: InputProps) {
+    const document = await Document.unscoped().findByPk(documentId);
+    if (!document) {
+      return false;
+    }
+
+    return { document };
+  }
+
+  protected subject({ actorName, document }: Props) {
+    return `${actorName} mentioned you in "${document.title}"`;
+  }
+
+  protected preview({ actorName }: Props): string {
+    return `${actorName} mentioned you`;
+  }
+
+  protected renderAsText({
+    actorName,
+    teamUrl,
+    document,
+    mentionId,
+  }: Props): string {
+    return `
+You were mentioned
+
+${actorName} mentioned you in the document "${document.title}".
+
+Open Document: ${teamUrl}${document.url}?mentionId=${mentionId}
+`;
+  }
+
+  protected render({ document, actorName, teamUrl, mentionId }: Props) {
+    const link = `${teamUrl}${document.url}?ref=notification-email&mentionId=${mentionId}`;
+
+    return (
+      <EmailTemplate>
+        <Header />
+
+        <Body>
+          <Heading>You were mentioned</Heading>
+          <p>
+            {actorName} mentioned you in the document{" "}
+            <a href={link}>{document.title}</a>.
+          </p>
+          <p>
+            <Button href={link}>Open Document</Button>
+          </p>
+        </Body>
+      </EmailTemplate>
+    );
+  }
+}