adispatchd 0.0.0-stage → 0.1.0

package/dist/api/serialize.js

@@ -0,0 +1,135 @@
+/**
+ * API response shapes (documented in docs/api.md). Responses never contain
+ * secrets: run snapshots hold identity IDs only, worker context/result files
+ * are redacted by the executor, error details pass `redactValue`.
+ */
+import { ACTIVE_STATUSES, isTerminalStatus } from '../core/index.js';
+const ACTIVE = new Set(ACTIVE_STATUSES);
+function snap(run) {
+    return (run.configSnapshot ?? {});
+}
+function str(v) {
+    return typeof v === 'string' ? v : null;
+}
+/** Outcome classification (see {@link RunOutcome}). */
+export function runOutcome(run) {
+    if (!isTerminalStatus(run.status))
+        return 'active';
+    if (run.status === 'completed')
+        return run.businessResult === 'failure' ? 'failure' : 'success';
+    if (run.status === 'cancelled')
+        return 'cancelled';
+    return 'technical_error';
+}
+/** Summary of a run. */
+export function toRunSummary(run) {
+    const s = snap(run);
+    const result = run.result;
+    const start = run.startedAt ?? null;
+    const end = run.finishedAt ?? null;
+    return {
+        id: run.id,
+        workflowId: run.workflowId,
+        workflowName: str(s.workflow?.name),
+        triggerType: run.triggerType,
+        sourceId: run.sourceId,
+        sourceItemKey: run.sourceItemKey,
+        sourceUrl: run.sourceUrl,
+        scheduledFor: run.scheduledFor,
+        identity: run.identity ?? str(s.workflow?.identity) ?? str(s.source?.identity),
+        status: run.status,
+        active: ACTIVE.has(run.status),
+        outcome: runOutcome(run),
+        finalStatus: run.finalStatus,
+        businessResult: run.businessResult,
+        finalReason: run.finalReason,
+        resultMessage: result && typeof result === 'object' ? str(result.message) : null,
+        statusMessage: run.statusMessage,
+        exitCode: run.exitCode,
+        lifecycleStatus: run.lifecycleStatus,
+        lifecycleFailed: run.lifecycleStatus === 'failed',
+        createdAt: run.createdAt,
+        startedAt: start,
+        finishedAt: end,
+        durationMs: start && end ? Math.max(0, Date.parse(end) - Date.parse(start)) : null,
+    };
+}
+/** Extra fields of the run detail. */
+export function runDetailFields(run) {
+    const s = snap(run);
+    const configured = s.workflow?.execute;
+    return {
+        lockKey: run.lockKey,
+        parameters: run.parameters,
+        command: run.command ??
+            (configured ? { command: configured.command ?? null, args: configured.args ?? [], configured: true } : null),
+        workingDirectory: run.workspacePath ?? str(configured?.workingDirectory),
+        workspacePath: run.workspacePath,
+        pid: run.pid,
+        result: run.result ?? null,
+        error: run.error ?? null,
+        blockGeneration: run.blockGeneration,
+        countedTechnicalFailure: run.countedTechnicalFailure,
+        finalizingAt: run.finalizingAt,
+        updatedAt: run.updatedAt,
+        configVersion: typeof s.configVersion === 'number' ? s.configVersion : null,
+        configHash: str(s.configHash),
+    };
+}
+/** Parameter definition in API form. */
+function parameterView(def) {
+    return {
+        type: def.type,
+        required: def.required,
+        default: def.default,
+        description: def.description,
+        ...(def.type === 'enum' ? { values: def.values } : {}),
+    };
+}
+/** Workflow in lists / detail. */
+export function toWorkflowView(wf, extra) {
+    const c = wf.config;
+    return {
+        id: c.id,
+        name: c.name,
+        file: c.file,
+        enabled: wf.enabled,
+        priority: wf.priority,
+        maxConcurrent: wf.maxConcurrent,
+        configured: { enabled: c.enabled, priority: c.priority, maxConcurrent: c.maxConcurrent },
+        overrides: wf.overrides,
+        trigger: c.trigger,
+        identity: c.identity,
+        activeRuns: extra.activeRuns,
+        activeBlocks: extra.activeBlocks,
+        parameters: Object.fromEntries(Object.entries(c.parameters).map(([k, v]) => [k, parameterView(v)])),
+        execute: {
+            type: c.execute.type,
+            command: c.execute.command,
+            args: c.execute.args,
+            workingDirectory: c.execute.workingDirectory,
+            timeout: c.execute.timeout,
+            secrets: Object.keys(c.execute.secrets),
+        },
+        hasFilter: c.filter !== null,
+        hasShellFilter: c.shellFilter !== null,
+        conditions: { workflow: c.conditions.workflow.length, item: c.conditions.item.length },
+        maxTechnicalFailures: c.retry.maxTechnicalFailures,
+        cron: extra.cron,
+        lastPlanning: extra.diagnosis
+            ? {
+                at: extra.diagnosis.at,
+                status: extra.diagnosis.status,
+                error: extra.diagnosis.error,
+                polled: extra.diagnosis.polled,
+                candidates: extra.diagnosis.candidates.length,
+                started: extra.diagnosis.candidates.filter((x) => x.decision === 'started').length,
+            }
+            : null,
+    };
+}
+/** Block with UI helpers. */
+export function toBlockView(block, extra) {
+    return { ...block, active: block.clearedAt === null, ...extra };
+}
+//# sourceMappingURL=serialize.js.map

package/dist/api/serialize.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"serialize.js","sourceRoot":"","sources":["../../src/api/serialize.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,EAAE,eAAe,EAAE,gBAAgB,EAAwB,MAAM,kBAAkB,CAAC;AA6C3F,MAAM,MAAM,GAAG,IAAI,GAAG,CAAS,eAAe,CAAC,CAAC;AAShD,SAAS,IAAI,CAAC,GAAc;IAC1B,OAAO,CAAC,GAAG,CAAC,cAAc,IAAI,EAAE,CAAiB,CAAC;AACpD,CAAC;AAED,SAAS,GAAG,CAAC,CAAU;IACrB,OAAO,OAAO,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;AAC1C,CAAC;AAED,uDAAuD;AACvD,MAAM,UAAU,UAAU,CAAC,GAAiD;IAC1E,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,MAAM,CAAC;QAAE,OAAO,QAAQ,CAAC;IACnD,IAAI,GAAG,CAAC,MAAM,KAAK,WAAW;QAAE,OAAO,GAAG,CAAC,cAAc,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC;IAChG,IAAI,GAAG,CAAC,MAAM,KAAK,WAAW;QAAE,OAAO,WAAW,CAAC;IACnD,OAAO,iBAAiB,CAAC;AAC3B,CAAC;AAED,wBAAwB;AACxB,MAAM,UAAU,YAAY,CAAC,GAAc;IACzC,MAAM,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC;IACpB,MAAM,MAAM,GAAG,GAAG,CAAC,MAAsC,CAAC;IAC1D,MAAM,KAAK,GAAG,GAAG,CAAC,SAAS,IAAI,IAAI,CAAC;IACpC,MAAM,GAAG,GAAG,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC;IACnC,OAAO;QACL,EAAE,EAAE,GAAG,CAAC,EAAE;QACV,UAAU,EAAE,GAAG,CAAC,UAAU;QAC1B,YAAY,EAAE,GAAG,CAAC,CAAC,CAAC,QAAQ,EAAE,IAAI,CAAC;QACnC,WAAW,EAAE,GAAG,CAAC,WAAW;QAC5B,QAAQ,EAAE,GAAG,CAAC,QAAQ;QACtB,aAAa,EAAE,GAAG,CAAC,aAAa;QAChC,SAAS,EAAE,GAAG,CAAC,SAAS;QACxB,YAAY,EAAE,GAAG,CAAC,YAAY;QAC9B,QAAQ,EAAE,GAAG,CAAC,QAAQ,IAAI,GAAG,CAAC,CAAC,CAAC,QAAQ,EAAE,QAAQ,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,MAAM,EAAE,QAAQ,CAAC;QAC9E,MAAM,EAAE,GAAG,CAAC,MAAM;QAClB,MAAM,EAAE,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC;QAC9B,OAAO,EAAE,UAAU,CAAC,GAAG,CAAC;QACxB,WAAW,EAAE,GAAG,CAAC,WAAW;QAC5B,cAAc,EAAE,GAAG,CAAC,cAAc;QAClC,WAAW,EAAE,GAAG,CAAC,WAAW;QAC5B,aAAa,EAAE,MAAM,IAAI,OAAO,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI;QAChF,aAAa,EAAE,GAAG,CAAC,aAAa;QAChC,QAAQ,EAAE,GAAG,CAAC,QAAQ;QACtB,eAAe,EAAE,GAAG,CAAC,eAAe;QACpC,eAAe,EAAE,GAAG,CAAC,eAAe,KAAK,QAAQ;QACjD,SAAS,EAAE,GAAG,CAAC,SAAS;QACxB,SAAS,EAAE,KAAK;QAChB,UAAU,EAAE,GAAG;QACf,UAAU,EAAE,KAAK,IAAI,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI;KACnF,CAAC;AACJ,CAAC;AAED,sCAAsC;AACtC,MAAM,UAAU,eAAe,CAAC,GAAc;IAC5C,MAAM,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC;IACpB,MAAM,UAAU,GAAG,CAAC,CAAC,QAAQ,EAAE,OAAO,CAAC;IACvC,OAAO;QACL,OAAO,EAAE,GAAG,CAAC,OAAO;QACpB,UAAU,EAAE,GAAG,CAAC,UAAU;QAC1B,OAAO,EACL,GAAG,CAAC,OAAO;YACX,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,UAAU,CAAC,OAAO,IAAI,IAAI,EAAE,IAAI,EAAE,UAAU,CAAC,IAAI,IAAI,EAAE,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;QAC9G,gBAAgB,EAAE,GAAG,CAAC,aAAa,IAAI,GAAG,CAAC,UAAU,EAAE,gBAAgB,CAAC;QACxE,aAAa,EAAE,GAAG,CAAC,aAAa;QAChC,GAAG,EAAE,GAAG,CAAC,GAAG;QACZ,MAAM,EAAE,GAAG,CAAC,MAAM,IAAI,IAAI;QAC1B,KAAK,EAAE,GAAG,CAAC,KAAK,IAAI,IAAI;QACxB,eAAe,EAAE,GAAG,CAAC,eAAe;QACpC,uBAAuB,EAAE,GAAG,CAAC,uBAAuB;QACpD,YAAY,EAAE,GAAG,CAAC,YAAY;QAC9B,SAAS,EAAE,GAAG,CAAC,SAAS;QACxB,aAAa,EAAE,OAAO,CAAC,CAAC,aAAa,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI;QAC3E,UAAU,EAAE,GAAG,CAAC,CAAC,CAAC,UAAU,CAAC;KAC9B,CAAC;AACJ,CAAC;AAED,wCAAwC;AACxC,SAAS,aAAa,CAAC,GAAwB;IAC7C,OAAO;QACL,IAAI,EAAE,GAAG,CAAC,IAAI;QACd,QAAQ,EAAE,GAAG,CAAC,QAAQ;QACtB,OAAO,EAAE,GAAG,CAAC,OAAO;QACpB,WAAW,EAAE,GAAG,CAAC,WAAW;QAC5B,GAAG,CAAC,GAAG,CAAC,IAAI,KAAK,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KACvD,CAAC;AACJ,CAAC;AAED,kCAAkC;AAClC,MAAM,UAAU,cAAc,CAC5B,EAAqB,EACrB,KAAsI;IAEtI,MAAM,CAAC,GAAmB,EAAE,CAAC,MAAM,CAAC;IACpC,OAAO;QACL,EAAE,EAAE,CAAC,CAAC,EAAE;QACR,IAAI,EAAE,CAAC,CAAC,IAAI;QACZ,IAAI,EAAE,CAAC,CAAC,IAAI;QACZ,OAAO,EAAE,EAAE,CAAC,OAAO;QACnB,QAAQ,EAAE,EAAE,CAAC,QAAQ;QACrB,aAAa,EAAE,EAAE,CAAC,aAAa;QAC/B,UAAU,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE,QAAQ,EAAE,CAAC,CAAC,QAAQ,EAAE,aAAa,EAAE,CAAC,CAAC,aAAa,EAAE;QACxF,SAAS,EAAE,EAAE,CAAC,SAAS;QACvB,OAAO,EAAE,CAAC,CAAC,OAAO;QAClB,QAAQ,EAAE,CAAC,CAAC,QAAQ;QACpB,UAAU,EAAE,KAAK,CAAC,UAAU;QAC5B,YAAY,EAAE,KAAK,CAAC,YAAY;QAChC,UAAU,EAAE,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACnG,OAAO,EAAE;YACP,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,IAAI;YACpB,OAAO,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO;YAC1B,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,IAAI;YACpB,gBAAgB,EAAE,CAAC,CAAC,OAAO,CAAC,gBAAgB;YAC5C,OAAO,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO;YAC1B,OAAO,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC;SACxC;QACD,SAAS,EAAE,CAAC,CAAC,MAAM,KAAK,IAAI;QAC5B,cAAc,EAAE,CAAC,CAAC,WAAW,KAAK,IAAI;QACtC,UAAU,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC,UAAU,CAAC,QAAQ,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,EAAE;QACtF,oBAAoB,EAAE,CAAC,CAAC,KAAK,CAAC,oBAAoB;QAClD,IAAI,EAAE,KAAK,CAAC,IAAI;QAChB,YAAY,EAAE,KAAK,CAAC,SAAS;YAC3B,CAAC,CAAC;gBACE,EAAE,EAAE,KAAK,CAAC,SAAS,CAAC,EAAE;gBACtB,MAAM,EAAE,KAAK,CAAC,SAAS,CAAC,MAAM;gBAC9B,KAAK,EAAE,KAAK,CAAC,SAAS,CAAC,KAAK;gBAC5B,MAAM,EAAE,KAAK,CAAC,SAAS,CAAC,MAAM;gBAC9B,UAAU,EAAE,KAAK,CAAC,SAAS,CAAC,UAAU,CAAC,MAAM;gBAC7C,OAAO,EAAE,KAAK,CAAC,SAAS,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,MAAM;aACnF;YACH,CAAC,CAAC,IAAI;KACT,CAAC;AACJ,CAAC;AAED,6BAA6B;AAC7B,MAAM,UAAU,WAAW,CAAC,KAAkB,EAAE,KAA0F;IACxI,OAAO,EAAE,GAAG,KAAK,EAAE,MAAM,EAAE,KAAK,CAAC,SAAS,KAAK,IAAI,EAAE,GAAG,KAAK,EAAE,CAAC;AAClE,CAAC"}

package/dist/api/server.d.ts

@@ -0,0 +1,89 @@
+import { type FastifyInstance } from 'fastify';
+import { type Clock, type Logger, type Redactor } from '../core/index.js';
+import { type ConfigManager, type ReloadResult } from '../config/index.js';
+import type { LifecycleEngine } from '../lifecycle/index.js';
+import type { NotificationService } from '../notifications/index.js';
+import type { Repositories } from '../persistence/index.js';
+import type { RetentionService, RunController } from '../runs/index.js';
+import type { Scheduler } from '../scheduler/index.js';
+import type { ViewService } from '../views/index.js';
+import type { EventHub } from './sse.js';
+/** Header that every mutating request must carry (CSRF protection). */
+export declare const CSRF_HEADER = "x-adispatch-request";
+/** Readiness of the instance (`/ready`). */
+export interface ReadinessReport {
+    ready: boolean;
+    /**
+     * There is no separate config check: an instance only runs with a fully
+     * validated configuration (invalid YAML prevents the start, a failed reload
+     * keeps the active configuration).
+     */
+    checks: {
+        database: boolean;
+        recovery: boolean;
+        scheduler: boolean;
+        shuttingDown: boolean;
+    };
+}
+/** Everything the API needs from the application. */
+export interface ApiDeps {
+    config: ConfigManager;
+    repositories: Repositories;
+    controller: RunController;
+    scheduler: Scheduler;
+    lifecycle: LifecycleEngine;
+    views: ViewService;
+    notifications: NotificationService;
+    retention?: RetentionService;
+    events: EventHub;
+    dataDir: string;
+    clock?: Clock;
+    logger?: Logger;
+    /** Redaction of error texts (shared `SecretRedactor`). */
+    redact?: Redactor;
+    readiness(): ReadinessReport;
+    /** Start a shutdown (drain or cancel-all) in the background; repeated calls escalate. */
+    shutdown(mode: 'drain' | 'cancel', reason?: string): void;
+    /** Reload the configuration (app also rebuilds adapters, invalidates caches, plans). */
+    reloadConfig(): Promise<ReloadResult>;
+    /** Track a background operation started by a request (awaited/aborted on shutdown). */
+    background(what: string, start: (signal: AbortSignal) => Promise<unknown>): Promise<unknown>;
+    /** Static info for `/status`. */
+    info: {
+        version: string;
+        startedAt: string;
+        host: string;
+        port: () => number | null;
+    };
+    /** Additional allowed `Origin`s for mutating requests (besides the request's own host). */
+    allowedOrigins?: readonly string[];
+    /** Directory with static web UI assets (WI-11), served at `/` if present. */
+    uiDir?: string;
+}
+/**
+ * True if the `Host` (or an `Origin`'s host) matches an allowed entry: `name`
+ * matches any port, `name:port` only that port. A value without port (the
+ * client used the scheme's default port, e.g. behind an HTTPS reverse proxy)
+ * matches entries without port and entries with `:80` or `:443`.
+ */
+export declare function isAllowedHost(value: string, allowed: readonly string[]): boolean;
+/**
+ * True if `origin` (an http(s) origin) names exactly `host` (the request's
+ * `Host` header). A `Host` without port matches the origin scheme's default
+ * port (80/443), e.g. behind a TLS-terminating reverse proxy.
+ */
+export declare function originMatchesHost(origin: string, host: string): boolean;
+/** Create the Fastify instance with all routes (not listening yet). */
+export declare function createApiServer(deps: ApiDeps): Promise<FastifyInstance>;
+/**
+ * Structural redaction of a YAML file for read-only display: values of
+ * `url` keys, everything below `headers`/`headers_env` and every key that
+ * looks secret ({@link isSecretKey}) are replaced, URLs in comments are cut
+ * to their origin. Independent of the loaded configuration (also covers
+ * edited, not yet reloaded files). Unparseable files are never returned raw.
+ */
+export declare function redactYaml(text: string): {
+    content: string;
+} | {
+    error: string;
+};