@oneuptime/common 8.0.5239 → 8.0.5283

package/Server/Types/Workflow/ComponentCode.ts

@@ -1,5 +1,7 @@
-// this class is the base class that all the component can implement
-//
+/*
+ * this class is the base class that all the component can implement
+ *
+ */
 import BadDataException from "../../../Types/Exception/BadDataException";
 import Exception from "../../../Types/Exception/Exception";
 import { JSONArray, JSONObject, JSONValue } from "../../../Types/JSON";

package/Server/Types/Workflow/Components/Conditions/IfElse.ts

@@ -55,9 +55,11 @@ export default class IfElse extends ComponentCode {
     }
 
     try {
-      // Set timeout
-      // Inject args
-      // Inject dependencies
+      /*
+       * Set timeout
+       * Inject args
+       * Inject dependencies
+       */
 
       for (const key in args) {
         if (key === "operator") {

package/Server/Types/Workflow/Components/JavaScript.ts

@@ -51,9 +51,11 @@ export default class JavaScriptCode extends ComponentCode {
     }
 
     try {
-      // Set timeout
-      // Inject args
-      // Inject dependencies
+      /*
+       * Set timeout
+       * Inject args
+       * Inject dependencies
+       */
 
       let scriptArgs: JSONObject | string =
         (args["arguments"] as JSONObject | string) || {};

package/Server/Types/Workflow/TriggerCode.ts

@@ -1,5 +1,7 @@
-// this class is the base class that all the component can implement
-//
+/*
+ * this class is the base class that all the component can implement
+ *
+ */
 import { ExpressRouter } from "../../Utils/Express";
 import ComponentCode, { RunOptions, RunReturnType } from "./ComponentCode";
 import BadDataException from "../../../Types/Exception/BadDataException";

package/Server/Utils/AnalyticsDatabase/Statement.ts

@@ -159,8 +159,10 @@ export class Statement implements BaseQueryParams {
   private static toColumnType(
     statementParam: StatementParameter | string,
   ): string {
-    // ensure we have a mapping for all types (a missing mapping will
-    // be a compile error)
+    /*
+     * ensure we have a mapping for all types (a missing mapping will
+     * be a compile error)
+     */
     const columnTypes: Dictionary<string> = {
       [TableColumnType.Text]: "String",
       [TableColumnType.ObjectID]: "String",

package/Server/Utils/AnalyticsDatabase/StatementGenerator.ts

@@ -131,8 +131,10 @@ export default class StatementGenerator<TBaseModel extends AnalyticsBaseModel> {
       records.push(record);
     }
 
-    // we need async insert to be enabled for clickhouse to work.
-    // otherwise too many parts will be created.
+    /*
+     * we need async insert to be enabled for clickhouse to work.
+     * otherwise too many parts will be created.
+     */
 
     const statement: string = `INSERT INTO ${
       this.database.getDatasourceOptions().database
@@ -263,9 +265,11 @@ export default class StatementGenerator<TBaseModel extends AnalyticsBaseModel> {
           setStatement.append(SQL`, `);
         }
 
-        // special case - ClickHouse does not support using query
-        // parameters for column names in the SET statement so we
-        // have to trust the column names here.
+        /*
+         * special case - ClickHouse does not support using query
+         * parameters for column names in the SET statement so we
+         * have to trust the column names here.
+         */
         const keyStatement: string = column.key;
 
         setStatement.append(keyStatement).append(
@@ -505,8 +509,10 @@ export default class StatementGenerator<TBaseModel extends AnalyticsBaseModel> {
     statement: Statement;
     columns: Array<string>;
   } {
-    // EXAMPLE:
-    // SELECT sum(Metric.value) as avg_value, date_trunc('hour', toStartOfInterval(createdAt, INTERVAL 1 hour)) as createdAt
+    /*
+     * EXAMPLE:
+     * SELECT sum(Metric.value) as avg_value, date_trunc('hour', toStartOfInterval(createdAt, INTERVAL 1 hour)) as createdAt
+     */
 
     const selectStatement: Statement = new Statement();
 
@@ -578,8 +584,10 @@ export default class StatementGenerator<TBaseModel extends AnalyticsBaseModel> {
         columns.append(SQL`, `);
       }
 
-      // special case - ClickHouse does not support using an a query parameter
-      // to specify the column name when creating the table
+      /*
+       * special case - ClickHouse does not support using an a query parameter
+       * to specify the column name when creating the table
+       */
       const keyStatement: string = column.key;
 
       columns
@@ -683,8 +691,10 @@ export default class StatementGenerator<TBaseModel extends AnalyticsBaseModel> {
       this.model.tableColumns,
     );
 
-    // special case - ClickHouse does not support using a query parameter
-    // to specify the table engine
+    /*
+     * special case - ClickHouse does not support using a query parameter
+     * to specify the table engine
+     */
     const tableEngineStatement: string = this.model.tableEngine;
 
     const partitionKey: string = this.model.partitionKey;

package/Server/Utils/Browser.ts

@@ -78,10 +78,12 @@ export default class BrowserUtil {
       page = await browser.newPage();
     }
 
-    // if (data.browserType === BrowserType.Webkit) {
-    //     browser = await webkit.launch();
-    //     page = await browser.newPage();
-    // }
+    /*
+     * if (data.browserType === BrowserType.Webkit) {
+     *     browser = await webkit.launch();
+     *     page = await browser.newPage();
+     * }
+     */
 
     await page?.setViewportSize({
       width: viewport.width,

package/Server/Utils/CodeRepository/GitHub/GitHub.ts

@@ -141,8 +141,10 @@ export default class GitHubUtil extends HostedCodeRepository {
       page: page,
     });
 
-    // Fetch all pull requests by paginating through the results
-    // 100 pull requests per page is the limit of the GitHub API
+    /*
+     * Fetch all pull requests by paginating through the results
+     * 100 pull requests per page is the limit of the GitHub API
+     */
     while (pullRequests.length === page * 100 || page === 1) {
       pullRequests = await this.getPullRequestsByPage({
         organizationName: data.organizationName,

package/Server/Utils/LocalFile.ts

@@ -218,4 +218,18 @@ export default class LocalFile {
       },
     );
   }
+
+  @CaptureSpan()
+  public static async readAsBuffer(path: string): Promise<Buffer> {
+    return new Promise(
+      (resolve: (data: Buffer) => void, reject: PromiseRejectErrorFunction) => {
+        fs.readFile(path, (err: Error | null, data: Buffer) => {
+          if (!err) {
+            return resolve(data);
+          }
+          return reject(err);
+        });
+      },
+    );
+  }
 }

package/Server/Utils/Monitor/MonitorResource.ts

@@ -572,8 +572,10 @@ export default class MonitorResourceUtil {
         lastMonitorStatusTimeline.monitorStatusId.toString() ===
           monitorSteps.data.defaultMonitorStatusId.toString()
       ) {
-        // status is same as last status. do not create new status timeline.
-        // do nothing! status is same as last status.
+        /*
+         * status is same as last status. do not create new status timeline.
+         * do nothing! status is same as last status.
+         */
       } else {
         // if no criteria is met then update monitor to default state.
         const monitorStatusTimeline: MonitorStatusTimeline =
@@ -634,9 +636,11 @@ export default class MonitorResourceUtil {
 
     const itemsToSave: Array<Metric> = [];
 
-    // Metric name to serviceId map
-    // example: "cpu.usage" -> [serviceId1, serviceId2]
-    // since these are monitor metrics. They dont belong to any service so we can keep the array empty.
+    /*
+     * Metric name to serviceId map
+     * example: "cpu.usage" -> [serviceId1, serviceId2]
+     * since these are monitor metrics. They dont belong to any service so we can keep the array empty.
+     */
     const metricNameServiceNameMap: Dictionary<MetricType> = {};
 
     if (
@@ -1147,8 +1151,10 @@ export default class MonitorResourceUtil {
     probeApiIngestResponse: ProbeApiIngestResponse;
     criteriaInstance: MonitorCriteriaInstance;
   }): Promise<string | null> {
-    // returns root cause if any. Otherwise criteria is not met.
-    // process monitor criteria instance here.
+    /*
+     * returns root cause if any. Otherwise criteria is not met.
+     * process monitor criteria instance here.
+     */
 
     const rootCause: string | null =
       await MonitorResourceUtil.isMonitorInstanceCriteriaFiltersMet({
@@ -1227,8 +1233,10 @@ export default class MonitorResourceUtil {
     criteriaInstance: MonitorCriteriaInstance;
     criteriaFilter: CriteriaFilter;
   }): Promise<string | null> {
-    // returns root cause if any. Otherwise criteria is not met.
-    // process monitor criteria filter here.
+    /*
+     * returns root cause if any. Otherwise criteria is not met.
+     * process monitor criteria filter here.
+     */
 
     if (input.criteriaFilter.checkOn === CheckOn.JavaScriptExpression) {
       let storageMap: JSONObject = {};

package/Server/Utils/Realtime.ts

@@ -92,8 +92,10 @@ export default abstract class Realtime {
       await this.init();
     }
 
-    // before joining room check the user token and check if the user has access to this tenant
-    // and to this model and to this event type
+    /*
+     * before joining room check the user token and check if the user has access to this tenant
+     * and to this model and to this event type
+     */
 
     logger.debug("Extracting user access token from socket");
     const userAccessToken: string | undefined =

package/Server/Utils/StartServer.ts

@@ -109,7 +109,7 @@ app.use((req: OneUptimeRequest, res: ExpressResponse, next: NextFunction) => {
 
     req.on("end", () => {
       const buffer: Buffer = Buffer.concat(buffers);
-      zlib.gunzip(buffer, (err: unknown, decoded: Buffer) => {
+      zlib.gunzip(buffer as Uint8Array, (err: unknown, decoded: Buffer) => {
         if (err) {
           logger.error(err);
           return Response.sendErrorResponse(

package/Server/Utils/Telemetry.ts

@@ -1,7 +1,9 @@
 import OpenTelemetryAPI, {
-  // diag,
-  // DiagConsoleLogger,
-  // DiagLogLevel,
+  /*
+   * diag,
+   * DiagConsoleLogger,
+   * DiagLogLevel,
+   */
   Meter,
 } from "@opentelemetry/api";
 import { Logger, logs } from "@opentelemetry/api-logs";
@@ -33,8 +35,10 @@ import Dictionary from "../../Types/Dictionary";
 import { DisableTelemetry } from "../EnvironmentConfig";
 import logger from "./Logger";
 
-// Enable this line to see debug logs
-// diag.setLogger(new DiagConsoleLogger(), DiagLogLevel.DEBUG);
+/*
+ * Enable this line to see debug logs
+ * diag.setLogger(new DiagConsoleLogger(), DiagLogLevel.DEBUG);
+ */
 
 export type Span = opentelemetry.api.Span;
 export type SpanStatus = opentelemetry.api.SpanStatus;
@@ -203,10 +207,12 @@ export default class Telemetry {
         nodeSdkConfiguration.traceExporter = traceExporter;
       }
 
-      // We will skip this becasue we're attachng this metric reader to the meter provider later.
-      // if (this.metricReader) {
-      //   nodeSdkConfiguration.metricReader = this.metricReader;
-      // }
+      /*
+       * We will skip this becasue we're attachng this metric reader to the meter provider later.
+       * if (this.metricReader) {
+       *   nodeSdkConfiguration.metricReader = this.metricReader;
+       * }
+       */
 
       if (logRecordProcessor) {
         nodeSdkConfiguration.logRecordProcessor = logRecordProcessor;

package/Server/Utils/{TwoFactorAuth.ts → TotpAuth.ts}

@@ -3,9 +3,9 @@ import * as OTPAuth from "otpauth";
 import CaptureSpan from "./Telemetry/CaptureSpan";
 
 /**
- * Utility class for handling two-factor authentication.
+ * Utility class for handling TOTP authentication.
  */
-export default class TwoFactorAuth {
+export default class TotpAuth {
   /**
    * Generates a random secret key for two-factor authentication.
    * @returns The generated secret key.

package/Server/Utils/Workspace/MicrosoftTeams/Actions/ActionTypes.ts

@@ -1,38 +1,97 @@
-enum SlackActionType {
-  // Incident actions
-  AcknowledgeIncident = "AcknowledgeIncident",
+// Microsoft Teams Action Types for OneUptime Integration
+
+// Incident Actions
+export enum MicrosoftTeamsIncidentActionType {
+  AckIncident = "AcknowledgeIncident",
   ResolveIncident = "ResolveIncident",
+  UnresolveIncident = "UnresolveIncident",
+  ViewIncident = "ViewIncident",
+  IncidentCreated = "IncidentCreated",
+  IncidentStateChanged = "IncidentStateChanged",
   ViewAddIncidentNote = "ViewAddIncidentNote",
   SubmitIncidentNote = "SubmitIncidentNote",
-  ViewChangeIncidentState = "ViewChangeIncidentState",
-  SubmitChangeIncidentState = "SubmitChangeIncidentState",
+  AddIncidentNote = "AddIncidentNote",
+  ExecuteIncidentOnCallPolicy = "ExecuteIncidentOnCallPolicy",
   ViewExecuteIncidentOnCallPolicy = "ViewExecuteIncidentOnCallPolicy",
   SubmitExecuteIncidentOnCallPolicy = "SubmitExecuteIncidentOnCallPolicy",
-  ViewIncident = "ViewIncident",
+  ViewChangeIncidentState = "ViewChangeIncidentState",
+  SubmitChangeIncidentState = "SubmitChangeIncidentState",
   NewIncident = "/incident", // new incident slash command
   SubmitNewIncident = "SubmitNewIncident",
+}
 
-  // Alert Actions just like Incident Actions
-  AcknowledgeAlert = "AcknowledgeAlert",
+// Alert Actions
+export enum MicrosoftTeamsAlertActionType {
+  AckAlert = "AckAlert",
   ResolveAlert = "ResolveAlert",
+  ViewAlert = "ViewAlert",
+  AlertCreated = "AlertCreated",
+  AlertStateChanged = "AlertStateChanged",
+  AddAlertNote = "AddAlertNote",
+  ExecuteAlertOnCallPolicy = "ExecuteAlertOnCallPolicy",
   ViewAddAlertNote = "ViewAddAlertNote",
   SubmitAlertNote = "SubmitAlertNote",
-  ViewChangeAlertState = "ViewChangeAlertState",
-  SubmitChangeAlertState = "SubmitChangeAlertState",
   ViewExecuteAlertOnCallPolicy = "ViewExecuteAlertOnCallPolicy",
   SubmitExecuteAlertOnCallPolicy = "SubmitExecuteAlertOnCallPolicy",
-  ViewAlert = "ViewAlert",
+  ViewChangeAlertState = "ViewChangeAlertState",
+  SubmitChangeAlertState = "SubmitChangeAlertState",
+}
+
+// Monitor Actions
+export enum MicrosoftTeamsMonitorActionType {
+  ViewMonitor = "ViewMonitor",
+  EnableMonitor = "EnableMonitor",
+  DisableMonitor = "DisableMonitor",
+  MonitorStatusChanged = "MonitorStatusChanged",
+}
 
-  // Scheduled Maintenance Actions just like Incident Actions.
-  MarkScheduledMaintenanceAsComplete = "MarkScheduledMaintenanceAsComplete",
-  MarkScheduledMaintenanceAsOngoing = "MarkScheduledMaintenanceAsOngoing",
+// Scheduled Maintenance Actions
+export enum MicrosoftTeamsScheduledMaintenanceActionType {
+  ViewScheduledMaintenance = "ViewScheduledMaintenance",
+  MarkAsComplete = "MarkAsComplete",
+  MarkAsOngoing = "MarkAsOngoing",
+  ScheduledMaintenanceCreated = "ScheduledMaintenanceCreated",
+  ScheduledMaintenanceStateChanged = "ScheduledMaintenanceStateChanged",
+  AddScheduledMaintenanceNote = "AddScheduledMaintenanceNote",
   ViewAddScheduledMaintenanceNote = "ViewAddScheduledMaintenanceNote",
   SubmitScheduledMaintenanceNote = "SubmitScheduledMaintenanceNote",
   ViewChangeScheduledMaintenanceState = "ViewChangeScheduledMaintenanceState",
   SubmitChangeScheduledMaintenanceState = "SubmitChangeScheduledMaintenanceState",
-  ViewScheduledMaintenance = "ViewScheduledMaintenance",
   NewScheduledMaintenance = "/maintenance", // new scheduled maintenance slash command
   SubmitNewScheduledMaintenance = "SubmitNewScheduledMaintenance",
 }
 
-export default SlackActionType;
+// On-Call Duty Actions
+export enum MicrosoftTeamsOnCallDutyActionType {
+  ViewOnCallDuty = "ViewOnCallDuty",
+  EscalateOnCall = "EscalateOnCall",
+  OnCallDutyPolicyTriggered = "OnCallDutyPolicyTriggered",
+}
+
+// General Actions
+export enum MicrosoftTeamsGeneralActionType {
+  Help = "Help",
+  ViewDashboard = "ViewDashboard",
+  ViewProject = "ViewProject",
+}
+
+// Activity Types from Microsoft Teams
+export enum TeamsActivityType {
+  Message = "message",
+  Invoke = "invoke",
+  InstallationUpdate = "installationUpdate",
+  MessageReaction = "messageReaction",
+  MembersAdded = "membersAdded",
+  MembersRemoved = "membersRemoved",
+}
+
+// All action types combined
+export type MicrosoftTeamsActionType =
+  | MicrosoftTeamsIncidentActionType
+  | MicrosoftTeamsAlertActionType
+  | MicrosoftTeamsMonitorActionType
+  | MicrosoftTeamsScheduledMaintenanceActionType
+  | MicrosoftTeamsOnCallDutyActionType
+  | MicrosoftTeamsGeneralActionType;
+
+export default MicrosoftTeamsActionType;