Files
stack/packages/webui/tests/triage-usage.test.mjs
jason.woltje 17b972b92d feat(triage): the host holds the daily token cap
Each turn's usage goes to <dataRoot>/triage/usage.jsonl, one line per
usage.end, 0600 and owned by the running user; a link, wrong mode or
owner, or a non-file refuses. The host holds the stored cap through
daily-quota mayLaunch and report before each start and each queued
message, lets a crossing turn finish, drains the queue with a host
line, sums the file again after a restart (a torn line counts as an
unknown turn), and GET /api/triage adds usageToday, cap and resetsAt.
With no route stored the fields say "not set". cli.mjs keeps route
null. (#1873, lane triage-cap)
2026-11-18 14:03:50 -06:00

206 lines
14 KiB
JavaScript

// #1873 triage-cap: Triage's usage file and its daily cap. One line per turn in
// <dataRoot>/triage/usage.jsonl, held to the same file checks as the route store; the cap is the
// daily-quota plugin's own rule over those lines, with the stored cap as its one leaf.
import { test } from "node:test";
import assert from "node:assert/strict";
import { chmodSync, linkSync, lstatSync, mkdirSync, mkdtempSync, readFileSync, symlinkSync, writeFileSync } from "node:fs";
import { execFileSync } from "node:child_process";
import { join } from "node:path";
import { mayLaunch, report } from "../../plugins/limit-check/daily-quota/index.mjs";
import {
USAGE_ACCOUNT, USAGE_FIELDS, appendUsage, capState, delta, limitsFor, nextReset, readUsage, snapshot, usagePath,
} from "../src/triage-usage.mjs";
const scratch = () => mkdtempSync(join(process.env.TMPDIR, "tu-"));
const fileIn = () => {
const dir = join(scratch(), "triage");
mkdirSync(dir, { mode: 0o700 });
return join(dir, "usage.jsonl");
};
const line = (over = {}) => ({ at: "2026-11-18T12:00:00.000Z", run: "triage-20261118120000", turn: "owner-0123456789ab", status: "known", input: 10, output: 5, cacheRead: 2, cacheWrite: 1, ...over });
const unknownLine = (over = {}) => line({ status: "unknown", input: null, output: null, cacheRead: null, cacheWrite: null, ...over });
const cap = (over = {}) => ({ limit: 100, since: "2026-10-01T00:00:00.000Z", reset: "00:00", timeZone: "UTC", ...over });
const ms = (s) => Date.parse(s);
test("the usage file is <dataRoot>/triage/usage.jsonl and a line holds exactly its eight fields", () => {
assert.equal(usagePath("/d"), "/d/triage/usage.jsonl");
assert.deepEqual(USAGE_FIELDS, ["at", "run", "turn", "status", "input", "output", "cacheRead", "cacheWrite"]);
assert.equal(USAGE_ACCOUNT, "triage");
});
test("each append writes one line, 0600, in field order; a torn last line is closed off before the next line", () => {
const file = fileIn();
appendUsage(file, line());
appendUsage(file, unknownLine({ turn: "owner-0123456789ac" }));
assert.equal(lstatSync(file).mode & 0o777, 0o600);
const text = readFileSync(file, "utf8");
assert.equal(text.split("\n").length, 3);
assert.deepEqual(Object.keys(JSON.parse(text.split("\n")[0])), USAGE_FIELDS);
// A crash in a write leaves a torn line. The next append starts on a line of its own.
writeFileSync(file, '{"at":"2026-11-18T12:0', { flag: "a" });
appendUsage(file, line({ turn: "owner-0123456789ad" }));
const lines = readFileSync(file, "utf8").split("\n");
assert.equal(lines.length, 5);
assert.equal(JSON.parse(lines[3]).turn, "owner-0123456789ad");
// A line that does not match its shape is never written.
for (const bad of [{ ...line(), extra: 1 }, line({ at: "yesterday" }), line({ input: -1 }), line({ status: "unknown" }), unknownLine({ input: 3 }), line({ turn: "a b" }), line({ run: "" })]) {
assert.throws(() => appendUsage(file, bad), (e) => e.code === "triage-usage-unreadable", JSON.stringify(bad));
}
assert.equal(readFileSync(file, "utf8").split("\n").length, 5);
});
test("a narrow umask still leaves a new usage file at 0600", () => {
const file = fileIn();
const old = process.umask(0o277);
try { appendUsage(file, line()); } finally { process.umask(old); }
assert.equal(lstatSync(file).mode & 0o777, 0o600);
});
// Each unsafe state refuses both the read and the append, and the append leaves the target alone.
function unsafe(make) {
const file = fileIn();
const opts = make(file) ?? {};
return { file, opts };
}
test("a wrong mode, a wrong owner, a symlink, a hard link or a non-file refuses the read and the append", () => {
const cases = {
"mode 0644": (f) => { appendUsage(f, line()); chmodSync(f, 0o644); },
"mode 0400": (f) => { appendUsage(f, line()); chmodSync(f, 0o400); },
"owner": (f) => { appendUsage(f, line()); return { uid: process.getuid() + 1 }; },
"symlink": (f) => { const real = join(f, "..", "real.jsonl"); writeFileSync(real, "", { mode: 0o600 }); symlinkSync(real, f); },
"dangling symlink": (f) => { symlinkSync(join(f, "..", "absent.jsonl"), f); },
"hard link": (f) => { appendUsage(f, line()); linkSync(f, join(f, "..", "other.jsonl")); },
"directory": (f) => { mkdirSync(f, { mode: 0o700 }); },
"fifo": (f) => { execFileSync("mkfifo", ["-m", "600", f]); },
};
for (const [label, make] of Object.entries(cases)) {
const { file, opts } = unsafe(make);
const before = lstatSync(file);
assert.throws(() => readUsage(file, opts), (e) => e.code === "triage-usage-unreadable", `read: ${label}`);
assert.throws(() => appendUsage(file, line(), opts), (e) => e.code === "triage-usage-unreadable", `append: ${label}`);
const after = lstatSync(file);
assert.deepEqual([after.size, after.mode, after.ino], [before.size, before.mode, before.ino], `untouched: ${label}`);
}
// The dangling link's target is not made.
const { file } = unsafe((f) => { symlinkSync(join(f, "..", "absent.jsonl"), f); });
try { appendUsage(file, line()); } catch {}
assert.throws(() => lstatSync(join(file, "..", "absent.jsonl")), (e) => e.code === "ENOENT");
});
test("a usage file over the size bound refuses before it is parsed", () => {
const file = fileIn();
appendUsage(file, line());
appendUsage(file, line({ turn: "owner-0123456789ac" }));
const size = lstatSync(file).size;
assert.equal(readUsage(file, { maxBytes: size }).records.length, 2);
assert.throws(() => readUsage(file, { maxBytes: size - 1 }), (e) => e.code === "triage-usage-unreadable");
});
test("no file reads as no turns; good lines read back as records for the triage account", () => {
const file = fileIn();
assert.deepEqual(readUsage(file), { records: [], bad: [] });
appendUsage(file, line());
appendUsage(file, unknownLine({ turn: "owner-0123456789ac" }));
const { records, bad } = readUsage(file);
assert.deepEqual(bad, []);
assert.deepEqual(records, [{ account: "triage", ...line() }, { account: "triage", ...unknownLine({ turn: "owner-0123456789ac" }) }]);
});
test("a torn last line is refused and counts as one unknown turn; a wrong-shaped line the same", () => {
const file = fileIn();
appendUsage(file, line());
writeFileSync(file, '{"at":"2026-11-18T13:00:00.000Z","run":"triage-2026', { flag: "a" });
const torn = readUsage(file);
assert.equal(torn.records.length, 2);
assert.deepEqual(torn.bad.map((b) => b.line), [2]);
const [, b] = torn.records;
assert.deepEqual([b.status, b.run, b.turn, b.input, b.output, b.cacheRead, b.cacheWrite], ["unknown", null, "line-2", null, null, null, null]);
assert.ok(!Number.isNaN(Date.parse(b.at)), "a torn last line takes the file's change time");
const [r] = report({ limits: limitsFor(cap()), records: torn.records, now: "2026-11-18T23:00:00.000Z" });
assert.deepEqual([r.count, r.unknownTurns], [18, 1]);
// Closed off by the next append, it stays one unknown turn, dated by the line after it.
appendUsage(file, line({ at: "2026-11-18T14:00:00.000Z", turn: "owner-0123456789ac", input: 1, output: 0, cacheRead: 0, cacheWrite: 0 }));
writeFileSync(file, JSON.stringify({ ...line(), input: "9" }) + "\n", { flag: "a" });
const later = readUsage(file);
assert.deepEqual(later.bad.map((x) => x.line), [2, 4]);
assert.equal(later.records[1].at, "2026-11-18T14:00:00.000Z");
const [again] = report({ limits: limitsFor(cap()), records: later.records, now: "2026-11-18T23:00:00.000Z" });
assert.deepEqual([again.count, again.unknownTurns], [19, 2]);
});
test("the limits copy the organization shape: one daily leaf for the triage account", () => {
assert.deepEqual(limitsFor(cap()), { tokens: { daily: { triage: cap() } } });
const records = [{ account: "triage", ...line({ input: 100, output: 0, cacheRead: 0, cacheWrite: 0 }) }];
assert.deepEqual(mayLaunch({ limits: limitsFor(cap()), subject: { account: "triage" }, records, now: "2026-11-18T13:00:00.000Z" }).allow, false);
});
test("the cap state: under, at and over the cap, unknown turns adding nothing, and the cap's since", () => {
const now = ms("2026-11-18T18:00:00.000Z");
const recs = (...counts) => counts.map((n, i) => ({ account: "triage", ...line({ turn: `owner-00000000000${i}`, input: n, output: 0, cacheRead: 0, cacheWrite: 0 }) }));
const under = capState({ cap: cap(), records: recs(40, 59), now });
assert.equal(under.allow, true);
assert.deepEqual(under.usageToday, { count: 99, input: 99, output: 0, cacheRead: 0, cacheWrite: 0, unknownTurns: 0 });
assert.equal(under.resetsAt, "2026-11-19T00:00:00.000Z");
const at = capState({ cap: cap(), records: recs(40, 60), now });
assert.equal(at.allow, false);
assert.equal(at.usageToday.count, 100);
const withUnknown = capState({ cap: cap(), records: [...recs(40), { account: "triage", ...unknownLine({ turn: "owner-00000000000f" }) }], now });
assert.deepEqual([withUnknown.allow, withUnknown.usageToday.count, withUnknown.usageToday.unknownTurns], [true, 40, 1]);
// Lines before the cap's since or before today's reset do not count.
const old = [{ account: "triage", ...line({ at: "2026-11-17T23:59:59.999Z", input: 500, output: 0, cacheRead: 0, cacheWrite: 0 }) }];
assert.equal(capState({ cap: cap(), records: old, now }).usageToday.count, 0);
const since = [{ account: "triage", ...line({ at: "2026-11-18T10:00:00.000Z", input: 500, output: 0, cacheRead: 0, cacheWrite: 0 }) }];
assert.equal(capState({ cap: cap({ since: "2026-11-18T11:00:00.000Z" }), records: since, now }).allow, true);
// A cap of 0 takes no turn, as the plugin's own rule says.
assert.equal(capState({ cap: cap({ limit: 0 }), records: [], now }).allow, false);
});
test("the reset is 00:00 in the stored zone: the next one is the time shown and the day turns over there", () => {
const z = (timeZone) => cap({ timeZone });
assert.equal(new Date(nextReset(z("UTC"), ms("2026-11-18T18:00:00.000Z"))).toISOString(), "2026-11-19T00:00:00.000Z");
assert.equal(new Date(nextReset(z("UTC"), ms("2026-11-18T00:00:00.000Z"))).toISOString(), "2026-11-19T00:00:00.000Z", "at the reset, the next is a day on");
assert.equal(new Date(nextReset(z("UTC"), ms("2026-11-18T23:59:59.999Z"))).toISOString(), "2026-11-19T00:00:00.000Z");
assert.equal(new Date(nextReset(z("Asia/Kolkata"), ms("2026-11-18T18:00:00.000Z"))).toISOString(), "2026-11-18T18:30:00.000Z");
// A since after now: the reset after it.
assert.equal(new Date(nextReset(cap({ since: "2026-11-19T06:00:00.000Z" }), ms("2026-11-18T18:00:00.000Z"))).toISOString(), "2026-11-20T00:00:00.000Z");
});
test("a DST day: America/Chicago falls back on 2026-11-01 (25 hours) and springs forward on 2026-03-08 (23 hours)", () => {
const chicago = cap({ timeZone: "America/Chicago", since: "2026-01-01T00:00:00.000Z", limit: 50 });
// Fall back: the day runs from 05:00Z (00:00 CDT) to 06:00Z next day (00:00 CST).
assert.equal(new Date(nextReset(chicago, ms("2026-11-01T12:00:00.000Z"))).toISOString(), "2026-11-02T06:00:00.000Z");
assert.equal(new Date(nextReset(chicago, ms("2026-11-01T05:30:00.000Z"))).toISOString(), "2026-11-02T06:00:00.000Z", "inside the repeated hour's day");
const fall = [
{ account: "triage", ...line({ at: "2026-11-01T04:59:59.999Z", turn: "owner-000000000001", input: 30, output: 0, cacheRead: 0, cacheWrite: 0 }) },
{ account: "triage", ...line({ at: "2026-11-01T05:00:00.000Z", turn: "owner-000000000002", input: 30, output: 0, cacheRead: 0, cacheWrite: 0 }) },
{ account: "triage", ...line({ at: "2026-11-02T05:30:00.000Z", turn: "owner-000000000003", input: 30, output: 0, cacheRead: 0, cacheWrite: 0 }) },
];
const lateFall = capState({ cap: chicago, records: fall, now: ms("2026-11-02T05:59:59.999Z") });
assert.deepEqual([lateFall.allow, lateFall.usageToday.count, lateFall.resetsAt], [false, 60, "2026-11-02T06:00:00.000Z"], "the 25th hour still counts the day");
const nextDay = capState({ cap: chicago, records: fall, now: ms("2026-11-02T06:00:00.000Z") });
assert.deepEqual([nextDay.allow, nextDay.usageToday.count, nextDay.resetsAt], [true, 0, "2026-11-03T06:00:00.000Z"]);
// Spring forward: the day runs from 06:00Z (00:00 CST) to 05:00Z next day (00:00 CDT).
assert.equal(new Date(nextReset(chicago, ms("2026-03-08T12:00:00.000Z"))).toISOString(), "2026-03-09T05:00:00.000Z");
const spring = [{ account: "triage", ...line({ at: "2026-03-08T06:00:00.000Z", input: 60, output: 0, cacheRead: 0, cacheWrite: 0 }) }];
assert.equal(capState({ cap: chicago, records: spring, now: ms("2026-03-09T04:59:59.999Z") }).allow, false);
assert.equal(capState({ cap: chicago, records: spring, now: ms("2026-03-09T05:00:00.000Z") }).allow, true);
});
test("the turn delta keeps the bus's rules: new entries summed, a rewritten or missing baseline unknown, no new usage unknown", () => {
const e = (input) => ({ input, output: 1, cacheWrite: 0, cacheRead: 0 });
const begin = snapshot({ status: "known", entries: { a: e(5) } });
assert.deepEqual(delta(begin, snapshot({ status: "known", entries: { a: e(5), b: e(7), c: e(1) } })), { status: "known", input: 8, output: 2, cacheWrite: 0, cacheRead: 0 });
assert.deepEqual(delta(begin, snapshot({ status: "known", entries: { a: e(5) } })), { status: "unknown", code: "no-new-usage" });
assert.deepEqual(delta(begin, snapshot({ status: "known", entries: { a: e(6), b: e(1) } })), { status: "unknown", code: "transcript-rewritten" });
assert.deepEqual(delta(begin, snapshot({ status: "known", entries: { b: e(1) } })), { status: "unknown", code: "transcript-rewritten" });
assert.deepEqual(delta(null, snapshot({ status: "known", entries: { b: e(1) } })), { status: "unknown", code: "baseline-unknown" });
assert.deepEqual(delta(snapshot({ status: "unknown", code: "transcript-size" }), snapshot({ status: "known", entries: {} })), { status: "unknown", code: "baseline-unknown" });
assert.deepEqual(delta(begin, snapshot({ status: "unknown", code: "transcript-parse" })), { status: "unknown", code: "transcript-parse" });
assert.deepEqual(snapshot({ status: "unknown", code: "anything" }), { status: "unknown", code: "source-unknown" });
assert.deepEqual(snapshot({ status: "known", entries: { a: { input: -1, output: 0, cacheWrite: 0, cacheRead: 0 } } }), { status: "unknown", code: "source-invalid" });
assert.deepEqual(snapshot({ status: "known", entries: { a: { ...e(1), extra: 0 } } }), { status: "unknown", code: "source-invalid" });
assert.deepEqual(snapshot(null), { status: "unknown", code: "source-invalid" });
const big = { status: "known", entries: { a: e(Number.MAX_SAFE_INTEGER), b: e(1) } };
assert.deepEqual(delta(snapshot({ status: "known", entries: {} }), snapshot(big)), { status: "unknown", code: "usage-overflow" });
});