mirror of
https://github.com/Ark0N/Codeman.git
synced 2026-10-02 21:49:42 +02:00
Review of the plan-usage chip feature (commits since 1.0.0) surfaced several issues; this fixes all confirmed findings: - HIGH: applyStatusLineConfig clobbered a user's hand-authored statusLine on the enable path (the isOurs guard only protected disable). Now bails out when an existing statusLine isn't ours, on both the enable and disable paths. - MED: StatusTelemetrySchema used z.optional() (rejects null) on Claude's undocumented statusline fields — a single stray null 400'd the entire POST and silently killed the chip's data feed. Switched the modeled fields to .nullish(). - MED: dropping the Token Count / Show Cost header toggles left their features reading settings.showTokenCount/showCost, but saveAppSettings rebuilds settings fresh from the DOM, dropping those keys and resetting them to defaults on every save (re-enabling the token chip with no UI to turn it off). Preserve the prior stored preference. - telemetrySignature keyed on contextUsedPercentage (never displayed) and the raw unrounded %, churning a redundant SSE broadcast + localStorage write + identical chip re-render on every assistant message. Now keys on the rounded displayed window values only. - Plan-usage chip flashed hidden on load (no server-side reveal): renderIndexHtml now strips header-plan-usage--hidden when enabled, matching btn-multimonitor; fixes the FOUC and makes the "server renders initial state" comments accurate. - Serialize all settings.local.json read-modify-write writers in hooks-config via a shared per-path mutex (previously lock-free; concurrent session-create + settings-toggle on the same repo could lose writes). - Hardened the chip's innerHTML against any future string field; removed the dead _latestPlanUsage field; clamped ctx% in the footer formatter; corrected the session-create comment (the path is add-only by design — a per-repo settings file is shared by sibling sessions). - Tests: new test/routes/status-telemetry-routes.test.ts (route behavior, dedup, null-tolerance) + NaN/Infinity/fractional and signature-churn unit tests; made server-index-title.test.ts deterministic against the ambient settings.json. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
167 lines
7.0 KiB
TypeScript
167 lines
7.0 KiB
TypeScript
/**
|
||
* @fileoverview Pure parsing + formatting of Claude Code statusline telemetry.
|
||
*
|
||
* Claude Code (v2.1.80+) pipes a JSON blob to a configured `statusLine.command`
|
||
* on each render. On Pro/Max subscriptions that blob carries a `rate_limits`
|
||
* object with the 5-hour rolling and 7-day weekly plan windows. The
|
||
* Codeman-managed statusLine exporter (see `hooks-config.generateStatusLineCommand`)
|
||
* POSTs that blob to `/api/status-telemetry`; these helpers normalize the subset
|
||
* Codeman displays and format the compact in-terminal footer string.
|
||
*
|
||
* Confirmed schema (empirically captured, CC 2.1.177, Claude Max — see
|
||
* `docs/usage-limits-display-plan.md`):
|
||
* rate_limits.{five_hour,seven_day}.{used_percentage: number 0-100,
|
||
* resets_at: number EPOCH-SECONDS}
|
||
* Only those two windows exist (no Opus-weekly field). `rate_limits` is absent
|
||
* before the first API response and for non-subscriber auth — both yield null.
|
||
*
|
||
* All functions are pure for testability. See `test/usage-telemetry.test.ts`.
|
||
*
|
||
* @module usage-telemetry
|
||
*/
|
||
|
||
/** A single normalized plan-usage window. */
|
||
export interface UsageWindow {
|
||
/** Percent of the window consumed, 0–100. */
|
||
usedPercentage: number;
|
||
/** Epoch MILLISECONDS when the window resets (statusline reports seconds). */
|
||
resetAt: number;
|
||
}
|
||
|
||
/** Normalized telemetry Codeman broadcasts to the UI. */
|
||
export interface StatusTelemetry {
|
||
fiveHour?: UsageWindow;
|
||
sevenDay?: UsageWindow;
|
||
/** Context-window percent used, 0–100 (bonus field from the same payload). */
|
||
contextUsedPercentage?: number;
|
||
/** Session cost in USD (bonus field). */
|
||
costUsd?: number;
|
||
/** Model display name, e.g. "Opus 4.8 (1M context)" (bonus field). */
|
||
modelDisplayName?: string;
|
||
}
|
||
|
||
/** Raw subset of the statusline stdin JSON (snake_case, as Claude emits it). */
|
||
export interface RawStatuslinePayload {
|
||
rate_limits?: {
|
||
five_hour?: { used_percentage?: number; resets_at?: number };
|
||
seven_day?: { used_percentage?: number; resets_at?: number };
|
||
};
|
||
context_window?: { used_percentage?: number; total_input_tokens?: number; total_output_tokens?: number };
|
||
cost?: { total_cost_usd?: number };
|
||
model?: { display_name?: string };
|
||
}
|
||
|
||
function clampPct(n: number): number {
|
||
if (!Number.isFinite(n)) return 0;
|
||
return Math.max(0, Math.min(100, n));
|
||
}
|
||
|
||
function parseWindow(w?: { used_percentage?: number; resets_at?: number }): UsageWindow | undefined {
|
||
if (!w || typeof w.used_percentage !== 'number' || typeof w.resets_at !== 'number') return undefined;
|
||
if (!Number.isFinite(w.resets_at) || w.resets_at <= 0) return undefined;
|
||
return { usedPercentage: clampPct(w.used_percentage), resetAt: Math.round(w.resets_at * 1000) };
|
||
}
|
||
|
||
/**
|
||
* Normalize a raw statusline payload to the telemetry Codeman displays. Returns
|
||
* null when there is no plan-limit data to show (pre-first-response or a
|
||
* non-subscriber account) so the caller can skip broadcasting.
|
||
*/
|
||
export function parseStatusTelemetry(data: RawStatuslinePayload | undefined): StatusTelemetry | null {
|
||
if (!data) return null;
|
||
const fiveHour = parseWindow(data.rate_limits?.five_hour);
|
||
const sevenDay = parseWindow(data.rate_limits?.seven_day);
|
||
if (!fiveHour && !sevenDay) return null;
|
||
|
||
const t: StatusTelemetry = {};
|
||
if (fiveHour) t.fiveHour = fiveHour;
|
||
if (sevenDay) t.sevenDay = sevenDay;
|
||
if (typeof data.context_window?.used_percentage === 'number') {
|
||
t.contextUsedPercentage = clampPct(data.context_window.used_percentage);
|
||
}
|
||
if (typeof data.cost?.total_cost_usd === 'number' && Number.isFinite(data.cost.total_cost_usd)) {
|
||
t.costUsd = data.cost.total_cost_usd;
|
||
}
|
||
if (typeof data.model?.display_name === 'string' && data.model.display_name) {
|
||
t.modelDisplayName = data.model.display_name.slice(0, 60);
|
||
}
|
||
return t;
|
||
}
|
||
|
||
/**
|
||
* Current-session status for the in-terminal statusline footer. This is the
|
||
* "status of the current session" the user sees in Claude's footer — distinct
|
||
* from the account-wide plan limits, which live ONLY in the Codeman header chip.
|
||
*/
|
||
export interface SessionStatus {
|
||
modelDisplayName?: string;
|
||
inputTokens?: number;
|
||
outputTokens?: number;
|
||
contextUsedPercentage?: number;
|
||
}
|
||
|
||
/** Group a non-negative integer with thousands separators: 562411 → "562,411". */
|
||
function withCommas(n: number): string {
|
||
return Math.max(0, Math.round(n))
|
||
.toString()
|
||
.replace(/\B(?=(\d{3})+(?!\d))/g, ',');
|
||
}
|
||
|
||
/** Extract current-session status (footer) from the raw payload. */
|
||
export function parseSessionStatus(data: RawStatuslinePayload | undefined): SessionStatus | null {
|
||
if (!data) return null;
|
||
const s: SessionStatus = {};
|
||
if (typeof data.model?.display_name === 'string' && data.model.display_name) {
|
||
s.modelDisplayName = data.model.display_name.slice(0, 60);
|
||
}
|
||
const cw = data.context_window;
|
||
if (typeof cw?.total_input_tokens === 'number' && Number.isFinite(cw.total_input_tokens)) {
|
||
s.inputTokens = Math.max(0, cw.total_input_tokens);
|
||
}
|
||
if (typeof cw?.total_output_tokens === 'number' && Number.isFinite(cw.total_output_tokens)) {
|
||
s.outputTokens = Math.max(0, cw.total_output_tokens);
|
||
}
|
||
if (typeof cw?.used_percentage === 'number') {
|
||
s.contextUsedPercentage = clampPct(cw.used_percentage);
|
||
}
|
||
return Object.keys(s).length ? s : null;
|
||
}
|
||
|
||
/**
|
||
* Format the in-terminal statusline footer: the CURRENT SESSION's status —
|
||
* `Opus 4.8 (1M context) in:562,411 out:1,188 ctx:56%` — NOT the plan limits,
|
||
* which live in the Codeman header chip. Claude requires a statusLine command to
|
||
* emit the rate_limits JSON at all, so this is what that command prints back.
|
||
*/
|
||
export function formatSessionStatusText(s: SessionStatus | null): string {
|
||
if (!s) return 'codeman';
|
||
const groups: string[] = [];
|
||
if (s.modelDisplayName) groups.push(s.modelDisplayName);
|
||
const tok: string[] = [];
|
||
if (s.inputTokens != null) tok.push(`in:${withCommas(s.inputTokens)}`);
|
||
if (s.outputTokens != null) tok.push(`out:${withCommas(s.outputTokens)}`);
|
||
if (tok.length) groups.push(tok.join(' '));
|
||
if (s.contextUsedPercentage != null) groups.push(`ctx:${Math.round(clampPct(s.contextUsedPercentage))}%`);
|
||
return groups.length ? groups.join(' ') : 'codeman';
|
||
}
|
||
|
||
/**
|
||
* Stable signature for change-detection — the statusline fires on every
|
||
* assistant message, so the route only rebroadcasts when this value changes.
|
||
*
|
||
* Keys on EXACTLY the values the header chip displays: the two windows' ROUNDED
|
||
* percentages (the chip renders `Math.round`) + their reset times. Deliberately
|
||
* excludes contextUsedPercentage / costUsd / modelDisplayName — none are shown
|
||
* in the chip, and contextUsedPercentage in particular drifts on every assistant
|
||
* message, which would defeat the dedup and fan out a redundant SSE broadcast +
|
||
* localStorage write + identical chip re-render each time.
|
||
*/
|
||
export function telemetrySignature(t: StatusTelemetry): string {
|
||
return JSON.stringify([
|
||
t.fiveHour ? Math.round(t.fiveHour.usedPercentage) : null,
|
||
t.fiveHour?.resetAt ?? null,
|
||
t.sevenDay ? Math.round(t.sevenDay.usedPercentage) : null,
|
||
t.sevenDay?.resetAt ?? null,
|
||
]);
|
||
}
|