1pub mod trace;
11
12use std::path::{Path, PathBuf};
13use std::sync::Arc;
14use std::sync::atomic::{AtomicU32, Ordering};
15
16use base64::Engine as _;
17use zeph_llm::provider::{Message, MessagePart, Role, ToolDefinition};
18
19use crate::redact::scrub_content;
20
21pub use zeph_config::DumpFormat;
22
23#[derive(Clone)]
25pub struct DebugDumper {
26 dir: PathBuf,
27 counter: Arc<AtomicU32>,
28 format: DumpFormat,
29}
30
31pub struct RequestDebugDump<'a> {
32 pub model_name: &'a str,
33 pub messages: &'a [Message],
34 pub tools: &'a [ToolDefinition],
35 pub provider_request: serde_json::Value,
36 pub memcot_state: Option<&'a str>,
41}
42
43impl DebugDumper {
44 pub fn new(base_dir: &Path, format: DumpFormat) -> std::io::Result<Self> {
50 let ts = std::time::SystemTime::now()
51 .duration_since(std::time::UNIX_EPOCH)
52 .map_or(0, |d| d.as_secs());
53 let dir = base_dir.join(ts.to_string());
54 std::fs::create_dir_all(&dir)?;
55 tracing::info!(path = %dir.display(), format = ?format, "debug dump directory created");
56 Ok(Self {
57 dir,
58 counter: Arc::new(AtomicU32::new(0)),
59 format,
60 })
61 }
62
63 #[must_use]
65 pub fn dir(&self) -> &Path {
66 &self.dir
67 }
68
69 #[must_use]
74 pub fn is_trace_format(&self) -> bool {
75 self.format == DumpFormat::Trace
76 }
77
78 fn next_id(&self) -> u32 {
79 self.counter.fetch_add(1, Ordering::Relaxed)
80 }
81
82 fn write(&self, filename: &str, content: &[u8]) {
83 let path = self.dir.join(filename);
84 if let Err(e) = zeph_common::fs_secure::write_private(&path, content) {
85 tracing::warn!(path = %path.display(), error = %e, "debug dump write failed");
86 }
87 }
88
89 #[must_use]
94 pub fn dump_request(&self, request: &RequestDebugDump<'_>) -> u32 {
95 let id = self.next_id();
96 if self.format == DumpFormat::Trace {
98 return id;
99 }
100 let json = match self.format {
101 DumpFormat::Raw => raw_dump(request),
102 DumpFormat::Trace => unreachable!("handled above"),
103 _ => json_dump(request),
104 };
105 self.write(&format!("{id:04}-request.json"), json.as_bytes());
106 id
107 }
108
109 pub fn dump_response(&self, id: u32, response: &str) {
112 if self.format == DumpFormat::Trace {
113 return;
114 }
115 self.write(&format!("{id:04}-response.txt"), response.as_bytes());
116 }
117
118 pub fn dump_tool_output(&self, tool_name: &str, output: &str) {
121 if self.format == DumpFormat::Trace {
122 return;
123 }
124 let id = self.next_id();
125 let safe_name = sanitize_dump_name(tool_name);
126 self.write(&format!("{id:04}-tool-{safe_name}.txt"), output.as_bytes());
127 }
128
129 #[cfg(test)]
132 pub(crate) fn dump_pruning_scores(&self, scores: &[zeph_agent_context::BlockScore]) {
133 if self.format == DumpFormat::Trace {
134 return;
135 }
136 let id = self.next_id();
137 let payload: Vec<serde_json::Value> = scores
138 .iter()
139 .map(|s| {
140 serde_json::json!({
141 "msg_index": s.msg_index,
142 "relevance": s.relevance,
143 "redundancy": s.redundancy,
144 "mig": s.mig,
145 })
146 })
147 .collect();
148 match serde_json::to_string_pretty(&serde_json::json!({ "scores": payload })) {
149 Ok(json) => self.write(&format!("{id:04}-pruning-scores.json"), json.as_bytes()),
150 Err(e) => tracing::warn!("dump_pruning_scores: serialize failed: {e}"),
151 }
152 }
153
154 pub(crate) fn dump_anchored_summary(
159 &self,
160 summary: &zeph_memory::AnchoredSummary,
161 fallback: bool,
162 token_counter: &zeph_memory::TokenCounter,
163 ) {
164 if self.format == DumpFormat::Trace {
165 return;
166 }
167 let id = self.next_id();
168 let section_completeness = serde_json::json!({
169 "session_intent": !summary.session_intent.trim().is_empty(),
170 "files_modified": !summary.files_modified.is_empty(),
171 "decisions_made": !summary.decisions_made.is_empty(),
172 "open_questions": !summary.open_questions.is_empty(),
173 "next_steps": !summary.next_steps.is_empty(),
174 });
175 let total_items = summary.files_modified.len()
176 + summary.decisions_made.len()
177 + summary.open_questions.len()
178 + summary.next_steps.len();
179 let markdown = summary.to_markdown();
180 let token_estimate = token_counter.count_tokens(&markdown);
181 let payload = serde_json::json!({
182 "summary": summary,
183 "section_completeness": section_completeness,
184 "total_items": total_items,
185 "token_estimate": token_estimate,
186 "fallback": fallback,
187 });
188 match serde_json::to_string_pretty(&payload) {
189 Ok(json) => self.write(&format!("{id:04}-anchored-summary.json"), json.as_bytes()),
190 Err(e) => tracing::warn!("dump_anchored_summary: serialize failed: {e}"),
191 }
192 }
193
194 pub(crate) fn dump_compaction_probe(&self, result: &zeph_memory::CompactionProbeResult) {
197 if self.format == DumpFormat::Trace {
198 return;
199 }
200 let id = self.next_id();
201 let questions: Vec<serde_json::Value> = result
202 .questions
203 .iter()
204 .zip(
205 result
206 .answers
207 .iter()
208 .chain(std::iter::repeat(&String::new())),
209 )
210 .zip(
211 result
212 .per_question_scores
213 .iter()
214 .chain(std::iter::repeat(&0.0_f32)),
215 )
216 .map(|((q, a), &s)| {
217 serde_json::json!({
218 "question": scrub_content(&q.question),
219 "expected": scrub_content(&q.expected_answer),
220 "actual": scrub_content(a),
221 "score": s,
222 "category": format!("{:?}", q.category),
223 })
224 })
225 .collect();
226 let category_scores: Vec<serde_json::Value> = result
227 .category_scores
228 .iter()
229 .map(|cs| {
230 serde_json::json!({
231 "category": format!("{:?}", cs.category),
232 "score": cs.score,
233 "probes_run": cs.probes_run,
234 })
235 })
236 .collect();
237 let payload = serde_json::json!({
238 "score": result.score,
239 "category_scores": category_scores,
240 "threshold": result.threshold,
241 "hard_fail_threshold": result.hard_fail_threshold,
242 "verdict": format!("{:?}", result.verdict),
243 "model": result.model,
244 "duration_ms": result.duration_ms,
245 "questions": questions,
246 });
247 match serde_json::to_string_pretty(&payload) {
248 Ok(json) => {
249 self.write(&format!("{id:04}-compaction-probe.json"), json.as_bytes());
250 }
251 Err(e) => tracing::warn!("dump_compaction_probe: serialize failed: {e}"),
252 }
253 }
254
255 pub fn dump_focus_knowledge(&self, knowledge: &str) {
258 if self.format == DumpFormat::Trace {
259 return;
260 }
261 let id = self.next_id();
262 self.write(
263 &format!("{id:04}-focus-knowledge.txt"),
264 knowledge.as_bytes(),
265 );
266 }
267
268 pub(crate) fn dump_sidequest_eviction(
271 &self,
272 cursors: &[crate::agent::sidequest::ToolOutputCursor],
273 evicted_indices: &[usize],
274 freed_tokens: usize,
275 ) {
276 if self.format == DumpFormat::Trace {
277 return;
278 }
279 let id = self.next_id();
280 let cursor_info: Vec<serde_json::Value> = cursors
281 .iter()
282 .enumerate()
283 .map(|(i, c)| {
284 serde_json::json!({
285 "cursor_id": i,
286 "msg_index": c.msg_index,
287 "part_index": c.part_index,
288 "tool_name": c.tool_name,
289 "token_count": c.token_count,
290 "evicted": evicted_indices.contains(&i),
291 })
292 })
293 .collect();
294 let payload = serde_json::json!({
295 "cursors": cursor_info,
296 "evicted_indices": evicted_indices,
297 "freed_tokens": freed_tokens,
298 });
299 match serde_json::to_string_pretty(&payload) {
300 Ok(json) => self.write(&format!("{id:04}-sidequest-eviction.json"), json.as_bytes()),
301 Err(e) => tracing::warn!("dump_sidequest_eviction: serialize failed: {e}"),
302 }
303 }
304
305 #[cfg(test)]
310 pub(crate) fn dump_subgoal_registry(&self, registry: &zeph_agent_context::SubgoalRegistry) {
311 if self.format == DumpFormat::Trace {
312 return;
313 }
314 let id = self.next_id();
315 let mut output = String::from("=== Subgoal Registry ===\n");
316 if registry.subgoals.is_empty() {
317 output.push_str("(no subgoals tracked yet)\n");
318 } else {
319 for sg in ®istry.subgoals {
320 let state_str = match sg.state {
321 zeph_agent_context::SubgoalState::Active => "Active ",
322 zeph_agent_context::SubgoalState::Completed => "Completed",
323 _ => "Unknown ",
324 };
325 let _ = std::fmt::write(
326 &mut output,
327 format_args!(
328 "[{}] {state_str}: \"{}\" (msgs {}-{})\n",
329 sg.id.0, sg.description, sg.start_msg_index, sg.end_msg_index,
330 ),
331 );
332 }
333 }
334 self.write(&format!("{id:04}-subgoal-registry.txt"), output.as_bytes());
335 }
336
337 pub fn dump_tool_error(&self, tool_name: &str, error: &zeph_tools::ToolError) {
340 if self.format == DumpFormat::Trace {
341 return;
342 }
343 let id = self.next_id();
344 let safe_name = sanitize_dump_name(tool_name);
345 let payload = serde_json::json!({
346 "tool": tool_name,
347 "error": error.to_string(),
348 "kind": error.kind().to_string(),
349 });
350 match serde_json::to_string_pretty(&payload) {
351 Ok(json) => {
352 self.write(
353 &format!("{id:04}-tool-error-{safe_name}.json"),
354 json.as_bytes(),
355 );
356 }
357 Err(e) => {
358 tracing::warn!("dump_tool_error: failed to serialize error payload: {e}");
359 }
360 }
361 }
362}
363
364fn json_dump(request: &RequestDebugDump<'_>) -> String {
365 let payload = serde_json::json!({
366 "model": extract_model(&request.provider_request, request.model_name),
367 "max_tokens": extract_max_tokens(&request.provider_request),
368 "messages": serde_json::to_value(request.messages)
369 .unwrap_or(serde_json::Value::Array(vec![])),
370 "tools": extract_tools(&request.provider_request, request.tools),
371 "temperature": request
372 .provider_request
373 .get("temperature")
374 .cloned()
375 .unwrap_or(serde_json::Value::Null),
376 "cache_control": request
377 .provider_request
378 .get("cache_control")
379 .cloned()
380 .unwrap_or(serde_json::Value::Null),
381 "memcot_state": request.memcot_state,
382 });
383 serde_json::to_string_pretty(&payload).unwrap_or_else(|e| format!("serialization error: {e}"))
384}
385
386fn raw_dump(request: &RequestDebugDump<'_>) -> String {
387 let mut payload = if request.provider_request.is_object() {
388 request.provider_request.clone()
389 } else {
390 serde_json::json!({})
391 };
392 if let Some(obj) = payload.as_object_mut() {
393 obj.entry("model")
394 .or_insert_with(|| extract_model(&request.provider_request, request.model_name));
395 obj.entry("max_tokens")
396 .or_insert_with(|| extract_max_tokens(&request.provider_request));
397 obj.entry("tools")
398 .or_insert_with(|| extract_tools(&request.provider_request, request.tools));
399 obj.entry("temperature").or_insert_with(|| {
400 request
401 .provider_request
402 .get("temperature")
403 .cloned()
404 .unwrap_or(serde_json::Value::Null)
405 });
406 obj.entry("cache_control").or_insert_with(|| {
407 request
408 .provider_request
409 .get("cache_control")
410 .cloned()
411 .unwrap_or(serde_json::Value::Null)
412 });
413 obj.insert(
414 "memcot_state".to_owned(),
415 match request.memcot_state {
416 Some(s) => serde_json::Value::String(s.to_owned()),
417 None => serde_json::Value::Null,
418 },
419 );
420 if !obj.contains_key("messages") && !obj.contains_key("system") {
421 let generic = messages_to_api_value(request.messages);
422 if let Some(generic_obj) = generic.as_object() {
423 for (key, value) in generic_obj {
424 obj.insert(key.clone(), value.clone());
425 }
426 }
427 }
428 }
429 serde_json::to_string_pretty(&payload).unwrap_or_else(|e| format!("serialization error: {e}"))
430}
431
432fn extract_model(payload: &serde_json::Value, fallback: &str) -> serde_json::Value {
433 payload
434 .get("model")
435 .cloned()
436 .unwrap_or_else(|| serde_json::json!(fallback))
437}
438
439fn extract_max_tokens(payload: &serde_json::Value) -> serde_json::Value {
440 payload
441 .get("max_tokens")
442 .cloned()
443 .or_else(|| payload.get("max_completion_tokens").cloned())
444 .unwrap_or(serde_json::Value::Null)
445}
446
447fn extract_tools(payload: &serde_json::Value, fallback: &[ToolDefinition]) -> serde_json::Value {
448 payload.get("tools").cloned().unwrap_or_else(|| {
449 serde_json::to_value(fallback).unwrap_or(serde_json::Value::Array(vec![]))
450 })
451}
452
453fn sanitize_dump_name(name: &str) -> String {
454 name.chars()
455 .map(|c| {
456 if c.is_alphanumeric() || c == '-' {
457 c
458 } else {
459 '_'
460 }
461 })
462 .collect()
463}
464
465fn messages_to_api_value(messages: &[Message]) -> serde_json::Value {
469 let system: String = messages
470 .iter()
471 .filter(|m| m.metadata.visibility.is_agent_visible() && m.role == Role::System)
472 .map(zeph_llm::provider::Message::to_llm_content)
473 .collect::<Vec<_>>()
474 .join("\n\n");
475
476 let chat: Vec<serde_json::Value> = messages
477 .iter()
478 .filter(|m| m.metadata.visibility.is_agent_visible() && m.role != Role::System)
479 .filter_map(|m| {
480 let role = match m.role {
481 Role::User => "user",
482 Role::Assistant => "assistant",
483 Role::System | _ => return None,
484 };
485 let is_assistant = m.role == Role::Assistant;
486 let has_structured = m.parts.iter().any(|p| {
487 matches!(
488 p,
489 MessagePart::ToolUse { .. }
490 | MessagePart::ToolResult { .. }
491 | MessagePart::Image(_)
492 | MessagePart::ThinkingBlock { .. }
493 | MessagePart::RedactedThinkingBlock { .. }
494 )
495 });
496 let content: serde_json::Value = if !has_structured || m.parts.is_empty() {
497 let text = m.to_llm_content();
498 if text.trim().is_empty() {
499 return None;
500 }
501 serde_json::json!(text)
502 } else {
503 let blocks: Vec<serde_json::Value> = m
504 .parts
505 .iter()
506 .filter_map(|p| part_to_block(p, is_assistant))
507 .collect();
508 if blocks.is_empty() {
509 return None;
510 }
511 serde_json::Value::Array(blocks)
512 };
513 Some(serde_json::json!({ "role": role, "content": content }))
514 })
515 .collect();
516
517 serde_json::json!({ "system": system, "messages": chat })
518}
519
520fn part_to_block(part: &MessagePart, is_assistant: bool) -> Option<serde_json::Value> {
521 match part {
522 MessagePart::Text { text }
523 | MessagePart::Recall { text }
524 | MessagePart::CodeContext { text }
525 | MessagePart::Summary { text }
526 | MessagePart::CrossSession { text } => {
527 if text.trim().is_empty() {
528 None
529 } else {
530 Some(serde_json::json!({ "type": "text", "text": text }))
531 }
532 }
533 MessagePart::ToolOutput {
534 tool_name,
535 body,
536 compacted_at,
537 } => {
538 let text = if compacted_at.is_some() {
539 if body.is_empty() {
540 format!("[tool output: {tool_name}] (pruned)")
541 } else {
542 format!("[tool output: {tool_name}] {body}")
543 }
544 } else {
545 format!("[tool output: {tool_name}]\n{body}")
546 };
547 Some(serde_json::json!({ "type": "text", "text": text }))
548 }
549 MessagePart::ToolUse { id, name, input } if is_assistant => {
550 Some(serde_json::json!({ "type": "tool_use", "id": id, "name": name, "input": input }))
551 }
552 MessagePart::ToolUse { name, input, .. } => Some(
553 serde_json::json!({ "type": "text", "text": format!("[tool_use: {name}] {input}") }),
554 ),
555 MessagePart::ToolResult {
556 tool_use_id,
557 content,
558 is_error,
559 } if !is_assistant => Some(
560 serde_json::json!({ "type": "tool_result", "tool_use_id": tool_use_id, "content": content, "is_error": is_error }),
561 ),
562 MessagePart::ToolResult { content, .. } => {
563 if content.trim().is_empty() {
564 None
565 } else {
566 Some(serde_json::json!({ "type": "text", "text": content }))
567 }
568 }
569 MessagePart::ThinkingBlock {
570 thinking,
571 signature,
572 } if is_assistant => Some(
573 serde_json::json!({ "type": "thinking", "thinking": thinking, "signature": signature }),
574 ),
575 MessagePart::RedactedThinkingBlock { data } if is_assistant => {
576 Some(serde_json::json!({ "type": "redacted_thinking", "data": data }))
577 }
578 MessagePart::ThinkingBlock { .. }
579 | MessagePart::RedactedThinkingBlock { .. }
580 | MessagePart::Compaction { .. }
581 if !is_assistant =>
582 {
583 None
584 }
585 MessagePart::Compaction { summary } => {
586 Some(serde_json::json!({ "type": "compaction", "summary": summary }))
587 }
588 MessagePart::Image(img) => Some(serde_json::json!({
589 "type": "image",
590 "source": {
591 "type": "base64",
592 "media_type": img.mime_type,
593 "data": base64::engine::general_purpose::STANDARD.encode(&img.data),
594 },
595 })),
596 _ => None,
597 }
598}
599
600#[cfg(test)]
601mod tests {
602 use super::*;
603 use tempfile::tempdir;
604
605 #[test]
606 fn dump_format_from_str_valid() {
607 assert_eq!("json".parse::<DumpFormat>().unwrap(), DumpFormat::Json);
608 assert_eq!("raw".parse::<DumpFormat>().unwrap(), DumpFormat::Raw);
609 assert_eq!("trace".parse::<DumpFormat>().unwrap(), DumpFormat::Trace);
610 }
611
612 #[test]
613 fn dump_format_from_str_invalid_returns_error() {
614 let err = "binary".parse::<DumpFormat>().unwrap_err();
615 assert!(
616 err.contains("unknown dump format"),
617 "error must mention unknown dump format: {err}"
618 );
619 }
620
621 fn sample_messages() -> Vec<Message> {
622 vec![
623 Message::from_legacy(Role::System, "system prompt"),
624 Message::from_legacy(Role::User, "hello"),
625 ]
626 }
627
628 fn sample_tools() -> Vec<ToolDefinition> {
629 vec![ToolDefinition {
630 name: "read_file".into(),
631 description: "Read a file".into(),
632 parameters: serde_json::json!({
633 "type": "object",
634 "properties": { "path": { "type": "string" } },
635 }),
636 output_schema: None,
637 }]
638 }
639
640 fn read_request_dump(dir: &Path) -> serde_json::Value {
641 let session = std::fs::read_dir(dir)
642 .unwrap()
643 .next()
644 .unwrap()
645 .unwrap()
646 .path();
647 serde_json::from_str(&std::fs::read_to_string(session.join("0000-request.json")).unwrap())
648 .unwrap()
649 }
650
651 #[test]
652 fn json_dump_request_includes_request_metadata() {
653 let dir = tempdir().unwrap();
654 let dumper = DebugDumper::new(dir.path(), DumpFormat::Json).unwrap();
655 let messages = sample_messages();
656 let tools = sample_tools();
657
658 let _ = dumper.dump_request(&RequestDebugDump {
659 model_name: "claude-sonnet-test",
660 messages: &messages,
661 tools: &tools,
662 provider_request: serde_json::json!({
663 "model": "claude-sonnet-test",
664 "max_tokens": 4096,
665 "tools": [{ "name": "read_file" }],
666 "temperature": 0.7,
667 "cache_control": { "type": "ephemeral" }
668 }),
669 memcot_state: None,
670 });
671
672 let payload = read_request_dump(dir.path());
673 assert_eq!(payload["model"], "claude-sonnet-test");
674 assert_eq!(payload["max_tokens"], 4096);
675 assert_eq!(payload["tools"][0]["name"], "read_file");
676 assert_eq!(payload["temperature"], 0.7);
677 assert_eq!(payload["cache_control"]["type"], "ephemeral");
678 assert_eq!(payload["messages"][1]["content"], "hello");
679 }
680
681 #[test]
682 fn raw_dump_request_includes_request_metadata() {
683 let dir = tempdir().unwrap();
684 let dumper = DebugDumper::new(dir.path(), DumpFormat::Raw).unwrap();
685 let messages = sample_messages();
686 let tools = sample_tools();
687
688 let _ = dumper.dump_request(&RequestDebugDump {
689 model_name: "gpt-5-mini",
690 messages: &messages,
691 tools: &tools,
692 provider_request: serde_json::json!({
693 "model": "gpt-5-mini",
694 "max_completion_tokens": 2048,
695 "messages": [{ "role": "user", "content": "hello" }],
696 "tools": [{ "type": "function", "function": { "name": "read_file" } }],
697 "temperature": 0.3,
698 "cache_control": null
699 }),
700 memcot_state: None,
701 });
702
703 let payload = read_request_dump(dir.path());
704 assert_eq!(payload["model"], "gpt-5-mini");
705 assert_eq!(payload["max_tokens"], 2048);
706 assert_eq!(payload["tools"][0]["function"]["name"], "read_file");
707 assert_eq!(payload["temperature"], 0.3);
708 assert_eq!(payload["messages"][0]["content"], "hello");
709 }
710
711 #[test]
712 fn memcot_state_written_to_dump_when_present() {
713 for fmt in [DumpFormat::Json, DumpFormat::Raw] {
714 let dir = tempdir().unwrap();
715 let dumper = DebugDumper::new(dir.path(), fmt).unwrap();
716 let messages = sample_messages();
717 let tools = sample_tools();
718
719 let _ = dumper.dump_request(&RequestDebugDump {
720 model_name: "test-model",
721 messages: &messages,
722 tools: &tools,
723 provider_request: serde_json::json!({ "model": "test-model", "max_tokens": 1024 }),
724 memcot_state: Some("Rust uses LLVM; user is refactoring the parser"),
725 });
726
727 let payload = read_request_dump(dir.path());
728 assert_eq!(
729 payload["memcot_state"], "Rust uses LLVM; user is refactoring the parser",
730 "memcot_state must appear in {fmt:?} dump"
731 );
732 }
733 }
734
735 #[test]
736 fn memcot_state_null_when_absent() {
737 let dir = tempdir().unwrap();
738 let dumper = DebugDumper::new(dir.path(), DumpFormat::Json).unwrap();
739 let messages = sample_messages();
740 let tools = sample_tools();
741
742 let _ = dumper.dump_request(&RequestDebugDump {
743 model_name: "test-model",
744 messages: &messages,
745 tools: &tools,
746 provider_request: serde_json::json!({ "model": "test-model", "max_tokens": 1024 }),
747 memcot_state: None,
748 });
749
750 let payload = read_request_dump(dir.path());
751 assert!(
752 payload["memcot_state"].is_null(),
753 "memcot_state must be null when None"
754 );
755 }
756}