mirror of
https://github.com/louislam/uptime-kuma.git
synced 2024-12-26 22:19:43 -08:00
8a92054c2b
* Added JSDoc to eslint rules Signed-off-by: Matthew Nickson <[email protected]> * Fixed JSDoc eslint errors Signed-off-by: Matthew Nickson <[email protected]> * Update the check-linters workflow to Node.js 20 --------- Signed-off-by: Matthew Nickson <[email protected]> Co-authored-by: Louis Lam <[email protected]>
164 lines
4.7 KiB
JavaScript
164 lines
4.7 KiB
JavaScript
const NotificationProvider = require("./notification-provider");
|
|
const axios = require("axios");
|
|
const { DOWN, UP } = require("../../src/util");
|
|
|
|
class Teams extends NotificationProvider {
|
|
name = "teams";
|
|
|
|
/**
|
|
* Generate the message to send
|
|
* @param {const} status The status constant
|
|
* @param {string} monitorName Name of monitor
|
|
* @returns {string} Status message
|
|
*/
|
|
_statusMessageFactory = (status, monitorName) => {
|
|
if (status === DOWN) {
|
|
return `🔴 Application [${monitorName}] went down`;
|
|
} else if (status === UP) {
|
|
return `✅ Application [${monitorName}] is back online`;
|
|
}
|
|
return "Notification";
|
|
};
|
|
|
|
/**
|
|
* Select theme color to use based on status
|
|
* @param {const} status The status constant
|
|
* @returns {string} Selected color in hex RGB format
|
|
*/
|
|
_getThemeColor = (status) => {
|
|
if (status === DOWN) {
|
|
return "ff0000";
|
|
}
|
|
if (status === UP) {
|
|
return "00e804";
|
|
}
|
|
return "008cff";
|
|
};
|
|
|
|
/**
|
|
* Generate payload for notification
|
|
* @param {object} args Method arguments
|
|
* @param {const} args.status The status of the monitor
|
|
* @param {string} args.monitorMessage Message to send
|
|
* @param {string} args.monitorName Name of monitor affected
|
|
* @param {string} args.monitorUrl URL of monitor affected
|
|
* @returns {object} Notification payload
|
|
*/
|
|
_notificationPayloadFactory = ({
|
|
status,
|
|
monitorMessage,
|
|
monitorName,
|
|
monitorUrl,
|
|
}) => {
|
|
const notificationMessage = this._statusMessageFactory(
|
|
status,
|
|
monitorName
|
|
);
|
|
|
|
const facts = [];
|
|
|
|
if (monitorName) {
|
|
facts.push({
|
|
name: "Monitor",
|
|
value: monitorName,
|
|
});
|
|
}
|
|
|
|
if (monitorUrl && monitorUrl !== "https://") {
|
|
facts.push({
|
|
name: "URL",
|
|
value: monitorUrl,
|
|
});
|
|
}
|
|
|
|
return {
|
|
"@context": "https://schema.org/extensions",
|
|
"@type": "MessageCard",
|
|
themeColor: this._getThemeColor(status),
|
|
summary: notificationMessage,
|
|
sections: [
|
|
{
|
|
activityImage:
|
|
"https://raw.githubusercontent.com/louislam/uptime-kuma/master/public/icon.png",
|
|
activityTitle: "**Uptime Kuma**",
|
|
},
|
|
{
|
|
activityTitle: notificationMessage,
|
|
},
|
|
{
|
|
activityTitle: "**Description**",
|
|
text: monitorMessage,
|
|
facts,
|
|
},
|
|
],
|
|
};
|
|
};
|
|
|
|
/**
|
|
* Send the notification
|
|
* @param {string} webhookUrl URL to send the request to
|
|
* @param {object} payload Payload generated by _notificationPayloadFactory
|
|
* @returns {Promise<void>}
|
|
*/
|
|
_sendNotification = async (webhookUrl, payload) => {
|
|
await axios.post(webhookUrl, payload);
|
|
};
|
|
|
|
/**
|
|
* Send a general notification
|
|
* @param {string} webhookUrl URL to send request to
|
|
* @param {string} msg Message to send
|
|
* @returns {Promise<void>}
|
|
*/
|
|
_handleGeneralNotification = (webhookUrl, msg) => {
|
|
const payload = this._notificationPayloadFactory({
|
|
monitorMessage: msg
|
|
});
|
|
|
|
return this._sendNotification(webhookUrl, payload);
|
|
};
|
|
|
|
/**
|
|
* @inheritdoc
|
|
*/
|
|
async send(notification, msg, monitorJSON = null, heartbeatJSON = null) {
|
|
let okMsg = "Sent Successfully.";
|
|
|
|
try {
|
|
if (heartbeatJSON == null) {
|
|
await this._handleGeneralNotification(notification.webhookUrl, msg);
|
|
return okMsg;
|
|
}
|
|
|
|
let url;
|
|
|
|
switch (monitorJSON["type"]) {
|
|
case "http":
|
|
case "keywork":
|
|
url = monitorJSON["url"];
|
|
break;
|
|
case "docker":
|
|
url = monitorJSON["docker_host"];
|
|
break;
|
|
default:
|
|
url = monitorJSON["hostname"];
|
|
break;
|
|
}
|
|
|
|
const payload = this._notificationPayloadFactory({
|
|
monitorMessage: heartbeatJSON.msg,
|
|
monitorName: monitorJSON.name,
|
|
monitorUrl: url,
|
|
status: heartbeatJSON.status,
|
|
});
|
|
|
|
await this._sendNotification(notification.webhookUrl, payload);
|
|
return okMsg;
|
|
} catch (error) {
|
|
this.throwGeneralAxiosError(error);
|
|
}
|
|
}
|
|
}
|
|
|
|
module.exports = Teams;
|