ric/uptime-kuma
1
0
Fork 0
mirror of https://github.com/louislam/uptime-kuma.git synced 2024-11-23 14:54:05 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Refactor MS-Teams notification to use AdaptiveCards (#4538)

Browse source
This commit is contained in:
Frank Elsinga 2024-03-07 15:36:32 +01:00 committed by GitHub
commit 6eef2192b0
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 143 additions and 51 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

194
server/notification-providers/teams.js
View file

@ -1,6 +1,7 @@
const NotificationProvider = require("./notification-provider"); const NotificationProvider = require("./notification-provider");
const axios = require("axios"); const axios = require("axios");
const { DOWN, UP } = require("../../src/util"); const { setting } = require("../util-server");
const { DOWN, UP, getMonitorRelativeURL } = require("../../src/util");
class Teams extends NotificationProvider { class Teams extends NotificationProvider {
name = "teams"; name = "teams";
@ -9,89 +10,172 @@ class Teams extends NotificationProvider {
* Generate the message to send * Generate the message to send
* @param {const} status The status constant * @param {const} status The status constant
* @param {string} monitorName Name of monitor * @param {string} monitorName Name of monitor
* @param {boolean} withStatusSymbol If the status should be prepended as symbol
* @returns {string} Status message * @returns {string} Status message
*/ */
_statusMessageFactory = (status, monitorName) => { _statusMessageFactory = (status, monitorName, withStatusSymbol) => {
if (status === DOWN) { if (status === DOWN) {
return `🔴 Application [${monitorName}] went down`; return (withStatusSymbol ? "🔴 " : "") + `[${monitorName}] went down`;
} else if (status === UP) { } else if (status === UP) {
return `✅ Application [${monitorName}] is back online`; return (withStatusSymbol ? "✅ " : "") + `[${monitorName}] is back online`;
} }
return "Notification"; return "Notification";
}; };
/** /**
* Select theme color to use based on status * Select the style to use based on status
* @param {const} status The status constant * @param {const} status The status constant
* @returns {string} Selected color in hex RGB format * @returns {string} Selected style for adaptive cards
*/ */
_getThemeColor = (status) => { _getStyle = (status) => {
if (status === DOWN) { if (status === DOWN) {
return "ff0000"; return "attention";
} }
if (status === UP) { if (status === UP) {
return "00e804"; return "good";
} }
return "008cff"; return "emphasis";
}; };
/** /**
* Generate payload for notification * Generate payload for notification
* @param {object} args Method arguments * @param {object} args Method arguments
* @param {const} args.status The status of the monitor * @param {object} args.heartbeatJSON Heartbeat details
* @param {string} args.monitorMessage Message to send * @param {string} args.monitorName Name of the monitor affected
* @param {string} args.monitorName Name of monitor affected * @param {string} args.monitorUrl URL of the monitor affected
* @param {string} args.monitorUrl URL of monitor affected * @param {string} args.dashboardUrl URL of the dashboard affected
* @returns {object} Notification payload * @returns {object} Notification payload
*/ */
_notificationPayloadFactory = ({ _notificationPayloadFactory = ({
status, heartbeatJSON,
monitorMessage,
monitorName, monitorName,
monitorUrl, monitorUrl,
dashboardUrl,
}) => { }) => {
const notificationMessage = this._statusMessageFactory( const status = heartbeatJSON?.status;
status,
monitorName
);
const facts = []; const facts = [];
const actions = [];
if (dashboardUrl) {
actions.push({
"type": "Action.OpenUrl",
"title": "Visit Uptime Kuma",
"url": dashboardUrl
});
}
if (heartbeatJSON?.msg) {
facts.push({
title: "Description",
value: heartbeatJSON.msg,
});
}
if (monitorName) { if (monitorName) {
facts.push({ facts.push({
name: "Monitor", title: "Monitor",
value: monitorName, value: monitorName,
}); });
} }
if (monitorUrl && monitorUrl !== "https://") { if (monitorUrl && monitorUrl !== "https://") {
facts.push({ facts.push({
name: "URL", title: "URL",
value: monitorUrl, // format URL as markdown syntax, to be clickable
value: `[${monitorUrl}](${monitorUrl})`,
});
actions.push({
"type": "Action.OpenUrl",
"title": "Visit Monitor URL",
"url": monitorUrl
}); });
} }
return { if (heartbeatJSON?.localDateTime) {
"@context": "https://schema.org/extensions", facts.push({
"@type": "MessageCard", title: "Time",
themeColor: this._getThemeColor(status), value: heartbeatJSON.localDateTime + (heartbeatJSON.timezone ? ` (${heartbeatJSON.timezone})` : ""),
summary: notificationMessage, });
sections: [ }
const payload = {
"type": "message",
// message with status prefix as notification text
"summary": this._statusMessageFactory(status, monitorName, true),
"attachments": [
{ {
activityImage: "contentType": "application/vnd.microsoft.card.adaptive",
"https://raw.githubusercontent.com/louislam/uptime-kuma/master/public/icon.png", "contentUrl": "",
activityTitle: "**Uptime Kuma**", "content": {
}, "type": "AdaptiveCard",
{ "body": [
activityTitle: notificationMessage, {
}, "type": "Container",
{ "verticalContentAlignment": "Center",
activityTitle: "**Description**", "items": [
text: monitorMessage, {
facts, "type": "ColumnSet",
}, "style": this._getStyle(status),
], "columns": [
{
"type": "Column",
"width": "auto",
"verticalContentAlignment": "Center",
"items": [
{
"type": "Image",
"width": "32px",
"style": "Person",
"url": "https://raw.githubusercontent.com/louislam/uptime-kuma/master/public/icon.png",
"altText": "Uptime Kuma Logo"
}
]
},
{
"type": "Column",
"width": "stretch",
"items": [
{
"type": "TextBlock",
"size": "Medium",
"weight": "Bolder",
"text": `**${this._statusMessageFactory(status, monitorName, false)}**`,
},
{
"type": "TextBlock",
"size": "Small",
"weight": "Default",
"text": "Uptime Kuma Alert",
"isSubtle": true,
"spacing": "None"
}
]
}
]
}
]
},
{
"type": "FactSet",
"separator": false,
"facts": facts
}
],
"$schema": "http://adaptivecards.io/schemas/adaptive-card.json",
"version": "1.5"
}
}
]
}; };
if (actions) {
payload.attachments[0].content.body.push({
"type": "ActionSet",
"actions": actions,
});
}
return payload;
}; };
/** /**
@ -112,7 +196,9 @@ class Teams extends NotificationProvider {
*/ */
_handleGeneralNotification = (webhookUrl, msg) => { _handleGeneralNotification = (webhookUrl, msg) => {
const payload = this._notificationPayloadFactory({ const payload = this._notificationPayloadFactory({
monitorMessage: msg heartbeatJSON: {
msg: msg
}
}); });
return this._sendNotification(webhookUrl, payload); return this._sendNotification(webhookUrl, payload);
@ -130,26 +216,32 @@ class Teams extends NotificationProvider {
return okMsg; return okMsg;
} }
let url; let monitorUrl;
switch (monitorJSON["type"]) { switch (monitorJSON["type"]) {
case "http": case "http":
case "keywork": case "keywork":
url = monitorJSON["url"]; monitorUrl = monitorJSON["url"];
break; break;
case "docker": case "docker":
url = monitorJSON["docker_host"]; monitorUrl = monitorJSON["docker_host"];
break; break;
default: default:
url = monitorJSON["hostname"]; monitorUrl = monitorJSON["hostname"];
break; break;
} }
const baseURL = await setting("primaryBaseURL");
let dashboardUrl;
if (baseURL) {
dashboardUrl = baseURL + getMonitorRelativeURL(monitorJSON.id);
}
const payload = this._notificationPayloadFactory({ const payload = this._notificationPayloadFactory({
monitorMessage: heartbeatJSON.msg, heartbeatJSON: heartbeatJSON,
monitorName: monitorJSON.name, monitorName: monitorJSON.name,
monitorUrl: url, monitorUrl: monitorUrl,
status: heartbeatJSON.status, dashboardUrl: dashboardUrl,
}); });
await this._sendNotification(notification.webhookUrl, payload); await this._sendNotification(notification.webhookUrl, payload);