@oneuptime/common 14.0.6 → 14.0.7

package/Server/Services/WorkspaceNotificationSummaryService.ts

@@ -18,6 +18,8 @@ import IncidentStateTimeline from "../../Models/DatabaseModels/IncidentStateTime
 import AlertStateTimeline from "../../Models/DatabaseModels/AlertStateTimeline";
 import Label from "../../Models/DatabaseModels/Label";
 import Monitor from "../../Models/DatabaseModels/Monitor";
+import LinkedAffectedResources from "../Utils/AffectedResources/LinkedAffectedResources";
+import { escapeMarkdownInline } from "../../Utils/Markdown/MarkdownEscape";
 import WorkspaceNotificationLogService from "./WorkspaceNotificationLogService";
 import WorkspaceNotificationStatus from "../../Types/Workspace/WorkspaceNotificationStatus";
 import WorkspaceNotificationActionType from "../../Types/Workspace/WorkspaceNotificationActionType";
@@ -212,6 +214,18 @@ export class Service extends DatabaseService<WorkspaceNotificationSummary> {
     return `[${text}](${url})`;
   }
 
+  /*
+   * Resource names are escaped: a host or cluster name can come from an
+   * agent rather than from someone typing it, and this text is markdown.
+   */
+  private static joinNames(names: Array<string>): string {
+    return names
+      .map((name: string): string => {
+        return escapeMarkdownInline(name);
+      })
+      .join(", ");
+  }
+
   private static formatDuration(totalMinutes: number): string {
     if (totalMinutes < 1) {
       return "< 1m";
@@ -761,20 +775,20 @@ export class Service extends DatabaseService<WorkspaceNotificationSummary> {
     if (
       Service.has(items, WorkspaceNotificationSummaryItem.ResourcesAffected)
     ) {
-      const names: Set<string> = new Set();
-      for (const inc of incidents) {
-        if (inc.monitors) {
-          for (const m of inc.monitors) {
-            if (m.name) {
-              names.add(m.name);
-            }
-          }
-        }
-      }
-      if (names.size > 0) {
+      // Every resource the period's incidents are linked to, not only monitors.
+      const names: Array<string> = LinkedAffectedResources.getNames({
+        resources: await LinkedAffectedResources.readForIncidents({
+          service: IncidentService,
+          projectId,
+          incidentIds: incidents.map((inc: Incident): ObjectID => {
+            return inc.id!;
+          }),
+        }),
+      });
+      if (names.length > 0) {
         blocks.push(
           Service.md(
-            `${Service.bold(`Resources Affected (${names.size}):`)}  ${Array.from(names).join(", ")}`,
+            `${Service.bold(`Resources Affected (${names.length}):`)}  ${Service.joinNames(names)}`,
           ),
         );
       }
@@ -1203,16 +1217,20 @@ export class Service extends DatabaseService<WorkspaceNotificationSummary> {
     if (
       Service.has(items, WorkspaceNotificationSummaryItem.ResourcesAffected)
     ) {
-      const names: Set<string> = new Set();
-      for (const a of alerts) {
-        if (a.monitor?.name) {
-          names.add(a.monitor.name);
-        }
-      }
-      if (names.size > 0) {
+      // Every resource the period's alerts are linked to, not only monitors.
+      const names: Array<string> = LinkedAffectedResources.getNames({
+        resources: await LinkedAffectedResources.readForAlerts({
+          service: AlertService,
+          projectId,
+          alertIds: alerts.map((a: Alert): ObjectID => {
+            return a.id!;
+          }),
+        }),
+      });
+      if (names.length > 0) {
         blocks.push(
           Service.md(
-            `${Service.bold(`Resources Affected (${names.size}):`)}  ${Array.from(names).join(", ")}`,
+            `${Service.bold(`Resources Affected (${names.length}):`)}  ${Service.joinNames(names)}`,
           ),
         );
       }

package/Server/Utils/AffectedResources/LinkedAffectedResources.ts

@@ -0,0 +1,576 @@
+import FindAllBy from "../../Types/Database/FindAllBy";
+import Query from "../../Types/Database/Query";
+import QueryHelper from "../../Types/Database/QueryHelper";
+import Select from "../../Types/Database/Select";
+import Alert from "../../../Models/DatabaseModels/Alert";
+import DatabaseBaseModel from "../../../Models/DatabaseModels/DatabaseBaseModel/DatabaseBaseModel";
+import Incident from "../../../Models/DatabaseModels/Incident";
+import ScheduledMaintenance from "../../../Models/DatabaseModels/ScheduledMaintenance";
+import URL from "../../../Types/API/URL";
+import ObjectID from "../../../Types/ObjectID";
+import { escapeMarkdownInline } from "../../../Utils/Markdown/MarkdownEscape";
+import {
+  getSloAffectedResourceMarkdownLines,
+  SloAffectedResourceLinkSubject,
+} from "../../../Utils/Slo/SloAffectedResourceMarkdown";
+
+/*
+ * What an incident, alert or scheduled maintenance event affects, for the
+ * text the server writes about it: the "Resources Affected" section of its
+ * feed items, the Resources Affected row of its emails, and the workspace
+ * summaries.
+ *
+ * The dashboard's Affected Resources cards (AffectedResourcesDisplay) list
+ * every relation the record carries - monitors, hosts, clusters, container
+ * hosts, databases, services, SLOs. The server used to name the monitors
+ * only, so an SLO burn-rate alert's card named its SLO while its on-call
+ * email read "Resources Affected: No resources identified", and an incident
+ * raised against a host named nothing at all. Every one of those writers now
+ * reads the list from here, so they name what the cards show.
+ *
+ * Reads run as root - an owner or on-call email has no user session behind
+ * it - and are held to the record's own project twice: the record is only
+ * read inside that project, and a related row of any other project is left
+ * out. The write hooks reject cross-project links now, but rows saved before
+ * that check existed may still hold one, and naming it would put another
+ * project's resource into this project's feed, Slack and email.
+ *
+ * The caller hands over the service to read with, and the dashboard URL to
+ * link from. Those services import this module, and the owner-notification
+ * workers' tests replace them wholesale; importing them here would drag the
+ * whole service graph into every one of those suites.
+ */
+
+export enum LinkedAffectedResourceType {
+  Monitor = "Monitor",
+  Host = "Host",
+  KubernetesCluster = "KubernetesCluster",
+  DockerHost = "DockerHost",
+  PodmanHost = "PodmanHost",
+  ProxmoxCluster = "ProxmoxCluster",
+  VMwareVCenter = "VMwareVCenter",
+  CephCluster = "CephCluster",
+  DockerSwarmCluster = "DockerSwarmCluster",
+  IoTFleet = "IoTFleet",
+  DatabaseServer = "DatabaseServer",
+  NetworkSite = "NetworkSite",
+  Service = "Service",
+  ServiceLevelObjective = "ServiceLevelObjective",
+}
+
+export interface LinkedAffectedResource {
+  type: LinkedAffectedResourceType;
+  id: string;
+  name: string;
+}
+
+export interface LinkedAffectedResourceRelation {
+  // The relation column on Incident / Alert / ScheduledMaintenance.
+  column: string;
+  type: LinkedAffectedResourceType;
+  // Leads the feed bullet, e.g. "[Host web-01](...)".
+  label: string;
+  // The dashboard route after `/<projectId>/`, ending just before the id.
+  dashboardRoute: string;
+}
+
+/*
+ * The categories AffectedResourcesDisplay renders, in the order it renders
+ * them, so a feed item lists resources the way the cards beside it do. The
+ * routes are the ones each resource's own getXLinkInDashboard builds (a test
+ * pins every one that exists); IoT fleets and network sites have none on the
+ * server, so theirs follow the dashboard's RouteMap.
+ *
+ * An alert has a single `monitor`; incidents and scheduled maintenance events
+ * have `monitors`. Each record kind is read for the columns its model has.
+ */
+export const LINKED_AFFECTED_RESOURCE_RELATIONS: ReadonlyArray<LinkedAffectedResourceRelation> =
+  [
+    {
+      column: "monitors",
+      type: LinkedAffectedResourceType.Monitor,
+      label: "Monitor",
+      dashboardRoute: "monitors",
+    },
+    {
+      column: "monitor",
+      type: LinkedAffectedResourceType.Monitor,
+      label: "Monitor",
+      dashboardRoute: "monitors",
+    },
+    {
+      column: "hosts",
+      type: LinkedAffectedResourceType.Host,
+      label: "Host",
+      dashboardRoute: "host",
+    },
+    {
+      column: "kubernetesClusters",
+      type: LinkedAffectedResourceType.KubernetesCluster,
+      label: "Kubernetes Cluster",
+      dashboardRoute: "kubernetes",
+    },
+    {
+      column: "dockerHosts",
+      type: LinkedAffectedResourceType.DockerHost,
+      label: "Docker Host",
+      dashboardRoute: "docker",
+    },
+    {
+      column: "podmanHosts",
+      type: LinkedAffectedResourceType.PodmanHost,
+      label: "Podman Host",
+      dashboardRoute: "podman",
+    },
+    {
+      column: "proxmoxClusters",
+      type: LinkedAffectedResourceType.ProxmoxCluster,
+      label: "Proxmox Cluster",
+      dashboardRoute: "proxmox",
+    },
+    {
+      column: "vmwareVCenters",
+      type: LinkedAffectedResourceType.VMwareVCenter,
+      label: "VMware vCenter",
+      dashboardRoute: "vmware",
+    },
+    {
+      column: "cephClusters",
+      type: LinkedAffectedResourceType.CephCluster,
+      label: "Ceph Cluster",
+      dashboardRoute: "ceph",
+    },
+    {
+      column: "dockerSwarmClusters",
+      type: LinkedAffectedResourceType.DockerSwarmCluster,
+      label: "Docker Swarm Cluster",
+      dashboardRoute: "docker-swarm",
+    },
+    {
+      column: "iotFleets",
+      type: LinkedAffectedResourceType.IoTFleet,
+      label: "IoT Fleet",
+      dashboardRoute: "iot",
+    },
+    {
+      column: "databaseServers",
+      type: LinkedAffectedResourceType.DatabaseServer,
+      label: "Database",
+      dashboardRoute: "databases",
+    },
+    {
+      column: "networkSites",
+      type: LinkedAffectedResourceType.NetworkSite,
+      label: "Network Site",
+      dashboardRoute: "network-sites/view",
+    },
+    {
+      column: "services",
+      type: LinkedAffectedResourceType.Service,
+      label: "Service",
+      dashboardRoute: "service",
+    },
+    /*
+     * Last, as on the cards: an SLO is the objective measured over the
+     * resources above it rather than one of them.
+     */
+    {
+      column: "serviceLevelObjectives",
+      type: LinkedAffectedResourceType.ServiceLevelObjective,
+      label: "SLO",
+      dashboardRoute: "slos",
+    },
+  ];
+
+// Structural, so a model instance and a plain relation row both fit.
+interface RelatedRow {
+  _id?: string | ObjectID | undefined | null;
+  name?: string | undefined | null;
+  projectId?: ObjectID | string | undefined | null;
+}
+
+type RecordWithRelations = {
+  projectId?: ObjectID | string | undefined | null;
+} & Partial<Record<string, unknown>>;
+
+// The one method read here - IncidentService, AlertService and so on.
+export interface LinkedAffectedResourceReader<
+  TBaseModel extends DatabaseBaseModel,
+> {
+  findAllBy(findAllBy: FindAllBy<TBaseModel>): Promise<Array<TBaseModel>>;
+}
+
+function isSameProject(
+  projectId: ObjectID | string | undefined | null,
+  expected: ObjectID,
+): boolean {
+  if (!projectId) {
+    return false;
+  }
+
+  return (
+    projectId.toString().trim().toLowerCase() ===
+    expected.toString().trim().toLowerCase()
+  );
+}
+
+export default class LinkedAffectedResources {
+  // The relations `model` carries, in display order.
+  public static getRelations(
+    model: DatabaseBaseModel,
+  ): Array<LinkedAffectedResourceRelation> {
+    return LINKED_AFFECTED_RESOURCE_RELATIONS.filter(
+      (relation: LinkedAffectedResourceRelation) => {
+        return model.hasColumn(relation.column);
+      },
+    );
+  }
+
+  public static async readForIncident(data: {
+    service: LinkedAffectedResourceReader<Incident>;
+    projectId: ObjectID;
+    incidentId: ObjectID;
+  }): Promise<Array<LinkedAffectedResource>> {
+    return await LinkedAffectedResources.readForIncidents({
+      service: data.service,
+      projectId: data.projectId,
+      incidentIds: [data.incidentId],
+    });
+  }
+
+  public static async readForIncidents(data: {
+    service: LinkedAffectedResourceReader<Incident>;
+    projectId: ObjectID;
+    incidentIds: Array<ObjectID>;
+  }): Promise<Array<LinkedAffectedResource>> {
+    return await LinkedAffectedResources.read({
+      service: data.service,
+      model: new Incident(),
+      projectId: data.projectId,
+      recordIds: data.incidentIds,
+    });
+  }
+
+  public static async readForAlert(data: {
+    service: LinkedAffectedResourceReader<Alert>;
+    projectId: ObjectID;
+    alertId: ObjectID;
+  }): Promise<Array<LinkedAffectedResource>> {
+    return await LinkedAffectedResources.readForAlerts({
+      service: data.service,
+      projectId: data.projectId,
+      alertIds: [data.alertId],
+    });
+  }
+
+  public static async readForAlerts(data: {
+    service: LinkedAffectedResourceReader<Alert>;
+    projectId: ObjectID;
+    alertIds: Array<ObjectID>;
+  }): Promise<Array<LinkedAffectedResource>> {
+    return await LinkedAffectedResources.read({
+      service: data.service,
+      model: new Alert(),
+      projectId: data.projectId,
+      recordIds: data.alertIds,
+    });
+  }
+
+  public static async readForScheduledMaintenance(data: {
+    service: LinkedAffectedResourceReader<ScheduledMaintenance>;
+    projectId: ObjectID;
+    scheduledMaintenanceId: ObjectID;
+  }): Promise<Array<LinkedAffectedResource>> {
+    return await LinkedAffectedResources.read({
+      service: data.service,
+      model: new ScheduledMaintenance(),
+      projectId: data.projectId,
+      recordIds: [data.scheduledMaintenanceId],
+    });
+  }
+
+  /*
+   * The resources linked to any of `recordIds`, merged into one list.
+   *
+   * One query per relation rather than one query selecting them all: the
+   * relations are many-to-many, and joining a dozen of them at once returns
+   * the product of their sizes - an incident on 50 monitors and 50 hosts
+   * would come back as 2,500 rows. Read one at a time, the rows add up.
+   */
+  private static async read<TBaseModel extends DatabaseBaseModel>(data: {
+    service: LinkedAffectedResourceReader<TBaseModel>;
+    model: TBaseModel;
+    projectId: ObjectID;
+    recordIds: Array<ObjectID>;
+  }): Promise<Array<LinkedAffectedResource>> {
+    const recordIds: Array<ObjectID> = [];
+    const seenRecordIds: Set<string> = new Set<string>();
+
+    for (const recordId of data.recordIds) {
+      const key: string = recordId?.toString() || "";
+
+      if (!key || seenRecordIds.has(key)) {
+        continue;
+      }
+
+      seenRecordIds.add(key);
+      recordIds.push(recordId);
+    }
+
+    if (recordIds.length === 0) {
+      return [];
+    }
+
+    const rowsPerRelation: Array<Array<TBaseModel> | undefined> =
+      await Promise.all(
+        LinkedAffectedResources.getRelations(data.model).map(
+          (
+            relation: LinkedAffectedResourceRelation,
+          ): Promise<Array<TBaseModel>> => {
+            return data.service.findAllBy({
+              query: {
+                _id: QueryHelper.any(recordIds),
+                projectId: data.projectId,
+              } as unknown as Query<TBaseModel>,
+              select: {
+                _id: true,
+                projectId: true,
+                [relation.column]: {
+                  _id: true,
+                  name: true,
+                  projectId: true,
+                },
+              } as unknown as Select<TBaseModel>,
+              props: {
+                isRoot: true,
+              },
+            });
+          },
+        ),
+      );
+
+    return LinkedAffectedResources.collect({
+      projectId: data.projectId,
+      records: rowsPerRelation.flatMap(
+        (rows: Array<TBaseModel> | undefined): Array<TBaseModel> => {
+          return rows || [];
+        },
+      ) as unknown as Array<RecordWithRelations>,
+    });
+  }
+
+  /*
+   * The resources on already-read records, in display order and without
+   * repeats. A related row is kept only when it has an id and belongs to
+   * `projectId`; a row whose project was not read cannot be shown to belong
+   * here, so it is left out too - which also makes a caller that drops
+   * projectId from its select fail loudly in tests rather than quietly
+   * print nothing.
+   */
+  public static collect(data: {
+    projectId: ObjectID;
+    records: Array<RecordWithRelations | null | undefined>;
+  }): Array<LinkedAffectedResource> {
+    const resources: Array<LinkedAffectedResource> = [];
+    const seen: Set<string> = new Set<string>();
+
+    const records: Array<RecordWithRelations> = data.records.filter(
+      (record: RecordWithRelations | null | undefined): boolean => {
+        if (!record) {
+          return false;
+        }
+
+        // A record read without its project is taken to be the caller's.
+        return (
+          !record.projectId || isSameProject(record.projectId, data.projectId)
+        );
+      },
+    ) as Array<RecordWithRelations>;
+
+    for (const relation of LINKED_AFFECTED_RESOURCE_RELATIONS) {
+      for (const record of records) {
+        const value: unknown = record[relation.column];
+
+        const rows: Array<RelatedRow | null | undefined> = Array.isArray(value)
+          ? (value as Array<RelatedRow | null | undefined>)
+          : value
+            ? [value as RelatedRow]
+            : [];
+
+        for (const row of rows) {
+          const id: string = row?._id?.toString() || "";
+
+          if (!row || !id || !isSameProject(row.projectId, data.projectId)) {
+            continue;
+          }
+
+          const key: string = `${relation.type}:${id}`;
+
+          if (seen.has(key)) {
+            continue;
+          }
+
+          seen.add(key);
+
+          resources.push({
+            type: relation.type,
+            id: id,
+            name: row.name?.toString() || "",
+          });
+        }
+      }
+    }
+
+    return resources;
+  }
+
+  /*
+   * The names, for plain-text surfaces: emails and workspace summaries.
+   *
+   * `seriesSummary` is an alert's series identity - the pod or container a
+   * grouped monitor raised it for (SeriesLabelDisplay.buildInlineSummary).
+   * It names what broke more precisely than the monitor does, so it takes
+   * the monitor's place at the head of the list rather than joining it.
+   *
+   * A name that repeats (a monitor and a host both called "web-01") is
+   * printed once: this is a sentence, not a table.
+   */
+  public static getNames(data: {
+    resources: Array<LinkedAffectedResource>;
+    seriesSummary?: string | undefined;
+  }): Array<string> {
+    const names: Array<string> = [];
+    const seenNames: Set<string> = new Set<string>();
+    const seriesSummary: string = data.seriesSummary?.trim() || "";
+
+    const addName: (name: string) => void = (name: string): void => {
+      const trimmed: string = name.trim();
+
+      if (!trimmed || seenNames.has(trimmed)) {
+        return;
+      }
+
+      seenNames.add(trimmed);
+      names.push(trimmed);
+    };
+
+    addName(seriesSummary);
+
+    for (const resource of data.resources) {
+      if (
+        seriesSummary &&
+        resource.type === LinkedAffectedResourceType.Monitor
+      ) {
+        continue;
+      }
+
+      addName(resource.name);
+    }
+
+    return names;
+  }
+
+  // getNames joined with ", ", or `fallback` when there are none.
+  public static getText(data: {
+    resources: Array<LinkedAffectedResource>;
+    seriesSummary?: string | undefined;
+    fallback: string;
+  }): string {
+    return (
+      LinkedAffectedResources.getNames({
+        resources: data.resources,
+        seriesSummary: data.seriesSummary,
+      }).join(", ") || data.fallback
+    );
+  }
+
+  public static getDashboardUrl(data: {
+    dashboardUrl: URL;
+    projectId: ObjectID;
+    resource: LinkedAffectedResource;
+  }): URL {
+    const relation: LinkedAffectedResourceRelation =
+      LinkedAffectedResources.getRelationForType(data.resource.type);
+
+    // URL.addRoute mutates, and the caller reuses its dashboard URL.
+    return URL.fromString(data.dashboardUrl.toString()).addRoute(
+      `/${data.projectId.toString()}/${relation.dashboardRoute}/${data.resource.id}`,
+    );
+  }
+
+  /*
+   * The bullets under a feed item's "🌎 Resources Affected" header.
+   *
+   * A monitor keeps the bullet the created feeds have always printed,
+   * `- [<name>](<monitor link>)`, and an SLO keeps `- [SLO <name>](<link>)`
+   * from getSloAffectedResourceMarkdownLines. Every other resource follows
+   * the SLO's shape, `- [Host <name>](<link>)`, so the reader can tell a host
+   * from a cluster from a service.
+   *
+   * Those names are escaped: feeds render without safe mode and the same
+   * markdown goes to Slack and Teams, and a host or cluster name can come
+   * from an agent rather than from someone typing it.
+   */
+  public static getMarkdownLines(data: {
+    dashboardUrl: URL;
+    projectId: ObjectID;
+    resources: Array<LinkedAffectedResource>;
+  }): Array<string> {
+    const lines: Array<string> = [];
+    const slos: Array<SloAffectedResourceLinkSubject> = [];
+
+    for (const resource of data.resources) {
+      if (resource.type === LinkedAffectedResourceType.ServiceLevelObjective) {
+        slos.push({
+          _id: resource.id,
+          name: resource.name,
+          // Already held to this project by collect.
+          projectId: data.projectId,
+        });
+        continue;
+      }
+
+      const link: string = LinkedAffectedResources.getDashboardUrl({
+        dashboardUrl: data.dashboardUrl,
+        projectId: data.projectId,
+        resource: resource,
+      }).toString();
+
+      if (resource.type === LinkedAffectedResourceType.Monitor) {
+        lines.push(`- [${resource.name}](${link})`);
+        continue;
+      }
+
+      const label: string = LinkedAffectedResources.getRelationForType(
+        resource.type,
+      ).label;
+      const escapedName: string = escapeMarkdownInline(resource.name).trim();
+
+      lines.push(
+        `- [${escapedName ? `${label} ${escapedName}` : label}](${link})`,
+      );
+    }
+
+    // SLOs are last in the table, so appending them keeps the order.
+    lines.push(
+      ...getSloAffectedResourceMarkdownLines({
+        dashboardUrl: data.dashboardUrl,
+        projectId: data.projectId,
+        serviceLevelObjectives: slos,
+      }),
+    );
+
+    return lines;
+  }
+
+  private static getRelationForType(
+    type: LinkedAffectedResourceType,
+  ): LinkedAffectedResourceRelation {
+    // Every type has at least one entry, so this always finds one.
+    return LINKED_AFFECTED_RESOURCE_RELATIONS.find(
+      (relation: LinkedAffectedResourceRelation) => {
+        return relation.type === type;
+      },
+    )!;
+  }
+}