feat(headroom): add extras detection and install UI (#2403)

- add Headroom extras status + install endpoints
- show Headroom version + code/ml extras in Token Saver UI
- fix Windows interpreter selection to read from env with headroom-ai
This commit is contained in:
KunN-21
2026-07-10 16:05:04 +07:00
committed by decolua
parent 90df008f0c
commit f1f9d27061
5 changed files with 368 additions and 5 deletions
@@ -24,6 +24,15 @@ export default function TokenSaverClient() {
useState(false);
const [headroomActionLoading, setHeadroomActionLoading] = useState(false);
const [headroomActionError, setHeadroomActionError] = useState("");
const [headroomExtras, setHeadroomExtras] = useState({
version: null,
extras: { code: false, ml: false },
available: ["code", "ml"],
loading: false,
});
const [pendingExtras, setPendingExtras] = useState([]);
const [extrasActionLoading, setExtrasActionLoading] = useState(false);
const [extrasActionError, setExtrasActionError] = useState("");
const [cavemanEnabled, setCavemanEnabled] = useState(false);
const [cavemanLevel, setCavemanLevel] = useState("full");
const [ponytailEnabled, setPonytailEnabled] = useState(false);
@@ -102,6 +111,39 @@ export default function TokenSaverClient() {
});
const data = await res.json();
setHeadroomStatus({ ...data, loading: false });
if (!data?.installed) {
setHeadroomExtras({
version: null,
extras: { code: false, ml: false },
available: ["code", "ml"],
loading: false,
});
setPendingExtras([]);
return;
}
try {
const er = await fetch("/api/headroom/extras", {
headers: { "Cache-Control": "no-store" },
});
if (!er.ok) throw new Error("extras status failed");
const ed = await er.json();
setHeadroomExtras((s) => ({
...s,
version: ed.version ?? null,
extras: ed.extras || { code: false, ml: false },
available: ed.available || ["code", "ml"],
loading: false,
}));
setPendingExtras([]);
} catch {
setHeadroomExtras({
version: null,
extras: { code: false, ml: false },
available: ["code", "ml"],
loading: false,
});
setPendingExtras([]);
}
} catch {
setHeadroomStatus({
installed: false,
@@ -109,6 +151,13 @@ export default function TokenSaverClient() {
python: null,
loading: false,
});
setHeadroomExtras({
version: null,
extras: { code: false, ml: false },
available: ["code", "ml"],
loading: false,
});
setPendingExtras([]);
}
}, []);
@@ -137,6 +186,37 @@ export default function TokenSaverClient() {
}
}, [refreshHeadroomStatus]);
const togglePendingExtra = (extra) => {
setPendingExtras((cur) =>
cur.includes(extra) ? cur.filter((e) => e !== extra) : [...cur, extra]
);
};
const handleInstallExtras = useCallback(async () => {
if (pendingExtras.length === 0) return;
setExtrasActionLoading(true);
setExtrasActionError("");
try {
const res = await fetch("/api/headroom/extras", {
method: "POST",
headers: { "Content-Type": "application/json" },
body: JSON.stringify({ extras: pendingExtras }),
});
const data = await res.json().catch(() => ({}));
if (!res.ok) throw new Error(data.error || "Install failed");
setHeadroomExtras((s) => ({
...s,
version: data.version ?? s.version,
extras: data.extras || s.extras,
}));
setPendingExtras([]);
} catch (e) {
setExtrasActionError(e.message);
} finally {
setExtrasActionLoading(false);
}
}, [pendingExtras]);
const handleCavemanLevel = (level) => {
setCavemanLevel(level);
patchSetting({ cavemanLevel: level });
@@ -257,6 +337,70 @@ export default function TokenSaverClient() {
onChange={() => handleHeadroomEnabled(!headroomEnabled)}
/>
</div>
{headroomStatus.installed && (
<div className="mt-3 ml-1 pl-3 border-l-2 border-border">
<div className="flex items-center gap-2 flex-wrap">
<span className="text-xs text-text-muted">
Compression extras
{headroomExtras.version ? ` · v${headroomExtras.version}` : ""}:
</span>
{headroomExtras.available.map((extra) => {
const installed = !!headroomExtras.extras[extra];
const pending = pendingExtras.includes(extra);
return (
<label
key={extra}
className={`flex items-center gap-1.5 text-xs px-2 py-1 rounded border cursor-pointer transition-colors ${
installed
? "border-success/40 bg-success/5 text-text"
: pending
? "border-primary bg-primary/10 text-primary"
: "border-border text-text-muted hover:bg-surface-2"
}`}
title={
extra === "code"
? "tree-sitter AST compression for code responses"
: "Kompress-v2 HF model for prose/agentic traces (~+1GB)"
}
>
<input
type="checkbox"
className="w-3 h-3"
checked={installed || pending}
disabled={installed}
onChange={() => togglePendingExtra(extra)}
/>
<span className="font-medium">[{extra}]</span>
<span className="opacity-70">
{installed ? "installed" : "not installed"}
</span>
</label>
);
})}
{pendingExtras.length > 0 && (
<button
onClick={handleInstallExtras}
disabled={extrasActionLoading}
className="text-xs px-2.5 py-1 rounded bg-primary text-white hover:opacity-90 disabled:opacity-50"
>
{extrasActionLoading
? "Installing…"
: `Install [proxy,${pendingExtras.join(",")}]`}
</button>
)}
</div>
{extrasActionError && (
<p className="text-xs text-error mt-1">{extrasActionError}</p>
)}
<p className="text-xs text-text-muted mt-1">
Default install is <code>[proxy]</code> only (SmartCrusher for
JSON). Adding <code>[code]</code> enables AST compression
(Python/JS/TS/Go/Rust/Java/C/C++/Perl). Adding <code>[ml]</code>{" "}
enables the Kompress-v2 HF model for prose/agentic traces but
adds ~1 GB (torch + huggingface-hub).
</p>
</div>
)}
<div className="flex items-center justify-between pt-4 gap-4 flex-wrap">
<div className="min-w-0 flex-1">
<p className="font-medium">
+30
View File
@@ -0,0 +1,30 @@
import { NextResponse } from "next/server";
import { findPython310, getInstalledHeadroomExtras, HEADROOM_COMPRESSION_EXTRAS } from "@/lib/headroom/detect";
import { installHeadroomExtras } from "@/lib/headroom/process";
export const dynamic = "force-dynamic";
export async function GET() {
try {
const python = findPython310();
const status = getInstalledHeadroomExtras(python);
return NextResponse.json({
available: HEADROOM_COMPRESSION_EXTRAS,
...status,
});
} catch (error) {
return NextResponse.json({ error: error.message }, { status: 500 });
}
}
export async function POST(req) {
try {
const body = await req.json().catch(() => ({}));
const requested = Array.isArray(body?.extras) ? body.extras : [];
const result = await installHeadroomExtras(requested);
return NextResponse.json(result);
} catch (error) {
const status = error.code === "NOT_INSTALLED" || error.code === "NO_PYTHON" ? 400 : 500;
return NextResponse.json({ error: error.message, code: error.code || null }, { status });
}
}
+71 -3
View File
@@ -1,6 +1,21 @@
import { execSync } from "child_process";
import { execFileSync, execSync } from "child_process";
import path from "path";
// Extras that improve headroom compression quality. `proxy` is the base;
// `code` adds tree-sitter AST compression; `ml` adds Kompress-v2 HF model.
// Other `[all]` extras (image, voice, otel, reports, evals, ...) are not
// useful for the 9router proxy use case, so we don't track them here.
export const HEADROOM_COMPRESSION_EXTRAS = ["code", "ml"];
// Marker packages that each extra pulls in. Detected from `pip list --format=json`
// so one call can answer both the installed version and active extras.
const EXTRA_MARKERS = {
code: ["tree-sitter", "tree-sitter-language-pack"],
ml: ["torch", "huggingface-hub"],
};
const HEADROOM_PIP_TIMEOUT_MS = 8000;
const IS_WIN = process.platform === "win32";
const WHICH_CMD = IS_WIN ? "where" : "which";
@@ -49,6 +64,9 @@ export function findHeadroomBinary() {
}
// Find a Python interpreter >= 3.10 (headroom-ai requires it). Returns null if none.
// On Windows, `python3` and `python` can point at different envs. Prefer the
// first candidate that can also see the installed `headroom-ai` package so the
// dashboard probes and install action operate on the same interpreter as the CLI.
export function findPython310() {
for (const candidate of PYTHON_CANDIDATES) {
try {
@@ -60,8 +78,18 @@ export function findPython310() {
const match = ver.match(/(\d+)\.(\d+)/);
if (!match) continue;
const [major, minor] = [parseInt(match[1], 10), parseInt(match[2], 10)];
if (major > MIN_VERSION[0] || (major === MIN_VERSION[0] && minor >= MIN_VERSION[1])) {
if (!(major > MIN_VERSION[0] || (major === MIN_VERSION[0] && minor >= MIN_VERSION[1]))) continue;
if (!IS_WIN) return candidate;
try {
execFileSync(candidate, ["-m", "pip", "show", "headroom-ai"], {
stdio: ["ignore", "pipe", "ignore"],
windowsHide: true,
timeout: HEADROOM_PIP_TIMEOUT_MS,
env: { ...process.env, PATH: EXTENDED_PATH },
});
return candidate;
} catch {
// Keep scanning on Windows until an interpreter sees headroom-ai.
}
} catch {
// candidate not present, try next
@@ -98,5 +126,45 @@ export async function getHeadroomStatus(url) {
const installed = Boolean(path);
const running = await probeProxyRunning(url);
const localUrl = isLoopbackHeadroomUrl(url);
return { installed, path, running, python, localUrl, canStart: installed && localUrl };
const extrasStatus = installed ? getInstalledHeadroomExtras(python) : { installed: false, version: null, extras: { code: false, ml: false } };
return {
installed,
path,
running,
python,
localUrl,
canStart: installed && localUrl,
version: extrasStatus.version,
extras: extrasStatus.extras,
};
}
// Parse installed headroom-ai version + which compression extras are
// actually installed (detected via marker package presence). One `pip list`
// call is enough to answer both questions.
//
// Returns: { installed: bool, version: string|null, extras: { code, ml } }
export function getInstalledHeadroomExtras(python) {
const py = python || findPython310();
if (!py) return { installed: false, version: null, extras: { code: false, ml: false } };
try {
const out = execFileSync(py, ["-m", "pip", "list", "--format=json", "--disable-pip-version-check"], {
stdio: ["ignore", "pipe", "ignore"],
windowsHide: true,
timeout: HEADROOM_PIP_TIMEOUT_MS,
env: { ...process.env, PATH: EXTENDED_PATH },
}).toString();
const packages = JSON.parse(out);
const names = new Set(packages.map((p) => String(p.name || "").toLowerCase()));
const installed = names.has("headroom-ai");
if (!installed) return { installed: false, version: null, extras: { code: false, ml: false } };
const version = packages.find((p) => p.name?.toLowerCase() === "headroom-ai")?.version || null;
const extras = {};
for (const extra of HEADROOM_COMPRESSION_EXTRAS) {
extras[extra] = EXTRA_MARKERS[extra].some((m) => names.has(m));
}
return { installed: true, version, extras };
} catch {
return { installed: false, version: null, extras: { code: false, ml: false } };
}
}
+50 -1
View File
@@ -2,7 +2,7 @@ import fs from "fs";
import path from "path";
import { spawn } from "child_process";
import { DATA_DIR } from "@/lib/dataDir.js";
import { findHeadroomBinary } from "./detect.js";
import { findHeadroomBinary, findPython310, HEADROOM_COMPRESSION_EXTRAS, getInstalledHeadroomExtras } from "./detect.js";
const HEADROOM_DIR = path.join(DATA_DIR, "headroom");
const PID_FILE = path.join(HEADROOM_DIR, "proxy.pid");
@@ -126,3 +126,52 @@ export function getHeadroomLogTail(maxLines = 200) {
return lines.slice(-maxLines).join("\n");
} catch { return ""; }
}
// Install (or upgrade) headroom-ai with the requested compression extras.
// `extras` is a whitelist from HEADROOM_COMPRESSION_EXTRAS — anything else
// is rejected to keep the install surface predictable. Always installs the
// `proxy` base + whatever extras the user picked, regardless of what is
// already present.
export async function installHeadroomExtras(extras = []) {
const requested = Array.isArray(extras) ? extras.filter((e) => HEADROOM_COMPRESSION_EXTRAS.includes(e)) : [];
const py = findPython310();
if (!py) {
const err = new Error("Python >= 3.10 not found");
err.code = "NO_PYTHON";
throw err;
}
if (!findHeadroomBinary()) {
const err = new Error("headroom-ai not installed (run `pip install headroom-ai[proxy]` first)");
err.code = "NOT_INSTALLED";
throw err;
}
// pip install string is built from a closed set (HEADROOM_COMPRESSION_EXTRAS),
// so it cannot be poisoned by caller input — the comma-list is a fixed
// ['proxy', ...requested]. No shell interpolation.
const extrasList = ["proxy", ...requested].join(",");
const spec = `headroom-ai[${extrasList}]`;
const args = ["-m", "pip", "install", "--upgrade", spec];
ensureDir();
const outFd = fs.openSync(path.join(HEADROOM_DIR, "install.log"), "a");
const child = spawn(py, args, {
stdio: ["ignore", outFd, outFd],
windowsHide: true,
env: { ...process.env },
});
return new Promise((resolve, reject) => {
child.once("error", (e) => { fs.closeSync(outFd); reject(e); });
child.once("exit", (code) => {
fs.closeSync(outFd);
if (code === 0) {
const status = getInstalledHeadroomExtras(py);
resolve({ success: true, code, spec, extras: requested, ...status });
} else {
const err = new Error(`pip install exited with code=${code} — see headroom/install.log`);
err.code = "INSTALL_FAILED";
reject(err);
}
});
});
}