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,257 @@
|
||||
//! JSON-RPC 2.0 envelope types with the Grok `session_id` / `seq`
|
||||
//! extensions.
|
||||
//!
|
||||
//! Two distinct id concepts coexist in this crate:
|
||||
//!
|
||||
//! - [`JsonRpcId`] (this module) is the JSON-RPC envelope `id` field —
|
||||
//! string OR number on the wire, per-connection, sender-allocated.
|
||||
//! - [`crate::RequestId`] is an opaque newtype wrapping a string, used
|
||||
//! internally as a correlator (e.g. to key in-flight maps). Convert
|
||||
//! between them via [`JsonRpcId::from_request_id`] /
|
||||
//! [`JsonRpcId::as_request_id`].
|
||||
|
||||
use std::fmt;
|
||||
|
||||
use serde::{Deserialize, Deserializer, Serialize, Serializer, de};
|
||||
|
||||
use crate::{FrameSeq, IdError, RequestId, SessionId};
|
||||
|
||||
/// JSON-RPC 2.0 protocol version marker.
|
||||
///
|
||||
/// Serializes as the literal string `"2.0"` and rejects any other value on
|
||||
/// deserialize.
|
||||
#[derive(Debug, Clone, Copy, Default, PartialEq, Eq)]
|
||||
pub struct JsonRpcVersion;
|
||||
|
||||
impl JsonRpcVersion {
|
||||
pub const VERSION: &'static str = "2.0";
|
||||
}
|
||||
|
||||
impl fmt::Display for JsonRpcVersion {
|
||||
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
|
||||
f.write_str(Self::VERSION)
|
||||
}
|
||||
}
|
||||
|
||||
impl Serialize for JsonRpcVersion {
|
||||
fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
|
||||
serializer.serialize_str(Self::VERSION)
|
||||
}
|
||||
}
|
||||
|
||||
impl<'de> Deserialize<'de> for JsonRpcVersion {
|
||||
fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
|
||||
struct V;
|
||||
impl de::Visitor<'_> for V {
|
||||
type Value = JsonRpcVersion;
|
||||
fn expecting(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
|
||||
write!(f, "the literal string \"{}\"", JsonRpcVersion::VERSION)
|
||||
}
|
||||
fn visit_str<E: de::Error>(self, v: &str) -> Result<Self::Value, E> {
|
||||
if v == JsonRpcVersion::VERSION {
|
||||
Ok(JsonRpcVersion)
|
||||
} else {
|
||||
Err(E::custom(format!(
|
||||
"expected jsonrpc \"{}\", got {v:?}",
|
||||
JsonRpcVersion::VERSION
|
||||
)))
|
||||
}
|
||||
}
|
||||
}
|
||||
deserializer.deserialize_str(V)
|
||||
}
|
||||
}
|
||||
|
||||
/// JSON-RPC 2.0 envelope `id` field.
|
||||
///
|
||||
/// Per the spec the `id` MAY be a string, a number, or null. We accept the
|
||||
/// first two on deserialize and emit a string ourselves. Null ids are not
|
||||
/// produced and not modelled on the receive path.
|
||||
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
|
||||
#[serde(untagged)]
|
||||
pub enum JsonRpcId {
|
||||
String(String),
|
||||
Number(i64),
|
||||
}
|
||||
|
||||
impl JsonRpcId {
|
||||
pub fn new_string(s: impl Into<String>) -> Self {
|
||||
Self::String(s.into())
|
||||
}
|
||||
|
||||
/// Build a fresh UUID v7-backed id.
|
||||
pub fn new_uuid_v7() -> Self {
|
||||
Self::String(uuid::Uuid::now_v7().to_string())
|
||||
}
|
||||
|
||||
pub fn from_request_id(id: &RequestId) -> Self {
|
||||
Self::String(id.as_str().to_owned())
|
||||
}
|
||||
|
||||
/// Project to a [`RequestId`]. Numeric ids are stringified. Returns
|
||||
/// an error if the resulting string would be empty.
|
||||
pub fn as_request_id(&self) -> Result<RequestId, IdError> {
|
||||
match self {
|
||||
Self::String(s) => RequestId::new(s.as_str()),
|
||||
Self::Number(n) => RequestId::new(n.to_string()),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl fmt::Display for JsonRpcId {
|
||||
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
|
||||
match self {
|
||||
Self::String(s) => f.write_str(s),
|
||||
Self::Number(n) => write!(f, "{n}"),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// JSON-RPC 2.0 request envelope.
|
||||
///
|
||||
/// Generic over `params` so callers can pin a concrete schema (e.g.
|
||||
/// [`crate::frames::ToolCallParams`]) without losing the envelope's
|
||||
/// invariants.
|
||||
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
|
||||
pub struct JsonRpcRequest<P = serde_json::Value> {
|
||||
pub jsonrpc: JsonRpcVersion,
|
||||
pub id: JsonRpcId,
|
||||
/// Grok extension: routing/sanity-check session id.
|
||||
#[serde(default, skip_serializing_if = "Option::is_none")]
|
||||
pub session_id: Option<SessionId>,
|
||||
pub method: String,
|
||||
pub params: P,
|
||||
}
|
||||
|
||||
/// JSON-RPC 2.0 notification envelope.
|
||||
///
|
||||
/// No `id` (notifications do not produce a response). `seq` is an
|
||||
/// optional per-connection monotonic counter so receivers can dedup and
|
||||
/// detect drops.
|
||||
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
|
||||
pub struct JsonRpcNotification<P = serde_json::Value> {
|
||||
pub jsonrpc: JsonRpcVersion,
|
||||
#[serde(default, skip_serializing_if = "Option::is_none")]
|
||||
pub session_id: Option<SessionId>,
|
||||
#[serde(default, skip_serializing_if = "Option::is_none")]
|
||||
pub seq: Option<FrameSeq>,
|
||||
pub method: String,
|
||||
pub params: P,
|
||||
}
|
||||
|
||||
/// JSON-RPC error object.
|
||||
///
|
||||
/// `code` is the numeric envelope code; `data` typically carries a
|
||||
/// serialized [`crate::error_wire::ToolErrorWire`] so receivers can switch
|
||||
/// on the stable string code rather than the numeric.
|
||||
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
|
||||
pub struct JsonRpcError {
|
||||
pub code: i32,
|
||||
pub message: String,
|
||||
#[serde(default, skip_serializing_if = "Option::is_none")]
|
||||
pub data: Option<serde_json::Value>,
|
||||
}
|
||||
|
||||
/// JSON-RPC 2.0 response envelope.
|
||||
///
|
||||
/// Per the spec exactly one of `result` / `error` is present. The custom
|
||||
/// `Serialize` / `Deserialize` impls enforce that invariant: a payload
|
||||
/// containing both keys, or neither, fails to deserialize.
|
||||
#[derive(Debug, Clone, PartialEq)]
|
||||
pub struct JsonRpcResponse<R = serde_json::Value> {
|
||||
pub jsonrpc: JsonRpcVersion,
|
||||
pub id: JsonRpcId,
|
||||
pub session_id: Option<SessionId>,
|
||||
pub outcome: ResponseOutcome<R>,
|
||||
}
|
||||
|
||||
/// Either a `result` payload (success) or a [`JsonRpcError`] (failure).
|
||||
#[derive(Debug, Clone, PartialEq)]
|
||||
pub enum ResponseOutcome<R> {
|
||||
Result(R),
|
||||
Error(JsonRpcError),
|
||||
}
|
||||
|
||||
impl<R: Serialize> Serialize for JsonRpcResponse<R> {
|
||||
fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
|
||||
use serde::ser::SerializeMap;
|
||||
let mut len = 3;
|
||||
if self.session_id.is_some() {
|
||||
len += 1;
|
||||
}
|
||||
let mut map = serializer.serialize_map(Some(len))?;
|
||||
map.serialize_entry("jsonrpc", &self.jsonrpc)?;
|
||||
map.serialize_entry("id", &self.id)?;
|
||||
if let Some(sid) = &self.session_id {
|
||||
map.serialize_entry("session_id", sid)?;
|
||||
}
|
||||
match &self.outcome {
|
||||
ResponseOutcome::Result(r) => map.serialize_entry("result", r)?,
|
||||
ResponseOutcome::Error(e) => map.serialize_entry("error", e)?,
|
||||
}
|
||||
map.end()
|
||||
}
|
||||
}
|
||||
|
||||
impl<'de, R: Deserialize<'de>> Deserialize<'de> for JsonRpcResponse<R> {
|
||||
fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
|
||||
// `Option<...>` deserialises to `None` when missing without
|
||||
// `#[serde(default)]`, avoiding a `R: Default` bound on the
|
||||
// result type parameter.
|
||||
#[derive(Deserialize)]
|
||||
struct Flat<R> {
|
||||
jsonrpc: JsonRpcVersion,
|
||||
id: JsonRpcId,
|
||||
session_id: Option<SessionId>,
|
||||
result: Option<R>,
|
||||
error: Option<JsonRpcError>,
|
||||
}
|
||||
|
||||
let flat = Flat::<R>::deserialize(deserializer)?;
|
||||
let outcome = match (flat.result, flat.error) {
|
||||
(Some(r), None) => ResponseOutcome::Result(r),
|
||||
(None, Some(e)) => ResponseOutcome::Error(e),
|
||||
(Some(_), Some(_)) => {
|
||||
return Err(de::Error::custom(
|
||||
"JSON-RPC response must contain `result` XOR `error`, got both",
|
||||
));
|
||||
}
|
||||
(None, None) => {
|
||||
return Err(de::Error::custom(
|
||||
"JSON-RPC response must contain `result` or `error`",
|
||||
));
|
||||
}
|
||||
};
|
||||
Ok(Self {
|
||||
jsonrpc: flat.jsonrpc,
|
||||
id: flat.id,
|
||||
session_id: flat.session_id,
|
||||
outcome,
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
impl<R> JsonRpcResponse<R> {
|
||||
pub fn ok(id: JsonRpcId, result: R) -> Self {
|
||||
Self {
|
||||
jsonrpc: JsonRpcVersion,
|
||||
id,
|
||||
session_id: None,
|
||||
outcome: ResponseOutcome::Result(result),
|
||||
}
|
||||
}
|
||||
|
||||
pub fn err(id: JsonRpcId, error: JsonRpcError) -> Self {
|
||||
Self {
|
||||
jsonrpc: JsonRpcVersion,
|
||||
id,
|
||||
session_id: None,
|
||||
outcome: ResponseOutcome::Error(error),
|
||||
}
|
||||
}
|
||||
|
||||
pub fn with_session(mut self, sid: SessionId) -> Self {
|
||||
self.session_id = Some(sid);
|
||||
self
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user