Implement Hexis confirmations, disabled-by-default risk, and timeout=>unknown

Closes the biggest gap between the running execution engine and
ECOSYSTEM-SPEC.md §4.3: confirmations were entirely unmodeled, so any
capability could execute unconfirmed regardless of requires_confirmation.

- New confirmations table + Confirmation domain type; POST
  /api/v1/confirmations mints a TTL-bound (120s) confirmation binding
  capability id+version, target entity, and a sorted-key args hash.
- Execute() now requires a valid pending confirmation when the
  capability demands one: rejects missing, expired, consumed, or
  args/version-mismatched confirmations; consumes on success.
- Capabilities gain enabled (destructive risk defaults to disabled,
  matching "must be turned on explicitly") and timeout_seconds.
- One in-flight execution per (capability_id, target_entity_id); a
  second concurrent attempt is rejected (surfaced as 409 over HTTP).
- Wall-clock timeout per capability now wraps the provider call; on
  timeout the outcome is "unknown" (new ExecutionStatus), never
  "failed", and the run is never auto-retried.
- 9 new engine tests cover each guard from the spec's Phase 6 gate.

Vikunja #274.
This commit is contained in:
kami
2026-07-20 00:58:42 +04:00
parent cca63269e1
commit 89d8433d17
8 changed files with 812 additions and 98 deletions
+139 -9
View File
@@ -1,6 +1,7 @@
package execution
import (
"context"
"encoding/json"
"fmt"
"time"
@@ -10,6 +11,8 @@ import (
"github.com/kami/hexis/internal/storage"
)
const defaultTimeout = 30 * time.Second
type Engine struct {
store storage.Interface
registry *provider.Registry
@@ -36,10 +39,25 @@ func (e *Engine) Execute(req *domain.ExecuteRequest) (*ExecuteResult, error) {
return nil, fmt.Errorf("capability: %w", err)
}
if !capability.Enabled {
return nil, domain.ErrCapabilityDisabled
}
if capability.TargetEntityID != "" && capability.TargetEntityID != req.TargetEntityID {
return nil, domain.ErrCapabilityNotBound
}
if capability.RequiresConfirmation {
if err := e.consumeConfirmation(req, capability); err != nil {
return nil, err
}
}
// One in-flight execution per (capability_id, target_entity_id).
if _, err := e.store.GetInFlightExecution(req.CapabilityID, req.TargetEntityID); err == nil {
return nil, domain.ErrExecutionInFlight
}
prov, err := e.registry.Get(capability.Provider)
if err != nil {
return nil, fmt.Errorf("provider: %w", err)
@@ -55,6 +73,7 @@ func (e *Engine) Execute(req *domain.ExecuteRequest) (*ExecuteResult, error) {
RequestedBy: req.RequestedBy,
Origin: req.Origin,
IdempotencyKey: req.IdempotencyKey,
ConfirmationID: req.ConfirmationID,
Status: domain.ExecutionStarted,
CorrelationID: req.CorrelationID,
ResolutionEvidence: req.ResolutionEvidence,
@@ -76,16 +95,33 @@ func (e *Engine) Execute(req *domain.ExecuteRequest) (*ExecuteResult, error) {
}
e.emitEvent(domain.EventExecutionStarted, exec.ID, map[string]any{
"capability_id": req.CapabilityID,
"capability_id": req.CapabilityID,
"target_entity_id": req.TargetEntityID,
"provider": capability.Provider,
"correlation_id": req.CorrelationID,
"provider": capability.Provider,
"correlation_id": req.CorrelationID,
})
result, execErr := prov.Execute(capability, req)
timeout := defaultTimeout
if capability.TimeoutSeconds > 0 {
timeout = time.Duration(capability.TimeoutSeconds) * time.Second
}
result, execErr, timedOut := e.runWithTimeout(prov, capability, req, timeout)
exec.UpdatedAt = time.Now().UTC()
if execErr != nil {
switch {
case timedOut:
// Outcome is never "failed" on timeout, and never retried automatically
// per ECOSYSTEM-SPEC.md §4.3 — the side effect may or may not have landed.
exec.Status = domain.ExecutionUnknown
exec.Error = "execution timed out after " + timeout.String()
exec.Result = map[string]any{"error": exec.Error}
e.emitEvent(domain.EventExecutionFailed, exec.ID, map[string]any{
"capability_id": req.CapabilityID,
"outcome": "unknown",
"reason": "timeout",
})
case execErr != nil:
exec.Status = domain.ExecutionFailed
exec.Error = execErr.Error()
exec.Result = map[string]any{"error": execErr.Error()}
@@ -93,7 +129,7 @@ func (e *Engine) Execute(req *domain.ExecuteRequest) (*ExecuteResult, error) {
"capability_id": req.CapabilityID,
"error": execErr.Error(),
})
} else {
default:
exec.Status = domain.ExecutionSucceeded
exec.Result = result
e.emitEvent(domain.EventExecutionSucceeded, exec.ID, map[string]any{
@@ -108,6 +144,100 @@ func (e *Engine) Execute(req *domain.ExecuteRequest) (*ExecuteResult, error) {
return &ExecuteResult{Execution: exec}, nil
}
// runWithTimeout executes the provider call on a goroutine and returns
// (nil, nil, true) if it doesn't finish within timeout. The goroutine is not
// cancelled — providers don't accept a context today — so a slow executor
// keeps running in the background; its eventual result is discarded, never
// retried, and the caller has already moved on with outcome=unknown.
func (e *Engine) runWithTimeout(prov provider.Provider, capability *domain.Capability, req *domain.ExecuteRequest, timeout time.Duration) (map[string]any, error, bool) {
type outcome struct {
result map[string]any
err error
}
ch := make(chan outcome, 1)
go func() {
r, err := prov.Execute(capability, req)
ch <- outcome{result: r, err: err}
}()
ctx, cancel := context.WithTimeout(context.Background(), timeout)
defer cancel()
select {
case o := <-ch:
return o.result, o.err, false
case <-ctx.Done():
return nil, nil, true
}
}
func (e *Engine) consumeConfirmation(req *domain.ExecuteRequest, capability *domain.Capability) error {
if req.ConfirmationID == "" {
return domain.ErrConfirmationRequired
}
conf, err := e.store.GetConfirmation(req.ConfirmationID)
if err != nil {
return err
}
if conf.State != domain.ConfirmationPending {
return domain.ErrConfirmationConsumed
}
if time.Now().UTC().After(conf.ExpiresAt) {
e.store.UpdateConfirmationState(conf.ID, domain.ConfirmationExpired)
return domain.ErrConfirmationExpired
}
if conf.CapabilityID != capability.ID || conf.CapabilityVersion != capability.Version {
return domain.ErrConfirmationInvalid
}
if conf.TargetEntityID != req.TargetEntityID {
return domain.ErrConfirmationInvalid
}
normalized, err := domain.NormalizeArgs(req.Arguments)
if err != nil {
return err
}
if domain.HashArgs(normalized) != conf.ArgsHash {
return domain.ErrConfirmationInvalid
}
return e.store.UpdateConfirmationState(conf.ID, domain.ConfirmationConsumed)
}
// CreateConfirmation validates a would-be execute request against a
// capability and mints a time-bounded confirmation for it.
func (e *Engine) CreateConfirmation(capabilityID, targetEntityID, requester string, args map[string]any) (*domain.Confirmation, error) {
capability, err := e.store.GetCapability(capabilityID)
if err != nil {
return nil, fmt.Errorf("capability: %w", err)
}
if capability.TargetEntityID != "" && capability.TargetEntityID != targetEntityID {
return nil, domain.ErrCapabilityNotBound
}
normalized, err := domain.NormalizeArgs(args)
if err != nil {
return nil, err
}
now := time.Now().UTC()
conf := &domain.Confirmation{
ID: domain.NewConfirmationID(),
CapabilityID: capability.ID,
CapabilityVersion: capability.Version,
TargetEntityID: targetEntityID,
ArgsNormalized: normalized,
ArgsHash: domain.HashArgs(normalized),
Requester: requester,
CreatedAt: now,
ExpiresAt: now.Add(domain.ConfirmationTTL),
State: domain.ConfirmationPending,
}
if err := e.store.CreateConfirmation(conf); err != nil {
return nil, err
}
return conf, nil
}
func (e *Engine) ValidateTarget(capabilityID, entityID string) error {
cap, err := e.store.GetCapability(capabilityID)
if err != nil {
@@ -134,9 +264,9 @@ type ResolveRequest struct {
}
type ResolveResult struct {
Status string `json:"status"`
Candidates []map[string]any `json:"candidates,omitempty"`
EntityID string `json:"entity_id,omitempty"`
Status string `json:"status"`
Candidates []map[string]any `json:"candidates,omitempty"`
EntityID string `json:"entity_id,omitempty"`
}
var _ json.Marshaler = (*ResolveResult)(nil)
+293
View File
@@ -0,0 +1,293 @@
package execution_test
import (
"errors"
"path/filepath"
"testing"
"time"
"github.com/kami/hexis/internal/domain"
"github.com/kami/hexis/internal/execution"
"github.com/kami/hexis/internal/provider"
"github.com/kami/hexis/internal/storage"
)
type fakeProvider struct {
name string
delay time.Duration
err error
}
func (p *fakeProvider) Name() string { return p.name }
func (p *fakeProvider) Execute(capability *domain.Capability, req *domain.ExecuteRequest) (map[string]any, error) {
if p.delay > 0 {
time.Sleep(p.delay)
}
if p.err != nil {
return nil, p.err
}
return map[string]any{"ok": true}, nil
}
func newTestEngine(t *testing.T, prov *fakeProvider) (*execution.Engine, *storage.Store) {
t.Helper()
dir := t.TempDir()
store, err := storage.Open(filepath.Join(dir, "hexis.db"))
if err != nil {
t.Fatalf("open storage: %v", err)
}
t.Cleanup(func() { store.Close() })
reg := provider.NewRegistry()
reg.Register(prov)
return execution.New(store, reg), store
}
func mustCreateCapability(t *testing.T, store storage.Interface, mutate func(*domain.Capability)) *domain.Capability {
t.Helper()
now := time.Now().UTC()
cap := &domain.Capability{
ID: domain.NewCapabilityID(),
Name: "test.capability",
Provider: "fake",
Operation: "noop",
Risk: "low",
ReadOnly: false,
Enabled: true,
CreatedAt: now,
UpdatedAt: now,
Version: 1,
TargetTypes: []string{},
Attributes: map[string]any{},
}
if mutate != nil {
mutate(cap)
}
if err := store.CreateCapability(cap); err != nil {
t.Fatalf("create capability: %v", err)
}
return cap
}
func TestExecute_FreeTextTargetRejectedWhenBound(t *testing.T) {
prov := &fakeProvider{name: "fake"}
eng, store := newTestEngine(t, prov)
cap := mustCreateCapability(t, store, func(c *domain.Capability) {
c.TargetEntityID = "ent_bound_only"
})
_, err := eng.Execute(&domain.ExecuteRequest{
CapabilityID: cap.ID,
TargetEntityID: "ent_someone_else",
})
if !errors.Is(err, domain.ErrCapabilityNotBound) {
t.Fatalf("expected ErrCapabilityNotBound, got %v", err)
}
}
func TestExecute_DisabledCapabilityRejected(t *testing.T) {
prov := &fakeProvider{name: "fake"}
eng, store := newTestEngine(t, prov)
cap := mustCreateCapability(t, store, func(c *domain.Capability) {
c.Enabled = false
})
_, err := eng.Execute(&domain.ExecuteRequest{CapabilityID: cap.ID, TargetEntityID: "ent_x"})
if !errors.Is(err, domain.ErrCapabilityDisabled) {
t.Fatalf("expected ErrCapabilityDisabled, got %v", err)
}
}
func TestExecute_ConfirmationRequiredButMissing(t *testing.T) {
prov := &fakeProvider{name: "fake"}
eng, store := newTestEngine(t, prov)
cap := mustCreateCapability(t, store, func(c *domain.Capability) {
c.RequiresConfirmation = true
})
_, err := eng.Execute(&domain.ExecuteRequest{CapabilityID: cap.ID, TargetEntityID: "ent_x"})
if !errors.Is(err, domain.ErrConfirmationRequired) {
t.Fatalf("expected ErrConfirmationRequired, got %v", err)
}
}
func TestExecute_ConfirmationValidSucceedsAndIsConsumed(t *testing.T) {
prov := &fakeProvider{name: "fake"}
eng, store := newTestEngine(t, prov)
cap := mustCreateCapability(t, store, func(c *domain.Capability) {
c.RequiresConfirmation = true
})
args := map[string]any{"foo": "bar"}
conf, err := eng.CreateConfirmation(cap.ID, "ent_x", "kami", args)
if err != nil {
t.Fatalf("create confirmation: %v", err)
}
res, err := eng.Execute(&domain.ExecuteRequest{
CapabilityID: cap.ID,
TargetEntityID: "ent_x",
Arguments: args,
ConfirmationID: conf.ID,
})
if err != nil {
t.Fatalf("execute: %v", err)
}
if res.Execution.Status != domain.ExecutionSucceeded {
t.Fatalf("expected succeeded, got %s", res.Execution.Status)
}
got, err := store.GetConfirmation(conf.ID)
if err != nil {
t.Fatalf("get confirmation: %v", err)
}
if got.State != domain.ConfirmationConsumed {
t.Fatalf("expected confirmation consumed, got %s", got.State)
}
// Reusing the same confirmation must fail.
_, err = eng.Execute(&domain.ExecuteRequest{
CapabilityID: cap.ID,
TargetEntityID: "ent_x",
Arguments: args,
ConfirmationID: conf.ID,
})
if !errors.Is(err, domain.ErrConfirmationConsumed) {
t.Fatalf("expected ErrConfirmationConsumed on replay, got %v", err)
}
}
func TestExecute_ConfirmationExpired(t *testing.T) {
prov := &fakeProvider{name: "fake"}
eng, store := newTestEngine(t, prov)
cap := mustCreateCapability(t, store, func(c *domain.Capability) {
c.RequiresConfirmation = true
})
conf, err := eng.CreateConfirmation(cap.ID, "ent_x", "kami", nil)
if err != nil {
t.Fatalf("create confirmation: %v", err)
}
// Directly backdate the row's expiry in storage to simulate TTL elapse
// without waiting out the real 120s TTL in a test.
if _, err := store.DB().Exec(`UPDATE confirmations SET expires_at = ? WHERE id = ?`,
time.Now().UTC().Add(-time.Minute).Format("2006-01-02T15:04:05.999999999Z07:00"), conf.ID); err != nil {
t.Fatalf("backdate confirmation: %v", err)
}
_, err = eng.Execute(&domain.ExecuteRequest{
CapabilityID: cap.ID,
TargetEntityID: "ent_x",
ConfirmationID: conf.ID,
})
if !errors.Is(err, domain.ErrConfirmationExpired) {
t.Fatalf("expected ErrConfirmationExpired, got %v", err)
}
got, err := store.GetConfirmation(conf.ID)
if err != nil {
t.Fatalf("get confirmation: %v", err)
}
if got.State != domain.ConfirmationExpired {
t.Fatalf("expected confirmation state expired, got %s", got.State)
}
}
func TestExecute_ArgsHashMismatchRejected(t *testing.T) {
prov := &fakeProvider{name: "fake"}
eng, store := newTestEngine(t, prov)
cap := mustCreateCapability(t, store, func(c *domain.Capability) {
c.RequiresConfirmation = true
})
conf, err := eng.CreateConfirmation(cap.ID, "ent_x", "kami", map[string]any{"n": 1})
if err != nil {
t.Fatalf("create confirmation: %v", err)
}
_, err = eng.Execute(&domain.ExecuteRequest{
CapabilityID: cap.ID,
TargetEntityID: "ent_x",
Arguments: map[string]any{"n": 2},
ConfirmationID: conf.ID,
})
if !errors.Is(err, domain.ErrConfirmationInvalid) {
t.Fatalf("expected ErrConfirmationInvalid on args mismatch, got %v", err)
}
}
func TestExecute_UnknownCapabilityVersionRejected(t *testing.T) {
prov := &fakeProvider{name: "fake"}
eng, store := newTestEngine(t, prov)
cap := mustCreateCapability(t, store, func(c *domain.Capability) {
c.RequiresConfirmation = true
})
conf, err := eng.CreateConfirmation(cap.ID, "ent_x", "kami", nil)
if err != nil {
t.Fatalf("create confirmation: %v", err)
}
// Bump the capability version (e.g. via update) so the confirmation now
// targets a stale version.
cap.Description = "changed"
if err := store.UpdateCapability(cap); err != nil {
t.Fatalf("update capability: %v", err)
}
_, err = eng.Execute(&domain.ExecuteRequest{
CapabilityID: cap.ID,
TargetEntityID: "ent_x",
ConfirmationID: conf.ID,
})
if !errors.Is(err, domain.ErrConfirmationInvalid) {
t.Fatalf("expected ErrConfirmationInvalid on stale version, got %v", err)
}
}
func TestExecute_ConcurrentInFlightRejected(t *testing.T) {
prov := &fakeProvider{name: "fake", delay: 300 * time.Millisecond}
eng, store := newTestEngine(t, prov)
cap := mustCreateCapability(t, store, nil)
done := make(chan struct{})
go func() {
eng.Execute(&domain.ExecuteRequest{CapabilityID: cap.ID, TargetEntityID: "ent_x"})
close(done)
}()
// Give the first execution time to register as "started".
time.Sleep(50 * time.Millisecond)
_, err := eng.Execute(&domain.ExecuteRequest{CapabilityID: cap.ID, TargetEntityID: "ent_x"})
if !errors.Is(err, domain.ErrExecutionInFlight) {
t.Fatalf("expected ErrExecutionInFlight, got %v", err)
}
<-done
}
func TestExecute_TimeoutYieldsUnknownNotFailed(t *testing.T) {
// Smallest supported capability timeout is 1s; use a provider slower
// than that so the engine's context deadline fires first.
prov := &fakeProvider{name: "slow", delay: 1500 * time.Millisecond}
eng, store := newTestEngine(t, prov)
cap := mustCreateCapability(t, store, func(c *domain.Capability) {
c.TimeoutSeconds = 1
c.Provider = "slow"
})
res, err := eng.Execute(&domain.ExecuteRequest{CapabilityID: cap.ID, TargetEntityID: "ent_x"})
if err != nil {
t.Fatalf("execute: %v", err)
}
if res.Execution.Status != domain.ExecutionUnknown {
t.Fatalf("expected status unknown on timeout, got %s", res.Execution.Status)
}
// Let the background provider goroutine finish so t.Cleanup can close
// the store without a dangling write racing it.
time.Sleep(1600 * time.Millisecond)
}