nsrb
c668947c90
- Updated all instances of `triggerWorkflow` to `onFailureWorkflow` across the codebase to improve clarity and consistency in naming. - Adjusted related logic in workflow configurations and UI components to reflect the new naming convention. - Enhanced error messages and documentation to align with the updated terminology. This change aims to provide a clearer understanding of the workflow's failure handling mechanism.
128 lines
3.8 KiB
JavaScript
128 lines
3.8 KiB
JavaScript
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 = onFailureWorkflowName(spec);
|
|
if (!Number.isFinite(threshold) || threshold < 1 || workflowName.length === 0) {
|
|
return null;
|
|
}
|
|
return {
|
|
threshold: Math.floor(threshold),
|
|
workflowName,
|
|
};
|
|
}
|
|
return null;
|
|
}
|
|
|
|
/**
|
|
* @param {Record<string, unknown>} trigger
|
|
*/
|
|
function onFailureWorkflowName(trigger) {
|
|
const value = trigger?.onFailureWorkflow;
|
|
return typeof value === "string" ? value.trim() : "";
|
|
}
|
|
|
|
/**
|
|
* @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 = onFailureWorkflowName(trigger).length > 0;
|
|
|
|
if (!hasThreshold && !hasWorkflow) continue;
|
|
|
|
if (!hasThreshold || !hasWorkflow) {
|
|
const err = new Error(
|
|
"onConsecutiveFailures and onFailureWorkflow 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,
|
|
};
|
|
}
|