agent-first-data 0.26.2

A naming convention that lets AI agents understand your data without being told what it means, plus a CLI and library for reading and safely editing structured JSON, TOML, YAML, dotenv, and INI documents.
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
package afdata

import (
	"bytes"
	"encoding/json"
	"errors"
	"strings"
	"syscall"
	"testing"
)

// ═══════════════════════════════════════════
// CliParseOutput
// ═══════════════════════════════════════════

func TestCliParseOutput_AllFormats(t *testing.T) {
	cases := []struct {
		in   string
		want OutputFormat
	}{
		{"json", OutputFormatJson},
		{"yaml", OutputFormatYaml},
		{"plain", OutputFormatPlain},
	}
	for _, c := range cases {
		got, err := CliParseOutput(c.in)
		if err != nil {
			t.Errorf("CliParseOutput(%q): unexpected error: %v", c.in, err)
		}
		if got != c.want {
			t.Errorf("CliParseOutput(%q) = %q, want %q", c.in, got, c.want)
		}
	}
}

func TestCliParseOutput_RejectsUnknown(t *testing.T) {
	for _, s := range []string{"xml", "JSON", "YAML", ""} {
		_, err := CliParseOutput(s)
		if err == nil {
			t.Errorf("CliParseOutput(%q): expected error, got nil", s)
		}
	}
}

func TestCliParseOutput_ErrorContainsValue(t *testing.T) {
	_, err := CliParseOutput("toml")
	if err == nil {
		t.Fatal("expected error")
	}
	msg := err.Error()
	if !contains(msg, "toml") {
		t.Errorf("error %q does not contain input value", msg)
	}
	if !contains(msg, "json") {
		t.Errorf("error %q does not mention expected values", msg)
	}
}

// ═══════════════════════════════════════════
// CliParseLogFilters
// ═══════════════════════════════════════════

func TestCliParseLogFilters_TrimsAndLowercases(t *testing.T) {
	got := CliParseLogFilters([]string{"  Query  ", "ERROR"})
	want := []string{"query", "error"}
	if !sliceEq(got.Values(), want) {
		t.Errorf("got %v, want %v", got.Values(), want)
	}
}

func TestCliParseLogFilters_Deduplicates(t *testing.T) {
	got := CliParseLogFilters([]string{"query", "error", "Query", "query"})
	want := []string{"query", "error"}
	if !sliceEq(got.Values(), want) {
		t.Errorf("got %v, want %v", got.Values(), want)
	}
}

func TestCliParseLogFilters_RemovesEmpty(t *testing.T) {
	got := CliParseLogFilters([]string{"", "query", "  "})
	want := []string{"query"}
	if !sliceEq(got.Values(), want) {
		t.Errorf("got %v, want %v", got.Values(), want)
	}
}

func TestCliParseLogFilters_EmptySlice(t *testing.T) {
	got := CliParseLogFilters([]string{})
	if !got.IsEmpty() {
		t.Errorf("expected empty, got %v", got.Values())
	}
}

func TestCliParseLogFilters_PreservesOrder(t *testing.T) {
	got := CliParseLogFilters([]string{"startup", "request", "retry"})
	want := []string{"startup", "request", "retry"}
	if !sliceEq(got.Values(), want) {
		t.Errorf("got %v, want %v", got.Values(), want)
	}
}

// ═══════════════════════════════════════════
// BuildCLIError
// ═══════════════════════════════════════════

func TestBuildCLIError_RequiredFields(t *testing.T) {
	event, err := BuildCLIError("missing --sql", "")
	if err != nil {
		t.Fatalf("unexpected error: %v", err)
	}
	v := event.Value()
	if v["kind"] != "error" {
		t.Errorf("kind = %v", v["kind"])
	}
	errPayload := v["error"].(map[string]any)
	if errPayload["code"] != "cli_error" {
		t.Errorf("error.code = %v", errPayload["code"])
	}
	if errPayload["message"] != "missing --sql" {
		t.Errorf("error.message = %v", errPayload["message"])
	}
	if errPayload["retryable"] != false {
		t.Errorf("error.retryable = %v", errPayload["retryable"])
	}
	if _, ok := v["error_code"]; ok {
		t.Errorf("unexpected error_code = %v", v["error_code"])
	}
	if _, ok := v["retryable"]; ok {
		t.Errorf("unexpected retryable = %v", v["retryable"])
	}
	if trace, ok := v["trace"].(map[string]any); !ok || len(trace) != 0 {
		t.Errorf("trace = %v, want empty object", v["trace"])
	}
}

func TestBuildCLIError_WithHint(t *testing.T) {
	event, err := BuildCLIError("bad flag", "try --help")
	if err != nil {
		t.Fatalf("unexpected error: %v", err)
	}
	v := event.Value()
	errPayload := v["error"].(map[string]any)
	if errPayload["hint"] != "try --help" {
		t.Errorf("hint = %v, want 'try --help'", errPayload["hint"])
	}
}

func TestBuildCLIError_WithoutHintHasNoHintKey(t *testing.T) {
	event, err := BuildCLIError("oops", "")
	if err != nil {
		t.Fatalf("unexpected error: %v", err)
	}
	v := event.Value()
	errPayload := v["error"].(map[string]any)
	if _, ok := errPayload["hint"]; ok {
		t.Errorf("expected no hint key, got %v", errPayload["hint"])
	}
}

func TestBuildCLIError_IsValidJson(t *testing.T) {
	event, err := BuildCLIError("oops", "")
	if err != nil {
		t.Fatalf("unexpected error: %v", err)
	}
	v := event.Value()
	s := Render(v, OutputFormatJson, OutputOptions{})
	if s == "" {
		t.Error("OutputJson returned empty string")
	}
	if !contains(s, "error") {
		t.Errorf("json %q missing 'error'", s)
	}
}

// ═══════════════════════════════════════════
// Render
// ═══════════════════════════════════════════

func TestCliOutput_DispatchesJson(t *testing.T) {
	event := NewJSONResult(map[string]any{"size_bytes": int64(1024)}).Build()
	v := event.Value()
	out := Render(v, OutputFormatJson, OutputOptions{})
	if !contains(out, "size_bytes") {
		t.Errorf("json output should preserve raw keys, got: %s", out)
	}
	if contains(out, "\n") {
		t.Error("json output should be single line")
	}
}

func TestCliOutput_DispatchesYaml(t *testing.T) {
	event := NewJSONResult(map[string]any{"size_bytes": int64(1024)}).Build()
	v := event.Value()
	out := Render(v, OutputFormatYaml, OutputOptions{})
	if !contains(out, "---") {
		t.Errorf("yaml output should start with ---, got: %s", out)
	}
	if !contains(out, "size_bytes: 1024") {
		t.Errorf("yaml output should be structure-preserving (raw key, raw value), got: %s", out)
	}
}

func TestCliOutput_DispatchesPlain(t *testing.T) {
	event := NewJSONResult(map[string]any{"ok": true}).Build()
	v := event.Value()
	out := Render(v, OutputFormatPlain, OutputOptions{})
	if !contains(out, "kind=result") {
		t.Errorf("plain output should be logfmt, got: %s", out)
	}
}

func TestCliOutputWithOptions_DispatchesRawYaml(t *testing.T) {
	v := map[string]any{"size_bytes": int64(1024)}
	out := Render(v, OutputFormatYaml, OutputOptions{Style: PlainStyleRaw})
	if !contains(out, "size_bytes: 1024") {
		t.Errorf("raw yaml output should preserve suffix key, got: %s", out)
	}
	if contains(out, "size:") {
		t.Errorf("raw yaml output should not strip suffix, got: %s", out)
	}
}

// ═══════════════════════════════════════════
// CliEmitter
// ═══════════════════════════════════════════

func TestCliEmitterWritesEventsAndTracksTerminal(t *testing.T) {
	var buf bytes.Buffer
	emitter := NewCliEmitter(&buf, OutputFormatJson)
	logEvent := NewJSONLog(map[string]any{"level": "info", "message": "startup"}).Build()
	if err := emitter.Emit(logEvent); err != nil {
		t.Fatalf("log emit: %v", err)
	}
	resultEvent := NewJSONResult(map[string]any{"rows": 2}).Build()
	if err := emitter.Emit(resultEvent); err != nil {
		t.Fatalf("result emit: %v", err)
	}
	out := buf.String()
	if !contains(out, "\"kind\":\"log\"") || !contains(out, "\"kind\":\"result\"") {
		t.Fatalf("unexpected output: %s", out)
	}
}

func TestCliEmitterFramingAllFormats(t *testing.T) {
	logEvent := NewJSONLog(map[string]any{"level": "info", "message": "startup"}).Build()
	resultEvent := NewJSONResult(map[string]any{"rows": 2}).Build()
	cases := []struct {
		name   string
		format OutputFormat
		check  func(t *testing.T, out string)
	}{
		{
			name:   "json",
			format: OutputFormatJson,
			check: func(t *testing.T, out string) {
				lines := strings.Split(strings.TrimSuffix(out, "\n"), "\n")
				if len(lines) != 2 {
					t.Fatalf("json should frame one event per line: %q", out)
				}
				for _, line := range lines {
					var parsed map[string]any
					if err := json.Unmarshal([]byte(line), &parsed); err != nil {
						t.Fatalf("json frame is not valid json: %q: %v", line, err)
					}
				}
			},
		},
		{
			name:   "plain",
			format: OutputFormatPlain,
			check: func(t *testing.T, out string) {
				lines := strings.Split(strings.TrimSuffix(out, "\n"), "\n")
				if len(lines) != 2 || !strings.HasPrefix(lines[0], "kind=log") || !strings.HasPrefix(lines[1], "kind=result") {
					t.Fatalf("plain should frame one display event per line: %q", out)
				}
			},
		},
		{
			name:   "yaml",
			format: OutputFormatYaml,
			check: func(t *testing.T, out string) {
				if strings.Count(out, "---") != 2 {
					t.Fatalf("yaml should frame every event with a document boundary: %q", out)
				}
			},
		},
	}
	for _, tc := range cases {
		t.Run(tc.name, func(t *testing.T) {
			var buf bytes.Buffer
			emitter := NewCliEmitter(&buf, tc.format)
			if err := emitter.Emit(logEvent); err != nil {
				t.Fatalf("emit: %v", err)
			}
			if err := emitter.Emit(resultEvent); err != nil {
				t.Fatalf("emit: %v", err)
			}
			tc.check(t, buf.String())
		})
	}
}

func TestCliEmitterRejectsDuplicateTerminal(t *testing.T) {
	var buf bytes.Buffer
	emitter := NewCliEmitter(&buf, OutputFormatJson)
	resultEvent := NewJSONResult(map[string]any{"rows": 2}).Build()
	if err := emitter.Emit(resultEvent); err != nil {
		t.Fatalf("result emit: %v", err)
	}
	errorEvent, _ := NewJSONError("late_error", "too late").Build()
	err := emitter.Emit(errorEvent)
	if err == nil || !contains(err.Error(), "duplicate terminal") {
		t.Fatalf("expected duplicate terminal error, got %v", err)
	}
}

func TestCliEmitterRejectsNonTerminalAfterTerminal(t *testing.T) {
	var buf bytes.Buffer
	emitter := NewCliEmitter(&buf, OutputFormatJson)
	resultEvent := NewJSONResult(map[string]any{"rows": 2}).Build()
	if err := emitter.Emit(resultEvent); err != nil {
		t.Fatalf("result emit: %v", err)
	}
	progressEvent := NewJSONProgress(map[string]any{"message": "working"}).Build()
	err := emitter.Emit(progressEvent)
	if err == nil || !contains(err.Error(), "after terminal") {
		t.Fatalf("expected after terminal error, got %v", err)
	}
}

type failingWriter struct{}

func (failingWriter) Write(_ []byte) (int, error) {
	return 0, errors.New("closed")
}

func TestCliEmitterReturnsWriterErrors(t *testing.T) {
	emitter := NewCliEmitter(failingWriter{}, OutputFormatJson)
	event := NewJSONResult(map[string]any{"rows": 2}).Build()
	err := emitter.Emit(event)
	if err == nil || !contains(err.Error(), "failed to write") {
		t.Fatalf("expected writer error, got %v", err)
	}
}

type failOnceWriter struct {
	failed bool
	buf    bytes.Buffer
}

func (w *failOnceWriter) Write(value []byte) (int, error) {
	if !w.failed {
		w.failed = true
		return 0, errors.New("retry")
	}
	return w.buf.Write(value)
}

func TestCliEmitterDoesNotCommitTerminalStateWhenWriteFails(t *testing.T) {
	writer := &failOnceWriter{}
	emitter := NewCliEmitter(writer, OutputFormatJson)
	event := NewJSONResult(map[string]any{"rows": 2}).Build()
	if err := emitter.Emit(event); err == nil {
		t.Fatal("first write must fail")
	}
	if err := emitter.Emit(event); err != nil {
		t.Fatalf("terminal event should remain retryable: %v", err)
	}
	if lines := strings.Count(strings.TrimSpace(writer.buf.String()), "\n") + 1; lines != 1 {
		t.Fatalf("expected one event line, got %d", lines)
	}
}

// ═══════════════════════════════════════════
// OutputTo parsing
// ═══════════════════════════════════════════

func TestParseOutputTo_AllVariants(t *testing.T) {
	cases := []struct {
		in   string
		want OutputTo
	}{
		{"split", OutputToSplit},
		{"stdout", OutputToStdout},
		{"stderr", OutputToStderr},
	}
	for _, c := range cases {
		got, err := ParseOutputTo(c.in)
		if err != nil {
			t.Errorf("ParseOutputTo(%q): unexpected error: %v", c.in, err)
		}
		if got != c.want {
			t.Errorf("ParseOutputTo(%q) = %q, want %q", c.in, got, c.want)
		}
	}
}

func TestParseOutputTo_RejectsUnknown(t *testing.T) {
	for _, s := range []string{"both", "SPLIT", "", "file"} {
		_, err := ParseOutputTo(s)
		if err == nil {
			t.Errorf("ParseOutputTo(%q): expected error, got nil", s)
		}
	}
	_, err := ParseOutputTo("both")
	if err == nil {
		t.Fatal("expected error")
	}
	if !contains(err.Error(), "both") || !contains(err.Error(), "split") {
		t.Errorf("error %q should name the bad value and the accepted set", err.Error())
	}
}

// ═══════════════════════════════════════════
// CliEmitter two-mode routing
// ═══════════════════════════════════════════

// Finite one-shot mode splits by kind: result → the primary (stdout) sink,
// while error/progress/log → the diagnostic (stderr) sink.
func TestCliEmitterFiniteSplitsResultToPrimary(t *testing.T) {
	var out, diag bytes.Buffer
	emitter := NewCliEmitterFinite(&out, &diag, OutputFormatJson)

	if err := emitter.EmitProgress("working"); err != nil {
		t.Fatalf("progress emit: %v", err)
	}
	if err := emitter.EmitLog(LogLevelInfo, "step"); err != nil {
		t.Fatalf("log emit: %v", err)
	}
	if err := emitter.EmitResult(map[string]any{"rows": 2}); err != nil {
		t.Fatalf("result emit: %v", err)
	}

	if !contains(out.String(), "\"kind\":\"result\"") {
		t.Fatalf("result must go to the primary sink, got: %q", out.String())
	}
	if contains(out.String(), "\"kind\":\"progress\"") || contains(out.String(), "\"kind\":\"log\"") {
		t.Fatalf("diagnostics must not reach the primary sink, got: %q", out.String())
	}
	if !contains(diag.String(), "\"kind\":\"progress\"") || !contains(diag.String(), "\"kind\":\"log\"") {
		t.Fatalf("progress/log must go to the diagnostic sink, got: %q", diag.String())
	}
	if contains(diag.String(), "\"kind\":\"result\"") {
		t.Fatalf("result must not reach the diagnostic sink, got: %q", diag.String())
	}
}

// In finite mode an error is a diagnostic (routing follows kind, not exit code),
// so it goes to the diagnostic sink, keeping the primary (stdout) sink free of
// anything a pipe could mistake for a successful payload.
func TestCliEmitterFiniteRoutesErrorToDiagnostic(t *testing.T) {
	var out, diag bytes.Buffer
	emitter := NewCliEmitterFinite(&out, &diag, OutputFormatJson)

	if err := emitter.EmitError("boom", "it failed"); err != nil {
		t.Fatalf("error emit: %v", err)
	}
	if out.Len() != 0 {
		t.Fatalf("primary sink must stay empty on error, got: %q", out.String())
	}
	if !contains(diag.String(), "\"kind\":\"error\"") {
		t.Fatalf("error must go to the diagnostic sink, got: %q", diag.String())
	}
}

// Event-stream (unified) mode collapses every event, including error, onto the
// single writer so a consumer reading one ordered stream sees them all.
func TestCliEmitterStreamUnifiesAllEvents(t *testing.T) {
	var buf bytes.Buffer
	emitter := NewCliEmitter(&buf, OutputFormatJson)

	if err := emitter.EmitProgress("working"); err != nil {
		t.Fatalf("progress emit: %v", err)
	}
	if err := emitter.EmitLog(LogLevelInfo, "step"); err != nil {
		t.Fatalf("log emit: %v", err)
	}
	if err := emitter.EmitError("boom", "it failed"); err != nil {
		t.Fatalf("error emit: %v", err)
	}

	out := buf.String()
	for _, want := range []string{"\"kind\":\"progress\"", "\"kind\":\"log\"", "\"kind\":\"error\""} {
		if !contains(out, want) {
			t.Fatalf("stream mode must keep %s on the single writer, got: %q", want, out)
		}
	}
	if lines := strings.Count(strings.TrimSpace(out), "\n") + 1; lines != 3 {
		t.Fatalf("expected three framed events, got %d: %q", lines, out)
	}
}

// The from-selector constructor picks the shape: split → finite (a diagnostic
// sink is wired), stdout/stderr → stream (a single writer, no diagnostic sink).
func TestNewCliEmitterFromOutputToShape(t *testing.T) {
	if e := NewCliEmitterFromOutputTo(OutputToSplit, OutputFormatJson); e.diagnostic == nil {
		t.Error("OutputToSplit must produce a finite emitter with a diagnostic sink")
	}
	if e := NewCliEmitterFromOutputTo(OutputToStdout, OutputFormatJson); e.diagnostic != nil {
		t.Error("OutputToStdout must produce a stream emitter with no diagnostic sink")
	}
	if e := NewCliEmitterFromOutputTo(OutputToStderr, OutputFormatJson); e.diagnostic != nil {
		t.Error("OutputToStderr must produce a stream emitter with no diagnostic sink")
	}
}

// ═══════════════════════════════════════════
// CliEmitter Finish / exit-code helpers
// ═══════════════════════════════════════════

func TestCliEmitterFinishSuccessReturnsSuccessCode(t *testing.T) {
	var buf bytes.Buffer
	emitter := NewCliEmitter(&buf, OutputFormatJson)
	errEvent, _ := NewJSONError("cancelled", "operation cancelled").Build()
	if code := emitter.Finish(errEvent, 1); code != 1 {
		t.Fatalf("Finish success code = %d, want 1", code)
	}
	if !contains(buf.String(), "\"kind\":\"error\"") {
		t.Fatalf("Finish must write the event: %q", buf.String())
	}
}

func TestCliEmitterFinishResultWritesResultAndReturnsZero(t *testing.T) {
	var out, diag bytes.Buffer
	emitter := NewCliEmitterFinite(&out, &diag, OutputFormatJson)
	if code := emitter.FinishResult(map[string]any{"rows": 3}); code != 0 {
		t.Fatalf("FinishResult code = %d, want 0", code)
	}
	if !contains(out.String(), "\"kind\":\"result\"") || !contains(out.String(), "rows") {
		t.Fatalf("FinishResult must write the result to the primary sink: %q", out.String())
	}
	if diag.Len() != 0 {
		t.Fatalf("FinishResult must not write to the diagnostic sink: %q", diag.String())
	}
}

// A rich error routed through the builder + Finish lands on the diagnostic sink
// with its hint intact, and Finish returns the caller's exit code.
func TestCliEmitterFinishRichErrorToDiagnostic(t *testing.T) {
	var out, diag bytes.Buffer
	emitter := NewCliEmitterFinite(&out, &diag, OutputFormatJson)
	event, err := NewJSONError("cancelled", "operation cancelled").
		Hint("retry later").
		Trace(map[string]any{"duration_ms": 0}).
		Build()
	if err != nil {
		t.Fatalf("build error event: %v", err)
	}
	if code := emitter.Finish(event, 1); code != 1 {
		t.Fatalf("Finish code = %d, want 1", code)
	}
	if out.Len() != 0 {
		t.Fatalf("error must not reach the primary sink: %q", out.String())
	}
	got := diag.String()
	if !contains(got, "\"kind\":\"error\"") || !contains(got, "cancelled") || !contains(got, "retry later") {
		t.Fatalf("error (incl. hint) must reach the diagnostic sink: %q", got)
	}
}

type epipeWriter struct{}

func (epipeWriter) Write(_ []byte) (int, error) { return 0, syscall.EPIPE }

func TestCliEmitterFinishBrokenPipeReturnsZero(t *testing.T) {
	// A broken pipe (reader hung up) collapses any success code to 0.
	if code := NewCliEmitter(epipeWriter{}, OutputFormatJson).FinishResult(map[string]any{"ok": true}); code != 0 {
		t.Fatalf("broken pipe FinishResult code = %d, want 0", code)
	}
	errEvent, _ := NewJSONError("boom", "it failed").Build()
	if code := NewCliEmitter(epipeWriter{}, OutputFormatJson).Finish(errEvent, 7); code != 0 {
		t.Fatalf("broken pipe Finish code = %d, want 0", code)
	}
}

func TestCliEmitterFinishOtherWriteFailureReturnsFour(t *testing.T) {
	// failingWriter returns a non-EPIPE error, so Finish maps it to 4.
	if code := NewCliEmitter(failingWriter{}, OutputFormatJson).FinishResult(map[string]any{"ok": true}); code != 4 {
		t.Fatalf("other write failure code = %d, want 4", code)
	}
}

// ═══════════════════════════════════════════
// Version helpers
// ═══════════════════════════════════════════

// versionValueFlags mirrors the example's own value-taking global flags, so the
// pre-parser recognizes their space-separated values.
var versionValueFlags = []string{"--log", "--stdout-file", "--stderr-file"}

func TestBuildCliVersion_StandardShape(t *testing.T) {
	v := BuildCliVersion("agent-cli", "Agent CLI Example", "1.2.3", "abc1234")
	if v["kind"] != "result" {
		t.Errorf("kind = %v", v["kind"])
	}
	result := v["result"].(map[string]any)
	if result["code"] != "version" {
		t.Errorf("code = %v", result["code"])
	}
	if result["name"] != "agent-cli" {
		t.Errorf("name = %v", result["name"])
	}
	if result["display_name"] != "Agent CLI Example" {
		t.Errorf("display_name = %v", result["display_name"])
	}
	if result["version"] != "1.2.3" {
		t.Errorf("version = %v", result["version"])
	}
	if result["build"] != "abc1234" {
		t.Errorf("build = %v", result["build"])
	}
	if trace, ok := v["trace"].(map[string]any); !ok || len(trace) != 0 {
		t.Errorf("trace = %v, want empty object", v["trace"])
	}
}

func TestBuildCliVersion_OmitsAbsentDisplayNameAndBuild(t *testing.T) {
	v := BuildCliVersion("agent-cli", "", "1.2.3", "")
	result := v["result"].(map[string]any)
	if result["name"] != "agent-cli" {
		t.Errorf("name = %v", result["name"])
	}
	if result["version"] != "1.2.3" {
		t.Errorf("version = %v", result["version"])
	}
	if _, ok := result["display_name"]; ok {
		t.Errorf("expected no display_name key, got %v", result["display_name"])
	}
	if _, ok := result["build"]; ok {
		t.Errorf("expected no build key, got %v", result["build"])
	}
}

func TestCliRenderVersion_Json(t *testing.T) {
	out := CliRenderVersion("agent-cli", "Agent CLI Example", "1.2.3", "abc1234", OutputFormatJson)
	var parsed map[string]any
	if err := json.Unmarshal([]byte(strings.TrimSpace(out)), &parsed); err != nil {
		t.Fatalf("version json must parse: %v (%q)", err, out)
	}
	result := parsed["result"].(map[string]any)
	if parsed["kind"] != "result" || result["code"] != "version" {
		t.Errorf("json version wrong shape: %s", out)
	}
	if result["name"] != "agent-cli" || result["version"] != "1.2.3" {
		t.Errorf("json version missing name/version: %s", out)
	}
	if result["display_name"] != "Agent CLI Example" || result["build"] != "abc1234" {
		t.Errorf("json version missing display_name/build: %s", out)
	}
}

func TestCliHandleVersionOrContinue_HonorsOutputFlag(t *testing.T) {
	out, handled, err := CliHandleVersionOrContinue(
		[]string{"--version", "--output", "plain"},
		versionValueFlags,
		"agent-cli", "Agent CLI Example", "1.2.3", "",
	)
	if err != nil {
		t.Fatalf("unexpected error: %v", err)
	}
	if !handled {
		t.Fatal("expected handled")
	}
	if !contains(out, "kind=result") || !contains(out, "result.version=1.2.3") {
		t.Errorf("plain version output = %s", out)
	}
}

func TestCliHandleVersionOrContinue_IgnoresJsonFlag(t *testing.T) {
	// --json belongs to the application: it must not select a format, and it
	// must not conflict with one. --output yaml still wins.
	out, handled, err := CliHandleVersionOrContinue(
		[]string{"--version", "--json", "--output", "yaml"},
		versionValueFlags,
		"agent-cli", "", "1.2.3", "",
	)
	if err != nil {
		t.Fatalf("unexpected error: %v", err)
	}
	if !handled {
		t.Fatal("expected handled")
	}
	if !contains(out, "kind: \"result\"") {
		t.Errorf("--output yaml must still select YAML: %s", out)
	}
}

func TestCliHandleVersionOrContinue_ConflictingOutputFormats(t *testing.T) {
	_, handled, err := CliHandleVersionOrContinue(
		[]string{"--version", "--output", "json", "--output", "yaml"},
		versionValueFlags,
		"agent-cli", "", "1.2.3", "",
	)
	if !handled {
		t.Fatal("expected handled")
	}
	if err == nil || !contains(err.Error(), "conflicting output formats") {
		t.Fatalf("expected conflict error, got %v", err)
	}
}

func TestCliHandleVersionOrContinue_BareInheritsJsonDefault(t *testing.T) {
	// Bare --version answers with a protocol-v1 event and follows the command's
	// declared output default.
	out, handled, err := CliHandleVersionOrContinue(
		[]string{"--version"},
		versionValueFlags,
		"agent-cli", "Agent CLI Example", "1.2.3", "",
	)
	if err != nil {
		t.Fatalf("unexpected error: %v", err)
	}
	if !handled {
		t.Fatal("expected handled")
	}
	var parsed map[string]any
	if err := json.Unmarshal([]byte(strings.TrimSpace(out)), &parsed); err != nil {
		t.Fatalf("bare --version must render json: %v (%q)", err, out)
	}
	result := parsed["result"].(map[string]any)
	if parsed["kind"] != "result" || result["code"] != "version" {
		t.Errorf("bare version wrong shape: %s", out)
	}
	if result["name"] != "agent-cli" || result["version"] != "1.2.3" {
		t.Errorf("bare version missing name/version: %s", out)
	}
	if result["display_name"] != "Agent CLI Example" {
		t.Errorf("bare version missing display_name: %s", out)
	}
}

func TestCliHandleVersionOrContinue_BareInheritsPlainDefault(t *testing.T) {
	out, handled, err := CliHandleVersionOrContinue(
		[]string{"--version"},
		versionValueFlags,
		"agent-cli", "", "1.2.3", "",
		OutputFormatPlain,
	)
	if err != nil || !handled {
		t.Fatalf("expected handled plain version, got handled=%v err=%v", handled, err)
	}
	if !contains(out, "result.code=version") || !contains(out, "result.version=1.2.3") {
		t.Fatalf("bare version did not inherit plain output: %q", out)
	}
}

func TestCliHandleVersionOrContinue_ReturnsNoneWithoutVersion(t *testing.T) {
	_, handled, err := CliHandleVersionOrContinue(
		[]string{"ping"},
		versionValueFlags,
		"agent-cli", "", "1.2.3", "",
	)
	if err != nil {
		t.Fatalf("unexpected error: %v", err)
	}
	if handled {
		t.Fatal("expected handled=false")
	}
}

func TestCliHandleVersionOrContinue_RejectsInvalidOutput(t *testing.T) {
	_, handled, err := CliHandleVersionOrContinue(
		[]string{"--version", "--output", "xml"},
		versionValueFlags,
		"agent-cli", "", "1.2.3", "",
	)
	if !handled {
		t.Fatal("expected handled")
	}
	if err == nil || !contains(err.Error(), "xml") {
		t.Fatalf("expected xml error, got %v", err)
	}
}

func TestCliHandleVersionOrContinue_IgnoresVersionFlagAfterSubcommand(t *testing.T) {
	// A subcommand that takes its own --version <value> must not be hijacked
	// by the top-level pre-parser.
	for _, args := range [][]string{
		{"hatch", "--version", "1.3.0"},
		{"hatch", "-V", "1.3.0"},
	} {
		_, handled, err := CliHandleVersionOrContinue(args, versionValueFlags, "agent-cli", "", "1.2.3", "")
		if err != nil {
			t.Fatalf("unexpected error for %v: %v", args, err)
		}
		if handled {
			t.Fatalf("expected handled=false for %v", args)
		}
	}
}

func TestCliHandleVersionOrContinue_HonorsOutputFlagBeforeTopLevelVersion(t *testing.T) {
	// A known output flag consumes its value, so a trailing top-level
	// --version is still recognized.
	out, handled, err := CliHandleVersionOrContinue(
		[]string{"--output", "json", "--version"},
		versionValueFlags,
		"agent-cli", "", "1.2.3", "",
	)
	if err != nil {
		t.Fatalf("unexpected error: %v", err)
	}
	if !handled {
		t.Fatal("expected handled")
	}
	if !contains(out, `"version":"1.2.3"`) {
		t.Fatalf("expected version json, got %q", out)
	}
}

func TestCliHandleVersionOrContinue_SkipsCallerDefinedValueFlag(t *testing.T) {
	// A caller's own value-taking global flag (here a comma-list --log) must have
	// its space-separated value recognized through valueFlags, not a hardcoded
	// list. Without that, "request,startup" would be mistaken for the subcommand
	// boundary and the trailing --version would be dropped.
	out, handled, err := CliHandleVersionOrContinue(
		[]string{"--log", "request,startup", "--version"},
		[]string{"--log"},
		"hypha", "", "1.2.3", "",
	)
	if err != nil {
		t.Fatalf("unexpected error: %v", err)
	}
	if !handled {
		t.Fatal("expected handled")
	}
	var parsed map[string]any
	if err := json.Unmarshal([]byte(strings.TrimSpace(out)), &parsed); err != nil {
		t.Fatalf("version json must parse: %v (%q)", err, out)
	}
	result := parsed["result"].(map[string]any)
	if result["name"] != "hypha" || result["version"] != "1.2.3" {
		t.Errorf("version missing name/version: %s", out)
	}
}

func TestCliHandleVersionOrContinue_SkipsOutputToSpaceValue(t *testing.T) {
	// A preceding --output-to <value> (space form) must not be mistaken for the
	// subcommand boundary; the trailing --version must still be recognized.
	out, handled, err := CliHandleVersionOrContinue(
		[]string{"--output-to", "stdout", "--version"},
		versionValueFlags,
		"agent-cli", "", "1.2.3", "",
	)
	if err != nil {
		t.Fatalf("unexpected error: %v", err)
	}
	if !handled {
		t.Fatal("expected handled")
	}
	if !contains(out, `"version":"1.2.3"`) {
		t.Fatalf("expected version json, got %q", out)
	}
}

// ═══════════════════════════════════════════
// Helpers
// ═══════════════════════════════════════════

func sliceEq(a, b []string) bool {
	if len(a) != len(b) {
		return false
	}
	for i := range a {
		if a[i] != b[i] {
			return false
		}
	}
	return true
}

func contains(s, sub string) bool {
	return len(s) >= len(sub) && (s == sub || len(sub) == 0 ||
		func() bool {
			for i := 0; i <= len(s)-len(sub); i++ {
				if s[i:i+len(sub)] == sub {
					return true
				}
			}
			return false
		}())
}