@oneuptime/common 13.0.8 → 14.0.1

package/Models/DatabaseModels/ServiceLevelObjectiveOwnerRule.ts

@@ -0,0 +1,603 @@
+import Label from "./Label";
+import Project from "./Project";
+import Team from "./Team";
+import User from "./User";
+import RuleBaseModel from "./DatabaseBaseModel/RuleBaseModel";
+import Route from "../../Types/API/Route";
+import ColumnAccessControl from "../../Types/Database/AccessControl/ColumnAccessControl";
+import TableAccessControl from "../../Types/Database/AccessControl/TableAccessControl";
+import ColumnLength from "../../Types/Database/ColumnLength";
+import ColumnType from "../../Types/Database/ColumnType";
+import CrudApiEndpoint from "../../Types/Database/CrudApiEndpoint";
+import EnableDocumentation from "../../Types/Database/EnableDocumentation";
+import EnableWorkflow from "../../Types/Database/EnableWorkflow";
+import TableColumn from "../../Types/Database/TableColumn";
+import TableColumnType from "../../Types/Database/TableColumnType";
+import TableMetadata from "../../Types/Database/TableMetadata";
+import TenantColumn from "../../Types/Database/TenantColumn";
+import IconProp from "../../Types/Icon/IconProp";
+import ObjectID from "../../Types/ObjectID";
+import Permission from "../../Types/Permission";
+import {
+  Column,
+  Entity,
+  Index,
+  JoinColumn,
+  JoinTable,
+  ManyToMany,
+  ManyToOne,
+} from "typeorm";
+
+/*
+ * Adds owner users and teams to SLOs that match it - the SLO counterpart of
+ * DashboardOwnerRule. Evaluated by ServiceLevelObjectiveOwnerRuleEngineService
+ * when an SLO is created, and against existing SLOs by "Run now".
+ *
+ * Owners are who is told when an SLO goes at risk, so the owners a rule adds
+ * are written through the owner services: each one gets the same feed item and
+ * owner-added notification as an owner added by hand.
+ */
+@EnableDocumentation()
+@TenantColumn("projectId")
+@TableAccessControl({
+  create: [
+    Permission.ProjectOwner,
+    Permission.ProjectAdmin,
+    Permission.CreateServiceLevelObjectiveOwnerRule,
+  ],
+  read: [
+    Permission.ProjectOwner,
+    Permission.ProjectAdmin,
+    Permission.ProjectMember,
+    Permission.Viewer,
+    Permission.ReadServiceLevelObjectiveOwnerRule,
+  ],
+  delete: [
+    Permission.ProjectOwner,
+    Permission.ProjectAdmin,
+    Permission.DeleteServiceLevelObjectiveOwnerRule,
+  ],
+  update: [
+    Permission.ProjectOwner,
+    Permission.ProjectAdmin,
+    Permission.EditServiceLevelObjectiveOwnerRule,
+  ],
+})
+@CrudApiEndpoint(new Route("/service-level-objective-owner-rule"))
+@Entity({
+  name: "ServiceLevelObjectiveOwnerRule",
+})
+@EnableWorkflow({
+  create: true,
+  delete: true,
+  update: true,
+  read: true,
+})
+@TableMetadata({
+  tableName: "ServiceLevelObjectiveOwnerRule",
+  singularName: "SLO Owner Rule",
+  pluralName: "SLO Owner Rules",
+  icon: IconProp.User,
+  tableDescription:
+    "Configure rules for automatically assigning owner users and teams when matching SLOs are created",
+})
+export default class ServiceLevelObjectiveOwnerRule extends RuleBaseModel {
+  @ColumnAccessControl({
+    create: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.CreateServiceLevelObjectiveOwnerRule,
+    ],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.Viewer,
+      Permission.ReadServiceLevelObjectiveOwnerRule,
+    ],
+    update: [],
+  })
+  @TableColumn({
+    manyToOneRelationColumn: "projectId",
+    type: TableColumnType.Entity,
+    modelType: Project,
+    title: "Project",
+    description: "Relation to Project Resource in which this object belongs",
+  })
+  @ManyToOne(
+    () => {
+      return Project;
+    },
+    {
+      eager: false,
+      nullable: true,
+      onDelete: "CASCADE",
+      orphanedRowAction: "nullify",
+    },
+  )
+  @JoinColumn({ name: "projectId" })
+  public project?: Project = undefined;
+
+  @ColumnAccessControl({
+    create: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.CreateServiceLevelObjectiveOwnerRule,
+    ],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.Viewer,
+      Permission.ReadServiceLevelObjectiveOwnerRule,
+    ],
+    update: [],
+  })
+  @Index()
+  @TableColumn({
+    type: TableColumnType.ObjectID,
+    required: true,
+    canReadOnRelationQuery: true,
+    title: "Project ID",
+    description: "ID of your OneUptime Project in which this object belongs",
+  })
+  @Column({
+    type: ColumnType.ObjectID,
+    nullable: false,
+    transformer: ObjectID.getDatabaseTransformer(),
+  })
+  public projectId?: ObjectID = undefined;
+
+  @ColumnAccessControl({
+    create: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.CreateServiceLevelObjectiveOwnerRule,
+    ],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.Viewer,
+      Permission.ReadServiceLevelObjectiveOwnerRule,
+    ],
+    update: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.EditServiceLevelObjectiveOwnerRule,
+    ],
+  })
+  @Index()
+  @TableColumn({
+    required: true,
+    type: TableColumnType.ShortText,
+    canReadOnRelationQuery: true,
+    title: "Name",
+    description: "Name of this SLO owner rule",
+  })
+  @Column({
+    nullable: false,
+    type: ColumnType.ShortText,
+    length: ColumnLength.ShortText,
+  })
+  public name?: string = undefined;
+
+  @ColumnAccessControl({
+    create: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.CreateServiceLevelObjectiveOwnerRule,
+    ],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.Viewer,
+      Permission.ReadServiceLevelObjectiveOwnerRule,
+    ],
+    update: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.EditServiceLevelObjectiveOwnerRule,
+    ],
+  })
+  @TableColumn({
+    required: false,
+    type: TableColumnType.LongText,
+    title: "Description",
+    description: "Description of this SLO owner rule",
+  })
+  @Column({
+    nullable: true,
+    type: ColumnType.LongText,
+    length: ColumnLength.LongText,
+  })
+  public description?: string = undefined;
+
+  @ColumnAccessControl({
+    create: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.CreateServiceLevelObjectiveOwnerRule,
+    ],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.Viewer,
+      Permission.ReadServiceLevelObjectiveOwnerRule,
+    ],
+    update: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.EditServiceLevelObjectiveOwnerRule,
+    ],
+  })
+  @Index()
+  @TableColumn({
+    required: true,
+    type: TableColumnType.Boolean,
+    title: "Is Enabled",
+    description: "Whether this rule is enabled",
+    defaultValue: true,
+    isDefaultValueColumn: true,
+  })
+  @Column({
+    type: ColumnType.Boolean,
+    nullable: false,
+    default: true,
+  })
+  public isEnabled?: boolean = undefined;
+
+  @ColumnAccessControl({
+    create: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.CreateServiceLevelObjectiveOwnerRule,
+    ],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.Viewer,
+      Permission.ReadServiceLevelObjectiveOwnerRule,
+    ],
+    update: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.EditServiceLevelObjectiveOwnerRule,
+    ],
+  })
+  @TableColumn({
+    required: false,
+    type: TableColumnType.Boolean,
+    title: "Notify Owners",
+    description:
+      "Send notifications to owner users and teams when they are added by this rule",
+    defaultValue: true,
+    isDefaultValueColumn: true,
+  })
+  @Column({
+    type: ColumnType.Boolean,
+    nullable: false,
+    default: true,
+  })
+  public notifyOwners?: boolean = undefined;
+
+  // Match Criteria
+
+  @ColumnAccessControl({
+    create: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.CreateServiceLevelObjectiveOwnerRule,
+    ],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.Viewer,
+      Permission.ReadServiceLevelObjectiveOwnerRule,
+    ],
+    update: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.EditServiceLevelObjectiveOwnerRule,
+    ],
+  })
+  @TableColumn({
+    required: false,
+    type: TableColumnType.EntityArray,
+    modelType: Label,
+    title: "SLO Labels",
+    description:
+      "Only trigger for SLOs that have at least one of these labels. Leave empty to match regardless of labels.",
+  })
+  @ManyToMany(
+    () => {
+      return Label;
+    },
+    { eager: false },
+  )
+  @JoinTable({
+    name: "ServiceLevelObjectiveOwnerRuleServiceLevelObjectiveLabel",
+    inverseJoinColumn: {
+      name: "labelId",
+      referencedColumnName: "_id",
+    },
+    joinColumn: {
+      name: "serviceLevelObjectiveOwnerRuleId",
+      referencedColumnName: "_id",
+    },
+  })
+  public serviceLevelObjectiveLabels?: Array<Label> = undefined;
+
+  @ColumnAccessControl({
+    create: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.CreateServiceLevelObjectiveOwnerRule,
+    ],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.Viewer,
+      Permission.ReadServiceLevelObjectiveOwnerRule,
+    ],
+    update: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.EditServiceLevelObjectiveOwnerRule,
+    ],
+  })
+  @TableColumn({
+    required: false,
+    type: TableColumnType.LongText,
+    title: "SLO Name Pattern",
+    description:
+      "Regex (case-insensitive) matched against the SLO name. Leave empty to match any name.",
+  })
+  @Column({
+    type: ColumnType.LongText,
+    nullable: true,
+    length: ColumnLength.LongText,
+  })
+  public serviceLevelObjectiveNamePattern?: string = undefined;
+
+  @ColumnAccessControl({
+    create: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.CreateServiceLevelObjectiveOwnerRule,
+    ],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.Viewer,
+      Permission.ReadServiceLevelObjectiveOwnerRule,
+    ],
+    update: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.EditServiceLevelObjectiveOwnerRule,
+    ],
+  })
+  @TableColumn({
+    required: false,
+    type: TableColumnType.LongText,
+    title: "SLO Description Pattern",
+    description:
+      "Regex (case-insensitive) matched against the SLO description. Leave empty to match any description.",
+  })
+  @Column({
+    type: ColumnType.LongText,
+    nullable: true,
+    length: ColumnLength.LongText,
+  })
+  public serviceLevelObjectiveDescriptionPattern?: string = undefined;
+
+  // Action: Owner Users + Teams
+
+  @ColumnAccessControl({
+    create: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.CreateServiceLevelObjectiveOwnerRule,
+    ],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.Viewer,
+      Permission.ReadServiceLevelObjectiveOwnerRule,
+    ],
+    update: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.EditServiceLevelObjectiveOwnerRule,
+    ],
+  })
+  @TableColumn({
+    required: false,
+    type: TableColumnType.EntityArray,
+    modelType: User,
+    title: "Owner Users",
+    description: "Users to add as owners on the SLO when this rule matches.",
+  })
+  @ManyToMany(
+    () => {
+      return User;
+    },
+    { eager: false },
+  )
+  @JoinTable({
+    name: "ServiceLevelObjectiveOwnerRuleOwnerUser",
+    inverseJoinColumn: {
+      name: "userId",
+      referencedColumnName: "_id",
+    },
+    joinColumn: {
+      name: "serviceLevelObjectiveOwnerRuleId",
+      referencedColumnName: "_id",
+    },
+  })
+  public ownerUsers?: Array<User> = undefined;
+
+  @ColumnAccessControl({
+    create: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.CreateServiceLevelObjectiveOwnerRule,
+    ],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.Viewer,
+      Permission.ReadServiceLevelObjectiveOwnerRule,
+    ],
+    update: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.EditServiceLevelObjectiveOwnerRule,
+    ],
+  })
+  @TableColumn({
+    required: false,
+    type: TableColumnType.EntityArray,
+    modelType: Team,
+    title: "Owner Teams",
+    description: "Teams to add as owners on the SLO when this rule matches.",
+  })
+  @ManyToMany(
+    () => {
+      return Team;
+    },
+    { eager: false },
+  )
+  @JoinTable({
+    name: "ServiceLevelObjectiveOwnerRuleOwnerTeam",
+    inverseJoinColumn: {
+      name: "teamId",
+      referencedColumnName: "_id",
+    },
+    joinColumn: {
+      name: "serviceLevelObjectiveOwnerRuleId",
+      referencedColumnName: "_id",
+    },
+  })
+  public ownerTeams?: Array<Team> = undefined;
+
+  @ColumnAccessControl({
+    create: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.CreateServiceLevelObjectiveOwnerRule,
+    ],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.Viewer,
+      Permission.ReadServiceLevelObjectiveOwnerRule,
+    ],
+    update: [],
+  })
+  @TableColumn({
+    manyToOneRelationColumn: "createdByUserId",
+    type: TableColumnType.Entity,
+    modelType: User,
+    title: "Created by User",
+    description:
+      "Relation to User who created this object (if this object was created by a User)",
+  })
+  @ManyToOne(
+    () => {
+      return User;
+    },
+    {
+      eager: false,
+      nullable: true,
+      onDelete: "SET NULL",
+      orphanedRowAction: "nullify",
+    },
+  )
+  @JoinColumn({ name: "createdByUserId" })
+  public createdByUser?: User = undefined;
+
+  @ColumnAccessControl({
+    create: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.CreateServiceLevelObjectiveOwnerRule,
+    ],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.Viewer,
+      Permission.ReadServiceLevelObjectiveOwnerRule,
+    ],
+    update: [],
+  })
+  @TableColumn({
+    type: TableColumnType.ObjectID,
+    title: "Created by User ID",
+    description:
+      "User ID who created this object (if this object was created by a User)",
+  })
+  @Column({
+    type: ColumnType.ObjectID,
+    nullable: true,
+    transformer: ObjectID.getDatabaseTransformer(),
+  })
+  public createdByUserId?: ObjectID = undefined;
+
+  @ColumnAccessControl({
+    create: [],
+    read: [],
+    update: [],
+  })
+  @TableColumn({
+    manyToOneRelationColumn: "deletedByUserId",
+    type: TableColumnType.Entity,
+    title: "Deleted by User",
+    modelType: User,
+    description:
+      "Relation to User who deleted this object (if this object was deleted by a User)",
+  })
+  @ManyToOne(
+    () => {
+      return User;
+    },
+    {
+      cascade: false,
+      eager: false,
+      nullable: true,
+      onDelete: "SET NULL",
+      orphanedRowAction: "nullify",
+    },
+  )
+  @JoinColumn({ name: "deletedByUserId" })
+  public deletedByUser?: User = undefined;
+
+  @ColumnAccessControl({
+    create: [],
+    read: [],
+    update: [],
+  })
+  @TableColumn({
+    type: TableColumnType.ObjectID,
+    title: "Deleted by User ID",
+    description:
+      "User ID who deleted this object (if this object was deleted by a User)",
+  })
+  @Column({
+    type: ColumnType.ObjectID,
+    nullable: true,
+    transformer: ObjectID.getDatabaseTransformer(),
+  })
+  public deletedByUserId?: ObjectID = undefined;
+}

package/Scripts/generate-service-worker.js

@@ -16,6 +16,12 @@
 const fs = require("fs");
 const path = require("path");
 const crypto = require("crypto");
+const {
+  EDITION_COMMUNITY,
+  EDITION_ENTERPRISE,
+  readRequestedEdition,
+  getEnterpriseCandidates,
+} = require("../UI/esbuild-enterprise");
 
 // Default values
 const DEFAULT_APP_VERSION = "1.0.0";
@@ -64,6 +70,50 @@ function getGitSha() {
   }
 }
 
+/**
+ * The edition a frontend build bundles: "community" or "enterprise".
+ *
+ * The same decision esbuild makes for the frontend's Enterprise plugin (see
+ * Common/UI/esbuild-enterprise.js): ONEUPTIME_EDITION=community or
+ * enterprise decides outright, and "auto" (the default) means enterprise
+ * exactly when this frontend's ee plugin, ee/<frontend directory name>/
+ * Index.tsx, is on disk. A frontend with no ee plugin (Accounts, Status Page)
+ * is therefore always "community". An unknown ONEUPTIME_EDITION throws, like
+ * the build.
+ *
+ * The edition goes into the service worker's cache version: the Community and
+ * Enterprise images of one release share APP_VERSION and GIT_SHA, and without
+ * it a browser that cached one edition's assets would keep them after the
+ * deployment switched to the other.
+ * @param {string} frontendDir - The frontend's directory (where sw.js.template lives)
+ * @param {Object} [env] - Environment to read (defaults to process.env)
+ * @returns {string}
+ */
+function getEdition(frontendDir, env) {
+  const source = env || process.env;
+  const requested = readRequestedEdition(source);
+
+  if (requested === EDITION_COMMUNITY || requested === EDITION_ENTERPRISE) {
+    return requested;
+  }
+
+  const candidates = getEnterpriseCandidates(
+    frontendDir,
+    path.basename(frontendDir),
+    source,
+  );
+
+  const hasPlugin = candidates.some((candidate) => {
+    try {
+      return fs.statSync(candidate).isFile();
+    } catch (error) {
+      return false;
+    }
+  });
+
+  return hasPlugin ? EDITION_ENTERPRISE : EDITION_COMMUNITY;
+}
+
 /**
  * Generate service worker from template
  */
@@ -85,16 +135,19 @@ function generateServiceWorker(
   const packageJsonPath = path.join(path.dirname(templatePath), "package.json");
   const appVersion = getAppVersion(packageJsonPath);
   const gitSha = getGitSha();
+  const edition = getEdition(path.dirname(templatePath));
   const buildTimestamp = new Date().toISOString();
 
   console.log(`🔧 Generating service worker for ${serviceName}...`);
   console.log(`   App Version: ${appVersion}`);
+  console.log(`   Edition: ${edition}`);
   console.log(`   Git SHA: ${gitSha}`);
   console.log(`   Build Time: ${buildTimestamp}`);
 
   // Replace placeholders
   const generatedContent = template
     .replace(/\{\{APP_VERSION\}\}/g, appVersion)
+    .replace(/\{\{EDITION\}\}/g, edition)
     .replace(/\{\{GIT_SHA\}\}/g, gitSha)
     .replace(/\{\{BUILD_TIMESTAMP\}\}/g, buildTimestamp)
     .replace(/\{\{SERVICE_NAME\}\}/g, serviceName);
@@ -102,11 +155,12 @@ function generateServiceWorker(
   // Add generation comment at the top
   const header = `/*
  * Generated Service Worker for ${serviceName}
- * 
+ *
  * Generated at: ${buildTimestamp}
  * App Version: ${appVersion}
+ * Edition: ${edition}
  * Git SHA: ${gitSha}
- * 
+ *
  * DO NOT EDIT THIS FILE DIRECTLY
  * Edit the template file instead and run the generator script
  */
@@ -125,7 +179,9 @@ function generateServiceWorker(
   fs.writeFileSync(outputPath, finalContent, "utf8");
 
   console.log("✅ Service worker generated successfully:", outputPath);
-  console.log(`   Cache version: oneuptime-v${appVersion}-${gitSha}`);
+  console.log(
+    `   Cache version: oneuptime-v${appVersion}-${edition}-${gitSha}`,
+  );
 }
 
 // Command line interface
@@ -151,4 +207,9 @@ if (require.main === module) {
   }
 }
 
-module.exports = { generateServiceWorker, getAppVersion, getGitSha };
+module.exports = {
+  generateServiceWorker,
+  getAppVersion,
+  getGitSha,
+  getEdition,
+};