Skip to main content
← Back to list
01Issue
BugOpenSwamp CLIPublic
AssigneesNone

Relationships

#2115 Improve workflow authoring validation and recovery guidance

Opened by stack72 · 9/11/2026

Summary

Workflow authoring and early execution expose several recoverable conditions as low-context errors. This causes users to retry commands at the wrong lifecycle point and obscures the next safe action.

A user hit dependsOn entries must be objects, not strings twice while authoring a workflow, then encountered vault setup, workflow suspension, data-read readiness, external-call timeout, and repository-path errors while building and running a workflow. Subsequent workflow runs succeeded, so this is activation friction rather than a fundamental execution blocker.

Observed behavior

  • Workflow authoring rejects string entries in dependsOn with dependsOn entries must be objects, not strings.
  • workflow approve and workflow resume report no suspended run when the workflow is running or already complete.
  • data get plan triage reports the artifact is missing when the producing workflow has not completed.
  • vault put fails before the required vault exists and fails again when a secret already exists.
  • A long-running external Redmine call ends as workflow run terminated before completion, without enough timeout/cancellation context.
  • Running a model command outside a Swamp repository includes the absolute working directory in the error.

Expected behavior

  • Workflow authoring should guide users to the supported object form for dependsOn, preferably by normalizing an unambiguous string shorthand or by returning a schema error with a valid YAML example and the affected step.
  • Workflow lifecycle commands should expose the actual run state and a next action: wait/poll while running, inspect results when complete, or resume/approve only when a matching suspended run exists.
  • Reading data produced by an active workflow should identify the producer/run status and suggest waiting or inspecting workflow history rather than treating it as an unexplained missing artifact.
  • Vault setup errors should provide the exact create command; duplicate secret writes should describe the safe update/overwrite path if supported.
  • Timeout/cancellation errors should name the timed-out step/method, elapsed or configured timeout, and the recovery action.
  • Repository-not-found messages must redact or avoid displaying personal absolute paths by default.

Acceptance criteria

  • dependsOn validation names the invalid step and includes the supported object shape, with a unit test for a string entry.
  • Approve/resume errors report the latest relevant run state and actionable next command for running, completed, and absent workflows.
  • Data-read failures can distinguish a missing artifact from output that is pending an active producer run.
  • Vault-not-found and duplicate-secret errors provide idempotent setup/update guidance.
  • Workflow termination reports timeout/cancellation provenance at the failed step.
  • Non-repository errors do not disclose a user home directory or other sensitive absolute-path components.
  • Add focused coverage for each changed error contract, including structured JSON output.

Scope note

The underlying workflow runs recovered on retry. Prioritize clearer validation and state-aware recovery guidance over changing workflow execution semantics.

02Bog Flow
OPENTRIAGEDIN PROGRESSSHIPPED

Open

9/11/2026, 9:53:14 PM

No activity in this phase yet.

03Sludge Pulse

Sign in to post a ripple.