@oneuptime/common 7.0.2972 → 7.0.2981

package/Models/AnalyticsModels/AnalyticsBaseModel/CommonModel.ts

@@ -9,6 +9,7 @@ import LessThan from "../../../Types/BaseDatabase/LessThan";
 import LessThanOrEqual from "../../../Types/BaseDatabase/LessThanOrEqual";
 import NotEqual from "../../../Types/BaseDatabase/NotEqual";
 import Search from "../../../Types/BaseDatabase/Search";
+import { CompareType } from "../../../Types/Database/CompareBase";
 import OneUptimeDate from "../../../Types/Date";
 import BadDataException from "../../../Types/Exception/BadDataException";
 import { JSONArray, JSONObject, JSONValue } from "../../../Types/JSON";
@@ -21,15 +22,15 @@ export type RecordValue =
   | number
   | boolean
   | Date
-  | Search
-  | NotEqual
-  | GreaterThan
-  | InBetween
+  | Search<string>
+  | NotEqual<CompareType>
+  | GreaterThan<CompareType>
+  | InBetween<CompareType>
   | Includes
   | Date
-  | LessThan
-  | LessThanOrEqual
-  | GreaterThanOrEqual
+  | LessThan<CompareType>
+  | LessThanOrEqual<CompareType>
+  | GreaterThanOrEqual<CompareType>
   | Array<number>
   | Array<string>
   | Array<ObjectID>

package/Models/DatabaseModels/Monitor.ts

@@ -709,6 +709,42 @@ export default class Monitor extends BaseModel {
   })
   public incomingRequestReceivedAt?: Date = undefined;
 
+  @ColumnAccessControl({
+    create: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.CreateProjectMonitor,
+    ],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.ReadProjectMonitor,
+    ],
+    update: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.CreateProjectMonitor,
+    ],
+  })
+  @Index()
+  @TableColumn({
+    type: TableColumnType.Date,
+    required: false,
+    isDefaultValueColumn: false,
+    title:
+      "When was the last time we checked the heartbeat for incoming request?",
+    description:
+      "This field is for Incoming Request monitor only. When was the last time we checked the heartbeat?",
+  })
+  @Column({
+    type: ColumnType.Date,
+    nullable: true,
+  })
+  public incomingRequestMonitorHeartbeatCheckedAt?: Date = undefined;
+
   @ColumnAccessControl({
     create: [
       Permission.ProjectOwner,

package/Models/DatabaseModels/StatusPage.ts

@@ -39,6 +39,7 @@ import {
   ManyToMany,
   ManyToOne,
 } from "typeorm";
+import UptimePrecision from "../../Types/StatusPage/UptimePrecision";
 
 @EnableDocumentation()
 @AccessControlColumn("labels")
@@ -1864,4 +1865,74 @@ export default class StatusPage extends BaseModel {
     create: PlanType.Free,
   })
   public reportDataInDays?: number = undefined;
+
+  @ColumnAccessControl({
+    create: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.CreateProjectStatusPage,
+    ],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.ReadProjectStatusPage,
+    ],
+    update: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.EditProjectStatusPage,
+    ],
+  })
+  @TableColumn({
+    isDefaultValueColumn: true,
+    type: TableColumnType.Boolean,
+    title: "Show Overall Uptime Percent on Status Page",
+    description: "Show Overall Uptime Percent on Status Page?",
+  })
+  @Column({
+    type: ColumnType.Boolean,
+    default: false,
+  })
+  @ColumnBillingAccessControl({
+    read: PlanType.Free,
+    update: PlanType.Scale,
+    create: PlanType.Free,
+  })
+  public showOverallUptimePercentOnStatusPage?: boolean = undefined;
+
+  @ColumnAccessControl({
+    create: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.CreateProjectStatusPage,
+    ],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.ReadProjectStatusPage,
+    ],
+    update: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.EditProjectStatusPage,
+    ],
+  })
+  @TableColumn({
+    type: TableColumnType.ShortText,
+    title: "Overall Uptime Percent Precision",
+    required: false,
+    description: "Overall Precision of uptime percent for this status page.",
+  })
+  @Column({
+    type: ColumnType.ShortText,
+    nullable: true,
+    default: UptimePrecision.TWO_DECIMAL,
+  })
+  public overallUptimePercentPrecision?: UptimePrecision = undefined;
 }

package/Models/DatabaseModels/StatusPageResource.ts

@@ -23,13 +23,7 @@ import IconProp from "../../Types/Icon/IconProp";
 import ObjectID from "../../Types/ObjectID";
 import Permission from "../../Types/Permission";
 import { Column, Entity, Index, JoinColumn, ManyToOne } from "typeorm";
-
-export enum UptimePrecision {
-  NO_DECIMAL = "99% (No Decimal)",
-  ONE_DECIMAL = "99.9% (One Decimal)",
-  TWO_DECIMAL = "99.99% (Two Decimal)",
-  THREE_DECIMAL = "99.999% (Three Decimal)",
-}
+import UptimePrecision from "../../Types/StatusPage/UptimePrecision";
 
 @EnableDocumentation()
 @CanAccessIfCanReadOn("statusPage")

package/Server/API/BaseAnalyticsAPI.ts

@@ -234,9 +234,7 @@ export default class BaseAnalyticsAPI<
     let groupBy: GroupBy<AnalyticsDataModel> = {};
 
     if (req.body) {
-      query = JSONFunctions.deserialize(
-        req.body["query"],
-      ) as Query<AnalyticsDataModel>;
+      query = JSONFunctions.deserialize(req.body["query"]) as Query<any>;
 
       select = JSONFunctions.deserialize(
         req.body["select"],
@@ -316,9 +314,7 @@ export default class BaseAnalyticsAPI<
     await this.onBeforeCount(req, res);
 
     if (req.body) {
-      query = JSONFunctions.deserialize(
-        req.body["query"],
-      ) as Query<AnalyticsDataModel>;
+      query = JSONFunctions.deserialize(req.body["query"]) as Query<any>;
     }
 
     const databaseProps: DatabaseCommonInteractionProps =

package/Server/API/StatusPageAPI.ts

@@ -494,6 +494,8 @@ export default class StatusPageAPI extends BaseAPI<
                   _id: true,
                 },
                 defaultBarColor: true,
+                showOverallUptimePercentOnStatusPage: true,
+                overallUptimePercentPrecision: true,
               },
               props: {
                 isRoot: true,

package/Server/Infrastructure/Postgres/SchemaMigrations/1723825511054-MigrationName.ts

@@ -0,0 +1,17 @@
+import { MigrationInterface, QueryRunner } from "typeorm";
+
+export class MigrationName1723825511054 implements MigrationInterface {
+  public name = "MigrationName1723825511054";
+
+  public async up(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(
+      `ALTER TABLE "StatusPage" ADD "showOverallUptimePercentOnStatusPage" boolean NOT NULL DEFAULT false`,
+    );
+  }
+
+  public async down(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(
+      `ALTER TABLE "StatusPage" DROP COLUMN "showOverallUptimePercentOnStatusPage"`,
+    );
+  }
+}

package/Server/Infrastructure/Postgres/SchemaMigrations/1723828588502-MigrationName.ts

@@ -0,0 +1,17 @@
+import { MigrationInterface, QueryRunner } from "typeorm";
+
+export class MigrationName1723828588502 implements MigrationInterface {
+  public name = "MigrationName1723828588502";
+
+  public async up(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(
+      `ALTER TABLE "StatusPage" ADD "overallUptimePercentPrecision" character varying DEFAULT '99.99% (Two Decimal)'`,
+    );
+  }
+
+  public async down(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(
+      `ALTER TABLE "StatusPage" DROP COLUMN "overallUptimePercentPrecision"`,
+    );
+  }
+}

package/Server/Infrastructure/Postgres/SchemaMigrations/1724078044172-MigrationName.ts

@@ -0,0 +1,23 @@
+import { MigrationInterface, QueryRunner } from "typeorm";
+
+export class MigrationName1724078044172 implements MigrationInterface {
+  public name = "MigrationName1724078044172";
+
+  public async up(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(
+      `ALTER TABLE "Monitor" ADD "incomingRequestMonitorHeartbeatCheckedAt" TIMESTAMP WITH TIME ZONE`,
+    );
+    await queryRunner.query(
+      `CREATE INDEX "IDX_62cf90e5fbcd9f3742ed35a2bb" ON "Monitor" ("incomingRequestMonitorHeartbeatCheckedAt") `,
+    );
+  }
+
+  public async down(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(
+      `DROP INDEX "public"."IDX_62cf90e5fbcd9f3742ed35a2bb"`,
+    );
+    await queryRunner.query(
+      `ALTER TABLE "Monitor" DROP COLUMN "incomingRequestMonitorHeartbeatCheckedAt"`,
+    );
+  }
+}

package/Server/Infrastructure/Postgres/SchemaMigrations/Index.ts

@@ -38,6 +38,9 @@ import { MigrationName1721779190475 } from "./1721779190475-MigrationName";
 import { MigrationName1722031205897 } from "./1722031205897-MigrationName";
 import { MigrationName1722543640526 } from "./1722543640526-MigrationName";
 import { MigrationName1722892318363 } from "./1722892318363-MigrationName";
+import { MigrationName1723825511054 } from "./1723825511054-MigrationName";
+import { MigrationName1723828588502 } from "./1723828588502-MigrationName";
+import { MigrationName1724078044172 } from "./1724078044172-MigrationName";
 
 export default [
   InitialMigration,
@@ -80,4 +83,7 @@ export default [
   MigrationName1722031205897,
   MigrationName1722543640526,
   MigrationName1722892318363,
+  MigrationName1723825511054,
+  MigrationName1723828588502,
+  MigrationName1724078044172,
 ];

package/Server/Services/AnalyticsDatabaseService.ts

@@ -208,8 +208,8 @@ export default class AnalyticsDatabaseService<
         aggregateBy.limit = 10;
       }
 
-      if (!aggregateBy.aggregateBy) {
-        throw new BadDataException("aggregateBy is required");
+      if (!aggregateBy.aggregationType) {
+        throw new BadDataException("aggregationType is required");
       }
 
       if (!aggregateBy.aggregationTimestampColumnName) {

package/Server/Services/DatabaseService.ts

@@ -18,7 +18,7 @@ import {
 } from "../Types/Database/Hooks";
 import ModelPermission from "../Types/Database/Permissions/Index";
 import { CheckReadPermissionType } from "../Types/Database/Permissions/ReadPermission";
-import Query, { FindWhere } from "../Types/Database/Query";
+import Query from "../Types/Database/Query";
 import QueryHelper from "../Types/Database/QueryHelper";
 import RelationSelect from "../Types/Database/RelationSelect";
 import SearchBy from "../Types/Database/SearchBy";
@@ -60,6 +60,7 @@ import API from "Common/Utils/API";
 import Slug from "Common/Utils/Slug";
 import { DataSource, Repository, SelectQueryBuilder } from "typeorm";
 import { QueryDeepPartialEntity } from "typeorm/query-builder/QueryPartialEntity";
+import { FindWhere } from "../../Types/BaseDatabase/Query";
 
 class DatabaseService<TBaseModel extends BaseModel> extends BaseService {
   public modelType!: { new (): TBaseModel };
@@ -691,7 +692,6 @@ class DatabaseService<TBaseModel extends BaseModel> extends BaseService {
           [totalItemsColumnName]:
             createdBy.data.getColumnValue(totalItemsColumnName),
         } as FindWhere<TBaseModel>,
-
         skip: 0,
         limit: LIMIT_MAX,
         props: {

package/Server/Services/MonitorService.ts

@@ -49,6 +49,7 @@ import { SMSMessage } from "../../Types/SMS/SMS";
 import { CallRequestMessage } from "../../Types/Call/CallRequest";
 import UserNotificationSettingService from "./UserNotificationSettingService";
 import NotificationSettingEventType from "../../Types/NotificationSetting/NotificationSettingEventType";
+import Query from "../Types/Database/Query";
 
 export class Service extends DatabaseService<Model> {
   public constructor() {
@@ -126,6 +127,14 @@ export class Service extends DatabaseService<Model> {
     return { updateBy, carryForward: null };
   }
 
+  public getEnabledMonitorQuery(): Query<Model> {
+    return {
+      disableActiveMonitoring: false, // do not fetch if disabled is true.
+      disableActiveMonitoringBecauseOfManualIncident: false,
+      disableActiveMonitoringBecauseOfScheduledMaintenanceEvent: false,
+    };
+  }
+
   protected override async onBeforeCreate(
     createBy: CreateBy<Model>,
   ): Promise<OnCreate<Model>> {

package/Server/Services/ProjectService.ts

@@ -48,8 +48,8 @@ import Team from "Common/Models/DatabaseModels/Team";
 import TeamMember from "Common/Models/DatabaseModels/TeamMember";
 import TeamPermission from "Common/Models/DatabaseModels/TeamPermission";
 import User from "Common/Models/DatabaseModels/User";
-import { In } from "typeorm";
 import Select from "../Types/Database/Select";
+import Query from "../Types/Database/Query";
 
 export interface CurrentPlan {
   plan: PlanType | null;
@@ -886,7 +886,7 @@ export class ProjectService extends DatabaseService<Model> {
       findBy.props.userGlobalAccessPermission?.projectIds.length === 0
     ) {
       findBy.props.isRoot = true;
-      findBy.query._id = In([]); // should not get any projects.
+      findBy.query._id = ObjectID.getZeroObjectID().toString(); // should not get any projects.
     }
 
     return { findBy, carryForward: null };
@@ -1114,6 +1114,20 @@ export class ProjectService extends DatabaseService<Model> {
     });
   }
 
+  public getActiveProjectStatusQuery(): Query<Model> {
+    return {
+      // get only active projects
+      paymentProviderSubscriptionStatus: QueryHelper.equalToOrNull([
+        SubscriptionStatus.Active,
+        SubscriptionStatus.Trialing,
+      ]),
+      paymentProviderMeteredSubscriptionStatus: QueryHelper.equalToOrNull([
+        SubscriptionStatus.Active,
+        SubscriptionStatus.Trialing,
+      ]),
+    };
+  }
+
   public async isSMSNotificationsEnabled(
     projectId: ObjectID,
   ): Promise<boolean> {

package/Server/Services/StatusPageHeaderLinkService.ts

@@ -192,7 +192,7 @@ export class Service extends DatabaseService<Model> {
     // get status page resource with this order.
     const resources: Array<Model> = await this.findBy({
       query: {
-        order: QueryHelper.greaterThanEqualTo(currentOrder),
+        order: QueryHelper.greaterThanEqualTo<number>(currentOrder),
         statusPageId: statusPageId,
       },
       limit: LIMIT_MAX,

package/Server/Services/StatusPageService.ts

@@ -43,9 +43,7 @@ import MailService from "./MailService";
 import EmailTemplateType from "../../Types/Email/EmailTemplateType";
 import { FileRoute } from "Common/ServiceRoute";
 import ProjectSMTPConfigService from "./ProjectSmtpConfigService";
-import StatusPageResource, {
-  UptimePrecision,
-} from "Common/Models/DatabaseModels/StatusPageResource";
+import StatusPageResource from "Common/Models/DatabaseModels/StatusPageResource";
 import StatusPageResourceService from "./StatusPageResourceService";
 import Dictionary from "../../Types/Dictionary";
 import MonitorGroupResource from "Common/Models/DatabaseModels/MonitorGroupResource";
@@ -57,6 +55,7 @@ import MonitorStatusTimeline from "Common/Models/DatabaseModels/MonitorStatusTim
 import MonitorStatusTimelineService from "./MonitorStatusTimelineService";
 import SortOrder from "../../Types/BaseDatabase/SortOrder";
 import UptimeUtil from "Common/Utils/Uptime/UptimeUtil";
+import UptimePrecision from "../../Types/StatusPage/UptimePrecision";
 
 export interface StatusPageReportItem {
   resourceName: string;
@@ -67,6 +66,7 @@ export interface StatusPageReportItem {
 }
 
 export interface StatusPageReport {
+  reportDates: string; // start date and end date in string. e.g. "01 July 2021 - 14 July 2021"
   totalResources: number;
   totalIncidents: number;
   averageUptimePercent: string;
@@ -755,8 +755,15 @@ export class Service extends DatabaseService<StatusPage> {
         statusPageId: data.statusPageId,
       });
 
+    const currentDate: Date = OneUptimeDate.getCurrentDate();
+    const startDate: Date = OneUptimeDate.getSomeDaysAgo(
+      data.historyDays || 14,
+    );
+    const startAndEndDate: string = `${OneUptimeDate.getDateAsLocalFormattedString(startDate, true)} - ${OneUptimeDate.getDateAsLocalFormattedString(currentDate, true)}`;
+
     if (statusPageResources.length === 0) {
       return {
+        reportDates: startAndEndDate,
         totalResources: 0,
         totalIncidents: 0,
         averageUptimePercent: "0%",
@@ -854,6 +861,7 @@ export class Service extends DatabaseService<StatusPage> {
     );
 
     return {
+      reportDates: startAndEndDate,
       totalResources: statusPageResources.length,
       totalIncidents: incidentCount,
       averageUptimePercent: avgUptimePercentString,

package/Server/Types/AnalyticsDatabase/QueryHelper.ts

@@ -3,9 +3,10 @@ import InBetween from "Common/Types/BaseDatabase/InBetween";
 import Includes from "Common/Types/BaseDatabase/Includes";
 import LessThan from "Common/Types/BaseDatabase/LessThan";
 import ObjectID from "Common/Types/ObjectID";
+import { CompareType } from "../../../Types/Database/CompareBase";
 
 export default class QueryHelper {
-  public static lessThan(value: Date | number): LessThan {
+  public static lessThan<T extends CompareType>(value: T): LessThan<T> {
     return new LessThan(value);
   }
 
@@ -13,14 +14,14 @@ export default class QueryHelper {
     return new Includes(values);
   }
 
-  public static greaterThan(value: Date | number): GreaterThan {
-    return new GreaterThan(value);
+  public static greaterThan<T extends CompareType>(value: T): GreaterThan<T> {
+    return new GreaterThan<T>(value);
   }
 
-  public static inBetween(
-    startValue: Date | number,
-    endValue: Date | number,
-  ): InBetween {
+  public static inBetween<T extends CompareType>(
+    startValue: T,
+    endValue: T,
+  ): InBetween<T> {
     return new InBetween(startValue, endValue);
   }
 }

package/Server/Types/Database/Query.ts

@@ -1,25 +1,11 @@
 import BaseModel from "Common/Models/DatabaseModels/DatabaseBaseModel/DatabaseBaseModel";
-import DatabaseProperty from "Common/Types/Database/DatabaseProperty";
-import { FindOperator, FindOptionsWhereProperty } from "typeorm";
+import BaseQuery, {
+  OrQuery as BaseQueryOrQuery,
+} from "../../../Types/BaseDatabase/Query";
 
-export declare type FindWhereProperty<Property> =
-  Property extends DatabaseProperty
-    ? Property | FindOperator<Property> | Array<Property>
-    : FindOptionsWhereProperty<Property>;
-/**
- * :
- * Used for find operations.
- */
-export declare type FindWhere<Entity> = {
-  [P in keyof Entity]?:
-    | FindWhereProperty<NonNullable<Entity[P]>>
-    | FindOperator<NonNullable<Entity[P]>>;
-};
+export declare type OrQuery<TBaseModel extends BaseModel> =
+  BaseQueryOrQuery<TBaseModel>;
 
-declare type Query<TBaseModel extends BaseModel> = FindWhere<TBaseModel>;
-
-export declare type OrQuery<TBaseModel extends BaseModel> = Array<
-  Query<TBaseModel>
->;
+declare type Query<TBaseModel extends BaseModel> = BaseQuery<TBaseModel>;
 
 export default Query;