Sweep every first-party crate source (1956 .rs files) to the project comment guidelines: delete redundant restatements, decorative banners, change narration, and end-of-line comments; keep and tighten the crucial ones (invariants, bug rationale, SAFETY blocks, ported-source attribution). No functional code changed. Every edit is proven comment-only against the prior tree by a comment-stripping lexer (string/char/raw-string aware) plus a separate doctest-fence check. Where removing a comment made rustfmt or clippy want to re-lay-out adjacent code, the minimal triggering comment is restored so code tokens stay byte-identical. Gates green: cargo fmt --all --check (0 diffs), cargo check and cargo clippy --workspace --all-targets (0 warnings). Adds scripts/check_codegen_comment_guidelines.py — the enforcement gate for these guidelines (flags banners, end-of-line comments, change narration, and commented-out code).
170 lines
5.6 KiB
Rust
170 lines
5.6 KiB
Rust
//! Chat persistence trait and mock implementation.
|
|
//!
|
|
//! The actor owns persistence exclusively (`Box<dyn ChatPersistence>`), so the
|
|
//! trait uses `&mut self` — no locks, no atomics, no shared state.
|
|
//! The mock uses a channel to report records to the test, keeping everything
|
|
//! in the actor / message-passing paradigm.
|
|
|
|
use kigi_sampling_types::ConversationItem;
|
|
use tokio::sync::mpsc;
|
|
|
|
/// Abstraction over chat-specific persistence operations.
|
|
///
|
|
/// The actor owns this exclusively via `Box<dyn ChatPersistence>`, so all
|
|
/// methods take `&mut self` — no interior mutability needed.
|
|
///
|
|
/// The real implementation wraps an `mpsc::UnboundedSender<PersistenceMsg>`
|
|
/// (which only needs `&self` to send, but `&mut self` is still correct
|
|
/// because the actor is the sole owner).
|
|
pub trait ChatPersistence: Send + 'static {
|
|
/// Persist a single conversation item (append to chat_history.jsonl).
|
|
fn persist_message(&mut self, item: &ConversationItem);
|
|
|
|
/// Replace the entire chat history (compaction / rewind).
|
|
fn replace_history(&mut self, items: &[ConversationItem]);
|
|
|
|
/// Flush pending writes to disk.
|
|
fn flush(&mut self);
|
|
}
|
|
|
|
// Mock (test double) — channel-based, no locks, no atomics
|
|
|
|
/// A record of a persistence call, sent over a channel to the test.
|
|
#[derive(Debug, Clone)]
|
|
pub enum PersistenceRecord {
|
|
/// A single message was persisted.
|
|
Message(ConversationItem),
|
|
/// The full history was replaced.
|
|
ReplaceHistory(Vec<ConversationItem>),
|
|
/// A flush was requested.
|
|
Flush,
|
|
}
|
|
|
|
/// Test implementation: sends every call as a [`PersistenceRecord`] over a
|
|
/// channel. The test holds the [`MockPersistenceReceiver`] to inspect what
|
|
/// the actor did. No locks, no atomics — just message passing.
|
|
pub struct MockChatPersistence {
|
|
tx: mpsc::UnboundedSender<PersistenceRecord>,
|
|
}
|
|
|
|
/// Receiver side of the mock. Held by the test to drain and inspect records.
|
|
pub struct MockPersistenceReceiver {
|
|
rx: mpsc::UnboundedReceiver<PersistenceRecord>,
|
|
}
|
|
|
|
impl MockChatPersistence {
|
|
/// Create a paired (mock, receiver). Give the mock to the actor, keep the
|
|
/// receiver in the test.
|
|
pub fn new() -> (Self, MockPersistenceReceiver) {
|
|
let (tx, rx) = mpsc::unbounded_channel();
|
|
(Self { tx }, MockPersistenceReceiver { rx })
|
|
}
|
|
}
|
|
|
|
impl MockPersistenceReceiver {
|
|
/// Drain all pending records from the channel.
|
|
pub fn drain(&mut self) -> Vec<PersistenceRecord> {
|
|
let mut records = Vec::new();
|
|
while let Ok(record) = self.rx.try_recv() {
|
|
records.push(record);
|
|
}
|
|
records
|
|
}
|
|
|
|
/// Collect all `Message` items received so far (drains the channel).
|
|
pub fn messages(&mut self) -> Vec<ConversationItem> {
|
|
self.drain()
|
|
.into_iter()
|
|
.filter_map(|r| match r {
|
|
PersistenceRecord::Message(item) => Some(item),
|
|
_ => None,
|
|
})
|
|
.collect()
|
|
}
|
|
}
|
|
|
|
impl ChatPersistence for MockChatPersistence {
|
|
fn persist_message(&mut self, item: &ConversationItem) {
|
|
let _ = self.tx.send(PersistenceRecord::Message(item.clone()));
|
|
}
|
|
|
|
fn replace_history(&mut self, items: &[ConversationItem]) {
|
|
let _ = self
|
|
.tx
|
|
.send(PersistenceRecord::ReplaceHistory(items.to_vec()));
|
|
}
|
|
|
|
fn flush(&mut self) {
|
|
let _ = self.tx.send(PersistenceRecord::Flush);
|
|
}
|
|
}
|
|
|
|
// Null (noop) — for benchmarks / scenarios where persistence is unwanted
|
|
|
|
/// No-op implementation: discards everything (for benchmarks / noop scenarios).
|
|
pub struct NullChatPersistence;
|
|
|
|
impl ChatPersistence for NullChatPersistence {
|
|
fn persist_message(&mut self, _item: &ConversationItem) {}
|
|
fn replace_history(&mut self, _items: &[ConversationItem]) {}
|
|
fn flush(&mut self) {}
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod tests {
|
|
use super::*;
|
|
|
|
#[test]
|
|
fn mock_persistence_records_messages() {
|
|
let (mut mock, mut rx) = MockChatPersistence::new();
|
|
let item = ConversationItem::system("test");
|
|
mock.persist_message(&item);
|
|
let records = rx.drain();
|
|
assert_eq!(records.len(), 1);
|
|
assert!(matches!(&records[0], PersistenceRecord::Message(_)));
|
|
}
|
|
|
|
#[test]
|
|
fn mock_persistence_records_multiple_messages() {
|
|
let (mut mock, mut rx) = MockChatPersistence::new();
|
|
mock.persist_message(&ConversationItem::system("a"));
|
|
mock.persist_message(&ConversationItem::user("b"));
|
|
mock.persist_message(&ConversationItem::assistant("c"));
|
|
assert_eq!(rx.messages().len(), 3);
|
|
}
|
|
|
|
#[test]
|
|
fn mock_persistence_records_replace_history() {
|
|
let (mut mock, mut rx) = MockChatPersistence::new();
|
|
mock.replace_history(&[ConversationItem::system("a"), ConversationItem::system("b")]);
|
|
let records = rx.drain();
|
|
assert_eq!(records.len(), 1);
|
|
match &records[0] {
|
|
PersistenceRecord::ReplaceHistory(items) => assert_eq!(items.len(), 2),
|
|
other => panic!("expected ReplaceHistory, got {other:?}"),
|
|
}
|
|
}
|
|
|
|
#[test]
|
|
fn mock_persistence_records_flush() {
|
|
let (mut mock, mut rx) = MockChatPersistence::new();
|
|
mock.flush();
|
|
mock.flush();
|
|
let records = rx.drain();
|
|
assert_eq!(records.len(), 2);
|
|
assert!(
|
|
records
|
|
.iter()
|
|
.all(|r| matches!(r, PersistenceRecord::Flush))
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn null_persistence_does_not_panic() {
|
|
let mut null = NullChatPersistence;
|
|
null.persist_message(&ConversationItem::system("test"));
|
|
null.replace_history(&[ConversationItem::user("a")]);
|
|
null.flush();
|
|
}
|
|
}
|