@oneuptime/common 9.3.8 → 9.3.10

package/Models/DatabaseModels/TelemetryService.ts

@@ -1,529 +0,0 @@
-import Label from "./Label";
-import Project from "./Project";
-import User from "./User";
-import BaseModel from "./DatabaseBaseModel/DatabaseBaseModel";
-import Route from "../../Types/API/Route";
-import Color from "../../Types/Color";
-import ColumnAccessControl from "../../Types/Database/AccessControl/ColumnAccessControl";
-import TableAccessControl from "../../Types/Database/AccessControl/TableAccessControl";
-import AccessControlColumn from "../../Types/Database/AccessControlColumn";
-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 ColorField from "../../Types/Database/ColorField";
-import SlugifyColumn from "../../Types/Database/SlugifyColumn";
-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 UniqueColumnBy from "../../Types/Database/UniqueColumnBy";
-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";
-
-@AccessControlColumn("labels")
-@EnableDocumentation()
-@TenantColumn("projectId")
-@TableAccessControl({
-  create: [
-    Permission.ProjectOwner,
-    Permission.ProjectAdmin,
-    Permission.ProjectMember,
-    Permission.CreateTelemetryService,
-  ],
-  read: [
-    Permission.ProjectOwner,
-    Permission.ProjectAdmin,
-    Permission.ProjectMember,
-    Permission.ProjectMember,
-    Permission.ReadTelemetryService,
-  ],
-  delete: [
-    Permission.ProjectOwner,
-    Permission.ProjectAdmin,
-    Permission.ProjectMember,
-    Permission.DeleteTelemetryService,
-  ],
-  update: [
-    Permission.ProjectOwner,
-    Permission.ProjectAdmin,
-    Permission.ProjectMember,
-    Permission.EditTelemetryService,
-  ],
-})
-@EnableWorkflow({
-  create: true,
-  delete: true,
-  update: true,
-  read: true,
-})
-@CrudApiEndpoint(new Route("/telemetry-service"))
-@SlugifyColumn("name", "slug")
-@TableMetadata({
-  tableName: "TelemetryService",
-  singularName: "Telemetry Service",
-  pluralName: "Telemetry Services",
-  icon: IconProp.SquareStack,
-  tableDescription:
-    "Telemetry Services are the services that you can use to monitor your services. You can create multiple Telemetry Services and use them to monitor your services.",
-})
-@Entity({
-  name: "TelemetryService",
-})
-export default class TelemetryService extends BaseModel {
-  @ColumnAccessControl({
-    create: [
-      Permission.ProjectOwner,
-      Permission.ProjectAdmin,
-      Permission.ProjectMember,
-      Permission.CreateTelemetryService,
-    ],
-    read: [
-      Permission.ProjectOwner,
-      Permission.ProjectAdmin,
-      Permission.ProjectMember,
-      Permission.ProjectMember,
-      Permission.ReadTelemetryService,
-    ],
-    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.ProjectMember,
-      Permission.CreateTelemetryService,
-    ],
-    read: [
-      Permission.ProjectOwner,
-      Permission.ProjectAdmin,
-      Permission.ProjectMember,
-      Permission.ProjectMember,
-      Permission.ReadTelemetryService,
-    ],
-    update: [],
-  })
-  @Index()
-  @TableColumn({
-    type: TableColumnType.ObjectID,
-    required: true,
-    canReadOnRelationQuery: true,
-    title: "Project ID",
-    description: "ID of your OneUptime Project in which this object belongs",
-    example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
-  })
-  @Column({
-    type: ColumnType.ObjectID,
-    nullable: false,
-    transformer: ObjectID.getDatabaseTransformer(),
-  })
-  public projectId?: ObjectID = undefined;
-
-  @ColumnAccessControl({
-    create: [
-      Permission.ProjectOwner,
-      Permission.ProjectAdmin,
-      Permission.ProjectMember,
-      Permission.CreateTelemetryService,
-    ],
-    read: [
-      Permission.ProjectOwner,
-      Permission.ProjectAdmin,
-      Permission.ProjectMember,
-      Permission.ProjectMember,
-      Permission.ReadTelemetryService,
-    ],
-    update: [
-      Permission.ProjectOwner,
-      Permission.ProjectAdmin,
-      Permission.ProjectMember,
-      Permission.EditTelemetryService,
-    ],
-  })
-  @TableColumn({
-    required: true,
-    type: TableColumnType.ShortText,
-    canReadOnRelationQuery: true,
-    title: "Name",
-    description: "Any friendly name of this object",
-    example: "Payment API Service",
-  })
-  @Column({
-    nullable: false,
-    type: ColumnType.ShortText,
-    length: ColumnLength.ShortText,
-  })
-  @UniqueColumnBy("projectId")
-  public name?: string = undefined;
-
-  @ColumnAccessControl({
-    create: [],
-    read: [
-      Permission.ProjectOwner,
-      Permission.ProjectAdmin,
-      Permission.ProjectMember,
-      Permission.ProjectMember,
-      Permission.ReadTelemetryService,
-    ],
-    update: [],
-  })
-  @TableColumn({
-    required: true,
-    unique: true,
-    type: TableColumnType.Slug,
-    computed: true,
-    title: "Slug",
-    description: "Friendly globally unique name for your object",
-  })
-  @Column({
-    nullable: false,
-    type: ColumnType.Slug,
-    length: ColumnLength.Slug,
-  })
-  public slug?: string = undefined;
-
-  @ColumnAccessControl({
-    create: [
-      Permission.ProjectOwner,
-      Permission.ProjectAdmin,
-      Permission.ProjectMember,
-      Permission.CreateTelemetryService,
-    ],
-    read: [
-      Permission.ProjectOwner,
-      Permission.ProjectAdmin,
-      Permission.ProjectMember,
-      Permission.ProjectMember,
-      Permission.ReadTelemetryService,
-    ],
-    update: [
-      Permission.ProjectOwner,
-      Permission.ProjectAdmin,
-      Permission.ProjectMember,
-      Permission.EditTelemetryService,
-    ],
-  })
-  @TableColumn({
-    required: false,
-    type: TableColumnType.LongText,
-    title: "Description",
-    description: "Friendly description that will help you remember",
-    example: "Telemetry and monitoring for the payment processing API service",
-  })
-  @Column({
-    nullable: true,
-    type: ColumnType.LongText,
-    length: ColumnLength.LongText,
-  })
-  public description?: string = undefined;
-
-  @ColumnAccessControl({
-    create: [
-      Permission.ProjectOwner,
-      Permission.ProjectAdmin,
-      Permission.ProjectMember,
-      Permission.CreateTelemetryService,
-    ],
-    read: [
-      Permission.ProjectOwner,
-      Permission.ProjectAdmin,
-      Permission.ProjectMember,
-      Permission.ProjectMember,
-      Permission.ReadTelemetryService,
-    ],
-    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.ProjectMember,
-      Permission.CreateTelemetryService,
-    ],
-    read: [
-      Permission.ProjectOwner,
-      Permission.ProjectAdmin,
-      Permission.ProjectMember,
-      Permission.ProjectMember,
-      Permission.ReadTelemetryService,
-    ],
-    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)",
-    example: "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
-  })
-  @Column({
-    type: ColumnType.ObjectID,
-    nullable: true,
-    transformer: ObjectID.getDatabaseTransformer(),
-  })
-  public createdByUserId?: ObjectID = undefined;
-
-  @ColumnAccessControl({
-    create: [],
-    read: [
-      Permission.ProjectOwner,
-      Permission.ProjectAdmin,
-      Permission.ProjectMember,
-      Permission.ProjectMember,
-      Permission.ReadTelemetryService,
-    ],
-    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: [
-      Permission.ProjectOwner,
-      Permission.ProjectAdmin,
-      Permission.ProjectMember,
-      Permission.ProjectMember,
-      Permission.ReadTelemetryService,
-    ],
-    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)",
-    example: "b2c3d4e5-f6a7-8901-bcde-f2345678901a",
-  })
-  @Column({
-    type: ColumnType.ObjectID,
-    nullable: true,
-    transformer: ObjectID.getDatabaseTransformer(),
-  })
-  public deletedByUserId?: ObjectID = undefined;
-
-  @ColumnAccessControl({
-    create: [
-      Permission.ProjectOwner,
-      Permission.ProjectAdmin,
-      Permission.ProjectMember,
-      Permission.CreateTelemetryService,
-    ],
-    read: [
-      Permission.ProjectOwner,
-      Permission.ProjectAdmin,
-      Permission.ProjectMember,
-      Permission.ProjectMember,
-      Permission.ReadTelemetryService,
-    ],
-    update: [
-      Permission.ProjectOwner,
-      Permission.ProjectAdmin,
-      Permission.ProjectMember,
-      Permission.EditTelemetryService,
-    ],
-  })
-  @TableColumn({
-    required: false,
-    type: TableColumnType.EntityArray,
-    modelType: Label,
-    title: "Labels",
-    description:
-      "Relation to Labels Array where this object is categorized in.",
-  })
-  @ManyToMany(
-    () => {
-      return Label;
-    },
-    { eager: false },
-  )
-  @JoinTable({
-    name: "TelemetryServiceLabel",
-    inverseJoinColumn: {
-      name: "labelId",
-      referencedColumnName: "_id",
-    },
-    joinColumn: {
-      name: "telemetryServiceId",
-      referencedColumnName: "_id",
-    },
-  })
-  public labels?: Array<Label> = undefined;
-
-  // This field is deprecared and is no longer used.
-  @ColumnAccessControl({
-    create: [],
-    read: [
-      Permission.ProjectOwner,
-      Permission.ProjectAdmin,
-      Permission.ProjectMember,
-      Permission.ProjectMember,
-      Permission.ReadTelemetryService,
-    ],
-    update: [
-      Permission.ProjectOwner,
-      Permission.ProjectAdmin,
-      Permission.ProjectMember,
-      Permission.EditTelemetryService,
-    ],
-  })
-  @Index()
-  @TableColumn({
-    type: TableColumnType.ObjectID,
-    isDefaultValueColumn: false,
-    computed: true,
-    title: "Service Token",
-    description: "Service Token for this telemetry service",
-    example: "e5f6a7b8-c9d0-1234-efab-56789012cdef",
-  })
-  @Column({
-    type: ColumnType.ObjectID,
-    nullable: false,
-    transformer: ObjectID.getDatabaseTransformer(),
-  })
-  public telemetryServiceToken?: ObjectID = undefined;
-
-  @ColumnAccessControl({
-    create: [
-      Permission.ProjectOwner,
-      Permission.ProjectAdmin,
-      Permission.ProjectMember,
-      Permission.CreateTelemetryService,
-    ],
-    read: [
-      Permission.ProjectOwner,
-      Permission.ProjectAdmin,
-      Permission.ProjectMember,
-      Permission.ProjectMember,
-      Permission.ReadTelemetryService,
-    ],
-    update: [
-      Permission.ProjectOwner,
-      Permission.ProjectAdmin,
-      Permission.ProjectMember,
-      Permission.EditTelemetryService,
-    ],
-  })
-  @TableColumn({
-    type: TableColumnType.Number,
-    title: "Retain Telemetry Data For Days",
-    description: "Number of days to retain telemetry data for this service.",
-  })
-  @Column({
-    type: ColumnType.Number,
-    nullable: true,
-    unique: false,
-    default: 15,
-  })
-  public retainTelemetryDataForDays?: number = undefined;
-
-  @ColumnAccessControl({
-    create: [
-      Permission.ProjectOwner,
-      Permission.ProjectAdmin,
-      Permission.ProjectMember,
-      Permission.CreateTelemetryService,
-    ],
-    read: [
-      Permission.ProjectOwner,
-      Permission.ProjectAdmin,
-      Permission.ProjectMember,
-      Permission.ProjectMember,
-      Permission.ReadTelemetryService,
-    ],
-    update: [
-      Permission.ProjectOwner,
-      Permission.ProjectAdmin,
-      Permission.ProjectMember,
-      Permission.EditTelemetryService,
-    ],
-  })
-  @ColorField()
-  @TableColumn({
-    type: TableColumnType.Color,
-    title: "Service Color",
-    description: "Color for this telemetry service",
-    canReadOnRelationQuery: true,
-  })
-  @Column({
-    type: ColumnType.Color,
-    nullable: true,
-    unique: false,
-    transformer: Color.getDatabaseTransformer(),
-  })
-  public serviceColor?: Color = undefined;
-}

package/Server/Services/ServiceTelemetryServiceService.ts

@@ -1,59 +0,0 @@
-import BadDataException from "../../Types/Exception/BadDataException";
-import CreateBy from "../Types/Database/CreateBy";
-import { OnCreate } from "../Types/Database/Hooks";
-import DatabaseService from "./DatabaseService";
-import Model from "../../Models/DatabaseModels/ServiceTelemetryService";
-import ObjectID from "../../Types/ObjectID";
-import CaptureSpan from "../Utils/Telemetry/CaptureSpan";
-
-export class Service extends DatabaseService<Model> {
-  public constructor() {
-    super(Model);
-  }
-
-  @CaptureSpan()
-  protected override async onBeforeCreate(
-    createBy: CreateBy<Model>,
-  ): Promise<OnCreate<Model>> {
-    // select a random color.
-
-    if (!createBy.data.serviceId && !createBy.data.service) {
-      throw new BadDataException("service is required");
-    }
-
-    if (!createBy.data.telemetryService && !createBy.data.telemetryServiceId) {
-      throw new BadDataException("telemetryService is required");
-    }
-
-    // serviceId and dependencyServiceId should not be the same
-    const serviceId: string | ObjectID | undefined =
-      createBy.data.serviceId || createBy.data.service?._id;
-    const telemetryServiceId: string | ObjectID | undefined =
-      createBy.data.telemetryServiceId || createBy.data.telemetryService?._id;
-
-    // check if this telemetryService is already added to the service for this service.
-
-    const existingtelemetryService: Model | null = await this.findOneBy({
-      query: {
-        serviceId: serviceId as ObjectID,
-        telemetryServiceId: telemetryServiceId as ObjectID,
-      },
-      props: {
-        isRoot: true,
-      },
-    });
-
-    if (existingtelemetryService) {
-      throw new BadDataException(
-        "Telemetry Service already exists for this service",
-      );
-    }
-
-    return {
-      carryForward: null,
-      createBy: createBy,
-    };
-  }
-}
-
-export default new Service();

package/Server/Services/TelemetryServiceService.ts

@@ -1,53 +0,0 @@
-import CreateBy from "../Types/Database/CreateBy";
-import { OnCreate } from "../Types/Database/Hooks";
-import DatabaseService from "./DatabaseService";
-import ArrayUtil from "../../Utils/Array";
-import { BrightColors } from "../../Types/BrandColors";
-import BadDataException from "../../Types/Exception/BadDataException";
-import ObjectID from "../../Types/ObjectID";
-import Model from "../../Models/DatabaseModels/TelemetryService";
-import CaptureSpan from "../Utils/Telemetry/CaptureSpan";
-
-export class Service extends DatabaseService<Model> {
-  public constructor() {
-    super(Model);
-  }
-
-  @CaptureSpan()
-  protected override async onBeforeCreate(
-    createBy: CreateBy<Model>,
-  ): Promise<OnCreate<Model>> {
-    createBy.data.telemetryServiceToken = ObjectID.generate();
-
-    // select a random color.
-    createBy.data.serviceColor = ArrayUtil.selectItemByRandom(BrightColors);
-
-    return {
-      carryForward: null,
-      createBy: createBy,
-    };
-  }
-
-  @CaptureSpan()
-  public async getTelemetryDataRetentionInDays(
-    telemetryServiceId: ObjectID,
-  ): Promise<number> {
-    const project: Model | null = await this.findOneById({
-      id: telemetryServiceId,
-      select: {
-        retainTelemetryDataForDays: true,
-      },
-      props: {
-        isRoot: true,
-      },
-    });
-
-    if (!project) {
-      throw new BadDataException("Project not found");
-    }
-
-    return project.retainTelemetryDataForDays || 15; // default is 15 days.
-  }
-}
-
-export default new Service();