M0: compilable skeleton — Kigi 0.1.0 fork surgery
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).
This commit is contained in:
commit
d6c20fc13f
2612 files changed
+1353757
No files matched your search
@@ -0,0 +1,357 @@
|
||||
//! Format memory search results as `<system-reminder>` content.
|
||||
//!
|
||||
//! Used for:
|
||||
//! - Session start: inject relevant past context on the first turn
|
||||
//! - Post-compaction: recover relevant memory after context is lost
|
||||
|
||||
use kigi_chat_state::{MEMORY_CONTEXT_CLOSE_TAG, MEMORY_CONTEXT_OPEN_TAG};
|
||||
use kigi_sampling_types::ConversationItem;
|
||||
use kigi_tools::types::memory_backend::{MemorySearchResult, format_staleness_note};
|
||||
|
||||
/// Maximum characters to include per snippet in the injection.
|
||||
const SNIPPET_MAX_CHARS: usize = 500;
|
||||
|
||||
/// Returns `true` if a memory-context block is already persisted in the
|
||||
/// leading system message. Callers reuse a persisted block verbatim instead
|
||||
/// of re-searching: a re-scored block would mutate the system-prompt prefix
|
||||
/// and bust the KV cache for the whole downstream conversation.
|
||||
pub fn conversation_has_memory_context(items: &[ConversationItem]) -> bool {
|
||||
matches!(
|
||||
items.first(),
|
||||
Some(ConversationItem::System(sys)) if sys.content.contains(MEMORY_CONTEXT_OPEN_TAG)
|
||||
)
|
||||
}
|
||||
|
||||
/// Format memory search results as a markdown section for system-reminder injection.
|
||||
///
|
||||
/// Each result is formatted with score, source, file path, line range,
|
||||
/// and the snippet in a fenced code block (preserving newlines/markdown).
|
||||
/// This matches the output format of the `memory_search` tool for consistency.
|
||||
///
|
||||
/// Returns `None` if results are empty.
|
||||
pub fn format_memory_reminder(results: &[MemorySearchResult]) -> Option<String> {
|
||||
if results.is_empty() {
|
||||
return None;
|
||||
}
|
||||
|
||||
let mut section =
|
||||
format!("{MEMORY_CONTEXT_OPEN_TAG}\n## Relevant Memory from Past Sessions\n\n");
|
||||
|
||||
for (i, r) in results.iter().enumerate() {
|
||||
let truncated = r.snippet.chars().count() > SNIPPET_MAX_CHARS;
|
||||
let mut snippet: String = r.snippet.chars().take(SNIPPET_MAX_CHARS).collect();
|
||||
if truncated {
|
||||
snippet.push_str("...");
|
||||
}
|
||||
let staleness = format_staleness_note(&r.source, r.created_at);
|
||||
section.push_str(&format!(
|
||||
"### Result {} (score: {:.2}, source: {})\n\
|
||||
**File:** {} (lines {}-{})\n\
|
||||
{}```\n{}\n```\n\n",
|
||||
i + 1,
|
||||
r.score,
|
||||
r.source,
|
||||
r.path,
|
||||
r.start_line,
|
||||
r.end_line,
|
||||
staleness,
|
||||
snippet,
|
||||
));
|
||||
}
|
||||
|
||||
section.push_str(MEMORY_CONTEXT_CLOSE_TAG);
|
||||
Some(section)
|
||||
}
|
||||
|
||||
/// Check if a message looks like a greeting or generic opener.
|
||||
///
|
||||
/// Used to detect vague first messages that won't produce useful memory
|
||||
/// search results, so we can fall back to a broader project-context query.
|
||||
pub fn is_greeting(text: &str) -> bool {
|
||||
const GREETINGS: &[&str] = &[
|
||||
"hi",
|
||||
"hey",
|
||||
"hello",
|
||||
"howdy",
|
||||
"continue",
|
||||
"start",
|
||||
"begin",
|
||||
"go",
|
||||
"good morning",
|
||||
"good afternoon",
|
||||
"good evening",
|
||||
"what's up",
|
||||
"whats up",
|
||||
"sup",
|
||||
];
|
||||
let lowered = text.to_lowercase();
|
||||
let trimmed = lowered.trim().trim_end_matches(['.', '!', '?', ',']);
|
||||
GREETINGS.contains(&trimmed)
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
|
||||
#[test]
|
||||
fn test_format_empty() {
|
||||
assert_eq!(format_memory_reminder(&[]), None);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_format_single_result() {
|
||||
let results = vec![MemorySearchResult {
|
||||
chunk_id: "test:0".to_string(),
|
||||
path: "MEMORY.md".to_string(),
|
||||
start_line: 0,
|
||||
end_line: 5,
|
||||
score: 0.9,
|
||||
snippet: "Use tracing for logging, never println!".to_string(),
|
||||
source: "workspace".to_string(),
|
||||
created_at: None,
|
||||
}];
|
||||
let output = format_memory_reminder(&results).unwrap();
|
||||
assert!(output.contains("<memory-context>"));
|
||||
assert!(output.contains("### Result 1"));
|
||||
assert!(output.contains("score: 0.90"));
|
||||
assert!(output.contains("**File:** MEMORY.md (lines 0-5)"));
|
||||
assert!(output.contains("```\nUse tracing for logging"));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_format_preserves_newlines() {
|
||||
let results = vec![MemorySearchResult {
|
||||
chunk_id: "test:0".to_string(),
|
||||
path: "MEMORY.md".to_string(),
|
||||
start_line: 0,
|
||||
end_line: 3,
|
||||
score: 0.85,
|
||||
snippet: "## Conventions\n\n- Use Rust\n- No clones".to_string(),
|
||||
source: "workspace".to_string(),
|
||||
created_at: None,
|
||||
}];
|
||||
let output = format_memory_reminder(&results).unwrap();
|
||||
assert!(
|
||||
output.contains("## Conventions\n\n- Use Rust\n- No clones"),
|
||||
"newlines in snippet should be preserved, not collapsed"
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_format_truncates_long_snippets() {
|
||||
let results = vec![MemorySearchResult {
|
||||
chunk_id: "test:0".to_string(),
|
||||
path: "test.md".to_string(),
|
||||
start_line: 0,
|
||||
end_line: 5,
|
||||
score: 0.8,
|
||||
snippet: "x".repeat(1000),
|
||||
source: "session".to_string(),
|
||||
created_at: None,
|
||||
}];
|
||||
let output = format_memory_reminder(&results).unwrap();
|
||||
// Snippet should be truncated to SNIPPET_MAX_CHARS (500) + "..."
|
||||
assert!(!output.contains(&"x".repeat(501)));
|
||||
assert!(output.contains(&format!("{}...", "x".repeat(500))));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_format_multiple_results() {
|
||||
let results = vec![
|
||||
MemorySearchResult {
|
||||
chunk_id: "a:0".to_string(),
|
||||
path: "MEMORY.md".to_string(),
|
||||
start_line: 0,
|
||||
end_line: 5,
|
||||
score: 0.9,
|
||||
snippet: "First result".to_string(),
|
||||
source: "workspace".to_string(),
|
||||
created_at: None,
|
||||
},
|
||||
MemorySearchResult {
|
||||
chunk_id: "b:0".to_string(),
|
||||
path: "session.md".to_string(),
|
||||
start_line: 10,
|
||||
end_line: 15,
|
||||
score: 0.7,
|
||||
snippet: "Second result".to_string(),
|
||||
source: "session".to_string(),
|
||||
created_at: None,
|
||||
},
|
||||
];
|
||||
let output = format_memory_reminder(&results).unwrap();
|
||||
assert!(output.contains("### Result 1"));
|
||||
assert!(output.contains("### Result 2"));
|
||||
assert!(output.contains("score: 0.90"));
|
||||
assert!(output.contains("score: 0.70"));
|
||||
}
|
||||
|
||||
// -----------------------------------------------------------------------
|
||||
// conversation_has_memory_context (idempotency guard) tests
|
||||
// -----------------------------------------------------------------------
|
||||
|
||||
fn sample_result() -> MemorySearchResult {
|
||||
MemorySearchResult {
|
||||
chunk_id: "test:0".into(),
|
||||
path: "MEMORY.md".into(),
|
||||
start_line: 0,
|
||||
end_line: 5,
|
||||
score: 0.9,
|
||||
snippet: "Project uses Rust for backend services.".into(),
|
||||
source: "workspace".into(),
|
||||
created_at: None,
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_detects_persisted_block_in_system_message() {
|
||||
let block = format_memory_reminder(&[sample_result()]).unwrap();
|
||||
let system_content = format!("You are a helpful assistant.\n\n{block}");
|
||||
let conversation = vec![
|
||||
ConversationItem::system(system_content),
|
||||
ConversationItem::user("help me fix the auth bug"),
|
||||
];
|
||||
assert!(
|
||||
conversation_has_memory_context(&conversation),
|
||||
"an already-injected memory-context block must be detected so it is reused, not re-searched"
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_no_block_when_system_lacks_marker() {
|
||||
let conversation = vec![
|
||||
ConversationItem::system("You are a helpful assistant."),
|
||||
ConversationItem::user("hi"),
|
||||
];
|
||||
assert!(!conversation_has_memory_context(&conversation));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_no_block_when_no_leading_system_message() {
|
||||
let conversation = vec![ConversationItem::user("hi")];
|
||||
assert!(!conversation_has_memory_context(&conversation));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_no_block_for_empty_conversation() {
|
||||
assert!(!conversation_has_memory_context(&[]));
|
||||
}
|
||||
|
||||
// -----------------------------------------------------------------------
|
||||
// staleness annotation tests
|
||||
// -----------------------------------------------------------------------
|
||||
|
||||
#[test]
|
||||
fn test_staleness_shown_for_old_session_result() {
|
||||
let now = std::time::SystemTime::now()
|
||||
.duration_since(std::time::UNIX_EPOCH)
|
||||
.unwrap()
|
||||
.as_secs() as i64;
|
||||
let results = vec![MemorySearchResult {
|
||||
chunk_id: "s:0".into(),
|
||||
path: "session.md".into(),
|
||||
start_line: 0,
|
||||
end_line: 5,
|
||||
score: 0.8,
|
||||
snippet: "old info".into(),
|
||||
source: "session".into(),
|
||||
created_at: Some(now - 86400 * 10),
|
||||
}];
|
||||
let output = format_memory_reminder(&results).unwrap();
|
||||
assert!(
|
||||
output.contains("**Stale ("),
|
||||
"10-day-old session result should show stale warning, got: {output}"
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_no_staleness_for_workspace_result() {
|
||||
let now = std::time::SystemTime::now()
|
||||
.duration_since(std::time::UNIX_EPOCH)
|
||||
.unwrap()
|
||||
.as_secs() as i64;
|
||||
let results = vec![MemorySearchResult {
|
||||
chunk_id: "w:0".into(),
|
||||
path: "MEMORY.md".into(),
|
||||
start_line: 0,
|
||||
end_line: 5,
|
||||
score: 0.9,
|
||||
snippet: "workspace data".into(),
|
||||
source: "workspace".into(),
|
||||
created_at: Some(now - 86400 * 30),
|
||||
}];
|
||||
let output = format_memory_reminder(&results).unwrap();
|
||||
assert!(
|
||||
!output.contains("**Stale (") && !output.contains("**Note ("),
|
||||
"workspace result must not show staleness, got: {output}"
|
||||
);
|
||||
}
|
||||
|
||||
// -----------------------------------------------------------------------
|
||||
// is_greeting tests
|
||||
// -----------------------------------------------------------------------
|
||||
|
||||
#[test]
|
||||
fn test_greeting_detection() {
|
||||
assert!(is_greeting("hi"));
|
||||
assert!(is_greeting("Hey!"));
|
||||
assert!(is_greeting("Hello."));
|
||||
assert!(is_greeting("good morning"));
|
||||
assert!(is_greeting("continue"));
|
||||
assert!(is_greeting(" HELLO "));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_non_greeting() {
|
||||
assert!(!is_greeting("help me fix the auth bug"));
|
||||
assert!(!is_greeting("implement feature X"));
|
||||
assert!(!is_greeting("what does this function do"));
|
||||
assert!(!is_greeting("hi there, can you help me with something"));
|
||||
}
|
||||
|
||||
// -----------------------------------------------------------------------
|
||||
// Injection counter semantics tests
|
||||
// -----------------------------------------------------------------------
|
||||
|
||||
/// `format_memory_reminder` returns `None` for an empty result list.
|
||||
///
|
||||
/// This is the key invariant for the `memory_injection_count` contract:
|
||||
/// the counter must only be incremented when `memory_reminder.is_some()`,
|
||||
/// which is only true when `format_memory_reminder` returns `Some(_)`.
|
||||
/// An empty result set must produce `None`, preventing the counter from
|
||||
/// overcounting attempts where memory search found nothing to inject.
|
||||
#[test]
|
||||
fn test_format_memory_reminder_empty_results_is_none() {
|
||||
use kigi_tools::types::memory_backend::MemorySearchResult;
|
||||
let results: Vec<MemorySearchResult> = vec![];
|
||||
let reminder = format_memory_reminder(&results);
|
||||
assert!(
|
||||
reminder.is_none(),
|
||||
"empty results must produce None — injection_count must NOT increment"
|
||||
);
|
||||
}
|
||||
|
||||
/// `format_memory_reminder` returns `Some(_)` for a non-empty result list.
|
||||
///
|
||||
/// Confirms that `memory_injection_count` correctly increments when there
|
||||
/// are actual results to inject.
|
||||
#[test]
|
||||
fn test_format_memory_reminder_with_results_is_some() {
|
||||
use kigi_tools::types::memory_backend::MemorySearchResult;
|
||||
let results = vec![MemorySearchResult {
|
||||
chunk_id: "test:0".into(),
|
||||
path: "/mem/MEMORY.md".into(),
|
||||
start_line: 0,
|
||||
end_line: 3,
|
||||
score: 0.85,
|
||||
snippet: "Project uses Rust for backend services.".into(),
|
||||
source: "workspace".into(),
|
||||
created_at: None,
|
||||
}];
|
||||
let reminder = format_memory_reminder(&results);
|
||||
assert!(
|
||||
reminder.is_some(),
|
||||
"non-empty results must produce Some(_) — injection_count SHOULD increment"
|
||||
);
|
||||
}
|
||||
}
|
||||
Reference in new issue
Block a user