@oneuptime/common 10.7.2 → 10.8.1

package/Server/Services/RumApplicationClientService.ts

@@ -0,0 +1,69 @@
+import DatabaseService from "./DatabaseService";
+import Model from "../../Models/DatabaseModels/RumApplicationClient";
+import ObjectID from "../../Types/ObjectID";
+import OneUptimeDate from "../../Types/Date";
+import CaptureSpan from "../Utils/Telemetry/CaptureSpan";
+import logger from "../Utils/Logger";
+
+export class Service extends DatabaseService<Model> {
+  public constructor() {
+    super(Model);
+  }
+
+  /**
+   * Upsert a RUM client platform (browser.platform / device.model) from
+   * ingest. Refreshes lastSeenAt if it already exists.
+   */
+  @CaptureSpan()
+  public async recordClient(data: {
+    projectId: ObjectID;
+    rumApplicationId: ObjectID;
+    clientName: string;
+    clientType?: string | undefined;
+  }): Promise<void> {
+    try {
+      const existing: Model | null = await this.findOneBy({
+        query: {
+          projectId: data.projectId,
+          rumApplicationId: data.rumApplicationId,
+          clientName: data.clientName,
+        },
+        select: { _id: true },
+        props: { isRoot: true },
+      });
+
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      const fields: any = { lastSeenAt: OneUptimeDate.getCurrentDate() };
+      if (data.clientType) {
+        fields.clientType = data.clientType;
+      }
+
+      if (existing && existing._id) {
+        await this.updateOneById({
+          id: new ObjectID(existing._id.toString()),
+          data: fields,
+          props: { isRoot: true },
+        });
+        return;
+      }
+
+      const item: Model = new Model();
+      item.projectId = data.projectId;
+      item.rumApplicationId = data.rumApplicationId;
+      item.clientName = data.clientName;
+      item.lastSeenAt = OneUptimeDate.getCurrentDate();
+      if (data.clientType) {
+        item.clientType = data.clientType;
+      }
+      await this.create({ data: item, props: { isRoot: true } });
+    } catch (err) {
+      logger.warn(
+        `RumApplicationClientService.recordClient failed: ${
+          err instanceof Error ? err.message : String(err)
+        }`,
+      );
+    }
+  }
+}
+
+export default new Service();

package/Server/Services/RumApplicationLabelRuleEngineService.ts

@@ -0,0 +1,175 @@
+import Label from "../../Models/DatabaseModels/Label";
+import RumApplication from "../../Models/DatabaseModels/RumApplication";
+import RumApplicationLabelRule from "../../Models/DatabaseModels/RumApplicationLabelRule";
+import RumApplicationLabelRuleService from "./RumApplicationLabelRuleService";
+import RumApplicationService from "./RumApplicationService";
+import ObjectID from "../../Types/ObjectID";
+import CaptureSpan from "../Utils/Telemetry/CaptureSpan";
+import logger, { LogAttributes } from "../Utils/Logger";
+
+class RumApplicationLabelRuleEngineServiceClass {
+  /**
+   * Evaluates RumApplicationLabelRule rows for the given application and
+   * attaches matched labels. The union is deduped against labels already on
+   * the application before insert to avoid PK conflicts on the join table.
+   */
+  @CaptureSpan()
+  public async applyRulesToRumApplication(
+    rumApplication: RumApplication,
+  ): Promise<void> {
+    if (!rumApplication.id || !rumApplication.projectId) {
+      return;
+    }
+
+    try {
+      const rules: Array<RumApplicationLabelRule> =
+        await RumApplicationLabelRuleService.findBy({
+          query: {
+            projectId: rumApplication.projectId,
+            isEnabled: true,
+          },
+          props: { isRoot: true },
+          select: {
+            _id: true,
+            name: true,
+            matchLabels: { _id: true },
+            nameRegexPattern: true,
+            descriptionRegexPattern: true,
+            labelsToAdd: { _id: true },
+          },
+          limit: 100,
+          skip: 0,
+        });
+
+      if (rules.length === 0) {
+        return;
+      }
+
+      const appWithDetails: RumApplication | null =
+        await RumApplicationService.findOneById({
+          id: rumApplication.id,
+          select: {
+            name: true,
+            description: true,
+            labels: { _id: true },
+          },
+          props: { isRoot: true },
+        });
+
+      if (!appWithDetails) {
+        return;
+      }
+
+      const labelIdsToAdd: Set<string> = new Set();
+
+      for (const rule of rules) {
+        if (!this.doesMatchRule(appWithDetails, rule)) {
+          continue;
+        }
+        for (const label of rule.labelsToAdd || []) {
+          if (label.id) {
+            labelIdsToAdd.add(label.id.toString());
+          }
+        }
+      }
+
+      if (labelIdsToAdd.size === 0) {
+        return;
+      }
+
+      const existingLabelIds: Set<string> = new Set(
+        (appWithDetails.labels || [])
+          .map((l: Label) => {
+            return l.id?.toString() || "";
+          })
+          .filter((id: string) => {
+            return id !== "";
+          }),
+      );
+
+      const newLabelIds: Array<string> = Array.from(labelIdsToAdd).filter(
+        (id: string) => {
+          return !existingLabelIds.has(id);
+        },
+      );
+      if (newLabelIds.length === 0) {
+        return;
+      }
+
+      await RumApplicationService.getRepository()
+        .createQueryBuilder()
+        .relation(RumApplication, "labels")
+        .of(rumApplication.id.toString())
+        .add(newLabelIds);
+
+      const mergedLabelIds: Set<string> = new Set([
+        ...existingLabelIds,
+        ...newLabelIds,
+      ]);
+      rumApplication.labels = Array.from(mergedLabelIds).map((id: string) => {
+        const label: Label = new Label();
+        label.id = new ObjectID(id);
+        return label;
+      });
+    } catch (error) {
+      logger.error(`Error applying RUM application label rules: ${error}`, {
+        projectId: rumApplication.projectId?.toString(),
+        rumApplicationId: rumApplication.id?.toString(),
+      } as LogAttributes);
+    }
+  }
+
+  private doesMatchRule(
+    rumApplication: RumApplication,
+    rule: RumApplicationLabelRule,
+  ): boolean {
+    if (rule.matchLabels && rule.matchLabels.length > 0) {
+      if (!rumApplication.labels || rumApplication.labels.length === 0) {
+        return false;
+      }
+      const ruleLabelIds: Array<string> = rule.matchLabels.map((l: Label) => {
+        return l.id?.toString() || "";
+      });
+      const labelIds: Array<string> = rumApplication.labels.map((l: Label) => {
+        return l.id?.toString() || "";
+      });
+      if (
+        !ruleLabelIds.some((id: string) => {
+          return labelIds.includes(id);
+        })
+      ) {
+        return false;
+      }
+    }
+
+    if (
+      rule.nameRegexPattern &&
+      (!rumApplication.name ||
+        !this.testRegex(rule.nameRegexPattern, rumApplication.name))
+    ) {
+      return false;
+    }
+
+    if (
+      rule.descriptionRegexPattern &&
+      (!rumApplication.description ||
+        !this.testRegex(rule.descriptionRegexPattern, rumApplication.description))
+    ) {
+      return false;
+    }
+
+    return true;
+  }
+
+  private testRegex(pattern: string, value: string): boolean {
+    try {
+      const regex: RegExp = new RegExp(pattern, "i");
+      return regex.test(value);
+    } catch {
+      logger.warn(`Invalid regex in RUM application label rule: ${pattern}`);
+      return false;
+    }
+  }
+}
+
+export default new RumApplicationLabelRuleEngineServiceClass();

package/Server/Services/RumApplicationLabelRuleService.ts

@@ -0,0 +1,14 @@
+import DatabaseService from "./DatabaseService";
+import Model from "../../Models/DatabaseModels/RumApplicationLabelRule";
+import { IsBillingEnabled } from "../EnvironmentConfig";
+
+export class Service extends DatabaseService<Model> {
+  public constructor() {
+    super(Model);
+    if (IsBillingEnabled) {
+      this.hardDeleteItemsOlderThanInDays("createdAt", 3 * 365);
+    }
+  }
+}
+
+export default new Service();

package/Server/Services/RumApplicationOwnerRuleEngineService.ts

@@ -0,0 +1,192 @@
+import Label from "../../Models/DatabaseModels/Label";
+import RumApplication from "../../Models/DatabaseModels/RumApplication";
+import RumApplicationOwnerRule from "../../Models/DatabaseModels/RumApplicationOwnerRule";
+import RumApplicationOwnerUser from "../../Models/DatabaseModels/RumApplicationOwnerUser";
+import RumApplicationOwnerTeam from "../../Models/DatabaseModels/RumApplicationOwnerTeam";
+import RumApplicationOwnerRuleService from "./RumApplicationOwnerRuleService";
+import RumApplicationOwnerUserService from "./RumApplicationOwnerUserService";
+import RumApplicationOwnerTeamService from "./RumApplicationOwnerTeamService";
+import RumApplicationService from "./RumApplicationService";
+import ObjectID from "../../Types/ObjectID";
+import CaptureSpan from "../Utils/Telemetry/CaptureSpan";
+import logger, { LogAttributes } from "../Utils/Logger";
+
+class RumApplicationOwnerRuleEngineServiceClass {
+  /**
+   * Evaluates RumApplicationOwnerRule rows for the given application and adds
+   * matched owner users / teams. Rules with notifyOwners set notify the added
+   * owners; rules with notifyOwners off add silently.
+   */
+  @CaptureSpan()
+  public async applyRulesToRumApplication(
+    rumApplication: RumApplication,
+  ): Promise<void> {
+    if (!rumApplication.id || !rumApplication.projectId) {
+      return;
+    }
+
+    try {
+      const rules: Array<RumApplicationOwnerRule> =
+        await RumApplicationOwnerRuleService.findBy({
+          query: {
+            projectId: rumApplication.projectId,
+            isEnabled: true,
+          },
+          props: { isRoot: true },
+          select: {
+            _id: true,
+            name: true,
+            notifyOwners: true,
+            matchLabels: { _id: true },
+            nameRegexPattern: true,
+            descriptionRegexPattern: true,
+            ownerUsers: { _id: true },
+            ownerTeams: { _id: true },
+          },
+          limit: 100,
+          skip: 0,
+        });
+
+      if (rules.length === 0) {
+        return;
+      }
+
+      const appWithDetails: RumApplication | null =
+        await RumApplicationService.findOneById({
+          id: rumApplication.id,
+          select: {
+            name: true,
+            description: true,
+            labels: { _id: true },
+          },
+          props: { isRoot: true },
+        });
+
+      if (!appWithDetails) {
+        return;
+      }
+
+      const usersByNotify: Map<boolean, Set<string>> = new Map([
+        [true, new Set()],
+        [false, new Set()],
+      ]);
+      const teamsByNotify: Map<boolean, Set<string>> = new Map([
+        [true, new Set()],
+        [false, new Set()],
+      ]);
+
+      let anyMatched: boolean = false;
+
+      for (const rule of rules) {
+        if (!this.doesMatchRule(appWithDetails, rule)) {
+          continue;
+        }
+        const notify: boolean = rule.notifyOwners !== false;
+        for (const user of rule.ownerUsers || []) {
+          if (user.id) {
+            usersByNotify.get(notify)!.add(user.id.toString());
+            anyMatched = true;
+          }
+        }
+        for (const team of rule.ownerTeams || []) {
+          if (team.id) {
+            teamsByNotify.get(notify)!.add(team.id.toString());
+            anyMatched = true;
+          }
+        }
+      }
+
+      if (!anyMatched) {
+        return;
+      }
+
+      for (const notify of [true, false]) {
+        const userIds: Set<string> = usersByNotify.get(notify)!;
+        const teamIds: Set<string> = teamsByNotify.get(notify)!;
+
+        for (const userId of userIds) {
+          const owner: RumApplicationOwnerUser = new RumApplicationOwnerUser();
+          owner.rumApplicationId = rumApplication.id;
+          owner.projectId = rumApplication.projectId;
+          owner.userId = new ObjectID(userId);
+          owner.isOwnerNotified = !notify;
+          await RumApplicationOwnerUserService.create({
+            data: owner,
+            props: { isRoot: true },
+          });
+        }
+
+        for (const teamId of teamIds) {
+          const owner: RumApplicationOwnerTeam = new RumApplicationOwnerTeam();
+          owner.rumApplicationId = rumApplication.id;
+          owner.projectId = rumApplication.projectId;
+          owner.teamId = new ObjectID(teamId);
+          owner.isOwnerNotified = !notify;
+          await RumApplicationOwnerTeamService.create({
+            data: owner,
+            props: { isRoot: true },
+          });
+        }
+      }
+    } catch (error) {
+      logger.error(`Error applying RUM application owner rules: ${error}`, {
+        projectId: rumApplication.projectId?.toString(),
+        rumApplicationId: rumApplication.id?.toString(),
+      } as LogAttributes);
+    }
+  }
+
+  private doesMatchRule(
+    rumApplication: RumApplication,
+    rule: RumApplicationOwnerRule,
+  ): boolean {
+    if (rule.matchLabels && rule.matchLabels.length > 0) {
+      if (!rumApplication.labels || rumApplication.labels.length === 0) {
+        return false;
+      }
+      const ruleLabelIds: Array<string> = rule.matchLabels.map((l: Label) => {
+        return l.id?.toString() || "";
+      });
+      const labelIds: Array<string> = rumApplication.labels.map((l: Label) => {
+        return l.id?.toString() || "";
+      });
+      if (
+        !ruleLabelIds.some((id: string) => {
+          return labelIds.includes(id);
+        })
+      ) {
+        return false;
+      }
+    }
+
+    if (
+      rule.nameRegexPattern &&
+      (!rumApplication.name ||
+        !this.testRegex(rule.nameRegexPattern, rumApplication.name))
+    ) {
+      return false;
+    }
+
+    if (
+      rule.descriptionRegexPattern &&
+      (!rumApplication.description ||
+        !this.testRegex(rule.descriptionRegexPattern, rumApplication.description))
+    ) {
+      return false;
+    }
+
+    return true;
+  }
+
+  private testRegex(pattern: string, value: string): boolean {
+    try {
+      const regex: RegExp = new RegExp(pattern, "i");
+      return regex.test(value);
+    } catch {
+      logger.warn(`Invalid regex in RUM application owner rule: ${pattern}`);
+      return false;
+    }
+  }
+}
+
+export default new RumApplicationOwnerRuleEngineServiceClass();

package/Server/Services/RumApplicationOwnerRuleService.ts

@@ -0,0 +1,14 @@
+import DatabaseService from "./DatabaseService";
+import Model from "../../Models/DatabaseModels/RumApplicationOwnerRule";
+import { IsBillingEnabled } from "../EnvironmentConfig";
+
+export class Service extends DatabaseService<Model> {
+  public constructor() {
+    super(Model);
+    if (IsBillingEnabled) {
+      this.hardDeleteItemsOlderThanInDays("createdAt", 3 * 365);
+    }
+  }
+}
+
+export default new Service();

package/Server/Services/RumApplicationOwnerTeamService.ts

@@ -0,0 +1,10 @@
+import DatabaseService from "./DatabaseService";
+import Model from "../../Models/DatabaseModels/RumApplicationOwnerTeam";
+
+export class Service extends DatabaseService<Model> {
+  public constructor() {
+    super(Model);
+  }
+}
+
+export default new Service();

package/Server/Services/RumApplicationOwnerUserService.ts

@@ -0,0 +1,10 @@
+import DatabaseService from "./DatabaseService";
+import Model from "../../Models/DatabaseModels/RumApplicationOwnerUser";
+
+export class Service extends DatabaseService<Model> {
+  public constructor() {
+    super(Model);
+  }
+}
+
+export default new Service();