ZacharyZhang-NY/Kigi-CLI
1
0
Fork 0
Code Issues Pull Requests Actions 13 Packages Projects Releases Wiki Activity

docs(comments): rewrite comments across all crates to the guidelines

Browse Source 
Sweep every first-party crate source (1956 .rs files) to the project comment
guidelines: delete redundant restatements, decorative banners, change
narration, and end-of-line comments; keep and tighten the crucial ones
(invariants, bug rationale, SAFETY blocks, ported-source attribution).

No functional code changed. Every edit is proven comment-only against the
prior tree by a comment-stripping lexer (string/char/raw-string aware) plus a
separate doctest-fence check. Where removing a comment made rustfmt or clippy
want to re-lay-out adjacent code, the minimal triggering comment is restored so
code tokens stay byte-identical.

Gates green: cargo fmt --all --check (0 diffs), cargo check and cargo clippy
--workspace --all-targets (0 warnings).

Adds scripts/check_codegen_comment_guidelines.py — the enforcement gate for
these guidelines (flags banners, end-of-line comments, change narration, and
commented-out code).
This commit is contained in:
ZacharyZhang-NY
2026-07-23 16:55:39 -04:00
parent ff0fb56c67
commit a02b555e66
1458 changed files with 10729 additions and 21750 deletions
Download Patch File Download Diff File Expand all files Collapse all files
crates/codegen/kigi-sampler/tests/support/mod.rs
+3 -2
View File
@@ -16,8 +16,9 @@ pub fn test_config(base_url: &str, api_key: &str) -> SamplerConfig {
}
}
/// Drive one POST through the client; the canned `{}` body is not a valid
/// completion, but only the wire-level request matters here.
/// Drive one POST through the client. The response is discarded: the counting
/// server never returns a valid completion, and only the wire-level request
/// matters here.
pub async fn send_one(client: &SamplingClient) {
let request = ConversationRequest {
items: vec![ConversationItem::User(UserItem {
crates/codegen/kigi-sampler/tests/test_actor.rs
-31
View File
@@ -29,9 +29,7 @@ use kigi_sampling_types::{
};
use kigi_test_support::{SseEvent, sse};
// ---------------------------------------------------------------------------
// Mock server harness
// ---------------------------------------------------------------------------
struct MockServer {
addr: SocketAddr,
@@ -64,9 +62,7 @@ impl MockServer {
}
}
// ---------------------------------------------------------------------------
// Config + request helpers
// ---------------------------------------------------------------------------
fn test_config(base_url: String, model: &str) -> SamplerConfig {
SamplerConfig {
@@ -114,9 +110,7 @@ fn user_request(text: &str) -> ConversationRequest {
}
}
// ---------------------------------------------------------------------------
// SSE generators
// ---------------------------------------------------------------------------
/// Render test-helper [`SseEvent`]s (optional `event:` name + `data:`) as
/// axum SSE events for this file's router-based harness.
@@ -148,9 +142,7 @@ fn text_chunk_event(content: &str, finish: bool) -> Event {
Event::default().data(chunk.to_string())
}
// ---------------------------------------------------------------------------
// Actor lifecycle
// ---------------------------------------------------------------------------
#[tokio::test(flavor = "multi_thread", worker_threads = 2)]
async fn spawn_then_active_count_zero_then_cancel_unknown_is_noop() {
@@ -163,9 +155,7 @@ async fn spawn_then_active_count_zero_then_cancel_unknown_is_noop() {
assert_eq!(handle.active_count().await, 0);
}
// ---------------------------------------------------------------------------
// Submit + event flow
// ---------------------------------------------------------------------------
#[tokio::test(flavor = "multi_thread", worker_threads = 2)]
async fn submit_emits_started_first_token_channel_completed() {
@@ -226,9 +216,7 @@ async fn submit_emits_started_first_token_channel_completed() {
}
}
// ---------------------------------------------------------------------------
// submit_and_collect
// ---------------------------------------------------------------------------
#[tokio::test(flavor = "multi_thread", worker_threads = 2)]
async fn submit_and_collect_returns_response() {
@@ -258,9 +246,7 @@ async fn submit_and_collect_returns_response() {
assert_eq!(a.content.as_ref(), "collected response");
}
// ---------------------------------------------------------------------------
// Cancellation
// ---------------------------------------------------------------------------
#[tokio::test(flavor = "multi_thread", worker_threads = 2)]
async fn cancel_in_flight_request_terminates_task() {
@@ -313,9 +299,7 @@ async fn cancel_in_flight_request_terminates_task() {
server.shutdown();
}
// ---------------------------------------------------------------------------
// Concurrent requests
// ---------------------------------------------------------------------------
#[tokio::test(flavor = "multi_thread", worker_threads = 4)]
async fn two_concurrent_requests_complete_with_correct_request_ids() {
@@ -371,9 +355,7 @@ async fn two_concurrent_requests_complete_with_correct_request_ids() {
server.shutdown();
}
// ---------------------------------------------------------------------------
// Retry on transient transport error
// ---------------------------------------------------------------------------
#[tokio::test(flavor = "multi_thread", worker_threads = 2)]
async fn retries_on_500_then_succeeds() {
@@ -386,7 +368,6 @@ async fn retries_on_500_then_succeeds() {
async move {
let n = counter.fetch_add(1, Ordering::SeqCst);
if n == 0 {
// First attempt: server error.
Err::<Sse<_>, (StatusCode, String)>((
StatusCode::INTERNAL_SERVER_ERROR,
json!({ "error": { "message": "transient" } }).to_string(),
@@ -434,9 +415,7 @@ async fn retries_on_500_then_succeeds() {
);
}
// ---------------------------------------------------------------------------
// Rate limit exhausts threshold
// ---------------------------------------------------------------------------
#[tokio::test(flavor = "multi_thread", worker_threads = 2)]
async fn rate_limit_exhausts_at_threshold_and_yields_failed() {
@@ -489,9 +468,7 @@ async fn rate_limit_exhausts_at_threshold_and_yields_failed() {
assert!((1..=3).contains(&hits), "expected 1-3 hits, got {hits}");
}
// ---------------------------------------------------------------------------
// Auth error -> EmitToSession (immediate)
// ---------------------------------------------------------------------------
#[tokio::test(flavor = "multi_thread", worker_threads = 2)]
async fn auth_401_emits_failed_immediately_no_retry() {
@@ -542,9 +519,7 @@ async fn auth_401_emits_failed_immediately_no_retry() {
assert_eq!(counter.load(Ordering::SeqCst), 1, "no retries on 401");
}
// ---------------------------------------------------------------------------
// Anthropic Messages API: refusal stop_reason + mid-stream parse failure
// ---------------------------------------------------------------------------
fn messages_config(base_url: String) -> SamplerConfig {
let mut cfg = test_config(base_url, "messages-compatible-model");
@@ -709,9 +684,7 @@ async fn messages_unparseable_event_is_fatal_without_retry() {
assert_eq!(counter.load(Ordering::SeqCst), 1, "exactly one attempt");
}
// ---------------------------------------------------------------------------
// UpdateConfig invalidates cache + applies to subsequent requests
// ---------------------------------------------------------------------------
#[tokio::test(flavor = "multi_thread", worker_threads = 2)]
async fn update_config_changes_subsequent_request_model() {
@@ -765,9 +738,7 @@ async fn update_config_changes_subsequent_request_model() {
);
}
// ---------------------------------------------------------------------------
// Responses doom-loop check signals
// ---------------------------------------------------------------------------
fn responses_config(base_url: String, doom_loop: Option<DoomLoopRecoveryPolicy>) -> SamplerConfig {
let mut cfg = test_config(base_url, "test-model");
@@ -881,9 +852,7 @@ async fn responses_confident_doom_loop_signal_resamples_once() {
);
}
// ---------------------------------------------------------------------------
// Helpers for draining the event channel
// ---------------------------------------------------------------------------
/// Drain the event channel until a terminal event (`Completed` or
/// `Failed`) is received, or until `deadline` elapses.
crates/codegen/kigi-sampler/tests/test_kimi_wire.rs
-11
View File
@@ -37,9 +37,7 @@ use kigi_sampling_types::{
ToolResultItem, ToolSpec, UserItem, synthesized_reasoning_item,
};
// ---------------------------------------------------------------------------
// Mock server harness (same shape as test_actor.rs)
// ---------------------------------------------------------------------------
struct MockServer {
addr: SocketAddr,
@@ -139,9 +137,7 @@ async fn drain_until_terminal(
}
}
// ---------------------------------------------------------------------------
// Streaming happy path: reasoning + tool calls + Kimi usage shapes
// ---------------------------------------------------------------------------
#[tokio::test(flavor = "multi_thread", worker_threads = 2)]
async fn kimi_stream_reasoning_tool_calls_and_choice_usage() {
@@ -254,9 +250,7 @@ async fn kimi_stream_reasoning_tool_calls_and_choice_usage() {
}
}
// ---------------------------------------------------------------------------
// Request surface: bearer auth, kigi UA, kimi_compat body adaptations
// ---------------------------------------------------------------------------
type Captured = Arc<Mutex<Option<(HeaderMap, Value)>>>;
@@ -415,9 +409,7 @@ async fn request_carries_bearer_kigi_ua_and_kimi_dialect_body() {
assert_eq!(props["path"]["type"], json!("string"));
}
// ---------------------------------------------------------------------------
// 429 with Retry-After
// ---------------------------------------------------------------------------
#[tokio::test(flavor = "multi_thread", worker_threads = 2)]
async fn rate_limit_honors_retry_after_then_succeeds() {
@@ -494,9 +486,7 @@ async fn rate_limit_honors_retry_after_then_succeeds() {
);
}
// ---------------------------------------------------------------------------
// Mid-stream network drop → retry → recovery
// ---------------------------------------------------------------------------
#[tokio::test(flavor = "multi_thread", worker_threads = 2)]
async fn mid_stream_drop_recovers_via_retry() {
@@ -509,7 +499,6 @@ async fn mid_stream_drop_recovers_via_retry() {
async move {
let n = counter.fetch_add(1, Ordering::SeqCst);
if n == 0 {
// First attempt: a partial chunk, then the connection
// dies mid-body (simulated network drop).
let events: Vec<Result<Event, std::io::Error>> = vec![
Ok(chunk(