Skip to main content

kaish_types/
output.rs

1//! Structured output model (Tree-of-Tables) and output format handling.
2//!
3//! The unified output model uses `OutputData` containing a tree of `OutputNode`s:
4//!
5//! - **Builtins**: Pure data producers returning `OutputData`
6//! - **Frontends**: Handle all rendering (REPL, MCP, kaijutsu)
7
8use serde::{Deserialize, Serialize};
9
10use crate::result::ExecResult;
11
12// ============================================================
13// Structured Output (Tree-of-Tables Model)
14// ============================================================
15
16/// Entry type for rendering hints (colors, icons).
17///
18/// This unified enum is used by both the new OutputNode system
19/// and the legacy DisplayHint::Table for backward compatibility.
20#[non_exhaustive]
21#[derive(Debug, Clone, Copy, PartialEq, Eq, Default, Serialize, Deserialize)]
22#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
23#[serde(rename_all = "lowercase")]
24pub enum EntryType {
25    /// Generic text content.
26    #[default]
27    Text,
28    /// Regular file.
29    File,
30    /// Directory.
31    Directory,
32    /// Executable file.
33    Executable,
34    /// Symbolic link.
35    Symlink,
36}
37
38/// A node in the output tree.
39///
40/// All fields are always serialized (no skip_serializing_if) for predictable shape
41/// across JSON, postcard, and bincode formats.
42///
43/// `text` is Option<String> because None and Some("") are semantically distinct:
44/// - None: this is a named entry (file listing, table row), not a text node
45/// - Some(""): this IS a text node whose content is empty (e.g. `echo ""`)
46///
47/// The `is_text_only()` method depends on this distinction.
48#[derive(Debug, Clone, PartialEq, Eq, Default, Serialize, Deserialize)]
49#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
50#[serde(default)]
51pub struct OutputNode {
52    /// Primary identifier (filename, key, label).
53    pub name: String,
54    /// Rendering hint (colors, icons).
55    pub entry_type: EntryType,
56    /// Text content (for echo, cat, exec).
57    ///
58    /// Three-state semantics:
59    /// - `None` — named entry (file listing, table row), not text
60    /// - `Some("")` — text node with empty content (e.g., `echo ""`)
61    /// - `Some("x")` — text node with content
62    ///
63    /// `is_text_only()` returns true iff text is Some AND name/cells/children are empty.
64    pub text: Option<String>,
65    /// Additional columns (for ls -l, ps, env).
66    pub cells: Vec<String>,
67    /// Child nodes (for tree, find).
68    pub children: Vec<OutputNode>,
69}
70
71impl OutputNode {
72    /// Create a new node with a name.
73    pub fn new(name: impl Into<String>) -> Self {
74        Self {
75            name: name.into(),
76            ..Default::default()
77        }
78    }
79
80    /// Create a text-only node (for echo, cat, etc.).
81    pub fn text(content: impl Into<String>) -> Self {
82        Self {
83            text: Some(content.into()),
84            ..Default::default()
85        }
86    }
87
88    /// Set the entry type for rendering hints.
89    pub fn with_entry_type(mut self, entry_type: EntryType) -> Self {
90        self.entry_type = entry_type;
91        self
92    }
93
94    /// Set additional columns for tabular output.
95    pub fn with_cells(mut self, cells: Vec<String>) -> Self {
96        self.cells = cells;
97        self
98    }
99
100    /// Set child nodes for tree output.
101    pub fn with_children(mut self, children: Vec<OutputNode>) -> Self {
102        self.children = children;
103        self
104    }
105
106    /// Set text content.
107    pub fn with_text(mut self, text: impl Into<String>) -> Self {
108        self.text = Some(text.into());
109        self
110    }
111
112    /// Check if this is a text-only node.
113    pub fn is_text_only(&self) -> bool {
114        self.text.is_some() && self.name.is_empty() && self.cells.is_empty() && self.children.is_empty()
115    }
116
117    /// Check if this node has children.
118    pub fn has_children(&self) -> bool {
119        !self.children.is_empty()
120    }
121
122    /// Estimate brace-notation byte size without materializing.
123    pub fn estimated_byte_size(&self) -> usize {
124        if self.children.is_empty() {
125            self.name.len() + self.text.as_ref().map_or(0, |t| t.len())
126        } else {
127            // "name/{child1,child2,...}"
128            let mut size = self.name.len() + 2; // name + "/{" + "}"
129            for (i, child) in self.children.iter().enumerate() {
130                if i > 0 {
131                    size += 1; // comma separator
132                }
133                size += child.estimated_byte_size();
134            }
135            size + 1 // closing brace
136        }
137    }
138
139    /// Write brace-notation to a writer. Returns bytes written.
140    pub fn write_canonical(&self, w: &mut dyn std::io::Write, budget: usize) -> std::io::Result<usize> {
141        if self.children.is_empty() {
142            w.write_all(self.name.as_bytes())?;
143            return Ok(self.name.len());
144        }
145        let mut written = 0;
146        w.write_all(self.name.as_bytes())?;
147        written += self.name.len();
148        if written >= budget {
149            return Ok(written);
150        }
151        w.write_all(b"/{")?;
152        written += 2;
153        for (i, child) in self.children.iter().enumerate() {
154            if written >= budget {
155                break;
156            }
157            if i > 0 {
158                w.write_all(b",")?;
159                written += 1;
160            }
161            written += child.write_canonical(w, budget.saturating_sub(written))?;
162        }
163        w.write_all(b"}")?;
164        written += 1;
165        Ok(written)
166    }
167
168    /// Get the display name, potentially with text content.
169    pub fn display_name(&self) -> &str {
170        if self.name.is_empty() {
171            self.text.as_deref().unwrap_or("")
172        } else {
173            &self.name
174        }
175    }
176}
177
178/// Structured output data from a command.
179///
180/// This is the top-level structure for command output.
181/// It contains optional column headers and a list of root nodes.
182///
183/// `headers` is Option<Vec<String>> because None means "not tabular" while
184/// Some(vec![]) means "tabular with no column headers." The rendering dispatch
185/// in to_json() and the REPL formatter branch on this distinction.
186///
187/// # Rendering Rules
188///
189/// | Structure | Interactive | Piped/Model |
190/// |-----------|-------------|-------------|
191/// | Single node with `text` | Print text | Print text |
192/// | Flat nodes, `name` only | Multi-column, colored | One per line |
193/// | Flat nodes with `cells` | Aligned table | TSV or names only |
194/// | Nested `children` | Box-drawing tree | Brace notation |
195#[derive(Debug, Clone, PartialEq, Eq, Default, Serialize, Deserialize)]
196#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
197#[serde(default)]
198#[non_exhaustive]
199pub struct OutputData {
200    /// Column headers (optional, for table output).
201    pub headers: Option<Vec<String>>,
202    /// Top-level nodes.
203    pub root: Vec<OutputNode>,
204    /// Render-only override for `--json` consumers. When `Some`,
205    /// `to_json()` returns this verbatim instead of inferring from
206    /// `headers` / `root` / `cells`. Use it when a builtin wants its
207    /// `--json` shape to be richer than the table form (e.g. grep
208    /// emitting per-match objects with submatches and byte offsets).
209    ///
210    /// Skipped by serde (and thus by postcard / bincode) — this is a
211    /// transient render hint, not part of the persisted shape.
212    #[serde(skip)]
213    #[cfg_attr(feature = "schema", schemars(skip))]
214    pub rich_json: Option<serde_json::Value>,
215}
216
217impl OutputData {
218    /// Create new empty output data.
219    pub fn new() -> Self {
220        Self::default()
221    }
222
223    /// Create output data with a single text node.
224    ///
225    /// This is the simplest form for commands like `echo`.
226    pub fn text(content: impl Into<String>) -> Self {
227        Self {
228            headers: None,
229            root: vec![OutputNode::text(content)],
230            rich_json: None,
231        }
232    }
233
234    /// Create output data with named nodes (for ls, etc.).
235    pub fn nodes(nodes: Vec<OutputNode>) -> Self {
236        Self {
237            headers: None,
238            root: nodes,
239            rich_json: None,
240        }
241    }
242
243    /// Create output data with headers and nodes (for ls -l, ps, etc.).
244    pub fn table(headers: Vec<String>, nodes: Vec<OutputNode>) -> Self {
245        Self {
246            headers: Some(headers),
247            root: nodes,
248            rich_json: None,
249        }
250    }
251
252    /// Set column headers.
253    pub fn with_headers(mut self, headers: Vec<String>) -> Self {
254        self.headers = Some(headers);
255        self
256    }
257
258    /// Attach a render-only `--json` override. See `rich_json` field doc.
259    pub fn with_rich_json(mut self, value: serde_json::Value) -> Self {
260        self.rich_json = Some(value);
261        self
262    }
263
264    /// Check if this output is simple text (single text-only node).
265    pub fn is_simple_text(&self) -> bool {
266        self.root.len() == 1 && self.root[0].is_text_only()
267    }
268
269    /// Check if this output is a flat list (no nested children).
270    pub fn is_flat(&self) -> bool {
271        self.root.iter().all(|n| !n.has_children())
272    }
273
274    /// Check if this output has tabular data (nodes with cells).
275    pub fn is_tabular(&self) -> bool {
276        self.root.iter().any(|n| !n.cells.is_empty())
277    }
278
279    /// Get the text content if this is simple text output.
280    pub fn as_text(&self) -> Option<&str> {
281        if self.is_simple_text() {
282            self.root[0].text.as_deref()
283        } else {
284            None
285        }
286    }
287
288    /// Extract the owned String from a single-text-node OutputData.
289    /// Returns `Err(self)` for non-simple-text output (tables, trees, multi-node),
290    /// giving the caller back the unconsumed OutputData.
291    pub fn into_text(mut self) -> Result<String, Self> {
292        if self.root.len() == 1 && self.root[0].is_text_only() {
293            Ok(self.root.pop().and_then(|n| n.text).unwrap_or_default())
294        } else {
295            Err(self)
296        }
297    }
298
299    /// Estimate canonical string byte size without materializing.
300    ///
301    /// Lower bound — actual may be slightly larger due to formatting.
302    /// Mirrors `to_canonical_string()` structure but only accumulates sizes.
303    pub fn estimated_byte_size(&self) -> usize {
304        if self.root.len() == 1 && self.root[0].is_text_only() {
305            return self.root[0].text.as_ref().map_or(0, |t| t.len());
306        }
307
308        if self.is_flat() {
309            let mut size = 0;
310            for (i, n) in self.root.iter().enumerate() {
311                if i > 0 {
312                    size += 1; // newline separator
313                }
314                size += n.display_name().len();
315                for cell in &n.cells {
316                    size += 1 + cell.len(); // tab + cell
317                }
318            }
319            return size;
320        }
321
322        // Tree: estimate brace notation
323        let mut size = 0;
324        for (i, n) in self.root.iter().enumerate() {
325            if i > 0 {
326                size += 1; // newline separator
327            }
328            size += n.estimated_byte_size();
329        }
330        size
331    }
332
333    /// Write canonical representation to a writer with optional byte budget.
334    ///
335    /// Returns total bytes written. Stops after budget exceeded (imprecise:
336    /// one write past the limit is fine — caller uses this for spill detection,
337    /// not for exact truncation).
338    pub fn write_canonical(&self, w: &mut dyn std::io::Write, budget: Option<usize>) -> std::io::Result<usize> {
339        let mut written = 0usize;
340        let budget = budget.unwrap_or(usize::MAX);
341
342        if self.root.len() == 1 && self.root[0].is_text_only() {
343            if let Some(ref text) = self.root[0].text {
344                w.write_all(text.as_bytes())?;
345                return Ok(text.len());
346            }
347            return Ok(0);
348        }
349
350        if self.is_flat() {
351            for (i, n) in self.root.iter().enumerate() {
352                if i > 0 {
353                    w.write_all(b"\n")?;
354                    written += 1;
355                }
356                let name = n.display_name();
357                w.write_all(name.as_bytes())?;
358                written += name.len();
359                for cell in &n.cells {
360                    w.write_all(b"\t")?;
361                    w.write_all(cell.as_bytes())?;
362                    written += 1 + cell.len();
363                }
364                if written > budget {
365                    return Ok(written);
366                }
367            }
368            return Ok(written);
369        }
370
371        // Tree: brace notation
372        for (i, n) in self.root.iter().enumerate() {
373            if i > 0 {
374                w.write_all(b"\n")?;
375                written += 1;
376            }
377            written += n.write_canonical(w, budget.saturating_sub(written))?;
378            if written > budget {
379                return Ok(written);
380            }
381        }
382        Ok(written)
383    }
384
385    /// Convert to canonical string output (for pipes).
386    ///
387    /// This produces a simple string representation suitable for
388    /// piping to other commands:
389    /// - Text nodes: their text content
390    /// - Named nodes: names joined by newlines
391    /// - Tabular nodes (name + cells): TSV format (name\tcell1\tcell2...)
392    /// - Nested nodes: brace notation
393    pub fn to_canonical_string(&self) -> String {
394        if let Some(text) = self.as_text() {
395            return text.to_string();
396        }
397
398        // For flat lists (with or without cells), output one line per node
399        if self.is_flat() {
400            return self.root.iter()
401                .map(|n| {
402                    if n.cells.is_empty() {
403                        n.display_name().to_string()
404                    } else {
405                        // For tabular data, use TSV format
406                        let mut parts = vec![n.display_name().to_string()];
407                        parts.extend(n.cells.iter().cloned());
408                        parts.join("\t")
409                    }
410                })
411                .collect::<Vec<_>>()
412                .join("\n");
413        }
414
415        // For trees, use brace notation
416        fn format_node(node: &OutputNode) -> String {
417            if node.children.is_empty() {
418                node.name.clone()
419            } else {
420                let children: Vec<String> = node.children.iter()
421                    .map(format_node)
422                    .collect();
423                format!("{}/{{{}}}", node.name, children.join(","))
424            }
425        }
426
427        self.root.iter()
428            .map(format_node)
429            .collect::<Vec<_>>()
430            .join("\n")
431    }
432
433    /// Serialize to a JSON value for `--json` flag handling.
434    ///
435    /// Bare data, no envelope — optimized for `jq` patterns.
436    ///
437    /// | Structure | JSON |
438    /// |-----------|------|
439    /// | Simple text | `"hello world"` |
440    /// | Flat list (names only) | `["file1", "file2"]` |
441    /// | Table (headers + cells) | `[{"col1": "v1", ...}, ...]` |
442    /// | Tree (nested children) | `{"dir": {"file": null}}` |
443    pub fn to_json(&self) -> serde_json::Value {
444        // Builtin-supplied override wins (used by `grep --json` to expose
445        // submatches/byte offsets that don't fit the table model).
446        if let Some(rich) = &self.rich_json {
447            return rich.clone();
448        }
449        // Simple text -> JSON string
450        if let Some(text) = self.as_text() {
451            return serde_json::Value::String(text.to_string());
452        }
453
454        // Table -> array of objects keyed by headers
455        if let Some(ref headers) = self.headers {
456            let rows: Vec<serde_json::Value> = self.root.iter().map(|node| {
457                let mut map = serde_json::Map::new();
458                // First header maps to node.name
459                if let Some(first) = headers.first() {
460                    map.insert(first.clone(), serde_json::Value::String(node.name.clone()));
461                }
462                // Remaining headers map to cells
463                for (header, cell) in headers.iter().skip(1).zip(node.cells.iter()) {
464                    map.insert(header.clone(), serde_json::Value::String(cell.clone()));
465                }
466                serde_json::Value::Object(map)
467            }).collect();
468            return serde_json::Value::Array(rows);
469        }
470
471        // Tree -> nested object
472        if !self.is_flat() {
473            fn node_to_json(node: &OutputNode) -> serde_json::Value {
474                if node.children.is_empty() {
475                    serde_json::Value::Null
476                } else {
477                    let mut map = serde_json::Map::new();
478                    for child in &node.children {
479                        map.insert(child.name.clone(), node_to_json(child));
480                    }
481                    serde_json::Value::Object(map)
482                }
483            }
484
485            // Single root node -> its children as the top-level object
486            if self.root.len() == 1 {
487                return node_to_json(&self.root[0]);
488            }
489            // Multiple root nodes -> object with each root as a key
490            let mut map = serde_json::Map::new();
491            for node in &self.root {
492                map.insert(node.name.clone(), node_to_json(node));
493            }
494            return serde_json::Value::Object(map);
495        }
496
497        // Flat list -> array of strings
498        let items: Vec<serde_json::Value> = self.root.iter()
499            .map(|n| serde_json::Value::String(n.display_name().to_string()))
500            .collect();
501        serde_json::Value::Array(items)
502    }
503}
504
505// ============================================================
506// Output Format (Global --json flag)
507// ============================================================
508
509/// Output serialization format, requested via global flags.
510#[non_exhaustive]
511#[derive(Debug, Clone, Copy, PartialEq, Eq)]
512pub enum OutputFormat {
513    /// JSON serialization via OutputData::to_json()
514    Json,
515}
516
517/// Transform an ExecResult into the requested output format.
518///
519/// Serializes regardless of exit code — commands like `diff` (exit 1 = files differ)
520/// and `grep` (exit 1 = no matches) use non-zero exits for semantic meaning,
521/// not errors. The `--json` contract must hold for all exit codes.
522pub fn apply_output_format(mut result: ExecResult, format: OutputFormat) -> ExecResult {
523    if !result.has_output() && result.text_out().is_empty() {
524        // No stdout to format. A failure that carries a diagnostic message must
525        // still honor --json — otherwise the message leaks out as plain text
526        // even though structured output was requested. Emit a JSON error object
527        // so the contract holds on the error path. A clean non-zero exit with no
528        // message (e.g. `grep` no-match, exit 1) is not an error and stays empty.
529        if !result.ok() && !result.err.is_empty() {
530            match format {
531                OutputFormat::Json => {
532                    let obj = serde_json::json!({
533                        "error": result.err,
534                        "code": result.code,
535                    });
536                    result.data = Some(crate::result::json_to_value(obj.clone()));
537                    result.set_out(
538                        serde_json::to_string(&obj).unwrap_or_else(|_| "null".to_string()),
539                    );
540                }
541            }
542        }
543        return result;
544    }
545    match format {
546        OutputFormat::Json => {
547            if let Some(output) = result.output() {
548                let json_value = output.to_json();
549                // NLL: borrow of result via output ends here (json_value is owned)
550                result.set_out(serde_json::to_string(&json_value)
551                    .unwrap_or_else(|_| "null".to_string()));
552                result.data = Some(crate::result::json_to_value(json_value));
553            } else if let Some(data) = &result.data {
554                // Structured data already present (e.g. jq, any `success_with_data`
555                // builtin): serialize that, not the rendered text. Re-wrapping the
556                // text as a JSON string would double-encode it (`"1"` not `1`) and
557                // clobber the real value. `.data` is the structured truth.
558                let json_out = serde_json::to_string(&crate::result::value_to_json(data))
559                    .unwrap_or_else(|_| "null".to_string());
560                result.set_out(json_out);
561            } else {
562                // Text-only: wrap as JSON string. .data mirrors the same string.
563                let text = result.text_out().into_owned();
564                let json_out = serde_json::to_string(&text)
565                    .unwrap_or_else(|_| "null".to_string());
566                result.data = Some(crate::value::Value::String(text));
567                result.set_out(json_out);
568            }
569            // Clear sentinel — format already applied, prevents double-encoding
570            result.set_output(None);
571            result
572        }
573    }
574}
575
576#[cfg(test)]
577mod tests {
578    use super::*;
579
580    #[test]
581    fn entry_type_variants() {
582        assert_ne!(EntryType::File, EntryType::Directory);
583        assert_ne!(EntryType::Directory, EntryType::Executable);
584        assert_ne!(EntryType::Executable, EntryType::Symlink);
585    }
586
587    #[test]
588    fn to_json_simple_text() {
589        let output = OutputData::text("hello world");
590        assert_eq!(output.to_json(), serde_json::json!("hello world"));
591    }
592
593    #[test]
594    fn to_json_flat_list() {
595        let output = OutputData::nodes(vec![
596            OutputNode::new("file1"),
597            OutputNode::new("file2"),
598            OutputNode::new("file3"),
599        ]);
600        assert_eq!(output.to_json(), serde_json::json!(["file1", "file2", "file3"]));
601    }
602
603    #[test]
604    fn to_json_table() {
605        let output = OutputData::table(
606            vec!["NAME".into(), "SIZE".into(), "TYPE".into()],
607            vec![
608                OutputNode::new("foo.rs").with_cells(vec!["1024".into(), "file".into()]),
609                OutputNode::new("bar/").with_cells(vec!["4096".into(), "dir".into()]),
610            ],
611        );
612        assert_eq!(output.to_json(), serde_json::json!([
613            {"NAME": "foo.rs", "SIZE": "1024", "TYPE": "file"},
614            {"NAME": "bar/", "SIZE": "4096", "TYPE": "dir"},
615        ]));
616    }
617
618    #[test]
619    fn to_json_tree() {
620        let child1 = OutputNode::new("main.rs").with_entry_type(EntryType::File);
621        let child2 = OutputNode::new("utils.rs").with_entry_type(EntryType::File);
622        let subdir = OutputNode::new("lib")
623            .with_entry_type(EntryType::Directory)
624            .with_children(vec![child2]);
625        let root = OutputNode::new("src")
626            .with_entry_type(EntryType::Directory)
627            .with_children(vec![child1, subdir]);
628
629        let output = OutputData::nodes(vec![root]);
630        assert_eq!(output.to_json(), serde_json::json!({
631            "main.rs": null,
632            "lib": {"utils.rs": null},
633        }));
634    }
635
636    #[test]
637    fn to_json_tree_multiple_roots() {
638        let root1 = OutputNode::new("src")
639            .with_entry_type(EntryType::Directory)
640            .with_children(vec![OutputNode::new("main.rs")]);
641        let root2 = OutputNode::new("docs")
642            .with_entry_type(EntryType::Directory)
643            .with_children(vec![OutputNode::new("README.md")]);
644
645        let output = OutputData::nodes(vec![root1, root2]);
646        assert_eq!(output.to_json(), serde_json::json!({
647            "src": {"main.rs": null},
648            "docs": {"README.md": null},
649        }));
650    }
651
652    #[test]
653    fn to_json_empty() {
654        let output = OutputData::new();
655        assert_eq!(output.to_json(), serde_json::json!([]));
656    }
657
658    #[test]
659    fn apply_output_format_clears_sentinel() {
660        let output = OutputData::table(
661            vec!["NAME".into()],
662            vec![OutputNode::new("test")],
663        );
664        let result = ExecResult::with_output(output);
665        assert!(result.has_output(), "before: sentinel present");
666
667        let formatted = apply_output_format(result, OutputFormat::Json);
668        assert!(!formatted.has_output(), "after Json: sentinel cleared");
669    }
670
671    #[test]
672    fn apply_output_format_no_double_encoding() {
673        let output = OutputData::nodes(vec![
674            OutputNode::new("file1"),
675            OutputNode::new("file2"),
676        ]);
677        let result = ExecResult::with_output(output);
678
679        let after_json = apply_output_format(result, OutputFormat::Json);
680        let json_out = after_json.text_out().into_owned();
681        assert!(!after_json.has_output(), "sentinel cleared by Json");
682
683        let parsed: serde_json::Value = serde_json::from_str(&json_out).expect("valid JSON");
684        assert_eq!(parsed, serde_json::json!(["file1", "file2"]));
685    }
686
687    #[test]
688    fn apply_output_format_populates_data() {
689        let output = OutputData::nodes(vec![
690            OutputNode::new("file1"),
691            OutputNode::new("file2"),
692        ]);
693        let result = ExecResult::with_output(output);
694        assert!(result.data.is_none(), "before: no data on non-text output");
695
696        let formatted = apply_output_format(result, OutputFormat::Json);
697        assert!(formatted.data.is_some(), "after Json: data populated");
698
699        // data should match the JSON in out
700        let data = formatted.data.unwrap();
701        assert!(matches!(data, crate::value::Value::Json(_)), "data should be Json variant");
702        if let crate::value::Value::Json(json) = data {
703            assert_eq!(json, serde_json::json!(["file1", "file2"]));
704        }
705    }
706
707    #[test]
708    fn apply_output_format_prefers_structured_data_over_text() {
709        // A `success_with_data` result (e.g. jq '.a' on {"a":1}) carries the
710        // structured scalar in `.data` and the rendered text in stdout. --json
711        // must serialize the structured value (1), not re-wrap the text ("1").
712        use crate::value::Value;
713        let result = ExecResult::success_with_data("1", Value::Int(1));
714        assert!(!result.has_output(), "no OutputData sentinel on this path");
715
716        let formatted = apply_output_format(result, OutputFormat::Json);
717        let json_out = formatted.text_out().into_owned();
718        let parsed: serde_json::Value = serde_json::from_str(&json_out).expect("valid JSON");
719        assert_eq!(parsed, serde_json::json!(1), "number, not the string \"1\"");
720        // The structured `.data` is preserved, not clobbered down to a string.
721        assert_eq!(formatted.data, Some(Value::Int(1)));
722    }
723
724    #[test]
725    fn apply_output_format_compact_json() {
726        let output = OutputData::nodes(vec![
727            OutputNode::new("file1"),
728            OutputNode::new("file2"),
729        ]);
730        let result = ExecResult::with_output(output);
731
732        let formatted = apply_output_format(result, OutputFormat::Json);
733        // Compact JSON: no pretty-printing (no newlines within the array)
734        let out = formatted.text_out();
735        assert!(!out.contains('\n'), "should be compact JSON, got: {}", out);
736        assert_eq!(&*out, r#"["file1","file2"]"#);
737    }
738
739    #[test]
740    fn apply_output_format_emits_json_error_object_on_failure() {
741        // A failure with empty stdout and a populated err must still honor
742        // --json: emit {"error", "code"} rather than leaking the message as
743        // plain text (e.g. `grep --json --bogus-flag`).
744        let result = ExecResult::failure(2, "grep: unknown flag --bogus-flag");
745        assert!(!result.has_output());
746        assert!(result.text_out().is_empty());
747
748        let formatted = apply_output_format(result, OutputFormat::Json);
749        let out = formatted.text_out().into_owned();
750        let parsed: serde_json::Value = serde_json::from_str(&out).expect("valid JSON");
751        assert_eq!(
752            parsed,
753            serde_json::json!({"error": "grep: unknown flag --bogus-flag", "code": 2})
754        );
755        // .data mirrors the JSON object.
756        assert!(matches!(formatted.data, Some(crate::value::Value::Json(_))));
757    }
758
759    #[test]
760    fn apply_output_format_leaves_clean_no_match_empty() {
761        // grep no-match: exit 1, empty stdout, empty err. Not an error — must
762        // NOT be wrapped in a JSON error object; stays empty.
763        let result = ExecResult::failure(1, "");
764        let formatted = apply_output_format(result, OutputFormat::Json);
765        assert!(formatted.text_out().is_empty());
766        assert!(formatted.data.is_none());
767    }
768
769    #[test]
770    fn apply_output_format_empty_success_stays_empty() {
771        let result = ExecResult::success("");
772        let formatted = apply_output_format(result, OutputFormat::Json);
773        assert!(formatted.text_out().is_empty());
774        assert!(formatted.data.is_none());
775    }
776
777    #[test]
778    fn estimated_byte_size_text_only_node() {
779        let node = OutputNode::text("hello world");
780        // Text-only node: name is empty, text is "hello world" (11 bytes)
781        assert_eq!(node.estimated_byte_size(), 11);
782    }
783
784    #[test]
785    fn estimated_byte_size_named_node() {
786        let node = OutputNode::new("file.txt");
787        assert_eq!(node.estimated_byte_size(), 8);
788    }
789
790    #[test]
791    fn write_canonical_respects_budget() {
792        let parent = OutputNode::new("root")
793            .with_children(vec![
794                OutputNode::new("aaaa"),
795                OutputNode::new("bbbb"),
796                OutputNode::new("cccc"),
797            ]);
798        // With a very small budget, should stop writing children early
799        let mut buf = Vec::new();
800        let written = parent.write_canonical(&mut buf, 8).unwrap();
801        let output = String::from_utf8(buf).unwrap();
802        // "root" (4) + "/{" (2) = 6, then budget check kicks in after first child
803        assert!(written <= 16, "should respect budget, wrote {} bytes: {}", written, output);
804        // Should at least write the root name
805        assert!(output.starts_with("root"), "should start with root: {}", output);
806    }
807
808    #[test]
809    fn into_text_simple() {
810        let data = OutputData::text("hello");
811        assert_eq!(data.into_text(), Ok("hello".to_string()));
812    }
813
814    #[test]
815    fn into_text_non_simple() {
816        let data = OutputData::nodes(vec![OutputNode::new("a"), OutputNode::new("b")]);
817        assert!(data.into_text().is_err());
818    }
819
820    #[test]
821    fn into_text_empty() {
822        let data = OutputData::text("");
823        assert_eq!(data.into_text(), Ok("".to_string()));
824    }
825}