Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
146 changes: 146 additions & 0 deletions internal/auditlog/stream_entry_request_fields_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,146 @@
package auditlog

import (
"reflect"
"testing"
)

// responseSideLogDataFields are the LogData fields CreateStreamEntry may
// legitimately leave unset: they are not known when the stream entry is
// created and are filled in by the stream observer once the stream closes.
// Every other field describes the request and must survive the copy.
var responseSideLogDataFields = map[string]bool{
"ResponseBody": true,
"ResponseBodyTooBigToHandle": true,
"ErrorMessage": true,
"ErrorCode": true,
}

// A streamed request is persisted from the CreateStreamEntry copy — the base
// entry is never written — so an ingress rewrite chain recorded by
// EnrichEntryWithRequestRevision is lost unless the copy carries it. This
// regression covers request rewriters (e.g. pro token compression) whose
// "Rewritten" audit pane vanished on every successful streamed request while
// surviving on the non-streamed error path.
func TestCreateStreamEntryPreservesRequestRevisions(t *testing.T) {
base := &LogEntry{
ID: "entry-1",
Path: "/v1/chat/completions",
Data: &LogData{
RequestRevisions: []RequestRevisionSnapshot{{
Seq: 1,
Rewriter: "pro-token-compression",
BytesBefore: 65209,
BytesAfter: 64418,
TokensSaved: 189,
Detail: map[string]any{"chars_removed": 757},
}},
RequestBodyTooBigToHandle: true,
},
}

streamEntry := CreateStreamEntry(base)
if streamEntry == nil || streamEntry.Data == nil {
t.Fatal("expected a stream entry with data")
}

got := streamEntry.Data.RequestRevisions
if len(got) != 1 {
t.Fatalf("RequestRevisions dropped: got %d revisions, want 1", len(got))
}
if got[0].Rewriter != "pro-token-compression" || got[0].TokensSaved != 189 {
t.Fatalf("revision not copied faithfully: %+v", got[0])
}
if got[0].BytesBefore != 65209 || got[0].BytesAfter != 64418 {
t.Fatalf("revision byte counts not copied: %+v", got[0])
}
if !streamEntry.Data.RequestBodyTooBigToHandle {
t.Error("RequestBodyTooBigToHandle dropped")
}

// The copy must own its slice. Appending to the base entry would not show
// that: the source literal has no spare capacity, so append reallocates and
// leaves the copy alone whether or not the two share an array. Writing
// through an existing element is what actually distinguishes them.
base.Data.RequestRevisions[0].Rewriter = "mutated"
if streamEntry.Data.RequestRevisions[0].Rewriter != "pro-token-compression" {
t.Error("stream entry shares its revision backing array with the base entry")
}
}

// The nil case is the one the stream observer sees most often — most requests
// carry no rewriter — and it must stay nil rather than becoming an empty slice,
// so a streamed entry without rewrites serializes the same as it always did.
func TestCreateStreamEntryLeavesAbsentRequestRevisionsNil(t *testing.T) {
streamEntry := CreateStreamEntry(&LogEntry{ID: "entry-1", Data: &LogData{UserAgent: "curl/8"}})
if streamEntry == nil || streamEntry.Data == nil {
t.Fatal("expected a stream entry with data")
}
if streamEntry.Data.RequestRevisions != nil {
t.Errorf("RequestRevisions = %#v, want nil", streamEntry.Data.RequestRevisions)
}
if streamEntry.Data.UserAgent != "curl/8" {
t.Errorf("UserAgent = %q, want %q", streamEntry.Data.UserAgent, "curl/8")
}
}

// CreateStreamEntry builds LogData with a field whitelist, so any request-side
// field added to LogData later is silently dropped until someone remembers to
// extend that literal. This walks LogData by reflection and fails when a
// request-side field does not survive, which is how RequestRevisions went
// missing in the first place.
func TestCreateStreamEntryCopiesEveryRequestSideField(t *testing.T) {
populated := &LogData{}
v := reflect.ValueOf(populated).Elem()
typ := v.Type()

for i := range typ.NumField() {
field := typ.Field(i)
if !v.Field(i).CanSet() {
continue
}
if !setRecognizableValue(v.Field(i)) {
t.Fatalf("test needs a sample value for LogData.%s (%s)", field.Name, field.Type)
}
}

streamEntry := CreateStreamEntry(&LogEntry{ID: "entry-1", Data: populated})
if streamEntry == nil || streamEntry.Data == nil {
t.Fatal("expected a stream entry with data")
}

copied := reflect.ValueOf(streamEntry.Data).Elem()
for i := range typ.NumField() {
name := typ.Field(i).Name
if responseSideLogDataFields[name] {
continue
}
if copied.Field(i).IsZero() {
t.Errorf("LogData.%s is a request-side field but CreateStreamEntry dropped it", name)
}
}
}

// setRecognizableValue fills one field with a non-zero value so a dropped
// field shows up as the zero value on the other side of the copy.
func setRecognizableValue(field reflect.Value) bool {
switch field.Kind() {
case reflect.String:
field.SetString("x")
case reflect.Bool:
field.SetBool(true)
case reflect.Map:
m := reflect.MakeMap(field.Type())
m.SetMapIndex(reflect.ValueOf("k"), reflect.ValueOf("v"))
field.Set(m)
case reflect.Slice:
field.Set(reflect.MakeSlice(field.Type(), 1, 1))
case reflect.Pointer:
field.Set(reflect.New(field.Type().Elem()))
case reflect.Interface:
field.Set(reflect.ValueOf(map[string]any{"k": "v"}))
default:
return false
}
return true
}
Comment on lines +25 to +146

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📐 Maintainability & Code Quality | 🟠 Major | ⚡ Quick win

Use table-driven cases for the new behavior.

Cover at least absent and populated request revisions/metadata as table cases, while retaining the reflection drift guard. As per coding guidelines, “Add or update table-driven tests for behavior changes.”

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@internal/auditlog/stream_entry_request_fields_test.go` around lines 25 - 128,
Convert TestCreateStreamEntryPreservesRequestRevisions into table-driven cases
covering absent and populated RequestRevisions and request metadata, asserting
each case’s expected copied values and ownership behavior. Retain
TestCreateStreamEntryCopiesEveryRequestSideField as the reflection-based drift
guard, and keep the cases focused on CreateStreamEntry behavior.

Source: Coding guidelines

38 changes: 29 additions & 9 deletions internal/auditlog/stream_wrapper.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ package auditlog

import (
"maps"
"slices"
"sort"
"strings"
)
Expand Down Expand Up @@ -234,17 +235,25 @@ func CreateStreamEntry(baseEntry *LogEntry) *LogEntry {
Stream: true, // Mark as streaming
}

// This is a whitelist copy, so every request-side field of LogData must be
// listed here or it is silently lost: the stream observer completes and
// writes THIS copy, and the base entry is never persisted. Only the
// response-side fields may be omitted — ResponseBody, ErrorMessage,
// ErrorCode and ResponseBodyTooBigToHandle are all filled in later, once
// the stream closes. Anything already known at ingress belongs below.
if baseEntry.Data != nil {
entryCopy.Data = &LogData{
UserAgent: baseEntry.Data.UserAgent,
APIKeyHash: baseEntry.Data.APIKeyHash,
Labels: baseEntry.Data.Labels,
Temperature: baseEntry.Data.Temperature,
MaxTokens: baseEntry.Data.MaxTokens,
RequestHeaders: copyMap(baseEntry.Data.RequestHeaders),
ResponseHeaders: copyMap(baseEntry.Data.ResponseHeaders),
RequestBody: baseEntry.Data.RequestBody,
Attempts: normalizeAttemptSnapshots(baseEntry.Data.Attempts),
UserAgent: baseEntry.Data.UserAgent,
APIKeyHash: baseEntry.Data.APIKeyHash,
Labels: baseEntry.Data.Labels,
Temperature: baseEntry.Data.Temperature,
MaxTokens: baseEntry.Data.MaxTokens,
RequestHeaders: copyMap(baseEntry.Data.RequestHeaders),
ResponseHeaders: copyMap(baseEntry.Data.ResponseHeaders),
RequestBody: baseEntry.Data.RequestBody,
RequestBodyTooBigToHandle: baseEntry.Data.RequestBodyTooBigToHandle,
RequestRevisions: copyRequestRevisions(baseEntry.Data.RequestRevisions),
Attempts: normalizeAttemptSnapshots(baseEntry.Data.Attempts),
}
if baseEntry.Data.WorkflowFeatures != nil {
snapshot := *baseEntry.Data.WorkflowFeatures
Expand All @@ -259,6 +268,17 @@ func CreateStreamEntry(baseEntry *LogEntry) *LogEntry {
return entryCopy
}

// copyRequestRevisions copies the ingress rewrite chain so the streamed entry
// owns its own slice. The chain is complete before the stream opens, but the
// copy keeps this consistent with the map copying above and leaves no shared
// backing array between the base entry and the entry the observer writes.
func copyRequestRevisions(revisions []RequestRevisionSnapshot) []RequestRevisionSnapshot {
if revisions == nil {
return nil
}
return slices.Clone(revisions)
}

// copyMap creates a shallow copy of a string map
func copyMap(m map[string]string) map[string]string {
if m == nil {
Expand Down