Hard fork of xai-org/grok-build (Apache-2.0) re-targeted as Kigi, an
unofficial Kimi Code CLI community build.
Rename & identity
- 72 xai-*/xai-grok-* crates -> kigi-* (explicit: xai-grok-pager-bin ->
kigi-bin [binary `kigi`], xai-grok-pager -> kigi-tui; rest mechanical);
ptyctl, ptyctl-cli, third_party/ unchanged; proto package
xai.grok.tools.v1 -> kigi.tools.v1
- Config home ~/.kigi (KIGI_SHARE_DIR override), env prefix GROK_* ->
KIGI_*, `kigi --version` carries the unofficial-community-build notice
- clap identity, help text, startup banner, prompt templates rebranded
(templates re-encrypted)
Deletions (PRD removal list #5/#6/#7/#9/#10)
- voice input (xai-grok-voice) and all TUI wiring
- telemetry: Mixpanel client, external OTel stream, Sentry, OTLP layers,
trace/GCS/S3 upload queues (kigi-file-utils halved), workspace upload
module & dc_log, heap-profile uploader, auth-diagnostics uploader,
session-analytics halves of feedback; local zero-egress observability
preserved in new kigi-log crate (unified log, --debug firehose,
subsystem file logs, opt-in instrumentation)
- announcements (crate, remote-settings fields, TUI surfaces)
- plugin marketplace (crate, sources/browse/CTA/extensions-modal tab);
direct plugin install/uninstall/update via kigi-agent git_install kept
- relay/gateway/assets endpoints and features (agent relay, headless
relay transport, gateway bridge, LeaderEnvUrls); leader IPC socket now
~/.kigi/leader.sock + KIGI_LEADER_SOCKET, no ws-url derivation
- functional types rehomed instead of deleted: PermissionMode ->
kigi-config-types, McpInitStrategy -> kigi-mcp, PrCreationSource ->
session signals, TerminalDiagnostics -> kigi-pager-render, agent_id ->
shell util
Endpoints
- kigi-env rewritten: single production KigiEndpoints {coding_api_base_url
https://api.kimi.com/coding/v1 (KIGI_CODE_BASE_URL), oauth_host
https://auth.kimi.com (KIGI_OAUTH_HOST), update_base_url (GitHub
Releases API), upgrade_page_url}; GrokBuildEnvironment enum deleted
Toolchain & workspace hygiene
- Rust 1.97.0 pinned; edition 2024; full cargo update; git2 hoisted to
workspace at 0.21 (Option->Result API migration), quick-xml 0.41
- Root Cargo.toml hand-maintained (PRD §8.1): version 0.1.0 inherited by
all members, members sorted, unused deps pruned
- cargo-deny advisories gate (deny.toml with documented transitive
exceptions); CI workflow (check/clippy/fmt/deny/test, macOS+Linux)
- cross-crate test seams re-gated behind `test-support` cargo feature;
insta snapshot baselines renamed to the kigi_tui prefix
- clippy --workspace --all-targets: zero warnings; fmt clean
Fixes surfaced by the port
- updater probe/installer divergence (bin/kigi vs bin/grok symlink set)
- idle model-metadata refresh dead under KIGI_CODE_BASE_URL override
(new is_effective_coding_endpoint_url, loopback+override aware)
- macOS symlinked-TMPDIR fixture canonicalization (foreign_sessions,
fast-worktree); RSS measurement tests serialized via serial_test
Docs & legal (Apache §4)
- NOTICE added (upstream attribution + change statement); THIRD-PARTY
notices sustained; kigi-tools ported-code notices extended; README,
CONTRIBUTING, SECURITY, AGENTS.md rewritten
Out of scope for M0 (tracked): Kimi auth/inference (M1), search/fetch,
command parity, config import (M2), Computer Hub excision & final
brand-token sweep (M2), distribution & self-update rewrite (M3).
174 lines
5.9 KiB
Rust
174 lines
5.9 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();
|
|
}
|
|
}
|