@oneuptime/common 12.0.30 → 12.0.32

package/Tests/Server/Services/UserNotificationSettingMonitorDefaults.test.ts

@@ -0,0 +1,248 @@
+import UserNotificationSetting from "../../../Models/DatabaseModels/UserNotificationSetting";
+import UserNotificationSettingService from "../../../Server/Services/UserNotificationSettingService";
+import NotificationSettingEventType from "../../../Types/NotificationSetting/NotificationSettingEventType";
+import ObjectID from "../../../Types/ObjectID";
+import PositiveNumber from "../../../Types/PositiveNumber";
+import {
+  afterEach,
+  beforeEach,
+  describe,
+  expect,
+  jest,
+  test,
+} from "@jest/globals";
+
+const PROJECT_ID: ObjectID = new ObjectID(
+  "11111111-1111-4111-8111-111111111111",
+);
+const OTHER_PROJECT_ID: ObjectID = new ObjectID(
+  "33333333-3333-4333-8333-333333333333",
+);
+const USER_ID: ObjectID = new ObjectID("22222222-2222-4222-8222-222222222222");
+const OTHER_USER_ID: ObjectID = new ObjectID(
+  "44444444-4444-4444-8444-444444444444",
+);
+
+const STATUS_CHANGE_EVENT: NotificationSettingEventType =
+  NotificationSettingEventType.SEND_MONITOR_STATUS_CHANGED_OWNER_NOTIFICATION;
+
+const ENABLED_MONITOR_EVENTS: Array<NotificationSettingEventType> = [
+  NotificationSettingEventType.SEND_MONITOR_NOTIFICATION_WHEN_NO_PROBES_ARE_MONITORING_THE_MONITOR,
+  NotificationSettingEventType.SEND_MONITOR_NOTIFICATION_WHEN_PORBE_STATUS_CHANGES,
+];
+
+interface StoredSetting {
+  userId: string;
+  projectId: string;
+  eventType: NotificationSettingEventType;
+  alertByEmail: boolean;
+  alertBySMS: boolean;
+  alertByCall: boolean;
+  alertByPush: boolean;
+  alertByWhatsApp: boolean;
+  alertByTelegram: boolean;
+  alertBySlack: boolean;
+  alertByMicrosoftTeams: boolean;
+  alertByWebhook: boolean;
+  isRoot: boolean;
+}
+
+interface SettingIdentity {
+  userId: unknown;
+  projectId: unknown;
+  eventType: unknown;
+}
+
+function key(data: SettingIdentity): string {
+  return `${String(data.userId)}|${String(data.projectId)}|${String(
+    data.eventType,
+  )}`;
+}
+
+describe("UserNotificationSettingService monitor defaults", () => {
+  let store: Map<string, StoredSetting>;
+  let createdSettings: Array<StoredSetting>;
+  let queriedSettings: Array<SettingIdentity>;
+
+  beforeEach(() => {
+    store = new Map<string, StoredSetting>();
+    createdSettings = [];
+    queriedSettings = [];
+
+    jest
+      .spyOn(UserNotificationSettingService, "countBy")
+      .mockImplementation(((args: {
+        query: {
+          userId: ObjectID;
+          projectId: ObjectID;
+          eventType: NotificationSettingEventType;
+        };
+      }): Promise<PositiveNumber> => {
+        queriedSettings.push(args.query);
+
+        return Promise.resolve(
+          new PositiveNumber(store.has(key(args.query)) ? 1 : 0),
+        );
+      }) as never);
+
+    jest
+      .spyOn(UserNotificationSettingService, "create")
+      .mockImplementation(((args: {
+        data: UserNotificationSetting;
+        props: { isRoot?: boolean };
+      }): Promise<UserNotificationSetting> => {
+        const item: UserNotificationSetting = args.data;
+        const storedSetting: StoredSetting = {
+          userId: String(item.userId),
+          projectId: String(item.projectId),
+          eventType: item.eventType as NotificationSettingEventType,
+          alertByEmail: Boolean(item.alertByEmail),
+          alertBySMS: Boolean(item.alertBySMS),
+          alertByCall: Boolean(item.alertByCall),
+          alertByPush: Boolean(item.alertByPush),
+          alertByWhatsApp: Boolean(item.alertByWhatsApp),
+          alertByTelegram: Boolean(item.alertByTelegram),
+          alertBySlack: Boolean(item.alertBySlack),
+          alertByMicrosoftTeams: Boolean(item.alertByMicrosoftTeams),
+          alertByWebhook: Boolean(item.alertByWebhook),
+          isRoot: Boolean(args.props.isRoot),
+        };
+
+        createdSettings.push(storedSetting);
+        store.set(key(storedSetting), storedSetting);
+
+        return Promise.resolve(item);
+      }) as never);
+  });
+
+  afterEach(() => {
+    jest.restoreAllMocks();
+  });
+
+  function stored(
+    eventType: NotificationSettingEventType,
+    userId: ObjectID = USER_ID,
+    projectId: ObjectID = PROJECT_ID,
+  ): StoredSetting | undefined {
+    return store.get(key({ userId, projectId, eventType }));
+  }
+
+  function seed(setting: StoredSetting): void {
+    store.set(key(setting), setting);
+  }
+
+  test("does not seed monitor status-change notifications for a new membership", async () => {
+    await UserNotificationSettingService.addDefaultNotificationSettingsForUser(
+      USER_ID,
+      PROJECT_ID,
+    );
+
+    expect(stored(STATUS_CHANGE_EVENT)).toBeUndefined();
+    expect(
+      createdSettings.some((setting: StoredSetting) => {
+        return setting.eventType === STATUS_CHANGE_EVENT;
+      }),
+    ).toBe(false);
+    expect(
+      queriedSettings.some((setting: SettingIdentity) => {
+        return setting.eventType === STATUS_CHANGE_EVENT;
+      }),
+    ).toBe(false);
+  });
+
+  test("keeps the other monitor defaults enabled by email only", async () => {
+    await UserNotificationSettingService.addDefaultNotificationSettingsForUser(
+      USER_ID,
+      PROJECT_ID,
+    );
+
+    for (const eventType of ENABLED_MONITOR_EVENTS) {
+      expect(stored(eventType)).toEqual({
+        userId: USER_ID.toString(),
+        projectId: PROJECT_ID.toString(),
+        eventType,
+        alertByEmail: true,
+        alertBySMS: false,
+        alertByCall: false,
+        alertByPush: false,
+        alertByWhatsApp: false,
+        alertByTelegram: false,
+        alertBySlack: false,
+        alertByMicrosoftTeams: false,
+        alertByWebhook: false,
+        isRoot: true,
+      });
+    }
+  });
+
+  test("remains idempotent without recreating the disabled default", async () => {
+    await UserNotificationSettingService.addDefaultNotificationSettingsForUser(
+      USER_ID,
+      PROJECT_ID,
+    );
+
+    const settingsCreatedByFirstCall: number = createdSettings.length;
+    const rowsCreatedByFirstCall: number = store.size;
+
+    await UserNotificationSettingService.addDefaultNotificationSettingsForUser(
+      USER_ID,
+      PROJECT_ID,
+    );
+
+    expect(createdSettings).toHaveLength(settingsCreatedByFirstCall);
+    expect(store.size).toBe(rowsCreatedByFirstCall);
+    expect(stored(STATUS_CHANGE_EVENT)).toBeUndefined();
+  });
+
+  test("preserves an existing explicit status-change preference", async () => {
+    const optedInSetting: StoredSetting = {
+      userId: USER_ID.toString(),
+      projectId: PROJECT_ID.toString(),
+      eventType: STATUS_CHANGE_EVENT,
+      alertByEmail: false,
+      alertBySMS: false,
+      alertByCall: false,
+      alertByPush: true,
+      alertByWhatsApp: false,
+      alertByTelegram: false,
+      alertBySlack: true,
+      alertByMicrosoftTeams: false,
+      alertByWebhook: false,
+      isRoot: true,
+    };
+    seed(optedInSetting);
+
+    await UserNotificationSettingService.addDefaultNotificationSettingsForUser(
+      USER_ID,
+      PROJECT_ID,
+    );
+
+    expect(stored(STATUS_CHANGE_EVENT)).toEqual(optedInSetting);
+    expect(
+      createdSettings.some((setting: StoredSetting) => {
+        return setting.eventType === STATUS_CHANGE_EVENT;
+      }),
+    ).toBe(false);
+  });
+
+  test("applies the off default independently to every user and project", async () => {
+    await UserNotificationSettingService.addDefaultNotificationSettingsForUser(
+      USER_ID,
+      PROJECT_ID,
+    );
+    await UserNotificationSettingService.addDefaultNotificationSettingsForUser(
+      OTHER_USER_ID,
+      OTHER_PROJECT_ID,
+    );
+
+    expect(stored(STATUS_CHANGE_EVENT, USER_ID, PROJECT_ID)).toBeUndefined();
+    expect(
+      stored(STATUS_CHANGE_EVENT, OTHER_USER_ID, OTHER_PROJECT_ID),
+    ).toBeUndefined();
+
+    for (const eventType of ENABLED_MONITOR_EVENTS) {
+      expect(stored(eventType, USER_ID, PROJECT_ID)).toBeDefined();
+      expect(stored(eventType, OTHER_USER_ID, OTHER_PROJECT_ID)).toBeDefined();
+    }
+  });
+});

package/Tests/Server/Services/UserNotificationSettingWorkspaceChannels.test.ts

@@ -3,10 +3,13 @@ import UserSlackService from "../../../Server/Services/UserSlackService";
 import UserMicrosoftTeamsService from "../../../Server/Services/UserMicrosoftTeamsService";
 import WorkspaceUserNotificationService from "../../../Server/Services/WorkspaceUserNotificationService";
 import ProjectCallSMSConfigService from "../../../Server/Services/ProjectCallSMSConfigService";
+import MailService from "../../../Server/Services/MailService";
+import UserEmailService from "../../../Server/Services/UserEmailService";
 import logger from "../../../Server/Utils/Logger";
 import UserNotificationSetting from "../../../Models/DatabaseModels/UserNotificationSetting";
 import UserSlack from "../../../Models/DatabaseModels/UserSlack";
 import UserMicrosoftTeams from "../../../Models/DatabaseModels/UserMicrosoftTeams";
+import UserEmail from "../../../Models/DatabaseModels/UserEmail";
 import { CallRequestMessage } from "../../../Types/Call/CallRequest";
 import { EmailEnvelope } from "../../../Types/Email/EmailMessage";
 import EmailTemplateType from "../../../Types/Email/EmailTemplateType";
@@ -60,6 +63,8 @@ const TEAMS_USER_ID: string = "entra-object-id-1";
 
 const EVENT_TYPE: NotificationSettingEventType =
   NotificationSettingEventType.SEND_INCIDENT_CREATED_OWNER_NOTIFICATION;
+const MONITOR_STATUS_CHANGE_EVENT: NotificationSettingEventType =
+  NotificationSettingEventType.SEND_MONITOR_STATUS_CHANGED_OWNER_NOTIFICATION;
 
 type SendUserNotificationData = Parameters<
   typeof UserNotificationSettingService.sendUserNotification
@@ -114,6 +119,8 @@ describe("UserNotificationSettingService.sendUserNotification - workspace channe
   let findSettings: jest.SpyInstance;
   let findSlacks: jest.SpyInstance;
   let findTeams: jest.SpyInstance;
+  let findEmails: jest.SpyInstance;
+  let sendMail: jest.SpyInstance;
   let sendDm: jest.SpyInstance;
   let loggerError: jest.SpyInstance;
 
@@ -133,6 +140,16 @@ describe("UserNotificationSettingService.sendUserNotification - workspace channe
       .spyOn(ProjectCallSMSConfigService, "getProjectDefaultTwilioConfig")
       .mockResolvedValue(undefined as never);
 
+    findEmails = jest.spyOn(UserEmailService, "findBy").mockResolvedValue([
+      {
+        email: "user@example.com",
+      } as unknown as UserEmail,
+    ] as never);
+
+    sendMail = jest
+      .spyOn(MailService, "sendMail")
+      .mockResolvedValue(undefined as never);
+
     findSlacks = jest.spyOn(UserSlackService, "findBy").mockResolvedValue([
       {
         id: new ObjectID("44444444-4444-4444-8444-444444444444"),
@@ -251,13 +268,37 @@ describe("UserNotificationSettingService.sendUserNotification - workspace channe
       expect(findTeams).not.toHaveBeenCalled();
     });
 
-    test("no settings row at all sends nothing", async () => {
+    test("no monitor status-change setting sends nothing on any channel", async () => {
       findSettings.mockResolvedValue(null as never);
 
       await UserNotificationSettingService.sendUserNotification(
-        notificationData(),
+        notificationData({ eventType: MONITOR_STATUS_CHANGE_EVENT }),
+      );
+
+      expect(findEmails).not.toHaveBeenCalled();
+      expect(sendMail).not.toHaveBeenCalled();
+      expect(
+        ProjectCallSMSConfigService.getProjectDefaultTwilioConfig,
+      ).not.toHaveBeenCalled();
+      expect(findSlacks).not.toHaveBeenCalled();
+      expect(findTeams).not.toHaveBeenCalled();
+      expect(sendDm).not.toHaveBeenCalled();
+    });
+
+    test("an explicit monitor status-change email opt-in still delivers", async () => {
+      findSettings.mockResolvedValue(
+        settingsRow({ alertByEmail: true }) as never,
       );
 
+      await UserNotificationSettingService.sendUserNotification(
+        notificationData({ eventType: MONITOR_STATUS_CHANGE_EVENT }),
+      );
+
+      expect(findEmails).toHaveBeenCalledTimes(1);
+      expect(sendMail).toHaveBeenCalledTimes(1);
+      expect(sendMail.mock.calls[0]?.[0]).toMatchObject({
+        toEmail: "user@example.com",
+      });
       expect(sendDm).not.toHaveBeenCalled();
     });
   });

package/Tests/Server/Services/UserServiceSeatLimit.test.ts

@@ -0,0 +1,182 @@
+import UserService from "../../../Server/Services/UserService";
+import EnterpriseLicenseSeatUtil from "../../../Server/Utils/EnterpriseLicense/EnterpriseLicenseSeatUtil";
+import CreateBy from "../../../Server/Types/Database/CreateBy";
+import User from "../../../Models/DatabaseModels/User";
+import Email from "../../../Types/Email";
+import BadDataException from "../../../Types/Exception/BadDataException";
+import ObjectID from "../../../Types/ObjectID";
+import PositiveNumber from "../../../Types/PositiveNumber";
+import { beforeEach, afterEach, describe, expect, it } from "@jest/globals";
+
+/*
+ * Where the enterprise seat limit is actually enforced.
+ *
+ * The limit is bought per user and shared by every instance on the licence,
+ * and a seat is consumed by a person EXISTING on the installation — not by the
+ * particular door they walked through. There are eight of those doors: team
+ * invitations, self-service signup, SAML and OIDC just-in-time provisioning
+ * (project-level and global), three SCIM routes, the Admin Dashboard user
+ * form, and the master API key posting to /api/user. Every one of them ends up
+ * in UserService.create, so the check belongs in its create hook and nowhere
+ * else; a check on the invitation would have left signup and SSO as open doors
+ * beside it.
+ *
+ * The single most important assertion in this file is the isRoot one. Team
+ * invitations create the invited user with `props: { isRoot: true }`
+ * (TeamMemberService.onBeforeCreate), so the usual "internal writes bypass
+ * this" instinct would exempt invitations — the exact path this feature was
+ * asked for.
+ */
+
+jest.mock(
+  "../../../Server/Utils/EnterpriseLicense/EnterpriseLicenseSeatUtil",
+  () => {
+    return {
+      __esModule: true,
+      default: {
+        assertSeatAvailableForNewUser: jest.fn(),
+      },
+    };
+  },
+);
+
+type OnBeforeCreateFunction = (createBy: CreateBy<User>) => Promise<unknown>;
+
+/*
+ * onBeforeCreate is protected, which is exactly the right shape for it and
+ * exactly the wrong shape for a test. Reached through the instance rather than
+ * re-implemented, so this suite breaks if the hook is renamed or removed.
+ */
+const onBeforeCreate: OnBeforeCreateFunction = (
+  createBy: CreateBy<User>,
+): Promise<unknown> => {
+  return (
+    UserService as unknown as {
+      onBeforeCreate: OnBeforeCreateFunction;
+    }
+  ).onBeforeCreate(createBy);
+};
+
+type MakeCreateByFunction = (props?: Record<string, unknown>) => CreateBy<User>;
+
+const makeCreateBy: MakeCreateByFunction = (
+  props?: Record<string, unknown>,
+): CreateBy<User> => {
+  const user: User = new User();
+  user.email = new Email("someone@acme.com");
+
+  return {
+    data: user,
+    props: props || {},
+  } as unknown as CreateBy<User>;
+};
+
+type AssertSeatMockFunction = () => jest.Mock;
+
+const assertSeatMock: AssertSeatMockFunction = (): jest.Mock => {
+  return EnterpriseLicenseSeatUtil.assertSeatAvailableForNewUser as unknown as jest.Mock;
+};
+
+describe("UserService - the enterprise seat limit", () => {
+  beforeEach(() => {
+    jest.clearAllMocks();
+    assertSeatMock().mockResolvedValue(undefined);
+    UserService.countBy = jest.fn().mockResolvedValue(new PositiveNumber(7));
+  });
+
+  afterEach(() => {
+    jest.restoreAllMocks();
+  });
+
+  it("checks the seat limit before creating a user", async () => {
+    await onBeforeCreate(makeCreateBy());
+
+    expect(assertSeatMock()).toHaveBeenCalledTimes(1);
+  });
+
+  it("refuses the create when there is no seat for the new user", async () => {
+    assertSeatMock().mockRejectedValue(new BadDataException("No seats left"));
+
+    await expect(onBeforeCreate(makeCreateBy())).rejects.toBeInstanceOf(
+      BadDataException,
+    );
+  });
+
+  /*
+   * The one that matters. TeamMemberService creates the invited user as root,
+   * so an isRoot exemption would exempt invitations — and inviting users past
+   * the licence is the thing being prevented.
+   */
+  it.each([
+    ["a root write, which is how invitations create users", { isRoot: true }],
+    ["a master admin acting from the Admin Dashboard", { isMasterAdmin: true }],
+    ["an ordinary tenant write", { userId: ObjectID.generate() }],
+  ])(
+    "still checks the limit for %s",
+    async (_label: string, props: Record<string, unknown>) => {
+      await onBeforeCreate(makeCreateBy(props));
+
+      expect(assertSeatMock()).toHaveBeenCalledTimes(1);
+    },
+  );
+
+  it("checks the limit before anything else the hook does", async () => {
+    /*
+     * The hook also sanitizes attribution columns. If a refusal came after
+     * that, a rejected create would still have done work; more importantly the
+     * ordering pins that nothing was inserted ahead of the check later on.
+     */
+    assertSeatMock().mockRejectedValue(new BadDataException("No seats left"));
+
+    const createBy: CreateBy<User> = makeCreateBy();
+    (createBy.data as unknown as Record<string, unknown>)["clickIds"] = {
+      gclid: "abc",
+    };
+
+    await expect(onBeforeCreate(createBy)).rejects.toBeInstanceOf(
+      BadDataException,
+    );
+  });
+
+  describe("the user count it enforces against", () => {
+    type GetLocalUserCountFunction = () => Promise<number>;
+
+    type CapturedCallbackFunction = () => GetLocalUserCountFunction;
+
+    const capturedCallback: CapturedCallbackFunction =
+      (): GetLocalUserCountFunction => {
+        const call: Record<string, unknown> = assertSeatMock().mock
+          .calls[0]![0] as Record<string, unknown>;
+
+        return call["getLocalUserCount"] as GetLocalUserCountFunction;
+      };
+
+    it("counts every user on this installation, not just the caller's project", async () => {
+      await onBeforeCreate(makeCreateBy());
+
+      const count: number = await capturedCallback()();
+
+      expect(count).toBe(7);
+
+      const countCall: Record<string, unknown> = (
+        UserService.countBy as unknown as jest.Mock
+      ).mock.calls[0]![0] as Record<string, unknown>;
+
+      expect(countCall["query"]).toEqual({});
+      expect((countCall["props"] as Record<string, unknown>)["isRoot"]).toBe(
+        true,
+      );
+    });
+
+    /*
+     * The count is deliberately behind a callback rather than passed in: on
+     * Community Edition, and on a licence with no seat limit, it must never
+     * run at all. This is the create path of every user on the installation.
+     */
+    it("does not count users unless the seat check asks for it", async () => {
+      await onBeforeCreate(makeCreateBy());
+
+      expect(UserService.countBy).not.toHaveBeenCalled();
+    });
+  });
+});