@oneuptime/common 12.0.33 → 13.0.0

package/Tests/Server/Utils/Monitor/MonitorCriteriaMessageBuilderUnits.test.ts

@@ -116,9 +116,9 @@ describe("MonitorCriteriaMessageBuilder — metric unit labelling", () => {
       });
 
     // Observed value carries the unit.
-    expect(message).toContain("latest 0.06 sec");
-    expect(message).toContain("min 0.06 sec");
-    expect(message).toContain("max 0.06 sec");
+    expect(message).toContain("latest 60 ms");
+    expect(message).toContain("min 60 ms");
+    expect(message).toContain("max 60 ms");
     // Threshold in the expectation clause carries the same unit.
     expect(message).toContain("greater than 5 sec");
   });
@@ -150,11 +150,20 @@ describe("MonitorCriteriaMessageBuilder — metric unit labelling", () => {
         matchMessage: null,
       });
 
-    expect(message).toContain("latest 0.50 sec");
+    expect(message).toContain("latest 500 ms");
     expect(message).toContain("greater than 2 sec");
   });
 
-  test("omits the unit for dimensionless ratio metrics (native unit '1')", () => {
+  /*
+   * A ratio metric carries OTel's dimensionless "1" over samples that are
+   * fractions in [0, 1]. Printing "0.06 1" is meaningless and printing a
+   * bare "0.06" reads as 0.06% when the value is 6%.
+   *
+   * The fired-alert email has rendered this as "6.00%" since CompareCriteria
+   * adopted MetricValueFormatter; this line — the monitor's own evaluation
+   * log for the SAME sample — used to say "0.06". Both now agree.
+   */
+  test("renders a dimensionless ratio metric as the percentage it means", () => {
     const criteriaFilter: CriteriaFilter = {
       checkOn: CheckOn.MetricValue,
       filterType: FilterType.GreaterThan,
@@ -179,12 +188,50 @@ describe("MonitorCriteriaMessageBuilder — metric unit labelling", () => {
         matchMessage: null,
       });
 
-    expect(message).toContain("latest 0.06");
-    // No stray "0.06 1" and no unit on the threshold.
+    expect(message).toContain("latest 6.00%");
+    // Never the dimensionless marker, and never the unscaled fraction.
     expect(message).not.toContain("0.06 1");
-    expect(message).toContain("greater than 0.9");
+    expect(message).not.toContain("latest 0.06");
+    // The threshold is scaled the same way, so the two halves agree.
+    expect(message).toContain("greater than 90.00%");
     expect(message).not.toContain("greater than 0.9 1");
   });
+
+  /*
+   * The control for the rule above: "1" is only a percentage when the
+   * metric NAME says the value is a fraction. A counter carrying "1" —
+   * cumulative layout shift is the canonical one — keeps its bare number.
+   */
+  test("a non-fraction metric carrying '1' keeps its bare number", () => {
+    const criteriaFilter: CriteriaFilter = {
+      checkOn: CheckOn.MetricValue,
+      filterType: FilterType.GreaterThan,
+      value: "0.25",
+      metricMonitorOptions: {
+        metricAlias: "a",
+        metricAggregationType: EvaluateOverTimeType.Average,
+      },
+    };
+
+    const inputs: ReturnType<typeof buildInputs> = buildInputs({
+      metricNativeUnit: "1",
+      metricName: "browser.cumulative_layout_shift",
+      sampleValues: [0.31],
+      criteriaFilter,
+    });
+
+    const message: string =
+      MonitorCriteriaMessageBuilder.buildCriteriaFilterMessage({
+        ...inputs,
+        didMeetCriteria: false,
+        matchMessage: null,
+      });
+
+    expect(message).toContain("latest 0.31");
+    expect(message).not.toContain("0.31 1");
+    expect(message).not.toContain("31.00%");
+    expect(message).toContain("greater than 0.25");
+  });
 });
 
 /*
@@ -221,7 +268,7 @@ describe("MonitorCriteriaMessageBuilder.buildCriteriaFilterMessage — Evaluatio
       });
 
     expect(message).toBe(
-      "Metric Value (a) recorded latest 0.06 sec (min 0.06 sec, max 0.06 sec) across 3 data points. (expected to be greater than 5 sec using average).",
+      "Metric Value (a) recorded latest 60 ms (min 60 ms, max 60 ms) across 3 data points. (expected to be greater than 5 sec using average).",
     );
   });
 
@@ -251,10 +298,10 @@ describe("MonitorCriteriaMessageBuilder.buildCriteriaFilterMessage — Evaluatio
       });
 
     expect(message).toBe(
-      "Metric Value (a) recorded latest 10.00 sec (min 8.00 sec, max 12.00 sec) across 3 data points. (expected to be less than 5 sec using average).",
+      "Metric Value (a) recorded latest 10 sec (min 8 sec, max 12 sec) across 3 data points. (expected to be less than 5 sec using average).",
     );
     // The unit rides both the observed value and the "less than N unit" clause.
-    expect(message).toContain("latest 10.00 sec");
+    expect(message).toContain("latest 10 sec");
     expect(message).toContain("less than 5 sec");
   });
 
@@ -286,7 +333,7 @@ describe("MonitorCriteriaMessageBuilder.buildCriteriaFilterMessage — Evaluatio
       });
 
     expect(message).toBe(
-      "Metric Value (a) recorded latest 3.50 sec (min 1.50 sec, max 3.50 sec) across 3 data points. (expected to be greater than 2 sec using maximum value).",
+      "Metric Value (a) recorded latest 3.5 sec (min 1.5 sec, max 3.5 sec) across 3 data points. (expected to be greater than 2 sec using maximum value).",
     );
     // The raw ms magnitudes never leak into the rendered line.
     expect(message).not.toContain("1500");
@@ -329,14 +376,14 @@ describe("MonitorCriteriaMessageBuilder.buildCriteriaFilterMessage — Evaluatio
      * observed value and the threshold, even though "1.00" appears in the text.
      */
     expect(message).toBe(
-      "Metric Value (a) recorded latest 1.00 (min 0.95, max 1.00) across 3 data points. (expected to be greater than 0.9 using average).",
+      "Metric Value (a) recorded latest 100.00% (min 95.00%, max 100.00%) across 3 data points. (expected to be greater than 90.00% using average).",
     );
     /*
      * Neither the value nor the threshold carries a unit: each number is
      * immediately followed by punctuation/wording, never a " 1" unit suffix.
      */
-    expect(message).toContain("latest 1.00 (min 0.95, max 1.00)");
-    expect(message).toContain("greater than 0.9 using average");
+    expect(message).toContain("latest 100.00% (min 95.00%, max 100.00%)");
+    expect(message).toContain("greater than 90.00% using average");
   });
 
   /*
@@ -375,11 +422,11 @@ describe("MonitorCriteriaMessageBuilder.buildCriteriaFilterMessage — Evaluatio
       });
 
     expect(message).toBe(
-      "Metric Value (a) recorded latest 6.00 % across 1 data point. (expected to be greater than 90 % using average).",
+      "Metric Value (a) recorded latest 6.00% across 1 data point. (expected to be greater than 90.00% using average).",
     );
     // Both the converted observed value and the threshold carry the "%" unit.
-    expect(message).toContain("latest 6.00 %");
-    expect(message).toContain("greater than 90 %");
+    expect(message).toContain("latest 6.00%");
+    expect(message).toContain("greater than 90.00%");
     // The raw fraction magnitude never leaks into the rendered line.
     expect(message).not.toContain("0.06");
     // Singular grammar for the lone sample — no "(min .., max ..)" clause.
@@ -488,7 +535,7 @@ describe("MonitorCriteriaMessageBuilder.buildCriteriaFilterMessage — Evaluatio
       });
 
     expect(message).toBe(
-      "Metric Value (a) recorded latest 7.00 sec across 1 data point. (expected to be greater than 5 sec using average).",
+      "Metric Value (a) recorded latest 7 sec across 1 data point. (expected to be greater than 5 sec using average).",
     );
     // Singular grammar, and no "(min .., max ..)" clause for a lone sample.
     expect(message).toContain("across 1 data point.");
@@ -522,7 +569,7 @@ describe("MonitorCriteriaMessageBuilder.buildCriteriaFilterMessage — Evaluatio
       });
 
     expect(message).toBe(
-      "Metric Value (a) recorded latest 100.00 ms (min 100.00 ms, max 100.00 ms) across 3 data points. (expected to equal 100 ms using average).",
+      "Metric Value (a) recorded latest 100 ms (min 100 ms, max 100 ms) across 3 data points. (expected to equal 100 ms using average).",
     );
   });
 
@@ -552,7 +599,7 @@ describe("MonitorCriteriaMessageBuilder.buildCriteriaFilterMessage — Evaluatio
       });
 
     expect(message).toBe(
-      "Metric Value (a) recorded latest 70.00 ms (min 55.00 ms, max 70.00 ms) across 3 data points. (expected to be greater than or equal to 50 ms using maximum value).",
+      "Metric Value (a) recorded latest 70 ms (min 55 ms, max 70 ms) across 3 data points. (expected to be greater than or equal to 50 ms using maximum value).",
     );
   });
 

package/Tests/Server/Utils/Monitor/MonitorCriteriaObservationBuilderUnits.test.ts

@@ -318,7 +318,7 @@ describe("MonitorCriteriaObservationBuilder.describeFilterObservation — metric
       MonitorCriteriaObservationBuilder.describeFilterObservation(inputs);
 
     expect(observation).toBe(
-      "Metric Value (a) recorded latest 0.06 sec (min 0.06 sec, max 0.06 sec) across 3 data points.",
+      "Metric Value (a) recorded latest 60 ms (min 60 ms, max 60 ms) across 3 data points.",
     );
   });
 
@@ -339,7 +339,7 @@ describe("MonitorCriteriaObservationBuilder.describeFilterObservation — metric
       MonitorCriteriaObservationBuilder.describeFilterObservation(inputs);
 
     expect(observation).toBe(
-      "Metric Value (a) recorded latest 60.00 ms (min 40.00 ms, max 60.00 ms) across 2 data points.",
+      "Metric Value (a) recorded latest 60 ms (min 40 ms, max 60 ms) across 2 data points.",
     );
   });
 
@@ -364,9 +364,9 @@ describe("MonitorCriteriaObservationBuilder.describeFilterObservation — metric
       MonitorCriteriaObservationBuilder.describeFilterObservation(inputs);
 
     expect(observation).toBe(
-      "Metric Value (a) recorded latest 2.50 sec across 1 data point.",
+      "Metric Value (a) recorded latest 2.5 sec across 1 data point.",
     );
-    expect(observation).toContain("2.50 sec");
+    expect(observation).toContain("2.5 sec");
   });
 
   /*
@@ -389,9 +389,9 @@ describe("MonitorCriteriaObservationBuilder.describeFilterObservation — metric
       MonitorCriteriaObservationBuilder.describeFilterObservation(inputs);
 
     expect(observation).toBe(
-      "Metric Value (a) recorded latest 2.50 GB across 1 data point.",
+      "Metric Value (a) recorded latest 2.5 GB across 1 data point.",
     );
-    expect(observation).toContain("2.50 GB");
+    expect(observation).toContain("2.5 GB");
   });
 
   /*
@@ -413,13 +413,30 @@ describe("MonitorCriteriaObservationBuilder.describeFilterObservation — metric
     const observation: string | null =
       MonitorCriteriaObservationBuilder.describeFilterObservation(inputs);
 
+    /*
+     * The user mislabelled a millisecond metric as megabytes. The
+     * conversion still no-ops — ms and MB are different families — so the
+     * SAMPLE is untouched at 5000, and the renderer then takes the label
+     * at its word and reads 5000 MB out as "5 GB". Every string this
+     * sentence can produce is wrong, because the configuration is; what
+     * this test pins is that the mislabelling is passed through rather
+     * than silently repaired.
+     */
     expect(observation).toBe(
-      "Metric Value (a) recorded latest 5000.00 MB across 1 data point.",
+      "Metric Value (a) recorded latest 5 GB across 1 data point.",
     );
-    // Unconverted value passed through.
-    expect(observation).toContain("5000.00");
-    // But labelled with the (incompatible) threshold unit.
-    expect(observation).toContain("MB");
+    expect(observation).toContain("5 GB");
+    /*
+     * Still reported in the threshold unit's FAMILY — the label the user
+     * chose won, which is the behaviour this test guards. It reads "GB"
+     * rather than "MB" only because the ladder rescales within that family;
+     * the alternative would be to drop the user's unit when it looks
+     * incompatible, which would hide the misconfiguration entirely.
+     */
+    expect(observation).not.toContain("ms");
+    expect(
+      MonitorCriteriaObservationBuilder.getMetricValueDisplayUnit(inputs),
+    ).toBe("MB");
   });
 
   /*
@@ -486,7 +503,7 @@ describe("MonitorCriteriaObservationBuilder.describeFilterObservation — metric
       MonitorCriteriaObservationBuilder.describeFilterObservation(inputs);
 
     expect(observation).toBe(
-      "Metric Value (a) recorded latest 60.00 ms (min 40.00 ms, max 60.00 ms) across 2 data points.",
+      "Metric Value (a) recorded latest 60 ms (min 40 ms, max 60 ms) across 2 data points.",
     );
   });
 
@@ -532,7 +549,7 @@ describe("MonitorCriteriaObservationBuilder.describeFilterObservation — metric
       MonitorCriteriaObservationBuilder.describeFilterObservation(inputs);
 
     expect(observation).toBe(
-      "Metric Value (b) recorded latest 3.00 sec (min 1.00 sec, max 3.00 sec) across 3 data points.",
+      "Metric Value (b) recorded latest 3 sec (min 1 sec, max 3 sec) across 3 data points.",
     );
     // The a-series (ms, 40/60) must not leak in.
     expect(observation).not.toContain("(a)");
@@ -562,7 +579,7 @@ describe("MonitorCriteriaObservationBuilder.describeFilterObservation — metric
       MonitorCriteriaObservationBuilder.describeFilterObservation(inputs);
 
     expect(observation).toBe(
-      "Metric Value (a) recorded latest 6.00 % across 1 data point.",
+      "Metric Value (a) recorded latest 6.00% across 1 data point.",
     );
 
     const unit: string | undefined =
@@ -630,7 +647,7 @@ describe("MonitorCriteriaObservationBuilder.describeFilterObservation — metric
       MonitorCriteriaObservationBuilder.describeFilterObservation(inputs);
 
     expect(observation).toBe(
-      "Metric Value (c) recorded latest 2.50 sec (min 1.50 sec, max 2.50 sec) across 2 data points.",
+      "Metric Value (c) recorded latest 2.5 sec (min 1.5 sec, max 2.5 sec) across 2 data points.",
     );
     // The formula alias, not the base query, is summarized.
     expect(observation).toContain("(c)");
@@ -659,9 +676,9 @@ describe("MonitorCriteriaObservationBuilder.describeFilterObservation — metric
       MonitorCriteriaObservationBuilder.describeFilterObservation(inputs);
 
     expect(observation).toBe(
-      "Metric Value (a) recorded latest 1.50 gbit across 1 data point.",
+      "Metric Value (a) recorded latest 1.5 Gbit across 1 data point.",
     );
-    expect(observation).toContain("1.50 gbit");
+    expect(observation).toContain("1.5 Gbit");
   });
 
   /*
@@ -686,10 +703,10 @@ describe("MonitorCriteriaObservationBuilder.describeFilterObservation — metric
       MonitorCriteriaObservationBuilder.describeFilterObservation(inputs);
 
     expect(observation).toBe(
-      "Metric Value (a) recorded latest 5.00 sec across 1 data point.",
+      "Metric Value (a) recorded latest 5 sec across 1 data point.",
     );
     // Unconverted value, but labelled with the threshold unit.
-    expect(observation).toContain("5.00 sec");
+    expect(observation).toContain("5 sec");
   });
 });
 

package/Tests/Server/Utils/Monitor/MonitorTemplateUtilSeriesContext.test.ts

@@ -0,0 +1,176 @@
+import { JSONObject } from "../../../../Types/JSON";
+import MonitorType from "../../../../Types/Monitor/MonitorType";
+import DataToProcess from "../../../../Server/Utils/Monitor/DataToProcess";
+import MonitorTemplateUtil from "../../../../Server/Utils/Monitor/MonitorTemplateUtil";
+
+/*
+ * The series-identity template variables.
+ *
+ * The load-bearing property is that they are ALWAYS DEFINED. VMUtil's
+ * substitution leaves a placeholder it cannot resolve in the output
+ * verbatim, so a shipped template written as
+ *
+ *   "Pod CPU high{{seriesResourceSuffix}}"
+ *
+ * would render with the braces still in it on any monitor without a
+ * group-by. Defining them as "" instead is what makes a single template
+ * safe for grouped and ungrouped monitors alike - which is the whole
+ * reason these exist alongside the raw `{{resource.k8s.pod.name}}`
+ * label variables.
+ */
+
+const EMPTY_DATA: DataToProcess = {} as unknown as DataToProcess;
+
+function buildStorageMap(seriesLabels?: JSONObject | undefined): JSONObject {
+  return MonitorTemplateUtil.buildTemplateStorageMap({
+    monitorType: MonitorType.Kubernetes,
+    dataToProcess: EMPTY_DATA,
+    seriesLabels,
+  });
+}
+
+describe("MonitorTemplateUtil - series context variables", () => {
+  describe("always defined", () => {
+    test.each([
+      "seriesResourceSuffix",
+      "seriesResourceSummary",
+      "seriesResourceBlock",
+      "seriesDebugCommands",
+    ])("%s is defined when the monitor has no group-by", (key: string) => {
+      const storageMap: JSONObject = buildStorageMap(undefined);
+
+      expect(storageMap[key]).toBeDefined();
+      expect(storageMap[key]).toBe("");
+    });
+
+    test.each([
+      "seriesResourceSuffix",
+      "seriesResourceSummary",
+      "seriesResourceBlock",
+      "seriesDebugCommands",
+    ])("%s is defined for an empty label map", (key: string) => {
+      expect(buildStorageMap({})[key]).toBe("");
+    });
+
+    test("an unresolved placeholder never leaks into a rendered title", () => {
+      /*
+       * This is the failure mode the "always defined" rule prevents, and
+       * the assertion that would have caught it.
+       */
+      const rendered: string = MonitorTemplateUtil.processTemplateString({
+        value: "[K8s] Pod CPU high{{seriesResourceSuffix}}",
+        storageMap: buildStorageMap(undefined),
+      });
+
+      expect(rendered).toBe("[K8s] Pod CPU high");
+      expect(rendered).not.toContain("{{");
+    });
+  });
+
+  describe("resolved values", () => {
+    const POD_LABELS: JSONObject = {
+      "resource.k8s.namespace.name": "prod",
+      "resource.k8s.pod.name": "checkout-7d9f-2xk",
+      "resource.k8s.node.name": "ip-10-0-3-14",
+    };
+
+    test("the suffix renders the identity, separator included", () => {
+      expect(buildStorageMap(POD_LABELS)["seriesResourceSuffix"]).toBe(
+        " - Pod: checkout-7d9f-2xk | Namespace: prod | Node: ip-10-0-3-14",
+      );
+    });
+
+    test("the summary is the same text without the leading separator", () => {
+      expect(buildStorageMap(POD_LABELS)["seriesResourceSummary"]).toBe(
+        "Pod: checkout-7d9f-2xk | Namespace: prod | Node: ip-10-0-3-14",
+      );
+    });
+
+    test("the block lists every label as markdown", () => {
+      const block: string = buildStorageMap(POD_LABELS)[
+        "seriesResourceBlock"
+      ] as string;
+
+      expect(block).toContain("**Affected resource**");
+      expect(block).toContain("- **Pod:** `checkout-7d9f-2xk`");
+      expect(block).toContain("- **Node:** `ip-10-0-3-14`");
+    });
+
+    test("the commands are built for the monitor's own type", () => {
+      const kubernetesCommands: string =
+        MonitorTemplateUtil.buildTemplateStorageMap({
+          monitorType: MonitorType.Kubernetes,
+          dataToProcess: EMPTY_DATA,
+          seriesLabels: POD_LABELS,
+        })["seriesDebugCommands"] as string;
+
+      const dockerCommands: string =
+        MonitorTemplateUtil.buildTemplateStorageMap({
+          monitorType: MonitorType.Docker,
+          dataToProcess: EMPTY_DATA,
+          seriesLabels: { "resource.container.name": "nginx" },
+        })["seriesDebugCommands"] as string;
+
+      expect(kubernetesCommands).toContain("kubectl describe pod");
+      expect(dockerCommands).toContain("docker logs");
+      expect(dockerCommands).not.toContain("kubectl");
+    });
+
+    test("a title template composed of static text and the suffix renders cleanly", () => {
+      expect(
+        MonitorTemplateUtil.processTemplateString({
+          value:
+            "[K8s] Pod CPU Saturating Container Limit{{seriesResourceSuffix}}",
+          storageMap: buildStorageMap(POD_LABELS),
+        }),
+      ).toBe(
+        "[K8s] Pod CPU Saturating Container Limit - Pod: checkout-7d9f-2xk | Namespace: prod | Node: ip-10-0-3-14",
+      );
+    });
+  });
+
+  describe("coexistence with the raw label variables", () => {
+    test("the dotted label variables still resolve alongside the new ones", () => {
+      /*
+       * The raw variables are the escape hatch for a user who wants full
+       * control of the wording. Adding the convenience variables must not
+       * have displaced them.
+       */
+      const storageMap: JSONObject = buildStorageMap({
+        "resource.k8s.pod.name": "checkout-7d9f-2xk",
+      });
+
+      expect(
+        MonitorTemplateUtil.processTemplateString({
+          value: "Pod {{resource.k8s.pod.name}} is throttled",
+          storageMap,
+        }),
+      ).toBe("Pod checkout-7d9f-2xk is throttled");
+    });
+
+    test("the full label map is still exposed for iteration", () => {
+      const storageMap: JSONObject = buildStorageMap({
+        "resource.k8s.pod.name": "web-1",
+      });
+
+      expect(storageMap["seriesLabels"]).toEqual({
+        "resource.k8s.pod.name": "web-1",
+      });
+    });
+
+    test("a prototype-walking label key is still refused", () => {
+      /*
+       * Series label keys are attacker-adjacent (a monitor script picks
+       * them outright via oneuptime.captureMetric). Folding them onto the
+       * storage map must keep refusing __proto__ - and the new variables
+       * must not have introduced a second path that folds them.
+       */
+      const storageMap: JSONObject = buildStorageMap({
+        "__proto__.polluted": "yes",
+      });
+
+      expect(({} as JSONObject)["polluted"]).toBeUndefined();
+      expect(storageMap["seriesResourceSuffix"]).toBeDefined();
+    });
+  });
+});