Skip to content

install: keep isolated store entry names within NAME_MAX - #37470

Closed
robobun wants to merge 1 commit into
mainfrom
farm/de69ff22/isolated-store-long-names
Closed

robobun wants to merge 1 commit into
mainfrom
farm/de69ff22/isolated-store-long-names

Conversation

@robobun

@robobun robobun commented Aug 11, 2026

Copy link
Copy Markdown
Collaborator

Repro

mkdir probe && cd probe
cp <bun repo>/test/cli/install/bar-0.0.2.tgz .
bun -e 'require("fs").writeFileSync("package.json", JSON.stringify({ name: "probe", dependencies: { bar: "./" + "x/../".repeat(130) + "bar-0.0.2.tgz" } }))'
bun install --linker isolated
ENAMETOOLONG: File name too long: failed to link package: bar@./x/../x/../x/../...bar-0.0.2.tgz (link)
Failed to install 1 package

Exit code 1, on bun 1.4.0 and main. The tarball itself is at a valid path (the spec normalizes to ./bar-0.0.2.tgz); a tarball or folder at a really deep relative path, or a remote tarball whose URL is long, fails the same way. The hoisted linker installs all of these (its cache folder for a tarball is a hash of the URL); with the isolated linker there is no workaround other than shortening the spec.

Cause

The isolated linker creates one directory per store entry, node_modules/.bun/<name>@<resolution> (entry::StorePathFormatter in src/install/isolated_install/Store.rs). For npm packages the resolution is the version, but for local and remote tarballs, folders and git dependencies it is the user's path or URL, so the directory name is as long as the spec and mkdir fails once it passes NAME_MAX (255 bytes on Linux and macOS, 255 UTF-16 units on NTFS). The peer-set suffix (+<16 hex>) and, with install.globalStore, the -<entry hash> and .tmp-<suffix> suffixes that the installer appends to the same text make the effective limit lower still.

Fix

StorePathFormatter now formats <name>@<resolution> through a small sink that keeps the first 200 bytes and hashes all of it. A name of at most 200 bytes is emitted unchanged. A longer one is emitted as its first 183 bytes (backed up to a UTF-8 character boundary) followed by + and the 16 hex digit wyhash (seed 0, so Bun.hash(fullName) reproduces it) of the full text; the peer-set suffix is appended after that as before. 200 is 255 - 17 - 17 - 21: NAME_MAX minus the peer suffix, the global store's -<hash>, and the .tmp-<u64 hex> / .old-<u64 hex> staging suffixes, so the worst-case directory name in either store is exactly 255 bytes. The constants in Store.rs spell out that arithmetic.

Why this shape:

  • Every consumer (the project-local directory, the <cache>/links/ directory name, the dependency symlink targets, and the entry hash seeded from this text) goes through this one Display impl, so cutting the name there keeps all of them consistent, and the global store needs no separate treatment.
  • Names up to 200 bytes are byte-for-byte what they were, so existing installs are not re-linked on upgrade. The only names that change are ones in the 201 to 255 byte range that happened to fit before without peers or the global store; those are re-created once under the new name on the next install. Names over 255 bytes never existed on disk.
  • Keeping a readable prefix plus a hash of the whole text, rather than replacing the name with a hash the way the tarball cache does, leaves ls node_modules/.bun readable and keeps the cut name a pure function of the same text, so two specs that share the first 183 bytes still get separate entries. This is also what pnpm does for its virtual store (virtual-store-dir-max-length).

#36973 (open) documents the store layout; if it lands, its entry-name table should get a sentence about this rule. #37469 fixes the hoisted linker's panic on the same inputs and #37462 the path-buffer overflow when reading such a tarball; all three are independent.

Verification

New long store entry names block in test/cli/install/isolated-install.test.ts:

  • a local tarball and a folder dependency three 85-byte directories deep (entry names of 277 bytes) install, resolve through node_modules, and a second install reuses the same entries
  • a remote tarball with a 230 byte URL served by a local Bun.serve, with install.globalStore enabled: the node_modules/.bun entry has the cut name and links to <cache>/links/<cut name>-<hash>, and the package imports at runtime
  • a 200 byte name is kept verbatim while a 201 byte one is cut (pins the threshold)
  • two packages whose names only differ after the cut point get two entries, each alias resolving to its own package
  • a cut entry with a resolved peer gets +<peer hash> appended after the cut name and links its peer

The expected names are computed in the test with Bun.hash, so they pin the exact derivation. The first two fail with exit code 1 (ENAMETOOLONG) on the unfixed build and the other three fail on the entry name; all five pass with bun bd test, as does the rest of isolated-install.test.ts (67 tests), public-hoist-pattern.test.ts, bun-install-native-binlink.test.ts, config-version.test.ts, bun-install-hardlink-fallback.test.ts, regression/issue/31652.test.ts and the two --linker=isolated tests in bun-add.test.ts.

The isolated linker names a store entry <name>@<resolution>. For tarball,
folder and git packages the resolution is the user's path or URL, so the
directory name could exceed the 255 byte file name limit and the install
failed with ENAMETOOLONG.

Names longer than 200 bytes are now cut to 183 bytes followed by + and
the 16 hex digit wyhash of the full name. The 55 bytes left over hold the
peer-set suffix and the global store's -<hash> and .tmp-<hash> suffixes,
so the same name works in every place the installer uses it. Names up to
200 bytes are unchanged.
@coderabbitai

coderabbitai Bot commented Aug 11, 2026

Copy link
Copy Markdown
Contributor

Warning

Review limit reached

@robobun, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 4 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: 1125dfc6-3b74-4a12-a806-578b666e1aa3

📥 Commits

Reviewing files that changed from the base of the PR and between da3851e and c6e6289.

📒 Files selected for processing (2)
  • src/install/isolated_install/Store.rs
  • test/cli/install/isolated-install.test.ts

Comment @coderabbitai help to get the list of available commands.

@robobun

robobun commented Aug 11, 2026 •

Copy link
Copy Markdown
Collaborator Author
Updated 3:58 AM PT - Aug 11th, 2026

✅ @robobun, your commit c6e62893f8eba6f8ba03a4292c6dd843f4a47bc8 passed in Build #92171! 🎉


🧪   To try this PR locally:

bunx bun-pr 37470

That installs a local version of the PR into your bun-37470 executable, so you can run:

bun-37470 --bun

@robobun

robobun commented Aug 11, 2026 •

Copy link
Copy Markdown
Collaborator Author

Status: reproduced on bun 1.4.0 and main (54d6d16) with the repro in the description (ENAMETOOLONG ... failed to link package: bar@./x/../... (link), exit 1) and with a local tarball / folder three 85-byte directories deep and a remote tarball with a 230 byte URL. Fix and tests are in this PR; the new tests fail on the unfixed build and pass with it on Linux and on Windows x64 (debug build of this branch, all 5 pass; the deep-directory case goes through paths longer than 260 characters, which is fine). On unfixed Windows the same inputs hang instead of failing; that is a separate make_path problem and is tracked separately.

@claude claude Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I reviewed this PR and didn't find any bugs. Because it changes the isolated linker's on-disk store entry naming (a layout other consumers key off of) and the author's status note says a Windows run of the test file is still pending, a human look would be worthwhile before landing.

What was reviewed:

  • NameSink buffering and UTF-8 boundary backup — the ≤200-byte fast path emits the full input verbatim, and the cut path only reads buf[..≤183], so a multi-byte char straddling the 200-byte buffer edge is never emitted.
  • Streaming Wyhash::update is chunk-invariant (guarded by test_iterative_chunked_matches_oneshot in src/wyhash/lib.rs), so the write!-driven chunked hashing matches the tests' one-shot Bun.hash(fullName).
  • Suffix arithmetic against Installer.rs: .tmp-{:x} / .old-{:x} take a u64, so ".tmp-".len() + 16 is the true maximum and the worst case (cut 183 + 17 + peer 17 + global 17 + staging 21) is exactly 255.
  • The refactor from entries.slice().items_*() to entries.items_*() matches existing usage in the same file (fmt_global_store_path, is_cycle).
Extended reasoning...

Overview

The PR adds a length-capping fmt::Write sink (NameSink) around the isolated linker's StorePathFormatter, so a <name>@<resolution> longer than 200 bytes is emitted as its first ≤183 bytes plus +<16-hex wyhash>. The peer-set suffix is appended after the (possibly cut) name as before. The old fmt body is moved verbatim into a write_name(&mut impl fmt::Write) helper; the only behavioural change is the interposed sink. Five new tests in isolated-install.test.ts pin the exact threshold, the hash derivation (via Bun.hash), collision-by-prefix separation, peer-suffix ordering, and the global-store link name.

Security risks

None identified. The change only shortens directory names derived from user-supplied specs; it does not parse untrusted archive contents, escape a directory root, or alter which package bytes are extracted where. Shortening cannot introduce path traversal, and the hash suffix keeps distinct specs in distinct directories.

Level of scrutiny

Medium-high. This is the isolated linker's on-disk store layout — every consumer (local .bun/<entry>, <cache>/links/<entry>-<hash>, dependency symlink targets, and computeEntryHashes) keys off this one Display impl, so a mistake would mis-link packages rather than fail loudly. Names ≤200 bytes are byte-identical to before, which bounds the blast radius to previously-failing or narrowly-working (201-255 byte) inputs, but the layout is a de-facto stable interface that a maintainer should sign off on.

Other factors

  • The implementation checks out on close reading: Wyhash (final4, seed 0) is the same algorithm as Bun.hash, and its streaming update/final_ is chunk-invariant per the existing unit tests, so the fmt-chunked hash equals the one-shot hash the tests compute. The UTF-8 boundary loop terminates (is_on_char_boundary(_, 0) is always true) and only reads bytes fully copied from valid &str inputs. The suffix-length constants match the actual {:x} formatting of u64 values in Installer.rs.
  • The author's own status comment says a Windows run of the new tests is still outstanding, and the CI build was just started when this review ran. The tests lean on readlink/readlinkSync for symlink targets, which is an established pattern in this file but is the kind of thing that occasionally needs a Windows branch.
  • Test coverage is thorough (threshold pinned at 200/201, prefix-collision case, peer-suffix ordering, global store with staging suffix, second-install idempotence), and the PR description spells out the compatibility story for existing installs.

Given the layout change and the pending Windows verification, deferring to a human reviewer rather than auto-approving.

@robobun

robobun commented Aug 11, 2026

Copy link
Copy Markdown
Collaborator Author

Windows run done: the five new tests pass on a Windows x64 debug build of this branch (the deep-directory case and the global-store runtime import both go through paths over 260 characters; readlink on the junction/symlink targets works as in the rest of the file). Updated the status comment accordingly.

@robobun

robobun commented Aug 15, 2026

Copy link
Copy Markdown
Collaborator Author

#38867 applies the same cut-and-hash to the store entry name, but with an 80 byte limit on the resolution part instead of 200 bytes on the whole name@resolution: the isolated store also breaks below NAME_MAX on Windows, where a git dependency's entry (typically 110 to 180 bytes, URL plus commit) pushes the package directory past MAX_PATH, and CreateProcess then refuses it as the cwd of the package's lifecycle scripts (Failed to run script prepare due to error ENOENT). That PR covers the ENAMETOOLONG case from this one as well (a tarball URL past NAME_MAX is one of its tests), and it is rebased on the fmt_store_key / bun pm licenses code that landed since this was opened, so this PR can be closed if #38867 lands.

@robobun

robobun commented Aug 15, 2026

Copy link
Copy Markdown
Collaborator Author

Closing in favor of #38867.

#38867 applies the same cut-and-hash, but to the resolution part of the entry name (80 bytes kept verbatim, otherwise 63 bytes plus + plus the 16 hex wyhash of the full resolution) instead of to 200 bytes of the whole name@resolution. That also covers the case this PR's bound cannot: on Windows a git dependency's entry of 110 to 180 bytes, well under NAME_MAX, already pushes the package directory past MAX_PATH, and the package's lifecycle scripts then fail to spawn with ENOENT. Cutting inside the resolution also keeps name@ intact, which bun pm prune (split_store_key in src/install/prune.rs) and bun pm licenses now rely on; both landed after this PR was opened, and this branch conflicts with main since fmt_store_key was split out of StorePathFormatter.

Checked with a build of #38867's branch: the repro from this description (./x/../ x130 tarball spec) installs with an 84 byte entry (bar@.+x+..+x+..+...+4cc848e6dd29d08d), where the released build fails with the ENAMETOOLONG above. The deep-directory case from this PR (a local tarball and a folder three 85 byte directories deep, unbounded entry names of 277 bytes, the .bun/node_modules fallback link, and a second install finding the same entries) was not among #38867's tests, so it is carried over there in its naming scheme (474da9d, passed in its CI). The threshold, the two-specs-sharing-a-prefix case and the peer suffix case are covered there at the resolution level, and the remote tarball case by its 290 byte URL test.

One thing this PR's whole-name bound covered that #38867 does not is the package name itself: with #38867 a name longer than 119 bytes with the global store (157 in the project store) can still produce an entry over NAME_MAX once its resolution is cut and the suffixes are appended. That is not among the cases reported here (all of them are long resolutions with short names); it is noted on #38867 in case the bound should be extended to the name part there.

@robobun robobun closed this Aug 15, 2026
dylan-conway pushed a commit that referenced this pull request Aug 17, 2026
…ile: tarballs relative to their folder package (#38867)

This PR bundles three independent install fixes (each was reviewed on
its own PR; folded here so they land together):

1. bound the resolution part of isolated store entry names (this PR's
original change)
2. send credentials embedded in a tarball URL as Basic authorization
(from #39025)
3. read `file:` tarballs relative to the `file:` folder package that
declares them (from #39017)

Rebased on main after #39014: the isolated-store test file now computes
expected git entry names through the same resolution cut
(`storeEntryName`), since a `git+http+++host+port+repo.git+<url
hash>+<sha>` resolution passes 80 bytes.

---

## 1. install: bound the resolution part of isolated store entry names

#### Problem

- With `linker = "isolated"`, a trusted git dependency with any
lifecycle script makes `bun install` fail on Windows with `error: Failed
to run script prepare due to error ENOENT` (exit 1). The same project
installs fine with the hoisted linker. This is the Windows failure of
the isolated case in #38810's test, which that PR currently skips on
Windows.
- A store entry is named `<name>@<resolution>` (`StoreKeyFormatter`,
`src/install/isolated_install/Store.rs`). For git, github, tarball and
folder dependencies the resolution is the whole URL or path with
separators turned into `+` (`src/install/repository.rs`
`StorePathFormatter`, `src/install/resolution.rs` `StorePathFormatter`),
plus the commit for git: a git dependency checked out from a temp
directory gets an entry like
`dep@git+file++++C++Users+AZUREU~1+AppData+Local+Temp+lc-repro+dep-repo+3c6955c70dbe1ff186a126c93c5e77c3ae7bd6b4`
(111 bytes here, 170+ in #38810's test), and the name grows with the
repository path.
- The package directory,
`<project>\node_modules\.bun\<entry>\node_modules\<name>`, is the cwd of
the package's lifecycle scripts (`Scripts::get_list` ->
`lifecycle_script_runner.rs` `SpawnOptions.cwd`). bun's own file
operations use long-path-capable NT paths, so the entry is created and
linked, but `CreateProcessW` does not accept a current directory longer
than `MAX_PATH`, and the spawn (libuv's `uv_spawn` on Windows) reports
that as ENOENT. Measured on Windows x64 with the released
`1.4.0-canary.1`: a package directory of 238 characters runs the script,
one of 268 characters fails as above.
- The same unbounded name also fails on every platform once it passes
`NAME_MAX`: a tarball URL or folder path of 250+ bytes makes the install
fail with `ENAMETOOLONG: File name too long: failed to link package`
(the case of #37470).

#### Fix

- `StoreKeyFormatter` now writes the resolution through
`write_resolution`: a resolution of at most 80 bytes
(`MAX_RESOLUTION_LEN`) is written unchanged; a longer one is written as
its first 63 bytes (backed up to a UTF-8 character boundary) followed by
`+` and the 16 hex digit wyhash of the full text (seed 0, so
`Bun.hash(text)` reproduces it), which is 80 bytes again. The `name@`
prefix and the `+<peer hash>` suffix are unchanged. A cut git entry
looks like
`dep@git+file++++C++Users+AZUREU~1+AppData+Local+Temp+lc-repro-aaaaa+ef7ad81a431ad661`
(the 268 character case from the measurement above; its package
directory is now 206 characters).
- Why this is correct:
- Every path that contains an entry name is formatted through this one
`Display` impl: the project store directory and the dependency symlinks
into it (`Installer.rs` `append_store_path` /
`append_store_node_modules_path` / `link_to_hidden_node_modules`), the
lifecycle script cwd (same `append_store_path`), the global store
directory name and the entry hash seeded from the name (`Installer.rs`
`append_global_store_entry_path`, `isolated_install.rs` entry hash),
`bun pm prune`'s set of expected directories (`prune.rs`
`push_store_entry_names`) and `bun pm licenses`'s lookup
(`pm_licenses_command.rs` `BunStore::lookup`, via `fmt_store_key`). They
all see the same cut name; nothing persists or parses the old one (the
lockfile stores resolutions, and an existing entry is detected by
re-deriving its name).
- The cut name stays a function of the resolution alone, so repeated
installs find the same entry, and two resolutions that agree on the
first 63 bytes still get distinct entries through the hash. The sink
hashes the text in whatever chunks the formatters write it in (the path
formatters write one character at a time); `Wyhash`'s streaming form is
chunk-invariant (`test_iterative_chunked_matches_oneshot` in
`src/wyhash/lib.rs`), which is what lets the tests compute the expected
names with `Bun.hash`.
- The cut happens inside the resolution only, so `prune.rs`
(`split_store_key`, `store_has_entries`, `store_link_target`, which
split the name at `@`) and `pm licenses` (which matches `<key>` or
`<key>+<peer hash>`) keep working without changes.
- Resolutions of 80 bytes or less are byte for byte what they were, so
versions and `github:` shorthands (`github+owner+repo+<sha>` is about 60
to 75 bytes) are unaffected on upgrade. Most full git URLs are over 80
bytes (`git+https+++github.com+` is 23 bytes and the commit adds 41), so
those entries are re-created once under the cut name on the first
install after upgrading, and the old directories stay until `bun pm
prune`, as for any re-resolved entry. The cut keeps the URL itself
readable:
`git-pkg@git+file++++tmp+licenses-git-repo_eXITMt+491eb29762d8d19b570b43+f87e35b31f207dd4`.
- 80 is the tunable here. The package directory is `<project> + 34 + 2 *
<name> + <resolution>` (+17 with peers) characters, so with 80 it fits
`MAX_PATH` whenever `<project> + 2 * <name>` is at most 145 (128 with
peers); #38810's case (61 character temp dir, 25 character name) ends up
at about 225 instead of about 290. It also makes the entry directory
name fit `NAME_MAX` together with every suffix the installers append
(`+<peer hash>`, `-<entry hash>`, `.tmp-<hex>`) for names up to 119
bytes, and with the peer suffix alone for names up to 157 bytes. For
comparison, pnpm's `virtual-store-dir-max-length` defaults to 120 bytes
for the whole directory name; 80 bytes of resolution plus a typical name
lands in the same range.
- #37470 (the same mechanism with a 200 byte limit on the whole
`name@resolution`, for the `NAME_MAX` case only) is closed in favor of
this PR: that limit does not help the `MAX_PATH` case (the failing names
above are 130 to 180 bytes), and a cut through `name@` would no longer
work with `bun pm prune` / `pm licenses` (see the `prune.rs` bullet
above). Its repro installs with this branch and its deep-directory case
is carried over below. What it covered and this PR does not is the name
part: a name over 119 bytes (157 in the project store) can still produce
an entry over `NAME_MAX` once its resolution is cut; if that should be
covered too, it would be the same sink applied to the name separately,
keeping the `@`. #36973 (documenting the layout) would need a sentence
about this rule; this PR adds a short one to
`docs/pm/isolated-installs.mdx`. #38810's Windows skip of its isolated
case can be removed once both land. #39014 changes the same text (it
removes URL credentials, and the hash is of the text as formatted), so
landing it in the same release as this avoids renaming those entries
twice.
- Verification, `long store entry names` in
`test/cli/install/isolated-install.test.ts`:
- a folder resolution of exactly 80 bytes is kept verbatim and one of 81
bytes is cut to the name computed with `Bun.hash`; two resolutions of
one package that only differ after the cut point get separate entries
that each resolve to their own package; a second install finds the same
entries
- a cut entry with a resolved peer gets `+<peer hash>` appended after
the cut name and links the peer
- a folder name made of 2 byte characters, positioned so that byte 63
falls inside a character, is cut at byte 62 and still installs (without
the character boundary loop this case panics with `a formatting trait
implementation returned an error`; the test only asserts the shape
because the spelling of non-ASCII bytes in these names is #32304's
subject)
- (carried over from #37470) a local tarball and a folder three 85 byte
directories deep, whose unbounded entry names would be 277 bytes,
install; the top-level symlinks and the `.bun/node_modules` fallback
link point at the cut names, and a second install finds the same entries
- a tarball URL of about 290 bytes installs with `install.globalStore`
enabled: the local entry has the cut name, links to `links/<cut
name>-<entry hash>`, and the package imports at runtime
- the reported case: a trusted `git+file://` dependency whose repository
directory name alone is 60 characters runs its postinstall script with
the isolated linker; the entry has the cut name
- Without the `Store.rs` change the first three tests and the git one
fail on the entry name (on Windows the git one fails with `error: Failed
to run script postinstall due to error ENOENT`, the reported message)
and the deep-directory and tarball ones exit 1 with `ENAMETOOLONG`; all
of them pass with `bun bd test` on Linux (the five original ones also on
a local Windows x64 build; the deep-directory one on the Windows lanes
in CI). #37470's repro from its description (`./x/../` x130 tarball
spec) installs with this branch with an 84 byte entry.
- Also run with the fix: the rest of `isolated-install.test.ts`,
`bun-pm-licenses.test.ts` (its `git dependency is listed (isolated)`
case now goes through a cut name on every platform, since the repo lives
in a temp dir), `bun-prune.test.ts`, `public-hoist-pattern.test.ts`,
`isolated-relink.test.ts`, `bun-install-native-binlink.test.ts`,
`config-version.test.ts`, and the PowerShell reproduction from the
report on Windows x64 (package directory of 268 characters before, 206
after, script runs).

#### Background

- Isolated linker: instead of hoisting, every package is materialized
once under `node_modules/.bun/<entry>/node_modules/<name>` and
everything else symlinks to it. `<entry>` is `<name>@<resolution>`, plus
`+<16 hex>` when the package was installed for a specific set of peer
dependencies. With `install.globalStore`, `node_modules/.bun/<entry>` is
itself a symlink to `<cache>/links/<entry>-<16 hex entry hash>`.
- Resolution: the lockfile's description of where a package came from.
It is the version for registry packages and the spec itself (folder
path, tarball URL, git URL plus commit) for everything else, which is
why only those entries get long.
- `MAX_PATH`: Windows' 260 character limit for paths passed to Win32
APIs. Applications can opt out of it for file operations (bun does, by
using `\\?\` / NT paths), but the current directory handed to
`CreateProcess` is still limited to it, and libuv maps the resulting
Win32 error to ENOENT.
- `NAME_MAX`: the 255 byte limit on one path component on Linux and
macOS (255 UTF-16 units on NTFS); exceeding it fails with `ENAMETOOLONG`
regardless of how long the whole path is.

<details>
<summary>Windows measurement with the released build
(1.4.0-canary.1)</summary>

Git repo and project created under `%TEMP%` with `linker = "isolated"`,
`trustedDependencies: ["dep"]` and `"prepare": "echo prepared >
prepared.txt"`; the temp directory name was lengthened to move the
package directory across the limit.

```
store entry: dep@git+file++++C++Users+AZUREU~1+AppData+Local+Temp+lc-repro-aaaaaaaaaaaaaaaaaaa+dep-repo+d1a8f7c4111533cb16b52a9edcb086329e6472b5
pkg dir len: 238
prepared.txt exists: True
exit: 0

store entry: dep@git+file++++C++Users+AZUREU~1+AppData+Local+Temp+lc-repro-aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa+dep-repo+30b6ecc8d4d0e4fb2f3df2402556222bf6a5b7dc
pkg dir len: 268
pkg dir exists: True
prepared.txt exists: False
error: Failed to run script prepare due to error ENOENT
exit: 1
```

Same second layout with this PR's build:

```
store entry: dep@git+file++++C++Users+AZUREU~1+AppData+Local+Temp+lc-repro-aaaaa+ef7ad81a431ad661
pkg dir len: 206
prepared.txt exists: True
exit: 0
```

</details>

<!-- robobun:evidence:begin -->

---

**no test proof** · iteration 1 · Platform-specific test(s) that do not
run on this machine. Deferring to CI, which covers all platforms:
test/cli/install/bun-install.test.ts
test/cli/install/isolated-install.test.ts

<!-- robobun:evidence:end -->

---

## 2. install: send credentials embedded in a tarball URL as Basic
authorization (from #39025)

#### Problem
- A dependency declared as a tarball URL with credentials, `"no-deps":
"http://carol:s3cret@127.0.0.1:PORT/cdn/no-deps-1.0.0.tgz"`, is
downloaded without an `Authorization` header. A server that needs the
credentials answers 401 and the install fails with `error: GET
http://carol:s3cret@127.0.0.1:PORT/cdn/no-deps-1.0.0.tgz - 401` (bun
1.4.0 and `main`, hoisted and isolated linker). npm 11 installs the same
package.json and sends `Authorization: Basic Y2Fyb2w6czNjcmV0`
(`base64("carol:s3cret")`).
- The username-only form (`http://token@127.0.0.1:PORT/x.tgz`) does not
reach the server at all: the request goes to the hostname
`token@127.0.0.1`.
- Cause: `NetworkTask::for_tarball` (`src/install/NetworkTask.rs`) only
ever attaches the registry scope's configured token or `_auth`, and only
for npm packages whose tarball is on the registry's origin. Nothing
reads the URL's userinfo, and the HTTP client does not either (it only
turns the userinfo of a proxy URL into `Proxy-Authorization`). The
misrouted username-only form comes from `bun_url::URL::parse`, which
takes `token@127.0.0.1` for the hostname when the userinfo has no `:`
and a port follows (tracked separately; this change no longer depends on
how that parser splits the authority).
- Found while fixing the isolated store names of these URLs (#39014),
not from a user report.

#### Fix
- `for_tarball` splits the userinfo off the request URL before anything
else looks at it (`split_url_userinfo`: the authority runs from `://` to
the first `/`, `?` or `#`, the userinfo is everything in it up to the
last `@`, so the `@` of `/@scope/pkg/-/pkg.tgz` is not one) and sends it
as `Authorization: Basic base64(userinfo)`
(`basic_authorization_from_userinfo`, which appends `:` when the
userinfo has no password). The request URL is the URL without the
userinfo.
- Precedence: when the registry scope's credentials apply to the tarball
(npm package, tarball on the registry origin, scope has a token or
`_auth`), they are still sent and the URL's are not. This is npm's order
as well: npm-registry-fetch sets the header from the config, and node
only derives `Authorization` from the URL's `auth` when the request has
no such header.
- Why Basic of the userinfo as written: it is what npm sends, checked
against npm 11.16 for `user:pass`, `user` (sent as `user:`), `:pass` and
a percent-encoded password (sent undecoded); transcript below. It is
also how bun already treats credentials written into a registry URL
(#38796 stores the username and password bytes as given). pnpm was not
available offline. Two spellings are deliberately not npm's: a second
`:` inside the password is sent as written where npm percent-encodes it,
and `:token@` in a tarball URL is Basic like npm rather than the Bearer
that bun's registry URLs make of it; both are called out in the test
table and in the code comment.
- Why the URL is requested without the userinfo: `bun_url::URL::origin`
includes the userinfo and the HTTP client compares origins to decide
whether `Authorization` follows a redirect, so with the userinfo left
in, a redirect to the same host would drop the header (verified: with
only the header added, the redirect test below fails with
`authorization: null` on the second hop). It also fixes the
username-only form without touching `bun_url`, and the `GET <url> - 401`
line now prints the URL without the credentials. The cross-host rule is
unchanged: the HTTP client strips the header on a redirect to another
origin, same as for the registry token (test included).
- Behavior outside the request is unchanged: `package.json`, the
lockfile, the task id and the cache key still use the URL as written.
Documented in `docs/pm/cli/add.mdx`.
- Verified with `test/cli/install/bun-install.test.ts`,
`describe("credentials embedded in a tarball URL")`: 12 tests, 10 of
which fail on the unfixed build (the two guards, scoped path and
registry credentials taking precedence, pass on both). The rest of the
file is unchanged: the remaining failures locally are the tests that
need the public internet, identical with the unmodified binary.
- `cargo check -p bun_install`, `cargo clippy -p bun_install`, rustfmt
and prettier are clean.

#### Background
- Tarball dependency: a `package.json` entry whose version is an
`http(s)://` URL ending in `.tgz`/`.tar.gz`/`.tar`. Bun downloads it
directly; no registry manifest is involved, so the registry's configured
credentials never applied to it (`Authorization::NoAuthorization` at the
call sites in `PackageManagerEnqueue.rs`). Registry packages reach the
same `for_tarball` through their manifest's `dist.tarball` URL with
`AllowAuthorization`, which is the case where the registry scope's
credentials can apply.
- Userinfo: the `user:password@` part of a URL's authority (RFC 3986
section 3.2.1). HTTP never puts it on the wire; clients that honor it
(npm through minipass-fetch, curl, browsers) convert it into
`Authorization: Basic base64(user:password)`.
- `NetworkTask::for_tarball` builds one HTTP request per tarball
download: `url_buf` (the request URL) and `header_buf` (the headers,
built with `HeaderBuilder` in two passes, `count` then `append`, because
the buffer is allocated exactly once in between). Retries reuse the same
request, so the header is sent on every attempt.
- `bun_url::URL::parse` is the allocation-free splitter the HTTP client
and `for_tarball` use; it is not a WHATWG parser. Its `origin` is a
prefix of the input string, which is why it still contains the userinfo.

<details>
<summary>npm 11.16 against a local server logging the Authorization
header (same tarball, same package.json shape)</summary>

```
userinfo in the dependency URL   header npm sent
carol:s3cret@                    Basic Y2Fyb2w6czNjcmV0      = base64("carol:s3cret")
carol@                           Basic Y2Fyb2w6              = base64("carol:")
:s3cret@                         Basic OnMzY3JldA==          = base64(":s3cret")
carol:s3%40cret@                 Basic Y2Fyb2w6czMlNDBjcmV0  = base64("carol:s3%40cret"), not decoded
carol:s3:cret@                   Basic Y2Fyb2w6czMlM0FjcmV0  = base64("carol:s3%3Acret"), bun sends base64("carol:s3:cret")
carol:s3cret@ + 302 to same host Basic ... on both hops
```

bun 1.4.0-canary.1 (eabb96d) for the first row: the server logs
`auth=null` and bun prints `error: GET
http://carol:s3cret@127.0.0.1:PORT/cdn/no-deps-1.0.0.tgz - 401`.
</details>

---

## 3. install: read `file:` tarballs relative to the `file:` folder
package that declares them (from #39017)

#### Problem

- A `file:` folder dependency whose own package.json declares a local
tarball fails to install (released 1.4.0 canary and main, both linkers):
project package.json `{"dependencies":{"lib":"file:./vendor/lib"}}`,
`vendor/lib/package.json` declaring `"tool": "file:./tool.tgz"`,
`vendor/lib/tool.tgz` present:
  ```
  error: ENOENT extracting tarball from tool
  error: tool@file:./tool.tgz failed to resolve
  ```
- The path is read as `<project>/tool.tgz`. If that file happens to
exist it is installed as `tool` instead of the folder's copy, with no
error. The directory form of the same declaration (`"tool":
"file:./tool"`) is already resolved relative to `vendor/lib`.
- Cause: `enqueue_local_tarball`
(`src/install/PackageManager/PackageManagerEnqueue.rs`) picks the
directory a local tarball path is relative to, and the only declarer it
looked at was a workspace (`get_workspace_pkg_if_workspace_dep`). Every
other declarer, including a `file:` folder package, fell through to the
top-level dir.
- The same choice was also wrong in the other direction: a root
`overrides` / `resolutions` entry or catalog entry pointing a dependency
at `file:./x.tgz` was read relative to the workspace when the dependency
it applied to was declared by a workspace member, so `overrides: { bar:
"file:./bar.tgz" }` with `bar.tgz` in the project root failed with the
same ENOENT as soon as a workspace depended on `bar`. This is #25835
(`overrides`) and #25752 (`catalogs`); both reproduce as reported on the
released build and install with this change. The directory form of an
override is already resolved relative to the project (`Folder` arm of
`get_or_put_resolved_package`).

Fixes #25835
Fixes #25752

#### Fix

- `enqueue_local_tarball` now takes the base directory from
`local_tarball_base_dir`: the directory of the declaring package when it
is a workspace or a `file:` folder package and that package's own
specifier is the tarball path being read; the top-level dir in every
other case.
- Why the declaring package: a path in a package.json means a file next
to that package.json, which is what npm does for `file:` and what bun
already does for workspace declarers and for the directory form. A
`file:` folder package is read from the project like a workspace is, and
its `Resolution::Folder` payload is its directory relative to the
top-level dir (`folder_resolver.rs`, `NewResolver { folder_path: rel
}`), the same shape as a workspace's `Resolution::Workspace` payload, so
both are joined the same way. The only other `Resolution::Folder`
packages are the stubs created for `file:` directories declared by
something other than the root or a workspace (`Folder` arm of
`get_or_put_resolved_package`); those carry no dependency list, so they
are never the declarer of an edge.
- Why the "own specifier" condition: `overrides`, `resolutions` and
catalogs are only parsed from the root package.json (`Package.rs`,
`FEATURES.is_main`), and applying one leaves the declaring package's
stored edge untouched (the replacement is local to
`enqueue_dependency_with_main_and_success_fn`). So when the stored
edge's specifier is not the path being read, the root wrote the path and
the top-level dir is the only directory it can mean. Without this
condition, root overrides applied to a folder-declared dependency, which
work today only because of the bug, would start being read from the
folder.
- Why it is decided from the edge and not from the resolve pass's
`version_was_replaced`: `enqueue_local_tarball` is also reached from
`enqueue_tarball_for_reading` when a project with a `bun.lock` is
installed into an empty cache. The lockfile row keeps the path as
declared (`"tool": ["bar@./tool.tgz", ...]` under `"lib": [..., {
"dependencies": { "tool": "file:./tool.tgz" } }]`), and the edge's
declarer and specifier are available there too, so both passes compute
the same directory. Lockfile format is unchanged and existing lockfiles
keep working; the path in the row is joined onto a different directory
only for declarers that previously failed or installed the wrong file.
- Declarers extracted from the cache (registry, git, tarball packages)
still fall through to the top-level dir, as before; #38986 is changing
what happens to those separately.
`Lockfile::get_parent_pkg_of_dependency` is the same helper that PR
adds.
- Left as is: the lockfile identity of a local tarball is still the path
as written (`bar@./tool.tgz`), so two project packages declaring the
same relative path to two different files still share one row and one
read, the limitation workspaces already have. A package.json inside a
folder dependency that worked around this bug by writing a
project-relative path (`file:./vendor/lib/tool.tgz`) will now need the
path relative to itself, which is what npm requires for it as well.
- Verified with `test/cli/install/bun-install.test.ts`, `describe("file:
tarball declared by a file: folder dependency")`: the folder's tarball
is installed with the hoisted and with the isolated linker, and a root
override supplying the path is read from the project. Each test plants a
different tarball at the other candidate path and runs a fresh install
followed by `--frozen-lockfile` into an emptied cache, so both the
resolve pass and the install from `bun.lock` have to read the right
file. `test/cli/install/bun-workspaces.test.ts`, `relative tarballs >
from a root override / catalog entry applied to a workspace dependency`,
covers #25835 and #25752 the same way. The four folder/workspace tests
install the wrong tarball without the `src/` change (checked against a
debug build of main and against the released build); the
override-on-folder test passes before and after and pins that case.
- Also run with this change: `bun-workspaces.test.ts` (74 pass),
`overrides.test.ts` + `nested-overrides.test.ts` (151 pass),
`bun-lock.test.ts` (40 pass), `bun-install.test.ts -t
"tarball|tgz|file:|folder|override|resolutions"` (51 pass; `should treat
non-GitHub http(s) URLs as tarballs` fails identically on the released
build, it needs network), `isolated-install.test.ts`, `bun-add.test.ts`
and `bun-install-registry.test.ts` filtered to tarball/file tests (all
pass). `cargo clippy -p bun_install` is clean.

#### Background

- A `file:` dependency on a directory is a `Tag::Folder` dependency; one
on a `.tgz` is a `Tag::Tarball` dependency with a local URI. The latter
resolves to `Resolution::LocalTarball(<path as written>)`; the path
string is both the task id for reading it and the package's identity in
`bun.lock`.
- bun reads the package.json of the root, of workspace members and of
`file:` folder dependencies from disk (`Package::parse`), and stores for
each of the latter two a `Resolution::Workspace` / `Resolution::Folder`
whose payload is the package directory relative to the top-level dir.
Packages from the registry, git or a tarball get their dependency lists
from the manifest or the extracted archive instead and have no directory
in the project while they resolve.
- Dependency edges live in one flat buffer and every package owns a
contiguous slice of it, which is how the package that declared an edge
is found. The edge stores the specifier as declared; overrides,
resolutions and catalogs replace it only for the duration of resolving
that edge.
- `enqueue_local_tarball` is called from two places: the `Tarball` arm
of the resolve pass (no lockfile row yet, the tarball is read to learn
the package's name and dependencies) and `enqueue_tarball_for_reading`
during install (a row exists in `bun.lock`, but the extracted package is
missing from the cache). It computes the on-disk path on the main thread
and hands it to a thread pool task, which only reads the file.

Closes #39025
Closes #39017

---------

Co-authored-by: Jarred Sumner <jarred@jarredsumner.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant