@oneuptime/common 11.3.26 → 11.3.28

package/Tests/Types/OnCallDutyPolicy/LayerUtilInvariants.test.ts

@@ -0,0 +1,232 @@
+/**
+ * EMPIRICAL invariant fuzzing (audit lens).
+ *
+ * For unrestricted rotations over long horizons:
+ *   (A) CONTIGUITY: sorted events cover [start, end] with no gap > 2s and no
+ *       overlap (events are stitched with a +1s seam, so a 1s gap is expected).
+ *   (B) FAIRNESS: over many periods each user's shift count is within 1.
+ *   (C) ORDER: users cycle A,B,C,A,B,C... with no skip/repeat, including across
+ *       DST transitions.
+ */
+import LayerUtil, { LayerProps } from "../../../Types/OnCallDutyPolicy/Layer";
+import CalendarEvent from "../../../Types/Calendar/CalendarEvent";
+import RestrictionTimes, {
+  RestrictionType,
+} from "../../../Types/OnCallDutyPolicy/RestrictionTimes";
+import Recurring from "../../../Types/Events/Recurring";
+import OneUptimeDate from "../../../Types/Date";
+import User from "../../../Models/DatabaseModels/User";
+import EventInterval from "../../../Types/Events/EventInterval";
+import PositiveNumber from "../../../Types/PositiveNumber";
+
+function user(id: string): User {
+  return {
+    id: {
+      toString: (): string => {
+        return id;
+      },
+    } as any,
+  } as User;
+}
+
+function noRestriction(): RestrictionTimes {
+  const r: RestrictionTimes = new RestrictionTimes();
+  r.restictionType = RestrictionType.None;
+  r.dayRestrictionTimes = null;
+  return r;
+}
+
+interface Config {
+  name: string;
+  intervalType: EventInterval;
+  intervalCount: number;
+  userIds: string[];
+  timezone?: string | undefined;
+  start: Date;
+}
+
+function layerOf(c: Config): LayerProps {
+  const rot: Recurring = new Recurring();
+  rot.intervalType = c.intervalType;
+  rot.intervalCount = new PositiveNumber(c.intervalCount);
+  const handoff: Date = Recurring.getNextDateInterval(c.start, rot);
+  return {
+    users: c.userIds.map(user),
+    startDateTimeOfLayer: c.start,
+    restrictionTimes: noRestriction(),
+    handOffTime: handoff,
+    rotation: rot,
+    timezone: c.timezone,
+  };
+}
+
+function fullExpand(layer: LayerProps, to: Date): Array<CalendarEvent> {
+  const util: LayerUtil = new LayerUtil();
+  const events: Array<CalendarEvent> = util.getEvents({
+    ...layer,
+    calendarStartDate: layer.startDateTimeOfLayer,
+    calendarEndDate: to,
+  });
+  events.sort((a: CalendarEvent, b: CalendarEvent) => {
+    return a.start.getTime() - b.start.getTime();
+  });
+  return events;
+}
+
+const START: Date = OneUptimeDate.fromString("2025-01-06T00:00:00.000Z"); // Monday
+
+describe("INVARIANT: 24/7 coverage contiguity (no gap > 2s, no overlap)", () => {
+  const configs: Config[] = [];
+  const intervals: EventInterval[] = [
+    EventInterval.Hour,
+    EventInterval.Day,
+    EventInterval.Week,
+  ];
+  const counts: number[] = [1, 2, 3];
+  const userSets: string[][] = [
+    ["A", "B"],
+    ["A", "B", "C"],
+  ];
+  const timezones: (string | undefined)[] = [
+    undefined,
+    "America/New_York",
+    "Asia/Kolkata",
+  ];
+  for (const it of intervals) {
+    for (const count of counts) {
+      for (const users of userSets) {
+        for (const tz of timezones) {
+          configs.push({
+            name: `${count}x${it} users=${users.length} tz=${tz ?? "local"}`,
+            intervalType: it,
+            intervalCount: count,
+            userIds: users,
+            timezone: tz,
+            start: START,
+          });
+        }
+      }
+    }
+  }
+
+  const horizonMs: Record<string, number> = {
+    [EventInterval.Hour]: 60 * 3600000, // 60 hours
+    [EventInterval.Day]: 60 * 86400000, // 60 days (crosses spring DST)
+    [EventInterval.Week]: 40 * 604800000, // 40 weeks (crosses DST both ways)
+  };
+
+  for (const c of configs) {
+    it(`${c.name}`, () => {
+      const layer: LayerProps = layerOf(c);
+      const to: Date = new Date(
+        START.getTime() + (horizonMs[c.intervalType] || 60 * 86400000),
+      );
+      const events: Array<CalendarEvent> = fullExpand(layer, to);
+
+      const problems: string[] = [];
+      for (let i: number = 1; i < events.length; i++) {
+        const prev: CalendarEvent = events[i - 1]!;
+        const cur: CalendarEvent = events[i]!;
+        const gapMs: number = cur.start.getTime() - prev.end.getTime();
+        // Expected seam is +1s. Flag gaps > 2s (coverage hole) or overlaps (<0).
+        if (gapMs > 2000) {
+          problems.push(
+            `GAP ${gapMs}ms between ${prev.title}@${prev.end.toISOString()} and ${cur.title}@${cur.start.toISOString()}`,
+          );
+        }
+        if (gapMs < 0) {
+          problems.push(
+            `OVERLAP ${gapMs}ms between ${prev.title}@${prev.end.toISOString()} and ${cur.title}@${cur.start.toISOString()}`,
+          );
+        }
+      }
+
+      expect({ config: c.name, problems }).toEqual({
+        config: c.name,
+        problems: [],
+      });
+    });
+  }
+});
+
+describe("INVARIANT: rotation order + fairness over many periods", () => {
+  const configs: Config[] = [];
+  const intervals: EventInterval[] = [
+    EventInterval.Hour,
+    EventInterval.Day,
+    EventInterval.Week,
+  ];
+  const counts: number[] = [1, 2, 3];
+  const userSets: string[][] = [
+    ["A", "B", "C"],
+    ["A", "B", "C", "D", "E"],
+  ];
+  const timezones: (string | undefined)[] = [undefined, "America/New_York"];
+  for (const it of intervals) {
+    for (const count of counts) {
+      for (const users of userSets) {
+        for (const tz of timezones) {
+          configs.push({
+            name: `${count}x${it} users=${users.length} tz=${tz ?? "local"}`,
+            intervalType: it,
+            intervalCount: count,
+            userIds: users,
+            timezone: tz,
+            start: START,
+          });
+        }
+      }
+    }
+  }
+
+  const horizonMs: Record<string, number> = {
+    [EventInterval.Hour]: 120 * 3600000,
+    [EventInterval.Day]: 120 * 86400000,
+    [EventInterval.Week]: 60 * 604800000,
+  };
+
+  for (const c of configs) {
+    it(`${c.name}`, () => {
+      const layer: LayerProps = layerOf(c);
+      const to: Date = new Date(
+        START.getTime() + (horizonMs[c.intervalType] || 120 * 86400000),
+      );
+      const events: Array<CalendarEvent> = fullExpand(layer, to);
+
+      // ORDER: consecutive events cycle in userIds order.
+      const orderProblems: string[] = [];
+      const n: number = c.userIds.length;
+      for (let i: number = 0; i < events.length; i++) {
+        const expected: string = c.userIds[i % n]!;
+        if (events[i]!.title !== expected) {
+          orderProblems.push(
+            `event#${i} start=${events[i]!.start.toISOString()} expected=${expected} actual=${events[i]!.title}`,
+          );
+          break; // first divergence is enough
+        }
+      }
+
+      // FAIRNESS: drop the final (possibly clipped) event, count shifts.
+      const counts: Record<string, number> = {};
+      const usable: Array<CalendarEvent> = events.slice(0, -1);
+      for (const e of usable) {
+        counts[e.title] = (counts[e.title] || 0) + 1;
+      }
+      const values: number[] = c.userIds.map((u: string) => {
+        return counts[u] || 0;
+      });
+      const max: number = Math.max(...values);
+      const min: number = Math.min(...values);
+
+      expect({
+        config: c.name,
+        orderProblems,
+        fairnessSpread: max - min,
+      }).toEqual({
+        config: c.name,
+        orderProblems: [],
+        fairnessSpread: max - min <= 1 ? max - min : "TOO_WIDE:" + (max - min),
+      });
+    });
+  }
+});

package/Tests/Types/OnCallDutyPolicy/LayerUtilMergeAudit.test.ts

@@ -0,0 +1,227 @@
+import LayerUtil, { LayerProps } from "../../../Types/OnCallDutyPolicy/Layer";
+import RestrictionTimes, {
+  RestrictionType,
+} from "../../../Types/OnCallDutyPolicy/RestrictionTimes";
+import Recurring from "../../../Types/Events/Recurring";
+import EventInterval from "../../../Types/Events/EventInterval";
+import PositiveNumber from "../../../Types/PositiveNumber";
+import OneUptimeDate from "../../../Types/Date";
+import User from "../../../Models/DatabaseModels/User";
+import CalendarEvent from "../../../Types/Calendar/CalendarEvent";
+import { describe, expect, test } from "@jest/globals";
+
+/*
+ * Audit H2: removeOverlappingEvents ran a full Array.sort() INSIDE its per-event
+ * loop (O(n^2 log n)); getEvents rebuilt its array with [...events, ...] each
+ * period (O(n^2)). The fix hoists the sort to a single post-loop sort and pushes
+ * per-period segments, and makes the lower-priority "trim current event" step a
+ * monotonic max so it is independent of finalEvents ordering (which is what made
+ * hoisting the sort safe). These tests lock in the merge INVARIANTS the
+ * optimization must preserve: no overlaps, sorted, positive length, and correct
+ * priority/fallback coverage with no gaps under a 24/7 fallback.
+ */
+
+function user(id: string): User {
+  return {
+    id: {
+      toString: (): string => {
+        return id;
+      },
+    } as any,
+  } as User;
+}
+
+function rotation(type: EventInterval, count: number): Recurring {
+  const r: Recurring = new Recurring();
+  r.intervalType = type;
+  r.intervalCount = new PositiveNumber(count);
+  return r;
+}
+
+function businessHoursRestriction(): RestrictionTimes {
+  const rt: RestrictionTimes = new RestrictionTimes();
+  rt.restictionType = RestrictionType.Daily;
+  rt.dayRestrictionTimes = {
+    startTime: new Date(Date.UTC(2025, 0, 1, 9, 0, 0)),
+    endTime: new Date(Date.UTC(2025, 0, 1, 17, 0, 0)),
+  };
+  return rt;
+}
+
+function assertSortedNonOverlappingPositive(
+  events: Array<CalendarEvent>,
+): void {
+  for (let i: number = 0; i < events.length; i++) {
+    // positive length
+    expect(new Date(events[i]!.end).getTime()).toBeGreaterThan(
+      new Date(events[i]!.start).getTime(),
+    );
+    if (i > 0) {
+      // sorted by start
+      expect(new Date(events[i]!.start).getTime()).toBeGreaterThanOrEqual(
+        new Date(events[i - 1]!.start).getTime(),
+      );
+      // non-overlapping (previous end is at/before this start)
+      expect(new Date(events[i - 1]!.end).getTime()).toBeLessThanOrEqual(
+        new Date(events[i]!.start).getTime(),
+      );
+    }
+  }
+}
+
+describe("LayerUtil audit H2: multi-layer merge invariants preserved", () => {
+  const windowStart: Date = new Date(Date.UTC(2025, 5, 2, 0, 0, 0));
+  const windowEnd: Date = new Date(Date.UTC(2025, 5, 6, 0, 0, 0));
+
+  test("high-priority business-hours layer over a 24/7 fallback: no overlaps, no gaps, both users present", () => {
+    const layers: Array<LayerProps> = [
+      {
+        // priority 1 (higher): business-hours coverage by X
+        users: [user("X")],
+        startDateTimeOfLayer: new Date(Date.UTC(2025, 5, 1, 0, 0, 0)),
+        handOffTime: new Date(Date.UTC(2025, 5, 1, 0, 0, 0)),
+        restrictionTimes: businessHoursRestriction(),
+        rotation: rotation(EventInterval.Day, 1),
+        timezone: "UTC",
+      },
+      {
+        // priority 2 (fallback): 24/7 coverage by Y
+        users: [user("Y")],
+        startDateTimeOfLayer: new Date(Date.UTC(2025, 5, 1, 0, 0, 0)),
+        handOffTime: new Date(Date.UTC(2025, 5, 1, 0, 0, 0)),
+        restrictionTimes: RestrictionTimes.getDefault(),
+        rotation: rotation(EventInterval.Week, 1),
+        timezone: "UTC",
+      },
+    ];
+
+    const events: Array<CalendarEvent> = new LayerUtil().getMultiLayerEvents({
+      layers,
+      calendarStartDate: windowStart,
+      calendarEndDate: windowEnd,
+    });
+
+    assertSortedNonOverlappingPositive(events);
+
+    const titles: Set<string> = new Set(
+      events.map((e: CalendarEvent) => {
+        return e.title;
+      }),
+    );
+    expect(titles.has("X")).toBe(true); // higher priority appears
+    expect(titles.has("Y")).toBe(true); // fallback fills the gaps
+
+    /*
+     * With a 24/7 fallback the merged coverage must be CONTIGUOUS across the
+     * window (no uncovered gap). Allow the ~1s boundary seam the engine leaves
+     * between adjacent events.
+     */
+    for (let i: number = 1; i < events.length; i++) {
+      const gapSeconds: number =
+        (new Date(events[i]!.start).getTime() -
+          new Date(events[i - 1]!.end).getTime()) /
+        1000;
+      expect(gapSeconds).toBeLessThanOrEqual(2);
+    }
+  });
+
+  test("two back-to-back higher-priority windows over a fallback preserve the fallback's trailing tail (max-trim path)", () => {
+    /*
+     * Higher-priority daily rotation with two users creates adjacent daily
+     * windows; the fallback must survive as gaps/tail with no overlap.
+     */
+    const layers: Array<LayerProps> = [
+      {
+        users: [user("P"), user("Q")],
+        startDateTimeOfLayer: new Date(Date.UTC(2025, 5, 1, 0, 0, 0)),
+        handOffTime: new Date(Date.UTC(2025, 5, 1, 0, 0, 0)),
+        restrictionTimes: businessHoursRestriction(),
+        rotation: rotation(EventInterval.Day, 1),
+        timezone: "UTC",
+      },
+      {
+        users: [user("F")],
+        startDateTimeOfLayer: new Date(Date.UTC(2025, 5, 1, 0, 0, 0)),
+        handOffTime: new Date(Date.UTC(2025, 5, 1, 0, 0, 0)),
+        restrictionTimes: RestrictionTimes.getDefault(),
+        rotation: rotation(EventInterval.Week, 1),
+        timezone: "UTC",
+      },
+    ];
+
+    const events: Array<CalendarEvent> = new LayerUtil().getMultiLayerEvents({
+      layers,
+      calendarStartDate: windowStart,
+      calendarEndDate: windowEnd,
+    });
+
+    assertSortedNonOverlappingPositive(events);
+
+    /*
+     * The fallback F must appear (it owns the nights/weekends the higher layer
+     * does not cover) — the trailing-tail reconstruction must not delete it.
+     */
+    const titles: Set<string> = new Set(
+      events.map((e: CalendarEvent) => {
+        return e.title;
+      }),
+    );
+    expect(titles.has("F")).toBe(true);
+  });
+
+  test("single unrestricted layer: getNumberOfEvents returns exactly the requested current+next", () => {
+    const layer: LayerProps = {
+      users: [user("A"), user("B")],
+      startDateTimeOfLayer: new Date(Date.UTC(2025, 5, 1, 0, 0, 0)),
+      handOffTime: new Date(Date.UTC(2025, 5, 1, 0, 0, 0)),
+      restrictionTimes: RestrictionTimes.getDefault(),
+      rotation: rotation(EventInterval.Day, 1),
+      timezone: "UTC",
+    };
+
+    const events: Array<CalendarEvent> = new LayerUtil().getMultiLayerEvents(
+      {
+        layers: [layer],
+        calendarStartDate: new Date(Date.UTC(2025, 5, 3, 12, 0, 0)),
+        calendarEndDate: new Date(Date.UTC(2025, 5, 10, 0, 0, 0)),
+      },
+      { getNumberOfEvents: 2 },
+    );
+
+    expect(events.length).toBe(2);
+    assertSortedNonOverlappingPositive(events);
+    // current and next are different users in a 2-user daily rotation.
+    expect(events[0]!.title).not.toBe(events[1]!.title);
+  });
+
+  test("hourly layer over a multi-day window resolves quickly (push not O(n^2) spread)", () => {
+    const layer: LayerProps = {
+      users: [user("A"), user("B")],
+      startDateTimeOfLayer: new Date(Date.UTC(2025, 5, 1, 0, 0, 0)),
+      handOffTime: new Date(Date.UTC(2025, 5, 1, 0, 0, 0)),
+      restrictionTimes: RestrictionTimes.getDefault(),
+      rotation: rotation(EventInterval.Hour, 1),
+      timezone: "UTC",
+    };
+
+    const start: number = OneUptimeDate.getCurrentDate().getTime();
+    const events: Array<CalendarEvent> = new LayerUtil().getMultiLayerEvents({
+      layers: [layer],
+      /*
+       * ~20 days of hourly events (~480) — the merge must stay well under any
+       * pathological quadratic blowup.
+       */
+      calendarStartDate: new Date(Date.UTC(2025, 5, 1, 0, 0, 0)),
+      calendarEndDate: new Date(Date.UTC(2025, 5, 21, 0, 0, 0)),
+    });
+    const elapsedMs: number = OneUptimeDate.getCurrentDate().getTime() - start;
+
+    expect(events.length).toBeGreaterThan(0);
+    assertSortedNonOverlappingPositive(events);
+    /*
+     * Generous ceiling — the pre-fix quadratic path took tens of seconds for far
+     * fewer events; this must complete in a small fraction of that.
+     */
+    expect(elapsedMs).toBeLessThan(15000);
+  });
+});