Repository navigation
fix(npm): pass absolute tarball paths to npm publish #4
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,113 @@ | ||
| #!/usr/bin/env bash | ||
| # Regression test for scripts/bootstrap-npm.sh. | ||
| # | ||
| # bash scripts/test-bootstrap-npm.sh | ||
| # | ||
| # Builds the seven wrapper tarballs (no Go binaries needed — npm packs the | ||
| # placeholder layout fine), then exercises the bootstrap script in --dry-run | ||
| # mode against a *relative* directory. | ||
| # | ||
| # The main assertion is that every `npm publish` argument is an absolute path. | ||
| # npm parses a bare relative path such as "dist-npm/pkg.tgz" as the GitHub | ||
| # shorthand <owner>/<repo> and tries to clone | ||
| # ssh://git@github.com/dist-npm/pkg.tgz.git, failing with | ||
| # "npm error code 128 ... Permission denied (publickey)". | ||
| # | ||
| # Also asserts the publish order (six platform packages, launcher last) and the | ||
| # input validation (wrong tarball count, mixed versions, missing platform). | ||
| set -euo pipefail | ||
|
|
||
| VERSION="${1:-0.0.0-bootstrap-test.1}" | ||
| root="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)" | ||
| cd "$root" | ||
|
|
||
| tmp="$(mktemp -d)" | ||
| cleanup() { | ||
| git checkout -- npm/olk/package.json npm/olk-*/package.json 2>/dev/null || true | ||
| rm -rf "$tmp" | ||
| } | ||
| trap cleanup EXIT | ||
|
|
||
| echo "==> pack 7 tarballs at $VERSION" | ||
| node scripts/build-npm.mjs "$VERSION" \ | ||
| --scope @planmonster \ | ||
| --registry https://registry.npmjs.org \ | ||
| --repository PlanMonster/olkcli >/dev/null | ||
| mkdir -p "$tmp/dist-npm" | ||
| npm pack --silent --pack-destination "$tmp/dist-npm" ./npm/olk-* ./npm/olk >/dev/null | ||
| git checkout -- npm/olk/package.json npm/olk-*/package.json | ||
| count="$(ls "$tmp"/dist-npm/*.tgz | wc -l | tr -d ' ')" | ||
| [ "$count" -eq 7 ] || { | ||
| echo "expected 7 tarballs, packed $count" >&2 | ||
| exit 1 | ||
| } | ||
|
|
||
| # Run from the parent directory with a RELATIVE argument — the exact shape that | ||
| # triggered the git-shorthand misparse. | ||
| echo "==> dry run with a relative directory argument" | ||
| out="$( cd "$tmp" && bash "$root/scripts/bootstrap-npm.sh" dist-npm --dry-run )" | ||
| echo "$out" | sed 's/^/ /' | ||
|
|
||
| echo "==> assert every publish argument is an absolute path" | ||
| bad=0 | ||
| while IFS= read -r line; do | ||
| arg="$(printf '%s' "$line" | sed -n 's/.*npm publish \([^ ]*\).*/\1/p')" | ||
| [ -n "$arg" ] || continue | ||
| case "$arg" in | ||
| /*) ;; | ||
| *) | ||
| echo " NOT ABSOLUTE: $arg" >&2 | ||
| bad=1 | ||
| ;; | ||
| esac | ||
| done <<< "$(printf '%s\n' "$out" | grep 'DRY RUN: npm publish')" | ||
| [ "$bad" -eq 0 ] || { | ||
| echo "npm would parse a relative path as a git shorthand" >&2 | ||
| exit 1 | ||
| } | ||
|
|
||
| echo "==> assert publish order: 6 platform packages, launcher last" | ||
| order="$(printf '%s\n' "$out" | grep -c 'DRY RUN: npm publish')" | ||
| [ "$order" -eq 7 ] || { | ||
| echo "expected 7 publish commands, saw $order" >&2 | ||
| exit 1 | ||
| } | ||
| last="$(printf '%s\n' "$out" | grep 'DRY RUN: npm publish' | tail -1)" | ||
| case "$last" in | ||
| *olkcli-*) ;; | ||
| *) | ||
| echo "launcher must be published last, saw: $last" >&2 | ||
| exit 1 | ||
| ;; | ||
| esac | ||
|
Comment on lines
+69
to
+82
There was a problem hiding this comment. 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win Assert the complete publish sequence, not just its length. The current check only requires seven publish commands and a launcher-like final argument. It would still pass if a platform package were duplicated, omitted, or published in the wrong position. Capture the seven basenames and compare them with an explicit expected sequence containing each platform package exactly once and the launcher last. |
||
|
|
||
| expect_failure() { # description, dir | ||
| local desc="$1" d="$2" | ||
| if ( cd "$tmp" && bash "$root/scripts/bootstrap-npm.sh" "$d" --dry-run >/dev/null 2>&1 ); then | ||
| echo " expected failure: $desc" >&2 | ||
| exit 1 | ||
| fi | ||
| echo " rejected: $desc" | ||
| } | ||
|
|
||
| echo "==> assert input validation" | ||
| cp -r "$tmp/dist-npm" "$tmp/extra" | ||
| cp "$tmp/extra"/*olkcli-*.tgz "$tmp/extra/unrelated-9.9.9.tgz" | ||
| expect_failure "an extra/unexpected tarball" extra | ||
|
|
||
| cp -r "$tmp/dist-npm" "$tmp/missing" | ||
| rm -f "$tmp/missing"/*olk-win32-arm64*.tgz | ||
| expect_failure "a missing platform package" missing | ||
|
|
||
| cp -r "$tmp/dist-npm" "$tmp/empty-ish" | ||
| rm -f "$tmp/empty-ish"/*.tgz | ||
| expect_failure "no tarballs at all" empty-ish | ||
|
Comment on lines
+93
to
+104
There was a problem hiding this comment. 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win Add an isolated mixed-version fixture. The “extra/unexpected tarball” case adds an eighth file named |
||
|
|
||
| if ( cd "$tmp" && bash "$root/scripts/bootstrap-npm.sh" dist-npm --tag --dry-run >/dev/null 2>&1 ); then | ||
| echo " expected failure: --tag consuming a following flag" >&2 | ||
| exit 1 | ||
| fi | ||
| echo " rejected: --tag with an option-like value" | ||
|
|
||
| echo | ||
| echo "bootstrap script test: PASS" | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🗄️ Data Integrity & Integration | 🟠 Major | ⚡ Quick win
Do not discard the caller’s working-tree changes.
Both cleanup paths use
git checkout, which can erase a developer’s unstaged edits to the package manifests when this regression test is run locally. Snapshot the files and restore those exact bytes, or run the build in an isolated temporary worktree instead. This also prevents the CI working-tree check from masking manifest mutations.Also applies to: 38-38