@oneuptime/common 13.0.5 → 13.0.7

package/UI/Components/TelemetryViewer/components/TelemetryActiveFilterChips.tsx

@@ -3,9 +3,6 @@ import { ActiveFilter } from "../types";
 import Icon from "../../Icon/Icon";
 import IconProp from "../../../../Types/Icon/IconProp";
 import LockedFilterChip from "./LockedFilterChip";
-import LockedFilterActions, {
-  LockedFilterActionOptions,
-} from "./LockedFilterActions";
 import { TelemetrySignal } from "../../../../Utils/Telemetry/LockedFilterSearch";
 
 export interface TelemetryActiveFilterChipsProps {
@@ -14,15 +11,10 @@ export interface TelemetryActiveFilterChipsProps {
   onClearAll: () => void;
   /*
    * Which explorer the read-only chips belong to — names the explorer in the
-   * locked chips' tooltips and in the "Copy filter" / "Open in …" actions.
-   * Without it the chips explain themselves but name no explorer.
+   * locked chips' tooltips. Without it the chips still show their search
+   * syntax but name no explorer.
    */
   signal?: TelemetrySignal | undefined;
-  /*
-   * How the host reproduces its locked scope elsewhere. Rendered after the
-   * read-only chips; nothing is rendered when neither field is set.
-   */
-  lockedFilterActions?: LockedFilterActionOptions | undefined;
 }
 
 const TelemetryActiveFilterChips: FunctionComponent<
@@ -57,14 +49,6 @@ const TelemetryActiveFilterChips: FunctionComponent<
           />
         );
       })}
-      {readOnlyFilters.length > 0 &&
-        props.signal &&
-        props.lockedFilterActions && (
-          <LockedFilterActions
-            signal={props.signal}
-            {...props.lockedFilterActions}
-          />
-        )}
       {removableFilters.map((filter: ActiveFilter) => {
         const chipKey: string = `${filter.facetKey}:${filter.value}`;
         return (

package/UI/Components/TelemetryViewer/types.ts

@@ -26,8 +26,8 @@ export interface ActiveFilter {
   displayValue: string;
   readOnly?: boolean | undefined;
   /*
-   * For a read-only chip: what it matches and why it is locked, rendered as
-   * the chip's tooltip and folded into "Copy filter". Display only.
+   * For a read-only chip: its search syntax (or why there is none), shown in
+   * the chip's tooltip. Display only.
    */
   lockedDetail?: LockedFilterDetail | undefined;
 }

package/UI/Utils/Rules/RuleRunClient.ts

@@ -0,0 +1,178 @@
+import URL from "../../../Types/API/URL";
+import Dictionary from "../../../Types/Dictionary";
+import HTTPErrorResponse from "../../../Types/API/HTTPErrorResponse";
+import HTTPResponse from "../../../Types/API/HTTPResponse";
+import { JSONObject } from "../../../Types/JSON";
+import {
+  MAX_RULE_RUN_PASSES,
+  RuleRunPassResult,
+  RuleRunResult,
+  RuleRunResultUtil,
+  RuleRunType,
+} from "../../../Types/Rules/RuleRun";
+import RuleRunSummary from "../../../Utils/Rules/RuleRunSummary";
+import { APP_API_URL } from "../../Config";
+import API from "../API/API";
+
+/*
+ * The dashboard half of "Run now" for label, owner, privacy and status page
+ * monitor rules.
+ *
+ * The server answers one bounded pass per request. This client chains the
+ * passes, so one press of "Run Rule" covers a project of any ordinary size
+ * while each request stays small - and stops, and says so, after
+ * MAX_RULE_RUN_PASSES rather than looping without end.
+ */
+
+export interface RuleRunOutcome {
+  isSuccess: boolean;
+  /*
+   * The sentence to show, success or not. A failed run is not an exception
+   * here: the modal renders the same message either way, in a different slot.
+   */
+  message: string;
+  // What the run did, including a run that failed part-way. Null when no pass completed.
+  result: RuleRunResult | null;
+}
+
+export interface RunRuleData {
+  ruleType: RuleRunType;
+  ruleId: string;
+  // Owner rules only. Only ever sent as a real boolean.
+  notifyOwners?: boolean | undefined;
+  // The tenantid header in here is what scopes the run to a project.
+  headers?: Dictionary<string> | undefined;
+  // Called after every pass that is not the last, with the totals so far.
+  onProgress?: ((result: RuleRunResult) => void) | undefined;
+  maxPasses?: number | undefined;
+}
+
+export default class RuleRunClient {
+  public static getRunRoute(data: {
+    ruleType: RuleRunType;
+    ruleId: string;
+  }): string {
+    return `/rule-run/${data.ruleType}/${data.ruleId}/run`;
+  }
+
+  public static async run(data: RunRuleData): Promise<RuleRunOutcome> {
+    /*
+     * Without this the request would go to `/…//run`, which matches no route
+     * and comes back as an unhelpful 404 rather than as the real problem.
+     */
+    if (!data.ruleId) {
+      return {
+        isSuccess: false,
+        message: "This rule has no id, so it cannot be run.",
+        result: null,
+      };
+    }
+
+    const maxPasses: number = Math.max(
+      data.maxPasses || MAX_RULE_RUN_PASSES,
+      1,
+    );
+    const passes: Array<RuleRunPassResult> = [];
+    let cursor: string | null = null;
+    let isTruncated: boolean = false;
+
+    const failure: (message: string) => RuleRunOutcome = (
+      message: string,
+    ): RuleRunOutcome => {
+      if (passes.length === 0) {
+        return { isSuccess: false, message: message, result: null };
+      }
+
+      /*
+       * Earlier passes really did change resources. Saying only "failed" would
+       * hide that, and invite a re-run that looks like it did nothing.
+       */
+      const partial: RuleRunResult = RuleRunResultUtil.mergePasses({
+        passes: passes,
+        isTruncated: false,
+      });
+
+      return {
+        isSuccess: false,
+        message: `${message} The run stopped part-way. Before it stopped: ${RuleRunSummary.describe(
+          { ruleType: data.ruleType, result: partial },
+        )}`,
+        result: partial,
+      };
+    };
+
+    try {
+      for (;;) {
+        const body: JSONObject = {
+          notifyOwners: Boolean(data.notifyOwners),
+        };
+
+        if (cursor) {
+          body["cursor"] = cursor;
+        }
+
+        const response: HTTPResponse<JSONObject> | HTTPErrorResponse =
+          await API.post<JSONObject>({
+            url: URL.fromString(APP_API_URL.toString()).addRoute(
+              RuleRunClient.getRunRoute({
+                ruleType: data.ruleType,
+                ruleId: data.ruleId,
+              }),
+            ),
+            data: body,
+            ...(data.headers ? { headers: data.headers } : {}),
+          });
+
+        if (response.isFailure()) {
+          return failure(API.getFriendlyMessage(response));
+        }
+
+        const pass: RuleRunPassResult = RuleRunResultUtil.parsePassResult(
+          (response.data || {}) as JSONObject,
+        );
+
+        passes.push(pass);
+
+        if (!pass.nextCursor) {
+          break;
+        }
+
+        /*
+         * A cursor that does not move would repeat the same pass forever.
+         * Stop and report it as unfinished rather than trust it.
+         */
+        if (pass.nextCursor === cursor || passes.length >= maxPasses) {
+          isTruncated = true;
+          break;
+        }
+
+        cursor = pass.nextCursor;
+
+        if (data.onProgress) {
+          data.onProgress(
+            RuleRunResultUtil.mergePasses({
+              passes: passes,
+              isTruncated: false,
+            }),
+          );
+        }
+      }
+    } catch (err) {
+      return failure(API.getFriendlyMessage(err));
+    }
+
+    const result: RuleRunResult = RuleRunResultUtil.mergePasses({
+      passes: passes,
+      isTruncated: isTruncated,
+    });
+
+    return {
+      isSuccess: true,
+      message: RuleRunSummary.describe({
+        ruleType: data.ruleType,
+        result: result,
+      }),
+      result: result,
+    };
+  }
+}

package/UI/Utils/Telemetry/TelemetryEntityNames.ts

@@ -16,6 +16,7 @@ import RumApplication from "../../../Models/DatabaseModels/RumApplication";
 import ScheduledMaintenance from "../../../Models/DatabaseModels/ScheduledMaintenance";
 import ServerlessFunction from "../../../Models/DatabaseModels/ServerlessFunction";
 import Service from "../../../Models/DatabaseModels/Service";
+import ServiceLevelObjective from "../../../Models/DatabaseModels/ServiceLevelObjective";
 import VMwareVCenter from "../../../Models/DatabaseModels/VMwareVCenter";
 import Includes from "../../../Types/BaseDatabase/Includes";
 import ListResult from "../../../Types/BaseDatabase/ListResult";
@@ -161,6 +162,12 @@ export const TELEMETRY_ENTITY_TYPES: Record<
     modelType: ScheduledMaintenance,
     nameFields: ["title"],
   },
+  // The oneuptime.slo.* series carry the SLO id (SloMetricUtil).
+  [ServiceType.ServiceLevelObjective]: {
+    label: "SLO",
+    modelType: ServiceLevelObjective,
+    nameFields: ["name"],
+  },
   // Unattributed telemetry: the id is the projectId and there is no row.
   [ServiceType.Unknown]: {
     label: "Service",
@@ -193,6 +200,7 @@ export const TELEMETRY_ENTITY_RESOLUTION_ORDER: Array<ServiceType> = [
   ServiceType.Incident,
   ServiceType.Alert,
   ServiceType.ScheduledMaintenance,
+  ServiceType.ServiceLevelObjective,
 ];
 
 // Chip key used for a primaryEntityId chip whose entity is not resolved yet.

package/UI/esbuild-config.js

@@ -11,7 +11,7 @@ const dotenv = require("dotenv");
 function createRefractorCompatibilityPlugin() {
   const candidateRoots = [
     path.resolve(__dirname, "../node_modules/refractor"),
-    path.resolve(__dirname, "../../node_modules/refractor"),
+    path.resolve(__dirname, "../../../node_modules/refractor"),
   ];
 
   const refractorRoot = candidateRoots.find((packagePath) =>
@@ -53,7 +53,7 @@ function createRefractorCompatibilityPlugin() {
 function createMermaidPlugin() {
   const candidateRoots = [
     path.resolve(__dirname, "../node_modules/mermaid"),
-    path.resolve(__dirname, "../../node_modules/mermaid"),
+    path.resolve(__dirname, "../../../node_modules/mermaid"),
   ];
   const mermaidRoot = candidateRoots.find((p) => fs.existsSync(p));
 
@@ -259,7 +259,7 @@ function resolvePackageRoot(packageName) {
     process.cwd(),
     __dirname,
     path.resolve(__dirname, ".."),
-    path.resolve(__dirname, "../.."),
+    path.resolve(__dirname, "../../.."),
   ];
 
   for (const resolutionPath of resolutionPaths) {
@@ -300,7 +300,7 @@ function resolvePackageSubpath(packageName, subpath) {
     process.cwd(),
     __dirname,
     path.resolve(__dirname, ".."),
-    path.resolve(__dirname, "../.."),
+    path.resolve(__dirname, "../../.."),
   ];
 
   for (const resolutionPath of resolutionPaths) {

package/Utils/API.ts

@@ -659,6 +659,7 @@ export default class API {
               options.limitRedirectResponseBody || false,
               method === HTTPMethod.HEAD,
               options.maximumResponseBytes,
+              options.signal,
             );
           }
 
@@ -681,6 +682,7 @@ export default class API {
               options.limitRedirectResponseBody || false,
               method === HTTPMethod.HEAD,
               options.maximumResponseBytes,
+              options.signal,
             );
           }
 
@@ -871,6 +873,7 @@ export default class API {
     limitRedirectResponseBody: boolean,
     isHeadResponse: boolean,
     maximumResponseBytes?: number | undefined,
+    signal?: AbortSignal | undefined,
   ): Promise<unknown> {
     const body: Buffer = await HTTPResponseBodyReader.read(response.data, {
       budget: budget,
@@ -879,6 +882,7 @@ export default class API {
       limitRedirectResponseBody: limitRedirectResponseBody,
       isHeadResponse: isHeadResponse,
       maximumResponseBytes: maximumResponseBytes,
+      signal: signal,
     });
     const text: string = HTTPResponseBodyReader.decodeUtf8(body);
 
@@ -1246,7 +1250,12 @@ export default class API {
     const axiosError: AxiosError | null = axios.isAxiosError(error)
       ? (error as AxiosError)
       : null;
-    const errorCode: string | undefined = axiosError?.code;
+    const nativeErrorCode: unknown =
+      typeof error === "object" && error !== null && "code" in error
+        ? error.code
+        : undefined;
+    const errorCode: string | undefined =
+      typeof nativeErrorCode === "string" ? nativeErrorCode : undefined;
     const rawErrorMessage: string =
       (error as Error)?.message || String(error) || "Unknown error";
 

package/Utils/Dashboard/Components/DashboardSloComponent.ts

@@ -55,10 +55,17 @@ export default class DashboardSloComponentUtil extends DashboardBaseComponentUti
     const componentArguments: Array<ComponentArgument<DashboardSloComponent>> =
       [];
 
+    /*
+     * Neither of the two source arguments is `required` on its own: a widget
+     * is valid with an SLO pinned OR with a variable to follow, and the form
+     * would otherwise refuse to save the second kind. A widget with neither
+     * renders its setup state and makes no request.
+     */
     componentArguments.push({
       name: "Service Level Objective",
-      description: "The SLO this widget reports on",
-      required: true,
+      description:
+        "Pin this widget to one SLO. Leave empty to follow an SLO variable instead.",
+      required: false,
       type: ComponentInputType.EntityDropdown,
       id: "serviceLevelObjectiveId",
       placeholder: "Select an SLO",
@@ -66,6 +73,16 @@ export default class DashboardSloComponentUtil extends DashboardBaseComponentUti
       entityFilterModelType: EntityFilterModelType.ServiceLevelObjective,
     });
 
+    componentArguments.push({
+      name: "Follow SLO Variable",
+      description:
+        "Show whichever SLO is picked in this dashboard variable — a Telemetry Attribute variable on the sloName key. Ignored while an SLO is pinned above. On a public dashboard, viewers can pick any active SLO in the project.",
+      required: false,
+      type: ComponentInputType.TelemetryAttributeVariable,
+      id: "serviceLevelObjectiveVariableId",
+      section: DataSourceSection,
+    });
+
     componentArguments.push({
       name: "Metric",
       description: "Which of the SLO's tracked numbers to show",

package/Utils/Dashboard/Components/DashboardSloListComponent.ts

@@ -0,0 +1,126 @@
+import {
+  ComponentArgument,
+  ComponentArgumentSection,
+  ComponentInputType,
+  EntityFilterModelType,
+} from "../../../Types/Dashboard/DashboardComponents/ComponentArgument";
+import DashboardSloListComponent from "../../../Types/Dashboard/DashboardComponents/DashboardSloListComponent";
+import DashboardComponentType from "../../../Types/Dashboard/DashboardComponentType";
+import { ObjectType } from "../../../Types/JSON";
+import ObjectID from "../../../Types/ObjectID";
+import SloStatus from "../../../Types/ServiceLevelObjective/SloStatus";
+import { DropdownOption } from "../../../UI/Components/Dropdown/Dropdown";
+import {
+  SLO_LIST_DEFAULT_MAX_ROWS,
+  SLO_LIST_STATUS_FILTER_VALUES,
+} from "../../Slo/SloListWidgetFormat";
+import DashboardBaseComponentUtil from "./DashboardBaseComponent";
+import { getViewModeArgument } from "./DashboardListSharedArgs";
+
+const DisplaySection: ComponentArgumentSection = {
+  name: "Display Options",
+  description: "Configure the widget title, row limit and view",
+  order: 1,
+};
+
+const FiltersSection: ComponentArgumentSection = {
+  name: "Filters",
+  description: "Narrow down which SLOs are shown",
+  order: 2,
+  defaultCollapsed: true,
+};
+
+export default class DashboardSloListComponentUtil extends DashboardBaseComponentUtil {
+  public static override getDefaultComponent(): DashboardSloListComponent {
+    return {
+      _type: ObjectType.DashboardComponent,
+      componentType: DashboardComponentType.SloList,
+      /*
+       * Wider than the other list widgets' 6 units: every row carries five
+       * columns — name, status, SLI against target, the error-budget bar and
+       * the burn rate — and the budget bar needs room to be read as a bar.
+       */
+      widthInDashboardUnits: 8,
+      heightInDashboardUnits: 5,
+      topInDashboardUnits: 0,
+      leftInDashboardUnits: 0,
+      componentId: ObjectID.generate(),
+      minHeightInDashboardUnits: 3,
+      minWidthInDashboardUnits: 6,
+      arguments: {
+        maxRows: SLO_LIST_DEFAULT_MAX_ROWS,
+      },
+    };
+  }
+
+  public static override getComponentConfigArguments(): Array<
+    ComponentArgument<DashboardSloListComponent>
+  > {
+    const componentArguments: Array<
+      ComponentArgument<DashboardSloListComponent>
+    > = [];
+
+    componentArguments.push({
+      name: "Title",
+      description: "Header shown above the SLO list",
+      required: false,
+      type: ComponentInputType.Text,
+      id: "title",
+      section: DisplaySection,
+    });
+
+    componentArguments.push({
+      name: "Max Rows",
+      description:
+        "Maximum number of SLOs to show. Enabled SLOs come first, ordered by least error budget remaining, so the SLOs cut off are disabled ones first, then the healthiest.",
+      required: false,
+      type: ComponentInputType.Number,
+      id: "maxRows",
+      placeholder: String(SLO_LIST_DEFAULT_MAX_ROWS),
+      section: DisplaySection,
+    });
+
+    componentArguments.push(
+      getViewModeArgument<DashboardSloListComponent>(DisplaySection),
+    );
+
+    componentArguments.push({
+      name: "Status",
+      description:
+        "Show only enabled SLOs in the selected statuses. Leave empty to show every SLO, including disabled ones and ones not evaluated yet.",
+      required: false,
+      type: ComponentInputType.MultiSelectDropdown,
+      id: "sloStatuses",
+      placeholder: "All statuses",
+      section: FiltersSection,
+      dropdownOptions: SLO_LIST_STATUS_FILTER_VALUES.map(
+        (status: SloStatus): DropdownOption => {
+          return { label: status, value: status };
+        },
+      ),
+    });
+
+    componentArguments.push({
+      name: "Labels",
+      description: "Show only SLOs tagged with the selected labels",
+      required: false,
+      type: ComponentInputType.EntityMultiSelectDropdown,
+      id: "labelIds",
+      placeholder: "All labels",
+      section: FiltersSection,
+      entityFilterModelType: EntityFilterModelType.Label,
+    });
+
+    componentArguments.push({
+      name: "Label Variable",
+      description:
+        "Filter SLOs using a Project Labels dashboard variable. This is combined with the fixed filters above. All removes only the variable filter.",
+      required: false,
+      type: ComponentInputType.ProjectLabelVariable,
+      id: "labelVariableId",
+      section: FiltersSection,
+    });
+
+    return componentArguments;
+  }
+}

package/Utils/Dashboard/Components/Index.ts

@@ -41,6 +41,7 @@ import DashboardProxmoxGuestListComponentUtil from "./DashboardProxmoxGuestListC
 import DashboardSecurityEventsFlowComponentUtil from "./DashboardSecurityEventsFlowComponent";
 import DashboardSecurityEventsListComponentUtil from "./DashboardSecurityEventsListComponent";
 import DashboardSloComponentUtil from "./DashboardSloComponent";
+import DashboardSloListComponentUtil from "./DashboardSloListComponent";
 import DashboardProxmoxNodeListComponentUtil from "./DashboardProxmoxNodeListComponent";
 import DashboardDockerSwarmNodeListComponentUtil from "./DashboardDockerSwarmNodeListComponent";
 import DashboardDockerSwarmServiceListComponentUtil from "./DashboardDockerSwarmServiceListComponent";
@@ -183,6 +184,12 @@ export default class DashboardComponentsUtil {
       >;
     }
 
+    if (dashboardComponentType === DashboardComponentType.SloList) {
+      return DashboardSloListComponentUtil.getComponentConfigArguments() as Array<
+        ComponentArgument<DashboardBaseComponent>
+      >;
+    }
+
     if (dashboardComponentType === DashboardComponentType.KubernetesPodList) {
       return DashboardKubernetesPodListComponentUtil.getComponentConfigArguments() as Array<
         ComponentArgument<DashboardBaseComponent>

package/Utils/Dashboard/HtmlWidgetDocument.ts

@@ -27,7 +27,7 @@ import DashboardVariableInterpolation, {
  * are never emitted together, and getSandboxAttribute() has no input that
  * produces `allow-same-origin`.
  *
- * Internal/Roadmap/SessionReplay.md argues against `allow-scripts` without
+ * Docs/Internal/Roadmap/SessionReplay.md argues against `allow-scripts` without
  * `allow-same-origin`; that conclusion is specific to session replay, where
  * the rrweb Replayer runs in the PARENT and writes into contentDocument, so
  * it needs same-origin access and no script execution. This widget is the