harn_cli/
json_envelope.rs

1//! Canonical JSON envelope for `harn` CLI commands.
2//!
3//! Every `--json` mode returns a [`JsonEnvelope<T>`] — a versioned
4//! wrapper that exposes `schemaVersion`, `ok`, and either `data` or
5//! `error`. Soft signals attach as `warnings` so `ok: true` stays
6//! stable as long as the command succeeds.
7//!
8//! Schema versions are per-command and monotonically increasing.
9//! [`catalog`] returns the registry consumed by `harn --json-schemas`.
10//! New commands extend the catalog (and bump their own
11//! [`JsonOutput::SCHEMA_VERSION`]) when their JSON shape changes in a
12//! way agents need to detect.
13//!
14//! See epic #1753 (`--json` everywhere) for the broader contract.
15
16use serde::{Deserialize, Serialize};
17
18/// Schema version of the `harn --json-schemas` catalog itself. Bump
19/// when the shape of [`SchemaEntry`] or the catalog envelope changes.
20pub const CATALOG_SCHEMA_VERSION: u32 = 1;
21
22/// Versioned wrapper for every `--json` CLI output. All five fields
23/// are always serialized so consumers can rely on a flat shape:
24/// missing payloads surface as `null` and the empty `warnings` array
25/// is `[]` rather than absent.
26#[derive(Debug, Clone, Serialize, Deserialize)]
27pub struct JsonEnvelope<T: Serialize> {
28    #[serde(rename = "schemaVersion")]
29    pub schema_version: u32,
30    pub ok: bool,
31    pub data: Option<T>,
32    pub error: Option<JsonError>,
33    #[serde(default)]
34    pub warnings: Vec<JsonWarning>,
35}
36
37#[derive(Debug, Clone, Serialize, Deserialize)]
38pub struct JsonError {
39    pub code: String,
40    pub message: String,
41    /// Free-form structured context. `null` when the error has no
42    /// structured payload — the field is always present so consumers
43    /// can read `error.details` without an existence check.
44    #[serde(default)]
45    pub details: serde_json::Value,
46}
47
48#[derive(Debug, Clone, Serialize, Deserialize)]
49pub struct JsonWarning {
50    pub code: String,
51    pub message: String,
52}
53
54/// Implemented by every CLI command that exposes a `--json` mode. The
55/// associated `SCHEMA_VERSION` is also surfaced in [`catalog`] so
56/// agents can negotiate per-command compatibility without parsing
57/// every payload.
58pub trait JsonOutput {
59    const SCHEMA_VERSION: u32;
60    type Data: Serialize;
61    fn into_envelope(self) -> JsonEnvelope<Self::Data>;
62}
63
64impl<T: Serialize> JsonEnvelope<T> {
65    pub fn ok(schema_version: u32, data: T) -> Self {
66        Self {
67            schema_version,
68            ok: true,
69            data: Some(data),
70            error: None,
71            warnings: Vec::new(),
72        }
73    }
74
75    pub fn err(
76        schema_version: u32,
77        code: impl Into<String>,
78        message: impl Into<String>,
79    ) -> JsonEnvelope<T> {
80        Self {
81            schema_version,
82            ok: false,
83            data: None,
84            error: Some(JsonError {
85                code: code.into(),
86                message: message.into(),
87                details: serde_json::Value::Null,
88            }),
89            warnings: Vec::new(),
90        }
91    }
92
93    pub fn with_details(mut self, details: serde_json::Value) -> Self {
94        if let Some(err) = self.error.as_mut() {
95            err.details = details;
96        }
97        self
98    }
99
100    pub fn with_warning(mut self, code: impl Into<String>, message: impl Into<String>) -> Self {
101        self.warnings.push(JsonWarning {
102            code: code.into(),
103            message: message.into(),
104        });
105        self
106    }
107}
108
109/// One row of the `harn --json-schemas` catalog. `schema_json` is
110/// inline when small; richer schemas live behind a future
111/// `schema_url` field documented per-command.
112#[derive(Debug, Clone, Serialize)]
113pub struct SchemaEntry {
114    pub command: &'static str,
115    #[serde(rename = "schemaVersion")]
116    pub schema_version: u32,
117    pub description: &'static str,
118    #[serde(skip_serializing_if = "Option::is_none", rename = "schemaJson")]
119    pub schema_json: Option<serde_json::Value>,
120}
121
122/// Static catalog of commands that already emit a stable JSON shape.
123///
124/// E2.1 seeds the commands that ship a `schema_version` today (doctor,
125/// session export, the provider catalog). New commands register here as
126/// they migrate to [`JsonEnvelope`] — for example, the `skills` family
127/// added in E3.2.
128pub fn catalog() -> Vec<SchemaEntry> {
129    vec![
130        SchemaEntry {
131            command: "doctor",
132            schema_version: crate::commands::doctor::DOCTOR_SCHEMA_VERSION,
133            description: "Capability matrix: host, per-target buildability, per-provider reachability, per-stdlib-effect availability.",
134            schema_json: None,
135        },
136        SchemaEntry {
137            command: "session export",
138            schema_version: 1,
139            description: "Portable Harn session bundle export.",
140            schema_json: None,
141        },
142        SchemaEntry {
143            command: "provider-catalog",
144            schema_version: 1,
145            description: "Resolved provider/model catalog snapshot.",
146            schema_json: None,
147        },
148        SchemaEntry {
149            command: "connect status",
150            schema_version: 1,
151            description: "Outbound-connector readiness report.",
152            schema_json: None,
153        },
154        SchemaEntry {
155            command: "connect setup-plan",
156            schema_version: 1,
157            description: "Step-by-step plan to bring a connector online.",
158            schema_json: None,
159        },
160        SchemaEntry {
161            command: "run",
162            schema_version: crate::commands::run::json_events::RUN_JSON_SCHEMA_VERSION,
163            description: "Pipeline-run NDJSON event stream (stdout, stderr, transcript, tool, hook, persona, result, error).",
164            schema_json: None,
165        },
166        SchemaEntry {
167            command: "parse",
168            schema_version: crate::commands::parse_tokens::PARSE_JSON_SCHEMA_VERSION,
169            description: "Tagged Harn AST tree with byte spans for parser tooling.",
170            schema_json: None,
171        },
172        SchemaEntry {
173            command: "tokens",
174            schema_version: crate::commands::parse_tokens::TOKENS_JSON_SCHEMA_VERSION,
175            description: "Lexer token stream with source lexemes and byte spans.",
176            schema_json: None,
177        },
178        SchemaEntry {
179            command: "check",
180            schema_version: crate::commands::check::CHECK_SCHEMA_VERSION,
181            description: "Per-file static check results with diagnostics and summary counts.",
182            schema_json: None,
183        },
184        SchemaEntry {
185            command: "fmt",
186            schema_version: crate::commands::check::FMT_SCHEMA_VERSION,
187            description: "Per-file formatting result report for write and check modes.",
188            schema_json: None,
189        },
190        SchemaEntry {
191            command: "check provider-matrix",
192            schema_version: crate::commands::check::provider_matrix::PROVIDER_MATRIX_SCHEMA_VERSION,
193            description: "Provider/model capability matrix rows.",
194            schema_json: None,
195        },
196        SchemaEntry {
197            command: "check connector-matrix",
198            schema_version: crate::commands::check::connector_matrix::CONNECTOR_MATRIX_SCHEMA_VERSION,
199            description: "Connector package capability matrix rows.",
200            schema_json: None,
201        },
202        SchemaEntry {
203            command: "test conformance",
204            schema_version: crate::commands::test::CONFORMANCE_TEST_SCHEMA_VERSION,
205            description:
206                "Conformance test results with xfail accounting and a stable fixture snapshot key.",
207            schema_json: None,
208        },
209        SchemaEntry {
210            command: "time run",
211            schema_version: crate::commands::time::TIME_RUN_SCHEMA_VERSION,
212            description:
213                "Per-phase wall-clock + cache hit/miss + per-LLM/tool-call latency for `harn run`.",
214            schema_json: None,
215        },
216        SchemaEntry {
217            command: "fix plan",
218            schema_version: crate::commands::fix::FIX_PLAN_SCHEMA_VERSION,
219            description: "Plan repair-bearing diagnostics without editing files.",
220            schema_json: None,
221        },
222        SchemaEntry {
223            command: "fix apply",
224            schema_version: crate::commands::fix::FIX_APPLY_SCHEMA_VERSION,
225            description: "Apply clean repair edits at or below a declared safety ceiling.",
226            schema_json: None,
227        },
228        SchemaEntry {
229            command: "skills list",
230            schema_version: 1,
231            description: "Canonical Harn skill corpus, frontmatter only.",
232            schema_json: None,
233        },
234        SchemaEntry {
235            command: "skills get",
236            schema_version: 1,
237            description: "One canonical skill's frontmatter (and body with --full).",
238            schema_json: None,
239        },
240        SchemaEntry {
241            command: "pack",
242            schema_version: crate::commands::pack::PACK_SCHEMA_VERSION,
243            description: "Signed-ready .harnpack run-bundle build summary.",
244            schema_json: Some(crate::commands::pack::json_schema()),
245        },
246        SchemaEntry {
247            command: "pack verify",
248            schema_version: crate::commands::pack::PACK_VERIFY_SCHEMA_VERSION,
249            description:
250                "Result of verifying a .harnpack: bundle hash, signature, per-module hashes.",
251            schema_json: Some(crate::commands::pack::verify_json_schema()),
252        },
253        SchemaEntry {
254            command: "dev",
255            schema_version: 1,
256            description: "`harn dev --watch` incremental NDJSON event stream (ready / fingerprint_changed / rerun / diagnostics / tests).",
257            schema_json: None,
258        },
259        SchemaEntry {
260            command: "routes",
261            schema_version: 1,
262            description: "Static trigger route, budget, capability, and vendor-lock inventory.",
263            schema_json: None,
264        },
265        SchemaEntry {
266            command: "graph",
267            schema_version: crate::commands::graph::GRAPH_SCHEMA_VERSION,
268            description:
269                "Static module graph with public symbols, imports, capabilities, effects, and host-call surface.",
270            schema_json: None,
271        },
272        SchemaEntry {
273            command: "lint",
274            schema_version: crate::commands::check::LINT_SCHEMA_VERSION,
275            description:
276                "Per-file lint diagnostics with severity, fixable/fixed counts, and summary.",
277            schema_json: None,
278        },
279        SchemaEntry {
280            command: "replay",
281            schema_version: crate::commands::replay::REPLAY_SCHEMA_VERSION,
282            description:
283                "Replay summary: per-stage status/outcome/branch plus the embedded replay-fixture verdict.",
284            schema_json: None,
285        },
286        SchemaEntry {
287            command: "version",
288            schema_version: crate::VERSION_SCHEMA_VERSION,
289            description: "CLI build metadata: name, version, description.",
290            schema_json: None,
291        },
292        SchemaEntry {
293            command: "upgrade",
294            schema_version: crate::commands::upgrade::UPGRADE_SCHEMA_VERSION,
295            description:
296                "Self-update probe (`--check`) or install summary: current, target, archive URL, install outcome.",
297            schema_json: None,
298        },
299        SchemaEntry {
300            command: "explain --catalog",
301            schema_version: crate::commands::diagnostics_catalog::SCHEMA_VERSION,
302            description:
303                "Diagnostic-code catalog: per-code summary, repair, safety, related codes.",
304            schema_json: None,
305        },
306    ]
307}
308
309/// Encode an envelope as JSON. Uses pretty form so humans tailing the
310/// terminal can still read it; agents `jq`-pipe either form.
311pub fn to_string_pretty<T: Serialize>(envelope: &JsonEnvelope<T>) -> String {
312    serde_json::to_string_pretty(envelope).expect("JsonEnvelope serializes")
313}
314
315#[cfg(test)]
316mod tests {
317    use super::*;
318    use serde_json::json;
319
320    #[derive(Serialize)]
321    struct Payload {
322        value: u32,
323    }
324
325    #[test]
326    fn ok_envelope_round_trips() {
327        let env = JsonEnvelope::ok(7, Payload { value: 42 });
328        let v: serde_json::Value = serde_json::to_value(&env).unwrap();
329        assert_eq!(v["schemaVersion"], 7);
330        assert_eq!(v["ok"], true);
331        assert_eq!(v["data"]["value"], 42);
332        // All envelope fields are always serialized; absent payloads
333        // surface as JSON `null` / `[]`.
334        assert!(v["error"].is_null());
335        assert_eq!(v["warnings"], json!([]));
336    }
337
338    #[test]
339    fn err_envelope_carries_details() {
340        let env: JsonEnvelope<()> = JsonEnvelope::err(2, "io", "disk full")
341            .with_details(json!({ "path": "/var/log/harn" }));
342        let v: serde_json::Value = serde_json::to_value(&env).unwrap();
343        assert_eq!(v["schemaVersion"], 2);
344        assert_eq!(v["ok"], false);
345        assert_eq!(v["error"]["code"], "io");
346        assert_eq!(v["error"]["message"], "disk full");
347        assert_eq!(v["error"]["details"]["path"], "/var/log/harn");
348        assert!(v["data"].is_null());
349    }
350
351    #[test]
352    fn warnings_serialize_when_present() {
353        let env = JsonEnvelope::ok(1, Payload { value: 1 })
354            .with_warning("deprecated.flag", "--format=json is deprecated");
355        let v: serde_json::Value = serde_json::to_value(&env).unwrap();
356        assert_eq!(v["warnings"][0]["code"], "deprecated.flag");
357        assert_eq!(v["warnings"][0]["message"], "--format=json is deprecated");
358    }
359
360    #[test]
361    fn catalog_is_nonempty_and_unique() {
362        let entries = catalog();
363        assert!(!entries.is_empty(), "catalog should ship with E2.1 seeds");
364        let mut commands: Vec<_> = entries.iter().map(|e| e.command).collect();
365        commands.sort();
366        let unique_count = {
367            let mut deduped = commands.clone();
368            deduped.dedup();
369            deduped.len()
370        };
371        assert_eq!(commands.len(), unique_count, "command names must be unique");
372    }
373
374    #[test]
375    fn catalog_includes_fix_plan() {
376        let entries = catalog();
377        let entry = entries
378            .iter()
379            .find(|entry| entry.command == "fix plan")
380            .expect("fix plan schema should be registered");
381        assert_eq!(
382            entry.schema_version,
383            crate::commands::fix::FIX_PLAN_SCHEMA_VERSION
384        );
385        let entry = entries
386            .iter()
387            .find(|entry| entry.command == "fix apply")
388            .expect("fix apply schema should be registered");
389        assert_eq!(
390            entry.schema_version,
391            crate::commands::fix::FIX_APPLY_SCHEMA_VERSION
392        );
393    }
394
395    #[test]
396    fn schema_versions_are_positive() {
397        for entry in catalog() {
398            assert!(
399                entry.schema_version >= 1,
400                "{} should have schemaVersion >= 1",
401                entry.command
402            );
403        }
404    }
405}
harn_cli/json_envelope.rs

harn_cli/
json_envelope.rs
