mirror of
https://github.com/OneUptime/oneuptime.git
synced 2026-04-06 00:32:12 +02:00
ea71c8bd75
- Added ManualAPI for manually triggering workflows via GET and POST requests. - Introduced WorkflowAPI for updating workflows with authorization checks. - Created documentation for JavaScript and Webhook components. - Established WorkflowFeatureSet to initialize routing and job processing. - Developed QueueWorkflow service for managing workflow queue operations. - Implemented RunWorkflow service to execute workflows with error handling and logging. - Added utility for loading component metadata dynamically.
345 lines
12 KiB
TypeScript
345 lines
12 KiB
TypeScript
import RunCron from "../../Utils/Cron";
|
|
import { CallRequestMessage } from "Common/Types/Call/CallRequest";
|
|
import OneUptimeDate from "Common/Types/Date";
|
|
import Dictionary from "Common/Types/Dictionary";
|
|
import { EmailEnvelope } from "Common/Types/Email/EmailMessage";
|
|
import EmailTemplateType from "Common/Types/Email/EmailTemplateType";
|
|
import NotificationSettingEventType from "Common/Types/NotificationSetting/NotificationSettingEventType";
|
|
import ObjectID from "Common/Types/ObjectID";
|
|
import { SMSMessage } from "Common/Types/SMS/SMS";
|
|
import PushNotificationMessage from "Common/Types/PushNotification/PushNotificationMessage";
|
|
import Text from "Common/Types/Text";
|
|
import { EVERY_MINUTE } from "Common/Utils/CronTime";
|
|
import AlertService from "Common/Server/Services/AlertService";
|
|
import AlertStateTimelineService from "Common/Server/Services/AlertStateTimelineService";
|
|
import AlertStateService from "Common/Server/Services/AlertStateService";
|
|
import ProjectService from "Common/Server/Services/ProjectService";
|
|
import UserNotificationSettingService from "Common/Server/Services/UserNotificationSettingService";
|
|
import PushNotificationUtil from "Common/Server/Utils/PushNotificationUtil";
|
|
import Markdown, { MarkdownContentType } from "Common/Server/Types/Markdown";
|
|
import Alert from "Common/Models/DatabaseModels/Alert";
|
|
import AlertState from "Common/Models/DatabaseModels/AlertState";
|
|
import AlertStateTimeline from "Common/Models/DatabaseModels/AlertStateTimeline";
|
|
import User from "Common/Models/DatabaseModels/User";
|
|
import AlertFeedService from "Common/Server/Services/AlertFeedService";
|
|
import { AlertFeedEventType } from "Common/Models/DatabaseModels/AlertFeed";
|
|
import { Blue500 } from "Common/Types/BrandColors";
|
|
import UserService from "Common/Server/Services/UserService";
|
|
import SortOrder from "Common/Types/BaseDatabase/SortOrder";
|
|
import QueryHelper from "Common/Server/Types/Database/QueryHelper";
|
|
|
|
import { createWhatsAppMessageFromTemplate } from "Common/Server/Utils/WhatsAppTemplateUtil";
|
|
import { WhatsAppMessagePayload } from "Common/Types/WhatsApp/WhatsAppMessage";
|
|
RunCron(
|
|
"AlertOwner:SendStateChangeEmail",
|
|
{ schedule: EVERY_MINUTE, runOnStartup: false },
|
|
async () => {
|
|
// get all scheduled events of all the projects.
|
|
|
|
const alertStateTimelines: Array<AlertStateTimeline> =
|
|
await AlertStateTimelineService.findAllBy({
|
|
query: {
|
|
isOwnerNotified: false,
|
|
},
|
|
props: {
|
|
isRoot: true,
|
|
},
|
|
skip: 0,
|
|
select: {
|
|
_id: true,
|
|
createdAt: true,
|
|
startsAt: true,
|
|
projectId: true,
|
|
project: {
|
|
name: true,
|
|
},
|
|
alertId: true,
|
|
alertStateId: true,
|
|
alertState: {
|
|
name: true,
|
|
color: true,
|
|
},
|
|
},
|
|
});
|
|
|
|
for (const alertStateTimeline of alertStateTimelines) {
|
|
const alertId: ObjectID = alertStateTimeline.alertId!;
|
|
|
|
if (!alertId) {
|
|
continue;
|
|
}
|
|
|
|
// get alert
|
|
|
|
const alert: Alert | null = await AlertService.findOneById({
|
|
id: alertId,
|
|
props: {
|
|
isRoot: true,
|
|
},
|
|
select: {
|
|
_id: true,
|
|
title: true,
|
|
projectId: true,
|
|
description: true,
|
|
monitor: {
|
|
name: true,
|
|
},
|
|
alertNumber: true,
|
|
alertNumberWithPrefix: true,
|
|
},
|
|
});
|
|
|
|
if (!alert) {
|
|
continue;
|
|
}
|
|
|
|
const alertState: AlertState = alertStateTimeline.alertState!;
|
|
|
|
// get alert severity
|
|
const alertWithSeverity: Alert | null = await AlertService.findOneById({
|
|
id: alert.id!,
|
|
props: {
|
|
isRoot: true,
|
|
},
|
|
select: {
|
|
_id: true,
|
|
alertSeverity: {
|
|
name: true,
|
|
},
|
|
},
|
|
});
|
|
|
|
if (!alertWithSeverity) {
|
|
continue;
|
|
}
|
|
|
|
await AlertStateTimelineService.updateOneById({
|
|
id: alertStateTimeline.id!,
|
|
data: {
|
|
isOwnerNotified: true,
|
|
},
|
|
props: {
|
|
isRoot: true,
|
|
},
|
|
});
|
|
|
|
// Fetch the previous state timeline entry
|
|
let previousState: AlertState | null = null;
|
|
let previousStateDuration: string = "";
|
|
|
|
if (alertStateTimeline.alertId && alertStateTimeline.startsAt) {
|
|
const previousTimeline: AlertStateTimeline | null =
|
|
await AlertStateTimelineService.findOneBy({
|
|
query: {
|
|
alertId: alertStateTimeline.alertId,
|
|
startsAt: QueryHelper.lessThan(alertStateTimeline.startsAt),
|
|
},
|
|
sort: {
|
|
startsAt: SortOrder.Descending,
|
|
},
|
|
props: {
|
|
isRoot: true,
|
|
},
|
|
select: {
|
|
alertStateId: true,
|
|
startsAt: true,
|
|
createdAt: true,
|
|
},
|
|
});
|
|
|
|
if (previousTimeline?.alertStateId) {
|
|
previousState = await AlertStateService.findOneById({
|
|
id: previousTimeline.alertStateId,
|
|
props: {
|
|
isRoot: true,
|
|
},
|
|
select: {
|
|
name: true,
|
|
color: true,
|
|
},
|
|
});
|
|
|
|
/*
|
|
* Calculate how long the alert was in the previous state
|
|
* Use startsAt if available, otherwise fall back to createdAt
|
|
*/
|
|
const previousStartTime: Date | undefined =
|
|
previousTimeline.startsAt || previousTimeline.createdAt;
|
|
const currentStartTime: Date | undefined =
|
|
alertStateTimeline.startsAt || alertStateTimeline.createdAt;
|
|
|
|
if (previousStartTime && currentStartTime) {
|
|
const durationInSeconds: number =
|
|
OneUptimeDate.getDifferenceInSeconds(
|
|
currentStartTime,
|
|
previousStartTime,
|
|
);
|
|
previousStateDuration =
|
|
OneUptimeDate.convertSecondsToDaysHoursMinutesAndSeconds(
|
|
durationInSeconds,
|
|
);
|
|
}
|
|
}
|
|
}
|
|
|
|
// now find owners.
|
|
|
|
let doesResourceHasOwners: boolean = true;
|
|
|
|
let owners: Array<User> = await AlertService.findOwners(alert.id!);
|
|
|
|
if (owners.length === 0) {
|
|
doesResourceHasOwners = false;
|
|
|
|
// find project owners.
|
|
owners = await ProjectService.getOwners(alertStateTimeline.projectId!);
|
|
}
|
|
|
|
if (owners.length === 0) {
|
|
continue;
|
|
}
|
|
|
|
let moreAlertFeedInformationInMarkdown: string = "";
|
|
|
|
const alertNumberStr: string =
|
|
alert.alertNumberWithPrefix ||
|
|
(alert.alertNumber ? `#${alert.alertNumber}` : "");
|
|
|
|
for (const user of owners) {
|
|
const alertIdentifier: string =
|
|
alert.alertNumber !== undefined
|
|
? `${alertNumberStr} (${alert.title})`
|
|
: alert.title!;
|
|
|
|
// Build the "Was X for Y" string
|
|
const previousStateDurationText: string =
|
|
previousState?.name && previousStateDuration
|
|
? `Was ${previousState.name} for ${previousStateDuration}`
|
|
: "";
|
|
|
|
const vars: Dictionary<string> = {
|
|
alertTitle: alert.title!,
|
|
alertNumber: alertNumberStr,
|
|
projectName: alertStateTimeline.project!.name!,
|
|
currentState: alertState!.name!,
|
|
currentStateColor: alertState!.color?.toString() || "#000000",
|
|
previousState: previousState?.name || "",
|
|
previousStateColor: previousState?.color?.toString() || "#6b7280",
|
|
previousStateDurationText: previousStateDurationText,
|
|
alertDescription: await Markdown.convertToHTML(
|
|
alert.description! || "",
|
|
MarkdownContentType.Email,
|
|
),
|
|
resourcesAffected: alert.monitor?.name || "",
|
|
stateChangedAt:
|
|
OneUptimeDate.getDateAsFormattedHTMLInMultipleTimezones({
|
|
date: alertStateTimeline.createdAt!,
|
|
timezones: user.timezone ? [user.timezone] : [],
|
|
}),
|
|
alertSeverity: alertWithSeverity.alertSeverity!.name!,
|
|
alertViewLink: (
|
|
await AlertService.getAlertLinkInDashboard(
|
|
alertStateTimeline.projectId!,
|
|
alert.id!,
|
|
)
|
|
).toString(),
|
|
};
|
|
|
|
if (doesResourceHasOwners === true) {
|
|
vars["isOwner"] = "true";
|
|
}
|
|
|
|
const emailMessage: EmailEnvelope = {
|
|
templateType: EmailTemplateType.AlertOwnerStateChanged,
|
|
vars: vars,
|
|
subject: `[Alert ${alertNumberStr} ${Text.uppercaseFirstLetter(
|
|
alertState!.name!,
|
|
)}] - ${alert.title!}`,
|
|
};
|
|
|
|
const sms: SMSMessage = {
|
|
message: `This is a message from OneUptime. Alert ${alertIdentifier} - state changed${previousState ? ` from ${previousState.name}` : ""} to ${alertState!
|
|
.name!}. To unsubscribe from this notification go to User Settings in OneUptime Dashboard.`,
|
|
};
|
|
|
|
const callMessage: CallRequestMessage = {
|
|
data: [
|
|
{
|
|
sayMessage: `This is a message from OneUptime. Alert ${
|
|
alertIdentifier
|
|
} state changed${previousState ? ` from ${previousState.name}` : ""} to ${alertState!
|
|
.name!}. To unsubscribe from this notification go to User Settings in OneUptime Dashboard. Good bye.`,
|
|
},
|
|
],
|
|
};
|
|
|
|
const pushMessage: PushNotificationMessage =
|
|
PushNotificationUtil.createGenericNotification({
|
|
title: `Alert ${alertNumberStr} State Changed: ${alert.title}`,
|
|
body: `Alert ${alertNumberStr} state changed${previousState ? ` from ${previousState.name}` : ""} to ${alertState!.name!} in ${alertStateTimeline.project!.name!}. Click to view details.`,
|
|
clickAction: (
|
|
await AlertService.getAlertLinkInDashboard(
|
|
alertStateTimeline.projectId!,
|
|
alert.id!,
|
|
)
|
|
).toString(),
|
|
tag: "alert-state-changed",
|
|
requireInteraction: true,
|
|
});
|
|
|
|
const eventType: NotificationSettingEventType =
|
|
NotificationSettingEventType.SEND_ALERT_STATE_CHANGED_OWNER_NOTIFICATION;
|
|
|
|
const whatsAppMessage: WhatsAppMessagePayload =
|
|
createWhatsAppMessageFromTemplate({
|
|
eventType,
|
|
templateVariables: {
|
|
alert_title: alert.title!,
|
|
alert_state: alertState!.name!,
|
|
alert_link: vars["alertViewLink"] || "",
|
|
alert_number:
|
|
alert.alertNumber !== undefined
|
|
? alert.alertNumber.toString()
|
|
: "",
|
|
},
|
|
});
|
|
|
|
await UserNotificationSettingService.sendUserNotification({
|
|
userId: user.id!,
|
|
projectId: alertStateTimeline.projectId!,
|
|
emailEnvelope: emailMessage,
|
|
smsMessage: sms,
|
|
callRequestMessage: callMessage,
|
|
pushNotificationMessage: pushMessage,
|
|
whatsAppMessage,
|
|
alertId: alert.id!,
|
|
eventType,
|
|
});
|
|
|
|
moreAlertFeedInformationInMarkdown += `**Notified:** ${await UserService.getUserMarkdownString(
|
|
{
|
|
userId: user.id!,
|
|
projectId: alertStateTimeline.projectId!,
|
|
},
|
|
)})\n`;
|
|
}
|
|
|
|
const alertDisplayNumber: string =
|
|
alert.alertNumberWithPrefix || "#" + alert.alertNumber!;
|
|
const projectId: ObjectID = alert.projectId!;
|
|
|
|
await AlertFeedService.createAlertFeedItem({
|
|
alertId: alert.id!,
|
|
projectId: alert.projectId!,
|
|
alertFeedEventType: AlertFeedEventType.OwnerNotificationSent,
|
|
displayColor: Blue500,
|
|
feedInfoInMarkdown: `🔔 **Owners have been notified about the state change of the [Alert ${alertDisplayNumber}](${(await AlertService.getAlertLinkInDashboard(projectId, alertId)).toString()}).**: Owners have been notified about the state change of the alert because the alert state changed to **${alertState.name}**.`,
|
|
moreInformationInMarkdown: moreAlertFeedInformationInMarkdown,
|
|
workspaceNotification: {
|
|
sendWorkspaceNotification: true,
|
|
},
|
|
});
|
|
}
|
|
},
|
|
);
|