fix(workflows): close review gaps — pull round-trip, dup-names, reclaim budget
Adversarial review of the v1.2 Workflows track surfaced two HIGH footguns and several correctness/hardening gaps. Fixes: HIGH - pull round-trip: `pic pull` dropped `[[workflows]]`, so a later `apply --prune` silently deleted them. The list endpoint now returns the full `definition`; pull rebuilds the manifest block (inverse of workflow_to_wire). - case-colliding names: two workflows differing only by case collided in the reconcile diff (keyed by lower(name)), silently dropping one. Rejected up front in validate_bundle_for. MEDIUM - reclaim retry budget: a crashed attempt (no outcome) consumed the retry budget. reclaim_stale_steps now decrements `attempt` (floored) and clears `next_attempt_at`, so a crash no longer counts as a failed try. - on_error/backoff: typed the manifest fields against the shared enums so a bad value fails at TOML parse with a clear message, not an opaque 500. - dedupe depends_on: a repeated dependency inflated the Kahn in-degree past the single decrement, reporting a spurious cycle for a valid DAG. Count distinct. - canceled child: a canceled sub-workflow resolved the parent step with a message naming the cause instead of a generic "failed"; documented that a run-level cancel op is not yet supported. LOW - list_run_steps is now app-scoped at the query (JOIN workflow_runs) rather than relying on caller pre-verification. - partial failure is surfaced: a run that succeeds with on_error=continue failures records them in the run's `error` field. - admin-started runs log the root_execution_id against the principal. - documented the deliberate when(missing→false) vs template(missing→fail) asymmetry; corrected the claim's atomicity comment. Tests: unit (dedupe-deps), DB-gated reclaim-budget assertion, and two new CLI journeys (duplicate-name rejection, pull→plan clean round-trip). fmt + clippy -D warnings clean; 450 lib + 14 orchestrator DB + 5 workflow journeys pass; schema snapshot unchanged (no migration). Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This commit is contained in:
@@ -433,10 +433,27 @@ pub fn compute_advance(
|
||||
}
|
||||
}
|
||||
}
|
||||
// A run reaches here as Succeeded even if some steps failed under
|
||||
// `on_error = continue` (a hard `fail` short-circuits above). Those
|
||||
// steps contribute no output, so surface them in the run's `error`
|
||||
// field — otherwise a partial failure is invisible at the run level.
|
||||
let failed: Vec<&str> = def
|
||||
.steps
|
||||
.iter()
|
||||
.filter(|s| status_of(&s.name) == StepStatus::Failed)
|
||||
.map(|s| s.name.as_str())
|
||||
.collect();
|
||||
let run_error = (!failed.is_empty()).then(|| {
|
||||
format!(
|
||||
"run succeeded with {} continued failure(s): {}",
|
||||
failed.len(),
|
||||
failed.join(", ")
|
||||
)
|
||||
});
|
||||
return AdvancePlan {
|
||||
promote,
|
||||
run_status: RunStatus::Succeeded,
|
||||
run_error: None,
|
||||
run_error,
|
||||
run_output: Some(serde_json::Value::Object(out)),
|
||||
};
|
||||
}
|
||||
@@ -533,8 +550,12 @@ struct ClaimedRow {
|
||||
/// Atomically claim one `ready`, due step across all active runs — the queue
|
||||
/// competing-consumer lease (`FOR UPDATE SKIP LOCKED`), so parallel workers
|
||||
/// (and, cluster mode later, parallel nodes) never grab the same step. The
|
||||
/// claimed step flips to `running` with a fresh `claim_token`; its run flips
|
||||
/// `pending → running`. Returns `None` when nothing is claimable.
|
||||
/// claimed step flips to `running` with a fresh `claim_token` in one atomic
|
||||
/// statement. A *separate*, non-transactional follow-up statement then reflects
|
||||
/// the run as `pending → running` — this is a promptness convenience, not part
|
||||
/// of the claim's atomicity: a crash in between is harmless (the token-gated
|
||||
/// advance, and `reclaim`, both re-derive run status). Returns `None` when
|
||||
/// nothing is claimable.
|
||||
pub async fn claim_ready_step(pool: &PgPool) -> Result<Option<ClaimedStep>, WorkflowRepoError> {
|
||||
let token = Uuid::new_v4();
|
||||
let row: Option<ClaimedRow> = sqlx::query_as(
|
||||
@@ -762,10 +783,12 @@ pub async fn advance_run_tx(
|
||||
RunStatus::Succeeded => {
|
||||
sqlx::query(
|
||||
"UPDATE workflow_runs \
|
||||
SET status = 'succeeded', output = $2, finished_at = NOW() WHERE id = $1",
|
||||
SET status = 'succeeded', output = $2, error = $3, finished_at = NOW() \
|
||||
WHERE id = $1",
|
||||
)
|
||||
.bind(run_id.into_inner())
|
||||
.bind(plan.run_output)
|
||||
.bind(plan.run_error)
|
||||
.execute(&mut **tx)
|
||||
.await?;
|
||||
}
|
||||
@@ -796,6 +819,13 @@ pub async fn advance_run_tx(
|
||||
/// Periodic safety net: a step leased by a crashed worker (still `running`
|
||||
/// with a `claim_token` past the visibility timeout) is re-armed `ready` so
|
||||
/// another worker retries it. Only touches steps of still-active runs.
|
||||
///
|
||||
/// The crashed attempt produced no outcome, so it must NOT consume the retry
|
||||
/// budget: `claim_ready_step` incremented `attempt` up front, so reclaim
|
||||
/// *decrements* it (floored at 0) — the re-claim will re-increment, leaving the
|
||||
/// effective attempt count unchanged. `next_attempt_at` is cleared so the
|
||||
/// reclaimed step is immediately eligible.
|
||||
///
|
||||
/// Returns the number of steps reclaimed.
|
||||
pub async fn reclaim_stale_steps(
|
||||
pool: &PgPool,
|
||||
@@ -803,7 +833,8 @@ pub async fn reclaim_stale_steps(
|
||||
) -> Result<u64, WorkflowRepoError> {
|
||||
let res = sqlx::query(
|
||||
"UPDATE workflow_run_steps s \
|
||||
SET status = 'ready', claim_token = NULL, claimed_at = NULL, updated_at = NOW() \
|
||||
SET status = 'ready', claim_token = NULL, claimed_at = NULL, \
|
||||
attempt = GREATEST(s.attempt - 1, 0), next_attempt_at = NULL, updated_at = NOW() \
|
||||
FROM workflow_runs r \
|
||||
WHERE s.run_id = r.id \
|
||||
AND s.claim_token IS NOT NULL \
|
||||
@@ -934,16 +965,23 @@ impl TryFrom<StepRow> for WorkflowRunStep {
|
||||
}
|
||||
|
||||
/// All steps of a run, ordered by name (for the admin/CLI surface + tests).
|
||||
/// App-scoped at the query (JOIN `workflow_runs`) so isolation is enforced here
|
||||
/// rather than relying on the caller having pre-verified run ownership — a
|
||||
/// run under another app returns no rows.
|
||||
pub async fn list_run_steps(
|
||||
pool: &PgPool,
|
||||
app_id: AppId,
|
||||
run_id: WorkflowRunId,
|
||||
) -> Result<Vec<WorkflowRunStep>, WorkflowRepoError> {
|
||||
let rows: Vec<StepRow> = sqlx::query_as(
|
||||
"SELECT id, run_id, step_name, status, attempt, max_attempts, output, error, \
|
||||
child_run_id \
|
||||
FROM workflow_run_steps WHERE run_id = $1 ORDER BY step_name",
|
||||
"SELECT s.id, s.run_id, s.step_name, s.status, s.attempt, s.max_attempts, s.output, \
|
||||
s.error, s.child_run_id \
|
||||
FROM workflow_run_steps s \
|
||||
JOIN workflow_runs r ON r.id = s.run_id \
|
||||
WHERE s.run_id = $1 AND r.app_id = $2 ORDER BY s.step_name",
|
||||
)
|
||||
.bind(run_id.into_inner())
|
||||
.bind(app_id.into_inner())
|
||||
.fetch_all(pool)
|
||||
.await?;
|
||||
rows.into_iter().map(TryInto::try_into).collect()
|
||||
@@ -1105,10 +1143,19 @@ pub async fn resume_finished_children(pool: &PgPool) -> Result<u64, WorkflowRepo
|
||||
let mut resolved = 0u64;
|
||||
for r in rows {
|
||||
let mut tx = pool.begin().await?;
|
||||
let (new_status, out, err) = if r.child_status == "succeeded" {
|
||||
("succeeded", r.child_output.clone(), None)
|
||||
} else {
|
||||
(
|
||||
// A child terminates as succeeded / failed / canceled. There is no
|
||||
// distinct `canceled` step status (nor a run-cancel operation yet — the
|
||||
// `canceled` run status is reserved for a future admin cancel), so a
|
||||
// canceled child resolves the parent step to `failed` with a message
|
||||
// that names the cause rather than masquerading as a generic failure.
|
||||
let (new_status, out, err) = match r.child_status.as_str() {
|
||||
"succeeded" => ("succeeded", r.child_output.clone(), None),
|
||||
"canceled" => (
|
||||
"failed",
|
||||
None,
|
||||
Some("sub-workflow was canceled".to_string()),
|
||||
),
|
||||
_ => (
|
||||
"failed",
|
||||
None,
|
||||
Some(
|
||||
@@ -1116,7 +1163,7 @@ pub async fn resume_finished_children(pool: &PgPool) -> Result<u64, WorkflowRepo
|
||||
.clone()
|
||||
.unwrap_or_else(|| "sub-workflow failed".to_string()),
|
||||
),
|
||||
)
|
||||
),
|
||||
};
|
||||
let res = sqlx::query(
|
||||
"UPDATE workflow_run_steps \
|
||||
|
||||
Reference in New Issue
Block a user