@oneuptime/common 13.0.5 → 13.0.6

package/Tests/Server/Utils/Slo/SloRecordReferenceValidator.test.ts

@@ -0,0 +1,311 @@
+import SloRecordReferenceValidator from "../../../../Server/Utils/Slo/SloRecordReferenceValidator";
+import DatabaseService from "../../../../Server/Services/DatabaseService";
+import QueryHelper from "../../../../Server/Types/Database/QueryHelper";
+import ServiceLevelObjective from "../../../../Models/DatabaseModels/ServiceLevelObjective";
+import BadDataException from "../../../../Types/Exception/BadDataException";
+import { JSONObject } from "../../../../Types/JSON";
+import ObjectID from "../../../../Types/ObjectID";
+import fs from "fs";
+import path from "path";
+import { afterEach, beforeEach, describe, expect, test } from "@jest/globals";
+
+/*
+ * Incident.serviceLevelObjectives and Alert.serviceLevelObjectives are
+ * writable by API callers. Nothing in the framework checks that a relation id
+ * belongs to the row's project. An IncidentMember holding another project's
+ * SLO id could therefore link it, and the created feed item, the lists, the AI
+ * context and the metrics would all show that SLO's name inside the caller's
+ * project.
+ *
+ * This validator is what the Incident and Alert write hooks call. The part
+ * that matters most is that its read is pinned to the record's project. The
+ * fake SLO table below answers an unpinned read with the foreign SLO too, so a
+ * validator that dropped the pin would accept it and the rejection tests would
+ * fail. The error must not name the foreign SLO either: that would leak the
+ * same name through the error message.
+ */
+
+const PROJECT_ID: ObjectID = new ObjectID(
+  "0193c0de-dddd-4aaa-8bbb-000000000001",
+);
+const OTHER_PROJECT_ID: ObjectID = new ObjectID(
+  "0193c0de-dddd-4aaa-8bbb-000000000002",
+);
+const SLO_ID: string = "0193c0de-dddd-4aaa-8bbb-0000000000a1";
+const SECOND_SLO_ID: string = "0193c0de-dddd-4aaa-8bbb-0000000000a2";
+const FOREIGN_SLO_ID: string = "0193c0de-dddd-4aaa-8bbb-0000000000b1";
+const FOREIGN_SLO_NAME: string = "Payments SLO of another project";
+const MISSING_SLO_ID: string = "0193c0de-dddd-4aaa-8bbb-0000000000c1";
+
+interface StoredSlo {
+  id: string;
+  projectId: ObjectID;
+  name: string;
+}
+
+const SLO_TABLE: Array<StoredSlo> = [
+  { id: SLO_ID, projectId: PROJECT_ID, name: "Checkout availability" },
+  { id: SECOND_SLO_ID, projectId: PROJECT_ID, name: "Search latency" },
+  { id: FOREIGN_SLO_ID, projectId: OTHER_PROJECT_ID, name: FOREIGN_SLO_NAME },
+];
+
+interface LookupArgs {
+  query: JSONObject;
+  select: JSONObject;
+  limit: number;
+  skip: number;
+  props: JSONObject;
+}
+
+let anySpy: jest.SpyInstance;
+let lookup: jest.SpyInstance;
+
+// The ids the validator handed to QueryHelper.any for its latest read.
+function lastRequestedIds(): Array<string> {
+  const calls: Array<Array<unknown>> = anySpy.mock.calls as Array<
+    Array<unknown>
+  >;
+
+  return ((calls[calls.length - 1]?.[0] as Array<unknown>) || []).map(
+    (id: unknown): string => {
+      return String(id).toLowerCase();
+    },
+  );
+}
+
+function validate(serviceLevelObjectives: unknown): Promise<void> {
+  return SloRecordReferenceValidator.validateServiceLevelObjectivesBelongToProject(
+    {
+      projectId: PROJECT_ID,
+      subject: "incident",
+      serviceLevelObjectives: serviceLevelObjectives,
+    },
+  );
+}
+
+async function rejectionOf(promise: Promise<void>): Promise<Error> {
+  try {
+    await promise;
+  } catch (error) {
+    return error as Error;
+  }
+
+  throw new Error("Expected the validation to reject, but it resolved.");
+}
+
+beforeEach(() => {
+  // Calls through: only records the ids each read asked for.
+  anySpy = jest.spyOn(QueryHelper, "any");
+
+  lookup = jest
+    .spyOn(SloRecordReferenceValidator.getLookupService(), "findBy")
+    .mockImplementation((async (
+      args: LookupArgs,
+    ): Promise<Array<ServiceLevelObjective>> => {
+      const requestedIds: Array<string> = lastRequestedIds();
+      const pinnedProjectId: string | undefined = (
+        args.query["projectId"] as unknown as ObjectID | undefined
+      )?.toString();
+
+      return SLO_TABLE.filter((row: StoredSlo): boolean => {
+        return (
+          requestedIds.includes(row.id) &&
+          (!pinnedProjectId || row.projectId.toString() === pinnedProjectId)
+        );
+      }).map((row: StoredSlo): ServiceLevelObjective => {
+        const slo: ServiceLevelObjective = new ServiceLevelObjective();
+        slo._id = row.id;
+        slo.name = row.name;
+        slo.projectId = row.projectId;
+        return slo;
+      });
+    }) as never);
+});
+
+afterEach(() => {
+  jest.restoreAllMocks();
+});
+
+describe("SloRecordReferenceValidator.validateServiceLevelObjectivesBelongToProject", () => {
+  test("accepts SLOs of the record's own project, read as root, ids only, pinned to the project", async () => {
+    await expect(
+      validate([{ _id: SLO_ID }, { _id: SECOND_SLO_ID }]),
+    ).resolves.toBeUndefined();
+
+    expect(lookup).toHaveBeenCalledTimes(1);
+
+    const args: LookupArgs = lookup.mock.calls[0]![0] as LookupArgs;
+
+    expect((args.query["projectId"] as unknown as ObjectID).toString()).toBe(
+      PROJECT_ID.toString(),
+    );
+    expect(args.select).toEqual({ _id: true });
+    expect(args.props).toEqual({ isRoot: true });
+    expect(args.limit).toBe(2);
+    expect(lastRequestedIds()).toEqual([SLO_ID, SECOND_SLO_ID]);
+  });
+
+  test("rejects another project's SLO", async () => {
+    const error: Error = await rejectionOf(validate([{ _id: FOREIGN_SLO_ID }]));
+
+    expect(error).toBeInstanceOf(BadDataException);
+    expect(error.message).toBe(
+      `This incident references Service Level Objectives that do not exist in this project: "${FOREIGN_SLO_ID}". Please pick SLOs from this project and try again.`,
+    );
+  });
+
+  test("the rejection never names the foreign SLO", async () => {
+    const error: Error = await rejectionOf(validate([{ _id: FOREIGN_SLO_ID }]));
+
+    expect(error.message).not.toContain(FOREIGN_SLO_NAME);
+  });
+
+  test("a foreign id and an id that matches nothing get the same answer", async () => {
+    const foreign: Error = await rejectionOf(validate([FOREIGN_SLO_ID]));
+    const missing: Error = await rejectionOf(validate([MISSING_SLO_ID]));
+
+    expect(foreign.message.replace(FOREIGN_SLO_ID, "<id>")).toBe(
+      missing.message.replace(MISSING_SLO_ID, "<id>"),
+    );
+  });
+
+  test("names only the ids that are not in the project", async () => {
+    const error: Error = await rejectionOf(
+      validate([SLO_ID, FOREIGN_SLO_ID, MISSING_SLO_ID]),
+    );
+
+    expect(error.message).toContain(`"${FOREIGN_SLO_ID}", "${MISSING_SLO_ID}"`);
+    expect(error.message).not.toContain(SLO_ID);
+  });
+
+  test("every read is pinned to the record's project, whatever the outcome", async () => {
+    await validate([SLO_ID]);
+    await rejectionOf(validate([FOREIGN_SLO_ID]));
+
+    expect(lookup).toHaveBeenCalledTimes(2);
+
+    for (const call of lookup.mock.calls) {
+      const args: LookupArgs = call[0] as LookupArgs;
+
+      expect(
+        (
+          args.query["projectId"] as unknown as ObjectID | undefined
+        )?.toString(),
+      ).toBe(PROJECT_ID.toString());
+    }
+  });
+
+  test.each([
+    ["a bare uuid string (the update shape)", SLO_ID],
+    ["an upper-case uuid string", SLO_ID.toUpperCase()],
+    ["an ObjectID", new ObjectID(SLO_ID)],
+    ["an {_id} object (the API create shape)", { _id: SLO_ID }],
+    ["an {id: ObjectID} object", { id: new ObjectID(SLO_ID) }],
+  ])("accepts %s", async (_label: string, entry: unknown) => {
+    await expect(validate([entry])).resolves.toBeUndefined();
+
+    expect(lastRequestedIds()).toEqual([SLO_ID]);
+  });
+
+  test("accepts the burn-rate worker's id-stub model instance", async () => {
+    const stub: ServiceLevelObjective = new ServiceLevelObjective();
+    stub._id = SLO_ID;
+
+    await expect(validate([stub])).resolves.toBeUndefined();
+
+    expect(lastRequestedIds()).toEqual([SLO_ID]);
+  });
+
+  test("the same SLO twice is looked up once", async () => {
+    await validate([SLO_ID, { _id: SLO_ID.toUpperCase() }]);
+
+    expect(lastRequestedIds()).toEqual([SLO_ID]);
+    expect((lookup.mock.calls[0]![0] as LookupArgs).limit).toBe(1);
+  });
+
+  test("a malformed id is rejected without a query", async () => {
+    const error: Error = await rejectionOf(validate(["not-a-uuid"]));
+
+    expect(error).toBeInstanceOf(BadDataException);
+    expect(error.message).toContain('"not-a-uuid"');
+    expect(lookup).not.toHaveBeenCalled();
+  });
+
+  test.each([
+    ["undefined", undefined],
+    ["null", null],
+    ["an empty list", []],
+    ["entries without ids", [{ name: "Unsaved" }, null, ""]],
+  ])(
+    "%s links nothing, so nothing is read",
+    async (_label: string, value: unknown) => {
+      await expect(validate(value)).resolves.toBeUndefined();
+
+      expect(lookup).not.toHaveBeenCalled();
+    },
+  );
+
+  test("with no project to compare against the check is a no-op, as in ProjectScopedReferenceValidator", async () => {
+    await expect(
+      SloRecordReferenceValidator.validateServiceLevelObjectivesBelongToProject(
+        {
+          projectId: undefined,
+          subject: "alert",
+          serviceLevelObjectives: [FOREIGN_SLO_ID],
+        },
+      ),
+    ).resolves.toBeUndefined();
+
+    expect(lookup).not.toHaveBeenCalled();
+  });
+
+  test("the subject names the record in the message", async () => {
+    const error: Error = await rejectionOf(
+      SloRecordReferenceValidator.validateServiceLevelObjectivesBelongToProject(
+        {
+          projectId: PROJECT_ID,
+          subject: "alert",
+          serviceLevelObjectives: [FOREIGN_SLO_ID],
+        },
+      ),
+    );
+
+    expect(error.message.startsWith("This alert references")).toBe(true);
+  });
+});
+
+/*
+ * IncidentService and AlertService call this validator, and they cannot reach
+ * ServiceLevelObjectiveService: it imports the burn-rate rule service, which
+ * imports them. So the lookup must be a plain DatabaseService over the model.
+ * A hooked subclass would run SLO hooks, and importing an SLO service would
+ * bring the cycle back.
+ */
+describe("the SLO lookup does not reach the SLO services", () => {
+  test("is a plain DatabaseService over the ServiceLevelObjective model, created once", () => {
+    const service: DatabaseService<ServiceLevelObjective> =
+      SloRecordReferenceValidator.getLookupService();
+
+    expect(Object.getPrototypeOf(service)).toBe(DatabaseService.prototype);
+    expect(service.getModel()).toBeInstanceOf(ServiceLevelObjective);
+    expect(SloRecordReferenceValidator.getLookupService()).toBe(service);
+  });
+
+  test("the validator module imports DatabaseService and no other service", () => {
+    const source: string = fs.readFileSync(
+      path.join(
+        __dirname,
+        "../../../../Server/Utils/Slo/SloRecordReferenceValidator.ts",
+      ),
+      "utf8",
+    );
+
+    const serviceImports: Array<string> = (
+      source.match(/from "[^"]*\/Services\/[^"]*"/g) || []
+    ).map((specifier: string): string => {
+      return specifier.slice('from "'.length, -1);
+    });
+
+    expect(serviceImports).toEqual(["../../Services/DatabaseService"]);
+  });
+});

package/Tests/Server/Utils/StatusPageResource.test.ts

@@ -45,9 +45,9 @@ describe("StatusPageResourceUtil", () => {
        * Groups should be formatted as "GroupName: Resource1, Resource2"
        * Multiple groups separated by <br/> for HTML rendering
        */
-      expect(result).toContain("EU: Infrastructure, Website");
-      expect(result).toContain("UK: Infrastructure, API");
-      expect(result).toContain("<br/>");
+      expect(result).toBe(
+        "EU: Infrastructure, Website<br/>UK: Infrastructure, API",
+      );
     });
 
     it("should handle mixed grouped and ungrouped resources", () => {
@@ -121,6 +121,94 @@ describe("StatusPageResourceUtil", () => {
         StatusPageResourceUtil.getResourcesGroupedByGroupName(resources);
       expect(result).toBe("EU: Infrastructure, Website, API");
     });
+
+    it("should put each group on its own HTML line", () => {
+      const resources: Array<StatusPageResource> = [
+        createResourceWithGroup("Infrastructure", "EU"),
+        createResourceWithGroup("API", "UK"),
+        createResource("Global API"),
+      ];
+
+      const result: string =
+        StatusPageResourceUtil.getResourcesGroupedByGroupName(resources);
+      expect(result).toBe("EU: Infrastructure<br/>UK: API<br/>Global API");
+    });
+  });
+
+  describe("getResourcesGroupedByGroupNameAsPlainText", () => {
+    it("should separate groups with semicolons instead of <br/>", () => {
+      const resources: Array<StatusPageResource> = [
+        createResourceWithGroup("Infrastructure", "EU"),
+        createResourceWithGroup("Website", "EU"),
+        createResourceWithGroup("Infrastructure", "UK"),
+        createResourceWithGroup("API", "UK"),
+      ];
+
+      const result: string =
+        StatusPageResourceUtil.getResourcesGroupedByGroupNameAsPlainText(
+          resources,
+        );
+      expect(result).toBe(
+        "EU: Infrastructure, Website; UK: Infrastructure, API",
+      );
+      expect(result).not.toContain("<");
+    });
+
+    it("should keep ungrouped resources on the same line as the groups", () => {
+      const resources: Array<StatusPageResource> = [
+        createResourceWithGroup("Infrastructure", "EU"),
+        createResource("Global API"),
+        createResourceWithGroup("Website", "UK"),
+      ];
+
+      const result: string =
+        StatusPageResourceUtil.getResourcesGroupedByGroupNameAsPlainText(
+          resources,
+        );
+      expect(result).toBe("EU: Infrastructure; UK: Website; Global API");
+    });
+
+    it("should return the same comma-separated list as the HTML form when nothing is grouped", () => {
+      const resources: Array<StatusPageResource> = [
+        createResource("API"),
+        createResourceWithoutDisplayName(),
+        createResource("Website"),
+      ];
+
+      expect(
+        StatusPageResourceUtil.getResourcesGroupedByGroupNameAsPlainText(
+          resources,
+        ),
+      ).toBe("API, Website");
+      expect(
+        StatusPageResourceUtil.getResourcesGroupedByGroupName(resources),
+      ).toBe("API, Website");
+    });
+
+    it("should return a single group unchanged", () => {
+      const resources: Array<StatusPageResource> = [
+        createResourceWithGroup("Infrastructure", "EU"),
+        createResourceWithGroup("Website", "EU"),
+      ];
+
+      expect(
+        StatusPageResourceUtil.getResourcesGroupedByGroupNameAsPlainText(
+          resources,
+        ),
+      ).toBe("EU: Infrastructure, Website");
+    });
+
+    it("should return the default value when there are no resources", () => {
+      expect(
+        StatusPageResourceUtil.getResourcesGroupedByGroupNameAsPlainText([]),
+      ).toBe("");
+      expect(
+        StatusPageResourceUtil.getResourcesGroupedByGroupNameAsPlainText(
+          null as unknown as Array<StatusPageResource>,
+          "None",
+        ),
+      ).toBe("None");
+    });
   });
 });
 

package/Tests/Types/Billing/SubscriptionStatus.test.ts

@@ -2,7 +2,183 @@ import SubscriptionStatus, {
   SubscriptionStatusUtil,
 } from "../../../Types/Billing/SubscriptionStatus";
 
+/*
+ * Every status Stripe can report, and whether a project in it is still served
+ * (monitored, probed, polled, evaluated). Spelled out by hand - NOT derived
+ * from getActiveSubscriptionStatuses - so a change to the shared list has to
+ * be made here too, on purpose. past_due is active: the product decision is
+ * that monitoring continues while Stripe is still retrying the invoice.
+ */
+const EXPECTED_ACTIVE_BY_STATUS: Record<SubscriptionStatus, boolean> = {
+  [SubscriptionStatus.Active]: true,
+  [SubscriptionStatus.Trialing]: true,
+  [SubscriptionStatus.PastDue]: true,
+  [SubscriptionStatus.Incomplete]: false,
+  [SubscriptionStatus.IncompleteExpired]: false,
+  [SubscriptionStatus.Canceled]: false,
+  [SubscriptionStatus.Unpaid]: false,
+  [SubscriptionStatus.Expired]: false,
+  [SubscriptionStatus.Paused]: false,
+};
+
 describe("SubscriptionStatusUtil", () => {
+  describe("getActiveSubscriptionStatuses", () => {
+    test("is exactly active, trialing and past_due", () => {
+      expect(
+        [...SubscriptionStatusUtil.getActiveSubscriptionStatuses()].sort(),
+      ).toEqual(["active", "past_due", "trialing"]);
+    });
+
+    /*
+     * The production incident: a project whose autopay attempt failed (its
+     * old India e-mandate card declined after sitting in "processing" for a
+     * day) went past_due, and every monitoring query dropped it.
+     */
+    test("includes past_due so an overdue project keeps being monitored", () => {
+      expect(SubscriptionStatusUtil.getActiveSubscriptionStatuses()).toContain(
+        SubscriptionStatus.PastDue,
+      );
+    });
+
+    test.each([
+      SubscriptionStatus.Unpaid,
+      SubscriptionStatus.Canceled,
+      SubscriptionStatus.Incomplete,
+      SubscriptionStatus.IncompleteExpired,
+      SubscriptionStatus.Expired,
+      SubscriptionStatus.Paused,
+    ])("does not include %s", (status: SubscriptionStatus) => {
+      expect(
+        SubscriptionStatusUtil.getActiveSubscriptionStatuses(),
+      ).not.toContain(status);
+    });
+
+    test("has no duplicates", () => {
+      const statuses: Array<SubscriptionStatus> =
+        SubscriptionStatusUtil.getActiveSubscriptionStatuses();
+
+      expect(new Set(statuses).size).toBe(statuses.length);
+    });
+
+    test("only contains real enum values (each is a SQL-safe constant)", () => {
+      const enumValues: Array<string> = Object.values(SubscriptionStatus);
+
+      for (const status of SubscriptionStatusUtil.getActiveSubscriptionStatuses()) {
+        expect(enumValues).toContain(status);
+        // Bound into raw SQL by the claim queries - keep it boring.
+        expect(status).toMatch(/^[a-z_]+$/);
+      }
+    });
+
+    test("never contains undefined or null (NULL is handled by each query)", () => {
+      for (const status of SubscriptionStatusUtil.getActiveSubscriptionStatuses()) {
+        expect(status).toBeTruthy();
+      }
+    });
+
+    /*
+     * Handed straight to QueryHelper and to raw SQL parameters by several
+     * callers. A shared array that one caller pushes onto would quietly
+     * widen "active" for every other caller in the process.
+     */
+    test("returns a fresh array so a caller cannot mutate the definition", () => {
+      const first: Array<SubscriptionStatus> =
+        SubscriptionStatusUtil.getActiveSubscriptionStatuses();
+      first.push(SubscriptionStatus.Canceled);
+      first.splice(0, 1);
+
+      const second: Array<SubscriptionStatus> =
+        SubscriptionStatusUtil.getActiveSubscriptionStatuses();
+
+      expect(second).not.toBe(first);
+      expect([...second].sort()).toEqual(["active", "past_due", "trialing"]);
+      expect(
+        SubscriptionStatusUtil.isSubscriptionActive(
+          SubscriptionStatus.Canceled,
+        ),
+      ).toBe(false);
+      expect(
+        SubscriptionStatusUtil.isSubscriptionActive(SubscriptionStatus.Active),
+      ).toBe(true);
+    });
+  });
+
+  describe("isSubscriptionActive agrees with getActiveSubscriptionStatuses", () => {
+    test("covers every status in the enum (update the table when Stripe adds one)", () => {
+      expect(Object.keys(EXPECTED_ACTIVE_BY_STATUS).sort()).toEqual(
+        [...Object.values(SubscriptionStatus)].sort(),
+      );
+    });
+
+    test.each(Object.values(SubscriptionStatus))(
+      "%s: isSubscriptionActive matches membership in the shared list and the expected table",
+      (status: SubscriptionStatus) => {
+        const inList: boolean =
+          SubscriptionStatusUtil.getActiveSubscriptionStatuses().includes(
+            status,
+          );
+
+        expect(SubscriptionStatusUtil.isSubscriptionActive(status)).toBe(
+          inList,
+        );
+        expect(inList).toBe(EXPECTED_ACTIVE_BY_STATUS[status]);
+        expect(SubscriptionStatusUtil.isSubscriptionInactive(status)).toBe(
+          !EXPECTED_ACTIVE_BY_STATUS[status],
+        );
+      },
+    );
+
+    test.each([undefined, null, ""])(
+      "a missing status (%p) is active even though it is not in the list",
+      (status: undefined | null | string) => {
+        expect(
+          SubscriptionStatusUtil.isSubscriptionActive(
+            status as unknown as SubscriptionStatus | undefined,
+          ),
+        ).toBe(true);
+      },
+    );
+
+    test("an unknown status string is not active", () => {
+      expect(
+        SubscriptionStatusUtil.isSubscriptionActive(
+          "something_new" as SubscriptionStatus,
+        ),
+      ).toBe(false);
+    });
+  });
+
+  /*
+   * Billing enforcement is deliberately NOT the same question as "keep
+   * monitoring". Making past_due monitorable must not make it cancelled, and
+   * must not stop it being flagged as overdue (the banner and the daily
+   * overdue emails key off that).
+   */
+  describe("billing enforcement is unchanged by the monitoring decision", () => {
+    test("past_due is still overdue and still not cancelled", () => {
+      expect(
+        SubscriptionStatusUtil.isSubscriptionOverdue(
+          SubscriptionStatus.PastDue,
+        ),
+      ).toBe(true);
+      expect(
+        SubscriptionStatusUtil.isSubscriptionCancelled(
+          SubscriptionStatus.PastDue,
+        ),
+      ).toBe(false);
+    });
+
+    test("every cancelled status is outside the active list", () => {
+      for (const status of Object.values(SubscriptionStatus)) {
+        if (SubscriptionStatusUtil.isSubscriptionCancelled(status)) {
+          expect(
+            SubscriptionStatusUtil.getActiveSubscriptionStatuses(),
+          ).not.toContain(status);
+        }
+      }
+    });
+  });
+
   describe("isSubscriptionActive", () => {
     test("treats a missing status as active", () => {
       expect(SubscriptionStatusUtil.isSubscriptionActive(undefined)).toBe(true);