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,227 @@
|
||||
//! `WorkspaceError` <-> wire-code mapping for the workspace RPC envelope
|
||||
//! (the envelope types are canonical in `kigi_workspace_types::rpc`).
|
||||
//!
|
||||
//! `error_code` uses a non-wildcard match so the compiler enforces
|
||||
//! coverage of new `WorkspaceError` variants.
|
||||
|
||||
pub use kigi_workspace_types::rpc::{RpcEnvelope, RpcError};
|
||||
|
||||
use crate::error::WorkspaceError;
|
||||
|
||||
/// Build an error envelope from a `WorkspaceError`.
|
||||
pub fn envelope_err<T>(error: &WorkspaceError) -> RpcEnvelope<T> {
|
||||
RpcEnvelope::err_parts(error_code(error), error.to_string())
|
||||
}
|
||||
|
||||
/// Map a `WorkspaceError` to its wire code string.
|
||||
///
|
||||
/// Uses an exhaustive match with no wildcard -- the compiler will
|
||||
/// error when new variants are added to `WorkspaceError`, forcing
|
||||
/// the implementer to assign a wire code.
|
||||
pub fn error_code(err: &WorkspaceError) -> &'static str {
|
||||
match err {
|
||||
WorkspaceError::ParentSessionNotFound(_) => "parent_session_not_found",
|
||||
WorkspaceError::SessionNotFound(_) => "session_not_found",
|
||||
WorkspaceError::SessionAlreadyExists(_) => "session_already_exists",
|
||||
WorkspaceError::EmptyAgentId => "empty_agent_id",
|
||||
WorkspaceError::CannotDropMainSession => "cannot_drop_main",
|
||||
WorkspaceError::Finalize(_) => "finalize",
|
||||
WorkspaceError::CapabilityWidening { .. } => "capability_widening",
|
||||
WorkspaceError::Unauthorized { .. } => "unauthorized",
|
||||
WorkspaceError::TurnActive(_) => kigi_workspace_types::rpc::envelope::TURN_ACTIVE,
|
||||
WorkspaceError::MaxDepthExceeded { .. } => "max_depth_exceeded",
|
||||
WorkspaceError::JoinError(_) => "join_error",
|
||||
WorkspaceError::InvalidHunkAction(_) => "invalid_hunk_action",
|
||||
WorkspaceError::HunkActionFailed(_) => "hunk_action_failed",
|
||||
WorkspaceError::HubError(_) => "hub_error",
|
||||
WorkspaceError::DeployError { kind, .. } => kind.wire_code(),
|
||||
WorkspaceError::ShuttingDown => "shutting_down",
|
||||
WorkspaceError::ToolsetExternallyOwned(_) => "toolset_externally_owned",
|
||||
}
|
||||
}
|
||||
|
||||
/// Map a wire [`RpcError`] back to a [`WorkspaceError`].
|
||||
///
|
||||
/// Known codes are mapped to their specific variants. Unknown codes
|
||||
/// degrade gracefully to `WorkspaceError::HubError`, ensuring
|
||||
/// forward compatibility when a newer workspace sends codes an older
|
||||
/// shell does not recognise.
|
||||
///
|
||||
/// # Intentional degradation
|
||||
///
|
||||
/// The structured variants `CapabilityWidening`, `Unauthorized`, and
|
||||
/// `MaxDepthExceeded` carry multiple fields that are not preserved in
|
||||
/// the wire `message` string. These are mapped to `HubError` on the
|
||||
/// deserializing side because reconstructing the original struct fields
|
||||
/// from a flattened `Display` string would be fragile and error-prone.
|
||||
/// Callers that need to distinguish these errors can match on the
|
||||
/// `HubError` message which contains the original error code as a
|
||||
/// prefix (e.g. `"capability_widening: ..."`).
|
||||
pub fn rpc_error_to_workspace(err: RpcError) -> WorkspaceError {
|
||||
if let Some(kind) = kigi_workspace_types::rpc::deploy::DeployError::from_wire_code(&err.code) {
|
||||
return WorkspaceError::DeployError {
|
||||
kind,
|
||||
message: err.message,
|
||||
};
|
||||
}
|
||||
match err.code.as_str() {
|
||||
"parent_session_not_found" => WorkspaceError::ParentSessionNotFound(err.message),
|
||||
"session_not_found" => WorkspaceError::SessionNotFound(err.message),
|
||||
"session_already_exists" => WorkspaceError::SessionAlreadyExists(err.message),
|
||||
"empty_agent_id" => WorkspaceError::EmptyAgentId,
|
||||
"cannot_drop_main" => WorkspaceError::CannotDropMainSession,
|
||||
"finalize" => WorkspaceError::Finalize(err.message),
|
||||
"capability_widening" => {
|
||||
WorkspaceError::HubError(format!("capability_widening: {}", err.message))
|
||||
}
|
||||
"unauthorized" => WorkspaceError::HubError(format!("unauthorized: {}", err.message)),
|
||||
"turn_active" => WorkspaceError::TurnActive(err.message),
|
||||
"max_depth_exceeded" => {
|
||||
WorkspaceError::HubError(format!("max_depth_exceeded: {}", err.message))
|
||||
}
|
||||
"join_error" => WorkspaceError::JoinError(err.message),
|
||||
"invalid_hunk_action" => WorkspaceError::InvalidHunkAction(err.message),
|
||||
"hunk_action_failed" => WorkspaceError::HunkActionFailed(err.message),
|
||||
"hub_error" => WorkspaceError::HubError(err.message),
|
||||
"shutting_down" => WorkspaceError::ShuttingDown,
|
||||
"toolset_externally_owned" => WorkspaceError::ToolsetExternallyOwned(err.message),
|
||||
unknown => {
|
||||
WorkspaceError::HubError(format!("unknown error code: {unknown}: {}", err.message))
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
use crate::capability::CapabilityMode;
|
||||
|
||||
/// Verify round-trip fidelity for every `WorkspaceError` variant.
|
||||
#[test]
|
||||
fn error_code_round_trip_all_variants() {
|
||||
let mut variants: Vec<WorkspaceError> = vec![
|
||||
WorkspaceError::ParentSessionNotFound("p".into()),
|
||||
WorkspaceError::SessionNotFound("s".into()),
|
||||
WorkspaceError::SessionAlreadyExists("s".into()),
|
||||
WorkspaceError::EmptyAgentId,
|
||||
WorkspaceError::CannotDropMainSession,
|
||||
WorkspaceError::Finalize("f".into()),
|
||||
WorkspaceError::CapabilityWidening {
|
||||
parent: CapabilityMode::ReadOnly,
|
||||
child: CapabilityMode::All,
|
||||
},
|
||||
WorkspaceError::Unauthorized {
|
||||
caller: "a".into(),
|
||||
target: "b".into(),
|
||||
},
|
||||
WorkspaceError::TurnActive("s".into()),
|
||||
WorkspaceError::MaxDepthExceeded { parent: "p".into() },
|
||||
WorkspaceError::JoinError("j".into()),
|
||||
WorkspaceError::InvalidHunkAction("h".into()),
|
||||
WorkspaceError::HunkActionFailed("h".into()),
|
||||
WorkspaceError::HubError("hub".into()),
|
||||
WorkspaceError::ShuttingDown,
|
||||
WorkspaceError::ToolsetExternallyOwned("s".into()),
|
||||
];
|
||||
variants.extend(
|
||||
kigi_workspace_types::rpc::deploy::DeployError::ALL
|
||||
.into_iter()
|
||||
.map(|kind| WorkspaceError::DeployError {
|
||||
kind,
|
||||
message: "deploy".into(),
|
||||
}),
|
||||
);
|
||||
|
||||
for err in &variants {
|
||||
let code = error_code(err);
|
||||
assert!(!code.is_empty(), "code must not be empty for {err:?}");
|
||||
|
||||
// Round-trip through RpcError
|
||||
let rpc_err = RpcError {
|
||||
code: code.to_owned(),
|
||||
message: err.to_string(),
|
||||
};
|
||||
let recovered = rpc_error_to_workspace(rpc_err);
|
||||
// The recovered error's code should match the original code
|
||||
let recovered_code = error_code(&recovered);
|
||||
|
||||
// Structured variants (CapabilityWidening, Unauthorized,
|
||||
// MaxDepthExceeded) lose their fields on the wire and
|
||||
// degrade to HubError, which is the expected behavior.
|
||||
// Their error messages are preserved in the HubError string.
|
||||
match err {
|
||||
WorkspaceError::CapabilityWidening { .. } => {
|
||||
assert_eq!(recovered_code, "hub_error");
|
||||
let msg = recovered.to_string();
|
||||
assert!(
|
||||
msg.contains("capability_widening"),
|
||||
"degraded error should contain original code: {msg}"
|
||||
);
|
||||
}
|
||||
WorkspaceError::Unauthorized { .. } => {
|
||||
assert_eq!(recovered_code, "hub_error");
|
||||
let msg = recovered.to_string();
|
||||
assert!(
|
||||
msg.contains("unauthorized"),
|
||||
"degraded error should contain original code: {msg}"
|
||||
);
|
||||
}
|
||||
WorkspaceError::MaxDepthExceeded { .. } => {
|
||||
assert_eq!(recovered_code, "hub_error");
|
||||
let msg = recovered.to_string();
|
||||
assert!(
|
||||
msg.contains("max_depth_exceeded"),
|
||||
"degraded error should contain original code: {msg}"
|
||||
);
|
||||
}
|
||||
_ => {
|
||||
assert_eq!(
|
||||
recovered_code, code,
|
||||
"round-trip mismatch for {err:?}: got code {recovered_code}"
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// Verify unknown codes degrade to HubError.
|
||||
#[test]
|
||||
fn unknown_code_degrades_to_hub_error() {
|
||||
let rpc_err = RpcError {
|
||||
code: "future_new_variant".into(),
|
||||
message: "something new".into(),
|
||||
};
|
||||
let recovered = rpc_error_to_workspace(rpc_err);
|
||||
assert!(matches!(recovered, WorkspaceError::HubError(_)));
|
||||
let msg = recovered.to_string();
|
||||
assert!(msg.contains("future_new_variant"));
|
||||
}
|
||||
|
||||
/// Verify serde round-trip of RpcEnvelope.
|
||||
#[test]
|
||||
fn envelope_serde_round_trip_ok() {
|
||||
let env: RpcEnvelope<String> = RpcEnvelope::ok("hello".into());
|
||||
let json = serde_json::to_value(&env).unwrap();
|
||||
let recovered: RpcEnvelope<String> = serde_json::from_value(json).unwrap();
|
||||
match recovered.into_result() {
|
||||
Ok(v) => assert_eq!(v, "hello"),
|
||||
Err(e) => panic!("expected Ok, got {e:?}"),
|
||||
}
|
||||
}
|
||||
|
||||
/// Verify serde round-trip of RpcEnvelope error, through the
|
||||
/// `WorkspaceError` mapping in both directions.
|
||||
#[test]
|
||||
fn envelope_serde_round_trip_err() {
|
||||
let err = WorkspaceError::SessionNotFound("ghost".into());
|
||||
let env: RpcEnvelope<String> = envelope_err(&err);
|
||||
let json = serde_json::to_value(&env).unwrap();
|
||||
let recovered: RpcEnvelope<String> = serde_json::from_value(json).unwrap();
|
||||
match recovered.into_result().map_err(rpc_error_to_workspace) {
|
||||
Ok(_) => panic!("expected Err"),
|
||||
Err(e) => {
|
||||
assert_eq!(error_code(&e), "session_not_found");
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user