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:
@@ -0,0 +1,150 @@
|
||||
//! `ToolDispatch` is intentionally object-safe so an impl can be
|
||||
//! stored as `Box<dyn ToolDispatch>` (or `Arc<dyn ToolDispatch>`) for
|
||||
//! shared dynamic dispatch. `Tool` is NOT object-safe — its associated
|
||||
//! types make sense only via a typed-erasure adapter that lives downstream
|
||||
//! of this crate.
|
||||
|
||||
use async_trait::async_trait;
|
||||
use futures::StreamExt;
|
||||
use serde_json::{Value, json};
|
||||
|
||||
use kigi_tool_protocol::ToolId;
|
||||
use kigi_tool_runtime::{
|
||||
ToolCallContext, ToolDispatch, ToolError, ToolErrorKind, ToolProgress, ToolStream,
|
||||
ToolStreamItem, TypedToolOutput, terminal_only, with_progress,
|
||||
};
|
||||
|
||||
fn tid(s: &str) -> ToolId {
|
||||
ToolId::new(s).expect("test tool ids are well-formed")
|
||||
}
|
||||
|
||||
struct EchoDispatch;
|
||||
|
||||
#[async_trait]
|
||||
impl ToolDispatch for EchoDispatch {
|
||||
async fn call(
|
||||
&self,
|
||||
tool_id: ToolId,
|
||||
args: Value,
|
||||
_ctx: ToolCallContext,
|
||||
) -> ToolStream<TypedToolOutput> {
|
||||
if tool_id.as_str() == "echo" {
|
||||
terminal_only(Ok(TypedToolOutput::from_value(tool_id, args)))
|
||||
} else {
|
||||
terminal_only(Err(ToolError::not_found(
|
||||
tool_id.clone(),
|
||||
format!("tool '{}' not registered", tool_id),
|
||||
)))
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
struct ProgressDispatch;
|
||||
|
||||
#[async_trait]
|
||||
impl ToolDispatch for ProgressDispatch {
|
||||
async fn call(
|
||||
&self,
|
||||
tool_id: ToolId,
|
||||
args: Value,
|
||||
_ctx: ToolCallContext,
|
||||
) -> ToolStream<TypedToolOutput> {
|
||||
let progress = futures::stream::iter(vec![
|
||||
ToolProgress::Text {
|
||||
text: "tick".into(),
|
||||
},
|
||||
ToolProgress::Text {
|
||||
text: "tock".into(),
|
||||
},
|
||||
]);
|
||||
let tid = tool_id.clone();
|
||||
with_progress(progress, async move {
|
||||
Ok(TypedToolOutput::from_value(tid, args))
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
/// Constructs a stream that ends without a `Terminal` item — drives the
|
||||
/// `call_terminal` default-impl recovery path.
|
||||
struct EmptyStreamDispatch;
|
||||
|
||||
#[async_trait]
|
||||
impl ToolDispatch for EmptyStreamDispatch {
|
||||
async fn call(
|
||||
&self,
|
||||
_tool_id: ToolId,
|
||||
_args: Value,
|
||||
_ctx: ToolCallContext,
|
||||
) -> ToolStream<TypedToolOutput> {
|
||||
Box::pin(futures::stream::empty())
|
||||
}
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn dispatch_is_object_safe() {
|
||||
let boxed: Box<dyn ToolDispatch> = Box::new(EchoDispatch);
|
||||
let mut stream = boxed
|
||||
.call(tid("echo"), json!({"k": "v"}), ToolCallContext::default())
|
||||
.await;
|
||||
let item = stream.next().await.unwrap();
|
||||
match item {
|
||||
ToolStreamItem::Terminal(Ok(typed)) => assert_eq!(typed.value, json!({"k": "v"})),
|
||||
other => panic!("expected Terminal(Ok), got {other:?}"),
|
||||
}
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn arc_dispatch_is_object_safe() {
|
||||
let arc: std::sync::Arc<dyn ToolDispatch> = std::sync::Arc::new(EchoDispatch);
|
||||
let result = arc
|
||||
.call_terminal(tid("echo"), json!(42), ToolCallContext::default())
|
||||
.await;
|
||||
assert_eq!(result.unwrap().value, json!(42));
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn unknown_tool_returns_not_found() {
|
||||
let dispatch = EchoDispatch;
|
||||
let result = dispatch
|
||||
.call_terminal(tid("missing"), json!(null), ToolCallContext::default())
|
||||
.await;
|
||||
match result {
|
||||
Err(ref err) if err.kind == ToolErrorKind::NotFound => {
|
||||
assert!(
|
||||
err.detail.contains("missing"),
|
||||
"detail should mention the tool id, got: {}",
|
||||
err.detail
|
||||
);
|
||||
}
|
||||
other => panic!("expected NotFound, got {other:?}"),
|
||||
}
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn call_terminal_drops_progress_items() {
|
||||
let dispatch = ProgressDispatch;
|
||||
let result = dispatch
|
||||
.call_terminal(tid("any"), json!("x"), ToolCallContext::default())
|
||||
.await;
|
||||
assert_eq!(result.unwrap().value, json!("x"));
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn call_terminal_surfaces_no_terminal_as_custom_error() {
|
||||
let dispatch = EmptyStreamDispatch;
|
||||
let result = dispatch
|
||||
.call_terminal(tid("any"), json!(null), ToolCallContext::default())
|
||||
.await;
|
||||
match result {
|
||||
Err(ref err) if err.kind == ToolErrorKind::Custom => {
|
||||
let code = err
|
||||
.details
|
||||
.as_ref()
|
||||
.and_then(|d| d.get("code"))
|
||||
.and_then(|v| v.as_str())
|
||||
.unwrap_or("");
|
||||
assert_eq!(code, "stream_no_terminal");
|
||||
}
|
||||
other => panic!("expected Custom(stream_no_terminal), got {other:?}"),
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user