Add notifications for document and collection access (#6460)

* Add notification for added to document

* Add notifications for document and collection access

* Add notification delay

* fix: Collection notifications not appearing

* Add notification settings

server/queues/processors/EmailsProcessor.ts

@@ -1,9 +1,11 @@
 import { NotificationEventType } from "@shared/types";
 import CollectionCreatedEmail from "@server/emails/templates/CollectionCreatedEmail";
+import CollectionSharedEmail from "@server/emails/templates/CollectionSharedEmail";
 import CommentCreatedEmail from "@server/emails/templates/CommentCreatedEmail";
 import CommentMentionedEmail from "@server/emails/templates/CommentMentionedEmail";
 import DocumentMentionedEmail from "@server/emails/templates/DocumentMentionedEmail";
 import DocumentPublishedOrUpdatedEmail from "@server/emails/templates/DocumentPublishedOrUpdatedEmail";
+import DocumentSharedEmail from "@server/emails/templates/DocumentSharedEmail";
 import { Notification } from "@server/models";
 import { Event, NotificationEvent } from "@server/types";
 import BaseProcessor from "./BaseProcessor";
@@ -23,6 +25,10 @@ export default class EmailsProcessor extends BaseProcessor {
 
     const notificationId = notification.id;
 
+    if (notification.user.isSuspended) {
+      return;
+    }
+
     switch (notification.event) {
       case NotificationEventType.UpdateDocument:
       case NotificationEventType.PublishDocument: {
@@ -41,6 +47,34 @@ export default class EmailsProcessor extends BaseProcessor {
         return;
       }
 
+      case NotificationEventType.AddUserToDocument: {
+        await new DocumentSharedEmail(
+          {
+            to: notification.user.email,
+            userId: notification.userId,
+            documentId: notification.documentId,
+            teamUrl: notification.team.url,
+            actorName: notification.actor.name,
+          },
+          { notificationId }
+        ).schedule();
+        return;
+      }
+
+      case NotificationEventType.AddUserToCollection: {
+        await new CollectionSharedEmail(
+          {
+            to: notification.user.email,
+            userId: notification.userId,
+            collectionId: notification.collectionId,
+            teamUrl: notification.team.url,
+            actorName: notification.actor.name,
+          },
+          { notificationId }
+        ).schedule();
+        return;
+      }
+
       case NotificationEventType.MentionedInDocument: {
         await new DocumentMentionedEmail(
           {

server/queues/processors/NotificationsProcessor.ts

@@ -5,10 +5,14 @@ import {
   Event,
   DocumentEvent,
   CommentEvent,
+  CollectionUserEvent,
+  DocumentUserEvent,
 } from "@server/types";
+import CollectionAddUserNotificationsTask from "../tasks/CollectionAddUserNotificationsTask";
 import CollectionCreatedNotificationsTask from "../tasks/CollectionCreatedNotificationsTask";
 import CommentCreatedNotificationsTask from "../tasks/CommentCreatedNotificationsTask";
 import CommentUpdatedNotificationsTask from "../tasks/CommentUpdatedNotificationsTask";
+import DocumentAddUserNotificationsTask from "../tasks/DocumentAddUserNotificationsTask";
 import DocumentPublishedNotificationsTask from "../tasks/DocumentPublishedNotificationsTask";
 import RevisionCreatedNotificationsTask from "../tasks/RevisionCreatedNotificationsTask";
 import BaseProcessor from "./BaseProcessor";
@@ -16,8 +20,10 @@ import BaseProcessor from "./BaseProcessor";
 export default class NotificationsProcessor extends BaseProcessor {
   static applicableEvents: Event["name"][] = [
     "documents.publish",
+    "documents.add_user",
     "revisions.create",
     "collections.create",
+    "collections.add_user",
     "comments.create",
     "comments.update",
   ];
@@ -26,10 +32,14 @@ export default class NotificationsProcessor extends BaseProcessor {
     switch (event.name) {
       case "documents.publish":
         return this.documentPublished(event);
+      case "documents.add_user":
+        return this.documentAddUser(event);
       case "revisions.create":
         return this.revisionCreated(event);
       case "collections.create":
         return this.collectionCreated(event);
+      case "collections.add_user":
+        return this.collectionAddUser(event);
       case "comments.create":
         return this.commentCreated(event);
       case "comments.update":
@@ -51,6 +61,16 @@ export default class NotificationsProcessor extends BaseProcessor {
     await DocumentPublishedNotificationsTask.schedule(event);
   }
 
+  async documentAddUser(event: DocumentUserEvent) {
+    if (!event.data.isNew || event.userId === event.actorId) {
+      return;
+    }
+
+    await DocumentAddUserNotificationsTask.schedule(event, {
+      delay: Minute,
+    });
+  }
+
   async revisionCreated(event: RevisionEvent) {
     await RevisionCreatedNotificationsTask.schedule(event);
   }
@@ -68,6 +88,16 @@ export default class NotificationsProcessor extends BaseProcessor {
     await CollectionCreatedNotificationsTask.schedule(event);
   }
 
+  async collectionAddUser(event: CollectionUserEvent) {
+    if (!event.data.isNew || event.userId === event.actorId) {
+      return;
+    }
+
+    await CollectionAddUserNotificationsTask.schedule(event, {
+      delay: Minute,
+    });
+  }
+
   async commentCreated(event: CommentEvent) {
     await CommentCreatedNotificationsTask.schedule(event, {
       delay: Minute,

server/queues/tasks/CollectionAddUserNotificationsTask.ts

@@ -0,0 +1,32 @@
+import { NotificationEventType } from "@shared/types";
+import { Notification, User } from "@server/models";
+import { CollectionUserEvent } from "@server/types";
+import BaseTask, { TaskPriority } from "./BaseTask";
+
+export default class CollectionAddUserNotificationsTask extends BaseTask<CollectionUserEvent> {
+  public async perform(event: CollectionUserEvent) {
+    const recipient = await User.findByPk(event.userId);
+    if (!recipient) {
+      return;
+    }
+
+    if (
+      !recipient.isSuspended &&
+      recipient.subscribedToEventType(NotificationEventType.AddUserToCollection)
+    ) {
+      await Notification.create({
+        event: NotificationEventType.AddUserToCollection,
+        userId: event.userId,
+        actorId: event.actorId,
+        teamId: event.teamId,
+        collectionId: event.collectionId,
+      });
+    }
+  }
+
+  public get options() {
+    return {
+      priority: TaskPriority.Background,
+    };
+  }
+}

server/queues/tasks/DocumentAddUserNotificationsTask.ts

@@ -0,0 +1,32 @@
+import { NotificationEventType } from "@shared/types";
+import { Notification, User } from "@server/models";
+import { DocumentUserEvent } from "@server/types";
+import BaseTask, { TaskPriority } from "./BaseTask";
+
+export default class DocumentAddUserNotificationsTask extends BaseTask<DocumentUserEvent> {
+  public async perform(event: DocumentUserEvent) {
+    const recipient = await User.findByPk(event.userId);
+    if (!recipient) {
+      return;
+    }
+
+    if (
+      !recipient.isSuspended &&
+      recipient.subscribedToEventType(NotificationEventType.AddUserToDocument)
+    ) {
+      await Notification.create({
+        event: NotificationEventType.AddUserToDocument,
+        userId: event.userId,
+        actorId: event.actorId,
+        teamId: event.teamId,
+        documentId: event.documentId,
+      });
+    }
+  }
+
+  public get options() {
+    return {
+      priority: TaskPriority.Background,
+    };
+  }
+}