@oneuptime/common 11.6.1 → 11.7.0

package/build/dist/Utils/Slo/SloWidgetFormat.js

@@ -0,0 +1,174 @@
+import AggregationInterval from "../../Types/BaseDatabase/AggregationInterval";
+import { SloWidgetMetric } from "../../Types/Dashboard/DashboardComponents/DashboardSloComponent";
+/**
+ * Pure value/label derivation for the dashboard SLO widget.
+ *
+ * Everything the widget needs to turn a ServiceLevelObjective row into
+ * display strings lives here rather than in the React renderer, so the
+ * formatting rules (and every null / negative / rounding edge) are
+ * unit-testable without a DOM.
+ *
+ * The worker-maintained state columns on ServiceLevelObjective are NULL
+ * until the SLO is first evaluated, so every entry point must be able to
+ * answer "not evaluated yet" instead of rendering "null%" or "NaN%".
+ */
+/** Shown in place of a number whenever the SLO has no evaluated state. */
+export const SLO_NOT_EVALUATED_TEXT = "Not evaluated yet";
+/** U+2212 MINUS SIGN — reads as a minus rather than a hyphen at tile sizes. */
+const MINUS_SIGN = "−";
+/** U+00D7 MULTIPLICATION SIGN — burn rate is a multiplier ("3.2×"). */
+const MULTIPLICATION_SIGN = "×";
+const toFiniteNumber = (value) => {
+    if (typeof value !== "number" || !isFinite(value)) {
+        return null;
+    }
+    return value;
+};
+const roundToDecimals = (value, maxDecimals) => {
+    const factor = Math.pow(10, maxDecimals);
+    /*
+     * `+ 0` normalises -0 (which Math.round can produce from a tiny
+     * negative) so it never renders as "-0".
+     */
+    return Math.round(value * factor) / factor + 0;
+};
+/**
+ * SLI is quoted to three decimals to match the SLO pages — the digits
+ * past the second matter at 99.99x targets. Error budget remaining is a
+ * coarse gauge, so one decimal is enough; the precise number lives in the
+ * seconds subline.
+ */
+const SLI_DECIMALS = 3;
+const BUDGET_PERCENT_DECIMALS = 1;
+const BURN_RATE_DECIMALS = 2;
+export const formatSloPercent = (value, maxDecimals) => {
+    const numericValue = toFiniteNumber(value);
+    if (numericValue === null) {
+        return null;
+    }
+    return `${roundToDecimals(numericValue, maxDecimals !== null && maxDecimals !== void 0 ? maxDecimals : SLI_DECIMALS)}%`;
+};
+export const formatSloBurnRate = (value) => {
+    const numericValue = toFiniteNumber(value);
+    if (numericValue === null) {
+        return null;
+    }
+    return `${roundToDecimals(numericValue, BURN_RATE_DECIMALS)}${MULTIPLICATION_SIGN}`;
+};
+export const formatErrorBudgetRemainingSeconds = (seconds) => {
+    const numericSeconds = toFiniteNumber(seconds);
+    if (numericSeconds === null) {
+        return null;
+    }
+    const isOverBudget = numericSeconds < 0;
+    const suffix = isOverBudget ? "over budget" : "remaining";
+    const minutes = Math.round(Math.abs(numericSeconds) / 60);
+    if (minutes === 0) {
+        /*
+         * Exactly zero is a real state worth stating; a sub-30-second
+         * remainder would otherwise round to a misleading "0 min".
+         */
+        if (numericSeconds === 0) {
+            return `0 min ${suffix}`;
+        }
+        return `under 1 min ${suffix}`;
+    }
+    return `${isOverBudget ? MINUS_SIGN : ""}${minutes} min ${suffix}`;
+};
+export const getSloMetricLabel = (sloMetric) => {
+    if (sloMetric === SloWidgetMetric.ErrorBudgetRemaining) {
+        return "Error Budget Remaining";
+    }
+    if (sloMetric === SloWidgetMetric.BurnRate) {
+        return "Burn Rate";
+    }
+    // Sli is the default metric, so it is also the fallback label.
+    return "SLI";
+};
+export const getSloHistoryMetricName = (sloMetric) => {
+    if (sloMetric === SloWidgetMetric.ErrorBudgetRemaining) {
+        return "error.budget.remaining.percent";
+    }
+    if (sloMetric === SloWidgetMetric.BurnRate) {
+        return "burn.rate";
+    }
+    return "sli.percent";
+};
+export const getSloWidgetTitle = (data) => {
+    const trimmedTitle = (data.widgetTitle || "").trim();
+    if (trimmedTitle) {
+        return trimmedTitle;
+    }
+    const metricLabel = getSloMetricLabel(data.sloMetric);
+    const trimmedName = (data.sloName || "").trim();
+    if (!trimmedName) {
+        return metricLabel;
+    }
+    return `${trimmedName} · ${metricLabel}`;
+};
+export const getSloWidgetTileDisplay = (data) => {
+    const notEvaluated = {
+        isEvaluated: false,
+        value: SLO_NOT_EVALUATED_TEXT,
+        subline: null,
+    };
+    const slo = data.slo;
+    if (!slo) {
+        return notEvaluated;
+    }
+    if (data.sloMetric === SloWidgetMetric.ErrorBudgetRemaining) {
+        const value = formatSloPercent(slo.errorBudgetRemainingPercentage, BUDGET_PERCENT_DECIMALS);
+        if (value === null) {
+            return notEvaluated;
+        }
+        return {
+            isEvaluated: true,
+            value: value,
+            subline: formatErrorBudgetRemainingSeconds(slo.errorBudgetRemainingSeconds),
+        };
+    }
+    if (data.sloMetric === SloWidgetMetric.BurnRate) {
+        const value = formatSloBurnRate(slo.currentBurnRate);
+        if (value === null) {
+            return notEvaluated;
+        }
+        return {
+            isEvaluated: true,
+            value: value,
+            subline: null,
+        };
+    }
+    // Sli (also the default when the argument was never set).
+    const value = formatSloPercent(slo.currentSliPercentage, SLI_DECIMALS);
+    if (value === null) {
+        return notEvaluated;
+    }
+    const target = formatSloPercent(slo.targetPercentage, SLI_DECIMALS);
+    return {
+        isEvaluated: true,
+        value: value,
+        subline: target === null ? null : `target ${target}`,
+    };
+};
+export const getSloChartAggregationInterval = (rangeInMinutes) => {
+    if (!isFinite(rangeInMinutes) || rangeInMinutes <= 12 * 60) {
+        return AggregationInterval.FiveMinutes;
+    }
+    if (rangeInMinutes <= 3 * 24 * 60) {
+        return AggregationInterval.ThirtyMinutes;
+    }
+    if (rangeInMinutes <= 45 * 24 * 60) {
+        return AggregationInterval.Hour;
+    }
+    return AggregationInterval.Day;
+};
+export const formatSloChartValue = (sloMetric, value) => {
+    if (sloMetric === SloWidgetMetric.BurnRate) {
+        return formatSloBurnRate(value) || "";
+    }
+    if (sloMetric === SloWidgetMetric.ErrorBudgetRemaining) {
+        return formatSloPercent(value, BUDGET_PERCENT_DECIMALS) || "";
+    }
+    return formatSloPercent(value, SLI_DECIMALS) || "";
+};
+//# sourceMappingURL=SloWidgetFormat.js.map

package/build/dist/Utils/Slo/SloWidgetFormat.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SloWidgetFormat.js","sourceRoot":"","sources":["../../../../Utils/Slo/SloWidgetFormat.ts"],"names":[],"mappings":"AAAA,OAAO,mBAAmB,MAAM,8CAA8C,CAAC;AAC/E,OAAO,EAAE,eAAe,EAAE,MAAM,iEAAiE,CAAC;AAGlG;;;;;;;;;;;GAWG;AAEH,0EAA0E;AAC1E,MAAM,CAAC,MAAM,sBAAsB,GAAW,mBAAmB,CAAC;AAElE,+EAA+E;AAC/E,MAAM,UAAU,GAAW,GAAG,CAAC;AAE/B,uEAAuE;AACvE,MAAM,mBAAmB,GAAW,GAAG,CAAC;AAsCxC,MAAM,cAAc,GAA2B,CAC7C,KAAgC,EACjB,EAAE;IACjB,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QAClD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AASF,MAAM,eAAe,GAA4B,CAC/C,KAAa,EACb,WAAmB,EACX,EAAE;IACV,MAAM,MAAM,GAAW,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,WAAW,CAAC,CAAC;IAEjD;;;OAGG;IACH,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,MAAM,CAAC,GAAG,MAAM,GAAG,CAAC,CAAC;AACjD,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,YAAY,GAAW,CAAC,CAAC;AAC/B,MAAM,uBAAuB,GAAW,CAAC,CAAC;AAC1C,MAAM,kBAAkB,GAAW,CAAC,CAAC;AAOrC,MAAM,CAAC,MAAM,gBAAgB,GAA6B,CACxD,KAAgC,EAChC,WAAgC,EACjB,EAAE;IACjB,MAAM,YAAY,GAAkB,cAAc,CAAC,KAAK,CAAC,CAAC;IAE1D,IAAI,YAAY,KAAK,IAAI,EAAE,CAAC;QAC1B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,OAAO,GAAG,eAAe,CAAC,YAAY,EAAE,WAAW,aAAX,WAAW,cAAX,WAAW,GAAI,YAAY,CAAC,GAAG,CAAC;AAC1E,CAAC,CAAC;AAMF,MAAM,CAAC,MAAM,iBAAiB,GAA8B,CAC1D,KAAgC,EACjB,EAAE;IACjB,MAAM,YAAY,GAAkB,cAAc,CAAC,KAAK,CAAC,CAAC;IAE1D,IAAI,YAAY,KAAK,IAAI,EAAE,CAAC;QAC1B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,OAAO,GAAG,eAAe,CAAC,YAAY,EAAE,kBAAkB,CAAC,GAAG,mBAAmB,EAAE,CAAC;AACtF,CAAC,CAAC;AAWF,MAAM,CAAC,MAAM,iCAAiC,GAC5C,CAAC,OAAkC,EAAiB,EAAE;IACpD,MAAM,cAAc,GAAkB,cAAc,CAAC,OAAO,CAAC,CAAC;IAE9D,IAAI,cAAc,KAAK,IAAI,EAAE,CAAC;QAC5B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,YAAY,GAAY,cAAc,GAAG,CAAC,CAAC;IACjD,MAAM,MAAM,GAAW,YAAY,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,WAAW,CAAC;IAClE,MAAM,OAAO,GAAW,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,cAAc,CAAC,GAAG,EAAE,CAAC,CAAC;IAElE,IAAI,OAAO,KAAK,CAAC,EAAE,CAAC;QAClB;;;WAGG;QACH,IAAI,cAAc,KAAK,CAAC,EAAE,CAAC;YACzB,OAAO,SAAS,MAAM,EAAE,CAAC;QAC3B,CAAC;QAED,OAAO,eAAe,MAAM,EAAE,CAAC;IACjC,CAAC;IAED,OAAO,GAAG,YAAY,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,GAAG,OAAO,QAAQ,MAAM,EAAE,CAAC;AACrE,CAAC,CAAC;AAMJ,MAAM,CAAC,MAAM,iBAAiB,GAA8B,CAC1D,SAA6C,EACrC,EAAE;IACV,IAAI,SAAS,KAAK,eAAe,CAAC,oBAAoB,EAAE,CAAC;QACvD,OAAO,wBAAwB,CAAC;IAClC,CAAC;IAED,IAAI,SAAS,KAAK,eAAe,CAAC,QAAQ,EAAE,CAAC;QAC3C,OAAO,WAAW,CAAC;IACrB,CAAC;IAED,+DAA+D;IAC/D,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAUF,MAAM,CAAC,MAAM,uBAAuB,GAAoC,CACtE,SAA6C,EACrC,EAAE;IACV,IAAI,SAAS,KAAK,eAAe,CAAC,oBAAoB,EAAE,CAAC;QACvD,OAAO,gCAAgC,CAAC;IAC1C,CAAC;IAED,IAAI,SAAS,KAAK,eAAe,CAAC,QAAQ,EAAE,CAAC;QAC3C,OAAO,WAAW,CAAC;IACrB,CAAC;IAED,OAAO,aAAa,CAAC;AACvB,CAAC,CAAC;AAaF,MAAM,CAAC,MAAM,iBAAiB,GAA8B,CAAC,IAI5D,EAAU,EAAE;IACX,MAAM,YAAY,GAAW,CAAC,IAAI,CAAC,WAAW,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;IAE7D,IAAI,YAAY,EAAE,CAAC;QACjB,OAAO,YAAY,CAAC;IACtB,CAAC;IAED,MAAM,WAAW,GAAW,iBAAiB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IAC9D,MAAM,WAAW,GAAW,CAAC,IAAI,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;IAExD,IAAI,CAAC,WAAW,EAAE,CAAC;QACjB,OAAO,WAAW,CAAC;IACrB,CAAC;IAED,OAAO,GAAG,WAAW,MAAM,WAAW,EAAE,CAAC;AAC3C,CAAC,CAAC;AAYF,MAAM,CAAC,MAAM,uBAAuB,GAAoC,CAAC,IAGxE,EAAwB,EAAE;IACzB,MAAM,YAAY,GAAyB;QACzC,WAAW,EAAE,KAAK;QAClB,KAAK,EAAE,sBAAsB;QAC7B,OAAO,EAAE,IAAI;KACd,CAAC;IAEF,MAAM,GAAG,GAA0C,IAAI,CAAC,GAAG,CAAC;IAE5D,IAAI,CAAC,GAAG,EAAE,CAAC;QACT,OAAO,YAAY,CAAC;IACtB,CAAC;IAED,IAAI,IAAI,CAAC,SAAS,KAAK,eAAe,CAAC,oBAAoB,EAAE,CAAC;QAC5D,MAAM,KAAK,GAAkB,gBAAgB,CAC3C,GAAG,CAAC,8BAA8B,EAClC,uBAAuB,CACxB,CAAC;QAEF,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;YACnB,OAAO,YAAY,CAAC;QACtB,CAAC;QAED,OAAO;YACL,WAAW,EAAE,IAAI;YACjB,KAAK,EAAE,KAAK;YACZ,OAAO,EAAE,iCAAiC,CACxC,GAAG,CAAC,2BAA2B,CAChC;SACF,CAAC;IACJ,CAAC;IAED,IAAI,IAAI,CAAC,SAAS,KAAK,eAAe,CAAC,QAAQ,EAAE,CAAC;QAChD,MAAM,KAAK,GAAkB,iBAAiB,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;QAEpE,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;YACnB,OAAO,YAAY,CAAC;QACtB,CAAC;QAED,OAAO;YACL,WAAW,EAAE,IAAI;YACjB,KAAK,EAAE,KAAK;YACZ,OAAO,EAAE,IAAI;SACd,CAAC;IACJ,CAAC;IAED,0DAA0D;IAC1D,MAAM,KAAK,GAAkB,gBAAgB,CAC3C,GAAG,CAAC,oBAAoB,EACxB,YAAY,CACb,CAAC;IAEF,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;QACnB,OAAO,YAAY,CAAC;IACtB,CAAC;IAED,MAAM,MAAM,GAAkB,gBAAgB,CAC5C,GAAG,CAAC,gBAAgB,EACpB,YAAY,CACb,CAAC;IAEF,OAAO;QACL,WAAW,EAAE,IAAI;QACjB,KAAK,EAAE,KAAK;QACZ,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,UAAU,MAAM,EAAE;KACrD,CAAC;AACJ,CAAC,CAAC;AAkBF,MAAM,CAAC,MAAM,8BAA8B,GACzC,CAAC,cAAsB,EAAuB,EAAE;IAC9C,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,IAAI,cAAc,IAAI,EAAE,GAAG,EAAE,EAAE,CAAC;QAC3D,OAAO,mBAAmB,CAAC,WAAW,CAAC;IACzC,CAAC;IAED,IAAI,cAAc,IAAI,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC;QAClC,OAAO,mBAAmB,CAAC,aAAa,CAAC;IAC3C,CAAC;IAED,IAAI,cAAc,IAAI,EAAE,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC;QACnC,OAAO,mBAAmB,CAAC,IAAI,CAAC;IAClC,CAAC;IAED,OAAO,mBAAmB,CAAC,GAAG,CAAC;AACjC,CAAC,CAAC;AAYJ,MAAM,CAAC,MAAM,mBAAmB,GAAgC,CAC9D,SAA6C,EAC7C,KAAa,EACL,EAAE;IACV,IAAI,SAAS,KAAK,eAAe,CAAC,QAAQ,EAAE,CAAC;QAC3C,OAAO,iBAAiB,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;IACxC,CAAC;IAED,IAAI,SAAS,KAAK,eAAe,CAAC,oBAAoB,EAAE,CAAC;QACvD,OAAO,gBAAgB,CAAC,KAAK,EAAE,uBAAuB,CAAC,IAAI,EAAE,CAAC;IAChE,CAAC;IAED,OAAO,gBAAgB,CAAC,KAAK,EAAE,YAAY,CAAC,IAAI,EAAE,CAAC;AACrD,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oneuptime/common",
-  "version": "11.6.1",
+  "version": "11.7.0",
   "description": "",
   "repository": {
     "type": "git",
@@ -8,7 +8,7 @@
   },
   "main": "index.js",
   "scripts": {
-    "test": "cd .. && export $(grep -v '^#' config.env | xargs) && cd Common && node node_modules/.bin/jest --runInBand ./Tests --detectOpenHandles",
+    "test": "cd .. && export $(grep -v '^#' config.env | xargs) && cd Common && node --max-old-space-size=6144 node_modules/.bin/jest --runInBand ./Tests --detectOpenHandles",
     "test-file": "cd .. && export $(grep -v '^#' config.env | xargs) && cd Common && node node_modules/.bin/jest --runInBand $1 --detectOpenHandles",
     "coverage": "jest --detectOpenHandles --coverage",
     "compile": "tsc",

package/Types/Dashboard/DashboardComponents/Index.ts

@@ -1,7 +0,0 @@
-enum DashboardComponentType {
-  Chart = "Chart",
-  Value = "Value",
-  Text = "Text",
-}
-
-export default DashboardComponentType;

package/build/dist/Types/Dashboard/DashboardComponents/Index.js

@@ -1,8 +0,0 @@
-var DashboardComponentType;
-(function (DashboardComponentType) {
-    DashboardComponentType["Chart"] = "Chart";
-    DashboardComponentType["Value"] = "Value";
-    DashboardComponentType["Text"] = "Text";
-})(DashboardComponentType || (DashboardComponentType = {}));
-export default DashboardComponentType;
-//# sourceMappingURL=Index.js.map

package/build/dist/Types/Dashboard/DashboardComponents/Index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"Index.js","sourceRoot":"","sources":["../../../../../Types/Dashboard/DashboardComponents/Index.ts"],"names":[],"mappings":"AAAA,IAAK,sBAIJ;AAJD,WAAK,sBAAsB;IACzB,yCAAe,CAAA;IACf,yCAAe,CAAA;IACf,uCAAa,CAAA;AACf,CAAC,EAJI,sBAAsB,KAAtB,sBAAsB,QAI1B;AAED,eAAe,sBAAsB,CAAC"}