@futurewindai/wotchi 0.1.0-beta.2 → 0.1.0-beta.5

package/dist/esm/integrations/request-context.js

@@ -1,5 +1,6 @@
 const MAX_ROUTE_LENGTH = 500;
 const MAX_REQUEST_ID_LENGTH = 200;
+const MAX_CORRELATION_ID_LENGTH = 200;
 const UUID_PATTERN = /^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/i;
 const HEX_PATTERN = /^[0-9a-f]{8,}$/i;
 const isRecord = (value) => typeof value === "object" && value !== null;
@@ -28,6 +29,24 @@ const normalizeRequestIdProperty = (property) => {
     }
     return property;
 };
+const normalizeTraceContextProperty = (property) => {
+    if (property === undefined) {
+        return undefined;
+    }
+    if (!/^[A-Za-z_$][A-Za-z0-9_$]*$/.test(property)) {
+        throw new TypeError("traceContextProperty must be a simple property name");
+    }
+    return property;
+};
+const normalizeCorrelationIdProperty = (property) => {
+    if (property === undefined) {
+        return undefined;
+    }
+    if (!/^[A-Za-z_$][A-Za-z0-9_$]*$/.test(property)) {
+        throw new TypeError("correlationIdProperty must be a simple property name");
+    }
+    return property;
+};
 const readRequestId = (request, property) => {
     if (property === undefined || !isRecord(request)) {
         return undefined;
@@ -43,8 +62,51 @@ const readRequestId = (request, property) => {
         return undefined;
     }
 };
+const readTraceContext = (request, property) => {
+    if (property === undefined || !isRecord(request)) {
+        return undefined;
+    }
+    try {
+        if (!Object.prototype.hasOwnProperty.call(request, property)) {
+            return undefined;
+        }
+        const value = request[property];
+        if (!isRecord(value)) {
+            return undefined;
+        }
+        const traceId = typeof value.traceId === "string" ? value.traceId.slice(0, 128) : undefined;
+        const spanId = typeof value.spanId === "string" ? value.spanId.slice(0, 128) : undefined;
+        if (traceId === undefined && spanId === undefined) {
+            return undefined;
+        }
+        return {
+            ...(traceId === undefined ? {} : { traceId }),
+            ...(spanId === undefined ? {} : { spanId }),
+        };
+    }
+    catch {
+        return undefined;
+    }
+};
+const readCorrelationId = (request, property) => {
+    if (property === undefined || !isRecord(request)) {
+        return undefined;
+    }
+    try {
+        if (!Object.prototype.hasOwnProperty.call(request, property)) {
+            return undefined;
+        }
+        const value = request[property];
+        return typeof value === "string" ? value.slice(0, MAX_CORRELATION_ID_LENGTH) : undefined;
+    }
+    catch {
+        return undefined;
+    }
+};
 export function buildRequestContext(input) {
     const requestIdProperty = normalizeRequestIdProperty(input.options?.requestIdProperty);
+    const correlationIdProperty = normalizeCorrelationIdProperty(input.options?.correlationIdProperty);
+    const traceContextProperty = normalizeTraceContextProperty(input.options?.traceContextProperty);
     let requestId;
     try {
         requestId = readRequestId(input.request, requestIdProperty);
@@ -52,6 +114,22 @@ export function buildRequestContext(input) {
     catch {
         requestId = undefined;
     }
+    let correlationId;
+    try {
+        correlationId = readCorrelationId(input.request, correlationIdProperty);
+    }
+    catch {
+        correlationId = undefined;
+    }
+    let trace;
+    try {
+        const explicitTrace = input.trace;
+        trace = readTraceContext({ trace: explicitTrace }, "trace");
+        trace ??= readTraceContext(input.request, traceContextProperty);
+    }
+    catch {
+        trace = undefined;
+    }
     const method = typeof input.method === "string" ? input.method.slice(0, 16) : undefined;
     const route = normalizeRoutePath(input.route);
     const statusCode = typeof input.statusCode === "number" && Number.isSafeInteger(input.statusCode)
@@ -60,7 +138,9 @@ export function buildRequestContext(input) {
     if (method === undefined &&
         route === undefined &&
         statusCode === undefined &&
-        requestId === undefined) {
+        requestId === undefined &&
+        correlationId === undefined &&
+        trace === undefined) {
         return undefined;
     }
     return {
@@ -68,5 +148,7 @@ export function buildRequestContext(input) {
         ...(route === undefined ? {} : { route }),
         ...(statusCode === undefined ? {} : { statusCode }),
         ...(requestId === undefined ? {} : { requestId }),
+        ...(correlationId === undefined ? {} : { correlationId }),
+        ...(trace === undefined ? {} : { trace }),
     };
 }

package/dist/esm/notifiers/alert-payload.js

@@ -0,0 +1,16 @@
+import { redactValue } from "../core/redact.js";
+const isRecord = (value) => typeof value === "object" && value !== null && !Array.isArray(value);
+export function toBoundedPayload(value) {
+    const redacted = redactValue(value, {
+        maxDepth: 6,
+        maxKeys: 100,
+        maxStringLength: 1_000,
+        maxStackLength: 4_000,
+    });
+    return isRecord(redacted)
+        ? redacted
+        : { title: "Wotchi alert", summary: "Incident details were unavailable." };
+}
+export function toBoundedAlertPayload(alert) {
+    return toBoundedPayload(alert);
+}

package/dist/esm/notifiers/console.js

@@ -1,4 +1,5 @@
 import { redactValue } from "../core/redact.js";
+import { toBoundedAlertPayload } from "./alert-payload.js";
 const MAX_FIELD_LENGTH = 1_000;
 const MAX_ACTIONS = 5;
 const limit = (value, maxLength = MAX_FIELD_LENGTH) => value.slice(0, maxLength);
@@ -6,26 +7,94 @@ const safeText = (value, maxLength = MAX_FIELD_LENGTH) => {
     const redacted = redactValue(value, { maxStringLength: maxLength });
     return typeof redacted === "string" ? limit(redacted, maxLength) : "[unreadable value]";
 };
-const boundedAlert = (alert) => ({
-    title: safeText(alert.title),
-    fingerprint: safeText(alert.fingerprint),
-    severity: alert.severity,
-    summary: safeText(alert.summary),
-    suggestedActions: alert.suggestedActions
-        .slice(0, MAX_ACTIONS)
-        .map((action) => safeText(action, 300)),
-    firstSeenAt: safeText(alert.firstSeenAt, 100),
-    lastSeenAt: safeText(alert.lastSeenAt, 100),
-    occurrences: Number.isSafeInteger(alert.occurrences) && alert.occurrences >= 0 ? alert.occurrences : 0,
-    service: safeText(alert.service, 300),
-    environment: safeText(alert.environment, 300),
-});
+const safeJson = (value) => {
+    try {
+        return JSON.stringify(value);
+    }
+    catch {
+        return "[unreadable value]";
+    }
+};
+const boundedAlert = (alert) => {
+    const payload = toBoundedAlertPayload(alert);
+    return {
+        ...payload,
+        title: safeText(typeof payload.title === "string" ? payload.title : alert.title),
+        fingerprint: safeText(typeof payload.fingerprint === "string" ? payload.fingerprint : alert.fingerprint),
+        severity: alert.severity,
+        summary: safeText(typeof payload.summary === "string" ? payload.summary : alert.summary),
+        suggestedActions: alert.suggestedActions
+            .slice(0, MAX_ACTIONS)
+            .map((action) => safeText(action, 300)),
+        firstSeenAt: safeText(alert.firstSeenAt, 100),
+        lastSeenAt: safeText(alert.lastSeenAt, 100),
+        occurrences: Number.isSafeInteger(alert.occurrences) && alert.occurrences >= 0 ? alert.occurrences : 0,
+        service: safeText(alert.service, 300),
+        environment: safeText(alert.environment, 300),
+    };
+};
+const textDetails = (alert) => {
+    const lines = [];
+    if (alert.release !== undefined) {
+        lines.push(`Release: ${safeText(alert.release, 200)}`);
+    }
+    if (alert.instance !== undefined) {
+        lines.push(`Instance: ${safeText(alert.instance, 200)}`);
+    }
+    if (alert.operation !== undefined) {
+        lines.push(`Operation: ${safeText(alert.operation, 200)}`);
+    }
+    if (alert.job !== undefined) {
+        lines.push(`Job: ${safeText(alert.job, 200)}`);
+    }
+    if (alert.correlationId !== undefined) {
+        lines.push(`Correlation ID: ${safeText(alert.correlationId, 200)}`);
+    }
+    if (alert.tags !== undefined) {
+        lines.push(`Tags: ${safeText(safeJson(alert.tags), 600)}`);
+    }
+    if (alert.error !== undefined) {
+        lines.push(`Error: ${safeText(alert.error.name, 300)} — ${safeText(alert.error.message, 600)}`);
+        if (alert.error.applicationFrame !== undefined) {
+            lines.push(`Application frame: ${safeText(alert.error.applicationFrame, 500)}`);
+        }
+    }
+    if (alert.request !== undefined) {
+        const request = [alert.request.method, alert.request.route].filter((value) => typeof value === "string");
+        if (alert.request.statusCode !== undefined) {
+            request.push(`status ${alert.request.statusCode}`);
+        }
+        if (request.length > 0) {
+            lines.push(`Request: ${request.join(" ")}`);
+        }
+        if (alert.request.requestId !== undefined) {
+            lines.push(`Request ID: ${safeText(alert.request.requestId, 200)}`);
+        }
+        if (alert.request.correlationId !== undefined) {
+            lines.push(`Correlation ID: ${safeText(alert.request.correlationId, 200)}`);
+        }
+    }
+    const trace = alert.trace ?? alert.request?.trace;
+    if (trace?.traceId !== undefined || trace?.spanId !== undefined) {
+        lines.push(`Trace: ${safeText(trace.traceId ?? "", 128)}${trace.spanId === undefined ? "" : ` span ${safeText(trace.spanId, 128)}`}`);
+    }
+    if (alert.context !== undefined) {
+        lines.push(`Context: ${safeText(safeJson(alert.context), 1_000)}`);
+    }
+    if (alert.links !== undefined) {
+        lines.push(`Links: ${safeText(safeJson(alert.links), 600)}`);
+    }
+    return lines;
+};
 export function formatConsoleAlert(alert, format = "text") {
     const bounded = boundedAlert(alert);
     if (format === "json") {
         return JSON.stringify(bounded);
     }
-    const actions = bounded.suggestedActions.map((action) => `- ${action}`).join("\n");
+    const actions = alert.suggestedActions
+        .slice(0, MAX_ACTIONS)
+        .map((action) => `- ${safeText(action, 300)}`)
+        .join("\n");
     return [
         bounded.title,
         `Service: ${bounded.service}`,
@@ -34,6 +103,7 @@ export function formatConsoleAlert(alert, format = "text") {
         `Occurrences: ${bounded.occurrences}`,
         `First seen: ${bounded.firstSeenAt}`,
         `Last seen: ${bounded.lastSeenAt}`,
+        ...textDetails(alert),
         "Suggested checks:",
         actions,
     ].join("\n");

package/dist/esm/notifiers/telegram-format.js

@@ -1,3 +1,4 @@
+import { redactValue } from "../core/redact.js";
 const MAX_MESSAGE_LENGTH = 4_096;
 const MAX_ACTIONS = 5;
 const MAX_TITLE_LENGTH = 300;
@@ -5,9 +6,76 @@ const MAX_SERVICE_LENGTH = 300;
 const MAX_ENVIRONMENT_LENGTH = 300;
 const MAX_SUMMARY_LENGTH = 2_000;
 const MAX_ACTION_LENGTH = 600;
+const MAX_DETAIL_LENGTH = 900;
 const escapeHtml = (value) => value.replaceAll("&", "&amp;").replaceAll("<", "&lt;").replaceAll(">", "&gt;");
 const limit = (value, maxLength) => value.slice(0, maxLength);
-const render = (title, service, environment, summary, actions, firstSeenAt, lastSeenAt, occurrences) => {
+const safeText = (value, maxLength) => {
+    const redacted = redactValue(value, { maxStringLength: maxLength });
+    return typeof redacted === "string" ? limit(redacted, maxLength) : "[unreadable value]";
+};
+const safeJson = (value) => {
+    try {
+        return JSON.stringify(value);
+    }
+    catch {
+        return "[unreadable value]";
+    }
+};
+const details = (alert) => {
+    const lines = [];
+    if (alert.release !== undefined) {
+        lines.push(`Release: ${safeText(alert.release, 200)}`);
+    }
+    if (alert.instance !== undefined) {
+        lines.push(`Instance: ${safeText(alert.instance, 200)}`);
+    }
+    if (alert.operation !== undefined) {
+        lines.push(`Operation: ${safeText(alert.operation, 200)}`);
+    }
+    if (alert.job !== undefined) {
+        lines.push(`Job: ${safeText(alert.job, 200)}`);
+    }
+    if (alert.correlationId !== undefined) {
+        lines.push(`Correlation ID: ${safeText(alert.correlationId, 200)}`);
+    }
+    if (alert.tags !== undefined) {
+        lines.push(`Tags: ${safeText(safeJson(alert.tags), MAX_DETAIL_LENGTH)}`);
+    }
+    if (alert.error !== undefined) {
+        lines.push(`Error: ${safeText(alert.error.name, 250)} — ${safeText(alert.error.message, 500)}`);
+        if (alert.error.applicationFrame !== undefined) {
+            lines.push(`Application frame: ${safeText(alert.error.applicationFrame, 500)}`);
+        }
+    }
+    if (alert.request !== undefined) {
+        const request = [alert.request.method, alert.request.route].filter((value) => typeof value === "string");
+        if (alert.request.statusCode !== undefined) {
+            request.push(`status ${alert.request.statusCode}`);
+        }
+        if (request.length > 0) {
+            lines.push(`Request: ${request.join(" ")}`);
+        }
+        if (alert.request.requestId !== undefined) {
+            lines.push(`Request ID: ${safeText(alert.request.requestId, 200)}`);
+        }
+        if (alert.request.correlationId !== undefined) {
+            lines.push(`Correlation ID: ${safeText(alert.request.correlationId, 200)}`);
+        }
+    }
+    const trace = alert.trace ?? alert.request?.trace;
+    if (trace?.traceId !== undefined || trace?.spanId !== undefined) {
+        lines.push(`Trace: ${safeText(trace.traceId ?? "", 128)}${trace.spanId === undefined ? "" : ` span ${safeText(trace.spanId, 128)}`}`);
+    }
+    if (alert.context !== undefined) {
+        const redacted = redactValue(alert.context, { maxDepth: 4, maxKeys: 40, maxStringLength: 300 });
+        lines.push(`Context: ${safeText(safeJson(redacted), MAX_DETAIL_LENGTH)}`);
+    }
+    if (alert.links !== undefined) {
+        lines.push(`Links: ${safeText(safeJson(alert.links), MAX_DETAIL_LENGTH)}`);
+    }
+    return lines.map((line) => limit(line, MAX_DETAIL_LENGTH));
+};
+const render = (title, service, environment, summary, actions, context, firstSeenAt, lastSeenAt, occurrences) => {
     const actionText = actions.length === 0
         ? "- No suggested checks."
         : actions.map((action) => `- ${escapeHtml(action)}`).join("\n");
@@ -19,6 +87,7 @@ const render = (title, service, environment, summary, actions, firstSeenAt, last
         `Occurrences: ${occurrences}`,
         `First seen: ${escapeHtml(firstSeenAt)}`,
         `Last seen: ${escapeHtml(lastSeenAt)}`,
+        ...context.map((line) => escapeHtml(line)),
         "Suggested checks:",
         actionText,
     ].join("\n");
@@ -33,17 +102,18 @@ export function formatTelegramAlert(alert) {
     let actions = alert.suggestedActions
         .slice(0, MAX_ACTIONS)
         .map((action) => limit(action, MAX_ACTION_LENGTH));
-    let formatted = render(title, service, environment, summary, actions, firstSeenAt, lastSeenAt, alert.occurrences);
+    const context = details(alert);
+    let formatted = render(title, service, environment, summary, actions, context, firstSeenAt, lastSeenAt, alert.occurrences);
     while (formatted.length > MAX_MESSAGE_LENGTH && actions.length > 0) {
         actions = actions.slice(0, -1);
-        formatted = render(title, service, environment, summary, actions, firstSeenAt, lastSeenAt, alert.occurrences);
+        formatted = render(title, service, environment, summary, actions, context, firstSeenAt, lastSeenAt, alert.occurrences);
     }
     while (formatted.length > MAX_MESSAGE_LENGTH && summary.length > 0) {
         summary = summary.slice(0, Math.max(0, summary.length - 200));
-        formatted = render(title, service, environment, summary, actions, firstSeenAt, lastSeenAt, alert.occurrences);
+        formatted = render(title, service, environment, summary, actions, context, firstSeenAt, lastSeenAt, alert.occurrences);
     }
     if (formatted.length > MAX_MESSAGE_LENGTH) {
-        formatted = render(limit(title, 100), limit(service, 100), limit(environment, 100), "Incident details were truncated.", [], firstSeenAt, lastSeenAt, alert.occurrences);
+        formatted = render(limit(title, 100), limit(service, 100), limit(environment, 100), "Incident details were truncated.", [], [], firstSeenAt, lastSeenAt, alert.occurrences);
     }
     return formatted;
 }