Files
PaperClipAI/scripts/__tests__/release-dry-run-notes.test.mjs
T
Nicky LeachandClaude Fable 5.2 999709b0a6 fix(docker): stop a stale-lockfile build early and keep beta and stable releases buildable (#21333)
## Thinking Path

> - Paperclip is the open source app people use to manage AI agents for
work
> - The application image now takes its Runner from the
`runner-artifacts` stages, which install with a frozen lockfile
> - A contributor cannot commit `pnpm-lock.yaml`. After a change to a
manifest of the Runner, the lockfile on `master` is behind until the
refresh merges
> - In that time a plain `docker build` fails late, inside a long step,
with a message that is easy to miss. And a beta or a stable release can
be cut from such a commit, because the release workflows refresh the
lockfile for their own build
> - This pull request adds an early check with a clear instruction to
the image build, and the same check to the beta and the stable release
> - The benefit is a failure in seconds that says what to run, and beta
and stable tags that always build from source

## Linked Issues or Issue Description

This is the third part of a chain. The first part is #21331. The second
part takes the Runner of the application image from the
`runner-artifacts` stage. Refs #21204 and #21306 (the Runner image and
its lockfile rule). No issue exists for this change.

**What happened?**

A tree with a lockfile behind the manifests of the Runner fails `docker
build` after the daemon compile (169 s in the test). The error is
`ERR_PNPM_OUTDATED_LOCKFILE` in the middle of the largest `RUN` of the
`Dockerfile`.

**Expected behavior**

The build fails within seconds of the check running. The message names
the files and the command to run. The application's dependency install
starts from the check, so it cannot start before the check passes.
Stages that do not depend on it (the Runner's toolchain download and
daemon compile, and the tool layer of `production`) can already be
running, and the failed check cancels them. A beta or a stable release
from such a commit does not start.

How often this happens: of 72 nightly tags since 2026-08-24, 9 are on a
commit whose lockfile is behind the manifests of the Runner (2026-09-01,
09-18 through 09-23, 09-28 and 10-26). Of 12 beta tags, none is. A beta
is the promotion of a nightly, so a beta can be cut from such a commit.

**Steps to reproduce**

1. Change a dependency range in
`packages/paperclip-runner/package.json`. Do not refresh
`pnpm-lock.yaml`.
2. Run `docker build .`.

**Paperclip version or commit**

`master` with the previous pull request of this chain.

**Deployment mode**

Not applicable. This is the image build and the release tooling.

## What Changed

- `Dockerfile`: a `runner-lockfile` stage copies only the manifests the
Runner build installs from, the lockfile and the patches. It runs the
frozen, filtered, offline lockfile check, with the arguments of
`runnerLockState`. `deps` starts from it. For a stale lockfile it prints
the files and `pnpm install --resolution-only --ignore-scripts
--no-frozen-lockfile`. For any other failure it prints the output of
pnpm and says so.
- `scripts/check-release-runner-lockfile.mjs`: exports the Runner inputs
of a commit with `git archive` and gives them to `runnerLockState`
(`scripts/runner-image-publish.mjs`). Exit 0 for current, 1 for behind,
2 for an error.
- `scripts/release.sh` and `scripts/release-lib.sh`:
`require_runner_lockfile_current` runs for the `beta` and the `stable`
channel, after `--print-version` exits and before any build. It runs in
a dry run too. It does not run for `canary` or `nightly`.
- Both beta paths end in the `publish_beta` job: the promotion of a
nightly, and a `candidate/beta-*` branch. That job checks out the commit
that `select_beta` chose and runs `release.sh beta` there. So the check
reads the committed files of the commit the beta is built from. A beta
is refused before its soak starts. The stable that promotes it is
checked again.
- Tests: `server/src/__tests__/runner-lockfile-guards.test.ts` (18
tests). Three of them pin the checkout of `publish_beta`,
`preview_stable` and `publish_stable` to the selected commit. Two tests
plus one stub in `scripts/__tests__/release-dry-run-notes.test.mjs`
cover the beta, the candidate beta and the stable path.
- Docs: `doc/DOCKER.md`, `doc/RELEASING.md`,
`doc/runner-image-contract.md`.

## Verification

Builds: `linux/arm64`, local. They ran before the rebase onto `master`,
except the last one. `master` changed neither the `Dockerfile` nor a
manifest in between.

- A tree with `ajv` changed from `^8.20.0` to `^8.19.0` in the manifest
of the Runner: `docker buildx build --target build` fails after 6 s at
`runner-lockfile`, with the message.
- The same tree after `pnpm install --resolution-only --ignore-scripts
--no-frozen-lockfile` on the host, which is what the image workflows
run: `--target build` builds. The check passes, the Runner stages
install, and the vendor step logs `reusing the current Runner build` in
both of its runs.
- After the rebase: `build` and `runner-provider-pack` built from this
branch without a build commit. The check passed.
- The release check with the real pnpm: `behind` for the first tree,
`current` for the second, exit 0 for this checkout.
- `vitest run server/src/__tests__/runner-lockfile-guards.test.ts` with
the other changed server tests, on macOS and in `node:24.22.3-bookworm`
(249 pass in 11 files on Linux). The test file typechecks.
- `node --test scripts/__tests__/release-dry-run-notes.test.mjs`: 14
pass. `scripts/release-lib.test.mjs`: 15 pass on Linux; on macOS 4 of
its tests fail on `master` too. `release-verify-workflow.test.mjs` and
`acpx-patch-packaging.test.mjs`, which read the release scripts: pass.
- `docker buildx build --check`: no warning.
- The Docker builds above ran before the second part of the chain got
its expectation step and before the beta guard. The expectation step was
built on the second part alone. This branch as it is now was not built
again; its tests ran.
- Not run: the release workflow, any `linux/amd64` build, the full test
suite. Only CI and a release dry run can prove the release path.

## Risks

- **A beta can be refused.** When the newest nightly is on a commit
whose lockfile is behind, `release.sh beta` stops, in the dry run and in
the real run. The operator must promote a nightly whose commit includes
the lockfile refresh, or cut a candidate branch that includes it. `node
scripts/check-release-runner-lockfile.mjs --commit <ref>` gives the
answer before the dispatch.
- **A stable can be refused** only when its beta was cut before this
change, or with release tooling that does not have the check. Promotions
run the release tooling of the source commit.
- The check runs in `release.sh`. In the beta workflow it runs in
`publish_beta`, after the approval of the `npm-beta` environment and
after the candidate verification. In the stable workflow it runs after
verification, not in the `preflight_stable` job. The selection jobs have
no pnpm.
- `release.sh stable` now needs `git`, `tar` and `pnpm` on `PATH` before
its first build step. The workflow has them.
- `scripts/__tests__/release-dry-run-notes.test.mjs` is not in a CI
command today. The Vitest file carries the enforced tests.
- The image build has one more small stage. It reads only manifests, so
a source change does not run it again.
- The digest of the Runner image changes again, because its identity
covers the whole `Dockerfile`.

> For core feature work, check [`ROADMAP.md`](ROADMAP.md) first and
discuss it in `#dev` before opening the PR. Feature PRs that overlap
with planned core work may need to be redirected — check the roadmap
first. See `CONTRIBUTING.md`.

## Model Used

- Claude Fable 5.2 (`claude-fable-5-2`), from Anthropic, through Claude
Code. The model used tools: it edited files, ran the tests and ran the
Docker builds that this description reports.

## Checklist

- [x] I have included a thinking path that traces from project context
to this change
- [x] I have specified the model used (with version and capability
details)
- [x] I have checked ROADMAP.md and confirmed this PR does not duplicate
planned core work
- [x] I have searched GitHub for duplicate or related PRs and linked
them above
- [x] I have either (a) linked existing issues with `Fixes: #` / `Closes
#` / `Refs #` OR (b) described the issue in-PR following the relevant
issue template
- [x] I have not referenced internal/instance-local Paperclip issues or
links (only public GitHub `#NNN` / `github.com/paperclipai/paperclip`
URLs)
- [x] My branch name describes the change (e.g. `docs/...`, `fix/...`)
and contains no internal Paperclip ticket id or instance-derived details
- [x] I have run tests locally and they pass
- [x] I have added or updated tests where applicable
- [x] I have updated relevant documentation to reflect my changes
- [x] I have considered and documented any risks above
- [x] All Paperclip CI gates are green
- [x] Greptile is 5/5 with no open P2s, recommendations, or follow-ups
- [x] I will address all Greptile and reviewer comments before
requesting merge

🤖 Generated with [Claude Code](https://claude.com/claude-code)

---------

Co-authored-by: Claude Fable 5.2 <noreply@anthropic.com>
2026-11-13 14:17:15 -08:00

395 lines
14 KiB
JavaScript

import assert from "node:assert/strict";
import { spawnSync } from "node:child_process";
import { chmodSync, copyFileSync, mkdirSync, mkdtempSync, readFileSync, rmSync, writeFileSync } from "node:fs";
import { tmpdir } from "node:os";
import { join } from "node:path";
import test from "node:test";
const repoRoot = new URL("../..", import.meta.url).pathname.replace(/\/$/, "");
function writeExecutable(path, body) {
writeFileSync(path, body, { mode: 0o755 });
}
function createReleaseFixture() {
const fixtureDir = mkdtempSync(join(tmpdir(), "paperclip-release-dry-run-"));
const scriptsDir = join(fixtureDir, "scripts");
const binDir = join(fixtureDir, "bin");
const callLog = join(fixtureDir, "calls.log");
mkdirSync(scriptsDir, { recursive: true });
mkdirSync(join(fixtureDir, "releases"));
mkdirSync(binDir);
writeFileSync(callLog, "");
copyFileSync(join(repoRoot, "scripts", "release.sh"), join(scriptsDir, "release.sh"));
chmodSync(join(scriptsDir, "release.sh"), 0o755);
writeFileSync(
join(scriptsDir, "release-lib.sh"),
`#!/usr/bin/env bash
release_info() { echo "$@"; }
release_fail() { echo "Error: $*" >&2; exit 1; }
resolve_release_remote() { printf 'origin\\n'; }
fetch_release_remote() { :; }
git_current_branch() { printf 'master\\n'; }
get_last_stable_tag() { printf 'v2026.709.0\\n'; }
get_current_stable_version() { printf '2026.709.0\\n'; }
utc_date_iso() { printf '2026-07-10\\n'; }
list_public_package_info() {
if [ -n "\${FAKE_PACKAGE_INFO:-}" ]; then
printf '%b' "$FAKE_PACKAGE_INFO"
else
printf 'cli\\tpaperclipai\\t0.0.0\\n'
fi
}
package_publish_tool() { printf 'pnpm\\n'; }
next_stable_version() { printf '2026.710.0\\n'; }
next_prerelease_version() { printf '2026.710.0-%s.0\\n' "$1"; }
release_notes_file() { printf '%s/releases/v%s.md\\n' "$REPO_ROOT" "$1"; }
stable_tag_name() { printf 'v%s\\n' "$1"; }
prerelease_tag_name() { printf '%s/v%s\\n' "$1" "$2"; }
require_channel_tag_at_head() {
if [ "\${FAKE_MISSING_CHANNEL_TAG:-}" = "$1" ]; then
echo "Error: HEAD has no $1/v* tag; this channel only publishes commits that already shipped a $1 release." >&2
exit 1
fi
echo "[fixture] require_channel_tag_at_head $1"
}
require_channel_tag_absent_at_head() {
if [ "\${FAKE_PRESENT_CHANNEL_TAG:-}" = "$1" ]; then
echo "Error: HEAD already shipped as $1/v2026.710.0-$1.0; delete that tag first if you really want to republish this commit on the $1 channel." >&2
exit 1
fi
echo "[fixture] require_channel_tag_absent_at_head $1"
}
require_on_master_branch() { :; }
require_clean_worktree() { :; }
require_runner_lockfile_current() {
if [ "\${FAKE_RUNNER_LOCKFILE_BEHIND:-}" = "1" ]; then
echo "Error: a beta or stable release needs a pnpm-lock.yaml that matches the Runner's manifests at HEAD." >&2
exit 1
fi
echo "[fixture] require_runner_lockfile_current"
}
require_npm_publish_auth() { :; }
git_local_tag_exists() { return 1; }
git_remote_tag_exists() { return 1; }
npm_package_version_exists() { return 1; }
set_public_package_version() { :; }
`,
);
writeExecutable(
join(scriptsDir, "release-registry-versions.mjs"),
`#!/usr/bin/env node
const [mode] = process.argv.slice(2);
if (mode === "fetch") {
process.stdout.write('{"paperclipai":[]}\\n');
process.exit(0);
}
if (mode === "assert-absent") {
process.exit(0);
}
process.exit(2);
`,
);
writeExecutable(
join(binDir, "git"),
`#!/usr/bin/env bash
set -euo pipefail
if [ "$1" = "-C" ]; then
shift 2
fi
printf 'git %s\\n' "$*" >> "$FAKE_CALL_LOG"
case "$1" in
rev-parse)
if [ "\${2:-}" = "HEAD" ]; then
echo abcdef1234567890
exit 0
fi
;;
diff|ls-files)
exit 0
;;
checkout)
exit 0
;;
esac
exit 0
`,
);
writeExecutable(
join(binDir, "pnpm"),
`#!/usr/bin/env bash
set -euo pipefail
printf 'pnpm %s\\n' "$*" >> "$FAKE_CALL_LOG"
if [ "$*" = "build" ]; then
if [ "\${FAKE_BUILD_OK:-}" = "1" ]; then
exit 0
fi
echo "fixture stopped at workspace build"
exit 42
fi
if [ "$1" = "publish" ]; then
echo "fixture publish preview in $PWD"
case "$PWD" in
*"\${FAKE_FAIL_PUBLISH_DIR:-__none__}")
echo "fixture preview failure" >&2
exit 3
;;
esac
fi
exit 0
`,
);
return { binDir, callLog, fixtureDir, script: join(scriptsDir, "release.sh") };
}
function runRelease(args, extraEnv = {}, prepare = null) {
const fixture = createReleaseFixture();
if (prepare) {
prepare(fixture);
}
const result = spawnSync(fixture.script, args, {
cwd: fixture.fixtureDir,
encoding: "utf8",
env: {
...process.env,
PATH: `${fixture.binDir}:${process.env.PATH}`,
FAKE_CALL_LOG: fixture.callLog,
...extraEnv,
},
});
const calls = readFileSync(fixture.callLog, "utf8");
rmSync(fixture.fixtureDir, { recursive: true, force: true });
return {
calls,
output: result.stdout + result.stderr,
status: result.status,
};
}
test("stable dry-run preview does not require a pre-authored release notes file", () => {
const result = runRelease(["stable", "--skip-verify", "--dry-run"]);
assert.equal(result.status, 42);
assert.match(result.output, /==> Release plan/);
assert.match(result.output, /==> Step 2\/7: Building workspace artifacts/);
assert.doesNotMatch(result.output, /stable release notes file is required/);
assert.match(result.calls, /^pnpm build$/m);
});
test("stable publish still requires release notes before publish work starts", () => {
const result = runRelease(["stable", "--skip-verify"]);
assert.equal(result.status, 1);
assert.match(result.output, /stable release notes file is required/);
assert.doesNotMatch(result.output, /==> Step 2\/7: Building workspace artifacts/);
assert.doesNotMatch(result.calls, /^pnpm /m);
});
test("beta and stable check the lockfile against the Runner's manifests before any build, in a dry run too", () => {
for (const args of [["stable"], ["beta"], ["beta", "--from-candidate"]]) {
const current = runRelease([...args, "--skip-verify", "--dry-run"]);
assert.match(current.output, /\[fixture\] require_runner_lockfile_current/, args.join(" "));
const behind = runRelease([...args, "--skip-verify", "--dry-run"], { FAKE_RUNNER_LOCKFILE_BEHIND: "1" });
assert.equal(behind.status, 1, args.join(" "));
assert.match(behind.output, /needs a pnpm-lock\.yaml that matches the Runner's manifests at HEAD/);
assert.doesNotMatch(behind.output, /==> Release plan/);
assert.doesNotMatch(behind.calls, /^pnpm /m);
}
});
test("canary and nightly do not check the lockfile, and printing a version does not", () => {
for (const args of [["canary", "--skip-verify", "--dry-run"], ["nightly", "--skip-verify", "--dry-run"]]) {
const result = runRelease(args, { FAKE_RUNNER_LOCKFILE_BEHIND: "1" });
assert.doesNotMatch(result.output, /Runner's manifests/, args[0]);
assert.match(result.output, /==> Release plan/, args[0]);
}
for (const channel of ["stable", "beta"]) {
const version = runRelease([channel, "--print-version"], { FAKE_RUNNER_LOCKFILE_BEHIND: "1" });
assert.equal(version.status, 0, channel);
assert.doesNotMatch(version.output, /Runner's manifests/, channel);
}
});
test("nightly dry-run publishes under the nightly identity without release notes", () => {
const result = runRelease(["nightly", "--skip-verify", "--dry-run"]);
assert.equal(result.status, 42);
assert.match(result.output, /\[fixture\] require_channel_tag_at_head canary/);
assert.match(result.output, /Nightly version: 2026\.710\.0-nightly\.0/);
assert.match(result.output, /Dist-tag: nightly/);
assert.match(result.output, /Git tag: nightly\/v2026\.710\.0-nightly\.0/);
assert.doesNotMatch(result.output, /stable release notes file is required/);
assert.match(result.calls, /^pnpm build$/m);
});
test("nightly refuses commits that never shipped a canary", () => {
const result = runRelease(["nightly", "--skip-verify", "--dry-run"], {
FAKE_MISSING_CHANNEL_TAG: "canary",
});
assert.equal(result.status, 1);
assert.match(result.output, /HEAD has no canary\/v\* tag/);
assert.doesNotMatch(result.calls, /^pnpm /m);
});
test("nightly refuses commits that already shipped as a nightly", () => {
const result = runRelease(["nightly", "--skip-verify", "--dry-run"], {
FAKE_PRESENT_CHANNEL_TAG: "nightly",
});
assert.equal(result.status, 1);
assert.match(result.output, /HEAD already shipped as nightly\/v/);
assert.doesNotMatch(result.calls, /^pnpm /m);
});
test("beta dry-run publishes under the beta identity without release notes", () => {
const result = runRelease(["beta", "--skip-verify", "--dry-run"]);
assert.equal(result.status, 42);
assert.match(result.output, /\[fixture\] require_channel_tag_at_head nightly/);
assert.match(result.output, /Beta version: 2026\.710\.0-beta\.0/);
assert.match(result.output, /Dist-tag: beta/);
assert.match(result.output, /Git tag: beta\/v2026\.710\.0-beta\.0/);
assert.doesNotMatch(result.output, /stable release notes file is required/);
assert.match(result.calls, /^pnpm build$/m);
});
test("beta refuses commits that already shipped as a beta", () => {
const result = runRelease(["beta", "--skip-verify", "--dry-run"], {
FAKE_PRESENT_CHANNEL_TAG: "beta",
});
assert.equal(result.status, 1);
assert.match(result.output, /HEAD already shipped as beta\/v/);
assert.doesNotMatch(result.calls, /^pnpm /m);
});
test("beta --from-candidate waives the nightly requirement but keeps the duplicate guard", () => {
const result = runRelease(["beta", "--from-candidate", "--skip-verify", "--dry-run"], {
FAKE_MISSING_CHANNEL_TAG: "nightly",
});
assert.equal(result.status, 42);
assert.doesNotMatch(result.output, /require_channel_tag_at_head nightly/);
assert.match(result.output, /\[fixture\] require_channel_tag_absent_at_head beta/);
assert.match(result.output, /Beta version: 2026\.710\.0-beta\.0/);
assert.match(result.calls, /^pnpm build$/m);
});
test("--from-candidate is rejected outside the beta channel", () => {
const result = runRelease(["nightly", "--from-candidate", "--skip-verify", "--dry-run"]);
assert.equal(result.status, 1);
assert.match(result.output, /--from-candidate only applies to the beta channel/);
assert.doesNotMatch(result.calls, /^pnpm /m);
});
test("beta refuses commits that never shipped a nightly", () => {
const result = runRelease(["beta", "--skip-verify", "--dry-run"], {
FAKE_MISSING_CHANNEL_TAG: "nightly",
});
assert.equal(result.status, 1);
assert.match(result.output, /HEAD has no nightly\/v\* tag/);
assert.doesNotMatch(result.calls, /^pnpm /m);
});
// --- Step 5 concurrent publish-payload previews (dry-run only) ---
const PREVIEW_PACKAGE_COUNT = 10; // more than one batch of 8
function preparePreviewFixture(fixture) {
const { fixtureDir } = fixture;
// Step 2 copies the skills tree into these package dirs.
mkdirSync(join(fixtureDir, "skills"), { recursive: true });
for (const dir of ["server", "packages/adapters/claude-local", "packages/adapters/codex-local"]) {
mkdirSync(join(fixtureDir, dir), { recursive: true });
}
// Step 2 build helpers that live outside the pnpm stub.
writeExecutable(
join(fixtureDir, "scripts", "build-standalone-public-packages.mjs"),
"#!/usr/bin/env node\nprocess.exit(0);\n",
);
writeExecutable(join(fixtureDir, "scripts", "prepare-server-ui-dist.sh"), "#!/usr/bin/env bash\nexit 0\n");
writeExecutable(join(fixtureDir, "scripts", "build-npm.sh"), "#!/usr/bin/env bash\nexit 0\n");
// Step 4 verifies the CLI package version against the target canary version.
mkdirSync(join(fixtureDir, "cli"), { recursive: true });
writeFileSync(
join(fixtureDir, "cli", "package.json"),
JSON.stringify({ name: "paperclipai", version: "2026.710.0-canary.0" }),
);
// Step 5 cds into each previewed package directory.
for (let index = 1; index <= PREVIEW_PACKAGE_COUNT; index += 1) {
mkdirSync(join(fixtureDir, previewPackageDir(index)), { recursive: true });
}
}
function previewPackageDir(index) {
return `pkg-${String(index).padStart(2, "0")}`;
}
function previewPackageInfo() {
return Array.from({ length: PREVIEW_PACKAGE_COUNT }, (_, i) => {
const dir = previewPackageDir(i + 1);
return `${dir}\\t@fixture/${dir}\\t0.0.0\\n`;
}).join("");
}
test("canary dry-run previews every publish payload and replays logs in package order", () => {
const result = runRelease(
["canary", "--skip-verify", "--dry-run"],
{ FAKE_BUILD_OK: "1", FAKE_PACKAGE_INFO: previewPackageInfo() },
preparePreviewFixture,
);
assert.equal(result.status, 0, result.output);
const headerOffsets = [];
for (let index = 1; index <= PREVIEW_PACKAGE_COUNT; index += 1) {
const offset = result.output.indexOf(`--- ${previewPackageDir(index)} ---`);
assert.notEqual(offset, -1, `missing preview header for ${previewPackageDir(index)}`);
headerOffsets.push(offset);
}
assert.deepEqual(
headerOffsets,
[...headerOffsets].sort((a, b) => a - b),
"preview logs must replay in package order even though previews run concurrently",
);
const previews = result.output.match(/fixture publish preview in /g) ?? [];
assert.equal(previews.length, PREVIEW_PACKAGE_COUNT, "every package must be previewed exactly once");
assert.match(result.output, /Would create git tag/);
});
test("canary dry-run fails when any concurrent payload preview fails, after replaying every log", () => {
const result = runRelease(
["canary", "--skip-verify", "--dry-run"],
{
FAKE_BUILD_OK: "1",
FAKE_PACKAGE_INFO: previewPackageInfo(),
FAKE_FAIL_PUBLISH_DIR: previewPackageDir(7),
},
preparePreviewFixture,
);
assert.notEqual(result.status, 0, "a failed preview must fail the dry run");
assert.match(result.output, /one or more publish payload previews failed/);
assert.match(result.output, /fixture preview failure/);
for (let index = 1; index <= PREVIEW_PACKAGE_COUNT; index += 1) {
assert.match(
result.output,
new RegExp(`--- ${previewPackageDir(index)} ---`),
"every package's log must still replay so the failure is diagnosable",
);
}
assert.doesNotMatch(result.output, /Would create git tag/, "a failed preview must not reach tagging");
});