270 lines
6.1 KiB
TypeScript
270 lines
6.1 KiB
TypeScript
const SERVICE_NAME = "TeamsProvider";
|
|
import type { Notification } from "@/domain/notifications/notification.type.js";
|
|
import { NotificationProvider } from "@/domain/notifications/providers/INotificationProvider.js";
|
|
import type { NotificationMessage } from "@/domain/notifications/notification.type.js";
|
|
import { getTestMessage, incidentUrl } from "@/domain/notifications/providers/utils.js";
|
|
import got, { HTTPError } from "got";
|
|
|
|
// Types for Adaptive Card elements
|
|
type TextBlock = {
|
|
type: "TextBlock";
|
|
text: string;
|
|
weight?: "Bolder" | "Normal" | "Lighter";
|
|
size?: "Small" | "Medium" | "Large" | "ExtraLarge";
|
|
color?: "Default" | "Dark" | "Light" | "Accent" | "Good" | "Warning" | "Attention";
|
|
wrap?: boolean;
|
|
spacing?: "None" | "Small" | "Medium" | "Large" | "ExtraLarge" | "Auto";
|
|
isSubtle?: boolean;
|
|
};
|
|
|
|
type ColumnSet = {
|
|
type: "ColumnSet";
|
|
separator?: boolean;
|
|
spacing?: "None" | "Small" | "Medium" | "Large" | "ExtraLarge" | "Auto";
|
|
columns: unknown[];
|
|
};
|
|
|
|
type Fact = {
|
|
title: string;
|
|
value: string;
|
|
};
|
|
|
|
type FactSet = {
|
|
type: "FactSet";
|
|
facts: Fact[];
|
|
};
|
|
|
|
type Action = {
|
|
type: string;
|
|
title: string;
|
|
url?: string;
|
|
};
|
|
|
|
type AdaptiveCard = {
|
|
type: "AdaptiveCard";
|
|
$schema: "http://adaptivecards.io/schemas/adaptive-card.json";
|
|
version: "1.4";
|
|
body: (TextBlock | ColumnSet | FactSet)[];
|
|
actions?: Action[];
|
|
};
|
|
|
|
type TeamsMessage = {
|
|
type: "message";
|
|
attachments: Array<{
|
|
contentType: "application/vnd.microsoft.card.adaptive";
|
|
contentUrl: null;
|
|
content: AdaptiveCard;
|
|
}>;
|
|
};
|
|
|
|
export class TeamsProvider extends NotificationProvider {
|
|
async sendTestAlert(notification: Partial<Notification>): Promise<boolean> {
|
|
if (!notification.address) {
|
|
return false;
|
|
}
|
|
|
|
try {
|
|
const payload = this.wrapAdaptiveCard({
|
|
type: "AdaptiveCard",
|
|
$schema: "http://adaptivecards.io/schemas/adaptive-card.json",
|
|
version: "1.4",
|
|
body: [
|
|
{
|
|
type: "TextBlock",
|
|
text: getTestMessage(),
|
|
weight: "Bolder",
|
|
size: "Medium",
|
|
},
|
|
],
|
|
});
|
|
|
|
await got.post(notification.address, {
|
|
json: payload,
|
|
headers: {
|
|
"Content-Type": "application/json",
|
|
},
|
|
...this.gotRequestOptions(),
|
|
});
|
|
return true;
|
|
} catch (error) {
|
|
const err = error as HTTPError;
|
|
this.logger.warn({
|
|
message: "Teams test alert failed",
|
|
service: SERVICE_NAME,
|
|
method: "sendTestAlert",
|
|
stack: err?.stack,
|
|
});
|
|
return false;
|
|
}
|
|
}
|
|
|
|
async sendMessage(notification: Notification, message: NotificationMessage): Promise<boolean> {
|
|
if (!notification.address) {
|
|
return false;
|
|
}
|
|
|
|
const payload = this.wrapAdaptiveCard(this.buildAdaptiveCard(message));
|
|
|
|
try {
|
|
await got.post(notification.address, {
|
|
json: payload,
|
|
headers: {
|
|
"Content-Type": "application/json",
|
|
},
|
|
...this.gotRequestOptions(),
|
|
});
|
|
this.logger.info({
|
|
message: "Teams notification sent via sendMessage",
|
|
service: SERVICE_NAME,
|
|
method: "sendMessage",
|
|
});
|
|
return true;
|
|
} catch (error) {
|
|
const err = error as HTTPError;
|
|
this.logger.warn({
|
|
message: "Teams alert failed via sendMessage",
|
|
service: SERVICE_NAME,
|
|
method: "sendMessage",
|
|
stack: err?.stack,
|
|
});
|
|
return false;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Wrap an Adaptive Card in the Teams webhook envelope format
|
|
*/
|
|
private wrapAdaptiveCard(card: AdaptiveCard): TeamsMessage {
|
|
return {
|
|
type: "message",
|
|
attachments: [
|
|
{
|
|
contentType: "application/vnd.microsoft.card.adaptive",
|
|
contentUrl: null,
|
|
content: card,
|
|
},
|
|
],
|
|
};
|
|
}
|
|
|
|
/**
|
|
* Build an Adaptive Card from NotificationMessage
|
|
*/
|
|
private buildAdaptiveCard(message: NotificationMessage): AdaptiveCard {
|
|
const colorMap: Record<string, string> = {
|
|
critical: "attention",
|
|
warning: "warning",
|
|
success: "good",
|
|
info: "accent",
|
|
};
|
|
const color = (colorMap[message.severity] || "default") as "Default" | "Dark" | "Light" | "Accent" | "Good" | "Warning" | "Attention" | undefined;
|
|
|
|
const body: (TextBlock | ColumnSet | FactSet)[] = [];
|
|
|
|
// Header with colored status indicator
|
|
body.push({
|
|
type: "TextBlock",
|
|
text: message.content.title,
|
|
weight: "Bolder",
|
|
size: "Large",
|
|
color,
|
|
wrap: true,
|
|
});
|
|
|
|
// Summary
|
|
body.push({
|
|
type: "TextBlock",
|
|
text: message.content.summary,
|
|
wrap: true,
|
|
spacing: "Small",
|
|
});
|
|
|
|
// Separator
|
|
body.push({
|
|
type: "ColumnSet",
|
|
separator: true,
|
|
spacing: "Medium",
|
|
columns: [],
|
|
});
|
|
|
|
// Monitor details as a FactSet
|
|
body.push({
|
|
type: "FactSet",
|
|
facts: [
|
|
{ title: "Name", value: message.monitor.name },
|
|
{ title: "Type", value: message.monitor.type },
|
|
{ title: "Status", value: message.monitor.status },
|
|
{ title: "URL", value: message.monitor.url },
|
|
],
|
|
});
|
|
|
|
// Threshold breaches
|
|
if (message.content.thresholds && message.content.thresholds.length > 0) {
|
|
body.push({
|
|
type: "TextBlock",
|
|
text: "**Threshold Breaches**",
|
|
weight: "Bolder",
|
|
spacing: "Medium",
|
|
wrap: true,
|
|
});
|
|
|
|
for (const breach of message.content.thresholds) {
|
|
body.push({
|
|
type: "TextBlock",
|
|
text: `• **${breach.metric.toUpperCase()}**: ${breach.formattedValue} (threshold: ${breach.threshold}${breach.unit})`,
|
|
wrap: true,
|
|
spacing: "Small",
|
|
});
|
|
}
|
|
}
|
|
|
|
// Additional details
|
|
if (message.content.details && message.content.details.length > 0) {
|
|
body.push({
|
|
type: "TextBlock",
|
|
text: "**Additional Information**",
|
|
weight: "Bolder",
|
|
spacing: "Medium",
|
|
wrap: true,
|
|
});
|
|
|
|
for (const detail of message.content.details) {
|
|
body.push({
|
|
type: "TextBlock",
|
|
text: `• ${detail}`,
|
|
wrap: true,
|
|
spacing: "Small",
|
|
});
|
|
}
|
|
}
|
|
|
|
// Timestamp footer
|
|
body.push({
|
|
type: "TextBlock",
|
|
text: `Checkmate | ${new Date(message.content.timestamp).toUTCString()}`,
|
|
size: "Small",
|
|
isSubtle: true,
|
|
spacing: "Medium",
|
|
wrap: true,
|
|
});
|
|
|
|
// Actions (incident link)
|
|
const actions: Action[] = [];
|
|
if (message.content.incident) {
|
|
actions.push({
|
|
type: "Action.OpenUrl",
|
|
title: "View Incident",
|
|
url: incidentUrl(message),
|
|
});
|
|
}
|
|
|
|
return {
|
|
type: "AdaptiveCard",
|
|
$schema: "http://adaptivecards.io/schemas/adaptive-card.json",
|
|
version: "1.4",
|
|
body,
|
|
...(actions.length > 0 ? { actions } : {}),
|
|
};
|
|
}
|
|
}
|