Compare commits

...
Author SHA1 Message Date
anandh8x bea0c21472 Freeze planned tool schemas 2026-08-08 13:22:05 +05:30
anandh8x 0368c2bd3b Fix context plan request accounting 2026-08-08 13:02:10 +05:30
anandh8x 14f8a1ab90 Centralize agent context planning 2026-08-08 12:36:39 +05:30
14 changed files with 613 additions and 87 deletions

No files matched your search

+27 -16
View File
@@ -381,6 +381,8 @@ type compactionState struct {
// but its token COST must still be counted so usage reports and budgets include it.
onUsage func(Usage)
task *taskState
planner *contextPlanner
trace *trace.Recorder
// calibrationRatio scales the raw byte/4 token estimate toward the provider's
// real prompt-token count. ApproxTextTokens over-counts code-heavy content by
@@ -427,6 +429,8 @@ func newCompactionState(options Options, task *taskState) *compactionState {
preserveLast: options.CompactionPreserveLast,
onUsage: options.OnUsage,
task: task,
planner: newContextPlanner(contextPlannerConfig{contextWindow: options.ContextWindow}),
trace: options.Trace,
}
return state
}
@@ -482,7 +486,7 @@ func (state *compactionState) maybeCompact(
compacted, err := Compact(messages, CompactionOptions{
PreserveLast: state.preserveLast,
Summarize: summarizeClosure(ctx, provider, state.onUsage),
Summarize: state.summarizeClosure(ctx, provider),
taskState: state.task.snapshotForCompaction(messages),
})
if err != nil {
@@ -533,7 +537,7 @@ func (state *compactionState) recover(
result, compactErr := Compact(messages, CompactionOptions{
PreserveLast: state.preserveLast,
Summarize: summarizeClosure(ctx, provider, state.onUsage),
Summarize: state.summarizeClosure(ctx, provider),
taskState: state.task.snapshotForCompaction(messages),
})
if compactErr != nil {
@@ -567,9 +571,12 @@ func (state *compactionState) recover(
// provider call. The summary stream intentionally does NOT forward OnText (so
// compaction stays invisible on the user-facing surface), but it DOES forward
// OnUsage so the summarizer's token cost is still counted by usage/budgeting.
func summarizeClosure(ctx context.Context, provider Provider, onUsage func(Usage)) func([]zeroruntime.Message) (string, error) {
func (state *compactionState) summarizeClosure(ctx context.Context, provider Provider) func([]zeroruntime.Message) (string, error) {
if state.planner == nil {
state.planner = newContextPlanner(contextPlannerConfig{})
}
return func(toSummarize []zeroruntime.Message) (string, error) {
return summarizeWithFallback(ctx, provider, toSummarize, onUsage)
return summarizeWithPlanner(ctx, provider, toSummarize, state.onUsage, state.planner, state.trace)
}
}
@@ -581,7 +588,11 @@ func summarizeClosure(ctx context.Context, provider Provider, onUsage func(Usage
// Non-context-limit errors (and a single message that still won't fit) surface
// to the caller unchanged.
func summarizeWithFallback(ctx context.Context, provider Provider, messages []zeroruntime.Message, onUsage func(Usage)) (string, error) {
summary, err := summarizeMessagesOnce(ctx, provider, messages, onUsage)
return summarizeWithPlanner(ctx, provider, messages, onUsage, newContextPlanner(contextPlannerConfig{}), nil)
}
func summarizeWithPlanner(ctx context.Context, provider Provider, messages []zeroruntime.Message, onUsage func(Usage), planner *contextPlanner, recorder *trace.Recorder) (string, error) {
summary, err := summarizeMessagesOnce(ctx, provider, messages, onUsage, planner, recorder)
if err == nil {
return summary, nil
}
@@ -590,11 +601,11 @@ func summarizeWithFallback(ctx context.Context, provider Provider, messages []ze
}
mid := len(messages) / 2
left, leftErr := summarizeWithFallback(ctx, provider, messages[:mid], onUsage)
left, leftErr := summarizeWithPlanner(ctx, provider, messages[:mid], onUsage, planner, recorder)
if leftErr != nil {
return "", leftErr
}
right, rightErr := summarizeWithFallback(ctx, provider, messages[mid:], onUsage)
right, rightErr := summarizeWithPlanner(ctx, provider, messages[mid:], onUsage, planner, recorder)
if rightErr != nil {
return "", rightErr
}
@@ -607,7 +618,7 @@ func summarizeWithFallback(ctx context.Context, provider Provider, messages []ze
combined := strings.TrimSpace(left + "\n\n" + right)
reduced, reduceErr := summarizeMessagesOnce(ctx, provider, []zeroruntime.Message{
{Role: zeroruntime.MessageRoleUser, Content: combined},
}, onUsage)
}, onUsage, planner, recorder)
if reduceErr != nil {
if isContextLimitError(reduceErr.Error()) {
// Even the two combined partials don't fit (extreme): fall back to the
@@ -623,15 +634,15 @@ func summarizeWithFallback(ctx context.Context, provider Provider, messages []ze
}
// summarizeMessagesOnce performs a single tool-less summarization call.
func summarizeMessagesOnce(ctx context.Context, provider Provider, messages []zeroruntime.Message, onUsage func(Usage)) (string, error) {
request := zeroruntime.CompletionRequest{
Messages: []zeroruntime.Message{
{Role: zeroruntime.MessageRoleSystem, Content: CompactionSummaryInstructions},
{Role: zeroruntime.MessageRoleUser, Content: "Summarize this conversation:\n\n" + renderTranscript(messages)},
},
// No tools: this is a plain text summarization call.
func summarizeMessagesOnce(ctx context.Context, provider Provider, messages []zeroruntime.Message, onUsage func(Usage), planner *contextPlanner, recorder *trace.Recorder) (string, error) {
requestMessages := []zeroruntime.Message{
{Role: zeroruntime.MessageRoleSystem, Content: CompactionSummaryInstructions},
{Role: zeroruntime.MessageRoleUser, Content: "Summarize this conversation:\n\n" + renderTranscript(messages)},
}
stream, err := provider.StreamCompletion(ctx, request)
parts := systemPromptParts{prompt: CompactionSummaryInstructions, baseInstructions: CompactionSummaryInstructions}
plan := planner.planWithPromptParts(requestMessages, nil, "", parts)
recordContextPlanTrace(recorder, plan)
stream, err := provider.StreamCompletion(ctx, plan.Request)
if err != nil {
return "", err
}
+63
View File
@@ -7,6 +7,7 @@ import (
"testing"
"github.com/Gitlawb/zero/internal/tools"
"github.com/Gitlawb/zero/internal/trace"
"github.com/Gitlawb/zero/internal/zeroruntime"
)
@@ -428,6 +429,7 @@ type reactiveProvider struct {
summarizeCalls int
turnRequests int
failedOnce bool
connectError bool
bigText string
finalText string
}
@@ -449,6 +451,9 @@ func (provider *reactiveProvider) StreamCompletion(ctx context.Context, request
return streamEvents(toolTurnWithText(provider.bigText, "1", "read_file", `{"path":"x"}`)), nil
case provider.turnRequests == 2 && !provider.failedOnce:
provider.failedOnce = true
if provider.connectError {
return nil, errors.New("context_length_exceeded")
}
return streamEvents([]zeroruntime.StreamEvent{
{Type: zeroruntime.StreamEventError, Error: "This model's maximum context length is 1000 tokens. Please reduce the length of the messages."},
}), nil
@@ -457,6 +462,39 @@ func (provider *reactiveProvider) StreamCompletion(ctx context.Context, request
}
}
func TestRunConnectErrorCompactionRecordsReplacementPlan(t *testing.T) {
provider := &reactiveProvider{
connectError: true,
bigText: strings.Repeat("b", 6000),
finalText: "recovered",
}
registry := tools.NewRegistry()
registry.Register(tools.NewScopedReadFileTool(t.TempDir(), nil))
recorder := trace.NewRecorder("connect-compaction", "run-1", "test")
var contextPlans []ContextBreakdown
result, err := Run(context.Background(), strings.Repeat("z", 6000), provider, Options{
Registry: registry,
PermissionMode: PermissionModeUnsafe,
ContextWindow: 10_000_000,
CompactionPreserveLast: 2,
Trace: recorder,
OnContext: func(breakdown ContextBreakdown) {
contextPlans = append(contextPlans, breakdown)
},
})
if err != nil || result.FinalAnswer != "recovered" {
t.Fatalf("connect-error compaction failed: result=%#v err=%v", result, err)
}
if len(contextPlans) != 3 || contextPlans[2].MessageTokens >= contextPlans[1].MessageTokens {
t.Fatalf("replacement request context not reported: %#v", contextPlans)
}
gotTrace := recorder.Finish()
if len(gotTrace.PrefixHashes) != 4 || gotTrace.PrefixHashes[3].InvalidationReason != "unchanged" {
t.Fatalf("replacement request trace not recorded: %#v", gotTrace.PrefixHashes)
}
}
func TestRunReactiveCompactionRecovers(t *testing.T) {
provider := &reactiveProvider{
bigText: strings.Repeat("b", 6000),
@@ -468,6 +506,8 @@ func TestRunReactiveCompactionRecovers(t *testing.T) {
// bloats the history.
registry := tools.NewRegistry()
registry.Register(tools.NewScopedReadFileTool(t.TempDir(), nil))
recorder := trace.NewRecorder("reactive-compaction", "run-1", "test")
var contextPlans []ContextBreakdown
// ContextWindow large enough that proactive compaction never triggers, so
// only the reactive path can save the run.
@@ -476,6 +516,10 @@ func TestRunReactiveCompactionRecovers(t *testing.T) {
PermissionMode: PermissionModeUnsafe,
ContextWindow: 10_000_000,
CompactionPreserveLast: 2,
Trace: recorder,
OnContext: func(breakdown ContextBreakdown) {
contextPlans = append(contextPlans, breakdown)
},
})
if err != nil {
t.Fatalf("expected reactive compaction to recover the run, got error: %v", err)
@@ -486,6 +530,25 @@ func TestRunReactiveCompactionRecovers(t *testing.T) {
if provider.summarizeCalls == 0 {
t.Fatal("expected reactive compaction to invoke the summarizer")
}
if len(contextPlans) != 3 {
t.Fatalf("main request context callbacks = %d, want initial turns plus compacted retry", len(contextPlans))
}
if contextPlans[2].MessageTokens >= contextPlans[1].MessageTokens {
t.Fatalf("retry context was not updated after compaction: before=%d after=%d", contextPlans[1].MessageTokens, contextPlans[2].MessageTokens)
}
gotTrace := recorder.Finish()
if len(gotTrace.PrefixHashes) != 4 {
t.Fatalf("prefix evidence count = %d, want two turns, compaction, and retry: %#v", len(gotTrace.PrefixHashes), gotTrace.PrefixHashes)
}
if gotTrace.PrefixHashes[0].InvalidationReason != "initial" ||
gotTrace.PrefixHashes[1].InvalidationReason != "unchanged" ||
gotTrace.PrefixHashes[2].InvalidationReason != "initial" ||
gotTrace.PrefixHashes[3].InvalidationReason != "unchanged" {
t.Fatalf("unexpected request-specific invalidation evidence: %#v", gotTrace.PrefixHashes)
}
if gotTrace.PrefixHashes[2].CompletePrefixHash == gotTrace.PrefixHashes[1].CompletePrefixHash {
t.Fatalf("compaction fingerprint reused the main request prefix: %#v", gotTrace.PrefixHashes)
}
}
// midStreamReactiveProvider forwards some text BEFORE surfacing a context-limit
+36
View File
@@ -23,6 +23,24 @@ type ContextBreakdown struct {
TotalTokens int // SystemTokens + ToolTokens + MessageTokens
ContextWindow int // model context window; 0 when unknown
UsedFraction float64 // TotalTokens / ContextWindow; 0 when window unknown
// Blocks explain why each model-visible category is present without exposing
// its content. The planner currently preserves all three categories.
Blocks []ContextBlock
// CompletePrefixHash identifies the provider-visible system+tool prefix.
CompletePrefixHash string
// PrefixInvalidationReason is "initial", "unchanged", or a stable comma-
// separated list of changed prefix categories.
PrefixInvalidationReason string
}
// ContextBlock is content-free evidence for one model-visible context category.
type ContextBlock struct {
Kind string
Tokens int
CacheClass string
Authority string
Recoverable bool
Reason string
}
// MeasureContext estimates the per-category token footprint of a request: the
@@ -41,6 +59,24 @@ func MeasureContext(messages []zeroruntime.Message, tools []zeroruntime.ToolDefi
ContextWindow: contextWindow,
}
breakdown.TotalTokens = breakdown.SystemTokens + breakdown.ToolTokens + breakdown.MessageTokens
if breakdown.SystemTokens > 0 {
breakdown.Blocks = append(breakdown.Blocks, ContextBlock{
Kind: "system", Tokens: breakdown.SystemTokens, CacheClass: "stable_prefix",
Authority: "required", Reason: "instructions, workspace policy, and safety policy",
})
}
if breakdown.ToolTokens > 0 {
breakdown.Blocks = append(breakdown.Blocks, ContextBlock{
Kind: "tools", Tokens: breakdown.ToolTokens, CacheClass: "stable_prefix",
Authority: "capability", Reason: "currently permitted and selected tool definitions",
})
}
if breakdown.MessageTokens > 0 {
breakdown.Blocks = append(breakdown.Blocks, ContextBlock{
Kind: "conversation", Tokens: breakdown.MessageTokens, CacheClass: "dynamic_tail",
Authority: "transcript", Reason: "valid provider replay history and current task context",
})
}
if contextWindow > 0 {
breakdown.UsedFraction = float64(breakdown.TotalTokens) / float64(contextWindow)
}
@@ -32,6 +32,9 @@ func TestMeasureContextSplitsByCategory(t *testing.T) {
if breakdown.UsedFraction != wantFraction {
t.Fatalf("UsedFraction = %v, want %v", breakdown.UsedFraction, wantFraction)
}
if len(breakdown.Blocks) != 3 {
t.Fatalf("Blocks = %#v, want system/tools/conversation", breakdown.Blocks)
}
}
func TestMeasureContextUnknownWindowHasZeroFraction(t *testing.T) {
+183
View File
@@ -0,0 +1,183 @@
package agent
import (
"strings"
"github.com/Gitlawb/zero/internal/zeroruntime"
)
type contextPlannerConfig struct {
contextWindow int
promptCacheKey string
promptParts systemPromptParts
}
// contextPlanner is the single seam for constructing model-visible requests.
// Planning is deterministic and does not retrieve content, execute tools, or
// change permissions. The initial implementation deliberately preserves every
// message and tool definition while making composition and cache drift
// inspectable; later selection policies must continue to cross this seam.
type contextPlanner struct {
config contextPlannerConfig
previousPrefix prefixFingerprint
hasPrevious bool
toolSnapshotKey string
toolSnapshot []zeroruntime.ToolDefinition
}
type contextPlan struct {
Request zeroruntime.CompletionRequest
Breakdown ContextBreakdown
PrefixFingerprint prefixFingerprint
}
func newContextPlanner(config contextPlannerConfig) *contextPlanner {
return &contextPlanner{config: config}
}
// Plan returns a provider request snapshot plus content-free accounting.
// It intentionally performs no relevance filtering: preserving current model
// capability is the baseline contract for future planner policies.
func (planner *contextPlanner) Plan(messages []zeroruntime.Message, toolDefs []zeroruntime.ToolDefinition, reasoningEffort string) contextPlan {
return planner.plan(messages, toolDefs, reasoningEffort, planner.config.promptParts)
}
// planWithPromptParts plans a request whose stable system sections differ from
// the planner's configured main-run prompt, such as a compaction summary call.
func (planner *contextPlanner) planWithPromptParts(messages []zeroruntime.Message, toolDefs []zeroruntime.ToolDefinition, reasoningEffort string, parts systemPromptParts) contextPlan {
return planner.plan(messages, toolDefs, reasoningEffort, parts)
}
func (planner *contextPlanner) plan(messages []zeroruntime.Message, toolDefs []zeroruntime.ToolDefinition, reasoningEffort string, parts systemPromptParts) contextPlan {
requestMessages := copyMessages(messages)
requestSystemPrompt := leadingSystemContent(requestMessages)
if parts.prompt != requestSystemPrompt {
// Component boundaries from a different request would make the detailed
// invalidation reason misleading. Retain the exact request prefix and
// classify it conservatively as an unstructured system prompt instead.
parts = systemPromptParts{prompt: requestSystemPrompt}
}
fingerprint := computePrefixFingerprint(buildPromptSubstringsFromParts(parts, toolDefs))
request := zeroruntime.CompletionRequest{
Messages: requestMessages,
Tools: planner.snapshotTools(toolDefs, fingerprint),
ReasoningEffort: reasoningEffort,
PromptCacheKey: planner.config.promptCacheKey,
}
breakdown := MeasureContext(request.Messages, request.Tools, planner.config.contextWindow)
breakdown.CompletePrefixHash = fingerprint.CompletePrefixHash
var previous *prefixFingerprint
if planner.hasPrevious {
previous = &planner.previousPrefix
}
breakdown.PrefixInvalidationReason = explainPrefixChange(previous, fingerprint)
planner.previousPrefix = fingerprint
planner.hasPrevious = true
return contextPlan{
Request: request,
Breakdown: breakdown,
PrefixFingerprint: fingerprint,
}
}
// snapshotTools freezes provider-visible tool definitions when their semantic
// fingerprint changes. Stable turns reuse the frozen schemas instead of
// recursively cloning every map and slice for every request.
func (planner *contextPlanner) snapshotTools(toolDefs []zeroruntime.ToolDefinition, fingerprint prefixFingerprint) []zeroruntime.ToolDefinition {
key := fingerprint.ToolsHash + "\x00" + fingerprint.SchemaHash
if planner.toolSnapshotKey != key {
planner.toolSnapshot = copyToolDefinitions(toolDefs)
planner.toolSnapshotKey = key
}
return planner.toolSnapshot
}
func copyToolDefinitions(toolDefs []zeroruntime.ToolDefinition) []zeroruntime.ToolDefinition {
if toolDefs == nil {
return nil
}
copied := make([]zeroruntime.ToolDefinition, len(toolDefs))
for index, definition := range toolDefs {
copied[index] = definition
copied[index].Parameters = copySchemaMap(definition.Parameters)
}
return copied
}
func copySchemaMap(schema map[string]any) map[string]any {
if schema == nil {
return nil
}
copied := make(map[string]any, len(schema))
for key, value := range schema {
copied[key] = copySchemaValue(value)
}
return copied
}
func copySchemaValue(value any) any {
switch typed := value.(type) {
case map[string]any:
return copySchemaMap(typed)
case []any:
copied := make([]any, len(typed))
for index, item := range typed {
copied[index] = copySchemaValue(item)
}
return copied
case []string:
return append([]string(nil), typed...)
default:
return value
}
}
func leadingSystemContent(messages []zeroruntime.Message) string {
contents := make([]string, 0, 1)
for _, message := range messages {
if message.Role != zeroruntime.MessageRoleSystem {
break
}
contents = append(contents, message.Content)
}
return strings.Join(contents, "\n\n")
}
func explainPrefixChange(previous *prefixFingerprint, current prefixFingerprint) string {
if previous == nil {
return "initial"
}
if previous.CompletePrefixHash == current.CompletePrefixHash {
return "unchanged"
}
reasons := make([]string, 0, 3)
if previous.SystemPromptHash != current.SystemPromptHash {
parts := make([]string, 0, 4)
if previous.BaseInstructionsHash != current.BaseInstructionsHash {
parts = append(parts, "base_instructions")
}
if previous.ConfirmationPolicyHash != current.ConfirmationPolicyHash {
parts = append(parts, "confirmation_policy")
}
if previous.ProjectContextHash != current.ProjectContextHash {
parts = append(parts, "project_context")
}
if previous.SkillsHash != current.SkillsHash {
parts = append(parts, "skills")
}
if len(parts) == 0 {
parts = append(parts, "system_prompt")
}
reasons = append(reasons, parts...)
}
if previous.ToolsHash != current.ToolsHash {
reasons = append(reasons, "tools")
}
if previous.SchemaHash != current.SchemaHash {
reasons = append(reasons, "schema")
}
if len(reasons) == 0 {
return "prefix_changed"
}
return strings.Join(reasons, ",")
}
+185
View File
@@ -0,0 +1,185 @@
package agent
import (
"reflect"
"testing"
"github.com/Gitlawb/zero/internal/zeroruntime"
)
func TestContextPlannerPreservesProviderRequest(t *testing.T) {
messages := []zeroruntime.Message{
{Role: zeroruntime.MessageRoleSystem, Content: "system"},
{Role: zeroruntime.MessageRoleUser, Content: "inspect this", Images: []zeroruntime.ImageBlock{{MediaType: "image/png", Data: []byte{1, 2, 3}}}},
{Role: zeroruntime.MessageRoleAssistant, Content: "working", ToolCalls: []zeroruntime.ToolCall{{ID: "call-1", Name: "read_file", Arguments: `{"path":"main.go"}`}}, Reasoning: []zeroruntime.ReasoningBlock{{Provider: "test", Type: "thinking", Signature: "sig"}}},
}
toolDefs := []zeroruntime.ToolDefinition{{
Name: "read_file", Description: "Read a file",
Parameters: map[string]any{
"type": "object",
"required": []string{"path"},
"properties": map[string]any{"path": map[string]any{"type": "string"}},
"anyOf": []any{map[string]any{"type": "object"}},
},
}}
planner := newContextPlanner(contextPlannerConfig{
contextWindow: 128_000,
promptCacheKey: "session-1",
promptParts: systemPromptParts{prompt: "system", baseInstructions: "system"},
})
plan := planner.Plan(messages, toolDefs, "medium")
want := zeroruntime.CompletionRequest{
Messages: copyMessages(messages),
Tools: toolDefs,
ReasoningEffort: "medium",
PromptCacheKey: "session-1",
}
if !reflect.DeepEqual(plan.Request, want) {
t.Fatalf("planned request changed provider input:\n got: %#v\nwant: %#v", plan.Request, want)
}
stable := planner.Plan(messages, toolDefs, "medium")
if &stable.Request.Tools[0] != &plan.Request.Tools[0] {
t.Fatal("stable tool fingerprint rebuilt the immutable schema snapshot")
}
// A plan owns its request snapshot; later caller mutation cannot change its
// messages or its recursively nested tool schema.
messages[1].Content = "changed"
messages[1].Images[0].Data[0] = 9
toolDefs[0].Name = "changed_tool"
toolDefs[0].Parameters["required"].([]string)[0] = "other"
toolDefs[0].Parameters["properties"].(map[string]any)["path"].(map[string]any)["type"] = "integer"
toolDefs[0].Parameters["anyOf"].([]any)[0].(map[string]any)["type"] = "array"
if plan.Request.Messages[1].Content != "inspect this" || plan.Request.Messages[1].Images[0].Data[0] != 1 {
t.Fatalf("planned messages alias caller state: %#v", plan.Request.Messages[1])
}
if plan.Request.Tools[0].Name != "read_file" ||
plan.Request.Tools[0].Parameters["required"].([]string)[0] != "path" ||
plan.Request.Tools[0].Parameters["properties"].(map[string]any)["path"].(map[string]any)["type"] != "string" ||
plan.Request.Tools[0].Parameters["anyOf"].([]any)[0].(map[string]any)["type"] != "object" {
t.Fatalf("planned tools alias caller state: %#v", plan.Request.Tools[0])
}
next := planner.Plan(messages, toolDefs, "medium")
if next.PrefixFingerprint == plan.PrefixFingerprint || next.Request.Tools[0].Name != "changed_tool" {
t.Fatalf("changed tool schema did not refresh snapshot: %#v", next)
}
if plan.Request.Tools[0].Name != "read_file" {
t.Fatalf("refresh mutated earlier request: %#v", plan.Request.Tools[0])
}
}
func TestContextPlannerReportsInspectableBlocks(t *testing.T) {
planner := newContextPlanner(contextPlannerConfig{contextWindow: 100_000})
plan := planner.Plan([]zeroruntime.Message{
{Role: zeroruntime.MessageRoleSystem, Content: filler(400)},
{Role: zeroruntime.MessageRoleUser, Content: filler(200)},
}, []zeroruntime.ToolDefinition{{Name: "read_file", Description: "Read a file"}}, "")
if plan.Breakdown.PrefixInvalidationReason != "initial" || plan.Breakdown.CompletePrefixHash == "" {
t.Fatalf("prefix evidence = %#v", plan.Breakdown)
}
if len(plan.Breakdown.Blocks) != 3 {
t.Fatalf("blocks = %#v, want system/tools/conversation", plan.Breakdown.Blocks)
}
wantKinds := []string{"system", "tools", "conversation"}
total := 0
for index, block := range plan.Breakdown.Blocks {
if block.Kind != wantKinds[index] || block.Tokens <= 0 || block.Reason == "" || block.Authority == "" || block.CacheClass == "" {
t.Fatalf("block %d = %#v", index, block)
}
total += block.Tokens
}
if total != plan.Breakdown.TotalTokens {
t.Fatalf("block tokens = %d, want total %d", total, plan.Breakdown.TotalTokens)
}
}
func TestContextPlannerFingerprintsActualRequestSystemPrompt(t *testing.T) {
planner := newContextPlanner(contextPlannerConfig{promptParts: systemPromptParts{
prompt: "configured system", baseInstructions: "configured system",
}})
messages := []zeroruntime.Message{
{Role: zeroruntime.MessageRoleSystem, Content: "request-specific system"},
{Role: zeroruntime.MessageRoleUser, Content: "task"},
}
plan := planner.Plan(messages, nil, "")
want := computePrefixFingerprint(buildPromptSubstringsFromParts(
systemPromptParts{prompt: "request-specific system"}, nil,
))
if plan.PrefixFingerprint != want {
t.Fatalf("fingerprint describes configured prompt instead of request:\n got: %#v\nwant: %#v", plan.PrefixFingerprint, want)
}
}
func TestContextPlannerExplainsPrefixInvalidation(t *testing.T) {
planner := newContextPlanner(contextPlannerConfig{promptParts: systemPromptParts{
prompt: "system", baseInstructions: "base", projectContext: "project",
}})
messages := []zeroruntime.Message{{Role: zeroruntime.MessageRoleSystem, Content: "system"}, {Role: zeroruntime.MessageRoleUser, Content: "task"}}
tools := []zeroruntime.ToolDefinition{{Name: "read_file", Description: "Read", Parameters: map[string]any{"type": "object"}}}
if got := planner.Plan(messages, tools, "").Breakdown.PrefixInvalidationReason; got != "initial" {
t.Fatalf("first reason = %q, want initial", got)
}
if got := planner.Plan(messages, tools, "").Breakdown.PrefixInvalidationReason; got != "unchanged" {
t.Fatalf("stable reason = %q, want unchanged", got)
}
tools[0].Description = "Read an exact file"
if got := planner.Plan(messages, tools, "").Breakdown.PrefixInvalidationReason; got != "tools" {
t.Fatalf("tool reason = %q, want tools", got)
}
tools[0].Parameters["required"] = []any{"path"}
if got := planner.Plan(messages, tools, "").Breakdown.PrefixInvalidationReason; got != "schema" {
t.Fatalf("schema reason = %q, want schema", got)
}
planner.config.promptParts.prompt = "system with changed project"
planner.config.promptParts.projectContext = "changed project"
messages[0].Content = "system with changed project"
if got := planner.Plan(messages, tools, "").Breakdown.PrefixInvalidationReason; got != "project_context" {
t.Fatalf("project reason = %q, want project_context", got)
}
}
func TestExplainPrefixChangeNamesEveryChangedComponent(t *testing.T) {
baseline := prefixFingerprint{
SystemPromptHash: "system",
BaseInstructionsHash: "base",
ConfirmationPolicyHash: "policy",
ProjectContextHash: "project",
SkillsHash: "skills",
ToolsHash: "tools",
SchemaHash: "schema",
CompletePrefixHash: "complete",
}
tests := []struct {
name string
mutate func(*prefixFingerprint)
want string
}{
{name: "base instructions", mutate: func(value *prefixFingerprint) {
value.SystemPromptHash, value.BaseInstructionsHash = "changed", "changed"
}, want: "base_instructions"},
{name: "confirmation policy", mutate: func(value *prefixFingerprint) {
value.SystemPromptHash, value.ConfirmationPolicyHash = "changed", "changed"
}, want: "confirmation_policy"},
{name: "project context", mutate: func(value *prefixFingerprint) {
value.SystemPromptHash, value.ProjectContextHash = "changed", "changed"
}, want: "project_context"},
{name: "skills", mutate: func(value *prefixFingerprint) { value.SystemPromptHash, value.SkillsHash = "changed", "changed" }, want: "skills"},
{name: "unclassified system prompt", mutate: func(value *prefixFingerprint) { value.SystemPromptHash = "changed" }, want: "system_prompt"},
{name: "tools and schema", mutate: func(value *prefixFingerprint) { value.ToolsHash, value.SchemaHash = "changed", "changed" }, want: "tools,schema"},
}
for _, test := range tests {
t.Run(test.name, func(t *testing.T) {
current := baseline
test.mutate(&current)
current.CompletePrefixHash = "changed"
if got := explainPrefixChange(&baseline, current); got != test.want {
t.Fatalf("reason = %q, want %q", got, test.want)
}
})
}
}
+47 -56
View File
@@ -183,6 +183,11 @@ func Run(ctx context.Context, prompt string, provider Provider, options Options)
defer runPermissions.cleanup()
promptParts := buildSystemPromptParts(options)
planner := newContextPlanner(contextPlannerConfig{
contextWindow: options.ContextWindow,
promptCacheKey: options.SessionID,
promptParts: promptParts,
})
messages := zeroruntime.SeedMessagesWithImages(promptParts.prompt, prompt, options.Images)
guards := newGuardState()
@@ -282,42 +287,15 @@ func Run(ctx context.Context, prompt string, provider Provider, options Options)
exposed, _ := partitionToolsCached(registry, permissionMode, options, loaded, toolDefCache)
toolPartitionSpan.End()
// Fingerprint the exact system prompt built at run start plus this turn's
// provider-visible tool definitions in their emitted order. Reusing the
// retained prompt parts avoids rebuilding workspace context while ensuring
// the trace describes the same bytes carried by the request.
if options.Trace != nil {
fp := computePrefixFingerprint(buildPromptSubstringsFromParts(promptParts, exposed))
options.Trace.EmitPrefixHash(trace.PrefixHash{
SystemPromptHash: fp.SystemPromptHash,
BaseInstructionsHash: fp.BaseInstructionsHash,
ConfirmationPolicyHash: fp.ConfirmationPolicyHash,
ProjectContextHash: fp.ProjectContextHash,
SkillsHash: fp.SkillsHash,
ToolsHash: fp.ToolsHash,
SchemaHash: fp.SchemaHash,
CompletePrefixHash: fp.CompletePrefixHash,
})
}
// PROACTIVE compaction: if the history is approaching the model's
// context window, summarize the oldest middle before building the
// request. A no-op when ContextWindow == 0 (compaction disabled).
compactionSpan := options.Trace.Span(trace.SpanCompaction)
messages = compactor.maybeCompact(ctx, provider, messages, exposed)
compactionSpan.End()
request := zeroruntime.CompletionRequest{
Messages: copyMessages(messages),
Tools: exposed,
ReasoningEffort: options.ReasoningEffort,
PromptCacheKey: options.SessionID,
}
// Report the per-category context budget for this turn so a surface can
// show utilization. Opt-in: a no-op when OnContext is unset.
if options.OnContext != nil {
options.OnContext(MeasureContext(messages, request.Tools, options.ContextWindow))
}
plan := planner.Plan(messages, exposed, options.ReasoningEffort)
request := plan.Request
recordContextPlan(options, plan)
// A transient upstream disconnect on the initial connect is retried with
// backoff (before any content is forwarded, so no OnText is duplicated);
@@ -342,12 +320,9 @@ func Run(ctx context.Context, prompt string, provider Provider, options Options)
// on registry+loaded, not on the messages, so they stay valid after
// compaction. Using the bare toolDefinitions here would route through an
// empty-loaded partition, re-hiding every already-loaded deferred tool.
request = zeroruntime.CompletionRequest{
Messages: copyMessages(messages),
Tools: exposed,
ReasoningEffort: options.ReasoningEffort,
PromptCacheKey: options.SessionID,
}
retryPlan := planner.Plan(messages, exposed, options.ReasoningEffort)
request = retryPlan.Request
recordContextPlan(options, retryPlan)
// Pre-content connect after a context-limit compaction: route through the
// reconnect helper so a transient upstream hiccup here doesn't fail the
// whole run and re-burn every token (AUDIT-L1).
@@ -431,12 +406,9 @@ func Run(ctx context.Context, prompt string, provider Provider, options Options)
// Reuse the SAME active-mode partition (exposed) from this turn rather
// than the bare toolDefinitions: exposed depends on registry+loaded (not
// the messages), so it stays valid after compaction.
retryRequest := zeroruntime.CompletionRequest{
Messages: copyMessages(messages),
Tools: exposed,
ReasoningEffort: options.ReasoningEffort,
PromptCacheKey: options.SessionID,
}
retryPlan := planner.Plan(messages, exposed, options.ReasoningEffort)
retryRequest := retryPlan.Request
recordContextPlan(options, retryPlan)
retryStream, retryStreamErr := streamWithReconnect(ctx, provider, retryRequest, reconnectNoticeFor(options))
if retryStreamErr != nil {
return collected, retryStreamErr
@@ -494,12 +466,9 @@ func Run(ctx context.Context, prompt string, provider Provider, options Options)
result.Messages = copyMessages(messages)
return result, err
}
retryRequest := zeroruntime.CompletionRequest{
Messages: copyMessages(messages),
Tools: exposed,
ReasoningEffort: options.ReasoningEffort,
PromptCacheKey: options.SessionID,
}
retryPlan := planner.Plan(messages, exposed, options.ReasoningEffort)
retryRequest := retryPlan.Request
recordContextPlan(options, retryPlan)
retryStream, retryErr := streamWithReconnect(ctx, provider, retryRequest, reconnectNoticeFor(options))
if retryErr != nil {
result.Messages = copyMessages(messages)
@@ -929,7 +898,7 @@ func Run(ctx context.Context, prompt string, provider Provider, options Options)
})
}
finalExposed, _ := partitionToolsCached(registry, permissionMode, options, loaded, toolDefCache)
if answer, finalMessages, finishReason := finalAnswerAfterMaxTurns(ctx, provider, messages, finalExposed, options); strings.TrimSpace(answer) != "" {
if answer, finalMessages, finishReason := finalAnswerAfterMaxTurns(ctx, provider, planner, messages, finalExposed, options); strings.TrimSpace(answer) != "" {
result.FinalAnswer = answer
result.FinishReason = finishReason
result.Messages = copyMessages(finalMessages)
@@ -971,7 +940,32 @@ func recordOutputBudgetTrace(recorder *trace.Recorder, result ToolResult) {
})
}
func finalAnswerAfterMaxTurns(ctx context.Context, provider Provider, messages []zeroruntime.Message, toolDefs []zeroruntime.ToolDefinition, options Options) (string, []zeroruntime.Message, string) {
func recordContextPlan(options Options, plan contextPlan) {
recordContextPlanTrace(options.Trace, plan)
if options.OnContext != nil {
options.OnContext(plan.Breakdown)
}
}
func recordContextPlanTrace(recorder *trace.Recorder, plan contextPlan) {
if recorder == nil {
return
}
fingerprint := plan.PrefixFingerprint
recorder.EmitPrefixHash(trace.PrefixHash{
SystemPromptHash: fingerprint.SystemPromptHash,
BaseInstructionsHash: fingerprint.BaseInstructionsHash,
ConfirmationPolicyHash: fingerprint.ConfirmationPolicyHash,
ProjectContextHash: fingerprint.ProjectContextHash,
SkillsHash: fingerprint.SkillsHash,
ToolsHash: fingerprint.ToolsHash,
SchemaHash: fingerprint.SchemaHash,
CompletePrefixHash: fingerprint.CompletePrefixHash,
InvalidationReason: plan.Breakdown.PrefixInvalidationReason,
})
}
func finalAnswerAfterMaxTurns(ctx context.Context, provider Provider, planner *contextPlanner, messages []zeroruntime.Message, toolDefs []zeroruntime.ToolDefinition, options Options) (string, []zeroruntime.Message, string) {
finalMessages := copyMessages(messages)
finalMessages = append(finalMessages, zeroruntime.Message{
Role: zeroruntime.MessageRoleUser,
@@ -980,12 +974,9 @@ func finalAnswerAfterMaxTurns(ctx context.Context, provider Provider, messages [
// The max-turns final-answer call is a pre-content connect, often after a long
// autonomous/cron run — route it through the reconnect helper so a single
// transient hiccup doesn't drop the final summary (AUDIT-L1).
stream, err := streamWithReconnect(ctx, provider, zeroruntime.CompletionRequest{
Messages: copyMessages(finalMessages),
Tools: toolDefs,
ReasoningEffort: options.ReasoningEffort,
PromptCacheKey: options.SessionID,
}, reconnectNoticeFor(options))
plan := planner.Plan(finalMessages, toolDefs, options.ReasoningEffort)
recordContextPlan(options, plan)
stream, err := streamWithReconnect(ctx, provider, plan.Request, reconnectNoticeFor(options))
if err != nil {
return "", messages, ""
}
+12
View File
@@ -3729,6 +3729,8 @@ func TestRunTracingWrapperStampsUsage(t *testing.T) {
{Type: zeroruntime.StreamEventDone},
}}}
onUsageCalls := 0
onContextCalls := 0
var contextPlan ContextBreakdown
rec := trace.NewRecorder("tracing-session", "run-1", "test")
if _, err := Run(context.Background(), "hi", provider, Options{
SessionID: "tracing-session",
@@ -3737,6 +3739,10 @@ func TestRunTracingWrapperStampsUsage(t *testing.T) {
Model: "test-model",
Trace: rec,
OnUsage: func(Usage) { onUsageCalls++ },
OnContext: func(breakdown ContextBreakdown) {
onContextCalls++
contextPlan = breakdown
},
}); err != nil {
t.Fatalf("Run: %v", err)
}
@@ -3763,6 +3769,12 @@ func TestRunTracingWrapperStampsUsage(t *testing.T) {
if onUsageCalls == 0 {
t.Fatal("wrapped OnUsage did not forward to the caller's callback")
}
if onContextCalls != 1 || len(contextPlan.Blocks) != 2 || contextPlan.PrefixInvalidationReason != "initial" {
t.Fatalf("context plan callback = calls %d, plan %#v", onContextCalls, contextPlan)
}
if len(tr.PrefixHashes) != 1 || tr.PrefixHashes[0].InvalidationReason != "initial" || tr.PrefixHashes[0].CompletePrefixHash != contextPlan.CompletePrefixHash {
t.Fatalf("trace context evidence = %#v, plan %#v", tr.PrefixHashes, contextPlan)
}
}
// TestRunNilTraceForwardsUsage verifies a nil recorder leaves the loop
+5 -3
View File
@@ -333,9 +333,11 @@ type Options struct {
// specialist child process emits while running. The toolCallID identifies
// which Task tool call the progress belongs to. nil is a no-op.
OnToolProgress func(toolCallID string, event streamjson.Event)
// OnContext, when set, is called once per turn with the per-category context
// budget of the request about to be sent, so a surface (TUI/CLI) can show
// context utilization. Opt-in like the other callbacks; nil is a no-op.
// OnContext, when set, is called for each main agent request with its
// per-category context budget, including a replacement request after
// compaction or a stall retry. Internal summarizer requests are excluded so
// surfaces keep showing the active conversation budget. Opt-in like the other
// callbacks; nil is a no-op.
OnContext func(ContextBreakdown)
// ModelSwitcher, when set, lets a tool escalate the run to a stronger model
// mid-run: the loop calls it with the requested model id and, on success,
+11 -7
View File
@@ -86,16 +86,16 @@ func WriteNDJSON(w io.Writer, t *TurnTrace) error {
}
}
// Prefix fingerprints are emitted after counters in insertion (turn)
// Prefix fingerprints are emitted after counters in insertion (request)
// order. The order is the order EmitPrefixHash was called, which is the
// order the agent loop computed each turn's fingerprint, which is the
// order a downstream consumer needs to correlate a prefix_hash event
// with the cached_input_tokens counter for that turn. Sorting by
// complete_prefix hash would destroy that correlation, so we do not
// order the agent computed each request's fingerprint, which is the
// order a downstream consumer needs to reconstruct prefix changes across
// main, compaction, and retry requests. Sorting by complete_prefix hash would
// destroy that sequence, so we do not
// sort. The slice is already a deep copy from Finish (see
// Recorder.Finish) so it is safe to range over without copying.
for _, p := range t.PrefixHashes {
if err := enc.Encode(map[string]any{
obj := map[string]any{
"type": "prefix_hash",
"system_prompt": p.SystemPromptHash,
"base_instructions": p.BaseInstructionsHash,
@@ -105,7 +105,11 @@ func WriteNDJSON(w io.Writer, t *TurnTrace) error {
"tools": p.ToolsHash,
"schema": p.SchemaHash,
"complete_prefix": p.CompletePrefixHash,
}); err != nil {
}
if p.InvalidationReason != "" {
obj["invalidation_reason"] = p.InvalidationReason
}
if err := enc.Encode(obj); err != nil {
return err
}
}
+1
View File
@@ -116,6 +116,7 @@ func ReadNDJSON(r io.Reader) (*TurnTrace, error) {
ToolsHash: stringField(obj, "tools"),
SchemaHash: stringField(obj, "schema"),
CompletePrefixHash: stringField(obj, "complete_prefix"),
InvalidationReason: stringField(obj, "invalidation_reason"),
})
case "output_budget":
if !sawTraceHeader {
+3 -3
View File
@@ -177,9 +177,9 @@ func (r *Recorder) StampFirstUsefulAction() {
}
// EmitPrefixHash records one prompt-prefix fingerprint on the trace. Multiple
// calls are allowed within a run (one per turn, typically) and accumulate in
// order. The first call after Finish is a no-op; later calls are also no-ops
// because the trace has been sealed.
// calls are allowed within a run (one per planned provider request) and
// accumulate in request order. The first call after Finish is a no-op; later
// calls are also no-ops because the trace has been sealed.
func (r *Recorder) EmitPrefixHash(p PrefixHash) {
if r == nil {
return
+1
View File
@@ -159,6 +159,7 @@ type PrefixHash struct {
ToolsHash string `json:"tools"`
SchemaHash string `json:"schema"`
CompletePrefixHash string `json:"complete_prefix"`
InvalidationReason string `json:"invalidation_reason,omitempty"`
}
// WallDuration is the total traced wall time of the run.
+36 -2
View File
@@ -382,6 +382,7 @@ func TestReadNDJSONRoundTrip(t *testing.T) {
ToolsHash: "t1",
SchemaHash: "x1",
CompletePrefixHash: "complete1",
InvalidationReason: "initial",
})
r.EmitPrefixHash(PrefixHash{
SystemPromptHash: "system2",
@@ -392,6 +393,7 @@ func TestReadNDJSONRoundTrip(t *testing.T) {
ToolsHash: "t2",
SchemaHash: "x2",
CompletePrefixHash: "complete2",
InvalidationReason: "tools",
})
original := r.Finish()
@@ -421,8 +423,8 @@ func TestReadNDJSONRoundTrip(t *testing.T) {
if parsed.FirstTokenAt.IsZero() {
t.Fatal("first_token_at lost in round-trip")
}
// prefix_hash round-trip: two events, in insertion order, with all
// seven sub-hash fields preserved exactly.
// prefix_hash round-trip: two events, in insertion order, with all hash
// fields and the invalidation reason preserved exactly.
if len(parsed.PrefixHashes) != 2 {
t.Fatalf("expected 2 prefix_hash events after round-trip, got %d", len(parsed.PrefixHashes))
}
@@ -435,6 +437,38 @@ func TestReadNDJSONRoundTrip(t *testing.T) {
if parsed.PrefixHashes[1].SystemPromptHash != "system2" || parsed.PrefixHashes[1].BaseInstructionsHash != "b2" || parsed.PrefixHashes[1].SchemaHash != "x2" {
t.Fatalf("prefix_hash sub-hashes lost on second event: got %+v", parsed.PrefixHashes[1])
}
if parsed.PrefixHashes[0].InvalidationReason != "initial" || parsed.PrefixHashes[1].InvalidationReason != "tools" {
t.Fatalf("prefix invalidation reasons lost: %+v", parsed.PrefixHashes)
}
}
func TestWriteNDJSONOmitsEmptyPrefixInvalidationReason(t *testing.T) {
recorder := NewRecorder("session", "run", "test")
recorder.Start()
recorder.EmitPrefixHash(PrefixHash{CompletePrefixHash: "stable"})
tr := recorder.Finish()
var output bytes.Buffer
if err := WriteNDJSON(&output, tr); err != nil {
t.Fatalf("WriteNDJSON: %v", err)
}
found := false
for _, line := range strings.Split(strings.TrimSpace(output.String()), "\n") {
var event map[string]any
if err := json.Unmarshal([]byte(line), &event); err != nil {
t.Fatalf("decode event: %v", err)
}
if event["type"] != "prefix_hash" {
continue
}
found = true
if _, exists := event["invalidation_reason"]; exists {
t.Fatalf("empty invalidation reason should be omitted: %s", line)
}
}
if !found {
t.Fatal("prefix_hash event not written")
}
}
func TestReadNDJSONRejectsNonTrace(t *testing.T) {