Please check the build logs for more information.
See Builds for ideas on how to fix a failed build, or Metadata for how to configure docs.rs builds.
If you believe this is docs.rs' fault, open an issue.
taquba-workflow
Durable, at-least-once workflow runtime on top of the Taquba durable task queue.
taquba-workflow is the plumbing for any multi-step process that
benefits from durable state between steps: idempotent step execution,
retries with backoff, graceful restart, and terminal-state notifications.
Implement StepRunner with bytes-in / bytes-out per-step logic; the
runtime persists everything else.
Particularly well-suited for AI agent runs (see
examples/rig_agent.rs for a
Rig integration), but the runtime
itself is framework-neutral and equally usable for ETL pipelines, document
processing, payment flows, etc.
What this is / isn't
taquba-workflow is an imperative step orchestrator: at each step
the runner decides what happens next via StepOutcome (Continue,
Succeed, Fail, Cancel). External cancellation is supported via
WorkflowRuntime::cancel. It is not:
- A DAG executor. There's no declarative graph, no fan-out / fan-in, no dependency-driven scheduling.
- An event-sourced workflow engine. There's no event-history replay, no per-side-effect recording.
Install
Enable the webhooks feature for WebhookTerminalHook:
Quick start
use Arc;
use ;
use ;
;
async
Examples
ANTHROPIC_API_KEY=...
OPENAI_API_KEY=...
rig_agent is a two-stage AI agent (research, then write) that
demonstrates between-step durability: kill the process after step 0 and
a fresh process resumes at step 1.
Step outcomes
| Outcome | Effect |
|---|---|
StepOutcome::Continue { payload } |
Enqueue the next step immediately. |
StepOutcome::ContinueAfter { payload, delay } |
Schedule the next step delay from now. |
StepOutcome::Succeed { result } |
Ack; terminal hook fires Succeeded. |
StepOutcome::Fail { reason } |
Ack; terminal hook fires Failed. Runner verdict: no dead-letter. |
StepOutcome::Cancel { reason } |
Ack; terminal hook fires Cancelled. Runner verdict: no dead-letter. |
Err(StepError::transient(_)) |
Retry per backoff up to max_attempts, then dead-letter. |
Err(StepError::permanent(_)) |
Dead-letter immediately. |
StepOutcome::Fail / StepOutcome::Cancel vs Err(StepError::permanent):
runner verdicts ack normally; an infrastructure error dead-letters so
operators can find it via queue.dead_jobs().
Cancellation
Call WorkflowRuntime::cancel(run_id) to cancel an active run from
outside the runner:
-
If the current step is pending or scheduled, the queued step job is removed and the terminal hook fires from the
cancelcall before it returns. -
If the current step is running, cancellation is delivered via
Step::cancel_token(atokio_util::sync::CancellationToken). Runners that watch the token can short-circuit immediately:select!Runners that ignore the token are allowed to run to completion (futures cannot be safely aborted mid-step). In both cases the runner's
StepOutcomeis discarded, any pending transient retry is suppressed, and the worker fires the terminal hook withCancelledonce the step returns. Watching the token only reduces cancellation latency for slow steps; it doesn't change semantics.
While termination is in flight, WorkflowRuntime::status reports a
RunState::Cancelling overlay until the entry is dropped.
Returns Ok(false) if the run is unknown or already terminal in this
runtime. cancel only reaches runs submitted to this WorkflowRuntime
instance; a second runtime in the same process (sharing the queue)
maintains its own registry.
Reserved headers
Step jobs reserve the workflow.* prefix; submission rejects user
headers starting with it. Other headers on RunSpec::headers thread
through every step and reach the terminal hook on RunOutcome::headers.
| Key | Meaning |
|---|---|
workflow.run_id |
Run identifier. |
workflow.step |
Zero-based step number. |
Idempotency
Each step is enqueued with dedup_key = "run:{run_id}:{step_number}",
preventing concurrent duplicate steps. But Taquba is at-least-once: a
step can be claimed and executed twice if its lease expires before ack.
StepRunner impls must be idempotent for the same
(run_id, step_number).
Duplicate submissions
WorkflowRuntime::submit rejects re-submissions of an active run_id
from two sources, in order:
- An in-process registry catches duplicates within the same runtime.
- A durable per-run record written atomically with the step-0
enqueue (via Taquba's
enqueue_with_kv) catches duplicates across process restarts, even after step 0 has been claimed and its dedup key released. The record is cleaned up when the run reaches a terminal state.
Both paths surface as Error::DuplicateRun.
Terminal hook
TerminalHook::on_termination fires once per run on Succeeded,
Failed, or Cancelled, receiving the submitter's headers and the
runner's result or error. WebhookTerminalHook (behind the webhooks
feature) fires HTTP callbacks via taquba-webhooks; set the per-run URL
on RunSpec::headers["callback_url"].
License
Apache-2.0