mirror of
https://github.com/outline/outline.git
synced 2026-11-21 13:34:02 +03:00
260 lines
8.6 KiB
TypeScript
260 lines
8.6 KiB
TypeScript
import { NotificationEventType } from "@shared/types";
|
|
import {
|
|
buildComment,
|
|
buildDocument,
|
|
buildSubscription,
|
|
buildUser,
|
|
} from "@server/test/factories";
|
|
import NotificationHelper from "./NotificationHelper";
|
|
|
|
describe("NotificationHelper", () => {
|
|
describe("getCommentNotificationRecipients", () => {
|
|
it("should return users who have notification enabled for comment creation and are subscribed to the document in case of parent comment", async () => {
|
|
const documentAuthor = await buildUser();
|
|
const document = await buildDocument({
|
|
userId: documentAuthor.id,
|
|
teamId: documentAuthor.teamId,
|
|
});
|
|
const notificationEnabledUser = await buildUser({
|
|
teamId: document.teamId,
|
|
notificationSettings: { [NotificationEventType.CreateComment]: true },
|
|
});
|
|
const notificationDisabledUser = await buildUser({
|
|
teamId: document.teamId,
|
|
notificationSettings: { [NotificationEventType.CreateComment]: false },
|
|
});
|
|
await Promise.all([
|
|
buildSubscription({
|
|
userId: documentAuthor.id,
|
|
documentId: document.id,
|
|
}),
|
|
buildSubscription({
|
|
userId: notificationEnabledUser.id,
|
|
documentId: document.id,
|
|
}),
|
|
buildSubscription({
|
|
userId: notificationDisabledUser.id,
|
|
documentId: document.id,
|
|
}),
|
|
]);
|
|
|
|
const comment = await buildComment({
|
|
documentId: document.id,
|
|
userId: documentAuthor.id,
|
|
});
|
|
|
|
const recipients =
|
|
await NotificationHelper.getCommentNotificationRecipients(
|
|
document,
|
|
comment,
|
|
comment.createdById
|
|
);
|
|
|
|
expect(recipients.length).toEqual(1);
|
|
expect(recipients[0].id).toEqual(notificationEnabledUser.id);
|
|
});
|
|
|
|
it("should return users who have notification enabled for comment creation and are in the thread in case of child comment", async () => {
|
|
const documentAuthor = await buildUser();
|
|
const document = await buildDocument({
|
|
userId: documentAuthor.id,
|
|
teamId: documentAuthor.teamId,
|
|
});
|
|
const notificationEnabledUserInThread = await buildUser({
|
|
teamId: document.teamId,
|
|
notificationSettings: { [NotificationEventType.CreateComment]: true },
|
|
});
|
|
const notificationEnabledUserNotInThread = await buildUser({
|
|
teamId: document.teamId,
|
|
notificationSettings: { [NotificationEventType.CreateComment]: true },
|
|
});
|
|
const notificationDisabledUser = await buildUser({
|
|
teamId: document.teamId,
|
|
notificationSettings: {
|
|
[NotificationEventType.CreateComment]: false,
|
|
},
|
|
});
|
|
await Promise.all([
|
|
buildSubscription({
|
|
userId: documentAuthor.id,
|
|
documentId: document.id,
|
|
}),
|
|
buildSubscription({
|
|
userId: notificationEnabledUserInThread.id,
|
|
documentId: document.id,
|
|
}),
|
|
buildSubscription({
|
|
userId: notificationEnabledUserNotInThread.id,
|
|
documentId: document.id,
|
|
}),
|
|
buildSubscription({
|
|
userId: notificationDisabledUser.id,
|
|
documentId: document.id,
|
|
}),
|
|
]);
|
|
const parentComment = await buildComment({
|
|
documentId: document.id,
|
|
userId: notificationEnabledUserInThread.id,
|
|
});
|
|
const childComment = await buildComment({
|
|
documentId: document.id,
|
|
userId: documentAuthor.id,
|
|
parentCommentId: parentComment.id,
|
|
});
|
|
|
|
const recipients =
|
|
await NotificationHelper.getCommentNotificationRecipients(
|
|
document,
|
|
childComment,
|
|
childComment.createdById
|
|
);
|
|
|
|
expect(recipients.length).toEqual(1);
|
|
expect(recipients[0].id).toEqual(notificationEnabledUserInThread.id);
|
|
});
|
|
});
|
|
|
|
describe("getDocumentNotificationRecipients", () => {
|
|
it("should return all users who have notification enabled for the event", async () => {
|
|
const documentAuthor = await buildUser();
|
|
const document = await buildDocument({
|
|
userId: documentAuthor.id,
|
|
teamId: documentAuthor.teamId,
|
|
});
|
|
const notificationEnabledUser = await buildUser({
|
|
teamId: document.teamId,
|
|
notificationSettings: { [NotificationEventType.UpdateDocument]: true },
|
|
});
|
|
|
|
const recipients =
|
|
await NotificationHelper.getDocumentNotificationRecipients({
|
|
document,
|
|
notificationType: NotificationEventType.UpdateDocument,
|
|
onlySubscribers: false,
|
|
actorId: documentAuthor.id,
|
|
});
|
|
|
|
expect(recipients.length).toEqual(1);
|
|
expect(recipients[0].id).toEqual(notificationEnabledUser.id);
|
|
});
|
|
|
|
it("should return users who have subscribed to the document", async () => {
|
|
const documentAuthor = await buildUser();
|
|
const document = await buildDocument({
|
|
userId: documentAuthor.id,
|
|
teamId: documentAuthor.teamId,
|
|
});
|
|
const subscribedUser = await buildUser({ teamId: document.teamId });
|
|
await buildSubscription({
|
|
userId: subscribedUser.id,
|
|
documentId: document.id,
|
|
});
|
|
|
|
const recipients =
|
|
await NotificationHelper.getDocumentNotificationRecipients({
|
|
document,
|
|
notificationType: NotificationEventType.UpdateDocument,
|
|
onlySubscribers: true,
|
|
actorId: documentAuthor.id,
|
|
});
|
|
|
|
expect(recipients.length).toEqual(1);
|
|
expect(recipients[0].id).toEqual(subscribedUser.id);
|
|
});
|
|
|
|
it("should return users who have subscribed to the collection", async () => {
|
|
const documentAuthor = await buildUser();
|
|
const document = await buildDocument({
|
|
userId: documentAuthor.id,
|
|
teamId: documentAuthor.teamId,
|
|
});
|
|
const subscribedUser = await buildUser({ teamId: document.teamId });
|
|
await buildSubscription({
|
|
userId: subscribedUser.id,
|
|
collectionId: document.collectionId!,
|
|
});
|
|
|
|
const recipients =
|
|
await NotificationHelper.getDocumentNotificationRecipients({
|
|
document,
|
|
notificationType: NotificationEventType.UpdateDocument,
|
|
onlySubscribers: true,
|
|
actorId: documentAuthor.id,
|
|
});
|
|
|
|
expect(recipients.length).toEqual(1);
|
|
expect(recipients[0].id).toEqual(subscribedUser.id);
|
|
});
|
|
|
|
it("should return users who have subscribed to either the document or the containing collection", async () => {
|
|
const documentAuthor = await buildUser();
|
|
const document = await buildDocument({
|
|
userId: documentAuthor.id,
|
|
teamId: documentAuthor.teamId,
|
|
});
|
|
const [documentSubscribedUser, collectionSubscribedUser] =
|
|
await Promise.all([
|
|
buildUser({
|
|
teamId: document.teamId,
|
|
}),
|
|
buildUser({
|
|
teamId: document.teamId,
|
|
}),
|
|
]);
|
|
await Promise.all([
|
|
buildSubscription({
|
|
userId: documentSubscribedUser.id,
|
|
documentId: document.id,
|
|
}),
|
|
buildSubscription({
|
|
userId: collectionSubscribedUser.id,
|
|
collectionId: document.collectionId!,
|
|
}),
|
|
]);
|
|
|
|
const recipients =
|
|
await NotificationHelper.getDocumentNotificationRecipients({
|
|
document,
|
|
notificationType: NotificationEventType.UpdateDocument,
|
|
onlySubscribers: true,
|
|
actorId: documentAuthor.id,
|
|
});
|
|
|
|
expect(recipients.length).toEqual(2);
|
|
|
|
const recipientIds = recipients.map((u) => u.id);
|
|
expect(recipientIds).toContain(collectionSubscribedUser.id);
|
|
expect(recipientIds).toContain(documentSubscribedUser.id);
|
|
});
|
|
|
|
it("should not return suspended users", async () => {
|
|
const documentAuthor = await buildUser();
|
|
const document = await buildDocument({
|
|
userId: documentAuthor.id,
|
|
teamId: documentAuthor.teamId,
|
|
});
|
|
const notificationEnabledUser = await buildUser({
|
|
teamId: document.teamId,
|
|
notificationSettings: { [NotificationEventType.UpdateDocument]: true },
|
|
});
|
|
// suspended user
|
|
await buildUser({
|
|
suspendedAt: new Date(),
|
|
teamId: document.teamId,
|
|
notificationSettings: { [NotificationEventType.UpdateDocument]: true },
|
|
});
|
|
|
|
const recipients =
|
|
await NotificationHelper.getDocumentNotificationRecipients({
|
|
document,
|
|
notificationType: NotificationEventType.UpdateDocument,
|
|
onlySubscribers: false,
|
|
actorId: documentAuthor.id,
|
|
});
|
|
|
|
expect(recipients.length).toEqual(1);
|
|
expect(recipients[0].id).toEqual(notificationEnabledUser.id);
|
|
});
|
|
});
|
|
});
|