Compare commits

...
Author SHA1 Message Date
Edward Bowie 27d5d6d206 fix(scripts): read npm pack --json in both npm 10 and npm 12 shapes (#2953) (#2975)
Under npm 12, `npm pack --json` prints an object keyed by package name, so six scripts and tests that read `[0]` failed, including the release pack and the substance gate. A shared reader, `scripts/npm-pack-json.mjs`, accepts both npm 10/11's array and npm 12's object, and all six readers use it; npm 10 and 11 output reads as before. The substance gate binds one package's receipt, so it now refuses pack output that lists more than one package, naming --package-root and any npm workspaces setting, instead of certifying the first entry only. For #2953.
2026-11-11 19:19:48 -08:00
Mike Schwarz aa71304a7d fix(tui): show a seat the daemon reads as unknown as unknown, not idle (#3012)
When the daemon couldn't tell what a running seat was doing, rig ps said unknown, but the TUI's list, explorer and agent-detail status rows said idle unless the seat was a community harness, so a seat thinking quietly could look free to take more work. Those rows now show unknown when the daemon serves an explicit unknown. The daemon's idle and working words keep their mapping, and screen motion still shows active. When no activityState is served, the existing screen fallback remains; this change covers an explicit unknown display. The topology graph view is unchanged.
2026-11-11 19:11:45 -08:00
Coder8124 492170b1b5 fix(daemon): give an unreadable Claude statusline cache its own reason (#2880)
`rig provider status` gave a Claude statusline cache that couldn't be parsed the same unknown reason as a valid cache with no rate-limit windows, so a usage check couldn't tell a broken cache from one with nothing reported yet. An unreadable cache now reports `claude_statusline_cache_unreadable`, and a readable cache with no windows keeps `claude_statusline_cache_had_no_windows`; both stay unknown rows with no percentage. Discovery also keeps a seat whose only cache file is malformed, naming it from the file name, so that seat reads unreadable instead of no cache yet. For #2875.
2026-11-11 18:51:26 -08:00
17 changed files with 268 additions and 36 deletions

No files matched your search

+3 -1
View File
@@ -13,7 +13,9 @@ provider usage stop updating, and Claude resume-token capture at adoption or
handover loses its current session evidence. An earlier sidecar can remain and
contain an older session ID; without one, context and capture report
`missing_sidecar`, and provider usage reports `no_statusline_cache_yet` unless an
earlier cache remains.
earlier cache remains. A cache that exists but cannot be read reports
`claude_statusline_cache_unreadable`; a readable cache that carried no rate
limits reports `claude_statusline_cache_had_no_windows`.
## Feed both commands the same input
@@ -61,15 +61,16 @@ export interface ClaudeUsageReaderDeps {
/**
* Read each Claude seat's provider_usage cache → provider_statusline rows via
* claudeStatuslineSignals. Explicit unknown rows for absent cache (no_statusline_cache_yet) and
* cache-present-but-no/-malformed windows (empty_reading).
* Never throws — a malformed cache is treated as present-with-no-windows, not a crash.
* claudeStatuslineSignals. Explicit unknown rows for absent cache (no_statusline_cache_yet),
* an unreadable cache (unreadable_cache), and a valid cache with no windows (empty_reading).
* Never throws — a malformed cache becomes an unknown row, not a crash.
*/
export function collectClaudeStatuslineSignals(deps: ClaudeUsageReaderDeps): ProviderSignal[] {
const now = deps.now();
const out: ProviderSignal[] = [];
for (const seat of deps.listClaudeSeats()) {
let cachePresent = false;
let cacheUnreadable = false;
let reading: ClaudeStatuslineReading | undefined;
let staleAfter: string | undefined;
let capturedAsOf: string | undefined;
@@ -84,7 +85,8 @@ export function collectClaudeStatuslineSignals(deps: ClaudeUsageReaderDeps): Pro
staleAfter = parsed.staleAfter;
capturedAsOf = typeof parsed.asOf === "string" ? parsed.asOf : undefined;
} catch {
// Malformed cache → present-with-no-windows (empty_reading unknown), never a throw.
// Malformed cache → present-but-unreadable (its own unknown), never a throw.
cacheUnreadable = true;
reading = undefined;
}
}
@@ -92,6 +94,7 @@ export function collectClaudeStatuslineSignals(deps: ClaudeUsageReaderDeps): Pro
...claudeStatuslineSignals({
seatSession: seat.seatSession,
cachePresent,
cacheUnreadable,
reading,
// Signal asOf = when the reading was captured (the cache's asOf) when present+valid; else now.
asOf: cachePresent && capturedAsOf ? capturedAsOf : now,
@@ -109,6 +112,7 @@ export function collectClaudeSignalsFromProviderUsageDirectory(
legacyDirectory?: string,
): ProviderSignal[] {
const seats = new Map<string, ClaudeSeatRef>();
const unreadableFiles = new Set<string>();
for (const candidateDirectory of [directory, legacyDirectory]) {
if (!candidateDirectory) continue;
try {
@@ -119,10 +123,16 @@ export function collectClaudeSignalsFromProviderUsageDirectory(
if (typeof parsed.seatSession === "string") {
seats.set(parsed.seatSession, { seatSession: parsed.seatSession });
}
} catch { /* malformed cache cannot create a usable cache signal */ }
} catch {
// A cache file that exists but cannot be read or parsed still names its seat in the
// filename (telemetrySidecarFilename sanitizes the same seat name). Keep it in the
// seat list so the reader reports an unreadable cache instead of the file vanishing.
unreadableFiles.add(file.slice(0, -".json".length));
}
}
} catch { /* absent cache directory */ }
}
for (const seatSession of unreadableFiles) seats.set(seatSession, { seatSession });
const readFrom = (candidateDirectory: string, seatSession: string): string | null => {
try {
@@ -131,6 +131,8 @@ export interface ClaudeSignalInput {
seatSession: string;
/** false = the statusline cache has not been written yet (before the first API response). */
cachePresent: boolean;
/** True when a cache file exists but cannot be read or parsed. Distinct from an empty reading. */
cacheUnreadable?: boolean;
/** Present only when the cache exists and carried a rate_limits object. */
reading?: ClaudeStatuslineReading;
asOf: string;
@@ -140,6 +142,7 @@ export interface ClaudeSignalInput {
export const CLAUDE_UNKNOWN_REASON = {
no_statusline_cache_yet: "claude_no_statusline_cache_yet",
empty_reading: "claude_statusline_cache_had_no_windows",
unreadable_cache: "claude_statusline_cache_unreadable",
} as const;
function claudeUnknownSignal(
@@ -165,17 +168,22 @@ function claudeUnknownSignal(
/**
* Normalize a Claude statusline `rate_limits` reading into `signals[]` rows.
* - seat before first response (no cache) → explicit unknown row.
* - a cache that exists but cannot be read/parsed → its own unknown reason (broken, not empty).
* - seat with subscription windows → one `provider_statusline` row per window (five_hour, and
* seven_day normalized to "weekly"); a genuine 0 survives as 0.
* - subscription with cache but no windows → explicit unknown row (never fabricated zeros).
*/
export function claudeStatuslineSignals(input: ClaudeSignalInput): ProviderSignal[] {
const { seatSession, cachePresent, reading, asOf, staleAfter } = input;
const { seatSession, cachePresent, cacheUnreadable, reading, asOf, staleAfter } = input;
if (!cachePresent) {
return [claudeUnknownSignal(seatSession, asOf, CLAUDE_UNKNOWN_REASON.no_statusline_cache_yet, staleAfter)];
}
if (cacheUnreadable) {
return [claudeUnknownSignal(seatSession, asOf, CLAUDE_UNKNOWN_REASON.unreadable_cache, staleAfter)];
}
const windows: Array<["five_hour" | "weekly", ClaudeStatuslineWindow | undefined]> = [
["five_hour", reading?.five_hour],
["weekly", reading?.seven_day],
@@ -112,6 +112,40 @@ describe("Slice-04 C3 — seat-keyed Claude provider_usage discovery (production
}
});
it("a live seat whose only cache is malformed reports unreadable_cache through real getReadModel", async () => {
const root = fs.mkdtempSync(nodePath.join(os.tmpdir(), "provider-c3-unreadable-"));
try {
const usageDir = nodePath.join(root, "provider-usage");
fs.mkdirSync(usageDir, { recursive: true });
const seatSession = "dev-impl@test-rig";
fs.writeFileSync(nodePath.join(usageDir, `${seatSession}.json`), "{ not json");
const db = createFullTestDb();
seedClaudeSeat(db, seatSession);
const svc = new ProviderServiceImpl({
db,
listRigs: () => [{ id: "rig-1" }],
env: emptyCodexHomeEnv(),
now: () => ASOF,
collectClaudeSignals: () => collectClaudeSignalsFromProviderUsageDirectory(usageDir, () => ASOF),
});
const model = await svc.getReadModel();
const claude = model.signals.filter((signal) => signal.provider === "claude");
expect(claude).toHaveLength(1);
expect(claude[0]).toMatchObject({
seatSession,
sourceClass: "unknown",
authority: "unknown",
unknownReason: "claude_statusline_cache_unreadable",
automationUse: "do_not_automate",
});
expect(claude[0]!.usedPercent).toBeUndefined();
} finally {
fs.rmSync(root, { recursive: true, force: true });
}
});
it("an exited latest Claude session plus matching stale cache emits zero Claude signals", async () => {
const root = fs.mkdtempSync(nodePath.join(os.tmpdir(), "provider-c3-exited-"));
try {
@@ -76,12 +76,20 @@ describe("collectClaudeStatuslineSignals — reader → provider_statusline / ex
expect(sigs[0]!.unknownReason).toBe(CLAUDE_UNKNOWN_REASON.empty_reading);
});
it("malformed cache JSON → unknown(empty_reading), never throws", () => {
it("malformed cache JSON → unknown(unreadable_cache), never throws", () => {
const sigs = collectClaudeStatuslineSignals(readerDeps({
listClaudeSeats: () => [{ seatSession: "dev-impl@rig" }],
readCacheRaw: () => "{ not json",
}));
expect(sigs[0]!.sourceClass).toBe("unknown");
expect(sigs[0]!.unknownReason).toBe(CLAUDE_UNKNOWN_REASON.unreadable_cache);
});
it("a valid cache with no windows keeps empty_reading (distinct from an unreadable cache)", () => {
const sigs = collectClaudeStatuslineSignals(readerDeps({
listClaudeSeats: () => [{ seatSession: "dev-impl@rig" }],
readCacheRaw: () => JSON.stringify({ seatSession: "dev-impl@rig", asOf: CACHE_ASOF }),
}));
expect(sigs[0]!.unknownReason).toBe(CLAUDE_UNKNOWN_REASON.empty_reading);
});
});
@@ -111,14 +119,33 @@ describe("0.5.8 provider-usage compatibility bridge", () => {
const malformedCanonical = collectClaudeSignalsFromProviderUsageDirectory(canonical, () => ASOF, legacy);
expect(malformedCanonical.find((signal) => signal.seatSession === "legacy@rig")?.usedPercent).toBeUndefined();
expect(malformedCanonical.find((signal) => signal.seatSession === "legacy@rig")?.unknownReason)
.toBe(CLAUDE_UNKNOWN_REASON.empty_reading);
.toBe(CLAUDE_UNKNOWN_REASON.unreadable_cache);
fs.rmSync(path.join(canonical, "[email protected]"));
fs.mkdirSync(path.join(canonical, "[email protected]"));
const wrongTypeCanonical = collectClaudeSignalsFromProviderUsageDirectory(canonical, () => ASOF, legacy);
expect(wrongTypeCanonical.find((signal) => signal.seatSession === "legacy@rig")?.usedPercent).toBeUndefined();
expect(wrongTypeCanonical.find((signal) => signal.seatSession === "legacy@rig")?.unknownReason)
.toBe(CLAUDE_UNKNOWN_REASON.empty_reading);
.toBe(CLAUDE_UNKNOWN_REASON.unreadable_cache);
fs.rmSync(home, { recursive: true, force: true });
});
});
describe("collectClaudeSignalsFromProviderUsageDirectory — a malformed-only cache stays visible", () => {
it("reports unreadable_cache for a seat known only from a malformed file's name", () => {
const home = fs.mkdtempSync(path.join(os.tmpdir(), "provider-unreadable-"));
const directory = path.join(home, "state", "provider-usage");
fs.mkdirSync(directory, { recursive: true });
fs.writeFileSync(path.join(directory, "[email protected]"), "{ not json");
try {
const signals = collectClaudeSignalsFromProviderUsageDirectory(directory, () => ASOF);
expect(signals).toHaveLength(1);
expect(signals[0]!.seatSession).toBe("broken@rig");
expect(signals[0]!.sourceClass).toBe("unknown");
expect(signals[0]!.unknownReason).toBe(CLAUDE_UNKNOWN_REASON.unreadable_cache);
expect(signals[0]!.usedPercent).toBeUndefined();
} finally {
fs.rmSync(home, { recursive: true, force: true });
}
});
});
@@ -1,5 +1,5 @@
import { describe, it, expect } from "vitest";
import { claudeStatuslineSignals } from "../src/domain/provider/provider-signals.js";
import { CLAUDE_UNKNOWN_REASON, claudeStatuslineSignals } from "../src/domain/provider/provider-signals.js";
// Slice-04 (OPR.0.5.0.4) — Claude statusline lane normalization (§2 Claude lane + the
// 2026-07-31 RESEARCH verdict). Proof item 6: the statusline sidecar's rate_limits object
@@ -68,5 +68,21 @@ describe("claudeStatuslineSignals — Claude lane honesty", () => {
expect(sigs[0].sourceClass).toBe("unknown");
expect(sigs[0].usedPercent).toBeUndefined();
expect(sigs[0].automationUse).toBe("do_not_automate");
expect(sigs[0].unknownReason).toBe(CLAUDE_UNKNOWN_REASON.empty_reading);
});
it("an unreadable cache gets its own reason, not the empty-reading one", () => {
const sigs = claudeStatuslineSignals({
seatSession: "dev-impl@rig",
cachePresent: true,
cacheUnreadable: true,
asOf: ASOF,
});
expect(sigs).toHaveLength(1);
expect(sigs[0].sourceClass).toBe("unknown");
expect(sigs[0].unknownReason).toBe(CLAUDE_UNKNOWN_REASON.unreadable_cache);
expect(sigs[0].unknownReason).not.toBe(CLAUDE_UNKNOWN_REASON.empty_reading);
expect(sigs[0].usedPercent).toBeUndefined();
expect(sigs[0].automationUse).toBe("do_not_automate");
});
});
+4 -2
View File
@@ -287,8 +287,10 @@ function toAgentRow(node: NodeInventoryRead): AgentRow {
: node.activityState?.display === "idle"
? "idle"
: (node.terminalActive === true || (node.terminalActive == null && node.agentActivity?.state === "running") ? "active"
// A community harness gives no idle signal: a quiet screen is unknown, not idle.
: node.communityHarness ? "unknown" : "idle"))
// The daemon's activity word decides when it's served (as in `rig ps`): it said unknown, so a quiet
// screen stays unknown. A community harness gives no idle signal either. Only an older daemon that
// serves no activity word keeps the screen fallback.
: node.communityHarness || node.activityState ? "unknown" : "idle"))
: (node.sessionStatus ?? "unknown"),
live: node.lifecycleState === "running",
canRun: node.lifecycleState !== "running"
+23 -3
View File
@@ -710,7 +710,7 @@ describe("snapshot hydration over the §4.A reads (Phase 2)", () => {
expect(output.lines.find((line) => /\bmismatch\s/.test(line))).not.toContain("run ▸");
expect(output.lines.find((line) => /\bmissing\s/.test(line))).not.toContain("run ▸");
});
it("shows a quiet community harness as unknown, never idle, and leaves built-in rows as they were", async () => {
it("shows a quiet seat the daemon reads as unknown as unknown, never idle, for a community harness and a built-in runtime alike", async () => {
const base = (FIXTURES["/api/rigs/01JRIG/nodes"] as Array<Record<string, unknown>>)[0]!;
const quiet = { startupStatus: "ready", sessionStatus: "running", terminalActive: false, agentActivity: { state: "unknown" },
activityState: { activity: "unknown", display: "unknown", needsInput: { count: 0, reason: null }, decidedBy: null } };
@@ -727,8 +727,28 @@ describe("snapshot hydration over the §4.A reads (Phase 2)", () => {
"dev.app-quiet": "unknown",
"dev.app-moving": "active",
"dev.app-prompt": "needs_input",
"dev.pi-quiet": "idle",
"dev.claude-quiet": "idle",
"dev.pi-quiet": "unknown",
"dev.claude-quiet": "unknown",
});
});
it("keeps the daemon's idle and working words, and the screen fallback only for a daemon that serves no activity word", async () => {
const base = (FIXTURES["/api/rigs/01JRIG/nodes"] as Array<Record<string, unknown>>)[0]!;
const running = { startupStatus: "ready", sessionStatus: "running", runtime: "claude-code", agentActivity: { state: "unknown" } };
const served = (display: string) => ({ activity: display === "idle" ? "idle-at-prompt" : display, display, needsInput: { count: 0, reason: null }, decidedBy: null });
const nodes = [
{ ...base, ...running, logicalId: "dev.served-idle", terminalActive: false, activityState: served("idle") },
{ ...base, ...running, logicalId: "dev.served-working", terminalActive: false, activityState: served("working") },
{ ...base, ...running, logicalId: "dev.unknown-moving", terminalActive: true, activityState: served("unknown") },
{ ...base, ...running, logicalId: "dev.legacy-quiet", terminalActive: false, activityState: undefined },
];
const snap = await hydrateSnapshot(fixtureClient({}, { "/api/rigs/01JRIG/nodes": nodes }));
const statuses = Object.fromEntries(myrig(snap).pods[0]!.agents.map((agent) => [agent.name, agent.status]));
expect(statuses).toEqual({
"dev.served-idle": "idle",
"dev.served-working": "active",
"dev.unknown-moving": "active",
"dev.legacy-quiet": "idle",
});
});
+2 -1
View File
@@ -4,6 +4,7 @@ import fs from "node:fs";
import { tmpdir } from "node:os";
import { join } from "node:path";
import { test } from "node:test";
import { packEntry } from "./npm-pack-json.mjs";
const script = fs.readFileSync(new URL("./build-package.sh", import.meta.url), "utf8");
const assetsBranch = script.match(/^if \[ -d "\$DAEMON_DIR\/assets" \]; then\n[\s\S]*?^fi$/m)?.[0];
@@ -129,7 +130,7 @@ test("offline npm pack carries staged asset bytes and executability, with npm's
assertStaged(f);
const staged = snapshot(f.staged);
fs.writeFileSync(join(f.cli, "package.json"), JSON.stringify({ name: "openrig-assets-fixture", version: "1.0.0", private: true, files: ["daemon"] }));
const packed = JSON.parse(execFileSync("bash", ["-c", 'umask 0022; exec npm pack --offline --ignore-scripts --json --pack-destination "$1"', "asset-pack", f.root], { cwd: f.cli, encoding: "utf8", timeout: 30_000, stdio: ["ignore", "pipe", "pipe"] }))[0];
const packed = packEntry(execFileSync("bash", ["-c", 'umask 0022; exec npm pack --offline --ignore-scripts --json --pack-destination "$1"', "asset-pack", f.root], { cwd: f.cli, encoding: "utf8", timeout: 30_000, stdio: ["ignore", "pipe", "pipe"] }));
const files = new Map(packed.files.map(file => [file.path, file]));
for (const [name, bytes] of Object.entries(contents)) {
const entry = `daemon/assets/${name}`;
+2 -2
View File
@@ -2,14 +2,14 @@ import { execSync } from "node:child_process";
import { existsSync, readFileSync } from "node:fs";
import { test } from "node:test";
import assert from "node:assert/strict";
import { packEntry } from "./npm-pack-json.mjs";
test("npm pack of @openrig/cli includes scripts/check-abi.mjs in tarball", () => {
const output = execSync("npm pack --dry-run --json 2>/dev/null", {
cwd: "packages/cli",
encoding: "utf-8",
});
const entries = JSON.parse(output);
const files = entries[0]?.files?.map((f) => f.path) ?? [];
const files = packEntry(output).files?.map((f) => f.path) ?? [];
assert.ok(
files.some((f) => f.includes("scripts/check-abi.mjs")),
+14 -4
View File
@@ -19,6 +19,7 @@ import {
scanInternalLeaks,
} from "./internal-leak-scanner.mjs";
import { LEAK_GUARD_RULES_ENV, leakGuardRulesPath } from "./leak-guard-rules.mjs";
import { packEntries } from "./npm-pack-json.mjs";
const HERE = dirname(fileURLToPath(import.meta.url));
const FIX = "Genericize the content, cite its public home, or re-home it to the internal pack root.";
@@ -155,13 +156,22 @@ function derivePackageArtifacts(packageRoot) {
if (packed.status !== 0) {
throw new Error(`npm artifact enumeration failed:\n${packed.stderr || packed.stdout || `exit ${packed.status}`}`);
}
let parsed;
let entries = [];
try {
parsed = JSON.parse(packed.stdout);
// One parse, in the shared reader: a JSON string (even one holding a serialized list) is not a shape npm prints.
entries = packEntries(packed.stdout);
} catch (error) {
throw new Error(`npm artifact enumeration did not return JSON: ${error.message}`);
if (error instanceof SyntaxError) throw new Error(`npm artifact enumeration did not return JSON: ${error.message}`);
// not a shape npm prints: reported below as no files array
}
const rawFiles = parsed?.[0]?.files;
// One package is packed here; scanning only the first of several would issue a receipt for part of the artifact.
if (entries.length > 1) {
throw new Error(
`npm artifact enumeration listed ${entries.length} packages where one was packed; `
+ "run the gate for one package (check --package-root and any npm workspaces setting)",
);
}
const rawFiles = entries[0]?.files;
if (!Array.isArray(rawFiles)) throw new Error("npm artifact enumeration returned no files array");
const files = rawFiles.map((entry) => entry?.path).filter((path) => typeof path === "string");
if (files.length !== rawFiles.length || files.length === 0) {
+42 -3
View File
@@ -5,6 +5,7 @@ import { execFileSync, spawnSync } from "node:child_process";
import {
existsSync,
mkdirSync,
chmodSync,
mkdtempSync,
readFileSync,
rmSync,
@@ -405,6 +406,44 @@ test("exact-line allowances reach content and derived scans and are recorded in
});
});
test("npm output that is a JSON string is refused, even when the string holds a serialized list", () => {
withFixture(({ root, repo, rules, review, receipt }) => {
write(join(repo, "public/guide.md"), "Generic product guidance.\n");
commitAll(repo, "string output fixture");
writeFileSync(review, JSON.stringify({ surfaces: [] }));
const bin = join(root, "bin");
const serialized = JSON.stringify([{ files: [{ path: "package.json" }, { path: "public/guide.md" }] }]);
write(join(bin, "npm"), `#!${process.execPath}\nprocess.stdout.write(${JSON.stringify(JSON.stringify(serialized))});\n`);
chmodSync(join(bin, "npm"), 0o755);
const result = runGate({ repo, rules, review, receipt, cutSha: gitHead(repo),
env: { ...process.env, PATH: `${bin}:${process.env.PATH}` } });
assert.notEqual(result.status, 0);
assert.match(result.stderr, /npm artifact enumeration returned no files array/);
});
});
test("npm output that lists more than one package is refused before any scan or receipt", () => {
const first = { name: "first", files: [{ path: "package.json" }, { path: "public/guide.md" }] };
const second = { name: "second", files: [{ path: "package.json" }, { path: "public/other.md" }] };
for (const printed of [[first, second], { first, second }]) {
withFixture(({ root, repo, rules, review, receipt }) => {
write(join(repo, "public/guide.md"), "Generic product guidance.\n");
commitAll(repo, "two package output fixture");
writeFileSync(review, JSON.stringify({ surfaces: [] }));
const bin = join(root, "bin");
write(join(bin, "npm"), `#!${process.execPath}\nprocess.stdout.write(${JSON.stringify(JSON.stringify(printed))});\n`);
chmodSync(join(bin, "npm"), 0o755);
const result = runGate({ repo, rules, review, receipt, cutSha: gitHead(repo),
env: { ...process.env, PATH: `${bin}:${process.env.PATH}` } });
assert.notEqual(result.status, 0);
assert.match(result.stderr, /npm artifact enumeration listed 2 packages where one was packed; run the gate for one package \(check --package-root and any npm workspaces setting\)/);
assert.equal(existsSync(receipt), false);
});
}
});
test("the release ceremony names the gate and its durable receipt", () => {
const pkg = JSON.parse(readFileSync("package.json", "utf8"));
assert.equal(pkg.scripts["gate:substance"], "node scripts/check-substance-gate.mjs");
@@ -420,7 +459,7 @@ function writeGateHarness(root, source, invocationPath) {
mkdirSync(root, { recursive: true });
const gate = join(root, "check-substance-gate.mjs");
writeFileSync(gate, source);
for (const module of ["internal-leak-scanner.mjs", "leak-guard-rules.mjs"]) {
for (const module of ["internal-leak-scanner.mjs", "leak-guard-rules.mjs", "npm-pack-json.mjs"]) {
writeFileSync(join(root, module), readFileSync(resolve("scripts", module)));
}
writeFileSync(join(root, "check-internal-leak-guard.mjs"), [
@@ -474,7 +513,7 @@ function withFixture(run) {
}
}
function runGate({ repo, rules, review, receipt, cutSha, gate = GATE }) {
function runGate({ repo, rules, review, receipt, cutSha, gate = GATE, env = process.env }) {
return spawnSync(process.execPath, [
gate,
"--repo", repo,
@@ -485,7 +524,7 @@ function runGate({ repo, rules, review, receipt, cutSha, gate = GATE }) {
"--receipt", receipt,
"--judge", "dev-qa@fixture",
"--cut-sha", cutSha,
], { encoding: "utf8" });
], { encoding: "utf8", env });
}
function write(path, content) {
+6 -5
View File
@@ -4,6 +4,7 @@ import { tmpdir } from "node:os";
import { delimiter, join } from "node:path";
import { test } from "node:test";
import assert from "node:assert/strict";
import { packEntry } from "./npm-pack-json.mjs";
test("the CLI build carries the unchanged repository LICENSE and README into npm pack", () => {
const root = mkdtempSync(join(tmpdir(), "cli-license-"));
@@ -26,14 +27,14 @@ test("the CLI build carries the unchanged repository LICENSE and README into npm
execFileSync("npm", ["run", "build"], { cwd: cli, env, stdio: "pipe" });
const source = readFileSync(join(root, "LICENSE"));
assert.deepEqual(readFileSync(join(cli, "LICENSE")), source, "build must stage the repository license verbatim");
const packed = JSON.parse(execFileSync("npm", ["pack", "--ignore-scripts", "--json"], { cwd: cli, env, encoding: "utf8", stdio: ["pipe", "pipe", "pipe"] }));
assert.ok(packed[0].files.some((file) => file.path === "LICENSE"), "npm archive must include LICENSE");
const bytes = execFileSync("tar", ["-xOf", join(cli, packed[0].filename), "package/LICENSE"]);
const packed = packEntry(execFileSync("npm", ["pack", "--ignore-scripts", "--json"], { cwd: cli, env, encoding: "utf8", stdio: ["pipe", "pipe", "pipe"] }));
assert.ok(packed.files.some((file) => file.path === "LICENSE"), "npm archive must include LICENSE");
const bytes = execFileSync("tar", ["-xOf", join(cli, packed.filename), "package/LICENSE"]);
assert.deepEqual(bytes, source, "packed license must equal the existing root bytes");
// npm shows the package-root README on the registry page; without it the page reads "No README data found".
const readme = readFileSync(join(root, "README.md"));
assert.ok(packed[0].files.some((file) => file.path === "README.md"), "npm archive must include README.md");
const readmeBytes = execFileSync("tar", ["-xOf", join(cli, packed[0].filename), "package/README.md"]);
assert.ok(packed.files.some((file) => file.path === "README.md"), "npm archive must include README.md");
const readmeBytes = execFileSync("tar", ["-xOf", join(cli, packed.filename), "package/README.md"]);
assert.deepEqual(readmeBytes, readme, "packed README must equal the existing root bytes");
} finally {
rmSync(root, { recursive: true, force: true });
+25
View File
@@ -0,0 +1,25 @@
// `npm pack --json` prints an array of entries up to npm 11 and, from npm 12, an object keyed by package name
// ("the --json output of `npm pack` and `npm publish` have changed",
// https://github.com/npm/cli/releases/tag/v12.0.0). Every reader of that output goes through here, so both shapes
// give the same entries.
/** The entries `npm pack --json` printed, in order, from its output text or its parsed value. */
export function packEntries(output) {
const parsed = typeof output === "string" ? JSON.parse(output) : output;
const entries = Array.isArray(parsed)
? parsed
: parsed !== null && typeof parsed === "object" ? Object.values(parsed) : null;
if (!entries || !entries.every((entry) => entry !== null && typeof entry === "object" && !Array.isArray(entry))) {
throw new Error("npm pack --json printed neither an array of entries nor an object of per-package entries");
}
return entries;
}
/** The one entry of a `npm pack --json` run that packed one package; any other count throws. */
export function packEntry(output) {
const entries = packEntries(output);
if (entries.length !== 1) {
throw new Error(`npm pack --json printed ${entries.length} entries where one package was packed`);
}
return entries[0];
}
+35
View File
@@ -0,0 +1,35 @@
import assert from "node:assert/strict";
import { test } from "node:test";
import { packEntries, packEntry } from "./npm-pack-json.mjs";
const entry = { id: "@openrig/[email protected]", name: "@openrig/cli", version: "1.2.3", filename: "openrig-cli-1.2.3.tgz",
files: [{ path: "LICENSE" }, { path: "package.json" }] };
test("npm 10 and 11: an array of entries", () => {
assert.deepEqual(packEntries(JSON.stringify([entry])), [entry]);
assert.deepEqual(packEntry(JSON.stringify([entry])), entry);
});
test("npm 12: an object of entries keyed by package name", () => {
assert.deepEqual(packEntries(JSON.stringify({ "@openrig/cli": entry })), [entry]);
assert.deepEqual(packEntry(JSON.stringify({ "@openrig/cli": entry })), entry);
});
test("both shapes keep every entry in order, and a parsed value reads like its text", () => {
const other = { ...entry, name: "@openrig/acp", filename: "openrig-acp-1.2.3.tgz" };
assert.deepEqual(packEntries([entry, other]), [entry, other]);
assert.deepEqual(packEntries({ "@openrig/cli": entry, "@openrig/acp": other }), [entry, other]);
});
test("packEntry refuses any count but one", () => {
assert.throws(() => packEntry("[]"), /0 entries/);
assert.throws(() => packEntry("{}"), /0 entries/);
assert.throws(() => packEntry(JSON.stringify([entry, entry])), /2 entries/);
});
test("output that is neither shape throws", () => {
for (const output of ["null", "\"text\"", "3", JSON.stringify(entry), JSON.stringify([[entry]]), JSON.stringify({ a: null })]) {
assert.throws(() => packEntries(output), /neither an array of entries nor an object of per-package entries/, output);
}
assert.throws(() => packEntries("not json"), SyntaxError);
});
+3 -2
View File
@@ -8,6 +8,7 @@ import { createHash } from 'node:crypto';
import { existsSync, mkdirSync, readFileSync, writeFileSync } from 'node:fs';
import { join, resolve } from 'node:path';
import { fileURLToPath } from 'node:url';
import { packEntry } from './npm-pack-json.mjs';
const LISTING = ['packages/acp/registry/agent.json', 'packages/acp/registry/icon.svg'];
const readJson = (root, rel) => JSON.parse(readFileSync(join(root, rel), 'utf8'));
@@ -35,8 +36,8 @@ export function packRelease(root, dest) {
mkdirSync(dest, { recursive: true });
// The CLI is packed as the release producer has packed it; the launcher isn't a workspace, so it's packed by path.
// --ignore-scripts skips pack's prepack and postpack, but npm 10 still runs a `prepare`; neither package has one.
const pack = target => JSON.parse(execFileSync('npm', ['pack', ...target, '--ignore-scripts', '--json', '--pack-destination', dest],
{ cwd: root, encoding: 'utf8' }))[0];
const pack = target => packEntry(execFileSync('npm', ['pack', ...target, '--ignore-scripts', '--json', '--pack-destination', dest],
{ cwd: root, encoding: 'utf8' }));
const artifacts = [pack(['--workspace', 'packages/cli']), pack(['./packages/acp'])].map(packed => {
const path = join(dest, packed.filename);
return { name: packed.name, version: packed.version, path, size: packed.size, sha256: sha256(path), integrity: packed.integrity };
+4 -3
View File
@@ -4,6 +4,7 @@ import os from "node:os";
import path from "node:path";
import { execFileSync, spawn, spawnSync } from "node:child_process";
import { fileURLToPath } from "node:url";
import { packEntry } from "./npm-pack-json.mjs";
const root = path.resolve(path.dirname(fileURLToPath(import.meta.url)), "..");
const cli = path.join(root, "packages", "cli");
@@ -47,8 +48,8 @@ async function assertDelayedSplits(entry, pkgDir) {
try {
execFileSync("npm", ["run", "build:package"], { cwd: root, stdio: "inherit" });
const packed = JSON.parse(execFileSync("npm", ["pack", "--ignore-scripts", "--json", "--pack-destination", temp], { cwd: cli, encoding: "utf8" }));
const tarball = path.join(temp, packed[0].filename);
const packed = packEntry(execFileSync("npm", ["pack", "--ignore-scripts", "--json", "--pack-destination", temp], { cwd: cli, encoding: "utf8" }));
const tarball = path.join(temp, packed.filename);
execFileSync("tar", ["-xzf", tarball, "-C", temp]);
const pkgDir = path.join(temp, "package");
@@ -68,7 +69,7 @@ try {
});
assert.equal(launched.status, 0, launched.stderr || `packed TUI exited ${launched.status}`);
await assertDelayedSplits(entry, pkgDir);
console.log(`packed TUI launch PASS: ${packed[0].filename}`);
console.log(`packed TUI launch PASS: ${packed.filename}`);
} finally {
fs.rmSync(temp, { recursive: true, force: true });
}