@oneuptime/common 7.0.3840 → 7.0.3871

package/Server/Utils/Workspace/Slack/Messages/Monitor.ts

@@ -0,0 +1,60 @@
+import BadDataException from "../../../../../Types/Exception/BadDataException";
+import ObjectID from "../../../../../Types/ObjectID";
+import {
+  WorkspaceMessageBlock,
+  WorkspaceMessagePayloadButton,
+  WorkspacePayloadDivider,
+} from "../../../../../Types/Workspace/WorkspaceMessagePayload";
+import MonitorService from "../../../../Services/MonitorService";
+import SlackActionType from "../../../../Utils/Workspace/Slack/Actions/ActionTypes";
+import CaptureSpan from "../../../Telemetry/CaptureSpan";
+
+export default class SlackMonitorMessages {
+  @CaptureSpan()
+  public static async getMonitorCreateMessageBlocks(data: {
+    monitorId: ObjectID;
+    projectId: ObjectID;
+  }): Promise<Array<WorkspaceMessageBlock>> {
+    if (!data.monitorId) {
+      throw new BadDataException("Monitor ID is required");
+    }
+
+    // Slack.
+
+    const blockSlack: Array<WorkspaceMessageBlock> = [];
+
+    // add divider.
+
+    const dividerBlock: WorkspacePayloadDivider = {
+      _type: "WorkspacePayloadDivider",
+    };
+
+    blockSlack.push(dividerBlock);
+
+    // now add buttons.
+    // View data.
+    // Execute On Call
+    // Acknowledge Monitor
+    // Resolve data.
+    // Change Monitor State.
+    // Add Note.
+
+    const buttons: Array<WorkspaceMessagePayloadButton> = [];
+
+    // view data.
+    const viewMonitorButton: WorkspaceMessagePayloadButton = {
+      _type: "WorkspaceMessagePayloadButton",
+      title: "🔗 View Monitor",
+      url: await MonitorService.getMonitorLinkInDashboard(
+        data.projectId!,
+        data.monitorId!,
+      ),
+      value: data.monitorId?.toString() || "",
+      actionId: SlackActionType.ViewMonitor,
+    };
+
+    buttons.push(viewMonitorButton);
+
+    return blockSlack;
+  }
+}

package/Server/Utils/Workspace/Slack/Messages/ScheduledMaintenance.ts

@@ -8,8 +8,10 @@ import {
 } from "../../../../../Types/Workspace/WorkspaceMessagePayload";
 import ScheduledMaintenanceService from "../../../../Services/ScheduledMaintenanceService";
 import SlackActionType from "../../../../Utils/Workspace/Slack/Actions/ActionTypes";
+import CaptureSpan from "../../../Telemetry/CaptureSpan";
 
 export default class SlackScheduledMaintenanceMessages {
+  @CaptureSpan()
   public static async getScheduledMaintenanceCreateMessageBlocks(data: {
     scheduledMaintenanceId: ObjectID;
     projectId: ObjectID;

package/Server/Utils/Workspace/Slack/Slack.ts

@@ -29,12 +29,14 @@ import WorkspaceType from "../../../../Types/Workspace/WorkspaceType";
 import SlackifyMarkdown from "slackify-markdown";
 import { DropdownOption } from "../../../../UI/Components/Dropdown/Dropdown";
 import OneUptimeDate from "../../../../Types/Date";
+import CaptureSpan from "../../Telemetry/CaptureSpan";
 
 export default class SlackUtil extends WorkspaceBase {
+  @CaptureSpan()
   public static override async getUsernameFromUserId(data: {
     authToken: string;
     userId: string;
-  }): Promise<string> {
+  }): Promise<string | null> {
     logger.debug("Getting username from user ID with data:");
     logger.debug(data);
 
@@ -63,7 +65,7 @@ export default class SlackUtil extends WorkspaceBase {
     if ((response.jsonData as JSONObject)?.["ok"] !== true) {
       logger.error("Invalid response from Slack API:");
       logger.error(response.jsonData);
-      throw new BadRequestException("Invalid response");
+      return null;
     }
 
     if (
@@ -71,7 +73,7 @@ export default class SlackUtil extends WorkspaceBase {
     ) {
       logger.error("Invalid response from Slack API:");
       logger.error(response.jsonData);
-      throw new Error("Invalid response");
+      return null;
     }
 
     const username: string = (
@@ -83,6 +85,7 @@ export default class SlackUtil extends WorkspaceBase {
     return username;
   }
 
+  @CaptureSpan()
   public static override async showModalToUser(data: {
     authToken: string;
     triggerId: string;
@@ -126,6 +129,7 @@ export default class SlackUtil extends WorkspaceBase {
     logger.debug("Modal shown to user successfully.");
   }
 
+  @CaptureSpan()
   public static override async sendDirectMessageToUser(data: {
     authToken: string;
     workspaceUserId: string;
@@ -150,6 +154,7 @@ export default class SlackUtil extends WorkspaceBase {
     });
   }
 
+  @CaptureSpan()
   public static override async joinChannel(data: {
     authToken: string;
     channelId: string;
@@ -189,6 +194,7 @@ export default class SlackUtil extends WorkspaceBase {
     logger.debug(data);
   }
 
+  @CaptureSpan()
   public static override async inviteUserToChannelByChannelId(data: {
     authToken: string;
     channelId: string;
@@ -240,6 +246,7 @@ export default class SlackUtil extends WorkspaceBase {
     logger.debug("User invited to channel successfully.");
   }
 
+  @CaptureSpan()
   public static override async inviteUserToChannelByChannelName(data: {
     authToken: string;
     channelName: string;
@@ -267,6 +274,7 @@ export default class SlackUtil extends WorkspaceBase {
     });
   }
 
+  @CaptureSpan()
   public static override async createChannelsIfDoesNotExist(data: {
     authToken: string;
     channelNames: Array<string>;
@@ -289,6 +297,12 @@ export default class SlackUtil extends WorkspaceBase {
         channelName = channelName.substring(1);
       }
 
+      // convert channel name to lowercase
+      channelName = channelName.toLowerCase();
+
+      // replace spaces with hyphens
+      channelName = channelName.replace(/\s+/g, '-');
+
       if (existingWorkspaceChannels[channelName]) {
         logger.debug(`Channel ${channelName} already exists.`);
         workspaceChannels.push(existingWorkspaceChannels[channelName]!);
@@ -312,6 +326,7 @@ export default class SlackUtil extends WorkspaceBase {
     return workspaceChannels;
   }
 
+  @CaptureSpan()
   public static override async getWorkspaceChannelFromChannelName(data: {
     authToken: string;
     channelName: string;
@@ -338,6 +353,7 @@ export default class SlackUtil extends WorkspaceBase {
     return channels[data.channelName]!;
   }
 
+  @CaptureSpan()
   public static override async getWorkspaceChannelFromChannelId(data: {
     authToken: string;
     channelId: string;
@@ -394,6 +410,7 @@ export default class SlackUtil extends WorkspaceBase {
     return channel;
   }
 
+  @CaptureSpan()
   public static override async getAllWorkspaceChannels(data: {
     authToken: string;
   }): Promise<Dictionary<WorkspaceChannel>> {
@@ -447,12 +464,14 @@ export default class SlackUtil extends WorkspaceBase {
     return channels;
   }
 
+  @CaptureSpan()
   public static override getDividerBlock(): JSONObject {
     return {
       type: "divider",
     };
   }
 
+  @CaptureSpan()
   public static getValuesFromView(data: {
     view: JSONObject;
   }): Dictionary<string | number | Array<string | number> | Date> {
@@ -508,6 +527,7 @@ export default class SlackUtil extends WorkspaceBase {
     return values;
   }
 
+  @CaptureSpan()
   public static override async sendMessage(data: {
     workspaceMessagePayload: WorkspaceMessagePayload;
     authToken: string; // which auth token should we use to send.
@@ -609,6 +629,7 @@ export default class SlackUtil extends WorkspaceBase {
     return workspaspaceMessageResponse;
   }
 
+  @CaptureSpan()
   public static override async sendPayloadBlocksToChannel(data: {
     authToken: string;
     workspaceChannel: WorkspaceChannel;
@@ -654,6 +675,7 @@ export default class SlackUtil extends WorkspaceBase {
     };
   }
 
+  @CaptureSpan()
   public static override getButtonsBlock(data: {
     payloadButtonsBlock: WorkspacePayloadButtons;
   }): JSONObject {
@@ -674,6 +696,7 @@ export default class SlackUtil extends WorkspaceBase {
     return buttonsBlock;
   }
 
+  @CaptureSpan()
   public static override async createChannel(data: {
     authToken: string;
     channelName: string;
@@ -740,6 +763,7 @@ export default class SlackUtil extends WorkspaceBase {
     return channel;
   }
 
+  @CaptureSpan()
   public static override getHeaderBlock(data: {
     payloadHeaderBlock: WorkspacePayloadHeader;
   }): JSONObject {
@@ -759,6 +783,7 @@ export default class SlackUtil extends WorkspaceBase {
     return headerBlock;
   }
 
+  @CaptureSpan()
   public static override getCheckboxBlock(data: {
     payloadCheckboxBlock: WorkspaceCheckboxBlock;
   }): JSONObject {
@@ -811,6 +836,7 @@ export default class SlackUtil extends WorkspaceBase {
     return checkboxBlock;
   }
 
+  @CaptureSpan()
   public static override getDateTimePickerBlock(data: {
     payloadDateTimePickerBlock: WorkspaceDateTimePickerBlock;
   }): JSONObject {
@@ -835,6 +861,7 @@ export default class SlackUtil extends WorkspaceBase {
     return dateTimePickerBlock;
   }
 
+  @CaptureSpan()
   public static override getTextAreaBlock(data: {
     payloadTextAreaBlock: WorkspaceTextAreaBlock;
   }): JSONObject {
@@ -876,6 +903,7 @@ export default class SlackUtil extends WorkspaceBase {
     return textAreaBlock;
   }
 
+  @CaptureSpan()
   public static override getTextBoxBlock(data: {
     payloadTextBoxBlock: WorkspaceTextBoxBlock;
   }): JSONObject {
@@ -916,6 +944,7 @@ export default class SlackUtil extends WorkspaceBase {
     return textBoxBlock;
   }
 
+  @CaptureSpan()
   public static override getImageBlock(data: {
     payloadImageBlock: WorkspacePayloadImage;
   }): JSONObject {
@@ -933,6 +962,7 @@ export default class SlackUtil extends WorkspaceBase {
     return imageBlock;
   }
 
+  @CaptureSpan()
   public static override getDropdownBlock(data: {
     payloadDropdownBlock: WorkspaceDropdownBlock;
   }): JSONObject {
@@ -996,6 +1026,7 @@ export default class SlackUtil extends WorkspaceBase {
     return dropdownBlock;
   }
 
+  @CaptureSpan()
   public static override getModalBlock(data: {
     payloadModalBlock: WorkspaceModalBlock;
   }): JSONObject {
@@ -1028,6 +1059,7 @@ export default class SlackUtil extends WorkspaceBase {
     return modalBlock;
   }
 
+  @CaptureSpan()
   public static override getMarkdownBlock(data: {
     payloadMarkdownBlock: WorkspacePayloadMarkdown;
   }): JSONObject {
@@ -1049,6 +1081,7 @@ export default class SlackUtil extends WorkspaceBase {
     return markdownBlock;
   }
 
+  @CaptureSpan()
   public static override async isUserInDirectMessageChannel(data: {
     authToken: string;
     userId: string;
@@ -1093,6 +1126,7 @@ export default class SlackUtil extends WorkspaceBase {
     return false;
   }
 
+  @CaptureSpan()
   public static override async isUserInChannel(data: {
     authToken: string;
     channelId: string;
@@ -1163,6 +1197,7 @@ export default class SlackUtil extends WorkspaceBase {
     return false;
   }
 
+  @CaptureSpan()
   public static override getButtonBlock(data: {
     payloadButtonBlock: WorkspaceMessagePayloadButton;
   }): JSONObject {
@@ -1188,6 +1223,7 @@ export default class SlackUtil extends WorkspaceBase {
     return buttonBlock;
   }
 
+  @CaptureSpan()
   public static override async sendMessageToChannelViaIncomingWebhook(data: {
     url: URL;
     text: string;

package/Server/Utils/Workspace/Workspace.ts

@@ -16,8 +16,10 @@ import { MessageBlocksByWorkspaceType } from "../../Services/WorkspaceNotificati
 import WorkspaceUserAuthToken from "../../../Models/DatabaseModels/WorkspaceUserAuthToken";
 import WorkspaceUserAuthTokenService from "../../Services/WorkspaceUserAuthTokenService";
 import UserService from "../../Services/UserService";
+import CaptureSpan from "../Telemetry/CaptureSpan";
 
 export default class WorkspaceUtil {
+  @CaptureSpan()
   public static async getMessageBlocksByMarkdown(data: {
     projectId: ObjectID;
     // this is oneuptime user id.
@@ -50,13 +52,23 @@ export default class WorkspaceUtil {
           if (!projectAuthToken || !projectAuthToken.authToken) {
             userStringToAppend = "";
           } else {
-            const workspaceUsername: string =
+            const workspaceUsername: string | null =
               await this.getUserNameFromWorkspace({
                 userId: workspaceUserToken.workspaceUserId,
                 workspaceType: workspaceType,
                 authToken: projectAuthToken.authToken,
               });
 
+            if (!workspaceUsername) {
+              const userstring: string =
+                await UserService.getUserMarkdownString({
+                  userId: data.userId,
+                  projectId: data.projectId,
+                });
+
+              userStringToAppend = `${userstring} `;
+            }
+
             userStringToAppend = `@${workspaceUsername} `;
           }
         } else {
@@ -83,6 +95,7 @@ export default class WorkspaceUtil {
     return messageBlocksByWorkspaceType;
   }
 
+  @CaptureSpan()
   public static getAllWorkspaceTypes(): Array<WorkspaceType> {
     const workspaceTypes: Array<WorkspaceType> = [];
 
@@ -93,6 +106,7 @@ export default class WorkspaceUtil {
     return workspaceTypes;
   }
 
+  @CaptureSpan()
   public static getWorkspaceTypeUtil(
     workspaceType: WorkspaceType,
   ): typeof WorkspaceBase {
@@ -109,12 +123,13 @@ export default class WorkspaceUtil {
     );
   }
 
+  @CaptureSpan()
   public static async getUserNameFromWorkspace(data: {
     userId: string;
     workspaceType: WorkspaceType;
     authToken: string;
-  }): Promise<string> {
-    const userName: string = await WorkspaceUtil.getWorkspaceTypeUtil(
+  }): Promise<string | null> {
+    const userName: string | null = await WorkspaceUtil.getWorkspaceTypeUtil(
       data.workspaceType,
     ).getUsernameFromUserId({
       userId: data.userId,
@@ -124,6 +139,7 @@ export default class WorkspaceUtil {
     return userName;
   }
 
+  @CaptureSpan()
   public static async postMessageToAllWorkspaceChannelsAsBot(data: {
     projectId: ObjectID;
     messagePayloadsByWorkspace: Array<WorkspaceMessagePayload>;
@@ -191,6 +207,7 @@ export default class WorkspaceUtil {
     return responses;
   }
 
+  @CaptureSpan()
   public static async postToWorkspaceChannels(data: {
     workspaceUserId: string;
     projectOrUserAuthTokenForWorkspace: string;

package/Server/Utils/Workspace/WorkspaceBase.ts

@@ -21,6 +21,7 @@ import WorkspaceMessagePayload, {
 import WorkspaceType from "../../../Types/Workspace/WorkspaceType";
 import logger from "../Logger";
 import URL from "Common/Types/API/URL";
+import CaptureSpan from "../Telemetry/CaptureSpan";
 
 export interface WorkspaceThread {
   channel: WorkspaceChannel;
@@ -39,6 +40,7 @@ export interface WorkspaceChannel {
 }
 
 export default class WorkspaceBase {
+  @CaptureSpan()
   public static async isUserInDirectMessageChannel(_data: {
     authToken: string;
     userId: string;
@@ -46,13 +48,15 @@ export default class WorkspaceBase {
   }): Promise<boolean> {
     throw new NotImplementedException();
   }
+  @CaptureSpan()
   public static async getUsernameFromUserId(_data: {
     authToken: string;
     userId: string;
-  }): Promise<string> {
+  }): Promise<string | null> {
     throw new NotImplementedException();
   }
 
+  @CaptureSpan()
   public static async showModalToUser(_data: {
     authToken: string;
     triggerId: string;
@@ -61,12 +65,14 @@ export default class WorkspaceBase {
     throw new NotImplementedException();
   }
 
+  @CaptureSpan()
   public static getCheckboxBlock(_data: {
     payloadCheckboxBlock: WorkspaceCheckboxBlock;
   }): JSONObject {
     throw new NotImplementedException();
   }
 
+  @CaptureSpan()
   public static sendDirectMessageToUser(_data: {
     authToken: string;
     workspaceUserId: string;
@@ -75,6 +81,7 @@ export default class WorkspaceBase {
     throw new NotImplementedException();
   }
 
+  @CaptureSpan()
   public static async joinChannel(_data: {
     authToken: string;
     channelId: string;
@@ -82,6 +89,7 @@ export default class WorkspaceBase {
     throw new NotImplementedException();
   }
 
+  @CaptureSpan()
   public static async sendPayloadBlocksToChannel(_data: {
     authToken: string;
     workspaceChannel: WorkspaceChannel;
@@ -90,6 +98,7 @@ export default class WorkspaceBase {
     throw new NotImplementedException();
   }
 
+  @CaptureSpan()
   public static async inviteUsersToChannels(data: {
     authToken: string;
     workspaceChannelInvitationPayload: WorkspaceChannelInvitationPayload;
@@ -105,6 +114,7 @@ export default class WorkspaceBase {
     }
   }
 
+  @CaptureSpan()
   public static async inviteUsersToChannel(data: {
     authToken: string;
     channelName: string;
@@ -119,6 +129,7 @@ export default class WorkspaceBase {
     }
   }
 
+  @CaptureSpan()
   public static async inviteUserToChannelByChannelName(_data: {
     authToken: string;
     channelName: string;
@@ -127,18 +138,21 @@ export default class WorkspaceBase {
     throw new NotImplementedException();
   }
 
+  @CaptureSpan()
   public static getDateTimePickerBlock(_data: {
     payloadDateTimePickerBlock: WorkspaceDateTimePickerBlock;
   }): JSONObject {
     throw new NotImplementedException();
   }
 
+  @CaptureSpan()
   public static async inviteUserToChannelByChannelId(_data: {
     authToken: string;
     channelId: string;
     workspaceUserId: string;
   }): Promise<void> {}
 
+  @CaptureSpan()
   public static async createChannelsIfDoesNotExist(_data: {
     authToken: string;
     channelNames: Array<string>;
@@ -146,6 +160,7 @@ export default class WorkspaceBase {
     throw new NotImplementedException();
   }
 
+  @CaptureSpan()
   public static async getWorkspaceChannelFromChannelId(_data: {
     authToken: string;
     channelId: string;
@@ -153,6 +168,7 @@ export default class WorkspaceBase {
     throw new NotImplementedException();
   }
 
+  @CaptureSpan()
   public static async sendMessage(_data: {
     workspaceMessagePayload: WorkspaceMessagePayload;
     authToken: string; // which auth token should we use to send.
@@ -161,12 +177,14 @@ export default class WorkspaceBase {
     throw new NotImplementedException();
   }
 
+  @CaptureSpan()
   public static async getAllWorkspaceChannels(_data: {
     authToken: string;
   }): Promise<Dictionary<WorkspaceChannel>> {
     throw new NotImplementedException();
   }
 
+  @CaptureSpan()
   public static async getWorkspaceChannelFromChannelName(_data: {
     authToken: string;
     channelName: string;
@@ -174,6 +192,7 @@ export default class WorkspaceBase {
     throw new NotImplementedException();
   }
 
+  @CaptureSpan()
   public static async createChannel(_data: {
     authToken: string;
     channelName: string;
@@ -181,28 +200,33 @@ export default class WorkspaceBase {
     throw new NotImplementedException();
   }
 
+  @CaptureSpan()
   public static getHeaderBlock(_data: {
     payloadHeaderBlock: WorkspacePayloadHeader;
   }): JSONObject {
     throw new NotImplementedException();
   }
 
+  @CaptureSpan()
   public static getDividerBlock(): JSONObject {
     throw new NotImplementedException();
   }
 
+  @CaptureSpan()
   public static getMarkdownBlock(_data: {
     payloadMarkdownBlock: WorkspacePayloadMarkdown;
   }): JSONObject {
     throw new NotImplementedException();
   }
 
+  @CaptureSpan()
   public static getButtonBlock(_data: {
     payloadButtonBlock: WorkspaceMessagePayloadButton;
   }): JSONObject {
     throw new NotImplementedException();
   }
 
+  @CaptureSpan()
   public static getBlocksFromWorkspaceMessagePayload(data: {
     messageBlocks: Array<WorkspaceMessageBlock>;
   }): Array<JSONObject> {
@@ -285,42 +309,49 @@ export default class WorkspaceBase {
     return blocks;
   }
 
+  @CaptureSpan()
   public static getTextAreaBlock(_data: {
     payloadTextAreaBlock: WorkspaceTextAreaBlock;
   }): JSONObject {
     throw new NotImplementedException();
   }
 
+  @CaptureSpan()
   public static getTextBoxBlock(_data: {
     payloadTextBoxBlock: WorkspaceTextBoxBlock;
   }): JSONObject {
     throw new NotImplementedException();
   }
 
+  @CaptureSpan()
   public static getImageBlock(_data: {
     payloadImageBlock: WorkspacePayloadImage;
   }): JSONObject {
     throw new NotImplementedException();
   }
 
+  @CaptureSpan()
   public static getDropdownBlock(_data: {
     payloadDropdownBlock: WorkspaceDropdownBlock;
   }): JSONObject {
     throw new NotImplementedException();
   }
 
+  @CaptureSpan()
   public static getModalBlock(_data: {
     payloadModalBlock: WorkspaceModalBlock;
   }): JSONObject {
     throw new NotImplementedException();
   }
 
+  @CaptureSpan()
   public static getButtonsBlock(_data: {
     payloadButtonsBlock: WorkspacePayloadButtons;
   }): JSONObject {
     throw new NotImplementedException();
   }
 
+  @CaptureSpan()
   public static async sendMessageToChannelViaIncomingWebhook(_data: {
     url: URL;
     text: string;
@@ -328,6 +359,7 @@ export default class WorkspaceBase {
     throw new NotImplementedException();
   }
 
+  @CaptureSpan()
   public static async isUserInChannel(_data: {
     authToken: string;
     channelId: string;

package/Server/Utils/Workspace/WorkspaceMessages/Alert.ts

@@ -8,8 +8,10 @@ import WorkspaceNotificationRuleService, {
 } from "../../../Services/WorkspaceNotificationRuleService";
 import logger from "../../Logger";
 import SlackAlertMessages from "../Slack/Messages/Alert";
+import CaptureSpan from "../../Telemetry/CaptureSpan";
 
 export default class AlertWorkspaceMessages {
+  @CaptureSpan()
   public static async createChannelsAndInviteUsersToChannels(data: {
     projectId: ObjectID;
     alertId: ObjectID;
@@ -37,6 +39,7 @@ export default class AlertWorkspaceMessages {
     }
   }
 
+  @CaptureSpan()
   public static async getAlertCreateMessageBlocks(data: {
     alertId: ObjectID;
     projectId: ObjectID;

package/Server/Utils/Workspace/WorkspaceMessages/Incident.ts

@@ -8,8 +8,10 @@ import WorkspaceNotificationRuleService, {
 } from "../../../Services/WorkspaceNotificationRuleService";
 import logger from "../../Logger";
 import SlackIncidentMessages from "../Slack/Messages/Incident";
+import CaptureSpan from "../../Telemetry/CaptureSpan";
 
 export default class IncidentWorkspaceMessages {
+  @CaptureSpan()
   public static async createChannelsAndInviteUsersToChannels(data: {
     projectId: ObjectID;
     incidentId: ObjectID;
@@ -36,6 +38,7 @@ export default class IncidentWorkspaceMessages {
     }
   }
 
+  @CaptureSpan()
   public static async getIncidentCreateMessageBlocks(data: {
     incidentId: ObjectID;
     projectId: ObjectID;