@oneuptime/common 11.7.3 → 12.0.0

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

@@ -0,0 +1,398 @@
+import LogDropFilterService from "../../../Server/Services/LogDropFilterService";
+import TraceDropFilterService from "../../../Server/Services/TraceDropFilterService";
+import LogDropFilter from "../../../Models/DatabaseModels/LogDropFilter";
+import TraceDropFilter from "../../../Models/DatabaseModels/TraceDropFilter";
+import LogDropFilterAction from "../../../Types/Log/LogDropFilterAction";
+import TraceDropFilterAction from "../../../Types/Trace/TraceDropFilterAction";
+import BadDataException from "../../../Types/Exception/BadDataException";
+import ObjectID from "../../../Types/ObjectID";
+import CreateBy from "../../../Server/Types/Database/CreateBy";
+import UpdateBy from "../../../Server/Types/Database/UpdateBy";
+import { afterEach, describe, expect, it, jest } from "@jest/globals";
+
+/*
+ * Contract under test — the create/update hooks on both drop-filter services.
+ *
+ * A drop filter is the only piece of project config that deletes customer
+ * data as its normal operation, and two of its fields could be saved in
+ * states the engine could not honour:
+ *
+ *   - a blank `filterQuery`, which compiled to "match every record" and so
+ *     turned the filter into "discard 100% of this project's telemetry",
+ *   - `action = "sample"` with no percentage, which the engine read as
+ *     "discard half".
+ *
+ * Update is the harder half: a request need not name every field, so
+ * flipping `action` to "sample" while the stored percentage is null, or
+ * blanking `filterQuery` on a row whose action is already "drop", both have
+ * to be caught by validating the MERGED row rather than the incoming patch.
+ */
+
+const FILTER_ID: ObjectID = new ObjectID(
+  "11111111-1111-4111-8111-111111111111",
+);
+const PROJECT_ID: ObjectID = new ObjectID(
+  "22222222-2222-4222-8222-222222222222",
+);
+
+interface StoredRow {
+  action: string;
+  samplePercentage: number | undefined;
+  filterQuery: string;
+}
+
+const VALID_QUERY: string = "severityText = 'Debug'";
+
+/*
+ * Each case runs against both services. They are separate classes over
+ * separate tables with their own action enums, and the whole point of sharing
+ * the validator is that neither can drift — so every assertion is made twice
+ * rather than trusting the log side to speak for the trace side.
+ */
+const SUITES: Array<{
+  name: string;
+  service: any;
+  makeModel: () => any;
+  sampleAction: string;
+  dropAction: string;
+  recordNoun: string;
+}> = [
+  {
+    name: "LogDropFilterService",
+    service: LogDropFilterService,
+    makeModel: (): LogDropFilter => {
+      return new LogDropFilter();
+    },
+    sampleAction: LogDropFilterAction.Sample,
+    dropAction: LogDropFilterAction.Drop,
+    recordNoun: "logs",
+  },
+  {
+    name: "TraceDropFilterService",
+    service: TraceDropFilterService,
+    makeModel: (): TraceDropFilter => {
+      return new TraceDropFilter();
+    },
+    sampleAction: TraceDropFilterAction.Sample,
+    dropAction: TraceDropFilterAction.Drop,
+    recordNoun: "spans",
+  },
+];
+
+describe.each(SUITES)(
+  "$name save-time validation",
+  ({ service, makeModel, sampleAction, dropAction, recordNoun }: any) => {
+    afterEach(() => {
+      jest.restoreAllMocks();
+    });
+
+    function createBy(data: {
+      action?: string | undefined;
+      samplePercentage?: number | undefined;
+      filterQuery?: string | undefined;
+    }): CreateBy<any> {
+      const model: any = makeModel();
+      model.name = "Noisy debug logs";
+      model.projectId = PROJECT_ID;
+      model.action = data.action;
+      model.filterQuery = data.filterQuery;
+
+      if (data.samplePercentage !== undefined) {
+        model.samplePercentage = data.samplePercentage;
+      }
+
+      return { data: model, props: { isRoot: true } } as CreateBy<any>;
+    }
+
+    function updateBy(patch: Record<string, unknown>): UpdateBy<any> {
+      return {
+        query: { _id: FILTER_ID.toString() },
+        data: patch,
+        props: { isRoot: true },
+      } as unknown as UpdateBy<any>;
+    }
+
+    /*
+     * The update hook reads the rows the update matches so it can merge the
+     * patch over them. This stands in for that read.
+     */
+    function mockStoredRow(row: StoredRow): jest.SpiedFunction<any> {
+      const model: any = makeModel();
+      model._id = FILTER_ID.toString();
+      model.action = row.action;
+      model.filterQuery = row.filterQuery;
+      if (row.samplePercentage !== undefined) {
+        model.samplePercentage = row.samplePercentage;
+      }
+
+      return jest
+        .spyOn(service, "findBy")
+        .mockImplementation(async (): Promise<Array<any>> => {
+          return [model];
+        }) as unknown as jest.SpiedFunction<any>;
+    }
+
+    describe("on create", () => {
+      it("accepts a drop filter with a real condition", async () => {
+        await expect(
+          service.onBeforeCreate(
+            createBy({ action: dropAction, filterQuery: VALID_QUERY }),
+          ),
+        ).resolves.toBeDefined();
+      });
+
+      it("accepts a sample filter with a percentage in range", async () => {
+        await expect(
+          service.onBeforeCreate(
+            createBy({
+              action: sampleAction,
+              samplePercentage: 10,
+              filterQuery: VALID_QUERY,
+            }),
+          ),
+        ).resolves.toBeDefined();
+      });
+
+      it("rejects a blank filter query, which would match everything", async () => {
+        for (const blank of ["", "   ", "\n\t"]) {
+          await expect(
+            service.onBeforeCreate(
+              createBy({ action: dropAction, filterQuery: blank }),
+            ),
+          ).rejects.toThrow(BadDataException);
+        }
+      });
+
+      it("rejects a missing filter query", async () => {
+        await expect(
+          service.onBeforeCreate(createBy({ action: dropAction })),
+        ).rejects.toThrow(BadDataException);
+      });
+
+      it("names the right record type in the error", async () => {
+        await expect(
+          service.onBeforeCreate(
+            createBy({ action: dropAction, filterQuery: "" }),
+          ),
+        ).rejects.toThrow(new RegExp(recordNoun));
+      });
+
+      it("rejects a sample filter with no percentage", async () => {
+        await expect(
+          service.onBeforeCreate(
+            createBy({ action: sampleAction, filterQuery: VALID_QUERY }),
+          ),
+        ).rejects.toThrow(BadDataException);
+      });
+
+      it("rejects a sample percentage outside 1-99", async () => {
+        for (const outOfRange of [0, 100, -1, 250]) {
+          await expect(
+            service.onBeforeCreate(
+              createBy({
+                action: sampleAction,
+                samplePercentage: outOfRange,
+                filterQuery: VALID_QUERY,
+              }),
+            ),
+          ).rejects.toThrow(BadDataException);
+        }
+      });
+
+      it("does not care about the percentage on a drop filter", async () => {
+        await expect(
+          service.onBeforeCreate(
+            createBy({
+              action: dropAction,
+              samplePercentage: 0,
+              filterQuery: VALID_QUERY,
+            }),
+          ),
+        ).resolves.toBeDefined();
+      });
+    });
+
+    describe("on update", () => {
+      /*
+       * The hook must not pay for a SELECT on writes that cannot break the
+       * row — renaming a filter or toggling it off is the common case.
+       */
+      it("skips the row read entirely when no validated field is touched", async () => {
+        const findBy: jest.SpiedFunction<any> = mockStoredRow({
+          action: dropAction,
+          samplePercentage: undefined,
+          filterQuery: VALID_QUERY,
+        });
+
+        await service.onBeforeUpdate(
+          updateBy({ name: "Renamed", isEnabled: false, sortOrder: 3 }),
+        );
+
+        expect(findBy).not.toHaveBeenCalled();
+      });
+
+      it("accepts a percentage change that stays in range", async () => {
+        mockStoredRow({
+          action: sampleAction,
+          samplePercentage: 10,
+          filterQuery: VALID_QUERY,
+        });
+
+        await expect(
+          service.onBeforeUpdate(updateBy({ samplePercentage: 25 })),
+        ).resolves.toBeDefined();
+      });
+
+      it("rejects a percentage change that leaves the range", async () => {
+        mockStoredRow({
+          action: sampleAction,
+          samplePercentage: 10,
+          filterQuery: VALID_QUERY,
+        });
+
+        await expect(
+          service.onBeforeUpdate(updateBy({ samplePercentage: 0 })),
+        ).rejects.toThrow(BadDataException);
+      });
+
+      /*
+       * The merge case that a patch-only check would miss: the request names
+       * only `action`, and the row it lands on has no percentage stored.
+       */
+      it("rejects flipping to sample when the stored percentage is null", async () => {
+        mockStoredRow({
+          action: dropAction,
+          samplePercentage: undefined,
+          filterQuery: VALID_QUERY,
+        });
+
+        await expect(
+          service.onBeforeUpdate(updateBy({ action: sampleAction })),
+        ).rejects.toThrow(BadDataException);
+      });
+
+      it("allows flipping to sample when the patch supplies the percentage", async () => {
+        mockStoredRow({
+          action: dropAction,
+          samplePercentage: undefined,
+          filterQuery: VALID_QUERY,
+        });
+
+        await expect(
+          service.onBeforeUpdate(
+            updateBy({ action: sampleAction, samplePercentage: 5 }),
+          ),
+        ).resolves.toBeDefined();
+      });
+
+      it("allows flipping to sample when the stored percentage is already valid", async () => {
+        mockStoredRow({
+          action: dropAction,
+          samplePercentage: 20,
+          filterQuery: VALID_QUERY,
+        });
+
+        await expect(
+          service.onBeforeUpdate(updateBy({ action: sampleAction })),
+        ).resolves.toBeDefined();
+      });
+
+      /*
+       * The other merge case: blanking the query on a row that is already a
+       * drop filter. The patch alone looks like a harmless text edit.
+       */
+      it("rejects blanking the filter query on an existing drop filter", async () => {
+        mockStoredRow({
+          action: dropAction,
+          samplePercentage: undefined,
+          filterQuery: VALID_QUERY,
+        });
+
+        for (const blank of ["", "  "]) {
+          await expect(
+            service.onBeforeUpdate(updateBy({ filterQuery: blank })),
+          ).rejects.toThrow(BadDataException);
+        }
+      });
+
+      it("allows replacing the filter query with another real condition", async () => {
+        mockStoredRow({
+          action: dropAction,
+          samplePercentage: undefined,
+          filterQuery: VALID_QUERY,
+        });
+
+        await expect(
+          service.onBeforeUpdate(
+            updateBy({ filterQuery: "body CONTAINS 'healthcheck'" }),
+          ),
+        ).resolves.toBeDefined();
+      });
+
+      /*
+       * A query can match more than one row. Every matched row has to be
+       * checked, or a bulk update could break the ones it did not look at.
+       */
+      it("validates every row the update matches, not just the first", async () => {
+        const healthy: any = makeModel();
+        healthy._id = FILTER_ID.toString();
+        healthy.action = sampleAction;
+        healthy.samplePercentage = 10;
+        healthy.filterQuery = VALID_QUERY;
+
+        const wouldBreak: any = makeModel();
+        wouldBreak._id = PROJECT_ID.toString();
+        wouldBreak.action = dropAction;
+        wouldBreak.filterQuery = VALID_QUERY;
+        // no samplePercentage stored
+
+        jest
+          .spyOn(service, "findBy")
+          .mockImplementation(async (): Promise<Array<any>> => {
+            return [healthy, wouldBreak];
+          });
+
+        await expect(
+          service.onBeforeUpdate(updateBy({ action: sampleAction })),
+        ).rejects.toThrow(BadDataException);
+      });
+
+      it("passes when the update matches no rows at all", async () => {
+        jest
+          .spyOn(service, "findBy")
+          .mockImplementation(async (): Promise<Array<any>> => {
+            return [];
+          });
+
+        await expect(
+          service.onBeforeUpdate(updateBy({ filterQuery: "" })),
+        ).resolves.toBeDefined();
+      });
+
+      /*
+       * A raw SQL expression cannot be evaluated here. Skipping is correct;
+       * rejecting would break a legitimate caller and validating a
+       * stringified function would be nonsense.
+       */
+      it("skips validation when a validated field is a raw SQL expression", async () => {
+        const findBy: jest.SpiedFunction<any> = mockStoredRow({
+          action: dropAction,
+          samplePercentage: undefined,
+          filterQuery: VALID_QUERY,
+        });
+
+        await expect(
+          service.onBeforeUpdate(
+            updateBy({
+              filterQuery: () => {
+                return "'x'";
+              },
+            }),
+          ),
+        ).resolves.toBeDefined();
+
+        expect(findBy).not.toHaveBeenCalled();
+      });
+    });
+  },
+);

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

@@ -0,0 +1,280 @@
+import MonitorProbeService from "../../../Server/Services/MonitorProbeService";
+import MonitorService from "../../../Server/Services/MonitorService";
+import MonitorProbe from "../../../Models/DatabaseModels/MonitorProbe";
+import DeleteBy from "../../../Server/Types/Database/DeleteBy";
+import { OnDelete } from "../../../Server/Types/Database/Hooks";
+import ObjectID from "../../../Types/ObjectID";
+import {
+  afterEach,
+  beforeEach,
+  describe,
+  expect,
+  it,
+  jest,
+} from "@jest/globals";
+import { getJestSpyOn } from "../../Spy";
+
+/*
+ * https://github.com/OneUptime/oneuptime/issues/2899
+ *
+ * Monitor > Probes can now remove a probe from a monitor - previously it could
+ * only add one, so a probe attached by mistake was permanent.
+ *
+ * Removing one changes the same aggregate that adding one or toggling
+ * isEnabled changes: Monitor.isNoProbeEnabledOnThisMonitor (the "Probes Not
+ * Enabled" banner on the monitor page, and the owner notification behind it).
+ * MonitorProbeService had create and update hooks for that and no delete hook,
+ * so deleting the last probe left the monitor still claiming it was watched.
+ *
+ * The monitorIds have to be read *before* the delete - afterwards the rows are
+ * gone - which is what these tests pin.
+ */
+
+const MONITOR_ID: ObjectID = new ObjectID(
+  "22222222-2222-4222-8222-222222222222",
+);
+const OTHER_MONITOR_ID: ObjectID = new ObjectID(
+  "66666666-6666-4666-8666-666666666666",
+);
+
+type MakeDeleteByFunction = (
+  query: Record<string, unknown>,
+) => DeleteBy<MonitorProbe>;
+
+const makeDeleteBy: MakeDeleteByFunction = (
+  query: Record<string, unknown>,
+): DeleteBy<MonitorProbe> => {
+  return {
+    query: query as any,
+    limit: 10,
+    skip: 0,
+    props: { isRoot: false },
+  } as DeleteBy<MonitorProbe>;
+};
+
+type MakeRowFunction = (monitorId: ObjectID | undefined) => MonitorProbe;
+
+const makeRow: MakeRowFunction = (
+  monitorId: ObjectID | undefined,
+): MonitorProbe => {
+  const monitorProbe: MonitorProbe = new MonitorProbe();
+
+  if (monitorId) {
+    monitorProbe.monitorId = monitorId;
+  }
+
+  return monitorProbe;
+};
+
+/*
+ * onBeforeDelete / onDeleteSuccess are protected: DatabaseService is what calls
+ * them. Reaching them directly is the only way to test them without a database.
+ */
+type CallOnBeforeDeleteFunction = (
+  deleteBy: DeleteBy<MonitorProbe>,
+) => Promise<OnDelete<MonitorProbe>>;
+
+const callOnBeforeDelete: CallOnBeforeDeleteFunction = (
+  deleteBy: DeleteBy<MonitorProbe>,
+): Promise<OnDelete<MonitorProbe>> => {
+  return (MonitorProbeService as any).onBeforeDelete(deleteBy);
+};
+
+type CallOnDeleteSuccessFunction = (
+  onDelete: OnDelete<MonitorProbe>,
+) => Promise<OnDelete<MonitorProbe>>;
+
+const callOnDeleteSuccess: CallOnDeleteSuccessFunction = (
+  onDelete: OnDelete<MonitorProbe>,
+): Promise<OnDelete<MonitorProbe>> => {
+  return (MonitorProbeService as any).onDeleteSuccess(onDelete, []);
+};
+
+describe("MonitorProbeService delete hooks", () => {
+  let refreshedMonitorIds: Array<string> = [];
+  let findByCalls: Array<any> = [];
+  let rowsToReturn: Array<MonitorProbe> = [];
+
+  beforeEach(() => {
+    refreshedMonitorIds = [];
+    findByCalls = [];
+    rowsToReturn = [];
+
+    getJestSpyOn(MonitorProbeService, "findBy").mockImplementation(
+      async (findBy: any): Promise<Array<MonitorProbe>> => {
+        findByCalls.push(findBy);
+        return rowsToReturn;
+      },
+    );
+
+    getJestSpyOn(
+      MonitorService,
+      "refreshMonitorProbeStatus",
+    ).mockImplementation(async (monitorId: any): Promise<void> => {
+      refreshedMonitorIds.push(monitorId.toString());
+    });
+  });
+
+  afterEach(() => {
+    jest.restoreAllMocks();
+  });
+
+  describe("onBeforeDelete", () => {
+    it("carries forward the monitors whose rows are about to disappear", async () => {
+      rowsToReturn = [makeRow(MONITOR_ID)];
+
+      const onDelete: OnDelete<MonitorProbe> = await callOnBeforeDelete(
+        makeDeleteBy({ monitorId: MONITOR_ID }),
+      );
+
+      expect(
+        (onDelete.carryForward.monitorIds as Array<ObjectID>).map(
+          (id: ObjectID) => {
+            return id.toString();
+          },
+        ),
+      ).toEqual([MONITOR_ID.toString()]);
+    });
+
+    it("looks the rows up with the caller's own delete query", async () => {
+      const query: Record<string, unknown> = { monitorId: MONITOR_ID };
+
+      await callOnBeforeDelete(makeDeleteBy(query));
+
+      expect(findByCalls).toHaveLength(1);
+      expect(findByCalls[0].query).toEqual(query);
+      expect(findByCalls[0].select).toEqual({ monitorId: true });
+    });
+
+    it("reads as root, because the caller's scope has not been applied yet", async () => {
+      /*
+       * DatabaseService narrows the query for permissions *after* this hook
+       * runs, so the hook has to be able to see the rows it is asked about.
+       */
+      await callOnBeforeDelete(makeDeleteBy({ monitorId: MONITOR_ID }));
+
+      expect(findByCalls[0].props.isRoot).toBe(true);
+    });
+
+    it("passes the delete's own limit and skip so a bulk delete is covered", async () => {
+      const deleteBy: DeleteBy<MonitorProbe> = makeDeleteBy({
+        monitorId: MONITOR_ID,
+      });
+      deleteBy.limit = 250;
+      deleteBy.skip = 10;
+
+      await callOnBeforeDelete(deleteBy);
+
+      expect(findByCalls[0].limit).toBe(250);
+      expect(findByCalls[0].skip).toBe(10);
+    });
+
+    it("returns the deleteBy unchanged, so it does not narrow the delete", async () => {
+      const deleteBy: DeleteBy<MonitorProbe> = makeDeleteBy({
+        monitorId: MONITOR_ID,
+      });
+
+      const onDelete: OnDelete<MonitorProbe> =
+        await callOnBeforeDelete(deleteBy);
+
+      expect(onDelete.deleteBy).toBe(deleteBy);
+    });
+
+    it("drops rows with no monitorId rather than carrying an undefined forward", async () => {
+      rowsToReturn = [makeRow(undefined), makeRow(MONITOR_ID)];
+
+      const onDelete: OnDelete<MonitorProbe> = await callOnBeforeDelete(
+        makeDeleteBy({}),
+      );
+
+      expect(onDelete.carryForward.monitorIds).toHaveLength(1);
+    });
+
+    it("carries nothing forward when the delete matches nothing", async () => {
+      rowsToReturn = [];
+
+      const onDelete: OnDelete<MonitorProbe> = await callOnBeforeDelete(
+        makeDeleteBy({ monitorId: MONITOR_ID }),
+      );
+
+      expect(onDelete.carryForward.monitorIds).toEqual([]);
+    });
+  });
+
+  describe("onDeleteSuccess", () => {
+    it("refreshes the monitor, so the 'Probes Not Enabled' banner appears", async () => {
+      await callOnDeleteSuccess({
+        deleteBy: makeDeleteBy({ monitorId: MONITOR_ID }),
+        carryForward: { monitorIds: [MONITOR_ID] },
+      });
+
+      expect(refreshedMonitorIds).toEqual([MONITOR_ID.toString()]);
+    });
+
+    it("refreshes every monitor a bulk delete touched", async () => {
+      await callOnDeleteSuccess({
+        deleteBy: makeDeleteBy({}),
+        carryForward: { monitorIds: [MONITOR_ID, OTHER_MONITOR_ID] },
+      });
+
+      expect(refreshedMonitorIds).toEqual([
+        MONITOR_ID.toString(),
+        OTHER_MONITOR_ID.toString(),
+      ]);
+    });
+
+    it("refreshes a monitor once even when several of its rows went", async () => {
+      /*
+       * Removing three probes from one monitor is one aggregate to recompute,
+       * and refreshMonitorProbeStatus writes to the monitor and can notify its
+       * owners.
+       */
+      await callOnDeleteSuccess({
+        deleteBy: makeDeleteBy({ monitorId: MONITOR_ID }),
+        carryForward: { monitorIds: [MONITOR_ID, MONITOR_ID, MONITOR_ID] },
+      });
+
+      expect(refreshedMonitorIds).toEqual([MONITOR_ID.toString()]);
+    });
+
+    it("does nothing when nothing was carried forward", async () => {
+      await callOnDeleteSuccess({
+        deleteBy: makeDeleteBy({}),
+        carryForward: { monitorIds: [] },
+      });
+
+      expect(refreshedMonitorIds).toEqual([]);
+    });
+
+    it("survives a carryForward that never ran onBeforeDelete", async () => {
+      // props.ignoreHooks makes DatabaseService pass carryForward: [].
+      await callOnDeleteSuccess({
+        deleteBy: makeDeleteBy({}),
+        carryForward: [],
+      });
+
+      expect(refreshedMonitorIds).toEqual([]);
+    });
+
+    it("does not turn a failed status refresh into a failed delete", async () => {
+      /*
+       * The rows are already gone by the time this runs. Throwing here would
+       * report a 500 for a delete that actually succeeded.
+       */
+      jest.restoreAllMocks();
+      getJestSpyOn(
+        MonitorService,
+        "refreshMonitorProbeStatus",
+      ).mockImplementation(async (): Promise<void> => {
+        throw new Error("refresh exploded");
+      });
+
+      await expect(
+        callOnDeleteSuccess({
+          deleteBy: makeDeleteBy({ monitorId: MONITOR_ID }),
+          carryForward: { monitorIds: [MONITOR_ID] },
+        }),
+      ).resolves.toBeDefined();
+    });
+  });
+});