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,182 @@
|
||||
//! Buffered consumer for [`SamplingEvent`] streams.
|
||||
//!
|
||||
//! Drains a Layer-2 event stream into the final
|
||||
//! `(ConversationResponse, InferenceLatencyStats)` pair. Used by
|
||||
//! callers that don't need streaming UI updates (e.g., compaction,
|
||||
//! `/btw`, dream-model calls).
|
||||
|
||||
use futures_util::StreamExt;
|
||||
use futures_util::stream::Stream;
|
||||
|
||||
use kigi_sampling_types::ConversationResponse;
|
||||
|
||||
use crate::events::{SamplingErrorInfo, SamplingErrorKind, SamplingEvent};
|
||||
use crate::metrics::InferenceLatencyStats;
|
||||
|
||||
/// Drain a [`SamplingEvent`] stream, returning the final response.
|
||||
///
|
||||
/// Returns `Ok((response, metrics))` on the first
|
||||
/// [`SamplingEvent::Completed`] and `Err(error)` on the first
|
||||
/// [`SamplingEvent::Failed`]. Intermediate events (deltas, retries,
|
||||
/// metadata) are silently consumed -- this function is for callers
|
||||
/// that only need the final result.
|
||||
///
|
||||
/// If the stream ends without yielding either terminal event,
|
||||
/// returns an `Err` of kind [`SamplingErrorKind::Api`] indicating
|
||||
/// truncation. The Layer-2 transforms guarantee a terminal event in
|
||||
/// every successful return path, so this only fires for streams that
|
||||
/// are dropped mid-flight (e.g., the producer panicked or the
|
||||
/// underlying `tokio::spawn` was cancelled).
|
||||
pub async fn collect_response(
|
||||
stream: impl Stream<Item = SamplingEvent>,
|
||||
) -> Result<(ConversationResponse, InferenceLatencyStats), SamplingErrorInfo> {
|
||||
tokio::pin!(stream);
|
||||
|
||||
while let Some(event) = stream.next().await {
|
||||
match event {
|
||||
SamplingEvent::Completed {
|
||||
response, metrics, ..
|
||||
} => return Ok((*response, metrics)),
|
||||
SamplingEvent::Failed { error, .. } => return Err(error),
|
||||
// Drop intermediate events; this is a buffered collector.
|
||||
_ => {}
|
||||
}
|
||||
}
|
||||
|
||||
Err(SamplingErrorInfo {
|
||||
kind: SamplingErrorKind::Api,
|
||||
status_code: None,
|
||||
message: "stream ended without Completed or Failed".to_string(),
|
||||
is_retryable: false,
|
||||
retry_after_secs: None,
|
||||
model_metadata: None,
|
||||
empty_response_context: None,
|
||||
doom_loop_triggers: None,
|
||||
doom_loop_aborted_at_chunk: None,
|
||||
})
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
use futures_util::stream;
|
||||
use kigi_sampling_types::{ConversationItem, SamplingError, StopReason};
|
||||
|
||||
use crate::events::SamplingChannel;
|
||||
use crate::stream::stream_chat_completions;
|
||||
use crate::types::RequestId;
|
||||
use kigi_sampling_types::{
|
||||
ChatChunkChoice, ChatChunkDelta, ChatCompletionChunk, FinishReason, Role,
|
||||
};
|
||||
use std::time::Duration;
|
||||
|
||||
fn rid() -> RequestId {
|
||||
RequestId::from("collect-test")
|
||||
}
|
||||
|
||||
fn text_chunk(text: &str) -> ChatCompletionChunk {
|
||||
ChatCompletionChunk {
|
||||
id: "chunk".into(),
|
||||
object: "chat.completion.chunk".into(),
|
||||
created: 0,
|
||||
model: "test-model".into(),
|
||||
choices: vec![ChatChunkChoice {
|
||||
index: 0,
|
||||
delta: ChatChunkDelta {
|
||||
role: Some(Role::Assistant),
|
||||
content: Some(text.to_string()),
|
||||
reasoning_content: None,
|
||||
tool_calls: vec![],
|
||||
tool_call_id: None,
|
||||
},
|
||||
finish_reason: None,
|
||||
}],
|
||||
usage: None,
|
||||
system_fingerprint: None,
|
||||
}
|
||||
}
|
||||
|
||||
fn final_chunk() -> ChatCompletionChunk {
|
||||
ChatCompletionChunk {
|
||||
id: "chunk".into(),
|
||||
object: "chat.completion.chunk".into(),
|
||||
created: 0,
|
||||
model: "test-model".into(),
|
||||
choices: vec![ChatChunkChoice {
|
||||
index: 0,
|
||||
delta: ChatChunkDelta::default(),
|
||||
finish_reason: Some(FinishReason::Stop),
|
||||
}],
|
||||
usage: None,
|
||||
system_fingerprint: None,
|
||||
}
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn happy_path_returns_response_and_metrics() {
|
||||
let chunks: Vec<Result<ChatCompletionChunk, SamplingError>> =
|
||||
vec![Ok(text_chunk("hello")), Ok(final_chunk())];
|
||||
let raw = stream::iter(chunks).boxed();
|
||||
let events = stream_chat_completions(raw, None, rid(), Duration::from_secs(60));
|
||||
|
||||
let (response, _metrics) = collect_response(events)
|
||||
.await
|
||||
.expect("happy path returns Ok");
|
||||
let a = response.assistant().expect("assistant item present");
|
||||
assert_eq!(a.content.as_ref(), "hello");
|
||||
assert_eq!(response.stop_reason, Some(StopReason::Stop));
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn failure_path_returns_error() {
|
||||
let chunks: Vec<Result<ChatCompletionChunk, SamplingError>> = vec![
|
||||
Ok(text_chunk("partial")),
|
||||
Err(SamplingError::EventStreamError("boom".into())),
|
||||
];
|
||||
let raw = stream::iter(chunks).boxed();
|
||||
let events = stream_chat_completions(raw, None, rid(), Duration::from_secs(60));
|
||||
|
||||
let err = collect_response(events).await.expect_err("error returned");
|
||||
assert!(err.message.contains("boom"));
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn truncated_stream_returns_error() {
|
||||
let truncated = stream::iter(vec![SamplingEvent::StreamStarted {
|
||||
request_id: rid(),
|
||||
timestamp_ms: 0,
|
||||
}]);
|
||||
let err = collect_response(truncated)
|
||||
.await
|
||||
.expect_err("truncated stream returns Err");
|
||||
assert_eq!(err.kind, SamplingErrorKind::Api);
|
||||
assert!(err.message.contains("stream ended without"));
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn intermediate_events_are_dropped() {
|
||||
let token = SamplingEvent::ChannelToken {
|
||||
request_id: rid(),
|
||||
channel: SamplingChannel::Text,
|
||||
text: "hi".into(),
|
||||
chunk_index: 1,
|
||||
};
|
||||
let completed = SamplingEvent::Completed {
|
||||
request_id: rid(),
|
||||
response: Box::new(ConversationResponse {
|
||||
items: vec![ConversationItem::assistant("hi")],
|
||||
stop_reason: Some(StopReason::Stop),
|
||||
usage: None,
|
||||
cost_usd_ticks: None,
|
||||
message_chunks_emitted: 1,
|
||||
doom_loop_signals: Vec::new(),
|
||||
stop_message: None,
|
||||
}),
|
||||
metrics: InferenceLatencyStats::default(),
|
||||
};
|
||||
let s = stream::iter(vec![token, completed]);
|
||||
let (response, _) = collect_response(s).await.expect("ok");
|
||||
let a = response.assistant().expect("assistant item present");
|
||||
assert_eq!(a.content.as_ref(), "hi");
|
||||
}
|
||||
}
|
||||
Reference in new issue
Block a user