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

package/dist/cjs/core/config.js

@@ -4,17 +4,34 @@ exports.WotchiConfigurationError = void 0;
 exports.validateConfig = validateConfig;
 const errors_js_1 = require("./errors.js");
 Object.defineProperty(exports, "WotchiConfigurationError", { enumerable: true, get: function () { return errors_js_1.WotchiConfigurationError; } });
+const limits_js_1 = require("./limits.js");
 const MAX_REDACT_KEYS = 100;
+const MAX_RULES = 50;
+const MAX_RULE_STRING_LENGTH = 200;
+const MAX_LINK_TEMPLATE_LENGTH = 1_000;
+const ALLOWED_LINK_PLACEHOLDERS = new Set([
+    "service",
+    "environment",
+    "release",
+    "instance",
+    "fingerprint",
+    "requestId",
+    "correlationId",
+    "traceId",
+    "spanId",
+    "route",
+    "statusCode",
+]);
 const isRecord = (value) => typeof value === "object" && value !== null;
 const fail = (field) => {
     throw new errors_js_1.WotchiConfigurationError(`${field} is invalid`);
 };
-const readPositiveInteger = (parent, field, defaultValue) => {
+const readPositiveInteger = (parent, field, defaultValue, maximum) => {
     const value = parent?.[field];
     if (value === undefined) {
         return defaultValue;
     }
-    if (typeof value !== "number" || !Number.isSafeInteger(value) || value <= 0) {
+    if (typeof value !== "number" || !Number.isSafeInteger(value) || value <= 0 || value > maximum) {
         return fail(field);
     }
     return value;
@@ -28,6 +45,120 @@ const readOptionalRecord = (value, field) => {
     }
     return value;
 };
+const normalizeRuleString = (value, field) => {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (typeof value !== "string" || value.trim().length === 0) {
+        return fail(field);
+    }
+    return value.trim().slice(0, MAX_RULE_STRING_LENGTH);
+};
+const normalizeSeverity = (value, field) => {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value !== "low" && value !== "medium" && value !== "high" && value !== "critical") {
+        return fail(field);
+    }
+    return value;
+};
+const freezeHook = (hook) => {
+    try {
+        return Object.freeze(hook);
+    }
+    catch {
+        return hook;
+    }
+};
+const normalizeLinks = (value) => {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (!isRecord(value)) {
+        return fail("links");
+    }
+    const normalized = {};
+    for (const key of ["log", "trace"]) {
+        const raw = value[key];
+        if (raw === undefined) {
+            continue;
+        }
+        if (typeof raw !== "string" || raw.length === 0 || raw.length > MAX_LINK_TEMPLATE_LENGTH) {
+            return fail(`links.${key}`);
+        }
+        let parsed;
+        try {
+            parsed = new URL(raw.replace(/\{\{[^{}]+\}\}/g, "placeholder"));
+        }
+        catch {
+            return fail(`links.${key}`);
+        }
+        if (parsed.protocol !== "https:" ||
+            parsed.username !== "" ||
+            parsed.password !== "" ||
+            parsed.hash !== "") {
+            return fail(`links.${key}`);
+        }
+        const placeholders = raw.match(/\{\{([^{}]+)\}\}/g) ?? [];
+        if (/[{}]/.test(raw.replace(/\{\{[^{}]+\}\}/g, ""))) {
+            return fail(`links.${key}`);
+        }
+        for (const placeholder of placeholders) {
+            const name = placeholder.slice(2, -2);
+            if (!ALLOWED_LINK_PLACEHOLDERS.has(name)) {
+                return fail(`links.${key}`);
+            }
+        }
+        normalized[key] = raw;
+    }
+    return Object.freeze(normalized);
+};
+const normalizeRules = (value) => {
+    if (value === undefined) {
+        return Object.freeze([]);
+    }
+    if (!Array.isArray(value) || value.length > MAX_RULES) {
+        return fail("rules");
+    }
+    const rules = value.map((rawRule, index) => {
+        if (!isRecord(rawRule)) {
+            return fail(`rules[${index}]`);
+        }
+        const alertThreshold = rawRule.alertThreshold;
+        if (alertThreshold !== undefined &&
+            (typeof alertThreshold !== "number" ||
+                !Number.isSafeInteger(alertThreshold) ||
+                alertThreshold <= 0 ||
+                alertThreshold > 1_000_000)) {
+            return fail(`rules[${index}].alertThreshold`);
+        }
+        if (rawRule.ignore !== undefined && typeof rawRule.ignore !== "boolean") {
+            return fail(`rules[${index}].ignore`);
+        }
+        const environment = normalizeRuleString(rawRule.environment, `rules[${index}].environment`);
+        const route = normalizeRuleString(rawRule.route, `rules[${index}].route`);
+        const severity = normalizeSeverity(rawRule.severity, `rules[${index}].severity`);
+        const rule = {};
+        if (environment !== undefined) {
+            rule.environment = environment;
+        }
+        if (route !== undefined) {
+            rule.route = route;
+        }
+        if (rawRule.ignore !== undefined) {
+            rule.ignore = rawRule.ignore;
+        }
+        if (alertThreshold !== undefined) {
+            rule.alertThreshold = alertThreshold;
+        }
+        if (severity !== undefined) {
+            rule.severity = severity;
+        }
+        return Object.freeze(rule);
+    });
+    return Object.freeze(rules);
+};
 const normalizeRedactKeys = (privacy) => {
     const value = privacy?.redactKeys;
     if (value === undefined) {
@@ -50,11 +181,19 @@ const normalizeNotifiers = (value) => {
     }
     for (let index = 0; index < value.length; index += 1) {
         const notifier = value[index];
-        if (!isRecord(notifier) ||
-            typeof notifier.name !== "string" ||
-            notifier.name.trim().length === 0 ||
-            typeof notifier.send !== "function") {
-            return fail(`notifiers[${index}]`);
+        const valid = (() => {
+            try {
+                return (isRecord(notifier) &&
+                    typeof notifier.name === "string" &&
+                    notifier.name.trim().length > 0 &&
+                    typeof notifier.send === "function");
+            }
+            catch {
+                return false;
+            }
+        })();
+        if (!valid) {
+            return fail("notifiers[" + index + "]");
         }
     }
     return Object.freeze([...value]);
@@ -75,12 +214,28 @@ function validateConfig(config) {
         (typeof config.release !== "string" || config.release.trim().length === 0)) {
         return fail("release");
     }
+    if (config.instance !== undefined &&
+        (typeof config.instance !== "string" || config.instance.trim().length === 0)) {
+        return fail("instance");
+    }
     if (config.enabled !== undefined && typeof config.enabled !== "boolean") {
         return fail("enabled");
     }
+    if (config.filter !== undefined && typeof config.filter !== "function") {
+        return fail("filter");
+    }
+    if (config.fingerprint !== undefined && typeof config.fingerprint !== "function") {
+        return fail("fingerprint");
+    }
+    if (config.beforeSend !== undefined && typeof config.beforeSend !== "function") {
+        return fail("beforeSend");
+    }
     const grouping = readOptionalRecord(config.grouping, "grouping");
     const queue = readOptionalRecord(config.queue, "queue");
+    const notifierCircuitBreaker = readOptionalRecord(queue?.notifierCircuitBreaker, "queue.notifierCircuitBreaker");
     const privacy = readOptionalRecord(config.privacy, "privacy");
+    const overload = readOptionalRecord(config.overload, "overload");
+    const links = normalizeLinks(config.links);
     const concurrency = queue?.concurrency;
     if (concurrency !== undefined && concurrency !== 1) {
         return fail("queue.concurrency");
@@ -88,25 +243,45 @@ function validateConfig(config) {
     const normalized = {
         service: service.trim(),
         environment: environment.trim(),
-        ...(config.release === undefined ? {} : { release: config.release.trim() }),
+        ...(config.instance === undefined ? {} : { instance: config.instance.trim().slice(0, 200) }),
+        ...(config.release === undefined ? {} : { release: config.release.trim().slice(0, 200) }),
         enabled: config.enabled ?? true,
+        ...(config.filter === undefined ? {} : { filter: freezeHook(config.filter) }),
+        ...(config.fingerprint === undefined ? {} : { fingerprint: freezeHook(config.fingerprint) }),
+        ...(config.beforeSend === undefined ? {} : { beforeSend: freezeHook(config.beforeSend) }),
+        ...(links === undefined ? {} : { links }),
+        rules: normalizeRules(config.rules),
         grouping: Object.freeze({
-            windowMs: readPositiveInteger(grouping, "windowMs", 60_000),
-            alertThreshold: readPositiveInteger(grouping, "alertThreshold", 3),
-            cooldownMs: readPositiveInteger(grouping, "cooldownMs", 900_000),
-            maxGroups: readPositiveInteger(grouping, "maxGroups", 200),
-            maxEventsPerWindow: readPositiveInteger(grouping, "maxEventsPerWindow", 100),
+            windowMs: readPositiveInteger(grouping, "windowMs", 60_000, limits_js_1.MAX_WINDOW_MS),
+            alertThreshold: readPositiveInteger(grouping, "alertThreshold", 3, limits_js_1.MAX_ALERT_THRESHOLD),
+            cooldownMs: readPositiveInteger(grouping, "cooldownMs", 900_000, limits_js_1.MAX_COOLDOWN_MS),
+            maxGroups: readPositiveInteger(grouping, "maxGroups", 200, limits_js_1.MAX_GROUPS),
+            maxEventsPerWindow: readPositiveInteger(grouping, "maxEventsPerWindow", 100, limits_js_1.MAX_EVENTS_PER_WINDOW),
         }),
         queue: Object.freeze({
-            maxPendingAlerts: readPositiveInteger(queue, "maxPendingAlerts", 100),
+            maxPendingAlerts: readPositiveInteger(queue, "maxPendingAlerts", 100, limits_js_1.MAX_PENDING_ALERTS),
             concurrency: 1,
+            notifierTimeoutMs: readPositiveInteger(queue, "notifierTimeoutMs", 5_000, limits_js_1.MAX_NOTIFIER_TIMEOUT_MS),
+            notifierCircuitBreaker: Object.freeze({
+                failureThreshold: readPositiveInteger(notifierCircuitBreaker, "failureThreshold", 3, limits_js_1.MAX_CIRCUIT_BREAKER_FAILURES),
+                cooldownMs: readPositiveInteger(notifierCircuitBreaker, "cooldownMs", 30_000, limits_js_1.MAX_CIRCUIT_BREAKER_COOLDOWN_MS),
+            }),
         }),
+        ...(overload === undefined
+            ? {}
+            : {
+                overload: Object.freeze({
+                    maxEventsPerSecond: readPositiveInteger(overload, "maxEventsPerSecond", 1_000, limits_js_1.MAX_CAPTURE_RATE),
+                    burst: readPositiveInteger(overload, "burst", readPositiveInteger(overload, "maxEventsPerSecond", 1_000, limits_js_1.MAX_CAPTURE_RATE), limits_js_1.MAX_CAPTURE_RATE),
+                    alertCooldownMs: readPositiveInteger(overload, "alertCooldownMs", 60_000, limits_js_1.MAX_COOLDOWN_MS),
+                }),
+            }),
         privacy: Object.freeze({
             redactKeys: normalizeRedactKeys(privacy),
-            maxDepth: readPositiveInteger(privacy, "maxDepth", 5),
-            maxKeys: readPositiveInteger(privacy, "maxKeys", 100),
-            maxStringLength: readPositiveInteger(privacy, "maxStringLength", 500),
-            maxStackLength: readPositiveInteger(privacy, "maxStackLength", 4_000),
+            maxDepth: readPositiveInteger(privacy, "maxDepth", 5, limits_js_1.MAX_NORMALIZATION_DEPTH),
+            maxKeys: readPositiveInteger(privacy, "maxKeys", 100, limits_js_1.MAX_NORMALIZATION_KEYS),
+            maxStringLength: readPositiveInteger(privacy, "maxStringLength", 500, limits_js_1.MAX_NORMALIZATION_STRING_LENGTH),
+            maxStackLength: readPositiveInteger(privacy, "maxStackLength", 4_000, limits_js_1.MAX_NORMALIZATION_STACK_LENGTH),
         }),
         notifiers: normalizeNotifiers(config.notifiers),
     };

package/dist/cjs/core/diagnostics.js

@@ -3,12 +3,27 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.createDiagnosticsState = createDiagnosticsState;
 exports.snapshotDiagnostics = snapshotDiagnostics;
 function createDiagnosticsState() {
-    return { capturedEvents: 0, captureFailures: 0 };
+    return {
+        capturedEvents: 0,
+        captureFailures: 0,
+        fingerprintCallbackFailures: 0,
+        filterFailures: 0,
+        beforeSendFailures: 0,
+        eventsSuppressed: 0,
+        eventsDroppedOverload: 0,
+        capturesAfterShutdown: 0,
+    };
 }
 function snapshotDiagnostics(state, values) {
     return Object.freeze({
         capturedEvents: state.capturedEvents,
         captureFailures: state.captureFailures,
+        fingerprintCallbackFailures: state.fingerprintCallbackFailures,
+        filterFailures: state.filterFailures,
+        beforeSendFailures: state.beforeSendFailures,
+        eventsSuppressed: state.eventsSuppressed,
+        eventsDroppedOverload: state.eventsDroppedOverload,
+        capturesAfterShutdown: state.capturesAfterShutdown,
         ...values,
     });
 }

package/dist/cjs/core/group-store.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createGroupStore = createGroupStore;
 const normalize_js_1 = require("./normalize.js");
+const limits_js_1 = require("./limits.js");
 const rolling_window_js_1 = require("./rolling-window.js");
 const cloneSafeEvent = (event) => {
     const context = event.context === undefined ? undefined : (0, normalize_js_1.normalizeUnknown)(event.context);
@@ -10,16 +11,29 @@ const cloneSafeEvent = (event) => {
         timestamp: event.timestamp,
         service: event.service,
         environment: event.environment,
+        ...(event.instance === undefined ? {} : { instance: event.instance }),
         ...(event.release === undefined ? {} : { release: event.release }),
+        ...(event.correlationId === undefined ? {} : { correlationId: event.correlationId }),
+        ...(event.operation === undefined ? {} : { operation: event.operation }),
+        ...(event.job === undefined ? {} : { job: event.job }),
+        ...(event.tags === undefined ? {} : { tags: { ...event.tags } }),
         error: { ...event.error },
         ...(event.request === undefined ? {} : { request: { ...event.request } }),
+        ...(event.trace === undefined ? {} : { trace: { ...event.trace } }),
         ...(context === undefined ? {} : { context: context }),
     };
 };
 function createGroupStore(options) {
-    if (!Number.isSafeInteger(options.maxGroups) || options.maxGroups <= 0) {
+    if (!Number.isSafeInteger(options.maxGroups) ||
+        options.maxGroups <= 0 ||
+        options.maxGroups > limits_js_1.MAX_GROUPS) {
         throw new RangeError("maxGroups must be a positive integer");
     }
+    if (!Number.isSafeInteger(options.maxEventsPerWindow) ||
+        options.maxEventsPerWindow <= 0 ||
+        options.maxEventsPerWindow > limits_js_1.MAX_EVENTS_PER_WINDOW) {
+        throw new RangeError("maxEventsPerWindow must be a positive integer");
+    }
     const now = options.now ?? Date.now;
     const groups = new Map();
     let evicted = 0;
@@ -36,14 +50,9 @@ function createGroupStore(options) {
         severity: group.severity,
     });
     const evictLeastRecent = () => {
-        let candidate;
-        for (const group of groups.values()) {
-            if (candidate === undefined || group.lastSeenMs < candidate.lastSeenMs) {
-                candidate = group;
-            }
-        }
-        if (candidate !== undefined) {
-            groups.delete(candidate.fingerprint);
+        const oldestFingerprint = groups.keys().next().value;
+        if (typeof oldestFingerprint === "string") {
+            groups.delete(oldestFingerprint);
             evicted += 1;
         }
     };
@@ -69,6 +78,10 @@ function createGroupStore(options) {
             };
             groups.set(fingerprint, group);
         }
+        else {
+            groups.delete(fingerprint);
+            groups.set(fingerprint, group);
+        }
         group.lastSeenMs = timestamp;
         group.totalCount += 1;
         group.severity = severity;

package/dist/cjs/core/incident-builder.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.buildIncidentAlert = buildIncidentAlert;
+const stack_frame_js_1 = require("./stack-frame.js");
 const titleCase = (value) => `${value.slice(0, 1).toUpperCase()}${value.slice(1)}`;
 const suggestedActions = (group) => {
     const text = `${group.sample.error.name} ${group.sample.error.message}`.toLowerCase();
@@ -30,6 +31,11 @@ const suggestedActions = (group) => {
 function buildIncidentAlert(group, decision) {
     const message = group.sample.error.message;
     const errorName = group.sample.error.name;
+    const applicationFrame = (0, stack_frame_js_1.selectApplicationFrame)(group.sample.error.stack);
+    const error = {
+        ...group.sample.error,
+        ...(applicationFrame === undefined ? {} : { applicationFrame }),
+    };
     return {
         id: `wotchi-${group.fingerprint}-${group.lastSeenAt}`,
         fingerprint: group.fingerprint,
@@ -42,5 +48,17 @@ function buildIncidentAlert(group, decision) {
         occurrences: group.windowCount,
         service: group.sample.service,
         environment: group.sample.environment,
+        ...(group.sample.instance === undefined ? {} : { instance: group.sample.instance }),
+        ...(group.sample.release === undefined ? {} : { release: group.sample.release }),
+        ...(group.sample.correlationId === undefined
+            ? {}
+            : { correlationId: group.sample.correlationId }),
+        ...(group.sample.operation === undefined ? {} : { operation: group.sample.operation }),
+        ...(group.sample.job === undefined ? {} : { job: group.sample.job }),
+        ...(group.sample.tags === undefined ? {} : { tags: group.sample.tags }),
+        error,
+        ...(group.sample.request === undefined ? {} : { request: group.sample.request }),
+        ...(group.sample.trace === undefined ? {} : { trace: group.sample.trace }),
+        ...(group.sample.context === undefined ? {} : { context: group.sample.context }),
     };
 }

package/dist/cjs/core/incident-policy.js

@@ -13,13 +13,8 @@ function evaluateIncidentPolicy(input) {
     const eventKind = input.eventKind ?? "error";
     const isCritical = eventKind === "process-monitor";
     const isHigh = input.group.windowCount >= 20 || hasUnavailableResponse(input.group);
-    const severity = isCritical
-        ? "critical"
-        : isHigh
-            ? "high"
-            : eventKind === "manual"
-                ? (input.manualSeverity ?? "low")
-                : "medium";
+    const severity = input.manualSeverity ??
+        (isCritical ? "critical" : isHigh ? "high" : eventKind === "manual" ? "low" : "medium");
     const eligible = isCritical ||
         isHigh ||
         eventKind === "manual" ||

package/dist/cjs/core/limits.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MAX_NORMALIZATION_STACK_LENGTH = exports.MAX_NORMALIZATION_STRING_LENGTH = exports.MAX_NORMALIZATION_KEYS = exports.MAX_NORMALIZATION_DEPTH = exports.MAX_CIRCUIT_BREAKER_FAILURES = exports.MAX_CIRCUIT_BREAKER_COOLDOWN_MS = exports.MAX_NOTIFIER_TIMEOUT_MS = exports.MAX_CAPTURE_RATE = exports.MAX_COOLDOWN_MS = exports.MAX_ALERT_THRESHOLD = exports.MAX_WINDOW_MS = exports.MAX_PENDING_ALERTS = exports.MAX_EVENTS_PER_WINDOW = exports.MAX_GROUPS = void 0;
+exports.MAX_GROUPS = 10_000;
+exports.MAX_EVENTS_PER_WINDOW = 10_000;
+exports.MAX_PENDING_ALERTS = 10_000;
+exports.MAX_WINDOW_MS = 7 * 24 * 60 * 60 * 1_000;
+exports.MAX_ALERT_THRESHOLD = 1_000_000;
+exports.MAX_COOLDOWN_MS = 30 * 24 * 60 * 60 * 1_000;
+exports.MAX_CAPTURE_RATE = 1_000_000;
+exports.MAX_NOTIFIER_TIMEOUT_MS = 60_000;
+exports.MAX_CIRCUIT_BREAKER_COOLDOWN_MS = 24 * 60 * 60 * 1_000;
+exports.MAX_CIRCUIT_BREAKER_FAILURES = 100;
+exports.MAX_NORMALIZATION_DEPTH = 20;
+exports.MAX_NORMALIZATION_KEYS = 10_000;
+exports.MAX_NORMALIZATION_STRING_LENGTH = 32_768;
+exports.MAX_NORMALIZATION_STACK_LENGTH = 32_768;

package/dist/cjs/core/normalize.js

@@ -6,18 +6,19 @@ const UNREADABLE_VALUE = "[unreadable value]";
 const MAX_DEPTH_VALUE = "[MaxDepth]";
 const CIRCULAR_VALUE = "[Circular]";
 const MAX_KEYS_VALUE = "[MaxKeys]";
+const UNSAFE_OBJECT_KEYS = new Set(["__proto__", "prototype", "constructor"]);
 const defaultLimits = {
     maxDepth: 5,
     maxKeys: 100,
     maxStringLength: 500,
     maxStackLength: 4_000,
 };
-const boundedLimit = (value, fallback) => Number.isSafeInteger(value) && value > 0 ? value : fallback;
+const boundedLimit = (value, fallback, maximum) => Number.isSafeInteger(value) && value > 0 && value <= maximum ? value : fallback;
 const normalizeLimits = (limits) => ({
-    maxDepth: boundedLimit(limits?.maxDepth ?? defaultLimits.maxDepth, defaultLimits.maxDepth),
-    maxKeys: boundedLimit(limits?.maxKeys ?? defaultLimits.maxKeys, defaultLimits.maxKeys),
-    maxStringLength: boundedLimit(limits?.maxStringLength ?? defaultLimits.maxStringLength, defaultLimits.maxStringLength),
-    maxStackLength: boundedLimit(limits?.maxStackLength ?? defaultLimits.maxStackLength, defaultLimits.maxStackLength),
+    maxDepth: boundedLimit(limits?.maxDepth ?? defaultLimits.maxDepth, defaultLimits.maxDepth, limits_js_1.MAX_NORMALIZATION_DEPTH),
+    maxKeys: boundedLimit(limits?.maxKeys ?? defaultLimits.maxKeys, defaultLimits.maxKeys, limits_js_1.MAX_NORMALIZATION_KEYS),
+    maxStringLength: boundedLimit(limits?.maxStringLength ?? defaultLimits.maxStringLength, defaultLimits.maxStringLength, limits_js_1.MAX_NORMALIZATION_STRING_LENGTH),
+    maxStackLength: boundedLimit(limits?.maxStackLength ?? defaultLimits.maxStackLength, defaultLimits.maxStackLength, limits_js_1.MAX_NORMALIZATION_STACK_LENGTH),
 });
 const truncate = (value, limit) => value.slice(0, limit);
 const readProperty = (value, key) => {
@@ -89,12 +90,20 @@ const normalizeValue = (value, depth, state, limits) => {
     }
     const result = {};
     for (const key of keys) {
+        if (UNSAFE_OBJECT_KEYS.has(key)) {
+            continue;
+        }
         if (state.keysVisited >= limits.maxKeys - 1) {
             result["[truncated]"] = MAX_KEYS_VALUE;
             break;
         }
         state.keysVisited += 1;
-        result[truncate(key, limits.maxStringLength)] = normalizeValue(readProperty(value, key), depth + 1, state, limits);
+        const child = readProperty(value, key);
+        const normalizedKey = key.toLowerCase().replace(/[^a-z0-9]/g, "");
+        result[truncate(key, limits.maxStringLength)] =
+            normalizedKey === "stack" && typeof child === "string"
+                ? truncate(child, limits.maxStackLength)
+                : normalizeValue(child, depth + 1, state, limits);
     }
     return result;
 };
@@ -136,3 +145,4 @@ function normalizeError(error, limits) {
     const message = typeof normalized === "string" ? normalized : UNREADABLE_VALUE;
     return { name: "UnknownError", message };
 }
+const limits_js_1 = require("./limits.js");

package/dist/cjs/core/notification-queue.js

@@ -1,14 +1,37 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createNotificationQueue = createNotificationQueue;
+const limits_js_1 = require("./limits.js");
 const DEFAULT_FLUSH_TIMEOUT_MS = 5_000;
+const DEFAULT_NOTIFIER_TIMEOUT_MS = 5_000;
+const DEFAULT_CIRCUIT_FAILURE_THRESHOLD = 3;
+const DEFAULT_CIRCUIT_COOLDOWN_MS = 30_000;
 function createNotificationQueue(options) {
-    if (!Number.isSafeInteger(options.maxPendingAlerts) || options.maxPendingAlerts <= 0) {
+    if (!Number.isSafeInteger(options.maxPendingAlerts) ||
+        options.maxPendingAlerts <= 0 ||
+        options.maxPendingAlerts > limits_js_1.MAX_PENDING_ALERTS) {
         throw new RangeError("maxPendingAlerts must be a positive integer");
     }
     if (options.concurrency !== 1) {
         throw new RangeError("concurrency must be 1");
     }
+    if (options.notifierTimeoutMs !== undefined &&
+        (!Number.isSafeInteger(options.notifierTimeoutMs) ||
+            options.notifierTimeoutMs <= 0 ||
+            options.notifierTimeoutMs > limits_js_1.MAX_NOTIFIER_TIMEOUT_MS)) {
+        throw new RangeError("notifierTimeoutMs must be a positive integer");
+    }
+    if (options.notifierCircuitBreaker !== undefined) {
+        const { failureThreshold, cooldownMs } = options.notifierCircuitBreaker;
+        if (!Number.isSafeInteger(failureThreshold) ||
+            failureThreshold <= 0 ||
+            failureThreshold > limits_js_1.MAX_CIRCUIT_BREAKER_FAILURES ||
+            !Number.isSafeInteger(cooldownMs) ||
+            cooldownMs <= 0 ||
+            cooldownMs > limits_js_1.MAX_CIRCUIT_BREAKER_COOLDOWN_MS) {
+            throw new RangeError("notifierCircuitBreaker limits are invalid");
+        }
+    }
     const pendingJobs = [];
     let drainPromise;
     let resolveDrain;
@@ -17,6 +40,15 @@ function createNotificationQueue(options) {
     let dropped = 0;
     let sent = 0;
     let failures = 0;
+    let timeouts = 0;
+    let circuitOpenSkips = 0;
+    let closed = false;
+    const notifierStates = new Map();
+    const notifierTimeoutMs = options.notifierTimeoutMs ?? DEFAULT_NOTIFIER_TIMEOUT_MS;
+    const circuit = options.notifierCircuitBreaker ?? {
+        failureThreshold: DEFAULT_CIRCUIT_FAILURE_THRESHOLD,
+        cooldownMs: DEFAULT_CIRCUIT_COOLDOWN_MS,
+    };
     const notifyFailure = (error, notifier) => {
         failures += 1;
         try {
@@ -35,14 +67,56 @@ function createNotificationQueue(options) {
         resolveDrain = undefined;
     };
     const processJob = async (job) => {
-        for (const notifier of job.notifiers) {
+        const results = await Promise.all(job.notifiers.map(async (notifier) => {
+            const state = notifierStates.get(notifier) ?? { failures: 0, openUntil: 0 };
+            const timestamp = Date.now();
+            if (state.openUntil > timestamp) {
+                circuitOpenSkips += 1;
+                notifyFailure(new Error(`Notifier circuit is open: ${notifier.name}`), notifier);
+                return { sent: 0, failed: 1 };
+            }
+            if (state.openUntil !== 0) {
+                state.openUntil = 0;
+                state.failures = 0;
+            }
+            let timer;
             try {
-                await notifier.send(job.alert);
+                const timeout = new Promise((_, reject) => {
+                    timer = setTimeout(() => {
+                        timeouts += 1;
+                        reject(new Error(`Notifier timed out after ${notifierTimeoutMs}ms: ${notifier.name}`));
+                    }, notifierTimeoutMs);
+                    timer.unref?.();
+                });
+                await Promise.race([notifier.send(job.alert), timeout]);
+                if (timer !== undefined) {
+                    clearTimeout(timer);
+                }
+                state.failures = 0;
+                notifierStates.set(notifier, state);
                 sent += 1;
+                return { sent: 1, failed: 0 };
             }
             catch (error) {
+                if (timer !== undefined) {
+                    clearTimeout(timer);
+                }
+                state.failures += 1;
+                if (state.failures >= circuit.failureThreshold) {
+                    state.openUntil = Date.now() + circuit.cooldownMs;
+                }
+                notifierStates.set(notifier, state);
                 notifyFailure(error, notifier);
+                return { sent: 0, failed: 1 };
             }
+        }));
+        const jobSent = results.reduce((total, result) => total + result.sent, 0);
+        const jobFailures = results.reduce((total, result) => total + result.failed, 0);
+        try {
+            job.onComplete?.({ notifierFailures: jobFailures, sent: jobSent });
+        }
+        catch {
+            // Job observers cannot be allowed to affect notification processing.
         }
     };
     const pump = () => {
@@ -59,16 +133,24 @@ function createNotificationQueue(options) {
             });
         }
     };
-    const enqueue = (alert, notifiers) => {
-        if (pendingJobs.length >= options.maxPendingAlerts) {
+    const enqueue = (alert, notifiers, onComplete) => {
+        if (closed || pendingJobs.length >= options.maxPendingAlerts) {
             dropped += 1;
             return false;
         }
-        pendingJobs.push({ alert, notifiers: [...notifiers] });
+        pendingJobs.push({
+            alert,
+            notifiers: [...notifiers],
+            ...(onComplete === undefined ? {} : { onComplete }),
+        });
         queued += 1;
         pump();
         return true;
     };
+    const close = (timeoutMs = DEFAULT_FLUSH_TIMEOUT_MS) => {
+        closed = true;
+        return flush(timeoutMs);
+    };
     const flush = (timeoutMs = DEFAULT_FLUSH_TIMEOUT_MS) => {
         if (!Number.isSafeInteger(timeoutMs) || timeoutMs <= 0) {
             return Promise.reject(new RangeError("timeoutMs must be a positive integer"));
@@ -94,10 +176,14 @@ function createNotificationQueue(options) {
     return {
         enqueue,
         flush,
+        close,
+        isClosed: () => closed,
         pending: () => pendingJobs.length,
         alertsQueued: () => queued,
         alertsDropped: () => dropped,
         alertsSent: () => sent,
         notifierFailures: () => failures,
+        notifierTimeouts: () => timeouts,
+        notifierCircuitOpenSkips: () => circuitOpenSkips,
     };
 }