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,261 @@
|
||||
use std::cell::{Cell, RefCell};
|
||||
use std::path::Path;
|
||||
use std::time::Instant;
|
||||
|
||||
use super::log::EventWriter;
|
||||
use super::types::{CancellationCategory, Event, RedirectKind, TurnOutcomeLabel};
|
||||
|
||||
/// Per-session event state. `!Send` — lives on the session actor.
|
||||
/// Background tasks use `tracker.writer()` to get a `Clone + Send + Sync` handle.
|
||||
pub struct EventTracker {
|
||||
writer: EventWriter,
|
||||
turn_ended_emitted: Cell<bool>,
|
||||
active_tool: RefCell<Option<(String, Instant)>>,
|
||||
turn_tool_count: Cell<u32>,
|
||||
/// Cross-turn one-shot: the *fatal* user-interrupt cause that cancelled the
|
||||
/// most recent turn (set by the cancel paths), consumed by the *next* real
|
||||
/// user prompt to tag `UserItem::prior_turn_interrupt`. Deliberately NOT
|
||||
/// reset by `begin_turn` — it must survive into the next turn; the consumer
|
||||
/// clears it via `take_prior_interrupt_category`. Interjections are NOT
|
||||
/// recorded here (they don't cancel the turn; see `Event::Interjected`).
|
||||
prior_interrupt_category: Cell<Option<CancellationCategory>>,
|
||||
/// Cross-turn one-shot: the redirect mechanism for the NEXT turn after a
|
||||
/// mid-turn abort — `CancelThenSend` (nothing was queued) or
|
||||
/// `QueuedAfterCancel` (a prompt sat queued behind the aborted turn). Set
|
||||
/// by `cancel_running_task`, consumed by the next user `turn_started` to
|
||||
/// stamp `Event::TurnStarted::redirect_kind`. Like `prior_interrupt_category`
|
||||
/// it deliberately survives `begin_turn` so it reaches the next real turn.
|
||||
prior_redirect_kind: Cell<Option<RedirectKind>>,
|
||||
/// Cross-turn one-shot: armed by the cancel path only when a turn was aborted
|
||||
/// mid-stream with NO tool in flight, so neither the dangling-tool-call
|
||||
/// repair nor a permission tool-result will tell the model it was
|
||||
/// interrupted. Consumed by the next *real* user prompt to inject an
|
||||
/// interrupt `<system-reminder>`. Like the markers above it deliberately
|
||||
/// survives `begin_turn` so it reaches the next real turn.
|
||||
pending_interrupt_reminder: Cell<bool>,
|
||||
}
|
||||
|
||||
impl std::fmt::Debug for EventTracker {
|
||||
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
|
||||
let active_tool = self.active_tool.borrow();
|
||||
f.debug_struct("EventTracker")
|
||||
.field("writer", &self.writer)
|
||||
.field("turn_ended_emitted", &self.turn_ended_emitted.get())
|
||||
.field("turn_tool_count", &self.turn_tool_count.get())
|
||||
.field("active_tool", &active_tool.as_ref().map(|(name, _)| name))
|
||||
.field(
|
||||
"prior_interrupt_category",
|
||||
&self.prior_interrupt_category.get(),
|
||||
)
|
||||
.field("prior_redirect_kind", &self.prior_redirect_kind.get())
|
||||
.field(
|
||||
"pending_interrupt_reminder",
|
||||
&self.pending_interrupt_reminder.get(),
|
||||
)
|
||||
.finish()
|
||||
}
|
||||
}
|
||||
|
||||
impl EventTracker {
|
||||
pub fn new(session_dir: &Path) -> Self {
|
||||
Self {
|
||||
writer: EventWriter::open(session_dir),
|
||||
turn_ended_emitted: Cell::new(false),
|
||||
active_tool: RefCell::new(None),
|
||||
turn_tool_count: Cell::new(0),
|
||||
prior_interrupt_category: Cell::new(None),
|
||||
prior_redirect_kind: Cell::new(None),
|
||||
pending_interrupt_reminder: Cell::new(false),
|
||||
}
|
||||
}
|
||||
|
||||
/// Clone the writer for background tasks.
|
||||
pub fn writer(&self) -> EventWriter {
|
||||
self.writer.clone()
|
||||
}
|
||||
|
||||
pub fn emit(&self, event: Event) {
|
||||
self.writer.emit(event);
|
||||
}
|
||||
|
||||
/// Reset per-turn state. Called at the start of each turn.
|
||||
pub fn begin_turn(&self) {
|
||||
self.turn_ended_emitted.set(false);
|
||||
self.turn_tool_count.set(0);
|
||||
}
|
||||
|
||||
/// Emit `turn_ended` with a double-emission guard.
|
||||
pub fn emit_turn_ended(
|
||||
&self,
|
||||
outcome: TurnOutcomeLabel,
|
||||
category: Option<CancellationCategory>,
|
||||
context: Option<serde_json::Value>,
|
||||
) {
|
||||
if self.turn_ended_emitted.replace(true) {
|
||||
return;
|
||||
}
|
||||
self.emit(Event::TurnEnded {
|
||||
outcome,
|
||||
cancellation_category: category,
|
||||
cancellation_context: context,
|
||||
});
|
||||
}
|
||||
|
||||
/// Set the active tool for cancellation tracking and return the start instant.
|
||||
pub fn tool_started(&self, tool_name: String) -> Instant {
|
||||
let now = Instant::now();
|
||||
*self.active_tool.borrow_mut() = Some((tool_name, now));
|
||||
self.turn_tool_count.set(self.turn_tool_count.get() + 1);
|
||||
now
|
||||
}
|
||||
|
||||
pub fn tool_count_this_turn(&self) -> u32 {
|
||||
self.turn_tool_count.get()
|
||||
}
|
||||
|
||||
pub fn has_active_tool(&self) -> bool {
|
||||
self.active_tool.borrow().is_some()
|
||||
}
|
||||
|
||||
pub fn tool_finished(&self) {
|
||||
*self.active_tool.borrow_mut() = None;
|
||||
}
|
||||
|
||||
/// Cancel in-flight tool and emit `ToolCompleted(cancelled)`.
|
||||
/// Called from `cancel_running_task()` before `turn_ended`.
|
||||
pub fn cancel_active_tool(&self) {
|
||||
if let Some((tool_name, start)) = self.active_tool.borrow_mut().take() {
|
||||
self.emit(Event::ToolCompleted {
|
||||
tool_name,
|
||||
duration_ms: start.elapsed().as_millis() as u64,
|
||||
outcome: super::types::ToolOutcome::Cancelled,
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
/// Record the *fatal* user-interrupt cause that cancelled this turn so the
|
||||
/// *next* real user prompt can be tagged. Overwrites any prior value (latest
|
||||
/// cause wins).
|
||||
pub fn set_prior_interrupt_category(&self, category: CancellationCategory) {
|
||||
self.prior_interrupt_category.set(Some(category));
|
||||
}
|
||||
|
||||
/// Take (and clear) the recorded prior-turn interrupt cause.
|
||||
pub fn take_prior_interrupt_category(&self) -> Option<CancellationCategory> {
|
||||
self.prior_interrupt_category.take()
|
||||
}
|
||||
|
||||
/// Record the redirect mechanism (`CancelThenSend` / `QueuedAfterCancel`)
|
||||
/// for the next turn after a mid-turn abort. Overwrites any prior value
|
||||
/// (latest abort wins).
|
||||
pub fn set_prior_redirect_kind(&self, kind: RedirectKind) {
|
||||
self.prior_redirect_kind.set(Some(kind));
|
||||
}
|
||||
|
||||
/// Take (and clear) the recorded prior-turn redirect kind.
|
||||
pub fn take_prior_redirect_kind(&self) -> Option<RedirectKind> {
|
||||
self.prior_redirect_kind.take()
|
||||
}
|
||||
|
||||
/// Arm the one-shot interrupt reminder for the next real user prompt. Set
|
||||
/// only on the cancel path when no tool was in flight (the case where the
|
||||
/// model would otherwise get no signal that it was interrupted).
|
||||
pub fn set_pending_interrupt_reminder(&self) {
|
||||
self.pending_interrupt_reminder.set(true);
|
||||
}
|
||||
|
||||
/// Take (and clear) the pending interrupt-reminder flag.
|
||||
pub fn take_pending_interrupt_reminder(&self) -> bool {
|
||||
self.pending_interrupt_reminder.replace(false)
|
||||
}
|
||||
|
||||
/// Emit PhaseChanged(PermissionPrompt) → PermissionRequested.
|
||||
/// Returns the Instant for `permission_resolved()` to compute wait_ms.
|
||||
pub fn permission_requested(&self, tool_name: &str) -> Instant {
|
||||
self.emit(Event::PhaseChanged {
|
||||
phase: super::types::Phase::PermissionPrompt,
|
||||
});
|
||||
self.emit(Event::PermissionRequested {
|
||||
tool_name: tool_name.to_string(),
|
||||
});
|
||||
Instant::now()
|
||||
}
|
||||
|
||||
pub fn permission_resolved(
|
||||
&self,
|
||||
tool_name: &str,
|
||||
decision: super::types::PermissionDecision,
|
||||
start: Instant,
|
||||
) {
|
||||
self.emit(Event::PermissionResolved {
|
||||
tool_name: tool_name.to_string(),
|
||||
decision,
|
||||
wait_ms: start.elapsed().as_millis() as u64,
|
||||
});
|
||||
self.emit(Event::PhaseChanged {
|
||||
phase: super::types::Phase::ToolExecution,
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
|
||||
#[test]
|
||||
fn prior_interrupt_markers_are_one_shot_and_survive_begin_turn() {
|
||||
let dir = tempfile::tempdir().expect("tempdir");
|
||||
let t = EventTracker::new(dir.path());
|
||||
|
||||
// Defaults: nothing recorded.
|
||||
assert_eq!(t.take_prior_interrupt_category(), None);
|
||||
assert!(t.take_prior_redirect_kind().is_none());
|
||||
assert!(!t.take_pending_interrupt_reminder());
|
||||
|
||||
// Cancel cause is consumed exactly once.
|
||||
t.set_prior_interrupt_category(CancellationCategory::MidTurnAbort);
|
||||
assert_eq!(
|
||||
t.take_prior_interrupt_category(),
|
||||
Some(CancellationCategory::MidTurnAbort)
|
||||
);
|
||||
assert_eq!(t.take_prior_interrupt_category(), None);
|
||||
|
||||
// Interrupt-reminder flag is consumed exactly once.
|
||||
t.set_pending_interrupt_reminder();
|
||||
assert!(t.take_pending_interrupt_reminder());
|
||||
assert!(!t.take_pending_interrupt_reminder());
|
||||
|
||||
// Redirect kind is consumed exactly once.
|
||||
t.set_prior_redirect_kind(RedirectKind::QueuedAfterCancel);
|
||||
assert!(matches!(
|
||||
t.take_prior_redirect_kind(),
|
||||
Some(RedirectKind::QueuedAfterCancel)
|
||||
));
|
||||
assert!(t.take_prior_redirect_kind().is_none());
|
||||
|
||||
// `begin_turn` runs at the START of a turn — BEFORE the next real user
|
||||
// prompt consumes the markers — so it must NOT clear these cross-turn
|
||||
// markers (it only resets per-turn counters). A regression here would
|
||||
// silently drop the `prior_turn_interrupt` tag / `redirect_kind`.
|
||||
t.set_prior_interrupt_category(CancellationCategory::PermissionRejected);
|
||||
t.set_prior_redirect_kind(RedirectKind::CancelThenSend);
|
||||
t.set_pending_interrupt_reminder();
|
||||
t.begin_turn();
|
||||
assert_eq!(
|
||||
t.take_prior_interrupt_category(),
|
||||
Some(CancellationCategory::PermissionRejected),
|
||||
"begin_turn must preserve the cross-turn interrupt cause"
|
||||
);
|
||||
assert!(
|
||||
matches!(
|
||||
t.take_prior_redirect_kind(),
|
||||
Some(RedirectKind::CancelThenSend)
|
||||
),
|
||||
"begin_turn must preserve the cross-turn redirect kind"
|
||||
);
|
||||
assert!(
|
||||
t.take_pending_interrupt_reminder(),
|
||||
"begin_turn must preserve the pending interrupt reminder"
|
||||
);
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user