feat(triggers): start alert workflow after consecutive cron/http failures

Co-authored-by: Nasyarobby Putra <nasyarobby@gmail.com>
2026-08-16 23:45:45 +00:00
parent 989bf5d487
commit 0c416506d6
8 changed files with 380 additions and 8 deletions
@@ -0,0 +1,121 @@
+import { namespacedPath } from "./workflow-parse.js";
+
+/**
+ * @param {unknown} value
+ */
+function triggerTypesMatch(left, right) {
+  return String(left ?? "").toLowerCase() === String(right ?? "").toLowerCase();
+}
+
+/**
+ * @param {unknown} rawTrigger
+ * @param {string} owner
+ * @param {{ type: string, detail?: string | null }} runtimeTrigger
+ */
+export function findTriggerSpec(rawTrigger, owner, runtimeTrigger) {
+  if (rawTrigger == null || typeof rawTrigger !== "object" || Array.isArray(rawTrigger)) {
+    return null;
+  }
+  const trigger = /** @type {Record<string, unknown>} */ (rawTrigger);
+  if (!triggerTypesMatch(trigger.type, runtimeTrigger.type)) return null;
+
+  const type = String(runtimeTrigger.type).toLowerCase();
+  if (type === "cron") {
+    return trigger.schedule === runtimeTrigger.detail ? trigger : null;
+  }
+  if (type === "http") {
+    const method = String(trigger.method ?? "POST").toUpperCase();
+    const url = namespacedPath(owner, String(trigger.path ?? ""));
+    const detail = `${method} ${url}`;
+    return detail === runtimeTrigger.detail ? trigger : null;
+  }
+  return null;
+}
+
+/**
+ * @param {unknown} workflow
+ * @param {string} owner
+ * @param {{ type: string, detail?: string | null }} runtimeTrigger
+ */
+export function resolveFailureTriggerConfig(workflow, owner, runtimeTrigger) {
+  const type = String(runtimeTrigger.type).toLowerCase();
+  if (type !== "cron" && type !== "http") return null;
+
+  for (const raw of workflow?.triggers ?? []) {
+    const spec = findTriggerSpec(raw, owner, runtimeTrigger);
+    if (!spec) continue;
+
+    const threshold = Number(spec.onConsecutiveFailures);
+    const workflowName =
+      typeof spec.triggerWorkflow === "string" ? spec.triggerWorkflow.trim() : "";
+    if (!Number.isFinite(threshold) || threshold < 1 || workflowName.length === 0) {
+      return null;
+    }
+    return {
+      threshold: Math.floor(threshold),
+      workflowName,
+    };
+  }
+  return null;
+}
+
+/**
+ * @param {unknown} workflow
+ */
+export async function validateWorkflowFailureTriggers(workflow) {
+  if (!workflow || typeof workflow !== "object") return;
+
+  for (const raw of workflow.triggers ?? []) {
+    if (raw == null || typeof raw !== "object" || Array.isArray(raw)) continue;
+    const trigger = /** @type {Record<string, unknown>} */ (raw);
+    const type = String(trigger.type ?? "").toLowerCase();
+    if (type !== "cron" && type !== "http") continue;
+
+    const hasThreshold =
+      trigger.onConsecutiveFailures != null && trigger.onConsecutiveFailures !== "";
+    const hasWorkflow =
+      typeof trigger.triggerWorkflow === "string" && trigger.triggerWorkflow.trim().length > 0;
+
+    if (!hasThreshold && !hasWorkflow) continue;
+
+    if (!hasThreshold || !hasWorkflow) {
+      const err = new Error(
+        "onConsecutiveFailures and triggerWorkflow must both be set on a trigger",
+      );
+      err.statusCode = 400;
+      throw err;
+    }
+
+    const threshold = Number(trigger.onConsecutiveFailures);
+    if (!Number.isFinite(threshold) || threshold < 1) {
+      const err = new Error("onConsecutiveFailures must be a positive number");
+      err.statusCode = 400;
+      throw err;
+    }
+  }
+}
+
+/**
+ * @param {{
+ *   sourceKey: string,
+ *   sourceName?: string | null,
+ *   owner: string,
+ *   trigger: { type: string, detail?: string | null },
+ *   consecutiveFailures: number,
+ *   runId: string,
+ *   error: string,
+ * }} opts
+ */
+export function buildFailureAlertData(opts) {
+  return {
+    kind: "workflow-failure-alert",
+    sourceWorkflow: opts.sourceKey,
+    sourceWorkflowName: opts.sourceName ?? null,
+    owner: opts.owner,
+    triggerType: opts.trigger.type,
+    triggerDetail: opts.trigger.detail ?? null,
+    consecutiveFailures: opts.consecutiveFailures,
+    runId: opts.runId,
+    error: opts.error,
+  };
+}