v0.51.0 a9d674e

resident_history_test.go RawHistoryFolder

1package subagents
2
3import (
4	"context"
5	"encoding/json"
6	"os"
7	"path/filepath"
8	"strings"
9	"testing"
10
11	"github.com/bnema/zut/packages/core"
12	"github.com/bnema/zut/packages/provider"
13)
14
15func TestReadResidentHistoryPageIncludesRepetitionGuardNotice(t *testing.T) {
16	root := t.TempDir()
17	journal, err := OpenResidentJournal(root, "guard-child")
18	if err != nil {
19		t.Fatal(err)
20	}
21	spec := ResidentChildSpec{ID: "guard-child", SessionID: "guard-session", Provider: "openai", Model: "test"}
22	if err := journal.Accept(spec, "task"); err != nil {
23		t.Fatal(err)
24	}
25	if err := journal.RecordAgentEvent(core.EvRepetitionGuard{
26		Kind: core.RepetitionKindToolCall, Stage: core.RepetitionGuardWarning, Count: 5,
27	}); err != nil {
28		t.Fatal(err)
29	}
30	if err := journal.Close(); err != nil {
31		t.Fatal(err)
32	}
33
34	page, err := ReadResidentHistoryPage(filepath.Join(root, spec.ID), "", 10)
35	if err != nil {
36		t.Fatal(err)
37	}
38	if len(page.Items) != 1 || page.Items[0].Type != residentRecordGuard || page.Items[0].Outcome != string(core.RepetitionGuardWarning) || page.Items[0].GuardCount != 5 || page.Items[0].GuardKind != string(core.RepetitionKindToolCall) {
39		t.Fatalf("history items = %#v, want repetition guard warning", page.Items)
40	}
41}
42
43func TestReadResidentHistoryReturnsCompleteFinalizedItems(t *testing.T) {
44	root := t.TempDir()
45	journal, err := OpenResidentJournal(root, "history-child")
46	if err != nil {
47		t.Fatal(err)
48	}
49	spec := ResidentChildSpec{ID: "history-child", SessionID: "history-session", Provider: "openai", Model: "gpt-5"}
50	if err := journal.Accept(spec, "task"); err != nil {
51		t.Fatal(err)
52	}
53	if err := journal.RecordAgentEvent(core.EvUserMessage{Message: provider.Message{Role: provider.RoleUser, Content: []provider.Content{provider.TextBlock{Text: "question"}}}}); err != nil {
54		t.Fatal(err)
55	}
56	if err := journal.RecordAgentEvent(core.EvToolCall{ID: "call-1", Name: "bash", Args: json.RawMessage(`{"command":"pwd"}`)}); err != nil {
57		t.Fatal(err)
58	}
59	if err := journal.RecordAgentEvent(core.EvToolResult{ID: "call-1", Result: core.ToolResult{Content: []provider.Content{provider.TextBlock{Text: "/repo"}}}}); err != nil {
60		t.Fatal(err)
61	}
62	if err := journal.Close(); err != nil {
63		t.Fatal(err)
64	}
65	history, err := ReadResidentHistory(filepath.Join(root, spec.ID), 10)
66	if err != nil {
67		t.Fatal(err)
68	}
69	if len(history) != 3 || history[1].ToolName != "bash" || string(history[1].ToolArgs) != `{"command":"pwd"}` || len(history[2].ToolResult) == 0 {
70		t.Fatalf("history = %#v", history)
71	}
72	if _, err := ResidentHistoryDir(root, "../escape"); err == nil {
73		t.Fatal("ResidentHistoryDir accepted traversal")
74	}
75}
76
77func TestResidentHistoryMessagesRestoresToolCallsAndResults(t *testing.T) {
78	assistant, err := json.Marshal(provider.Message{Role: provider.RoleAssistant, Content: []provider.Content{provider.ToolCallBlock{ID: "call-1", Name: "bash", Arguments: json.RawMessage(`{"command":"pwd"}`)}}})
79	if err != nil {
80		t.Fatal(err)
81	}
82	result, err := json.Marshal(core.ToolResult{Content: []provider.Content{provider.TextBlock{Text: "/repo"}}})
83	if err != nil {
84		t.Fatal(err)
85	}
86	messages, err := ResidentHistoryMessages([]ResidentHistoryItem{
87		{Type: residentRecordAssistant, Message: assistant},
88		{Type: residentRecordToolCall, ToolID: "call-1", ToolName: "bash", ToolArgs: json.RawMessage(`{"command":"pwd"}`)},
89		{Type: residentRecordToolResult, ToolID: "call-1", ToolResult: result},
90	})
91	if err != nil {
92		t.Fatal(err)
93	}
94	if len(messages) != 2 {
95		t.Fatalf("messages = %#v", messages)
96	}
97	call, ok := messages[0].Content[0].(provider.ToolCallBlock)
98	if !ok || call.ID != "call-1" {
99		t.Fatalf("assistant call = %#v", messages[0])
100	}
101	tool, ok := messages[1].Content[0].(provider.ToolResultBlock)
102	if !ok || tool.CallID != "call-1" || len(tool.Content) != 1 {
103		t.Fatalf("tool message = %#v", messages[1])
104	}
105}
106
107func TestReadResidentTranscriptMessagesRestoresFinalizedConversation(t *testing.T) {
108	root := t.TempDir()
109	journal, err := OpenResidentJournal(root, "transcript")
110	if err != nil {
111		t.Fatal(err)
112	}
113	spec := ResidentChildSpec{ID: "transcript", SessionID: "session", Provider: "openai", Model: "gpt-5"}
114	if err := journal.Accept(spec, "task"); err != nil {
115		t.Fatal(err)
116	}
117	if err := journal.RecordAgentEvent(core.EvUserMessage{Message: provider.Message{Role: provider.RoleUser, Content: []provider.Content{provider.TextBlock{Text: "question"}}}}); err != nil {
118		t.Fatal(err)
119	}
120	if err := journal.Close(); err != nil {
121		t.Fatal(err)
122	}
123	messages, err := ReadResidentTranscriptMessages(filepath.Join(root, spec.ID))
124	if err != nil {
125		t.Fatal(err)
126	}
127	if len(messages) != 1 || messages[0].Role != provider.RoleUser {
128		t.Fatalf("messages = %#v", messages)
129	}
130}
131
132func TestReadResidentHistoryPageKeepsToolGroupsTogether(t *testing.T) {
133	root := t.TempDir()
134	journal, err := OpenResidentJournal(root, "history-page")
135	if err != nil {
136		t.Fatal(err)
137	}
138	spec := ResidentChildSpec{ID: "history-page", SessionID: "history-session", Provider: "openai", Model: "gpt-5"}
139	if err := journal.Accept(spec, "task"); err != nil {
140		t.Fatal(err)
141	}
142	for _, group := range []struct{ id, text string }{{"old", "old answer"}, {"new", "new answer"}} {
143		if err := journal.RecordAgentEvent(core.EvAssistantMessage{Message: provider.Message{Role: provider.RoleAssistant, Content: []provider.Content{provider.TextBlock{Text: group.text}}}}); err != nil {
144			t.Fatal(err)
145		}
146		if err := journal.RecordAgentEvent(core.EvToolCall{ID: group.id, Name: "bash", Args: json.RawMessage(`{"command":"pwd"}`)}); err != nil {
147			t.Fatal(err)
148		}
149		if err := journal.RecordAgentEvent(core.EvToolResult{ID: group.id, Result: core.ToolResult{Content: []provider.Content{provider.TextBlock{Text: "/repo"}}}}); err != nil {
150			t.Fatal(err)
151		}
152	}
153	if err := journal.Close(); err != nil {
154		t.Fatal(err)
155	}
156
157	page, err := ReadResidentHistoryPage(filepath.Join(root, spec.ID), "", 2)
158	if err != nil {
159		t.Fatal(err)
160	}
161	if len(page.Items) != 3 || page.Items[0].Type != residentRecordAssistant || page.Items[1].ToolID != "new" || page.Items[2].ToolID != "new" {
162		t.Fatalf("latest page split a tool group: %#v", page.Items)
163	}
164	if page.OlderCursor == "" {
165		t.Fatal("latest page has no cursor for the older group")
166	}
167	older, err := ReadResidentHistoryPage(filepath.Join(root, spec.ID), page.OlderCursor, 2)
168	if err != nil {
169		t.Fatal(err)
170	}
171	if len(older.Items) != 3 || older.Items[0].Type != residentRecordAssistant || older.Items[1].ToolID != "old" || older.Items[2].ToolID != "old" || older.OlderCursor != "" {
172		t.Fatalf("older page = %#v", older)
173	}
174}
175
176func TestReadResidentHistoryPageDefersIncompleteTailAndInvalidatesReplacedJournal(t *testing.T) {
177	root := t.TempDir()
178	journal, err := OpenResidentJournal(root, "history-cursor")
179	if err != nil {
180		t.Fatal(err)
181	}
182	spec := ResidentChildSpec{ID: "history-cursor", SessionID: "history-session", Provider: "openai", Model: "gpt-5"}
183	if err := journal.Accept(spec, "task"); err != nil {
184		t.Fatal(err)
185	}
186	if err := journal.RecordAgentEvent(core.EvUserMessage{Message: provider.Message{Role: provider.RoleUser, Content: []provider.Content{provider.TextBlock{Text: "saved"}}}}); err != nil {
187		t.Fatal(err)
188	}
189	if err := journal.RecordAgentEvent(core.EvUserMessage{Message: provider.Message{Role: provider.RoleUser, Content: []provider.Content{provider.TextBlock{Text: "newer"}}}}); err != nil {
190		t.Fatal(err)
191	}
192	if err := journal.Close(); err != nil {
193		t.Fatal(err)
194	}
195	path := filepath.Join(root, spec.ID, residentTranscriptName)
196	f, err := os.OpenFile(path, os.O_APPEND|os.O_WRONLY, 0o600)
197	if err != nil {
198		t.Fatal(err)
199	}
200	if _, err := f.WriteString(`{"type":"message.assistant"}`); err != nil {
201		t.Fatal(err)
202	}
203	if err := f.Close(); err != nil {
204		t.Fatal(err)
205	}
206	page, err := ReadResidentHistoryPage(filepath.Join(root, spec.ID), "", 1)
207	if err != nil {
208		t.Fatal(err)
209	}
210	if len(page.Items) != 1 || page.Items[0].Type != residentRecordUser {
211		t.Fatalf("incomplete tail leaked into page: %#v", page.Items)
212	}
213	if page.OlderCursor == "" {
214		t.Fatal("page has no cursor before replacement")
215	}
216
217	if err := os.WriteFile(path, []byte("{}\n"), 0o600); err != nil {
218		t.Fatal(err)
219	}
220	if _, err := ReadResidentHistoryPage(filepath.Join(root, spec.ID), page.OlderCursor, 10); err == nil {
221		t.Fatal("replaced journal cursor was accepted")
222	}
223}
224
225func TestReadResidentHistoryPageCursorSurvivesJournalAppend(t *testing.T) {
226	root := t.TempDir()
227	journal, err := OpenResidentJournal(root, "history-append")
228	if err != nil {
229		t.Fatal(err)
230	}
231	spec := ResidentChildSpec{ID: "history-append", SessionID: "history-session", Provider: "openai", Model: "gpt-5"}
232	if err := journal.Accept(spec, "task"); err != nil {
233		t.Fatal(err)
234	}
235	for _, text := range []string{"first", "second"} {
236		if err := journal.RecordAgentEvent(core.EvUserMessage{Message: provider.Message{Role: provider.RoleUser, Content: []provider.Content{provider.TextBlock{Text: text}}}}); err != nil {
237			t.Fatal(err)
238		}
239	}
240	if err := journal.Close(); err != nil {
241		t.Fatal(err)
242	}
243	page, err := ReadResidentHistoryPage(filepath.Join(root, spec.ID), "", 1)
244	if err != nil || page.OlderCursor == "" {
245		t.Fatalf("latest page = %#v, err=%v", page, err)
246	}
247	journal, err = OpenResidentJournal(root, spec.ID)
248	if err != nil {
249		t.Fatal(err)
250	}
251	if err := journal.RecordAgentEvent(core.EvUserMessage{Message: provider.Message{Role: provider.RoleUser, Content: []provider.Content{provider.TextBlock{Text: "third"}}}}); err != nil {
252		t.Fatal(err)
253	}
254	if err := journal.Close(); err != nil {
255		t.Fatal(err)
256	}
257	older, err := ReadResidentHistoryPage(filepath.Join(root, spec.ID), page.OlderCursor, 1)
258	if err != nil || len(older.Items) != 1 {
259		t.Fatalf("older page = %#v, err=%v", older, err)
260	}
261}
262
263func TestResidentManagerHistoryRejectsPathTraversal(t *testing.T) {
264	manager := NewResidentManager(t.TempDir(), func(ResidentChildSpec, *ResidentJournal) (ResidentRuntime, error) {
265		return ResidentTurnRunner(func(context.Context, string) error { return nil }), nil
266	})
267	if _, err := manager.History("../escape", 10); err == nil {
268		t.Fatal("History accepted traversal")
269	}
270	for _, childID := range []string{"../escape", "..", ".", "sub/child"} {
271		if _, err := manager.HistoryPage(childID, "", 10); err == nil {
272			t.Fatalf("HistoryPage(%q) accepted traversal", childID)
273		}
274	}
275}
276
277func TestReadResidentTranscriptMessagesReplaysCompactionCheckpoint(t *testing.T) {
278	root := t.TempDir()
279	journal, err := OpenResidentJournal(root, "compacted")
280	if err != nil {
281		t.Fatal(err)
282	}
283	spec := ResidentChildSpec{ID: "compacted", SessionID: "compacted-session", Provider: "openai", Model: "gpt-5"}
284	if err := journal.Accept(spec, "task"); err != nil {
285		t.Fatal(err)
286	}
287	if err := journal.RecordAgentEvent(core.EvUserMessage{Message: provider.Message{Role: provider.RoleUser, Content: []provider.Content{provider.TextBlock{Text: "old question"}}}}); err != nil {
288		t.Fatal(err)
289	}
290	if err := journal.RecordAgentEvent(core.EvToolCall{ID: "dropped-call", Name: "bash", Args: json.RawMessage(`{"command":"pwd"}`)}); err != nil {
291		t.Fatal(err)
292	}
293	if err := journal.RecordAgentEvent(core.EvToolResult{ID: "dropped-call", Result: core.ToolResult{Content: []provider.Content{provider.TextBlock{Text: "/repo"}}}}); err != nil {
294		t.Fatal(err)
295	}
296	if err := journal.RecordTurnStarted(spec, "turn-1"); err != nil {
297		t.Fatal(err)
298	}
299	if err := journal.RecordCompacted([]provider.Message{
300		{Role: provider.RoleUser, Content: []provider.Content{provider.TextBlock{Text: "## Context Summary (compacted)\n\ndigest"}}},
301	}); err != nil {
302		t.Fatal(err)
303	}
304	if err := journal.RecordAgentEvent(core.EvAssistantMessage{Message: provider.Message{Role: provider.RoleAssistant, Content: []provider.Content{provider.TextBlock{Text: "after checkpoint"}}}}); err != nil {
305		t.Fatal(err)
306	}
307	transcript := filepath.Join(journal.Dir(), residentTranscriptName)
308	if err := journal.Close(); err != nil {
309		t.Fatal(err)
310	}
311
312	records, err := ReadResidentJournal(transcript)
313	if err != nil {
314		t.Fatal(err)
315	}
316	var checkpoints []residentRecord
317	for _, record := range records {
318		if record.Type == residentRecordCompacted {
319			checkpoints = append(checkpoints, record)
320		}
321	}
322	if len(checkpoints) != 1 || checkpoints[0].TurnID != "turn-1" || len(checkpoints[0].Messages) != 1 {
323		t.Fatalf("checkpoints = %#v, want one attributed to the active turn", checkpoints)
324	}
325
326	dir := filepath.Join(root, spec.ID)
327	messages, err := ReadResidentTranscriptMessages(dir)
328	if err != nil {
329		t.Fatal(err)
330	}
331	if len(messages) != 2 || messages[0].Role != provider.RoleUser || messages[1].Role != provider.RoleAssistant {
332		t.Fatalf("resumed messages = %#v, want the checkpoint followed by the later reply", messages)
333	}
334	if text := joinedResidentMessageText(messages); strings.Contains(text, "old question") {
335		t.Fatalf("resume replayed pre-checkpoint content: %q", text)
336	}
337	if !strings.Contains(joinedResidentMessageText(messages[:1]), "Context Summary (compacted)") {
338		t.Fatalf("resume lost the checkpoint summary: %#v", messages[0])
339	}
340	for _, message := range messages {
341		for _, content := range message.Content {
342			if call, ok := content.(provider.ToolCallBlock); ok {
343				t.Fatalf("resume re-synthesized compacted tool call %q", call.ID)
344			}
345		}
346	}
347
348	// The UI pager keeps the append-only view: a checkpoint is not a history
349	// item, so paging still reaches the pre-checkpoint log.
350	page, err := ReadResidentHistoryPage(dir, "", 10)
351	if err != nil {
352		t.Fatal(err)
353	}
354	if page.OlderCursor == "" {
355		t.Fatal("page has no cursor for the pre-checkpoint log")
356	}
357	older, err := ReadResidentHistoryPage(dir, page.OlderCursor, 10)
358	if err != nil {
359		t.Fatal(err)
360	}
361	if len(older.Items) != 3 || older.Items[0].Type != residentRecordUser || !strings.Contains(string(older.Items[0].Message), "old question") {
362		t.Fatalf("older page = %#v, want the append-only log before the checkpoint", older.Items)
363	}
364	for _, item := range append(append([]ResidentHistoryItem(nil), page.Items...), older.Items...) {
365		if item.Type == residentRecordCompacted {
366			t.Fatalf("pager exposed a compaction checkpoint: %#v", item)
367		}
368	}
369}
370
371func TestReadResidentTranscriptMessagesRejectsInvalidCheckpoint(t *testing.T) {
372	for _, tc := range []struct {
373		name string
374		line string
375	}{
376		{name: "empty", line: `{"version":3,"type":"child.compacted","time":"2026-01-01T00:00:00Z"}`},
377		{name: "undecodable", line: `{"version":3,"type":"child.compacted","time":"2026-01-01T00:00:00Z","messages":["not a message"]}`},
378	} {
379		t.Run(tc.name, func(t *testing.T) {
380			root := t.TempDir()
381			journal, err := OpenResidentJournal(root, "bad-checkpoint")
382			if err != nil {
383				t.Fatal(err)
384			}
385			spec := ResidentChildSpec{ID: "bad-checkpoint", SessionID: "session", Provider: "openai", Model: "gpt-5"}
386			if err := journal.Accept(spec, "task"); err != nil {
387				t.Fatal(err)
388			}
389			if err := journal.RecordAgentEvent(core.EvUserMessage{Message: provider.Message{Role: provider.RoleUser, Content: []provider.Content{provider.TextBlock{Text: "question"}}}}); err != nil {
390				t.Fatal(err)
391			}
392			dir := journal.Dir()
393			if err := journal.Close(); err != nil {
394				t.Fatal(err)
395			}
396			path := filepath.Join(dir, residentTranscriptName)
397			file, err := os.OpenFile(path, os.O_APPEND|os.O_WRONLY, 0o600)
398			if err != nil {
399				t.Fatal(err)
400			}
401			if _, err := file.WriteString(tc.line + "\n"); err != nil {
402				t.Fatal(err)
403			}
404			if err := file.Close(); err != nil {
405				t.Fatal(err)
406			}
407			if _, err := ReadResidentTranscriptMessages(dir); err == nil {
408				t.Fatal("invalid checkpoint was accepted")
409			}
410			if _, err := ReconcileResidentJournal(dir); err == nil {
411				t.Fatal("reconciliation accepted an invalid checkpoint")
412			}
413		})
414	}
415}
416
417func joinedResidentMessageText(messages []provider.Message) string {
418	var text strings.Builder
419	for _, message := range messages {
420		for _, content := range message.Content {
421			if block, ok := content.(provider.TextBlock); ok {
422				text.WriteString(block.Text)
423				text.WriteString("\n")
424			}
425		}
426	}
427	return text.String()
428}

Keyboard shortcuts

Single-key shortcuts are on. ctrl k and esc work whatever this says.

ctrl k :
go to a section, branch, tag, file or repository
?
this list
j k
move the row cursor down / up
enter
open the row under the cursor; on Files, a directory opens or closes in place
↑ ↓ ← → home end
in the file tree (focus on a row): previous / next row, close / open a directory or go to its parent / first entry, first / last row. They never open a file
l h
on Files: open a directory or a file / close a directory or go up to its parent, then to the parent page. Elsewhere: into the side panel (on a merge request, its files) / back to the content; there j k move between its controls
g g G
first / last row
/
filter the list; on Files, find a file anywhere in the repository (esc clears, enter opens the best match)
b
switch branch or tag
g s g f g c g b g m g i g r g a
tabs: summary, files, commits, branches & tags, merge requests, issues, releases, actions (when available)
g h
home
w
wide mode: use the whole width of the screen, or not (remembered)
y
copy a permalink pinned to the commit
d u x
diff: split / unified / collapse or expand all
e E
diff: the whole file in view / every file, with the lines the hunks hide
n
merge request: next note in the diff
esc
close a dialog, leave a field

Branches 1

Tags 476

↑↓ moveenter openesc close