mirror of
https://github.com/block/buzz.git
synced 2026-11-01 06:51:17 +00:00
A partial run like `just bump-acp-tools --target aarch64-apple-darwin`
rewrote the entire acp-tools.lock.json with only the selected targets,
silently dropping the other three targets' entries. Because ensure/
prepare treat a target with zero lock entries as success (stage
nothing, exit 0), a later desktop-release-build for a dropped target
would ship an empty resources/acp and silently fall back to unpinned
user installs — exactly the drift the bundling series exists to
prevent.
Make --target runs merge instead of replace: before resolving, read
the existing lock and carry over every entry whose target is not
selected, then write the union. The guard rails match the script's
fail-loudly ethos:
- A missing lock preserves nothing (there is nothing to drop) and the
run proceeds — first-time generation with --target still works.
- An unreadable, unparseable, or tools-array-less lock aborts the
partial run before any registry work, refusing to overwrite pins it
cannot see.
- Full runs (no --target, or all four targets) never read the lock,
so `just bump-acp-tools` can still regenerate a corrupt lock from
scratch.
Preserved entries are logged ("Preserved 6 existing lock entries for
unselected targets") so a partial bump's diff is explainable from its
output, and the usage text documents the merge behaviour.
Addresses the partial-run finding from the bundling-series code
review (review 2ed3d00d on b52a665a).
Verification (against the Block registry, temp lock files):
- --target aarch64-apple-darwin on a copy of the committed lock:
6 unselected entries preserved byte-identically; merged lock
byte-identical to the committed lock (registry pins unchanged);
8 entries across all 4 targets.
- --target with no existing lock: writes only the selected target's
2 entries, exit 0.
- --target with corrupt JSON / {"tools":"nope"}: exits 1 in <1s with
a refusing-to-overwrite message; lock file left untouched.
- pnpm exec biome check + node scripts/check-file-sizes.mjs: clean.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Signed-off-by: Matt Toohey <contact@matttoohey.com>
416 lines
12 KiB
JavaScript
Executable File
416 lines
12 KiB
JavaScript
Executable File
#!/usr/bin/env node
|
|
import { execFile } from "node:child_process";
|
|
import { mkdir, readFile, writeFile } from "node:fs/promises";
|
|
import path from "node:path";
|
|
import process from "node:process";
|
|
import { promisify } from "node:util";
|
|
|
|
const appRoot = path.resolve(import.meta.dirname, "..");
|
|
const defaultLockFile = path.join(appRoot, "acp-tools.lock.json");
|
|
|
|
const SUPPORTED_TARGETS = [
|
|
"aarch64-apple-darwin",
|
|
"x86_64-apple-darwin",
|
|
"aarch64-unknown-linux-gnu",
|
|
"x86_64-unknown-linux-gnu",
|
|
];
|
|
|
|
// The Codex ACP executable stays `codex-acp`, but bundled installs must come
|
|
// from the maintained Agent Client Protocol package rather than the stale
|
|
// Zed package.
|
|
const CODEX_ACP_PACKAGE = "@agentclientprotocol/codex-acp";
|
|
|
|
const TOOL_SPECS = [
|
|
{
|
|
id: "claude-acp",
|
|
binary: "claude-agent-acp",
|
|
package: "@agentclientprotocol/claude-agent-acp",
|
|
dependencyPackage: "@anthropic-ai/claude-agent-sdk",
|
|
nativePackageKey: "claudeAgentSdk",
|
|
includeClaudeCodeVersion: true,
|
|
},
|
|
{
|
|
id: "codex-acp",
|
|
binary: "codex-acp",
|
|
package: CODEX_ACP_PACKAGE,
|
|
dependencyPackage: "@openai/codex",
|
|
nativePackageKey: "openaiCodex",
|
|
},
|
|
];
|
|
|
|
const NPM_TARGET_CONFIG = {
|
|
"aarch64-apple-darwin": {
|
|
npmOs: "darwin",
|
|
npmCpu: "arm64",
|
|
nativePackages: {
|
|
claudeAgentSdk: "@anthropic-ai/claude-agent-sdk-darwin-arm64",
|
|
openaiCodex: "@openai/codex-darwin-arm64",
|
|
},
|
|
nativeExecutables: {
|
|
claudeAgentSdk: "claude",
|
|
openaiCodex: "vendor/aarch64-apple-darwin/bin/codex",
|
|
},
|
|
},
|
|
"x86_64-apple-darwin": {
|
|
npmOs: "darwin",
|
|
npmCpu: "x64",
|
|
nativePackages: {
|
|
claudeAgentSdk: "@anthropic-ai/claude-agent-sdk-darwin-x64",
|
|
openaiCodex: "@openai/codex-darwin-x64",
|
|
},
|
|
nativeExecutables: {
|
|
claudeAgentSdk: "claude",
|
|
openaiCodex: "vendor/x86_64-apple-darwin/bin/codex",
|
|
},
|
|
},
|
|
"aarch64-unknown-linux-gnu": {
|
|
npmOs: "linux",
|
|
npmCpu: "arm64",
|
|
npmLibc: "glibc",
|
|
nativePackages: {
|
|
claudeAgentSdk: "@anthropic-ai/claude-agent-sdk-linux-arm64",
|
|
openaiCodex: "@openai/codex-linux-arm64",
|
|
},
|
|
nativeExecutables: {
|
|
claudeAgentSdk: "claude",
|
|
openaiCodex: "vendor/aarch64-unknown-linux-musl/bin/codex",
|
|
},
|
|
},
|
|
"x86_64-unknown-linux-gnu": {
|
|
npmOs: "linux",
|
|
npmCpu: "x64",
|
|
npmLibc: "glibc",
|
|
nativePackages: {
|
|
claudeAgentSdk: "@anthropic-ai/claude-agent-sdk-linux-x64",
|
|
openaiCodex: "@openai/codex-linux-x64",
|
|
},
|
|
nativeExecutables: {
|
|
claudeAgentSdk: "claude",
|
|
openaiCodex: "vendor/x86_64-unknown-linux-musl/bin/codex",
|
|
},
|
|
},
|
|
};
|
|
|
|
const npmViewCache = new Map();
|
|
const execFileAsync = promisify(execFile);
|
|
|
|
function usage() {
|
|
console.log(`Usage: desktop/scripts/update-acp-tools-lock.mjs [--target <triple>]... [--lock-file <path>]
|
|
|
|
Queries npm for the latest release of each supported ACP bridge tool and
|
|
writes acp-tools.lock.json. Fails loudly when a package or one of its
|
|
per-target native dependencies cannot be resolved — never silently pins an
|
|
older version.
|
|
|
|
A --target run regenerates only the selected targets; the existing lock's
|
|
entries for every other target are preserved verbatim, so a partial bump
|
|
never drops another target's pins.
|
|
|
|
Supported targets:
|
|
${SUPPORTED_TARGETS.join("\n ")}
|
|
|
|
Environment:
|
|
npm registry config used to resolve packages
|
|
ACP_TOOLS_LOCK_FILE lockfile path override
|
|
`);
|
|
}
|
|
|
|
function parseArgs(argv) {
|
|
const targets = [];
|
|
let lockFile = process.env.ACP_TOOLS_LOCK_FILE ?? defaultLockFile;
|
|
for (let i = 0; i < argv.length; i += 1) {
|
|
const arg = argv[i];
|
|
if (arg === "-h" || arg === "--help") {
|
|
usage();
|
|
process.exit(0);
|
|
}
|
|
if (arg === "--target") {
|
|
const value = argv[++i];
|
|
if (!value) throw new Error("--target requires a value");
|
|
targets.push(value);
|
|
continue;
|
|
}
|
|
if (arg === "--lock-file") {
|
|
const value = argv[++i];
|
|
if (!value) throw new Error("--lock-file requires a value");
|
|
lockFile = path.resolve(value);
|
|
continue;
|
|
}
|
|
throw new Error(`Unknown argument: ${arg}`);
|
|
}
|
|
|
|
const selectedTargets = targets.length ? targets : SUPPORTED_TARGETS;
|
|
for (const target of selectedTargets) {
|
|
if (!SUPPORTED_TARGETS.includes(target)) {
|
|
throw new Error(`Unsupported target '${target}'`);
|
|
}
|
|
}
|
|
return { targets: selectedTargets, lockFile };
|
|
}
|
|
|
|
async function npmView(spec, fields) {
|
|
const cacheKey = `${spec}\0${fields.join("\0")}`;
|
|
if (!npmViewCache.has(cacheKey)) {
|
|
npmViewCache.set(
|
|
cacheKey,
|
|
execFileAsync("npm", ["view", spec, ...fields, "--json"], {
|
|
maxBuffer: 10 * 1024 * 1024,
|
|
}).then(({ stdout }) => {
|
|
try {
|
|
return JSON.parse(stdout);
|
|
} catch (error) {
|
|
throw new Error(
|
|
`npm view ${spec} returned invalid JSON: ${
|
|
error instanceof Error ? error.message : String(error)
|
|
}`,
|
|
);
|
|
}
|
|
}),
|
|
);
|
|
}
|
|
return npmViewCache.get(cacheKey);
|
|
}
|
|
|
|
function requireString(value, label) {
|
|
if (typeof value !== "string" || value.trim() === "") {
|
|
throw new Error(`Missing ${label}`);
|
|
}
|
|
return value;
|
|
}
|
|
|
|
function packageDist(metadata, label) {
|
|
const dist = metadata?.dist;
|
|
return {
|
|
tarball: requireString(dist?.tarball, `${label} dist.tarball`),
|
|
integrity: requireString(dist?.integrity, `${label} dist.integrity`),
|
|
};
|
|
}
|
|
|
|
function compareSemver(left, right) {
|
|
const leftCore = left.split("-", 1)[0].split(".").map(Number);
|
|
const rightCore = right.split("-", 1)[0].split(".").map(Number);
|
|
for (let i = 0; i < 3; i += 1) {
|
|
if ((leftCore[i] ?? 0) !== (rightCore[i] ?? 0)) {
|
|
return (leftCore[i] ?? 0) - (rightCore[i] ?? 0);
|
|
}
|
|
}
|
|
// A release outranks any prerelease of the same core version.
|
|
return (left.includes("-") ? 0 : 1) - (right.includes("-") ? 0 : 1);
|
|
}
|
|
|
|
// npm view returns a single object when a spec matches one version, but an
|
|
// array of per-version objects when a range matches several. Pick the highest
|
|
// matching version so a ranged dependency still pins the newest release.
|
|
function pickLatestMatch(metadata, label) {
|
|
if (!Array.isArray(metadata)) return metadata;
|
|
if (metadata.length === 0) {
|
|
throw new Error(`No versions match ${label}`);
|
|
}
|
|
return metadata.reduce((best, candidate) =>
|
|
compareSemver(
|
|
requireString(candidate?.version, `${label} version`),
|
|
requireString(best?.version, `${label} version`),
|
|
) > 0
|
|
? candidate
|
|
: best,
|
|
);
|
|
}
|
|
|
|
function parseNpmAliasSpec(spec, fallbackPackage) {
|
|
if (!spec.startsWith("npm:")) {
|
|
return { packageName: fallbackPackage, version: spec };
|
|
}
|
|
const aliased = spec.slice("npm:".length);
|
|
const versionSeparator = aliased.lastIndexOf("@");
|
|
if (versionSeparator <= 0) {
|
|
throw new Error(`Unsupported npm alias spec: ${spec}`);
|
|
}
|
|
return {
|
|
packageName: aliased.slice(0, versionSeparator),
|
|
version: aliased.slice(versionSeparator + 1),
|
|
};
|
|
}
|
|
|
|
async function lockToolForTarget(tool, target) {
|
|
const npmTarget = NPM_TARGET_CONFIG[target];
|
|
if (!npmTarget) {
|
|
throw new Error(`No npm target mapping for ${target}`);
|
|
}
|
|
|
|
const packageName = tool.package;
|
|
const packageMetadata = await npmView(`${packageName}@latest`, [
|
|
"name",
|
|
"version",
|
|
"dist",
|
|
"dependencies",
|
|
"engines",
|
|
"bin",
|
|
]);
|
|
|
|
if (packageMetadata.name !== packageName) {
|
|
throw new Error(
|
|
`npm package ${packageName} resolved to ${packageMetadata.name}`,
|
|
);
|
|
}
|
|
|
|
const version = requireString(
|
|
packageMetadata.version,
|
|
`${packageName} version`,
|
|
);
|
|
const packageInfo = packageDist(packageMetadata, `${packageName}@${version}`);
|
|
const entry = {
|
|
id: tool.id,
|
|
binary: tool.binary,
|
|
source: "npm",
|
|
package: packageName,
|
|
version,
|
|
integrity: packageInfo.integrity,
|
|
tarball: packageInfo.tarball,
|
|
target,
|
|
npmOs: npmTarget.npmOs,
|
|
npmCpu: npmTarget.npmCpu,
|
|
...(npmTarget.npmLibc ? { npmLibc: npmTarget.npmLibc } : {}),
|
|
nodeEngine: packageMetadata.engines?.node ?? ">=22",
|
|
};
|
|
|
|
const dependencyRange = requireString(
|
|
packageMetadata.dependencies?.[tool.dependencyPackage],
|
|
`${packageName} dependency ${tool.dependencyPackage}`,
|
|
);
|
|
const dependencyMetadata = pickLatestMatch(
|
|
await npmView(`${tool.dependencyPackage}@${dependencyRange}`, [
|
|
"name",
|
|
"version",
|
|
"dist",
|
|
"optionalDependencies",
|
|
"claudeCodeVersion",
|
|
]),
|
|
`${tool.dependencyPackage}@${dependencyRange}`,
|
|
);
|
|
const dependencyVersion = requireString(
|
|
dependencyMetadata.version,
|
|
`${tool.dependencyPackage}@${dependencyRange} version`,
|
|
);
|
|
const dependencyInfo = packageDist(
|
|
dependencyMetadata,
|
|
`${tool.dependencyPackage}@${dependencyVersion}`,
|
|
);
|
|
entry.dependencyPackage = tool.dependencyPackage;
|
|
entry.dependencyVersion = dependencyVersion;
|
|
entry.dependencyIntegrity = dependencyInfo.integrity;
|
|
entry.dependencyTarball = dependencyInfo.tarball;
|
|
if (tool.includeClaudeCodeVersion) {
|
|
entry.claudeCodeVersion = dependencyMetadata.claudeCodeVersion ?? null;
|
|
}
|
|
|
|
const nativePackage = requireString(
|
|
npmTarget.nativePackages?.[tool.nativePackageKey],
|
|
`${target} native package for ${tool.nativePackageKey}`,
|
|
);
|
|
const nativeExecutable = requireString(
|
|
npmTarget.nativeExecutables?.[tool.nativePackageKey],
|
|
`${target} native executable for ${tool.nativePackageKey}`,
|
|
);
|
|
const nativeSpec = requireString(
|
|
dependencyMetadata.optionalDependencies?.[nativePackage],
|
|
`${tool.dependencyPackage}@${dependencyVersion} optional dependency ${nativePackage}`,
|
|
);
|
|
const nativeAlias = parseNpmAliasSpec(nativeSpec, nativePackage);
|
|
const nativeMetadata = await npmView(
|
|
`${nativeAlias.packageName}@${nativeAlias.version}`,
|
|
["name", "version", "dist"],
|
|
);
|
|
const nativeVersion = requireString(
|
|
nativeMetadata.version,
|
|
`${nativeAlias.packageName}@${nativeAlias.version} version`,
|
|
);
|
|
if (nativeVersion !== nativeAlias.version) {
|
|
throw new Error(
|
|
`${nativeAlias.packageName}@${nativeAlias.version} resolved to ${nativeVersion}`,
|
|
);
|
|
}
|
|
const nativeInfo = packageDist(
|
|
nativeMetadata,
|
|
`${nativeAlias.packageName}@${nativeVersion}`,
|
|
);
|
|
|
|
return {
|
|
...entry,
|
|
nativePackage,
|
|
nativePackageName: nativeMetadata.name ?? nativePackage,
|
|
nativeVersion,
|
|
nativeIntegrity: nativeInfo.integrity,
|
|
nativeTarball: nativeInfo.tarball,
|
|
nativeExecutable,
|
|
};
|
|
}
|
|
|
|
// Entries preserved from the existing lock when --target selects a subset.
|
|
// A missing lock preserves nothing (there is nothing to drop); an unreadable
|
|
// or malformed one aborts the run rather than clobbering pins we cannot see.
|
|
async function preservedLockEntries(lockFile, selectedTargets) {
|
|
let raw;
|
|
try {
|
|
raw = await readFile(lockFile, "utf8");
|
|
} catch (error) {
|
|
if (error?.code === "ENOENT") return [];
|
|
throw new Error(
|
|
`Cannot read existing lock ${lockFile} to preserve unselected targets: ${
|
|
error instanceof Error ? error.message : String(error)
|
|
}`,
|
|
);
|
|
}
|
|
let parsed;
|
|
try {
|
|
parsed = JSON.parse(raw);
|
|
} catch (error) {
|
|
throw new Error(
|
|
`Existing lock ${lockFile} is not valid JSON — refusing to overwrite it with a partial --target run: ${
|
|
error instanceof Error ? error.message : String(error)
|
|
}`,
|
|
);
|
|
}
|
|
if (!Array.isArray(parsed?.tools)) {
|
|
throw new Error(
|
|
`Existing lock ${lockFile} has no tools array — refusing to overwrite it with a partial --target run`,
|
|
);
|
|
}
|
|
return parsed.tools.filter((entry) => !selectedTargets.has(entry?.target));
|
|
}
|
|
|
|
async function main() {
|
|
const { targets, lockFile } = parseArgs(process.argv.slice(2));
|
|
const selectedTargets = new Set(targets);
|
|
const fullRun = SUPPORTED_TARGETS.every((target) =>
|
|
selectedTargets.has(target),
|
|
);
|
|
const preserved = fullRun
|
|
? []
|
|
: await preservedLockEntries(lockFile, selectedTargets);
|
|
const tools = [];
|
|
for (const tool of TOOL_SPECS) {
|
|
for (const target of targets) {
|
|
tools.push(await lockToolForTarget(tool, target));
|
|
}
|
|
}
|
|
if (preserved.length) {
|
|
console.log(
|
|
`Preserved ${preserved.length} existing lock entr${
|
|
preserved.length === 1 ? "y" : "ies"
|
|
} for unselected targets`,
|
|
);
|
|
}
|
|
tools.push(...preserved);
|
|
tools.sort((left, right) =>
|
|
`${left.id}:${left.target}`.localeCompare(`${right.id}:${right.target}`),
|
|
);
|
|
await mkdir(path.dirname(lockFile), { recursive: true });
|
|
await writeFile(lockFile, `${JSON.stringify({ tools }, null, 2)}\n`);
|
|
console.log(`Updated ${path.relative(process.cwd(), lockFile)}`);
|
|
}
|
|
|
|
main().catch((error) => {
|
|
console.error(error instanceof Error ? error.message : String(error));
|
|
process.exit(1);
|
|
});
|