chore: import upstream snapshot with attribution
govulncheck / govulncheck (push) Has been cancelled
Lint / golangci-lint (push) Has been cancelled
Run Tests / Unit Tests (push) Has been cancelled
Run Tests / Etcd Integration Tests (push) Has been cancelled
Harness (E2E) / Harnesses (mock LLM) (push) Has been cancelled
Harness (E2E) / Provider harnesses (live LLM conformance) (push) Has been cancelled

This commit is contained in:
wehub-resource-sync
2026-07-13 12:40:33 +08:00
commit e071084ebe
982 changed files with 160368 additions and 0 deletions
+72
View File
@@ -0,0 +1,72 @@
# Durable Flow
A workflow that survives a crash and resumes where it stopped.
A `flow` can be an ordered list of **steps** — a task with stages —
instead of a single LLM turn. Each step is checkpointed before and after
through a pluggable `Checkpoint` (store-backed by default), so if the
process dies mid-run, the run resumes at the step it stopped on, without
re-running the steps that already completed (and already had their side
effects).
## What this shows
A three-step checkout (`reserve → charge → confirm`) whose `charge` step
fails the first time, simulating a transient outage / crash:
```
first run:
reserve → inventory reserved
charge → payment dependency unavailable (crash)
run failed: payment gateway timeout
checkpoint: run 70643f61 is at step "charge" (status failed)
resume:
charge → payment captured
confirm → order confirmed
reserve ran 1 time(s) total — completed steps are not repeated on resume
no pending runs — the workflow completed durably
```
The key line is the last pair: on `Resume`, `reserve` does **not** run
again — its result was checkpointed — and the run finishes.
## The pieces
```go
f := micro.NewFlow("checkout",
micro.FlowSteps(
micro.FlowStep{Name: "reserve", Run: reserve},
micro.FlowStep{Name: "charge", Run: charge},
micro.FlowStep{Name: "confirm", Run: confirm},
),
micro.FlowWithCheckpoint(micro.StoreCheckpoint(nil, "checkout")), // nil store = default; "checkout" = key scope
)
f.Execute(ctx, `{}`) // runs; crashes at charge
pending, _ := f.Pending(ctx) // the run, checkpointed at "charge"
f.Resume(ctx, pending[0].ID) // continues from charge to the end
```
- **`State`** carries a typed payload (`Set`/`Scan`) plus a `Stage`
marker — the resume point.
- **`Checkpoint`** persists each `Run`. The built-in is store-backed and
keeps each flow's runs in their own store table (database `flow`, table
`checkout`) via `store.Scope`, so one flow's runs don't share a table
with another's — or with agent or service state. Point the default
store at Postgres or NATS KV and a run survives a real process restart,
or implement the interface to plug in Temporal, Restate, etc.
- A real step would be `flow.Call(service, endpoint)` (an RPC),
`flow.Dispatch(agent)` (hand off to an agent), or `flow.LLM(prompt)`
(one model turn). Here they're plain funcs so durability is the only
thing on display.
## Run
```bash
go run main.go
```
No LLM key required.
+114
View File
@@ -0,0 +1,114 @@
// Durable Flow — a workflow that survives a crash and resumes
//
// A flow can be an ordered list of steps (a task with stages) rather than
// a single LLM turn. Each step is checkpointed before and after through a
// pluggable Checkpoint (store-backed by default), so if the process dies
// mid-run, the run resumes at the step it stopped on — without re-running
// the steps that already completed (and already had their side effects).
//
// This example needs no LLM key. It runs a three-step checkout flow whose
// "charge" step fails the first time (a transient outage). The run is
// checkpointed as failed at that step; we then "recover" the dependency
// and Resume — and the already-completed "reserve" step does not run
// again. A real step would call a service (flow.Call), an agent
// (flow.Dispatch), or the model (flow.LLM); here they're plain funcs so
// the durability is the only thing on display.
package main
import (
"context"
"errors"
"fmt"
"go-micro.dev/v6"
)
// Order is the payload carried across steps via State.Set / State.Scan.
type Order struct {
ID string `json:"id"`
Reserved bool `json:"reserved"`
Charged bool `json:"charged"`
Confirmed bool `json:"confirmed"`
}
// charged toggles the transient failure: 0 = the payment dependency is
// down (first run), 1 = recovered (on resume).
var charged int
// reserveCalls proves the completed step is not re-run on resume.
var reserveCalls int
func reserve(_ context.Context, in micro.FlowState) (micro.FlowState, error) {
reserveCalls++
var o Order
in.Scan(&o)
o.ID = "order-1"
o.Reserved = true
fmt.Println(" reserve → inventory reserved")
return in, in.Set(o)
}
func charge(_ context.Context, in micro.FlowState) (micro.FlowState, error) {
var o Order
in.Scan(&o)
if charged == 0 {
fmt.Println(" charge → payment dependency unavailable (crash)")
return in, errors.New("payment gateway timeout")
}
o.Charged = true
fmt.Println(" charge → payment captured")
return in, in.Set(o)
}
func confirm(_ context.Context, in micro.FlowState) (micro.FlowState, error) {
var o Order
in.Scan(&o)
o.Confirmed = true
fmt.Println(" confirm → order confirmed")
return in, in.Set(o)
}
func main() {
f := micro.NewFlow("checkout",
micro.FlowSteps(
micro.FlowStep{Name: "reserve", Run: reserve},
micro.FlowStep{Name: "charge", Run: charge},
micro.FlowStep{Name: "confirm", Run: confirm},
),
// Durable by default; shown explicitly. Runs are namespaced under
// the flow name ("flow/checkout/runs/..."), so this flow's state
// doesn't share a keyspace with other flows. Point the default
// store at Postgres or NATS KV to survive a real process restart.
micro.FlowWithCheckpoint(micro.StoreCheckpoint(nil, "checkout")),
)
ctx := context.Background()
fmt.Println("first run:")
if err := f.Execute(ctx, `{}`); err != nil {
fmt.Printf(" run failed: %v\n", err)
}
pending, _ := f.Pending(ctx)
if len(pending) == 0 {
fmt.Println("nothing pending — unexpected")
return
}
run := pending[0]
fmt.Printf("\ncheckpoint: run %s is at step %q (status %s)\n",
run.ID[:8], run.State.Stage, run.Status)
// The dependency recovers (or a new process picks the run up).
charged = 1
fmt.Println("\nresume:")
if err := f.Resume(ctx, run.ID); err != nil {
fmt.Printf(" resume failed: %v\n", err)
return
}
fmt.Printf("\nreserve ran %d time(s) total — completed steps are not repeated on resume\n", reserveCalls)
if pend, _ := f.Pending(ctx); len(pend) == 0 {
fmt.Println("no pending runs — the workflow completed durably")
}
}