Notifications refactor (#5151

* Ongoing

* refactor

* test

* Add cleanup task

* refactor

server/queues/tasks/RevisionCreatedNotificationsTask.test.ts

@@ -0,0 +1,455 @@
+import {
+  View,
+  Subscription,
+  Event,
+  Notification,
+  Revision,
+} from "@server/models";
+import { buildDocument, buildUser } from "@server/test/factories";
+import { setupTestDatabase } from "@server/test/support";
+import RevisionCreatedNotificationsTask from "./RevisionCreatedNotificationsTask";
+
+const ip = "127.0.0.1";
+
+setupTestDatabase();
+
+beforeEach(async () => {
+  jest.resetAllMocks();
+});
+
+describe("revisions.create", () => {
+  test("should send a notification to other collaborators", async () => {
+    const spy = jest.spyOn(Notification, "create");
+    const document = await buildDocument();
+    await Revision.createFromDocument(document);
+
+    document.text = "Updated body content";
+    document.updatedAt = new Date();
+    const revision = await Revision.createFromDocument(document);
+    const collaborator = await buildUser({ teamId: document.teamId });
+    document.collaboratorIds = [collaborator.id];
+    await document.save();
+
+    const task = new RevisionCreatedNotificationsTask();
+    await task.perform({
+      name: "revisions.create",
+      documentId: document.id,
+      collectionId: document.collectionId,
+      teamId: document.teamId,
+      actorId: collaborator.id,
+      modelId: revision.id,
+      ip,
+    });
+    expect(spy).toHaveBeenCalled();
+  });
+
+  test("should not send a notification if viewed since update", async () => {
+    const spy = jest.spyOn(Notification, "create");
+    const document = await buildDocument();
+    await Revision.createFromDocument(document);
+    document.text = "Updated body content";
+    document.updatedAt = new Date();
+    const revision = await Revision.createFromDocument(document);
+    const collaborator = await buildUser({ teamId: document.teamId });
+    document.collaboratorIds = [collaborator.id];
+    await document.save();
+
+    await View.create({
+      userId: collaborator.id,
+      documentId: document.id,
+    });
+
+    const task = new RevisionCreatedNotificationsTask();
+    await task.perform({
+      name: "revisions.create",
+      documentId: document.id,
+      collectionId: document.collectionId,
+      teamId: document.teamId,
+      actorId: collaborator.id,
+      modelId: revision.id,
+      ip,
+    });
+    expect(spy).not.toHaveBeenCalled();
+  });
+
+  test("should not send a notification to last editor", async () => {
+    const spy = jest.spyOn(Notification, "create");
+    const user = await buildUser();
+    const document = await buildDocument({
+      teamId: user.teamId,
+      lastModifiedById: user.id,
+    });
+    await Revision.createFromDocument(document);
+    document.text = "Updated body content";
+    document.updatedAt = new Date();
+    const revision = await Revision.createFromDocument(document);
+
+    const task = new RevisionCreatedNotificationsTask();
+    await task.perform({
+      name: "revisions.create",
+      documentId: document.id,
+      collectionId: document.collectionId,
+      teamId: document.teamId,
+      actorId: user.id,
+      modelId: revision.id,
+      ip,
+    });
+    expect(spy).not.toHaveBeenCalled();
+  });
+
+  test("should send a notification for subscriptions, even to collaborator", async () => {
+    const spy = jest.spyOn(Notification, "create");
+    const document = await buildDocument();
+    await Revision.createFromDocument(document);
+    document.text = "Updated body content";
+    document.updatedAt = new Date();
+    const revision = await Revision.createFromDocument(document);
+    const collaborator = await buildUser({ teamId: document.teamId });
+    const subscriber = await buildUser({ teamId: document.teamId });
+
+    document.collaboratorIds = [collaborator.id, subscriber.id];
+
+    await document.save();
+
+    await Subscription.create({
+      userId: subscriber.id,
+      documentId: document.id,
+      event: "documents.update",
+      enabled: true,
+    });
+
+    const task = new RevisionCreatedNotificationsTask();
+
+    await task.perform({
+      name: "revisions.create",
+      documentId: document.id,
+      collectionId: document.collectionId,
+      teamId: document.teamId,
+      actorId: collaborator.id,
+      modelId: revision.id,
+      ip,
+    });
+
+    expect(spy).toHaveBeenCalled();
+  });
+
+  test("should create subscriptions for collaborator", async () => {
+    const collaborator0 = await buildUser();
+    const collaborator1 = await buildUser({ teamId: collaborator0.teamId });
+    const collaborator2 = await buildUser({ teamId: collaborator0.teamId });
+    const document = await buildDocument({ userId: collaborator0.id });
+    await Revision.createFromDocument(document);
+    document.text = "Updated body content";
+    document.updatedAt = new Date();
+    const revision = await Revision.createFromDocument(document);
+
+    await document.update({
+      collaboratorIds: [collaborator0.id, collaborator1.id, collaborator2.id],
+    });
+
+    const task = new RevisionCreatedNotificationsTask();
+
+    await task.perform({
+      name: "revisions.create",
+      documentId: document.id,
+      collectionId: document.collectionId,
+      teamId: document.teamId,
+      actorId: collaborator0.id,
+      modelId: revision.id,
+      ip,
+    });
+
+    const events = await Event.findAll();
+
+    // Should emit 3 `subscriptions.create` events.
+    expect(events.length).toEqual(3);
+    expect(events[0].name).toEqual("subscriptions.create");
+    expect(events[1].name).toEqual("subscriptions.create");
+    expect(events[2].name).toEqual("subscriptions.create");
+
+    // Each event should point to same document.
+    expect(events[0].documentId).toEqual(document.id);
+    expect(events[1].documentId).toEqual(document.id);
+    expect(events[2].documentId).toEqual(document.id);
+
+    // Events should mention correct `userId`.
+    expect(events[0].userId).toEqual(collaborator0.id);
+    expect(events[1].userId).toEqual(collaborator1.id);
+    expect(events[2].userId).toEqual(collaborator2.id);
+  });
+
+  test("should not send multiple emails", async () => {
+    const spy = jest.spyOn(Notification, "create");
+    const collaborator0 = await buildUser();
+    const collaborator1 = await buildUser({ teamId: collaborator0.teamId });
+    const collaborator2 = await buildUser({ teamId: collaborator0.teamId });
+    const document = await buildDocument({
+      teamId: collaborator0.teamId,
+      userId: collaborator0.id,
+    });
+    await Revision.createFromDocument(document);
+    document.text = "Updated body content";
+    document.updatedAt = new Date();
+    const revision = await Revision.createFromDocument(document);
+
+    await document.update({
+      collaboratorIds: [collaborator0.id, collaborator1.id, collaborator2.id],
+    });
+
+    const task = new RevisionCreatedNotificationsTask();
+
+    // Those changes will also emit a `revisions.create` event.
+    await task.perform({
+      name: "revisions.create",
+      documentId: document.id,
+      collectionId: document.collectionId,
+      teamId: document.teamId,
+      actorId: collaborator0.id,
+      modelId: revision.id,
+      ip,
+    });
+
+    // This should send out 2 emails, one for each collaborator that did not
+    // participate in the edit
+    expect(spy).toHaveBeenCalledTimes(2);
+  });
+
+  test("should not create subscriptions if previously unsubscribed", async () => {
+    const spy = jest.spyOn(Notification, "create");
+    const collaborator0 = await buildUser();
+    const collaborator1 = await buildUser({ teamId: collaborator0.teamId });
+    const collaborator2 = await buildUser({ teamId: collaborator0.teamId });
+    const document = await buildDocument({
+      teamId: collaborator0.teamId,
+      userId: collaborator0.id,
+    });
+    await Revision.createFromDocument(document);
+    document.text = "Updated body content";
+    document.updatedAt = new Date();
+    const revision = await Revision.createFromDocument(document);
+
+    await document.update({
+      collaboratorIds: [collaborator0.id, collaborator1.id, collaborator2.id],
+    });
+
+    // `collaborator2` created a subscription.
+    const subscription2 = await Subscription.create({
+      userId: collaborator2.id,
+      documentId: document.id,
+      event: "documents.update",
+    });
+
+    // `collaborator2` would no longer like to be notified.
+    await subscription2.destroy();
+
+    const task = new RevisionCreatedNotificationsTask();
+
+    await task.perform({
+      name: "revisions.create",
+      documentId: document.id,
+      collectionId: document.collectionId,
+      teamId: document.teamId,
+      actorId: collaborator0.id,
+      modelId: revision.id,
+      ip,
+    });
+
+    const events = await Event.findAll();
+
+    // Should emit 2 `subscriptions.create` events.
+    expect(events.length).toEqual(2);
+    expect(events[0].name).toEqual("subscriptions.create");
+    expect(events[1].name).toEqual("subscriptions.create");
+
+    // Each event should point to same document.
+    expect(events[0].documentId).toEqual(document.id);
+    expect(events[1].documentId).toEqual(document.id);
+
+    // Events should mention correct `userId`.
+    expect(events[0].userId).toEqual(collaborator0.id);
+    expect(events[1].userId).toEqual(collaborator1.id);
+
+    // One notification as one collaborator performed edit and the other is
+    // unsubscribed
+    expect(spy).toHaveBeenCalledTimes(1);
+  });
+
+  test("should send a notification for subscriptions to non-collaborators", async () => {
+    const spy = jest.spyOn(Notification, "create");
+    const document = await buildDocument();
+    const collaborator = await buildUser({ teamId: document.teamId });
+    const subscriber = await buildUser({ teamId: document.teamId });
+    await Revision.createFromDocument(document);
+    document.text = "Updated body content";
+    document.updatedAt = new Date();
+    const revision = await Revision.createFromDocument(document);
+
+    // `subscriber` hasn't collaborated on `document`.
+    document.collaboratorIds = [collaborator.id];
+
+    await document.save();
+
+    // `subscriber` subscribes to `document`'s changes.
+    // Specifically "documents.update" event.
+    await Subscription.create({
+      userId: subscriber.id,
+      documentId: document.id,
+      event: "documents.update",
+      enabled: true,
+    });
+
+    const task = new RevisionCreatedNotificationsTask();
+
+    await task.perform({
+      name: "revisions.create",
+      documentId: document.id,
+      collectionId: document.collectionId,
+      teamId: document.teamId,
+      actorId: collaborator.id,
+      modelId: revision.id,
+      ip,
+    });
+
+    expect(spy).toHaveBeenCalled();
+  });
+
+  test("should not send a notification for subscriptions to collaborators if unsubscribed", async () => {
+    const spy = jest.spyOn(Notification, "create");
+
+    const document = await buildDocument();
+    await Revision.createFromDocument(document);
+    document.text = "Updated body content";
+    document.updatedAt = new Date();
+    const revision = await Revision.createFromDocument(document);
+    const collaborator = await buildUser({ teamId: document.teamId });
+    const subscriber = await buildUser({ teamId: document.teamId });
+
+    // `subscriber` has collaborated on `document`.
+    document.collaboratorIds = [collaborator.id, subscriber.id];
+
+    await document.save();
+
+    // `subscriber` subscribes to `document`'s changes.
+    // Specifically "documents.update" event.
+    const subscription = await Subscription.create({
+      userId: subscriber.id,
+      documentId: document.id,
+      event: "documents.update",
+      enabled: true,
+    });
+
+    subscription.destroy();
+
+    const task = new RevisionCreatedNotificationsTask();
+
+    await task.perform({
+      name: "revisions.create",
+      documentId: document.id,
+      collectionId: document.collectionId,
+      teamId: document.teamId,
+      actorId: collaborator.id,
+      modelId: revision.id,
+      ip,
+    });
+
+    // Should send notification to `collaborator` and not `subscriber`.
+    expect(spy).toHaveBeenCalledTimes(1);
+  });
+
+  test("should not send a notification for subscriptions to members outside of the team", async () => {
+    const spy = jest.spyOn(Notification, "create");
+
+    const document = await buildDocument();
+    await Revision.createFromDocument(document);
+    document.text = "Updated body content";
+    document.updatedAt = new Date();
+    const revision = await Revision.createFromDocument(document);
+    const collaborator = await buildUser({ teamId: document.teamId });
+
+    // `subscriber` *does not* belong
+    // to `collaborator`'s team,
+    const subscriber = await buildUser();
+
+    // `subscriber` hasn't collaborated on `document`.
+    document.collaboratorIds = [collaborator.id];
+
+    await document.save();
+
+    // `subscriber` subscribes to `document`'s changes.
+    // Specifically "documents.update" event.
+    // Not sure how they got hold of this document,
+    // but let's just pretend they did!
+    await Subscription.create({
+      userId: subscriber.id,
+      documentId: document.id,
+      event: "documents.update",
+      enabled: true,
+    });
+
+    const task = new RevisionCreatedNotificationsTask();
+
+    await task.perform({
+      name: "revisions.create",
+      documentId: document.id,
+      collectionId: document.collectionId,
+      teamId: document.teamId,
+      actorId: collaborator.id,
+      modelId: revision.id,
+      ip,
+    });
+
+    // Should send notification to `collaborator` and not `subscriber`.
+    expect(spy).toHaveBeenCalledTimes(1);
+  });
+
+  test("should not send a notification if viewed since update", async () => {
+    const spy = jest.spyOn(Notification, "create");
+
+    const document = await buildDocument();
+    const revision = await Revision.createFromDocument(document);
+    const collaborator = await buildUser({ teamId: document.teamId });
+    document.collaboratorIds = [collaborator.id];
+    await document.save();
+
+    await View.create({
+      userId: collaborator.id,
+      documentId: document.id,
+    });
+
+    const task = new RevisionCreatedNotificationsTask();
+
+    await task.perform({
+      name: "revisions.create",
+      documentId: document.id,
+      collectionId: document.collectionId,
+      teamId: document.teamId,
+      actorId: collaborator.id,
+      modelId: revision.id,
+      ip,
+    });
+    expect(spy).not.toHaveBeenCalled();
+  });
+
+  test("should not send a notification to last editor", async () => {
+    const spy = jest.spyOn(Notification, "create");
+
+    const user = await buildUser();
+    const document = await buildDocument({
+      teamId: user.teamId,
+      lastModifiedById: user.id,
+    });
+    const revision = await Revision.createFromDocument(document);
+
+    const task = new RevisionCreatedNotificationsTask();
+    await task.perform({
+      name: "revisions.create",
+      documentId: document.id,
+      collectionId: document.collectionId,
+      teamId: document.teamId,
+      actorId: user.id,
+      modelId: revision.id,
+      ip,
+    });
+    expect(spy).not.toHaveBeenCalled();
+  });
+});