Skip to content

Extract shared event prologue in WorkflowAuditor #6122

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
JAORMX merged 1 commit into from
Jul 28, 2026
+34 −166
Merged

Extract shared event prologue in WorkflowAuditor #6122

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
112 changes: 24 additions & 88 deletions pkg/audit/workflow_auditor.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,17 +60,7 @@ func (w *WorkflowAuditor) LogWorkflowStarted(
return
}

source := w.extractSource(ctx)
subjects := w.extractSubjects(ctx)

event := NewAuditEvent(
EventTypeWorkflowStarted,
source,
OutcomeSuccess,
subjects,
w.component,
)
w.attachDelegation(ctx, event)
event := w.newEvent(ctx, EventTypeWorkflowStarted, OutcomeSuccess)

target := map[string]string{
TargetKeyWorkflowID: workflowID,
Expand Down Expand Up @@ -112,17 +102,7 @@ func (w *WorkflowAuditor) LogWorkflowCompleted(
return
}

source := w.extractSource(ctx)
subjects := w.extractSubjects(ctx)

event := NewAuditEvent(
EventTypeWorkflowCompleted,
source,
OutcomeSuccess,
subjects,
w.component,
)
w.attachDelegation(ctx, event)
event := w.newEvent(ctx, EventTypeWorkflowCompleted, OutcomeSuccess)

target := map[string]string{
TargetKeyWorkflowID: workflowID,
Expand Down Expand Up @@ -165,17 +145,7 @@ func (w *WorkflowAuditor) LogWorkflowFailed(
return
}

source := w.extractSource(ctx)
subjects := w.extractSubjects(ctx)

event := NewAuditEvent(
EventTypeWorkflowFailed,
source,
OutcomeFailure,
subjects,
w.component,
)
w.attachDelegation(ctx, event)
event := w.newEvent(ctx, EventTypeWorkflowFailed, OutcomeFailure)

target := map[string]string{
TargetKeyWorkflowID: workflowID,
Expand Down Expand Up @@ -205,17 +175,7 @@ func (w *WorkflowAuditor) LogWorkflowTimedOut(
return
}

source := w.extractSource(ctx)
subjects := w.extractSubjects(ctx)

event := NewAuditEvent(
EventTypeWorkflowTimedOut,
source,
OutcomeFailure,
subjects,
w.component,
)
w.attachDelegation(ctx, event)
event := w.newEvent(ctx, EventTypeWorkflowTimedOut, OutcomeFailure)

target := map[string]string{
TargetKeyWorkflowID: workflowID,
Expand Down Expand Up @@ -245,17 +205,7 @@ func (w *WorkflowAuditor) LogStepStarted(
return
}

source := w.extractSource(ctx)
subjects := w.extractSubjects(ctx)

event := NewAuditEvent(
EventTypeWorkflowStepStarted,
source,
OutcomeSuccess,
subjects,
w.component,
)
w.attachDelegation(ctx, event)
event := w.newEvent(ctx, EventTypeWorkflowStepStarted, OutcomeSuccess)

target := map[string]string{
TargetKeyWorkflowID: workflowID,
Expand Down Expand Up @@ -283,17 +233,7 @@ func (w *WorkflowAuditor) LogStepCompleted(
return
}

source := w.extractSource(ctx)
subjects := w.extractSubjects(ctx)

event := NewAuditEvent(
EventTypeWorkflowStepCompleted,
source,
OutcomeSuccess,
subjects,
w.component,
)
w.attachDelegation(ctx, event)
event := w.newEvent(ctx, EventTypeWorkflowStepCompleted, OutcomeSuccess)

target := map[string]string{
TargetKeyWorkflowID: workflowID,
Expand Down Expand Up @@ -323,17 +263,7 @@ func (w *WorkflowAuditor) LogStepFailed(
return
}

source := w.extractSource(ctx)
subjects := w.extractSubjects(ctx)

event := NewAuditEvent(
EventTypeWorkflowStepFailed,
source,
OutcomeFailure,
subjects,
w.component,
)
w.attachDelegation(ctx, event)
event := w.newEvent(ctx, EventTypeWorkflowStepFailed, OutcomeFailure)

target := map[string]string{
TargetKeyWorkflowID: workflowID,
Expand Down Expand Up @@ -361,17 +291,7 @@ func (w *WorkflowAuditor) LogStepSkipped(
return
}

source := w.extractSource(ctx)
subjects := w.extractSubjects(ctx)

event := NewAuditEvent(
EventTypeWorkflowStepSkipped,
source,
OutcomeSuccess,
subjects,
w.component,
)
w.attachDelegation(ctx, event)
event := w.newEvent(ctx, EventTypeWorkflowStepSkipped, OutcomeSuccess)

target := map[string]string{
TargetKeyWorkflowID: workflowID,
Expand All @@ -390,6 +310,22 @@ func (w *WorkflowAuditor) LogStepSkipped(
event.LogTo(ctx, w.auditLogger, LevelAudit)
}

// newEvent creates an audit event of the given type and outcome with the
// source, subjects, and RFC 8693 delegation chain extracted from the context.
// Every Log* method MUST build its event through this helper so that the
// delegation chain cannot be forgotten at any individual call site.
func (w *WorkflowAuditor) newEvent(ctx context.Context, eventType, outcome string) *AuditEvent {
event := NewAuditEvent(
eventType,
w.extractSource(ctx),
outcome,
w.extractSubjects(ctx),
w.component,
)
w.attachDelegation(ctx, event)
return event
}

// extractSource extracts source information from context.
// For workflows, source is always local since they're internal orchestration.
func (*WorkflowAuditor) extractSource(_ context.Context) EventSource {
Expand Down
88 changes: 10 additions & 78 deletions pkg/audit/workflow_auditor_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -617,86 +617,18 @@ func TestWorkflowAuditor_DelegationChain(t *testing.T) {
},
}

// attachDelegation is hand-repeated in every Log* method, so each call site is pinned individually.
logMethods := []struct {
name string
logFunc func(a *WorkflowAuditor, ctx context.Context)
}{
{
name: "LogWorkflowStarted",
logFunc: func(a *WorkflowAuditor, ctx context.Context) {
a.LogWorkflowStarted(ctx, "wf-1", "wf", nil, time.Second)
},
},
{
name: "LogWorkflowCompleted",
logFunc: func(a *WorkflowAuditor, ctx context.Context) {
a.LogWorkflowCompleted(ctx, "wf-1", "wf", time.Second, 1, nil)
},
},
{
name: "LogWorkflowFailed",
logFunc: func(a *WorkflowAuditor, ctx context.Context) {
a.LogWorkflowFailed(ctx, "wf-1", "wf", time.Second, 1, errors.New("failed"))
},
},
{
name: "LogWorkflowTimedOut",
logFunc: func(a *WorkflowAuditor, ctx context.Context) {
a.LogWorkflowTimedOut(ctx, "wf-1", "wf", time.Second, 1)
},
},
{
name: "LogStepStarted",
logFunc: func(a *WorkflowAuditor, ctx context.Context) {
a.LogStepStarted(ctx, "wf-1", "step-1", "tool", "some-tool")
},
},
{
name: "LogStepCompleted",
logFunc: func(a *WorkflowAuditor, ctx context.Context) {
a.LogStepCompleted(ctx, "wf-1", "step-1", time.Second, 0)
},
},
{
name: "LogStepFailed",
logFunc: func(a *WorkflowAuditor, ctx context.Context) {
a.LogStepFailed(ctx, "wf-1", "step-1", time.Second, 0, errors.New("failed"))
},
},
{
name: "LogStepSkipped",
logFunc: func(a *WorkflowAuditor, ctx context.Context) {
a.LogStepSkipped(ctx, "wf-1", "step-1", "condition")
},
},
}

for _, tt := range logMethods {
t.Run(tt.name, func(t *testing.T) {
t.Parallel()
auditor, writer := createTestAuditor(t, DefaultConfig())

ctx := auth.WithIdentity(context.Background(), delegatedIdentity)
tt.logFunc(auditor, ctx)
// Every Log* method builds its event through newEvent, so testing the
// helper covers the delegation attachment for all of them by construction.
t.Run("newEvent attaches delegation chain", func(t *testing.T) {
t.Parallel()
auditor, _ := createTestAuditor(t, DefaultConfig())

require.NotEmpty(t, writer.logs, "expected log entry")
entry := parseLogEntry(t, writer.getLastLog())
ctx := auth.WithIdentity(context.Background(), delegatedIdentity)
event := auditor.newEvent(ctx, EventTypeWorkflowStarted, OutcomeSuccess)

chain, ok := entry["delegation"].(map[string]any)
require.True(t, ok, "delegation should be present in the log output")
assert.Equal(t, false, chain["truncated"])
hops, ok := chain["chain"].([]any)
require.True(t, ok)
require.Len(t, hops, 2)
first, ok := hops[0].(map[string]any)
require.True(t, ok)
assert.Equal(t, "agent-1", first["sub"])
second, ok := hops[1].(map[string]any)
require.True(t, ok)
assert.Equal(t, "agent-2", second["sub"])
})
}
require.NotNil(t, event.DelegationChain, "delegation chain should be attached")
assert.Equal(t, delegatedChain, event.DelegationChain)
})

t.Run("no identity omits delegation chain", func(t *testing.T) {
t.Parallel()
Expand Down
Loading