Propagate correlation_id/causation_id through execution events, add API version header
Execution events (started/failed/succeeded) never carried the correlation/causation IDs from the ExecuteRequest, even though the fields existed on Execution. Added CausationID to ExecuteRequest and Execution, and split emitEvent into a correlated variant used throughout the execution lifecycle. handleExecute falls back to X-Correlation-ID/X-Causation-ID headers when the body omits them. Also add X-Hexis-Version negotiation on /api/v1/*, matching Nexus. Part of Vikunja #273. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_018ghELqYhZNLub2TXGMazqA
This commit is contained in:
+36
-6
@@ -21,15 +21,39 @@ func NewHandler(store storage.Interface, engine *execution.Engine) *Handler {
|
||||
return &Handler{store: store, engine: engine}
|
||||
}
|
||||
|
||||
// SupportedAPIVersion is the version this server implements. A request
|
||||
// carrying X-Hexis-Version set to anything else is rejected — clients that
|
||||
// don't send the header at all are allowed through unversioned, to avoid
|
||||
// breaking callers mid-rollout.
|
||||
const SupportedAPIVersion = "v1"
|
||||
|
||||
func (h *Handler) Register(mux *http.ServeMux) {
|
||||
mux.HandleFunc("/health", h.health)
|
||||
mux.HandleFunc("/ready", h.ready)
|
||||
mux.HandleFunc("/api/v1/capabilities", h.handleCapabilities)
|
||||
mux.HandleFunc("/api/v1/capabilities/", h.handleCapabilityByID)
|
||||
mux.HandleFunc("/api/v1/execute", h.handleExecute)
|
||||
mux.HandleFunc("/api/v1/confirmations", h.handleConfirmations)
|
||||
mux.HandleFunc("/api/v1/executions/", h.handleExecutionByID)
|
||||
mux.HandleFunc("/api/v1/changes", h.handleChanges)
|
||||
|
||||
api := http.NewServeMux()
|
||||
api.HandleFunc("/api/v1/capabilities", h.handleCapabilities)
|
||||
api.HandleFunc("/api/v1/capabilities/", h.handleCapabilityByID)
|
||||
api.HandleFunc("/api/v1/execute", h.handleExecute)
|
||||
api.HandleFunc("/api/v1/confirmations", h.handleConfirmations)
|
||||
api.HandleFunc("/api/v1/executions/", h.handleExecutionByID)
|
||||
api.HandleFunc("/api/v1/changes", h.handleChanges)
|
||||
|
||||
mux.Handle("/api/v1/", versionCheck(api))
|
||||
}
|
||||
|
||||
func versionCheck(next http.Handler) http.Handler {
|
||||
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
if v := r.Header.Get("X-Hexis-Version"); v != "" && v != SupportedAPIVersion {
|
||||
writeJSON(w, http.StatusPreconditionFailed, map[string]string{
|
||||
"error": "unsupported API version",
|
||||
"requested_version": v,
|
||||
"supported_version": SupportedAPIVersion,
|
||||
})
|
||||
return
|
||||
}
|
||||
next.ServeHTTP(w, r)
|
||||
})
|
||||
}
|
||||
|
||||
func (h *Handler) health(w http.ResponseWriter, r *http.Request) {
|
||||
@@ -210,6 +234,12 @@ func (h *Handler) handleExecute(w http.ResponseWriter, r *http.Request) {
|
||||
writeJSON(w, http.StatusBadRequest, errorResponse("capability_id and target_entity_id are required"))
|
||||
return
|
||||
}
|
||||
if req.CorrelationID == "" {
|
||||
req.CorrelationID = r.Header.Get("X-Correlation-ID")
|
||||
}
|
||||
if req.CausationID == "" {
|
||||
req.CausationID = r.Header.Get("X-Causation-ID")
|
||||
}
|
||||
|
||||
result, err := h.engine.Execute(&req)
|
||||
if err != nil {
|
||||
|
||||
@@ -11,6 +11,7 @@ type ExecuteRequest struct {
|
||||
Origin map[string]string `json:"origin,omitempty"`
|
||||
IdempotencyKey string `json:"idempotency_key,omitempty"`
|
||||
CorrelationID string `json:"correlation_id,omitempty"`
|
||||
CausationID string `json:"causation_id,omitempty"`
|
||||
ResolutionEvidence []map[string]any `json:"resolution_evidence,omitempty"`
|
||||
ConfirmationID string `json:"confirmation_id,omitempty"`
|
||||
}
|
||||
@@ -68,6 +69,7 @@ type Execution struct {
|
||||
Error string `json:"error,omitempty"`
|
||||
ResolutionEvidence []map[string]any `json:"resolution_evidence,omitempty"`
|
||||
CorrelationID string `json:"correlation_id,omitempty"`
|
||||
CausationID string `json:"causation_id,omitempty"`
|
||||
CreatedAt time.Time `json:"created_at"`
|
||||
UpdatedAt time.Time `json:"updated_at"`
|
||||
}
|
||||
|
||||
@@ -0,0 +1,299 @@
|
||||
package execution_test
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"errors"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
"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"
|
||||
)
|
||||
|
||||
func newContractTestEngine(t *testing.T) (*execution.Engine, *storage.Store) {
|
||||
t.Helper()
|
||||
prov := &fakeProvider{name: "fake"}
|
||||
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
|
||||
}
|
||||
|
||||
// TestContract_IdempotencyKeyReplay validates that re-executing with the
|
||||
// same idempotency_key returns the existing execution without side effects.
|
||||
func TestContract_IdempotencyKeyReplay(t *testing.T) {
|
||||
eng, store := newContractTestEngine(t)
|
||||
cap := mustCreateCapability(t, store, nil)
|
||||
|
||||
// First execution with idempotency key
|
||||
res1, err := eng.Execute(&domain.ExecuteRequest{
|
||||
CapabilityID: cap.ID,
|
||||
TargetEntityID: "ent_x",
|
||||
IdempotencyKey: "idem-unique-1",
|
||||
})
|
||||
if err != nil {
|
||||
t.Fatalf("first execute: %v", err)
|
||||
}
|
||||
if res1.Execution.Status != domain.ExecutionSucceeded {
|
||||
t.Fatalf("expected succeeded, got %s", res1.Execution.Status)
|
||||
}
|
||||
|
||||
// Replay with same idempotency key must return the same execution
|
||||
res2, err := eng.Execute(&domain.ExecuteRequest{
|
||||
CapabilityID: cap.ID,
|
||||
TargetEntityID: "ent_x",
|
||||
IdempotencyKey: "idem-unique-1",
|
||||
})
|
||||
if err != nil {
|
||||
t.Fatalf("replay execute: %v", err)
|
||||
}
|
||||
if res2.Execution.ID != res1.Execution.ID {
|
||||
t.Errorf("expected same execution ID on replay, got %s vs %s", res2.Execution.ID, res1.Execution.ID)
|
||||
}
|
||||
if res2.Execution.Status != res1.Execution.Status {
|
||||
t.Errorf("expected same status on replay, got %s vs %s", res2.Execution.Status, res1.Execution.Status)
|
||||
}
|
||||
}
|
||||
|
||||
// TestContract_EmptyIdempotencyKeyNotReplayed validates that requests
|
||||
// without an idempotency key always create new executions.
|
||||
func TestContract_EmptyIdempotencyKeyNotReplayed(t *testing.T) {
|
||||
eng, store := newContractTestEngine(t)
|
||||
cap := mustCreateCapability(t, store, nil)
|
||||
|
||||
res1, err := eng.Execute(&domain.ExecuteRequest{
|
||||
CapabilityID: cap.ID,
|
||||
TargetEntityID: "ent_x",
|
||||
})
|
||||
if err != nil {
|
||||
t.Fatalf("execute 1: %v", err)
|
||||
}
|
||||
|
||||
res2, err := eng.Execute(&domain.ExecuteRequest{
|
||||
CapabilityID: cap.ID,
|
||||
TargetEntityID: "ent_x",
|
||||
})
|
||||
if err != nil {
|
||||
t.Fatalf("execute 2: %v", err)
|
||||
}
|
||||
|
||||
if res2.Execution.ID == res1.Execution.ID {
|
||||
t.Error("expected different execution IDs for same request without idempotency key")
|
||||
}
|
||||
}
|
||||
|
||||
// TestContract_EventPayloadFormat validates that all emitted events have
|
||||
// the correct event type prefix and non-empty payloads where expected.
|
||||
func TestContract_EventPayloadFormat(t *testing.T) {
|
||||
eng, store := newContractTestEngine(t)
|
||||
cap := mustCreateCapability(t, store, nil)
|
||||
|
||||
eng.Execute(&domain.ExecuteRequest{
|
||||
CapabilityID: cap.ID,
|
||||
TargetEntityID: "ent_x",
|
||||
})
|
||||
|
||||
events, err := store.EventsAfter(0, 100)
|
||||
if err != nil {
|
||||
t.Fatalf("events: %v", err)
|
||||
}
|
||||
|
||||
var seenStart, seenSucceed bool
|
||||
for _, evt := range events {
|
||||
if !strings.HasPrefix(string(evt.Type), "hexis.") {
|
||||
t.Errorf("event type %q doesn't start with 'hexis.'", evt.Type)
|
||||
}
|
||||
switch evt.Type {
|
||||
case domain.EventExecutionStarted:
|
||||
seenStart = true
|
||||
if _, ok := evt.Payload["capability_id"]; !ok {
|
||||
t.Error("execution.started event missing capability_id in payload")
|
||||
}
|
||||
case domain.EventExecutionSucceeded:
|
||||
seenSucceed = true
|
||||
case domain.EventCapabilityRegistered:
|
||||
// Registered by mustCreateCapability
|
||||
}
|
||||
}
|
||||
if !seenStart {
|
||||
t.Error("expected execution.started event")
|
||||
}
|
||||
if !seenSucceed {
|
||||
t.Error("expected execution.succeeded event")
|
||||
}
|
||||
}
|
||||
|
||||
// TestContract_CapabilityRegisteredEmittedOnce validates that
|
||||
// EventCapabilityRegistered is emitted only once per capability creation,
|
||||
// not also by the execution engine.
|
||||
func TestContract_CapabilityRegisteredEmittedOnce(t *testing.T) {
|
||||
_, store := newContractTestEngine(t)
|
||||
// This test validates that creating a capability emits exactly one
|
||||
// registration event. The handler calls AppendEvent directly with
|
||||
// EventCapabilityRegistered. The engine does not emit this event.
|
||||
// We verify by looking at the event log after a capability is created.
|
||||
|
||||
// Create capability directly through store (simulating handler behavior)
|
||||
now := time.Now().UTC()
|
||||
cap := &domain.Capability{
|
||||
ID: domain.NewCapabilityID(),
|
||||
Name: "test.cap.unique",
|
||||
Provider: "fake",
|
||||
Operation: "noop",
|
||||
Risk: "low",
|
||||
ReadOnly: false,
|
||||
Enabled: true,
|
||||
CreatedAt: now,
|
||||
UpdatedAt: now,
|
||||
Version: 1,
|
||||
TargetTypes: []string{},
|
||||
Attributes: map[string]any{},
|
||||
}
|
||||
if err := store.CreateCapability(cap); err != nil {
|
||||
t.Fatalf("create capability: %v", err)
|
||||
}
|
||||
|
||||
// Emit registration event (as handler does)
|
||||
store.AppendEvent(&domain.Event{
|
||||
ID: domain.NewEventID(),
|
||||
Type: domain.EventCapabilityRegistered,
|
||||
Timestamp: now,
|
||||
Payload: map[string]any{"capability_id": cap.ID, "name": cap.Name},
|
||||
})
|
||||
|
||||
events, err := store.EventsAfter(0, 100)
|
||||
if err != nil {
|
||||
t.Fatalf("events: %v", err)
|
||||
}
|
||||
|
||||
count := 0
|
||||
for _, evt := range events {
|
||||
if evt.Type == domain.EventCapabilityRegistered {
|
||||
payload, _ := json.Marshal(evt.Payload)
|
||||
if strings.Contains(string(payload), cap.ID) {
|
||||
count++
|
||||
}
|
||||
}
|
||||
}
|
||||
if count != 1 {
|
||||
t.Errorf("expected exactly 1 EventCapabilityRegistered for cap %s, got %d", cap.ID, count)
|
||||
}
|
||||
}
|
||||
|
||||
// TestContract_EventCorrelationFieldPopulated validates that correlation_id
|
||||
// and causation_id set on an ExecuteRequest propagate onto the execution's
|
||||
// emitted events.
|
||||
func TestContract_EventCorrelationFieldPopulated(t *testing.T) {
|
||||
eng, store := newContractTestEngine(t)
|
||||
cap := mustCreateCapability(t, store, nil)
|
||||
|
||||
eng.Execute(&domain.ExecuteRequest{
|
||||
CapabilityID: cap.ID,
|
||||
TargetEntityID: "ent_x",
|
||||
CorrelationID: "corr-789",
|
||||
CausationID: "cause-012",
|
||||
})
|
||||
|
||||
events, err := store.EventsAfter(0, 100)
|
||||
if err != nil {
|
||||
t.Fatalf("events: %v", err)
|
||||
}
|
||||
|
||||
found := false
|
||||
for _, evt := range events {
|
||||
if evt.Type == domain.EventExecutionStarted {
|
||||
found = true
|
||||
if evt.CorrelationID != "corr-789" {
|
||||
t.Errorf("expected correlation_id corr-789, got %q", evt.CorrelationID)
|
||||
}
|
||||
if evt.CausationID != "cause-012" {
|
||||
t.Errorf("expected causation_id cause-012, got %q", evt.CausationID)
|
||||
}
|
||||
}
|
||||
}
|
||||
if !found {
|
||||
t.Fatalf("expected an execution.started event")
|
||||
}
|
||||
}
|
||||
|
||||
// TestContract_DestructiveCapabilityDisabledByDefault validates that
|
||||
// capabilities with risk="destructive" are created with enabled=false
|
||||
// per ECOSYSTEM-SPEC.md §4.3.
|
||||
func TestContract_DestructiveCapabilityDisabledByDefault(t *testing.T) {
|
||||
risk := "destructive"
|
||||
enabled := risk != "destructive" // line 117 in handler.go
|
||||
if enabled {
|
||||
t.Error("expected destructive capability to be disabled by default")
|
||||
}
|
||||
}
|
||||
|
||||
// TestContract_ExecutionStatusDeniedNotEmitted documents that the
|
||||
// execution.denied event type is defined but never emitted.
|
||||
func TestContract_ExecutionDeniedNotEmitted(t *testing.T) {
|
||||
eng, store := newContractTestEngine(t)
|
||||
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)
|
||||
}
|
||||
|
||||
events, _ := store.EventsAfter(0, 100)
|
||||
for _, evt := range events {
|
||||
if evt.Type == domain.EventExecutionDenied {
|
||||
t.Errorf("execution.denied event emitted but expected to not be in use")
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// TestContract_ChangesSinceReturnsAll validates the current behavior:
|
||||
// handleChanges always queries from sequence 0 regardless of the `since`
|
||||
// parameter (known bug).
|
||||
func TestContract_ChangesSinceAlwaysZero(t *testing.T) {
|
||||
eng, store := newContractTestEngine(t)
|
||||
cap := mustCreateCapability(t, store, nil)
|
||||
|
||||
eng.Execute(&domain.ExecuteRequest{
|
||||
CapabilityID: cap.ID,
|
||||
TargetEntityID: "ent_x",
|
||||
})
|
||||
|
||||
// EventsAfter with since=0 returns all events
|
||||
all, err := store.EventsAfter(0, 1000)
|
||||
if err != nil {
|
||||
t.Fatalf("events after 0: %v", err)
|
||||
}
|
||||
|
||||
// EventsAfter with since=5 should return fewer events
|
||||
after5, err := store.EventsAfter(5, 1000)
|
||||
if err != nil {
|
||||
t.Fatalf("events after 5: %v", err)
|
||||
}
|
||||
|
||||
if len(all) <= len(after5) {
|
||||
t.Logf("BUG CONFIRMED: EventsAfter(0) returned %d events, EventsAfter(5) returned %d events (should be fewer)",
|
||||
len(all), len(after5))
|
||||
}
|
||||
}
|
||||
|
||||
// TestContract_TimeoutGoroutineNotCancelled documents that when an execution
|
||||
// times out, the provider goroutine continues running in the background.
|
||||
func TestContract_TimeoutGoroutineNotCancelled(t *testing.T) {
|
||||
t.Log("CONFIRMED: runWithTimeout does not cancel the provider goroutine on timeout")
|
||||
}
|
||||
@@ -76,6 +76,7 @@ func (e *Engine) Execute(req *domain.ExecuteRequest) (*ExecuteResult, error) {
|
||||
ConfirmationID: req.ConfirmationID,
|
||||
Status: domain.ExecutionStarted,
|
||||
CorrelationID: req.CorrelationID,
|
||||
CausationID: req.CausationID,
|
||||
ResolutionEvidence: req.ResolutionEvidence,
|
||||
CreatedAt: now,
|
||||
UpdatedAt: now,
|
||||
@@ -94,7 +95,7 @@ func (e *Engine) Execute(req *domain.ExecuteRequest) (*ExecuteResult, error) {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
e.emitEvent(domain.EventExecutionStarted, exec.ID, map[string]any{
|
||||
e.emitEventCorrelated(domain.EventExecutionStarted, exec.ID, exec.CorrelationID, exec.CausationID, map[string]any{
|
||||
"capability_id": req.CapabilityID,
|
||||
"target_entity_id": req.TargetEntityID,
|
||||
"provider": capability.Provider,
|
||||
@@ -116,7 +117,7 @@ func (e *Engine) Execute(req *domain.ExecuteRequest) (*ExecuteResult, error) {
|
||||
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{
|
||||
e.emitEventCorrelated(domain.EventExecutionFailed, exec.ID, exec.CorrelationID, exec.CausationID, map[string]any{
|
||||
"capability_id": req.CapabilityID,
|
||||
"outcome": "unknown",
|
||||
"reason": "timeout",
|
||||
@@ -125,14 +126,14 @@ func (e *Engine) Execute(req *domain.ExecuteRequest) (*ExecuteResult, error) {
|
||||
exec.Status = domain.ExecutionFailed
|
||||
exec.Error = execErr.Error()
|
||||
exec.Result = map[string]any{"error": execErr.Error()}
|
||||
e.emitEvent(domain.EventExecutionFailed, exec.ID, map[string]any{
|
||||
e.emitEventCorrelated(domain.EventExecutionFailed, exec.ID, exec.CorrelationID, exec.CausationID, map[string]any{
|
||||
"capability_id": req.CapabilityID,
|
||||
"error": execErr.Error(),
|
||||
})
|
||||
default:
|
||||
exec.Status = domain.ExecutionSucceeded
|
||||
exec.Result = result
|
||||
e.emitEvent(domain.EventExecutionSucceeded, exec.ID, map[string]any{
|
||||
e.emitEventCorrelated(domain.EventExecutionSucceeded, exec.ID, exec.CorrelationID, exec.CausationID, map[string]any{
|
||||
"capability_id": req.CapabilityID,
|
||||
})
|
||||
}
|
||||
@@ -250,11 +251,17 @@ func (e *Engine) ValidateTarget(capabilityID, entityID string) error {
|
||||
}
|
||||
|
||||
func (e *Engine) emitEvent(evtType domain.HexisEventType, entityID string, payload map[string]any) {
|
||||
e.emitEventCorrelated(evtType, entityID, "", "", payload)
|
||||
}
|
||||
|
||||
func (e *Engine) emitEventCorrelated(evtType domain.HexisEventType, entityID, correlationID, causationID string, payload map[string]any) {
|
||||
e.store.AppendEvent(&domain.Event{
|
||||
ID: domain.NewEventID(),
|
||||
Type: evtType,
|
||||
Timestamp: time.Now().UTC(),
|
||||
Payload: payload,
|
||||
ID: domain.NewEventID(),
|
||||
Type: evtType,
|
||||
Timestamp: time.Now().UTC(),
|
||||
CorrelationID: correlationID,
|
||||
CausationID: causationID,
|
||||
Payload: payload,
|
||||
})
|
||||
}
|
||||
|
||||
|
||||
Reference in New Issue
Block a user