@oneuptime/common 7.0.2928 → 7.0.2936

package/Tests/AppModels/File.test.ts

@@ -0,0 +1,10 @@
+import File from "../../Models/DatabaseModels/File";
+import { describe, expect, it } from "@jest/globals";
+import BaseModel from "../../Models/DatabaseModels/DatabaseBaseModel/DatabaseBaseModel";
+
+describe("File", () => {
+  it("should be an instance of BaseModel", () => {
+    const file: File = new File();
+    expect(file).toBeInstanceOf(BaseModel);
+  });
+});

package/Tests/Types/Database/Date.test.ts

@@ -19,9 +19,13 @@ describe("DatabaseDate", () => {
       const expectedEnd: string = moment(inputDate)
         .endOf("day")
         .format("YYYY-MM-DD HH:mm:ss");
-      expect(result).toEqual({
-        startValue: expectedStart,
-        endValue: expectedEnd,
+      expect({
+        startValue: result["startValue"]?.toString(),
+        endValue: result["endValue"]?.toString(),
+        ...result,
+      }).toEqual({
+        startValue: expectedStart.toString(),
+        endValue: expectedEnd.toString(),
         _type: "InBetween",
       });
     });
@@ -32,15 +36,16 @@ describe("DatabaseDate", () => {
         DatabaseDate.asDateStartOfTheDayEndOfTheDayForDatabaseQuery(
           inputDate,
         ).toJSON();
-      const expectedStart: string = moment(inputDate)
-        .startOf("day")
-        .format("YYYY-MM-DD HH:mm:ss");
-      const expectedEnd: string = moment(inputDate)
-        .endOf("day")
-        .format("YYYY-MM-DD HH:mm:ss");
-      expect(result).toEqual({
-        startValue: expectedStart,
-        endValue: expectedEnd,
+      const expectedStart: Date = moment(inputDate).startOf("day").toDate();
+      const expectedEnd: Date = moment(inputDate).endOf("day").toDate();
+
+      expect({
+        startValue: result["startValue"]?.toString(),
+        endValue: result["endValue"]?.toString(),
+        ...result,
+      }).toEqual({
+        startValue: expectedStart.toString(),
+        endValue: expectedEnd.toString(),
         _type: "InBetween",
       });
     });

package/Tests/Types/JSONFunctions.test.ts

@@ -1,5 +1,5 @@
-import BaseModel from "../../Models/BaseModel";
 import { JSONObject } from "../../Types/JSON";
+import BaseModel from "../../Models/DatabaseModels/DatabaseBaseModel/DatabaseBaseModel";
 import JSONFunctions from "../../Types/JSONFunctions";
 
 describe("JSONFunctions Class", () => {

package/Types/API/HTTPResponse.ts

@@ -1,5 +1,5 @@
-import AnalyticsBaseModel from "../../AnalyticsModels/BaseModel";
-import BaseModel from "../../Models/BaseModel";
+import AnalyticsBaseModel from "../../Models/AnalyticsModels/AnalyticsBaseModel/AnalyticsBaseModel";
+import BaseModel from "../../Models/DatabaseModels/DatabaseBaseModel/DatabaseBaseModel";
 import { JSONArray, JSONObject, JSONObjectOrArray } from "../JSON";
 import JSONFunctions from "../JSONFunctions";
 import Typeof from "../Typeof";

package/Types/AnalyticsDatabase/TableColumn.ts

@@ -1,4 +1,4 @@
-import NestedModel from "../../AnalyticsModels/NestedModel";
+import NestedModel from "../../Models/AnalyticsModels/AnalyticsBaseModel/NestedModel";
 import TableColumnType from "../AnalyticsDatabase/TableColumnType";
 import { ColumnAccessControl } from "../BaseDatabase/AccessControl";
 import ColumnBillingAccessControl from "../BaseDatabase/ColumnBillingAccessControl";

package/Types/BaseDatabase/InBetween.ts

@@ -25,8 +25,24 @@ export default class InBetween extends SerializableObject {
     endValue: number | Date | string,
   ) {
     super();
-    this.endValue = endValue;
-    this.startValue = startValue;
+
+    if (
+      typeof startValue === "string" &&
+      OneUptimeDate.isValidDateString(startValue)
+    ) {
+      this.startValue = OneUptimeDate.fromString(startValue);
+    } else {
+      this.startValue = startValue;
+    }
+
+    if (
+      typeof endValue === "string" &&
+      OneUptimeDate.isValidDateString(endValue)
+    ) {
+      this.endValue = OneUptimeDate.fromString(endValue);
+    } else {
+      this.endValue = endValue;
+    }
   }
 
   public override toJSON(): JSONObject {

package/Types/Database/AccessControl/ColumnAccessControl.ts

@@ -1,4 +1,4 @@
-import BaseModel from "../../../Models/BaseModel";
+import BaseModel from "../../../Models/DatabaseModels/DatabaseBaseModel/DatabaseBaseModel";
 import { ColumnAccessControl } from "../../BaseDatabase/AccessControl";
 import Dictionary from "../../Dictionary";
 import { ReflectionMetadataType } from "../../Reflection";

package/Types/Database/AccessControl/ColumnBillingAccessControl.ts

@@ -1,4 +1,4 @@
-import BaseModel from "../../../Models/BaseModel";
+import BaseModel from "../../../Models/DatabaseModels/DatabaseBaseModel/DatabaseBaseModel";
 import ColumnBillingAccessControl from "../../BaseDatabase/ColumnBillingAccessControl";
 import Dictionary from "../../Dictionary";
 import { ReflectionMetadataType } from "../../Reflection";

package/Types/Database/TableColumn.ts

@@ -1,4 +1,4 @@
-import BaseModel, { BaseModelType } from "../../Models/BaseModel";
+import BaseModel from "../../Models/DatabaseModels/DatabaseBaseModel/DatabaseBaseModel";
 import Dictionary from "../Dictionary";
 import { ReflectionMetadataType } from "../Reflection";
 import TableColumnType from "./TableColumnType";
@@ -18,7 +18,7 @@ export interface TableColumnMetadata {
   manyToOneRelationColumn?: string;
   type: TableColumnType;
   canReadOnRelationQuery?: boolean;
-  modelType?: BaseModelType;
+  modelType?: { new (): BaseModel };
   forceGetDefaultValueOnCreate?: () => string | number | boolean; // overwrites any value that is being passed and generates a new one. Useful for generating OTPs, etc.
 }
 

package/Types/Database/UniqueColumnBy.ts

@@ -1,4 +1,4 @@
-import BaseModel from "../../Models/BaseModel";
+import BaseModel from "../../Models/DatabaseModels/DatabaseBaseModel/DatabaseBaseModel";
 import Dictionary from "../Dictionary";
 import { ReflectionMetadataType } from "../Reflection";
 import "reflect-metadata";

package/Types/Date.ts

@@ -849,6 +849,49 @@ export default class OneUptimeDate {
     return months;
   }
 
+  public static convertSecondsToDaysHoursMinutesAndSeconds(
+    seconds: number,
+  ): string {
+    // should output 2 days, 3 hours, 4 minutes and 5 seconds. If the days are 0, it should not show the days. If the hours are 0, it should not show the hours. If the minutes are 0, it should not show the minutes. If the seconds are 0, it should not show the seconds.
+
+    const days: number = Math.floor(seconds / (24 * 60 * 60));
+    const hours: number = Math.floor((seconds % (24 * 60 * 60)) / (60 * 60));
+    const minutes: number = Math.floor((seconds % (60 * 60)) / 60);
+    const secs: number = seconds % 60;
+
+    let formattedString: string = "";
+
+    if (days > 0) {
+      formattedString += days + " days";
+    }
+
+    if (hours > 0) {
+      if (formattedString.length > 0) {
+        formattedString += ", ";
+      }
+
+      formattedString += hours + " hours";
+    }
+
+    if (minutes > 0) {
+      if (formattedString.length > 0) {
+        formattedString += ", ";
+      }
+
+      formattedString += minutes + " minutes";
+    }
+
+    if (secs > 0) {
+      if (formattedString.length > 0) {
+        formattedString += ", ";
+      }
+
+      formattedString += secs + " seconds";
+    }
+
+    return formattedString;
+  }
+
   public static convertMinutesToDaysHoursAndMinutes(minutes: number): string {
     // should output 2 days, 3 hours and 4 minutes. If the days are 0, it should not show the days. If the hours are 0, it should not show the hours. If the minutes are 0, it should not show the minutes.
 
@@ -892,6 +935,10 @@ export default class OneUptimeDate {
     return this.getGmtOffsetFriendlyString(offset) + " " + timezone;
   }
 
+  public static isValidDateString(date: string): boolean {
+    return moment(date).isValid();
+  }
+
   public static getGmtOffsetFriendlyString(offset: number): string {
     const hours: number = Math.abs(offset) / 60;
     const minutes: number = Math.abs(offset) % 60;

package/Types/JSONFunctions.ts

@@ -1,4 +1,4 @@
-import BaseModel from "../Models/BaseModel";
+import BaseModel from "../Models/DatabaseModels/DatabaseBaseModel/DatabaseBaseModel";
 import DatabaseProperty from "./Database/DatabaseProperty";
 import OneUptimeDate from "./Date";
 import DiskSize from "./DiskSize";
@@ -261,6 +261,8 @@ export default class JSONFunctions {
       return val;
     } else if (val instanceof DatabaseProperty) {
       return val;
+    } else if (val instanceof SerializableObject) {
+      return val;
     } else if (
       val &&
       typeof val === Typeof.Object &&

package/Types/Log/LogSeverity.ts

@@ -0,0 +1,11 @@
+enum LogSeverity {
+  Unspecified = "Unspecified",
+  Information = "Information",
+  Warning = "Warning",
+  Error = "Error",
+  Trace = "Trace",
+  Debug = "Debug",
+  Fatal = "Fatal",
+}
+
+export default LogSeverity;

package/Types/Monitor/CriteriaFilter.ts

@@ -34,6 +34,9 @@ export enum CheckOn {
 
   ScreenSizeType = "Screen Size",
   BrowserType = "Browser Type",
+
+  // Log monitors.
+  LogCount = "Log Count",
 }
 
 export interface ServerMonitorOptions {

package/Types/Monitor/LogMonitor/LogMonitorResponse.ts

@@ -0,0 +1,8 @@
+import { JSONObject } from "../../JSON";
+import ObjectID from "../../ObjectID";
+
+export default interface LogMonitorResponse {
+  logCount: number;
+  logQuery: JSONObject;
+  monitorId: ObjectID;
+}

package/Types/Monitor/MonitorCriteriaInstance.ts

@@ -80,6 +80,31 @@ export default class MonitorCriteriaInstance extends DatabaseProperty {
       return monitorCriteriaInstance;
     }
 
+    if (arg.monitorType === MonitorType.Logs) {
+      const monitorCriteriaInstance: MonitorCriteriaInstance =
+        new MonitorCriteriaInstance();
+
+      monitorCriteriaInstance.data = {
+        id: ObjectID.generate().toString(),
+        monitorStatusId: arg.monitorStatusId,
+        filterCondition: FilterCondition.Any,
+        filters: [
+          {
+            checkOn: CheckOn.LogCount,
+            filterType: FilterType.GreaterThan,
+            value: 0, // if there are some logs then monitor is online.
+          },
+        ],
+        incidents: [],
+        changeMonitorStatus: true,
+        createIncidents: false,
+        name: `Check if ${arg.monitorName} is online`,
+        description: `This criteria checks if the ${arg.monitorName} is online`,
+      };
+
+      return monitorCriteriaInstance;
+    }
+
     if (arg.monitorType === MonitorType.SSLCertificate) {
       const monitorCriteriaInstance: MonitorCriteriaInstance =
         new MonitorCriteriaInstance();
@@ -283,6 +308,35 @@ export default class MonitorCriteriaInstance extends DatabaseProperty {
       };
     }
 
+    if (arg.monitorType === MonitorType.Logs) {
+      monitorCriteriaInstance.data = {
+        id: ObjectID.generate().toString(),
+        monitorStatusId: arg.monitorStatusId,
+        filterCondition: FilterCondition.Any,
+        filters: [
+          {
+            checkOn: CheckOn.LogCount,
+            filterType: FilterType.EqualTo,
+            value: 0, // if there are no logs then the monitor is offline
+          },
+        ],
+        incidents: [
+          {
+            title: `${arg.monitorName} is offline`,
+            description: `${arg.monitorName} is currently offline.`,
+            incidentSeverityId: arg.incidentSeverityId,
+            autoResolveIncident: true,
+            id: ObjectID.generate().toString(),
+            onCallPolicyIds: [],
+          },
+        ],
+        changeMonitorStatus: true,
+        createIncidents: true,
+        name: `Check if ${arg.monitorName} is offline`,
+        description: `This criteria checks if the ${arg.monitorName} is offline`,
+      };
+    }
+
     if (arg.monitorType === MonitorType.IncomingRequest) {
       monitorCriteriaInstance.data = {
         id: ObjectID.generate().toString(),

package/Types/Monitor/MonitorStep.ts

@@ -10,6 +10,9 @@ import JSONFunctions from "../JSONFunctions";
 import ObjectID from "../ObjectID";
 import Port from "../Port";
 import MonitorCriteria from "./MonitorCriteria";
+import MonitorStepLogMonitor, {
+  MonitorStepLogMonitorUtil,
+} from "./MonitorStepLogMonitor";
 import MonitorType from "./MonitorType";
 import BrowserType from "./SyntheticMonitors//BrowserType";
 import ScreenSizeType from "./SyntheticMonitors/ScreenSizeType";
@@ -35,6 +38,9 @@ export interface MonitorStepType {
   // this is for synthetic monitors.
   screenSizeTypes?: Array<ScreenSizeType> | undefined;
   browserTypes?: Array<BrowserType> | undefined;
+
+  // Log monitor type.
+  logMonitor?: MonitorStepLogMonitor | undefined;
 }
 
 export default class MonitorStep extends DatabaseProperty {
@@ -54,6 +60,7 @@ export default class MonitorStep extends DatabaseProperty {
       customCode: undefined,
       screenSizeTypes: undefined,
       browserTypes: undefined,
+      logMonitor: undefined,
     };
   }
 
@@ -77,6 +84,7 @@ export default class MonitorStep extends DatabaseProperty {
       customCode: undefined,
       screenSizeTypes: undefined,
       browserTypes: undefined,
+      logMonitor: undefined,
     };
 
     return monitorStep;
@@ -133,6 +141,11 @@ export default class MonitorStep extends DatabaseProperty {
     return this;
   }
 
+  public setLogMonitor(logMonitor: MonitorStepLogMonitor): MonitorStep {
+    this.data!.logMonitor = logMonitor;
+    return this;
+  }
+
   public setCustomCode(customCode: string): MonitorStep {
     this.data!.customCode = customCode;
     return this;
@@ -157,6 +170,7 @@ export default class MonitorStep extends DatabaseProperty {
         customCode: undefined,
         screenSizeTypes: undefined,
         browserTypes: undefined,
+        lgoMonitor: undefined,
       },
     };
   }
@@ -240,6 +254,11 @@ export default class MonitorStep extends DatabaseProperty {
           customCode: this.data.customCode || undefined,
           screenSizeTypes: this.data.screenSizeTypes || undefined,
           browserTypes: this.data.browserTypes || undefined,
+          logMonitor: this.data.logMonitor
+            ? MonitorStepLogMonitorUtil.toJSON(
+                this.data.logMonitor || MonitorStepLogMonitorUtil.getDefault(),
+              )
+            : undefined,
         },
       });
     }
@@ -328,8 +347,15 @@ export default class MonitorStep extends DatabaseProperty {
       screenSizeTypes:
         (json["screenSizeTypes"] as Array<ScreenSizeType>) || undefined,
       browserTypes: (json["browserTypes"] as Array<BrowserType>) || undefined,
+      logMonitor: json["logMonitor"]
+        ? (json["logMonitor"] as JSONObject)
+        : undefined,
     }) as any;
 
+    if (monitorStep.data && !monitorStep.data?.logMonitor) {
+      monitorStep.data.logMonitor = MonitorStepLogMonitorUtil.getDefault();
+    }
+
     return monitorStep;
   }
 

package/Types/Monitor/MonitorStepLogMonitor.ts

@@ -0,0 +1,95 @@
+import Log from "../../Models/AnalyticsModels/Log";
+import InBetween from "../BaseDatabase/InBetween";
+import Includes from "../BaseDatabase/Includes";
+import Query from "../BaseDatabase/Query";
+import Search from "../BaseDatabase/Search";
+import OneUptimeDate from "../Date";
+import Dictionary from "../Dictionary";
+import { JSONObject } from "../JSON";
+import LogSeverity from "../Log/LogSeverity";
+import ObjectID from "../ObjectID";
+
+export default interface MonitorStepLogMonitor {
+  attributes: Dictionary<string | number | boolean>;
+  body: string;
+  severityTexts: Array<LogSeverity>;
+  telemetryServiceIds: Array<ObjectID>;
+  lastXSecondsOfLogs: number;
+}
+
+export class MonitorStepLogMonitorUtil {
+  public static toQuery(
+    monitorStepLogMonitor: MonitorStepLogMonitor,
+  ): Query<Log> {
+    const query: Query<Log> = {};
+
+    if (
+      monitorStepLogMonitor.telemetryServiceIds &&
+      monitorStepLogMonitor.telemetryServiceIds.length > 0
+    ) {
+      query.serviceId = new Includes(monitorStepLogMonitor.telemetryServiceIds);
+    }
+
+    if (
+      monitorStepLogMonitor.attributes &&
+      Object.keys(monitorStepLogMonitor.attributes).length > 0
+    ) {
+      query.attributes = monitorStepLogMonitor.attributes;
+    }
+
+    if (
+      monitorStepLogMonitor.severityTexts &&
+      monitorStepLogMonitor.severityTexts.length > 0
+    ) {
+      query.severityText = new Includes(monitorStepLogMonitor.severityTexts);
+    }
+
+    if (monitorStepLogMonitor.body) {
+      query.body = new Search(monitorStepLogMonitor.body);
+    }
+
+    if (monitorStepLogMonitor.lastXSecondsOfLogs) {
+      const endDate: Date = OneUptimeDate.getCurrentDate();
+      const startDate: Date = OneUptimeDate.addRemoveSeconds(
+        endDate,
+        monitorStepLogMonitor.lastXSecondsOfLogs * -1,
+      );
+      query.time = new InBetween(startDate, endDate);
+    }
+
+    return query;
+  }
+
+  public static getDefault(): MonitorStepLogMonitor {
+    return {
+      attributes: {},
+      body: "",
+      severityTexts: [],
+      telemetryServiceIds: [],
+      lastXSecondsOfLogs: 60,
+    };
+  }
+
+  public static fromJSON(json: JSONObject): MonitorStepLogMonitor {
+    return {
+      attributes:
+        (json["attributes"] as Dictionary<string | number | boolean>) || {},
+      body: json["body"] as string,
+      severityTexts: json["severityTexts"] as Array<LogSeverity>,
+      telemetryServiceIds: ObjectID.fromJSONArray(
+        json["telemetryServiceIds"] as Array<JSONObject>,
+      ),
+      lastXSecondsOfLogs: json["lastXSecondsOfLogs"] as number,
+    };
+  }
+
+  public static toJSON(monitor: MonitorStepLogMonitor): JSONObject {
+    return {
+      attributes: monitor.attributes,
+      body: monitor.body,
+      severityTexts: monitor.severityTexts,
+      telemetryServiceIds: ObjectID.toJSONArray(monitor.telemetryServiceIds),
+      lastXSecondsOfLogs: monitor.lastXSecondsOfLogs,
+    };
+  }
+}

package/Types/Monitor/MonitorType.ts

@@ -15,6 +15,11 @@ enum MonitorType {
   // These two monitor types are same but we are keeping them separate for now - this is for marketing purposes
   SyntheticMonitor = "Synthetic Monitor",
   CustomJavaScriptCode = "Custom JavaScript Code",
+
+  // Telemetry monitor types
+  Logs = "Logs",
+  Metrics = "Metrics",
+  Traces = "Traces",
 }
 
 export default MonitorType;
@@ -99,6 +104,24 @@ export class MonitorTypeHelper {
         description:
           "This monitor type lets you run custom JavaScript code on a schedule.",
       },
+      {
+        monitorType: MonitorType.Logs,
+        title: "Logs",
+        description: "This monitor type lets you monitor logs from any source.",
+      },
+      // ,
+      // {
+      //   monitorType: MonitorType.Metrics,
+      //   title: "Metrics",
+      //   description:
+      //     "This monitor type lets you monitor metrics from any source.",
+      // },
+      // {
+      //   monitorType: MonitorType.Traces,
+      //   title: "Traces",
+      //   description:
+      //     "This monitor type lets you monitor traces from any source.",
+      // },
     ];
 
     return monitorTypeProps;
@@ -159,6 +182,9 @@ export class MonitorTypeHelper {
       MonitorType.CustomJavaScriptCode,
       MonitorType.IncomingRequest,
       MonitorType.Server,
+      MonitorType.Logs,
+      MonitorType.Metrics,
+      MonitorType.Traces,
     ];
   }
 

package/Types/ObjectID.ts

@@ -47,6 +47,19 @@ export default class ObjectID extends DatabaseProperty {
     return new this(UUID.generate());
   }
 
+  public static toJSONArray(ids: Array<ObjectID>): Array<JSONObject> {
+    if (!ids || ids.length === 0) {
+      return [];
+    }
+
+    return ids.map((id: ObjectID) => {
+      if (typeof id === "string") {
+        id = new ObjectID(id);
+      }
+      return id.toJSON();
+    });
+  }
+
   protected static override toDatabase(
     value: ObjectID | FindOperator<ObjectID>,
   ): string | null {
@@ -76,6 +89,12 @@ export default class ObjectID extends DatabaseProperty {
     throw new BadDataException("Invalid JSON: " + JSON.stringify(json));
   }
 
+  public static fromJSONArray(json: Array<JSONObject>): Array<ObjectID> {
+    return json.map((value: JSONObject) => {
+      return ObjectID.fromJSON(value);
+    });
+  }
+
   protected static override fromDatabase(_value: string): ObjectID | null {
     if (_value) {
       return new ObjectID(_value);

package/Types/OnCallDutyPolicy/Layer.ts

@@ -1,4 +1,4 @@
-import UserModel from "../../Models/UserModel";
+import UserModel from "../../Models/DatabaseModels/User";
 import CalendarEvent from "../Calendar/CalendarEvent";
 import OneUptimeDate from "../Date";
 import DayOfWeek from "../Day/DayOfWeek";

package/Types/Workflow/Components/BaseModel.ts

@@ -1,4 +1,4 @@
-import BaseModel from "../../../Models/BaseModel";
+import BaseModel from "../../../Models/DatabaseModels/DatabaseBaseModel/DatabaseBaseModel";
 import IconProp from "../../Icon/IconProp";
 import Text from "../../Text";
 import ComponentMetadata, {

package/Utils/API.ts

@@ -1,5 +1,5 @@
-import AnalyticsBaseModel from "../AnalyticsModels/BaseModel";
-import BaseModel from "../Models/BaseModel";
+import AnalyticsBaseModel from "../Models/AnalyticsModels/AnalyticsBaseModel/AnalyticsBaseModel";
+import BaseModel from "../Models/DatabaseModels/DatabaseBaseModel/DatabaseBaseModel";
 import HTTPErrorResponse from "../Types/API/HTTPErrorResponse";
 import HTTPMethod from "../Types/API/HTTPMethod";
 import HTTPResponse from "../Types/API/HTTPResponse";

package/Utils/Uptime/Event.ts

@@ -0,0 +1,11 @@
+import Color from "../../Types/Color";
+import ObjectID from "../../Types/ObjectID";
+
+export default interface Event {
+  startDate: Date;
+  endDate: Date;
+  label: string;
+  priority: number;
+  color: Color;
+  eventStatusId: ObjectID; // this is the id of the event status. for example, monitor status id.
+}

package/Utils/Uptime/MonitorEvent.ts

@@ -0,0 +1,6 @@
+import ObjectID from "../../Types/ObjectID";
+import Event from "./Event";
+
+export default interface MonitorEvent extends Event {
+  monitorId: ObjectID;
+}