1use chrono::{DateTime, Utc};
40use hashbrown::HashMap;
41use serde::{Deserialize, Serialize};
42use serde_json::Value;
43use std::path::PathBuf;
44
45pub const AGENT_TRACE_VERSION: &str = "0.1.0";
47
48pub const AGENT_TRACE_MIME_TYPE: &str = "application/vnd.agent-trace.record+json";
50
51#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
60#[cfg_attr(feature = "schema-export", derive(schemars::JsonSchema))]
61pub struct TraceRecord {
62 pub version: String,
64
65 #[serde(serialize_with = "serialize_uuid", deserialize_with = "deserialize_uuid")]
67 #[cfg_attr(feature = "schema-export", schemars(with = "String"))]
68 pub id: uuid::Uuid,
69
70 #[cfg_attr(feature = "schema-export", schemars(with = "String"))]
72 pub timestamp: DateTime<Utc>,
73
74 #[serde(skip_serializing_if = "Option::is_none")]
76 pub vcs: Option<VcsInfo>,
77
78 #[serde(skip_serializing_if = "Option::is_none")]
80 pub tool: Option<ToolInfo>,
81
82 pub files: Vec<TraceFile>,
84
85 #[serde(skip_serializing_if = "Option::is_none")]
87 pub metadata: Option<TraceMetadata>,
88}
89
90impl TraceRecord {
91 pub fn new() -> Self {
93 Self {
94 version: AGENT_TRACE_VERSION.to_string(),
95 id: uuid::Uuid::new_v4(),
96 timestamp: Utc::now(),
97 vcs: None,
98 tool: Some(ToolInfo::vtcode()),
99 files: Vec::new(),
100 metadata: None,
101 }
102 }
103
104 pub fn for_git_revision(revision: impl Into<String>) -> Self {
106 let mut trace = Self::new();
107 trace.vcs = Some(VcsInfo::git(revision));
108 trace
109 }
110
111 pub fn add_file(&mut self, file: TraceFile) {
113 self.files.push(file);
114 }
115
116 pub fn has_attributions(&self) -> bool {
118 self.files.iter().any(|f| f.conversations.iter().any(|c| !c.ranges.is_empty()))
119 }
120}
121
122impl Default for TraceRecord {
123 fn default() -> Self {
124 Self::new()
125 }
126}
127
128#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
134#[cfg_attr(feature = "schema-export", derive(schemars::JsonSchema))]
135pub struct VcsInfo {
136 #[serde(rename = "type")]
138 pub vcs_type: VcsType,
139
140 pub revision: String,
142}
143
144impl VcsInfo {
145 pub fn git(revision: impl Into<String>) -> Self {
147 Self { vcs_type: VcsType::Git, revision: revision.into() }
148 }
149
150 pub fn jj(change_id: impl Into<String>) -> Self {
152 Self { vcs_type: VcsType::Jj, revision: change_id.into() }
153 }
154}
155
156#[derive(Debug, Clone, Copy, Serialize, Deserialize, PartialEq, Eq)]
158#[cfg_attr(feature = "schema-export", derive(schemars::JsonSchema))]
159#[serde(rename_all = "lowercase")]
160pub enum VcsType {
161 Git,
163 Jj,
165 Hg,
167 Svn,
169}
170
171#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
177#[cfg_attr(feature = "schema-export", derive(schemars::JsonSchema))]
178pub struct ToolInfo {
179 pub name: String,
181
182 #[serde(skip_serializing_if = "Option::is_none")]
184 pub version: Option<String>,
185}
186
187impl ToolInfo {
188 pub fn vtcode() -> Self {
190 Self {
191 name: "vtcode".to_string(),
192 version: Some(env!("CARGO_PKG_VERSION").to_string()),
193 }
194 }
195
196 pub fn new(name: impl Into<String>, version: Option<String>) -> Self {
198 Self { name: name.into(), version }
199 }
200}
201
202#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
208#[cfg_attr(feature = "schema-export", derive(schemars::JsonSchema))]
209pub struct TraceFile {
210 pub path: String,
212
213 pub conversations: Vec<TraceConversation>,
215}
216
217impl TraceFile {
218 pub fn new(path: impl Into<String>) -> Self {
220 Self { path: path.into(), conversations: Vec::new() }
221 }
222
223 pub fn add_conversation(&mut self, conversation: TraceConversation) {
225 self.conversations.push(conversation);
226 }
227
228 pub fn with_ai_ranges(path: impl Into<String>, model_id: impl Into<String>, ranges: Vec<TraceRange>) -> Self {
230 let mut file = Self::new(path);
231 file.add_conversation(TraceConversation {
232 url: None,
233 contributor: Some(Contributor::ai(model_id)),
234 ranges,
235 related: None,
236 });
237 file
238 }
239}
240
241#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
243#[cfg_attr(feature = "schema-export", derive(schemars::JsonSchema))]
244pub struct TraceConversation {
245 #[serde(skip_serializing_if = "Option::is_none")]
247 pub url: Option<String>,
248
249 #[serde(skip_serializing_if = "Option::is_none")]
251 pub contributor: Option<Contributor>,
252
253 pub ranges: Vec<TraceRange>,
255
256 #[serde(skip_serializing_if = "Option::is_none")]
258 pub related: Option<Vec<RelatedResource>>,
259}
260
261impl TraceConversation {
262 pub fn ai(model_id: impl Into<String>, ranges: Vec<TraceRange>) -> Self {
264 Self {
265 url: None,
266 contributor: Some(Contributor::ai(model_id)),
267 ranges,
268 related: None,
269 }
270 }
271
272 pub fn with_session_url(mut self, url: impl Into<String>) -> Self {
274 self.url = Some(url.into());
275 self
276 }
277}
278
279#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
281#[cfg_attr(feature = "schema-export", derive(schemars::JsonSchema))]
282pub struct RelatedResource {
283 #[serde(rename = "type")]
285 pub resource_type: String,
286
287 pub url: String,
289}
290
291impl RelatedResource {
292 pub fn session(url: impl Into<String>) -> Self {
294 Self {
295 resource_type: "session".to_string(),
296 url: url.into(),
297 }
298 }
299
300 pub fn prompt(url: impl Into<String>) -> Self {
302 Self {
303 resource_type: "prompt".to_string(),
304 url: url.into(),
305 }
306 }
307}
308
309#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
315#[cfg_attr(feature = "schema-export", derive(schemars::JsonSchema))]
316pub struct TraceRange {
317 pub start_line: u32,
319
320 pub end_line: u32,
322
323 #[serde(skip_serializing_if = "Option::is_none")]
325 pub content_hash: Option<String>,
326
327 #[serde(skip_serializing_if = "Option::is_none")]
329 pub contributor: Option<Contributor>,
330}
331
332impl TraceRange {
333 pub fn new(start_line: u32, end_line: u32) -> Self {
335 Self {
336 start_line,
337 end_line,
338 content_hash: None,
339 contributor: None,
340 }
341 }
342
343 pub fn single_line(line: u32) -> Self {
345 Self::new(line, line)
346 }
347
348 pub fn with_hash(mut self, hash: impl Into<String>) -> Self {
350 self.content_hash = Some(hash.into());
351 self
352 }
353
354 pub fn with_content_hash(mut self, content: &str) -> Self {
356 let hash = compute_content_hash(content);
357 self.content_hash = Some(hash);
358 self
359 }
360}
361
362#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
368#[cfg_attr(feature = "schema-export", derive(schemars::JsonSchema))]
369pub struct Contributor {
370 #[serde(rename = "type")]
372 pub contributor_type: ContributorType,
373
374 #[serde(skip_serializing_if = "Option::is_none")]
376 pub model_id: Option<String>,
377}
378
379impl Contributor {
380 pub fn ai(model_id: impl Into<String>) -> Self {
382 Self {
383 contributor_type: ContributorType::Ai,
384 model_id: Some(model_id.into()),
385 }
386 }
387
388 pub fn human() -> Self {
390 Self {
391 contributor_type: ContributorType::Human,
392 model_id: None,
393 }
394 }
395
396 pub fn mixed() -> Self {
398 Self {
399 contributor_type: ContributorType::Mixed,
400 model_id: None,
401 }
402 }
403
404 pub fn unknown() -> Self {
406 Self {
407 contributor_type: ContributorType::Unknown,
408 model_id: None,
409 }
410 }
411}
412
413#[derive(Debug, Clone, Copy, Serialize, Deserialize, PartialEq, Eq)]
415#[cfg_attr(feature = "schema-export", derive(schemars::JsonSchema))]
416#[serde(rename_all = "lowercase")]
417pub enum ContributorType {
418 Human,
420 Ai,
422 Mixed,
424 Unknown,
426}
427
428#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Default)]
434#[cfg_attr(feature = "schema-export", derive(schemars::JsonSchema))]
435pub struct TraceMetadata {
436 #[serde(skip_serializing_if = "Option::is_none")]
438 pub confidence: Option<f64>,
439
440 #[serde(skip_serializing_if = "Option::is_none")]
442 pub post_processing_tools: Option<Vec<String>>,
443
444 #[serde(rename = "dev.vtcode", skip_serializing_if = "Option::is_none")]
446 pub vtcode: Option<VtCodeMetadata>,
447
448 #[serde(flatten)]
450 #[cfg_attr(feature = "schema-export", schemars(skip))]
451 pub extra: HashMap<String, Value>,
452}
453
454#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq, Default)]
456#[cfg_attr(feature = "schema-export", derive(schemars::JsonSchema))]
457pub struct VtCodeMetadata {
458 #[serde(skip_serializing_if = "Option::is_none")]
460 pub session_id: Option<String>,
461
462 #[serde(skip_serializing_if = "Option::is_none")]
464 pub turn_number: Option<u32>,
465
466 #[serde(skip_serializing_if = "Option::is_none")]
468 pub workspace_path: Option<String>,
469
470 #[serde(skip_serializing_if = "Option::is_none")]
472 pub provider: Option<String>,
473}
474
475#[derive(Debug, Clone, Copy, Default)]
481pub enum HashAlgorithm {
482 #[default]
484 MurmurHash3,
485 Fnv1a,
487}
488
489pub fn compute_content_hash(content: &str) -> String {
493 compute_content_hash_with(content, HashAlgorithm::default())
494}
495
496pub fn compute_content_hash_with(content: &str, algorithm: HashAlgorithm) -> String {
498 match algorithm {
499 HashAlgorithm::MurmurHash3 => {
500 let hash = murmur3_32(content.as_bytes(), 0);
502 format!("murmur3:{hash:08x}")
503 }
504 HashAlgorithm::Fnv1a => {
505 const FNV_OFFSET: u64 = 14695981039346656037;
506 const FNV_PRIME: u64 = 1099511628211;
507 let mut hash = FNV_OFFSET;
508 for byte in content.bytes() {
509 hash ^= byte as u64;
510 hash = hash.wrapping_mul(FNV_PRIME);
511 }
512 format!("fnv1a:{hash:016x}")
513 }
514 }
515}
516
517fn murmur3_32(data: &[u8], seed: u32) -> u32 {
519 const C1: u32 = 0xcc9e2d51;
520 const C2: u32 = 0x1b873593;
521 const R1: u32 = 15;
522 const R2: u32 = 13;
523 const M: u32 = 5;
524 const N: u32 = 0xe6546b64;
525
526 let mut hash = seed;
527 let len = data.len();
528
529 let mut chunks = data.chunks_exact(4);
531 for chunk in &mut chunks {
532 let mut k = u32::from_le_bytes([chunk[0], chunk[1], chunk[2], chunk[3]]);
533 k = k.wrapping_mul(C1);
534 k = k.rotate_left(R1);
535 k = k.wrapping_mul(C2);
536 hash ^= k;
537 hash = hash.rotate_left(R2);
538 hash = hash.wrapping_mul(M).wrapping_add(N);
539 }
540
541 let tail = chunks.remainder();
543 let mut k1: u32 = 0;
544 match tail.len() {
545 3 => {
546 k1 ^= (tail[2] as u32) << 16;
547 k1 ^= (tail[1] as u32) << 8;
548 k1 ^= tail[0] as u32;
549 }
550 2 => {
551 k1 ^= (tail[1] as u32) << 8;
552 k1 ^= tail[0] as u32;
553 }
554 1 => {
555 k1 ^= tail[0] as u32;
556 }
557 _ => {}
558 }
559 if !tail.is_empty() {
560 k1 = k1.wrapping_mul(C1);
561 k1 = k1.rotate_left(R1);
562 k1 = k1.wrapping_mul(C2);
563 hash ^= k1;
564 }
565
566 hash ^= len as u32;
568 hash ^= hash >> 16;
569 hash = hash.wrapping_mul(0x85ebca6b);
570 hash ^= hash >> 13;
571 hash = hash.wrapping_mul(0xc2b2ae35);
572 hash ^= hash >> 16;
573
574 hash
575}
576
577pub fn normalize_model_id(model: &str, provider: &str) -> String {
589 if model.contains('/') {
590 model.to_string()
591 } else {
592 format!("{provider}/{model}")
593 }
594}
595
596fn serialize_uuid<S>(uuid: &uuid::Uuid, serializer: S) -> Result<S::Ok, S::Error>
602where
603 S: serde::Serializer,
604{
605 serializer.serialize_str(&uuid.to_string())
606}
607
608fn deserialize_uuid<'de, D>(deserializer: D) -> Result<uuid::Uuid, D::Error>
610where
611 D: serde::Deserializer<'de>,
612{
613 let s = String::deserialize(deserializer)?;
614 uuid::Uuid::parse_str(&s).map_err(serde::de::Error::custom)
615}
616
617#[derive(Debug, Default)]
623pub struct TraceRecordBuilder {
624 vcs: Option<VcsInfo>,
625 tool: Option<ToolInfo>,
626 files: Vec<TraceFile>,
627 metadata: Option<TraceMetadata>,
628}
629
630impl TraceRecordBuilder {
631 pub fn new() -> Self {
633 Self::default()
634 }
635
636 pub fn vcs(mut self, vcs: VcsInfo) -> Self {
638 self.vcs = Some(vcs);
639 self
640 }
641
642 pub fn git_revision(mut self, revision: impl Into<String>) -> Self {
644 self.vcs = Some(VcsInfo::git(revision));
645 self
646 }
647
648 pub fn tool(mut self, tool: ToolInfo) -> Self {
650 self.tool = Some(tool);
651 self
652 }
653
654 pub fn file(mut self, file: TraceFile) -> Self {
656 self.files.push(file);
657 self
658 }
659
660 pub fn metadata(mut self, metadata: TraceMetadata) -> Self {
662 self.metadata = Some(metadata);
663 self
664 }
665
666 pub fn build(self) -> TraceRecord {
668 TraceRecord {
669 version: AGENT_TRACE_VERSION.to_string(),
670 id: uuid::Uuid::new_v4(),
671 timestamp: Utc::now(),
672 vcs: self.vcs,
673 tool: self.tool.or_else(|| Some(ToolInfo::vtcode())),
674 files: self.files,
675 metadata: self.metadata,
676 }
677 }
678}
679
680#[derive(Debug, Clone)]
686pub struct TraceContext {
687 pub revision: Option<String>,
689 pub session_id: Option<String>,
691 pub model_id: String,
693 pub provider: String,
695 pub turn_number: Option<u32>,
697 pub workspace_path: Option<PathBuf>,
699}
700
701impl TraceContext {
702 pub fn new(model_id: impl Into<String>, provider: impl Into<String>) -> Self {
704 Self {
705 revision: None,
706 session_id: None,
707 model_id: model_id.into(),
708 provider: provider.into(),
709 turn_number: None,
710 workspace_path: None,
711 }
712 }
713
714 pub fn with_revision(mut self, revision: impl Into<String>) -> Self {
716 self.revision = Some(revision.into());
717 self
718 }
719
720 pub fn with_session_id(mut self, session_id: impl Into<String>) -> Self {
722 self.session_id = Some(session_id.into());
723 self
724 }
725
726 pub fn with_turn_number(mut self, turn: u32) -> Self {
728 self.turn_number = Some(turn);
729 self
730 }
731
732 pub fn with_workspace_path(mut self, path: impl Into<PathBuf>) -> Self {
734 self.workspace_path = Some(path.into());
735 self
736 }
737
738 pub fn normalized_model_id(&self) -> String {
740 normalize_model_id(&self.model_id, &self.provider)
741 }
742}
743
744#[cfg(test)]
745#[allow(clippy::expect_used, clippy::unwrap_used)]
746mod tests {
747 use super::*;
748
749 #[test]
750 fn test_trace_record_creation() {
751 let trace = TraceRecord::new();
752 assert_eq!(trace.version, AGENT_TRACE_VERSION);
753 assert!(trace.tool.is_some());
754 assert!(trace.files.is_empty());
755 }
756
757 #[test]
758 fn test_trace_record_for_git() {
759 let trace = TraceRecord::for_git_revision("abc123");
760 assert!(trace.vcs.is_some());
761 let vcs = trace.vcs.as_ref().expect("trace.vcs is None");
762 assert_eq!(vcs.vcs_type, VcsType::Git);
763 assert_eq!(vcs.revision, "abc123");
764 }
765
766 #[test]
767 fn test_contributor_types() {
768 let ai = Contributor::ai("anthropic/claude-opus-4");
769 assert_eq!(ai.contributor_type, ContributorType::Ai);
770 assert_eq!(ai.model_id, Some("anthropic/claude-opus-4".to_string()));
771
772 let human = Contributor::human();
773 assert_eq!(human.contributor_type, ContributorType::Human);
774 assert!(human.model_id.is_none());
775 }
776
777 #[test]
778 fn test_trace_range() {
779 let range = TraceRange::new(10, 25);
780 assert_eq!(range.start_line, 10);
781 assert_eq!(range.end_line, 25);
782
783 let range_with_hash = range.with_content_hash("hello world");
784 assert!(range_with_hash.content_hash.is_some());
785 assert!(range_with_hash.content_hash.unwrap().starts_with("murmur3:"));
787 }
788
789 #[test]
790 fn test_hash_algorithms() {
791 let murmur = compute_content_hash_with("hello world", HashAlgorithm::MurmurHash3);
792 assert!(murmur.starts_with("murmur3:"));
793
794 let fnv = compute_content_hash_with("hello world", HashAlgorithm::Fnv1a);
795 assert!(fnv.starts_with("fnv1a:"));
796
797 let default_hash = compute_content_hash("hello world");
799 assert_eq!(default_hash, murmur);
800 }
801
802 #[test]
803 fn test_trace_file_builder() {
804 let file = TraceFile::with_ai_ranges("src/main.rs", "anthropic/claude-opus-4", vec![TraceRange::new(1, 50)]);
805 assert_eq!(file.path, "src/main.rs");
806 assert_eq!(file.conversations.len(), 1);
807 }
808
809 #[test]
810 fn test_normalize_model_id() {
811 assert_eq!(normalize_model_id("claude-3-opus", "anthropic"), "anthropic/claude-3-opus");
812 assert_eq!(normalize_model_id("anthropic/claude-3-opus", "anthropic"), "anthropic/claude-3-opus");
813 }
814
815 #[test]
816 fn test_trace_record_builder() {
817 let trace = TraceRecordBuilder::new()
818 .git_revision("abc123def456")
819 .file(TraceFile::with_ai_ranges("src/lib.rs", "openai/gpt-5", vec![TraceRange::new(10, 20)]))
820 .build();
821
822 assert!(trace.vcs.is_some());
823 assert_eq!(trace.files.len(), 1);
824 assert!(trace.has_attributions());
825 }
826
827 #[test]
828 fn test_trace_serialization() {
829 let trace = TraceRecord::for_git_revision("abc123");
830 let json = serde_json::to_string_pretty(&trace).expect("Failed to serialize trace to JSON");
831 assert!(json.contains("\"version\": \"0.1.0\""));
832 assert!(json.contains("abc123"));
833
834 let restored: TraceRecord = serde_json::from_str(&json).expect("Failed to deserialize trace from JSON");
835 assert_eq!(restored.version, trace.version);
836 }
837
838 #[test]
839 fn test_content_hash_consistency() {
840 let hash1 = compute_content_hash("hello world");
842 let hash2 = compute_content_hash("hello world");
843 assert_eq!(hash1, hash2);
844
845 let hash3 = compute_content_hash("hello world!");
846 assert_ne!(hash1, hash3);
847
848 let fnv1 = compute_content_hash_with("test", HashAlgorithm::Fnv1a);
850 let fnv2 = compute_content_hash_with("test", HashAlgorithm::Fnv1a);
851 assert_eq!(fnv1, fnv2);
852 }
853}