Files
kebab/crates/kebab-app/src/error_wire.rs
th-kim0823 f485608108 fix(fb-34): address PR #125 round 1 review
- error_wire: StructuredError wrapper preserves ErrorV1 through
  anyhow → classify pipeline. Adds downcast short-circuit so
  cursor::decode's typed code = "stale_cursor" reaches the wire
  instead of being string-formatted to code = "generic".
- app: search_with_opts now wraps cursor::decode error in
  StructuredError instead of anyhow! string format.
- test: error_wire pins both negative (bare anyhow → not
  stale_cursor) AND positive (StructuredError → stale_cursor)
  invariants. CLI integration test runs end-to-end and asserts
  error.v1.code on stderr.
- app: next_cursor only emitted on full-page (k-pop) path; drop
  speculative emit on snippet-only truncation that would point at
  a different page than the agent expected.
- cursor: differentiate malformed-base64 / malformed-payload /
  revision-mismatch error messages; all keep code = stale_cursor.
- test: cursor_rejected fixture uses .expect() to fail loud on
  cursor non-emission instead of silent skip.
- test: max_tokens=0 → 1-hit floor + truncated=true.
- docs: SKILL.md + schema description distinguish snippet-shrink
  (widen) vs k-pop (paginate) truncated cases. HOTFIXES notes
  --no-cache semantic shift (cached path + clear vs uncached path).

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-09 20:49:27 +09:00

261 lines
10 KiB
Rust

//! Map `anyhow::Error` (returned by `kebab-app` facade calls) to the
//! `error.v1` wire shape. The classifier downcasts to known typed errors
//! re-exported via `kebab_app::error_signal` (LlmError, ConfigInvalid,
//! NotIndexed) and falls back to `code: "generic"` for everything else.
//!
//! Refusal / no-hit / doctor-unhealthy are NOT routed here — they remain
//! exit-code-only signals (see main.rs `exit_code()`).
use serde::{Deserialize, Serialize};
use serde_json::{Value, json};
use crate::error_signal::{ConfigInvalid, LlmError, NotIndexed};
// p9-fb-34: `stale_cursor` is constructed directly by `cursor::decode`
// and surfaced through `StructuredError` (an anyhow-friendly wrapper
// that carries the typed `ErrorV1` payload without lossy string
// formatting). `classify` short-circuits on it at the top of the
// function so the typed `code = "stale_cursor"` reaches the wire.
/// Wire schema id for [`ErrorV1`]. Single source of truth — kebab-cli
/// + kebab-mcp use this via `kebab_app::ERROR_V1_ID`.
pub const ERROR_V1_ID: &str = "error.v1";
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ErrorV1 {
pub schema_version: String,
pub code: String,
pub message: String,
pub details: Value,
pub hint: Option<String>,
}
/// p9-fb-34: typed wrapper around an [`ErrorV1`] so callers that
/// surface `anyhow::Error` can downcast back to the structured wire
/// payload instead of losing it to string formatting. Constructed by
/// the cursor code path (`cursor::decode` → `App::search_with_opts`)
/// and short-circuited inside [`classify`].
#[derive(Debug)]
pub struct StructuredError(pub ErrorV1);
impl std::fmt::Display for StructuredError {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
write!(f, "[{}] {}", self.0.code, self.0.message)
}
}
impl std::error::Error for StructuredError {}
pub fn classify(err: &anyhow::Error, verbose: bool) -> ErrorV1 {
// p9-fb-34: structured wrapper short-circuits — preserves the
// typed payload that callers (cursor::decode) constructed
// instead of falling through to `code = "generic"`.
if let Some(s) = err.downcast_ref::<StructuredError>() {
return s.0.clone();
}
if let Some(s) = err.downcast_ref::<ConfigInvalid>() {
return ErrorV1 {
schema_version: ERROR_V1_ID.to_string(),
code: "config_invalid".to_string(),
message: s.to_string(),
details: json!({
"path": s.path.to_string_lossy(),
"cause": s.cause,
}),
hint: Some("check `--config <path>` and TOML syntax".to_string()),
};
}
if let Some(s) = err.downcast_ref::<NotIndexed>() {
return ErrorV1 {
schema_version: ERROR_V1_ID.to_string(),
code: "not_indexed".to_string(),
message: s.to_string(),
details: json!({
"expected": s.expected,
"found": s.found,
}),
hint: Some("run `kebab init` then `kebab ingest`".to_string()),
};
}
if let Some(s) = err.downcast_ref::<LlmError>() {
return classify_llm(s);
}
if let Some(io) = err.downcast_ref::<std::io::Error>() {
return ErrorV1 {
schema_version: ERROR_V1_ID.to_string(),
code: "io_error".to_string(),
message: io.to_string(),
details: json!({"kind": format!("{:?}", io.kind())}),
hint: None,
};
}
let mut details = json!({});
if verbose {
let chain: Vec<String> = err.chain().map(|c| c.to_string()).collect();
details = json!({"chain": chain});
}
ErrorV1 {
schema_version: ERROR_V1_ID.to_string(),
code: "generic".to_string(),
message: err.to_string(),
details,
hint: None,
}
}
fn classify_llm(s: &LlmError) -> ErrorV1 {
match s {
LlmError::Unreachable { endpoint, source } => ErrorV1 {
schema_version: ERROR_V1_ID.to_string(),
code: "model_unreachable".to_string(),
message: format!("ollama unreachable at {endpoint}"),
details: json!({
"endpoint": endpoint,
"source": source.to_string(),
}),
hint: Some(format!("ensure `ollama serve` is reachable at {endpoint}")),
},
LlmError::ModelNotPulled(model) => ErrorV1 {
schema_version: ERROR_V1_ID.to_string(),
code: "model_not_pulled".to_string(),
message: format!("ollama model `{model}` is not pulled"),
details: json!({"model": model}),
hint: Some(format!("run `ollama pull {model}`")),
},
LlmError::Timeout(e) => ErrorV1 {
schema_version: ERROR_V1_ID.to_string(),
code: "timeout".to_string(),
message: format!("ollama timeout: {e}"),
details: json!({"source": e.to_string()}),
hint: Some("increase timeout or check Ollama load".to_string()),
},
LlmError::Stream(body) => ErrorV1 {
schema_version: ERROR_V1_ID.to_string(),
code: "generic".to_string(),
message: format!("ollama HTTP error: {body}"),
details: json!({"body": body}),
hint: None,
},
LlmError::Malformed(line) => ErrorV1 {
schema_version: ERROR_V1_ID.to_string(),
code: "generic".to_string(),
message: format!("malformed response line: {line}"),
details: json!({"line": line}),
hint: None,
},
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn config_invalid_classifies_to_config_invalid_code() {
let err = anyhow::Error::new(ConfigInvalid {
path: std::path::PathBuf::from("/tmp/x.toml"),
cause: "missing".to_string(),
});
let v1 = classify(&err, false);
assert_eq!(v1.code, "config_invalid");
assert_eq!(v1.details.get("path").and_then(|p| p.as_str()), Some("/tmp/x.toml"));
assert!(v1.hint.is_some());
}
#[test]
fn not_indexed_classifies_correctly() {
let err = anyhow::Error::new(NotIndexed {
expected: "/data/k.sqlite".to_string(),
found: None,
});
let v1 = classify(&err, false);
assert_eq!(v1.code, "not_indexed");
}
#[test]
fn llm_unreachable_classifies_to_model_unreachable() {
// We cannot construct a reqwest::Error from scratch (private constructor).
// Approach: send a real request to a guaranteed-unroutable endpoint
// (port 1 is reserved + connect-refused on all conformant TCP stacks).
// 500ms timeout chosen as headroom over 50ms baseline — heavily loaded
// CI may hit timeout race instead of connect-refused, but either way
// the resulting LlmError::Unreachable maps to "model_unreachable".
let client = reqwest::blocking::Client::builder()
.timeout(std::time::Duration::from_millis(500))
.build().unwrap();
let err = client.get("http://127.0.0.1:1").send().unwrap_err();
let llm = LlmError::Unreachable {
endpoint: "http://127.0.0.1:1".to_string(),
source: err,
};
let anyhow_err = anyhow::Error::new(llm);
let v1 = classify(&anyhow_err, false);
assert_eq!(v1.code, "model_unreachable");
}
#[test]
fn model_not_pulled_classifies_correctly() {
let llm = LlmError::ModelNotPulled("gemma4:e4b".to_string());
let v1 = classify(&anyhow::Error::new(llm), false);
assert_eq!(v1.code, "model_not_pulled");
assert_eq!(v1.details.get("model").and_then(|p| p.as_str()), Some("gemma4:e4b"));
}
#[test]
fn unknown_error_classifies_to_generic() {
let err = anyhow::anyhow!("something else");
let v1 = classify(&err, false);
assert_eq!(v1.code, "generic");
assert!(v1.hint.is_none());
}
#[test]
fn generic_with_verbose_includes_chain() {
let err = anyhow::anyhow!("root").context("middle").context("leaf");
let v1 = classify(&err, true);
assert_eq!(v1.code, "generic");
let chain = v1.details.get("chain").and_then(|c| c.as_array()).unwrap();
assert_eq!(chain.len(), 3);
}
#[test]
fn io_error_classifies_correctly() {
let io = std::io::Error::new(std::io::ErrorKind::NotFound, "no such file");
let err = anyhow::Error::new(io);
let v1 = classify(&err, false);
assert_eq!(v1.code, "io_error");
}
#[test]
fn stale_cursor_is_not_routed_through_classify() {
use anyhow::anyhow;
let err: anyhow::Error = anyhow!("stale_cursor: rev mismatch");
let v1 = classify(&err, false);
// p9-fb-34: stale_cursor is constructed directly by cursor::decode
// (single source of truth). classify must not pattern-match on
// anyhow string contents — that would create two sources of
// truth. The bare anyhow string falls through to "generic".
assert_ne!(v1.code, "stale_cursor", "classify must not produce stale_cursor from bare anyhow string");
}
#[test]
fn stale_cursor_propagates_through_structured_wrapper() {
// p9-fb-34: positive-side contract for the structured-wrapper
// path. cursor::decode constructs a typed ErrorV1, the call site
// wraps it in `StructuredError`, anyhow carries it, and classify
// short-circuits via downcast — preserving the typed code +
// message instead of falling through to "generic".
let original = ErrorV1 {
schema_version: ERROR_V1_ID.to_string(),
code: "stale_cursor".to_string(),
message: "test stale cursor".to_string(),
details: Value::Null,
hint: None,
};
let err: anyhow::Error = anyhow::Error::new(StructuredError(original));
let v1 = classify(&err, false);
assert_eq!(v1.code, "stale_cursor");
assert_eq!(v1.message, "test stale cursor");
}
}