@oneuptime/common 13.0.1 → 13.0.4

package/Server/Services/LabelService.ts

@@ -125,7 +125,7 @@ export class Service extends DatabaseService<Model> {
             return Boolean(id);
           });
 
-        const statusPageMonitorRules: Array<StatusPageMonitorRule> =
+        const legacyStatusPageMonitorRules: Array<StatusPageMonitorRule> =
           await StatusPageMonitorRuleService.findBy({
             query: {
               monitorLabels: labelIds,
@@ -140,13 +140,56 @@ export class Service extends DatabaseService<Model> {
             },
           });
 
-        statusPageMonitorRuleIds = statusPageMonitorRules
-          .map((rule: StatusPageMonitorRule) => {
-            return rule.id;
-          })
-          .filter((id: ObjectID | null): id is ObjectID => {
-            return Boolean(id);
+        const statusPageMonitorRuleIdsByValue: Map<string, ObjectID> =
+          new Map();
+
+        for (const rule of legacyStatusPageMonitorRules) {
+          if (rule.id) {
+            statusPageMonitorRuleIdsByValue.set(rule.id.toString(), rule.id);
+          }
+        }
+
+        statusPageMonitorRuleIds = Array.from(
+          statusPageMonitorRuleIdsByValue.values(),
+        );
+
+        /*
+         * Configurable criteria keep relation ids inside jsonb rather than in
+         * the legacy join table. Find those rules before the label disappears
+         * as well; otherwise their existing status-page resources would never
+         * be reconciled. This is deliberately a second bounded lookup so the
+         * legacy relation query keeps using its index.
+         */
+        const criteriaStatusPageMonitorRules: Array<StatusPageMonitorRule> =
+          await StatusPageMonitorRuleService.findBy({
+            query: {
+              criteria: QueryHelper.jsonArrayObjectsContainAnyArrayValue({
+                arrayKey: "filters",
+                discriminatorKey: "field",
+                discriminatorValue: "monitorLabels",
+                valueArrayKey: "value",
+                values: labelIds,
+              }),
+            },
+            select: {
+              _id: true,
+            },
+            limit: LIMIT_MAX,
+            skip: 0,
+            props: {
+              isRoot: true,
+            },
           });
+
+        for (const rule of criteriaStatusPageMonitorRules) {
+          if (rule.id) {
+            statusPageMonitorRuleIdsByValue.set(rule.id.toString(), rule.id);
+          }
+        }
+
+        statusPageMonitorRuleIds = Array.from(
+          statusPageMonitorRuleIdsByValue.values(),
+        );
       }
     } catch (err) {
       logger.error(

package/Server/Services/MonitorLabelRuleEngineService.ts

@@ -13,6 +13,7 @@ import QueryHelper from "../Types/Database/QueryHelper";
 import CaptureSpan from "../Utils/Telemetry/CaptureSpan";
 import logger, { LogAttributes } from "../Utils/Logger";
 import { MAX_RULES_EVALUATED_PER_PROJECT } from "../../Utils/Rules/RuleEngineLimits";
+import { RuleCriteriaMatcher } from "../../Utils/Rules/RuleCriteriaMatcher";
 import logIfRuleReadWasTruncated from "../Utils/Rules/RuleEngineRuleRead";
 
 class MonitorLabelRuleEngineServiceClass {
@@ -38,6 +39,7 @@ class MonitorLabelRuleEngineServiceClass {
           select: {
             _id: true,
             name: true,
+            criteria: true,
             monitorLabels: { _id: true },
             monitorNamePattern: true,
             monitorDescriptionPattern: true,
@@ -247,6 +249,24 @@ class MonitorLabelRuleEngineServiceClass {
   private doesMonitorMatchRule(
     monitor: Monitor,
     rule: MonitorLabelRule,
+  ): boolean {
+    return RuleCriteriaMatcher.matchesWithLegacySync({
+      rule,
+      legacyFields: [
+        "monitorLabels",
+        "monitorNamePattern",
+        "monitorDescriptionPattern",
+      ],
+      emptyResult: true,
+      matchesLegacyRule: (legacyRule: MonitorLabelRule): boolean => {
+        return this.doesMonitorMatchLegacyRule(monitor, legacyRule);
+      },
+    });
+  }
+
+  private doesMonitorMatchLegacyRule(
+    monitor: Monitor,
+    rule: MonitorLabelRule,
   ): boolean {
     if (rule.monitorLabels && rule.monitorLabels.length > 0) {
       if (!monitor.labels || monitor.labels.length === 0) {

package/Server/Services/MonitorOwnerRuleEngineService.ts

@@ -16,6 +16,7 @@ import QueryHelper from "../Types/Database/QueryHelper";
 import CaptureSpan from "../Utils/Telemetry/CaptureSpan";
 import logger, { LogAttributes } from "../Utils/Logger";
 import { MAX_RULES_EVALUATED_PER_PROJECT } from "../../Utils/Rules/RuleEngineLimits";
+import { RuleCriteriaMatcher } from "../../Utils/Rules/RuleCriteriaMatcher";
 import logIfRuleReadWasTruncated from "../Utils/Rules/RuleEngineRuleRead";
 
 class MonitorOwnerRuleEngineServiceClass {
@@ -41,6 +42,7 @@ class MonitorOwnerRuleEngineServiceClass {
           select: {
             _id: true,
             name: true,
+            criteria: true,
             notifyOwners: true,
             monitorLabels: { _id: true },
             monitorNamePattern: true,
@@ -278,6 +280,24 @@ class MonitorOwnerRuleEngineServiceClass {
   private doesMonitorMatchRule(
     monitor: Monitor,
     rule: MonitorOwnerRule,
+  ): boolean {
+    return RuleCriteriaMatcher.matchesWithLegacySync({
+      rule,
+      legacyFields: [
+        "monitorLabels",
+        "monitorNamePattern",
+        "monitorDescriptionPattern",
+      ],
+      emptyResult: true,
+      matchesLegacyRule: (legacyRule: MonitorOwnerRule): boolean => {
+        return this.doesMonitorMatchLegacyRule(monitor, legacyRule);
+      },
+    });
+  }
+
+  private doesMonitorMatchLegacyRule(
+    monitor: Monitor,
+    rule: MonitorOwnerRule,
   ): boolean {
     if (rule.monitorLabels && rule.monitorLabels.length > 0) {
       if (!monitor.labels || monitor.labels.length === 0) {

package/Server/Services/NetworkDeviceAutoImportRuleEngineService.ts

@@ -588,6 +588,7 @@ class NetworkDeviceAutoImportRuleEngineServiceClass {
           name: true,
           isEnabled: true,
           isExclusion: true,
+          criteria: true,
           ipMatchTarget: true,
           sysNamePattern: true,
           sysDescrPattern: true,
@@ -958,6 +959,7 @@ class NetworkDeviceAutoImportRuleEngineServiceClass {
             _id: true,
             name: true,
             isExclusion: true,
+            criteria: true,
             ipMatchTarget: true,
             sysNamePattern: true,
             sysDescrPattern: true,

package/Server/Services/NetworkDeviceAutoImportRuleService.ts

@@ -25,6 +25,14 @@ import TablePermission from "../Types/Database/Permissions/TablePermission";
 import NetworkDeviceMonitorTemplateUtil from "../../Utils/Monitor/NetworkDeviceMonitorTemplateUtil";
 import QueryHelper from "../Types/Database/QueryHelper";
 import logger, { LogAttributes } from "../Utils/Logger";
+import {
+  getRuleCriteriaValidationError,
+  isValidRuleCriteria,
+} from "../../Utils/Rules/RuleCriteriaMatcher";
+import RuleCriteria, {
+  RuleCriteriaFilter,
+  RuleCriteriaOperator,
+} from "../../Types/Rules/RuleCriteria";
 
 /*
  * Write-time validation for auto-import rules, following the
@@ -87,6 +95,7 @@ export class Service extends DatabaseService<Model> {
     createBy: CreateBy<Model>,
   ): Promise<OnCreate<Model>> {
     this.validateCriteria({
+      criteria: createBy.data.criteria,
       ipMatchTarget: createBy.data.ipMatchTarget,
       sysNamePattern: createBy.data.sysNamePattern,
       sysDescrPattern: createBy.data.sysDescrPattern,
@@ -131,7 +140,8 @@ export class Service extends DatabaseService<Model> {
       dataKeys.includes("ipMatchTarget") ||
       dataKeys.includes("sysNamePattern") ||
       dataKeys.includes("sysDescrPattern") ||
-      dataKeys.includes("sysObjectIdPattern");
+      dataKeys.includes("sysObjectIdPattern") ||
+      dataKeys.includes("criteria");
 
     /*
      * `includePingOnlyHosts` is deliberately not here. A ping-only host
@@ -213,6 +223,7 @@ export class Service extends DatabaseService<Model> {
       select: {
         _id: true,
         projectId: true,
+        criteria: true,
         ipMatchTarget: true,
         sysNamePattern: true,
         sysDescrPattern: true,
@@ -242,6 +253,9 @@ export class Service extends DatabaseService<Model> {
     for (const existingRule of existingRules) {
       if (isCriteriaChange) {
         this.validateCriteria({
+          criteria: dataKeys.includes("criteria")
+            ? (data["criteria"] as RuleCriteria | null | undefined)
+            : existingRule.criteria,
           ipMatchTarget: dataKeys.includes("ipMatchTarget")
             ? (data["ipMatchTarget"] as string | null)
             : existingRule.ipMatchTarget,
@@ -602,11 +616,64 @@ export class Service extends DatabaseService<Model> {
   }
 
   private validateCriteria(data: {
+    criteria?: RuleCriteria | null | undefined;
     ipMatchTarget?: string | null | undefined;
     sysNamePattern?: string | null | undefined;
     sysDescrPattern?: string | null | undefined;
     sysObjectIdPattern?: string | null | undefined;
   }): void {
+    if (data.criteria !== undefined && data.criteria !== null) {
+      const validationError: string | null = getRuleCriteriaValidationError(
+        data.criteria,
+      );
+
+      if (validationError) {
+        throw new BadDataException(validationError);
+      }
+
+      if (!isValidRuleCriteria(data.criteria)) {
+        throw new BadDataException("Rule criteria is invalid.");
+      }
+
+      if (data.criteria.filters.length === 0) {
+        throw new BadDataException(
+          "At least one auto-import match condition is required.",
+        );
+      }
+
+      const supportedFields: Set<string> = new Set([
+        "ipMatchTarget",
+        "sysNamePattern",
+        "sysDescrPattern",
+        "sysObjectIdPattern",
+      ]);
+
+      for (const filter of data.criteria.filters) {
+        if (!supportedFields.has(filter.field)) {
+          throw new BadDataException(
+            `Unsupported auto-import match condition: ${filter.field}`,
+          );
+        }
+
+        if (Array.isArray(filter.value)) {
+          throw new BadDataException(
+            `${filter.field} requires a text comparison operator.`,
+          );
+        }
+
+        if (
+          filter.operator !== RuleCriteriaOperator.MatchesPattern &&
+          filter.operator !== RuleCriteriaOperator.DoesNotMatchPattern
+        ) {
+          continue;
+        }
+
+        this.validateConfiguredPattern(filter);
+      }
+
+      return;
+    }
+
     const ipMatchTarget: string = (data.ipMatchTarget || "").trim();
     const sysNamePattern: string = (data.sysNamePattern || "").trim();
     const sysDescrPattern: string = (data.sysDescrPattern || "").trim();
@@ -644,6 +711,31 @@ export class Service extends DatabaseService<Model> {
     this.validateOidPattern(sysObjectIdPattern);
   }
 
+  private validateConfiguredPattern(filter: RuleCriteriaFilter): void {
+    const pattern: string = String(filter.value).trim();
+
+    if (filter.field === "ipMatchTarget") {
+      if (!ScanTargetUtil.isValid(pattern)) {
+        throw new BadDataException(
+          `"${pattern}" is not a valid Host IP condition. ${ScanTargetUtil.getSyntaxHint()}`,
+        );
+      }
+      return;
+    }
+
+    if (filter.field === "sysObjectIdPattern") {
+      this.validateOidPattern(pattern);
+      return;
+    }
+
+    this.validatePattern(
+      filter.field === "sysNamePattern"
+        ? "System Name Pattern"
+        : "System Description Pattern",
+      pattern,
+    );
+  }
+
   private validatePattern(title: string, pattern: string): void {
     if (!pattern || RulePatternMatchUtil.isSupportedPattern(pattern)) {
       return;

package/Server/Services/NetworkDeviceLabelRuleEngineService.ts

@@ -11,6 +11,7 @@ import RulePatternMatchUtil from "../../Utils/Rules/RulePatternMatchUtil";
 import CaptureSpan from "../Utils/Telemetry/CaptureSpan";
 import logger, { LogAttributes } from "../Utils/Logger";
 import { MAX_RULES_EVALUATED_PER_PROJECT } from "../../Utils/Rules/RuleEngineLimits";
+import { RuleCriteriaMatcher } from "../../Utils/Rules/RuleCriteriaMatcher";
 import logIfRuleReadWasTruncated from "../Utils/Rules/RuleEngineRuleRead";
 
 /*
@@ -62,6 +63,7 @@ class NetworkDeviceLabelRuleEngineServiceClass {
           select: {
             _id: true,
             name: true,
+            criteria: true,
             networkDeviceLabels: { _id: true },
             networkDeviceNamePattern: true,
             networkDeviceDescriptionPattern: true,
@@ -194,6 +196,7 @@ class NetworkDeviceLabelRuleEngineServiceClass {
         select: {
           _id: true,
           name: true,
+          criteria: true,
           isEnabled: true,
           networkDeviceLabels: { _id: true },
           networkDeviceNamePattern: true,
@@ -384,6 +387,29 @@ class NetworkDeviceLabelRuleEngineServiceClass {
   private doesNetworkDeviceMatchRule(
     networkDevice: NetworkDevice,
     rule: NetworkDeviceLabelRule,
+  ): boolean {
+    return RuleCriteriaMatcher.matchesWithLegacySync({
+      rule: rule,
+      legacyFields: [
+        "networkDeviceLabels",
+        "networkDeviceNamePattern",
+        "networkDeviceDescriptionPattern",
+      ],
+      emptyResult: true,
+      matchesLegacyRule: (
+        networkDeviceRule: NetworkDeviceLabelRule,
+      ): boolean => {
+        return this.doesNetworkDeviceMatchRuleLegacy(
+          networkDevice,
+          networkDeviceRule,
+        );
+      },
+    });
+  }
+
+  private doesNetworkDeviceMatchRuleLegacy(
+    networkDevice: NetworkDevice,
+    rule: NetworkDeviceLabelRule,
   ): boolean {
     if (rule.networkDeviceLabels && rule.networkDeviceLabels.length > 0) {
       if (!networkDevice.labels || networkDevice.labels.length === 0) {

package/Server/Services/NetworkDeviceOwnerRuleEngineService.ts

@@ -12,6 +12,7 @@ import RulePatternMatchUtil from "../../Utils/Rules/RulePatternMatchUtil";
 import CaptureSpan from "../Utils/Telemetry/CaptureSpan";
 import logger, { LogAttributes } from "../Utils/Logger";
 import { MAX_RULES_EVALUATED_PER_PROJECT } from "../../Utils/Rules/RuleEngineLimits";
+import { RuleCriteriaMatcher } from "../../Utils/Rules/RuleCriteriaMatcher";
 import logIfRuleReadWasTruncated from "../Utils/Rules/RuleEngineRuleRead";
 
 class NetworkDeviceOwnerRuleEngineServiceClass {
@@ -40,6 +41,7 @@ class NetworkDeviceOwnerRuleEngineServiceClass {
           select: {
             _id: true,
             name: true,
+            criteria: true,
             notifyOwners: true,
             networkDeviceLabels: { _id: true },
             networkDeviceNamePattern: true,
@@ -162,6 +164,29 @@ class NetworkDeviceOwnerRuleEngineServiceClass {
   private doesNetworkDeviceMatchRule(
     networkDevice: NetworkDevice,
     rule: NetworkDeviceOwnerRule,
+  ): boolean {
+    return RuleCriteriaMatcher.matchesWithLegacySync({
+      rule: rule,
+      legacyFields: [
+        "networkDeviceLabels",
+        "networkDeviceNamePattern",
+        "networkDeviceDescriptionPattern",
+      ],
+      emptyResult: true,
+      matchesLegacyRule: (
+        networkDeviceRule: NetworkDeviceOwnerRule,
+      ): boolean => {
+        return this.doesNetworkDeviceMatchRuleLegacy(
+          networkDevice,
+          networkDeviceRule,
+        );
+      },
+    });
+  }
+
+  private doesNetworkDeviceMatchRuleLegacy(
+    networkDevice: NetworkDevice,
+    rule: NetworkDeviceOwnerRule,
   ): boolean {
     if (rule.networkDeviceLabels && rule.networkDeviceLabels.length > 0) {
       if (!networkDevice.labels || networkDevice.labels.length === 0) {

package/Server/Services/NetworkDeviceService.ts

@@ -2725,6 +2725,7 @@ export class Service extends DatabaseService<Model> {
           siteId: true,
           subnetCidr: true,
           hostnamePattern: true,
+          criteria: true,
           priority: true,
           createdAt: true,
         },
@@ -2825,6 +2826,7 @@ export class Service extends DatabaseService<Model> {
           siteId: true,
           subnetCidr: true,
           hostnamePattern: true,
+          criteria: true,
           priority: true,
           createdAt: true,
         },

package/Server/Services/NetworkSiteAssignmentRuleService.ts

@@ -9,7 +9,12 @@ import CaptureSpan from "../Utils/Telemetry/CaptureSpan";
 import LIMIT_MAX from "../../Types/Database/LimitMax";
 import BadDataException from "../../Types/Exception/BadDataException";
 import ObjectID from "../../Types/ObjectID";
+import RuleCriteria, {
+  RuleCriteriaFilter,
+  RuleCriteriaOperator,
+} from "../../Types/Rules/RuleCriteria";
 import CidrMatchUtil from "../../Utils/NetworkSite/CidrMatchUtil";
+import { getRuleCriteriaValidationError } from "../../Utils/Rules/RuleCriteriaMatcher";
 import RelationIdUtil from "../Utils/Database/RelationIdUtil";
 
 /*
@@ -18,6 +23,17 @@ import RelationIdUtil from "../Utils/Database/RelationIdUtil";
  */
 const SITE_KEYS: Array<string> = ["siteId", "site"];
 
+const HOSTNAME_OPERATORS: ReadonlySet<RuleCriteriaOperator> = new Set([
+  RuleCriteriaOperator.Equals,
+  RuleCriteriaOperator.NotEquals,
+  RuleCriteriaOperator.Contains,
+  RuleCriteriaOperator.DoesNotContain,
+  RuleCriteriaOperator.StartsWith,
+  RuleCriteriaOperator.EndsWith,
+  RuleCriteriaOperator.MatchesPattern,
+  RuleCriteriaOperator.DoesNotMatchPattern,
+]);
+
 function readSiteId(data: Record<string, unknown>): ObjectID | null {
   return RelationIdUtil.read(data, SITE_KEYS);
 }
@@ -77,6 +93,7 @@ export class Service extends DatabaseService<Model> {
     createBy: CreateBy<Model>,
   ): Promise<OnCreate<Model>> {
     this.validateCriteria({
+      criteria: createBy.data.criteria,
       subnetCidr: createBy.data.subnetCidr,
       hostnamePattern: createBy.data.hostnamePattern,
     });
@@ -102,7 +119,9 @@ export class Service extends DatabaseService<Model> {
     const dataKeys: Array<string> = Object.keys(updateBy.data || {});
 
     const isCriteriaChange: boolean =
-      dataKeys.includes("subnetCidr") || dataKeys.includes("hostnamePattern");
+      dataKeys.includes("criteria") ||
+      dataKeys.includes("subnetCidr") ||
+      dataKeys.includes("hostnamePattern");
 
     const newSiteId: ObjectID | null = readSiteId(
       updateBy.data as unknown as Record<string, unknown>,
@@ -123,6 +142,7 @@ export class Service extends DatabaseService<Model> {
         projectId: true,
         subnetCidr: true,
         hostnamePattern: true,
+        criteria: true,
       },
       limit: LIMIT_MAX,
       skip: 0,
@@ -134,6 +154,9 @@ export class Service extends DatabaseService<Model> {
     for (const existingRule of existingRules) {
       if (isCriteriaChange) {
         this.validateCriteria({
+          criteria: dataKeys.includes("criteria")
+            ? (updateBy.data as { criteria?: unknown }).criteria
+            : existingRule.criteria,
           subnetCidr: dataKeys.includes("subnetCidr")
             ? ((updateBy.data as any)["subnetCidr"] as string | null)
             : existingRule.subnetCidr,
@@ -155,9 +178,34 @@ export class Service extends DatabaseService<Model> {
   }
 
   private validateCriteria(data: {
+    criteria?: unknown;
     subnetCidr?: string | null | undefined;
     hostnamePattern?: string | null | undefined;
   }): void {
+    if (data.criteria !== undefined && data.criteria !== null) {
+      const validationError: string | null = getRuleCriteriaValidationError(
+        data.criteria,
+      );
+
+      if (validationError) {
+        throw new BadDataException(validationError);
+      }
+
+      const criteria: RuleCriteria = data.criteria as RuleCriteria;
+
+      if (criteria.filters.length === 0) {
+        throw new BadDataException(
+          "At least one network site assignment condition is required.",
+        );
+      }
+
+      for (const filter of criteria.filters) {
+        this.validateConfiguredFilter(filter);
+      }
+
+      return;
+    }
+
     const subnetCidr: string = (data.subnetCidr || "").trim();
     const hostnamePattern: string = (data.hostnamePattern || "").trim();
 
@@ -173,6 +221,47 @@ export class Service extends DatabaseService<Model> {
       );
     }
   }
+
+  private validateConfiguredFilter(filter: RuleCriteriaFilter): void {
+    const value: string = String(filter.value).trim();
+
+    if (filter.field === "subnetCidr") {
+      if (
+        filter.operator !== RuleCriteriaOperator.MatchesPattern &&
+        filter.operator !== RuleCriteriaOperator.DoesNotMatchPattern
+      ) {
+        throw new BadDataException(
+          "Subnet CIDR conditions must use a CIDR match operator.",
+        );
+      }
+
+      if (!CidrMatchUtil.isValidCidr(value)) {
+        throw new BadDataException(
+          `${value} is not a valid IPv4 CIDR (expected e.g. 10.0.0.0/24).`,
+        );
+      }
+
+      return;
+    }
+
+    if (filter.field !== "hostnamePattern") {
+      throw new BadDataException(
+        `${filter.field} is not a supported network site assignment condition.`,
+      );
+    }
+
+    if (!HOSTNAME_OPERATORS.has(filter.operator)) {
+      throw new BadDataException(
+        `${filter.operator} is not supported for Hostname Pattern.`,
+      );
+    }
+
+    if (value.length > CidrMatchUtil.MAX_HOSTNAME_PATTERN_LENGTH) {
+      throw new BadDataException(
+        `Hostname Pattern cannot exceed ${CidrMatchUtil.MAX_HOSTNAME_PATTERN_LENGTH} characters.`,
+      );
+    }
+  }
 }
 
 export default new Service();