@oneuptime/common 12.0.14 → 12.0.16

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

@@ -0,0 +1,104 @@
+import LlmCostBudget from "../../../Models/DatabaseModels/LlmCostBudget";
+import BadDataException from "../../../Types/Exception/BadDataException";
+import LlmCostBudgetService from "../../../Server/Services/LlmCostBudgetService";
+import CreateBy from "../../../Server/Types/Database/CreateBy";
+import UpdateBy from "../../../Server/Types/Database/UpdateBy";
+import { describe, expect, test } from "@jest/globals";
+
+/*
+ * The create/update hooks are protected; reach them the way the DatabaseService
+ * pipeline does, through the instance. They are pure validation (no DB access),
+ * so no mocking is needed.
+ */
+type HookAccess = {
+  onBeforeCreate: (
+    createBy: CreateBy<LlmCostBudget>,
+  ) => Promise<{ createBy: CreateBy<LlmCostBudget> }>;
+  onBeforeUpdate: (
+    updateBy: UpdateBy<LlmCostBudget>,
+  ) => Promise<{ updateBy: UpdateBy<LlmCostBudget> }>;
+};
+
+const service: HookAccess = LlmCostBudgetService as unknown as HookAccess;
+
+function makeCreateBy(data: Partial<LlmCostBudget>): CreateBy<LlmCostBudget> {
+  const budget: LlmCostBudget = new LlmCostBudget();
+  Object.assign(budget, data);
+
+  return {
+    data: budget,
+    props: { isRoot: true },
+  } as CreateBy<LlmCostBudget>;
+}
+
+function makeUpdateBy(data: Record<string, unknown>): UpdateBy<LlmCostBudget> {
+  return {
+    query: {},
+    data: data,
+    props: { isRoot: true },
+  } as unknown as UpdateBy<LlmCostBudget>;
+}
+
+describe("LlmCostBudgetService.onBeforeCreate — dailyBudgetInUSD", () => {
+  test("accepts a positive number", async () => {
+    const result: { createBy: CreateBy<LlmCostBudget> } =
+      await service.onBeforeCreate(makeCreateBy({ dailyBudgetInUSD: 250 }));
+
+    expect(result.createBy.data.dailyBudgetInUSD).toBe(250);
+  });
+
+  test("accepts a fractional budget", async () => {
+    const result: { createBy: CreateBy<LlmCostBudget> } =
+      await service.onBeforeCreate(makeCreateBy({ dailyBudgetInUSD: 0.5 }));
+
+    expect(result.createBy.data.dailyBudgetInUSD).toBe(0.5);
+  });
+
+  test("coerces a numeric string to a number", async () => {
+    const result: { createBy: CreateBy<LlmCostBudget> } =
+      await service.onBeforeCreate(
+        makeCreateBy({
+          dailyBudgetInUSD: "99.50" as unknown as number,
+        }),
+      );
+
+    expect(result.createBy.data.dailyBudgetInUSD).toBe(99.5);
+    expect(typeof result.createBy.data.dailyBudgetInUSD).toBe("number");
+  });
+
+  test.each([
+    ["zero", 0],
+    ["negative", -5],
+    ["NaN string", "not-a-number"],
+    ["empty string", ""],
+    ["missing", undefined],
+  ])("rejects %s", async (_label: string, value: unknown) => {
+    await expect(
+      service.onBeforeCreate(
+        makeCreateBy({ dailyBudgetInUSD: value as number }),
+      ),
+    ).rejects.toThrow(BadDataException);
+  });
+});
+
+describe("LlmCostBudgetService.onBeforeUpdate", () => {
+  test("coerces and validates an updated budget", async () => {
+    const result: { updateBy: UpdateBy<LlmCostBudget> } =
+      await service.onBeforeUpdate(makeUpdateBy({ dailyBudgetInUSD: "500" }));
+
+    expect(result.updateBy.data.dailyBudgetInUSD).toBe(500);
+  });
+
+  test("rejects an invalid updated budget", async () => {
+    await expect(
+      service.onBeforeUpdate(makeUpdateBy({ dailyBudgetInUSD: -1 })),
+    ).rejects.toThrow(BadDataException);
+  });
+
+  test("an update not touching the budget passes through", async () => {
+    const result: { updateBy: UpdateBy<LlmCostBudget> } =
+      await service.onBeforeUpdate(makeUpdateBy({ name: "renamed" }));
+
+    expect(result.updateBy.data["name"]).toBe("renamed");
+  });
+});

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

@@ -0,0 +1,405 @@
+import LogAggregationService, {
+  FacetRequest,
+  HistogramRequest,
+  LogAttributeFilterValue,
+} from "../../../Server/Services/LogAggregationService";
+import { Statement } from "../../../Server/Utils/AnalyticsDatabase/Statement";
+import ObjectID from "../../../Types/ObjectID";
+import BadDataException from "../../../Types/Exception/BadDataException";
+import { describe, expect, test } from "@jest/globals";
+
+/*
+ * Attribute filters carry an operator, not just a value. The logs *list*
+ * compiles those through StatementGenerator; these aggregation endpoints
+ * (histogram, facets, export) used to treat anything that was not an array as
+ * a plain string, so an operator arrived as an object, bound as
+ * "[object Object]" and matched nothing — the log monitor's preview showed an
+ * empty chart beside a populated list of logs.
+ *
+ * Operators travel as the `{_type, value}` shape every QueryOperator's
+ * toJSON() emits, which is exactly what lands in the request body.
+ *
+ * appendCommonFilters is shared by histogram / facets / analytics / export,
+ * so exercising it through the histogram covers all of them; the facet case
+ * at the end pins that sharing.
+ */
+
+const PROJECT_ID: ObjectID = ObjectID.generate();
+const START_TIME: Date = new Date("2026-03-01T00:00:00.000Z");
+const END_TIME: Date = new Date("2026-03-12T00:00:00.000Z");
+
+function histogramFor(
+  attributes: Record<string, LogAttributeFilterValue>,
+): Statement {
+  const request: HistogramRequest = {
+    projectId: PROJECT_ID,
+    startTime: START_TIME,
+    endTime: END_TIME,
+    bucketSizeInMinutes: 60,
+    attributes,
+  };
+
+  return (LogAggregationService as any).buildHistogramStatement(request);
+}
+
+function operator(
+  type: string,
+  value: unknown,
+): Record<string, LogAttributeFilterValue> {
+  return {
+    logtype: { _type: type, value } as LogAttributeFilterValue,
+  };
+}
+
+// The predicate this builder wraps every attribute match in.
+const KEY_MATCH: string = "arrayExists((k, v) -> lowerUTF8(k) = lowerUTF8(";
+const MAP_TAIL: string = ", mapKeys(attributes), mapValues(attributes))";
+
+function paramValues(statement: Statement): Array<unknown> {
+  return Object.values(statement.query_params);
+}
+
+describe("log attribute filters — operator support", () => {
+  describe("substring operators compile to ILIKE with the right anchors", () => {
+    test("Contains wraps the needle on both sides", () => {
+      const statement: Statement = histogramFor(operator("Search", "web"));
+
+      expect(statement.query).toContain(`${KEY_MATCH}`);
+      expect(statement.query).toContain("AND v ILIKE ");
+      expect(paramValues(statement)).toContain("%web%");
+    });
+
+    test("StartsWith anchors at the front", () => {
+      const statement: Statement = histogramFor(operator("StartsWith", "web"));
+
+      expect(statement.query).toContain("AND v ILIKE ");
+      expect(paramValues(statement)).toContain("web%");
+    });
+
+    test("EndsWith anchors at the back", () => {
+      const statement: Statement = histogramFor(operator("EndsWith", "web"));
+
+      expect(paramValues(statement)).toContain("%web");
+    });
+
+    test("NotContains negates the whole existence test", () => {
+      const statement: Statement = histogramFor(operator("NotContains", "web"));
+
+      expect(statement.query).toContain(`AND NOT ${KEY_MATCH}`);
+      expect(paramValues(statement)).toContain("%web%");
+    });
+  });
+
+  describe("equality operators", () => {
+    test("EqualTo compiles to the same predicate a bare string does", () => {
+      const wrapped: Statement = histogramFor(operator("EqualTo", "web"));
+      const bare: Statement = histogramFor({ logtype: "web" });
+
+      expect(wrapped.query).toBe(bare.query);
+      expect(wrapped.query_params).toStrictEqual(bare.query_params);
+    });
+
+    describe("a blank comparison value is special", () => {
+      /*
+       * The list query compares against a Map subscript, and ClickHouse
+       * returns the value type's default for a key the row does not carry —
+       * so `attributes['k']` reads as '' for a row with no such attribute.
+       * That makes '' the one value where "equals" and "not equals" have to
+       * reason about absence, and naively negating the existence test got
+       * both backwards.
+       */
+      test("NotEqual('') means present and non-empty, like 'is not empty'", () => {
+        const blank: Statement = histogramFor(operator("NotEqual", ""));
+        const isNotEmpty: Statement = histogramFor(operator("NotNull", null));
+
+        expect(blank.query).toBe(isNotEmpty.query);
+        expect(blank.query).toContain(`AND ${KEY_MATCH}`);
+        expect(blank.query).toContain("AND v != ''");
+        expect(blank.query).not.toContain("AND NOT arrayExists");
+      });
+
+      test("EqualTo('') means missing or empty, like 'is empty'", () => {
+        const blank: Statement = histogramFor(operator("EqualTo", ""));
+        const isEmpty: Statement = histogramFor(operator("IsNull", null));
+
+        expect(blank.query).toBe(isEmpty.query);
+        expect(blank.query).toContain(`AND NOT ${KEY_MATCH}`);
+      });
+
+      test("a bare '' filter reads the same as an explicit EqualTo('')", () => {
+        /*
+         * The same filter written two ways — a blank value box stores a bare
+         * "" — so the two spellings must not compile differently.
+         */
+        const bare: Statement = histogramFor({ logtype: "" });
+        const wrapped: Statement = histogramFor(operator("EqualTo", ""));
+
+        expect(bare.query).toBe(wrapped.query);
+        expect(bare.query_params).toStrictEqual(wrapped.query_params);
+      });
+
+      test("a missing NotEqual value is treated as blank, not as 'undefined'", () => {
+        const absent: Statement = histogramFor(operator("NotEqual", undefined));
+        const blank: Statement = histogramFor(operator("NotEqual", ""));
+
+        expect(absent.query).toBe(blank.query);
+      });
+
+      test("blank does not leak into non-blank comparisons", () => {
+        const nonBlank: Statement = histogramFor(operator("NotEqual", "web"));
+
+        expect(nonBlank.query).toContain(`AND NOT ${KEY_MATCH}`);
+        expect(nonBlank.query).toContain("AND v = ");
+        expect(paramValues(nonBlank)).toContain("web");
+      });
+    });
+
+    test("NotEqual negates, so rows without the attribute still match", () => {
+      /*
+       * Mirrors StatementGenerator's map-subscript form, where a missing key
+       * reads as '' and therefore satisfies `!= value`.
+       */
+      const statement: Statement = histogramFor(operator("NotEqual", "web"));
+
+      expect(statement.query).toContain(`AND NOT ${KEY_MATCH}`);
+      expect(statement.query).toContain("AND v = ");
+      expect(paramValues(statement)).toContain("web");
+    });
+  });
+
+  describe("membership operators", () => {
+    test("Includes compiles to IN", () => {
+      const statement: Statement = histogramFor(
+        operator("Includes", ["web", "api"]),
+      );
+
+      expect(statement.query).toContain("AND v IN (");
+      expect(statement.query).not.toContain("AND NOT arrayExists");
+      expect(paramValues(statement)).toContainEqual(["web", "api"]);
+    });
+
+    test("IncludesNone compiles to a negated IN", () => {
+      const statement: Statement = histogramFor(
+        operator("IncludesNone", ["web", "api"]),
+      );
+
+      expect(statement.query).toContain(`AND NOT ${KEY_MATCH}`);
+      expect(statement.query).toContain("AND v IN (");
+      expect(paramValues(statement)).toContainEqual(["web", "api"]);
+    });
+
+    test("non-string members are stringified rather than bound as objects", () => {
+      const statement: Statement = histogramFor(operator("Includes", [1, 2]));
+
+      expect(paramValues(statement)).toContainEqual(["1", "2"]);
+    });
+
+    test("an empty selection means All — no predicate at all", () => {
+      /*
+       * `IN ()` is a ClickHouse syntax error and "match nothing" is never
+       * what a cleared multi-select means; StatementGenerator and the form
+       * both treat it as All, so this must too.
+       */
+      const empty: Statement = histogramFor(operator("Includes", []));
+      const none: Statement = histogramFor({});
+
+      expect(empty.query).toBe(none.query);
+      expect(empty.query).not.toContain(KEY_MATCH);
+
+      const emptyExclusion: Statement = histogramFor(
+        operator("IncludesNone", []),
+      );
+
+      expect(emptyExclusion.query).toBe(none.query);
+    });
+  });
+
+  describe("numeric operators cast the stored text", () => {
+    test.each([
+      ["GreaterThan", ">"],
+      ["GreaterThanOrEqual", ">="],
+      ["LessThan", "<"],
+      ["LessThanOrEqual", "<="],
+    ])("%s compiles to toFloat64OrNull(v) %s", (type: string, sql: string) => {
+      const statement: Statement = histogramFor(operator(type, 5));
+
+      expect(statement.query).toContain(`AND toFloat64OrNull(v) ${sql} `);
+      expect(paramValues(statement)).toContain(5);
+    });
+
+    test("a fractional threshold binds as Double, not Int32", () => {
+      /*
+       * The value box is free text, so `> 1.5` is reachable from the criteria
+       * form. `TableColumnType.Number` maps to ClickHouse Int32 and the
+       * left-hand side is a Float64, so binding the threshold as Number made
+       * the database reject the query — a 500 where the pre-fix code merely
+       * showed an empty chart. Decimal maps to Double.
+       */
+      const statement: Statement = histogramFor(operator("GreaterThan", 1.5));
+
+      expect(statement.query).toMatch(/toFloat64OrNull\(v\) > \{p\d+:Double\}/);
+      expect(statement.query).not.toMatch(
+        /toFloat64OrNull\(v\) > \{p\d+:Int32\}/,
+      );
+      expect(paramValues(statement)).toContain(1.5);
+    });
+
+    test.each([
+      ["a missing value", undefined],
+      ["a null value", null],
+      ["an empty string", ""],
+      ["a non-numeric string", "not-a-number"],
+    ])(
+      "%s is refused instead of being bound as 0 or nan",
+      (_label: string, value: unknown) => {
+        /*
+         * `Number(null)` is 0, which would silently turn a half-filled filter
+         * into "> 0"; a non-numeric one binds as the literal `nan`, which
+         * ClickHouse cannot parse. Both should be a 400 naming the filter.
+         */
+        expect(() => {
+          return histogramFor(operator("GreaterThan", value));
+        }).toThrow(/needs a numeric value/);
+      },
+    );
+
+    test("the comparison is literal SQL, never a bound identifier", () => {
+      /*
+       * An interpolation inside the SQL tag becomes an Identifier parameter,
+       * which `>` is not — so the comparison has to be appended raw.
+       */
+      const statement: Statement = histogramFor(operator("GreaterThan", 5));
+
+      expect(statement.query).not.toContain("toFloat64OrNull(v) {p");
+    });
+  });
+
+  describe("presence operators", () => {
+    test("IsEmpty matches rows with no non-empty value under the key", () => {
+      const statement: Statement = histogramFor(operator("IsNull", null));
+
+      expect(statement.query).toContain(`AND NOT ${KEY_MATCH}`);
+      expect(statement.query).toContain("AND v != ''");
+    });
+
+    test("IsNotEmpty matches rows that do have one", () => {
+      const statement: Statement = histogramFor(operator("NotNull", null));
+
+      expect(statement.query).toContain(`AND ${KEY_MATCH}`);
+      expect(statement.query).toContain("AND v != ''");
+      expect(statement.query).not.toContain("AND NOT arrayExists");
+    });
+  });
+
+  describe("the existing shapes are untouched", () => {
+    test("a bare string still compiles to case-insensitive equality", () => {
+      const statement: Statement = histogramFor({ requestid: "uuid-123" });
+
+      expect(statement.query).toContain(KEY_MATCH);
+      expect(statement.query).toContain(MAP_TAIL);
+      expect(paramValues(statement)).toContain("requestid");
+      expect(paramValues(statement)).toContain("uuid-123");
+    });
+
+    test("a bare array still compiles to IN", () => {
+      const statement: Statement = histogramFor({
+        region: ["eu-west-1", "us-east-1"],
+      });
+
+      expect(statement.query).toContain("AND v IN (");
+      expect(paramValues(statement)).toContainEqual(["eu-west-1", "us-east-1"]);
+    });
+  });
+
+  describe("safety", () => {
+    test("values are bound as parameters, never inlined", () => {
+      const statement: Statement = histogramFor(
+        operator("Search", "web'; DROP TABLE log; --"),
+      );
+
+      expect(statement.query).not.toContain("DROP TABLE");
+      expect(paramValues(statement)).toContain("%web'; DROP TABLE log; --%");
+    });
+
+    test("an injection-shaped attribute key is still rejected by key validation", () => {
+      expect(() => {
+        return histogramFor({
+          "logtype') OR 1=1 --": { _type: "Search", value: "web" },
+        });
+      }).toThrow();
+    });
+
+    test.each([
+      ["Search", { toString: 1 }],
+      ["EqualTo", { valueOf: 1, toString: 2 }],
+      ["NotContains", []],
+      ["StartsWith", { nested: { deep: true } }],
+    ])(
+      "a non-primitive %s value is refused, not coerced",
+      (type: string, value: unknown) => {
+        /*
+         * `value` is unvalidated JSON off the wire. String()/Number() do not
+         * just produce a bad result on an object — ToPrimitive THROWS a
+         * TypeError when toString/valueOf are shadowed with non-callables,
+         * and that escaped the BadDataException path and answered 500.
+         */
+        expect(() => {
+          return histogramFor(operator(type, value));
+        }).toThrow(BadDataException);
+      },
+    );
+
+    test("a non-primitive membership member is refused too", () => {
+      expect(() => {
+        return histogramFor(operator("Includes", ["ok", { toString: 1 }]));
+      }).toThrow(BadDataException);
+    });
+
+    test("an unknown operator is refused rather than silently mis-filtered", () => {
+      /*
+       * `_type` comes off the wire. Binding an unrecognised object as text
+       * is how this broke in the first place — counts that quietly disagreed
+       * with the logs list. Fail loudly instead.
+       */
+      expect(() => {
+        return histogramFor(operator("SomethingElse", "web"));
+      }).toThrow(/Unsupported attribute filter/);
+    });
+  });
+
+  describe("every consumer of appendCommonFilters gets the same predicate", () => {
+    test("facets compile operators exactly like the histogram does", () => {
+      const request: FacetRequest = {
+        projectId: PROJECT_ID,
+        startTime: START_TIME,
+        endTime: END_TIME,
+        facetKey: "severityText",
+        limit: 15,
+        attributes: operator("Search", "web"),
+      };
+
+      const facetStatement: Statement = (
+        LogAggregationService as any
+      ).buildFacetStatement(request);
+
+      expect(facetStatement.query).toContain(KEY_MATCH);
+      expect(facetStatement.query).toContain("AND v ILIKE ");
+      expect(paramValues(facetStatement)).toContain("%web%");
+    });
+  });
+
+  describe("several filters combine", () => {
+    test("mixed operators all land in the same WHERE clause", () => {
+      const statement: Statement = histogramFor({
+        logtype: { _type: "Search", value: "web" } as LogAttributeFilterValue,
+        env: "production",
+        region: { _type: "Includes", value: ["eu"] } as LogAttributeFilterValue,
+      });
+
+      expect(statement.query.match(/arrayExists/g)).toHaveLength(3);
+      expect(paramValues(statement)).toContain("%web%");
+      expect(paramValues(statement)).toContain("production");
+      expect(paramValues(statement)).toContainEqual(["eu"]);
+    });
+  });
+});