@oneuptime/common 8.0.5312 → 8.0.5329

package/Server/Services/OnCallDutyPolicyScheduleService.ts

@@ -36,6 +36,8 @@ import DeleteBy from "../Types/Database/DeleteBy";
 import { OnDelete } from "../Types/Database/Hooks";
 import PushNotificationMessage from "../../Types/PushNotification/PushNotificationMessage";
 import PushNotificationUtil from "../Utils/PushNotificationUtil";
+import { createWhatsAppMessageFromTemplate } from "../Utils/WhatsAppTemplateUtil";
+import { WhatsAppMessagePayload } from "../../Types/WhatsApp/WhatsAppMessage";
 
 export class Service extends DatabaseService<OnCallDutyPolicySchedule> {
   private layerUtil = new LayerUtil();
@@ -265,6 +267,19 @@ export class Service extends DatabaseService<OnCallDutyPolicySchedule> {
               requireInteraction: false,
             });
 
+          const eventType: NotificationSettingEventType =
+            NotificationSettingEventType.SEND_WHEN_USER_IS_NO_LONGER_ACTIVE_ON_ON_CALL_ROSTER;
+
+          const whatsAppMessage: WhatsAppMessagePayload =
+            createWhatsAppMessageFromTemplate({
+              eventType,
+              templateVariables: {
+                on_call_policy_name: onCallPolicy.name!,
+                schedule_name: onCallSchedule.name!,
+                schedule_link: vars["onCallPolicyViewLink"] || "",
+              },
+            });
+
           await UserNotificationSettingService.sendUserNotification({
             userId: sendEmailToUserId,
             projectId: projectId,
@@ -272,8 +287,8 @@ export class Service extends DatabaseService<OnCallDutyPolicySchedule> {
             smsMessage: sms,
             callRequestMessage: callMessage,
             pushNotificationMessage: pushMessage,
-            eventType:
-              NotificationSettingEventType.SEND_WHEN_USER_IS_NO_LONGER_ACTIVE_ON_ON_CALL_ROSTER,
+            whatsAppMessage,
+            eventType,
             onCallPolicyId: escalationRule.onCallDutyPolicy!.id!,
             onCallPolicyEscalationRuleId:
               escalationRule.onCallDutyPolicyEscalationRule!.id!,
@@ -385,6 +400,19 @@ export class Service extends DatabaseService<OnCallDutyPolicySchedule> {
               requireInteraction: true,
             });
 
+          const eventType: NotificationSettingEventType =
+            NotificationSettingEventType.SEND_WHEN_USER_IS_ON_CALL_ROSTER;
+
+          const whatsAppMessage: WhatsAppMessagePayload =
+            createWhatsAppMessageFromTemplate({
+              eventType,
+              templateVariables: {
+                on_call_policy_name: onCallPolicy.name!,
+                schedule_name: onCallSchedule.name!,
+                schedule_link: vars["onCallPolicyViewLink"] || "",
+              },
+            });
+
           await UserNotificationSettingService.sendUserNotification({
             userId: sendEmailToUserId,
             projectId: projectId,
@@ -392,8 +420,8 @@ export class Service extends DatabaseService<OnCallDutyPolicySchedule> {
             smsMessage: sms,
             callRequestMessage: callMessage,
             pushNotificationMessage: pushMessage,
-            eventType:
-              NotificationSettingEventType.SEND_WHEN_USER_IS_ON_CALL_ROSTER,
+            whatsAppMessage,
+            eventType,
             onCallPolicyId: escalationRule.onCallDutyPolicy!.id!,
             onCallPolicyEscalationRuleId:
               escalationRule.onCallDutyPolicyEscalationRule!.id!,
@@ -525,6 +553,19 @@ export class Service extends DatabaseService<OnCallDutyPolicySchedule> {
               requireInteraction: false,
             });
 
+          const eventType: NotificationSettingEventType =
+            NotificationSettingEventType.SEND_WHEN_USER_IS_NEXT_ON_CALL_ROSTER;
+
+          const whatsAppMessage: WhatsAppMessagePayload =
+            createWhatsAppMessageFromTemplate({
+              eventType,
+              templateVariables: {
+                on_call_policy_name: onCallPolicy.name!,
+                schedule_name: onCallSchedule.name!,
+                schedule_link: vars["onCallPolicyViewLink"] || "",
+              },
+            });
+
           await UserNotificationSettingService.sendUserNotification({
             userId: sendEmailToUserId,
             projectId: projectId,
@@ -532,8 +573,8 @@ export class Service extends DatabaseService<OnCallDutyPolicySchedule> {
             smsMessage: sms,
             callRequestMessage: callMessage,
             pushNotificationMessage: pushMessage,
-            eventType:
-              NotificationSettingEventType.SEND_WHEN_USER_IS_NEXT_ON_CALL_ROSTER,
+            whatsAppMessage,
+            eventType,
             onCallPolicyId: escalationRule.onCallDutyPolicy!.id!,
             onCallPolicyEscalationRuleId:
               escalationRule.onCallDutyPolicyEscalationRule!.id!,

package/Server/Services/ProbeService.ts

@@ -33,6 +33,8 @@ import PushNotificationUtil from "../Utils/PushNotificationUtil";
 import CaptureSpan from "../Utils/Telemetry/CaptureSpan";
 import { IsBillingEnabled } from "../EnvironmentConfig";
 import GlobalCache from "../Infrastructure/GlobalCache";
+import { createWhatsAppMessageFromTemplate } from "../Utils/WhatsAppTemplateUtil";
+import { WhatsAppMessagePayload } from "../../Types/WhatsApp/WhatsAppMessage";
 
 export class Service extends DatabaseService<Model> {
   public constructor() {
@@ -387,6 +389,19 @@ export class Service extends DatabaseService<Model> {
             pushMessageParams,
           );
 
+        const eventType: NotificationSettingEventType =
+          NotificationSettingEventType.SEND_PROBE_STATUS_CHANGED_OWNER_NOTIFICATION;
+
+        const whatsAppMessage: WhatsAppMessagePayload =
+          createWhatsAppMessageFromTemplate({
+            eventType,
+            templateVariables: {
+              probe_name: probe.name!,
+              probe_status: connectionStatus,
+              probe_link: vars["viewProbesLink"] || "",
+            },
+          });
+
         await UserNotificationSettingService.sendUserNotification({
           userId: user.id!,
           projectId: probe.projectId!,
@@ -394,8 +409,8 @@ export class Service extends DatabaseService<Model> {
           smsMessage: sms,
           callRequestMessage: callMessage,
           pushNotificationMessage: pushMessage,
-          eventType:
-            NotificationSettingEventType.SEND_PROBE_STATUS_CHANGED_OWNER_NOTIFICATION,
+          whatsAppMessage,
+          eventType,
         });
       } catch (e) {
         logger.error("Error in sending incident created resource notification");

package/Server/Services/UserNotificationRuleService.ts

@@ -9,6 +9,7 @@ import IncidentSeverityService from "./IncidentSeverityService";
 import MailService from "./MailService";
 import ShortLinkService from "./ShortLinkService";
 import SmsService from "./SmsService";
+import WhatsAppService from "./WhatsAppService";
 import UserEmailService from "./UserEmailService";
 import UserOnCallLogService from "./UserOnCallLogService";
 import UserOnCallLogTimelineService from "./UserOnCallLogTimelineService";
@@ -29,6 +30,13 @@ import NotificationRuleType from "../../Types/NotificationRule/NotificationRuleT
 import ObjectID from "../../Types/ObjectID";
 import Phone from "../../Types/Phone";
 import SMS from "../../Types/SMS/SMS";
+import WhatsAppMessage from "../../Types/WhatsApp/WhatsAppMessage";
+import {
+  renderWhatsAppTemplate,
+  WhatsAppTemplateIds,
+  WhatsAppTemplateLanguage,
+  WhatsAppTemplateId,
+} from "../../Types/WhatsApp/WhatsAppTemplates";
 import UserNotificationEventType from "../../Types/UserNotification/UserNotificationEventType";
 import UserNotificationExecutionStatus from "../../Types/UserNotification/UserNotificationExecutionStatus";
 import UserNotificationStatus from "../../Types/UserNotification/UserNotificationStatus";
@@ -135,6 +143,10 @@ export class Service extends DatabaseService<Model> {
           phone: true,
           isVerified: true,
         },
+        userWhatsApp: {
+          phone: true,
+          isVerified: true,
+        },
         userEmail: {
           email: true,
           isVerified: true,
@@ -224,6 +236,7 @@ export class Service extends DatabaseService<Model> {
             name: true,
           },
           rootCause: true,
+          incidentNumber: true,
         },
       });
     }
@@ -252,6 +265,7 @@ export class Service extends DatabaseService<Model> {
           alertSeverity: {
             name: true,
           },
+          alertNumber: true,
         },
       });
     }
@@ -516,6 +530,125 @@ export class Service extends DatabaseService<Model> {
       });
     }
 
+    if (
+      notificationRuleItem.userWhatsApp?.phone &&
+      notificationRuleItem.userWhatsApp?.isVerified
+    ) {
+      if (
+        options.userNotificationEventType ===
+          UserNotificationEventType.AlertCreated &&
+        alert
+      ) {
+        logTimelineItem.status = UserNotificationStatus.Sending;
+        logTimelineItem.statusMessage = `Sending WhatsApp message to ${notificationRuleItem.userWhatsApp?.phone.toString()}.`;
+        logTimelineItem.userWhatsAppId = notificationRuleItem.userWhatsApp.id!;
+
+        const updatedLog: UserOnCallLogTimeline =
+          await UserOnCallLogTimelineService.create({
+            data: logTimelineItem,
+            props: {
+              isRoot: true,
+            },
+          });
+
+        const whatsAppMessage: WhatsAppMessage =
+          await this.generateWhatsAppTemplateForAlertCreated(
+            notificationRuleItem.userWhatsApp.phone,
+            alert,
+            updatedLog.id!,
+          );
+
+        WhatsAppService.sendWhatsAppMessage(whatsAppMessage, {
+          projectId: alert.projectId,
+          alertId: alert.id!,
+          userOnCallLogTimelineId: updatedLog.id!,
+          userId: notificationRuleItem.userId!,
+          onCallPolicyId: options.onCallPolicyId,
+          onCallPolicyEscalationRuleId: options.onCallPolicyEscalationRuleId,
+          teamId: options.userBelongsToTeamId,
+          onCallDutyPolicyExecutionLogTimelineId:
+            options.onCallDutyPolicyExecutionLogTimelineId,
+          onCallScheduleId: options.onCallScheduleId,
+        }).catch(async (err: Error) => {
+          await UserOnCallLogTimelineService.updateOneById({
+            id: updatedLog.id!,
+            data: {
+              status: UserNotificationStatus.Error,
+              statusMessage: err.message || "Error sending WhatsApp message.",
+            },
+            props: {
+              isRoot: true,
+            },
+          });
+        });
+      }
+
+      if (
+        options.userNotificationEventType ===
+          UserNotificationEventType.IncidentCreated &&
+        incident
+      ) {
+        logTimelineItem.status = UserNotificationStatus.Sending;
+        logTimelineItem.statusMessage = `Sending WhatsApp message to ${notificationRuleItem.userWhatsApp?.phone.toString()}.`;
+        logTimelineItem.userWhatsAppId = notificationRuleItem.userWhatsApp.id!;
+
+        const updatedLog: UserOnCallLogTimeline =
+          await UserOnCallLogTimelineService.create({
+            data: logTimelineItem,
+            props: {
+              isRoot: true,
+            },
+          });
+
+        const whatsAppMessage: WhatsAppMessage =
+          await this.generateWhatsAppTemplateForIncidentCreated(
+            notificationRuleItem.userWhatsApp.phone,
+            incident,
+            updatedLog.id!,
+          );
+
+        WhatsAppService.sendWhatsAppMessage(whatsAppMessage, {
+          projectId: incident.projectId,
+          incidentId: incident.id!,
+          userOnCallLogTimelineId: updatedLog.id!,
+          userId: notificationRuleItem.userId!,
+          onCallPolicyId: options.onCallPolicyId,
+          onCallPolicyEscalationRuleId: options.onCallPolicyEscalationRuleId,
+          teamId: options.userBelongsToTeamId,
+          onCallDutyPolicyExecutionLogTimelineId:
+            options.onCallDutyPolicyExecutionLogTimelineId,
+          onCallScheduleId: options.onCallScheduleId,
+        }).catch(async (err: Error) => {
+          await UserOnCallLogTimelineService.updateOneById({
+            id: updatedLog.id!,
+            data: {
+              status: UserNotificationStatus.Error,
+              statusMessage: err.message || "Error sending WhatsApp message.",
+            },
+            props: {
+              isRoot: true,
+            },
+          });
+        });
+      }
+    }
+
+    if (
+      notificationRuleItem.userWhatsApp?.phone &&
+      !notificationRuleItem.userWhatsApp?.isVerified
+    ) {
+      logTimelineItem.status = UserNotificationStatus.Error;
+      logTimelineItem.statusMessage = `WhatsApp message not sent because phone ${notificationRuleItem.userWhatsApp?.phone.toString()} is not verified.`;
+      logTimelineItem.userWhatsAppId = notificationRuleItem.userWhatsApp.id!;
+
+      await UserOnCallLogTimelineService.create({
+        data: logTimelineItem,
+        props: {
+          isRoot: true,
+        },
+      });
+    }
+
     // send call.
     if (
       notificationRuleItem.userCall?.phone &&
@@ -930,11 +1063,14 @@ export class Service extends DatabaseService<Model> {
     );
     const url: URL = await ShortLinkService.getShortenedUrl(shortUrl);
 
+    const alertIdentifier: string =
+      alert.alertNumber !== undefined
+        ? `#${alert.alertNumber} (${alert.title || "Alert"})`
+        : alert.title || "Alert";
+
     const sms: SMS = {
       to,
-      message: `This is a message from OneUptime. A new alert has been created. ${
-        alert.title
-      }. To acknowledge this alert, please click on the following link ${url.toString()}`,
+      message: `This is a message from OneUptime. A new alert has been created: ${alertIdentifier}. To acknowledge this alert, please click on the following link ${url.toString()}`,
     };
 
     return sms;
@@ -960,16 +1096,129 @@ export class Service extends DatabaseService<Model> {
     );
     const url: URL = await ShortLinkService.getShortenedUrl(shortUrl);
 
+    const incidentIdentifier: string =
+      incident.incidentNumber !== undefined
+        ? `#${incident.incidentNumber} (${incident.title || "Incident"})`
+        : incident.title || "Incident";
+
     const sms: SMS = {
       to,
-      message: `This is a message from OneUptime. A new incident has been created. ${
-        incident.title
-      }. To acknowledge this incident, please click on the following link ${url.toString()}`,
+      message: `This is a message from OneUptime. A new incident has been created: ${incidentIdentifier}. To acknowledge this incident, please click on the following link ${url.toString()}`,
     };
 
     return sms;
   }
 
+  @CaptureSpan()
+  public async generateWhatsAppTemplateForAlertCreated(
+    to: Phone,
+    alert: Alert,
+    userOnCallLogTimelineId: ObjectID,
+  ): Promise<WhatsAppMessage> {
+    const host: Hostname = await DatabaseConfig.getHost();
+    const httpProtocol: Protocol = await DatabaseConfig.getHttpProtocol();
+
+    const acknowledgeShortLink: ShortLink =
+      await ShortLinkService.saveShortLinkFor(
+        new URL(
+          httpProtocol,
+          host,
+          new Route(AppApiRoute.toString())
+            .addRoute(new UserOnCallLogTimeline().crudApiPath!)
+            .addRoute("/acknowledge/" + userOnCallLogTimelineId.toString()),
+        ),
+      );
+
+    const acknowledgeUrl: URL =
+      await ShortLinkService.getShortenedUrl(acknowledgeShortLink);
+
+    const alertLinkOnDashboard: string =
+      alert.projectId && alert.id
+        ? (
+            await AlertService.getAlertLinkInDashboard(
+              alert.projectId,
+              alert.id,
+            )
+          ).toString()
+        : acknowledgeUrl.toString();
+
+    const templateKey: WhatsAppTemplateId = WhatsAppTemplateIds.AlertCreated;
+    const templateVariables: Record<string, string> = {
+      project_name: alert.project?.name || "OneUptime",
+      alert_title: alert.title || "",
+      acknowledge_url: acknowledgeUrl.toString(),
+      alert_number:
+        alert.alertNumber !== undefined ? alert.alertNumber.toString() : "",
+      alert_link: alertLinkOnDashboard,
+    };
+
+    const body: string = renderWhatsAppTemplate(templateKey, templateVariables);
+
+    return {
+      to,
+      body,
+      templateKey,
+      templateVariables,
+      templateLanguageCode: WhatsAppTemplateLanguage[templateKey],
+    };
+  }
+
+  @CaptureSpan()
+  public async generateWhatsAppTemplateForIncidentCreated(
+    to: Phone,
+    incident: Incident,
+    userOnCallLogTimelineId: ObjectID,
+  ): Promise<WhatsAppMessage> {
+    const host: Hostname = await DatabaseConfig.getHost();
+    const httpProtocol: Protocol = await DatabaseConfig.getHttpProtocol();
+
+    const acknowledgeShortLink: ShortLink =
+      await ShortLinkService.saveShortLinkFor(
+        new URL(
+          httpProtocol,
+          host,
+          new Route(AppApiRoute.toString())
+            .addRoute(new UserOnCallLogTimeline().crudApiPath!)
+            .addRoute("/acknowledge/" + userOnCallLogTimelineId.toString()),
+        ),
+      );
+
+    const acknowledgeUrl: URL =
+      await ShortLinkService.getShortenedUrl(acknowledgeShortLink);
+
+    const incidentLinkOnDashboard: string =
+      incident.projectId && incident.id
+        ? (
+            await IncidentService.getIncidentLinkInDashboard(
+              incident.projectId,
+              incident.id,
+            )
+          ).toString()
+        : acknowledgeUrl.toString();
+
+    const templateKey: WhatsAppTemplateId = WhatsAppTemplateIds.IncidentCreated;
+    const templateVariables: Record<string, string> = {
+      project_name: incident.project?.name || "OneUptime",
+      incident_title: incident.title || "",
+      acknowledge_url: acknowledgeUrl.toString(),
+      incident_number:
+        incident.incidentNumber !== undefined
+          ? incident.incidentNumber.toString()
+          : "",
+      incident_link: incidentLinkOnDashboard,
+    };
+
+    const body: string = renderWhatsAppTemplate(templateKey, templateVariables);
+
+    return {
+      to,
+      body,
+      templateKey,
+      templateVariables,
+      templateLanguageCode: WhatsAppTemplateLanguage[templateKey],
+    };
+  }
+
   @CaptureSpan()
   public async generateEmailTemplateForAlertCreated(
     to: Email,
@@ -1210,12 +1459,14 @@ export class Service extends DatabaseService<Model> {
       !createBy.data.userEmail &&
       !createBy.data.userSms &&
       !createBy.data.userSmsId &&
+      !createBy.data.userWhatsApp &&
+      !createBy.data.userWhatsAppId &&
       !createBy.data.userEmailId &&
       !createBy.data.userPushId &&
       !createBy.data.userPush
     ) {
       throw new BadDataException(
-        "Call, SMS, Email, or Push notification is required",
+        "Call, SMS, WhatsApp, Email, or Push notification is required",
       );
     }
 

package/Server/Services/UserNotificationSettingService.ts

@@ -10,6 +10,8 @@ import UserCallService from "./UserCallService";
 import UserEmailService from "./UserEmailService";
 import UserSmsService from "./UserSmsService";
 import PushNotificationService from "./PushNotificationService";
+import UserWhatsAppService from "./UserWhatsAppService";
+import WhatsAppService from "./WhatsAppService";
 import { CallRequestMessage } from "../../Types/Call/CallRequest";
 import { LIMIT_PER_PROJECT } from "../../Types/Database/LimitMax";
 import { EmailEnvelope } from "../../Types/Email/EmailMessage";
@@ -19,11 +21,16 @@ import ObjectID from "../../Types/ObjectID";
 import PositiveNumber from "../../Types/PositiveNumber";
 import { SMSMessage } from "../../Types/SMS/SMS";
 import PushNotificationMessage from "../../Types/PushNotification/PushNotificationMessage";
+import WhatsAppMessage, {
+  WhatsAppMessagePayload,
+} from "../../Types/WhatsApp/WhatsAppMessage";
 import UserCall from "../../Models/DatabaseModels/UserCall";
 import UserEmail from "../../Models/DatabaseModels/UserEmail";
 import UserNotificationSetting from "../../Models/DatabaseModels/UserNotificationSetting";
 import UserSMS from "../../Models/DatabaseModels/UserSMS";
+import UserWhatsApp from "../../Models/DatabaseModels/UserWhatsApp";
 import CaptureSpan from "../Utils/Telemetry/CaptureSpan";
+import { appendRecipientToWhatsAppMessage } from "../Utils/WhatsAppTemplateUtil";
 
 export class Service extends DatabaseService<UserNotificationSetting> {
   public constructor() {
@@ -39,6 +46,7 @@ export class Service extends DatabaseService<UserNotificationSetting> {
     smsMessage: SMSMessage;
     callRequestMessage: CallRequestMessage;
     pushNotificationMessage: PushNotificationMessage;
+    whatsAppMessage: WhatsAppMessagePayload;
     incidentId?: ObjectID | undefined;
     alertId?: ObjectID | undefined;
     scheduledMaintenanceId?: ObjectID | undefined;
@@ -67,6 +75,7 @@ export class Service extends DatabaseService<UserNotificationSetting> {
         select: {
           alertByEmail: true,
           alertBySMS: true,
+          alertByWhatsApp: true,
           alertByCall: true,
           alertByPush: true,
         },
@@ -167,6 +176,57 @@ export class Service extends DatabaseService<UserNotificationSetting> {
         }
       }
 
+      if (notificationSettings.alertByWhatsApp) {
+        const userWhatsApps: Array<UserWhatsApp> =
+          await UserWhatsAppService.findBy({
+            query: {
+              userId: data.userId,
+              projectId: data.projectId,
+              isVerified: true,
+            },
+            select: {
+              phone: true,
+            },
+            limit: LIMIT_PER_PROJECT,
+            skip: 0,
+            props: {
+              isRoot: true,
+            },
+          });
+
+        if (!data.whatsAppMessage) {
+          logger.warn(
+            "Skipping WhatsApp notification because WhatsApp template payload is missing.",
+          );
+        } else {
+          for (const userWhatsApp of userWhatsApps) {
+            const whatsAppMessage: WhatsAppMessage =
+              appendRecipientToWhatsAppMessage(
+                data.whatsAppMessage,
+                userWhatsApp.phone!,
+              );
+
+            WhatsAppService.sendWhatsAppMessage(whatsAppMessage, {
+              projectId: data.projectId,
+              incidentId: data.incidentId,
+              alertId: data.alertId,
+              scheduledMaintenanceId: data.scheduledMaintenanceId,
+              statusPageId: data.statusPageId,
+              statusPageAnnouncementId: data.statusPageAnnouncementId,
+              userId: data.userId,
+              teamId: data.teamId,
+              onCallPolicyId: data.onCallPolicyId,
+              onCallPolicyEscalationRuleId: data.onCallPolicyEscalationRuleId,
+              onCallDutyPolicyExecutionLogTimelineId:
+                data.onCallDutyPolicyExecutionLogTimelineId,
+              onCallScheduleId: data.onCallScheduleId,
+            }).catch((err: Error) => {
+              logger.error(err);
+            });
+          }
+        }
+      }
+
       if (notificationSettings.alertByCall) {
         const userCalls: Array<UserCall> = await UserCallService.findBy({
           query: {