aube_lockfile/source.rs
1use std::path::{Path, PathBuf};
2
3/// Non-registry source for a locked package.
4///
5/// When a package comes from a local path (via `file:` or `link:` in
6/// `package.json`) it doesn't have a tarball URL or integrity hash, so we
7/// record the source separately and let the linker materialize it
8/// on-the-fly.
9#[derive(Debug, Clone, PartialEq, Eq)]
10pub enum LocalSource {
11 /// `file:<dir>` — a directory on disk whose contents should be
12 /// hardlink-copied into the virtual store like a normal package.
13 /// Path is stored relative to the project root.
14 Directory(PathBuf),
15 /// `file:<tarball>` — a `.tgz` on disk, extracted into the virtual
16 /// store the same way we extract registry tarballs.
17 Tarball(PathBuf),
18 /// `link:<dir>` — a plain symlink into `node_modules/<name>`, never
19 /// materialized into the virtual store. Transitive deps are the
20 /// target's responsibility.
21 Link(PathBuf),
22 /// `portal:<dir>` — a Yarn Berry package portal. The target is a
23 /// package on disk, but unlike `link:` its dependencies are still
24 /// modeled in the lockfile graph.
25 Portal(PathBuf),
26 /// `exec:<script>` — a Yarn Berry generator script. The script is
27 /// executed at fetch time and writes the package files into a
28 /// generated build directory.
29 Exec(PathBuf),
30 /// `git+https://`, `git+ssh://`, `github:user/repo`, etc. — a
31 /// remote git repo. Cloned at fetch time and imported like a
32 /// `file:` directory. `url` is the normalized clone URL (what
33 /// gets passed to `git clone`). `committish` is the user-written
34 /// ref after `#` (branch, tag, or commit; `None` means HEAD).
35 /// `resolved` is the 40-char commit SHA that `git ls-remote`
36 /// pinned the ref to — the lockfile records this so repeat
37 /// installs reproduce bit-for-bit.
38 Git(GitSource),
39 /// `https://example.com/pkg.tgz` — a remote tarball URL. Fetched
40 /// once at resolve time so the resolver can read the enclosed
41 /// `package.json` for version + transitive deps and pin the
42 /// sha512 integrity. `integrity` stays empty on freshly-parsed
43 /// specifiers and is filled in by the resolver after download.
44 RemoteTarball(RemoteTarballSource),
45}
46
47/// A remote tarball dependency spec. See [`LocalSource::RemoteTarball`].
48#[derive(Debug, Clone, PartialEq, Eq)]
49pub struct RemoteTarballSource {
50 pub url: String,
51 pub integrity: String,
52 pub git_hosted: bool,
53}
54
55/// A git dependency spec. See [`LocalSource::Git`].
56#[derive(Debug, Clone, PartialEq, Eq)]
57pub struct GitSource {
58 pub url: String,
59 pub committish: Option<String>,
60 pub resolved: String,
61 /// SHA-512 SRI of the hosted tarball bytes when the git source was
62 /// fetched through a codeload-style archive. Plain git-clone sources
63 /// leave this unset because git object IDs verify the checkout.
64 pub integrity: Option<String>,
65 /// pnpm `&path:/sub/dir` selector — when set, only this
66 /// subdirectory of the cloned repo is treated as the package
67 /// root. Stored without leading slash so dep_path hashes are
68 /// stable regardless of whether the user wrote `path:/x` or
69 /// `path:x`.
70 pub subpath: Option<String>,
71}
72
73pub fn git_commits_match(left: &str, right: &str) -> bool {
74 if left.eq_ignore_ascii_case(right) {
75 return true;
76 }
77 let left = left.trim();
78 let right = right.trim();
79 if left.len().min(right.len()) < 7
80 || !left.bytes().all(|b| b.is_ascii_hexdigit())
81 || !right.bytes().all(|b| b.is_ascii_hexdigit())
82 {
83 return false;
84 }
85 let left = left.to_ascii_lowercase();
86 let right = right.to_ascii_lowercase();
87 (left.len() == 40 && right.len() < 40 && left.starts_with(&right))
88 || (right.len() == 40 && left.len() < 40 && right.starts_with(&left))
89}
90
91impl LocalSource {
92 /// The original path (relative to the project root) the user wrote
93 /// in `package.json`. `None` for non-path sources like git.
94 pub fn path(&self) -> Option<&Path> {
95 match self {
96 LocalSource::Directory(p)
97 | LocalSource::Tarball(p)
98 | LocalSource::Link(p)
99 | LocalSource::Portal(p)
100 | LocalSource::Exec(p) => Some(p),
101 LocalSource::Git(_) | LocalSource::RemoteTarball(_) => None,
102 }
103 }
104
105 /// The protocol kind (`"file"` / `"link"` / `"git"` / `"url"`).
106 pub fn kind_str(&self) -> &'static str {
107 match self {
108 LocalSource::Directory(_) | LocalSource::Tarball(_) => "file",
109 LocalSource::Link(_) => "link",
110 LocalSource::Portal(_) => "portal",
111 LocalSource::Exec(_) => "exec",
112 LocalSource::Git(_) => "git",
113 LocalSource::RemoteTarball(_) => "url",
114 }
115 }
116
117 /// Whether this source is pinned to immutable, globally
118 /// reproducible content and can therefore be shared across
119 /// projects inside aube's global virtual store, exactly like a
120 /// registry package.
121 ///
122 /// `Git` is pinned to a 40-char commit SHA and `RemoteTarball` to
123 /// a fetched URL (and, once resolved, an integrity hash), so two
124 /// projects that depend on the same one resolve to the same files.
125 /// `file:` / `link:` / `portal:` / `exec:` all resolve against a
126 /// path inside the depending project, so they stay per-project and
127 /// are never promoted into the shared store.
128 ///
129 /// Load-bearing for global-virtual-store correctness: a registry
130 /// package materialized into the shared store points its
131 /// dependency siblings at the hashed global path
132 /// (`virtual_store_subdir(dep_path)`). If one of those deps were a
133 /// git/tarball source that only ever landed in the per-project
134 /// `.aube/`, the sibling symlink would dangle and Node's module
135 /// walk would silently fall back to some unrelated `<name>` found
136 /// higher up the tree.
137 pub fn is_globally_shareable(&self) -> bool {
138 matches!(self, LocalSource::Git(_) | LocalSource::RemoteTarball(_))
139 }
140
141 /// The path as a POSIX-style string with forward-slash separators.
142 /// `Path::display()` and `to_string_lossy()` honor the host's
143 /// separator (backslash on Windows), which would make `dep_path`
144 /// hashes and lockfile `specifier:` strings non-portable: the
145 /// same `file:./some/dir` would render as `some\dir` on Windows
146 /// and `some/dir` on Unix, producing two different hashes for
147 /// the same logical target. Always rendering with `/` keeps
148 /// lockfiles cross-platform identical.
149 pub fn path_posix(&self) -> String {
150 self.path()
151 .map(|p| p.to_string_lossy().replace('\\', "/"))
152 .unwrap_or_default()
153 }
154
155 /// Canonical specifier string as pnpm writes it in the `packages:`
156 /// and `snapshots:` keys (post-`<name>@` part). For `file:` /
157 /// `link:` this is `file:./vendor/foo` / `link:../sibling`. For
158 /// `git`, pnpm uses the resolved form `<url>#<commit>` (no
159 /// `git+` prefix) because the lockfile pins to the exact commit
160 /// regardless of what the user wrote. Always emits POSIX
161 /// separators so the resulting lockfile is portable.
162 pub fn specifier(&self) -> String {
163 match self {
164 LocalSource::Git(g) => match &g.subpath {
165 Some(sub) => format!("{}#{}&path:/{}", g.url, g.resolved, sub),
166 None => format!("{}#{}", g.url, g.resolved),
167 },
168 LocalSource::RemoteTarball(t) => t.url.clone(),
169 _ => format!("{}:{}", self.kind_str(), self.path_posix()),
170 }
171 }
172
173 /// Internal FS-safe dep_path used as the key in
174 /// `LockfileGraph.packages` and as the `.aube/` subdir name.
175 ///
176 /// Distinct paths must map to distinct keys (otherwise the
177 /// linker would silently mix files between two local packages),
178 /// and the result must be a single filesystem component — no
179 /// `/`, `\`, `:`, or `..`. Ad-hoc character substitution trips
180 /// over cases like `../vendor` vs `__/vendor` or `a.b` vs `a_b`
181 /// collapsing to the same string, so we hash the raw path bytes
182 /// and suffix the first 16 hex chars (64 bits — more than enough
183 /// to avoid collisions inside a single project).
184 ///
185 /// The hash input is the POSIX-form path string so a checked-in
186 /// lockfile resolves to the same key regardless of which
187 /// platform ran `aube install`.
188 pub fn dep_path(&self, name: &str) -> String {
189 use sha2::{Digest, Sha256};
190 let mut hasher = Sha256::new();
191 match self {
192 LocalSource::Git(g) => {
193 hasher.update(g.url.as_bytes());
194 hasher.update(b"#");
195 hasher.update(g.resolved.as_bytes());
196 if let Some(sub) = &g.subpath {
197 hasher.update(b"&path:/");
198 hasher.update(sub.as_bytes());
199 }
200 }
201 LocalSource::RemoteTarball(t) => {
202 hasher.update(t.url.as_bytes());
203 }
204 _ => hasher.update(self.path_posix().as_bytes()),
205 }
206 let digest = hasher.finalize();
207 let short: String = digest.iter().take(8).map(|b| format!("{b:02x}")).collect();
208 format!("{name}@{}+{short}", self.kind_str())
209 }
210
211 /// Classify a user-written `file:` / `link:` specifier against the
212 /// project root. Returns `None` if `spec` isn't a local specifier.
213 /// Resolves the target path relative to `project_root`; a `file:`
214 /// target that resolves to a `.tgz` / `.tar.gz` on disk is treated
215 /// as a tarball, anything else as a directory.
216 pub fn parse(spec: &str, project_root: &Path) -> Option<Self> {
217 // Check git first so URLs like `https://host/user/repo.git`
218 // aren't swallowed by the broader bare-http tarball check
219 // below.
220 if let Some((url, committish, subpath)) = parse_git_spec(spec) {
221 // `resolved` is filled in by the resolver after running
222 // `git ls-remote`. A lockfile round-trip that never
223 // re-resolves will leave this empty, which is the sentinel
224 // the resolver checks for before calling ls-remote.
225 return Some(LocalSource::Git(GitSource {
226 url,
227 committish,
228 resolved: String::new(),
229 integrity: None,
230 subpath,
231 }));
232 }
233 // Any remaining bare `http(s)://` URL is a remote tarball.
234 // npm semantics treat *all* non-git HTTP URLs in a dependency
235 // value as tarball URLs, so services that serve tarballs from
236 // URLs without a `.tgz` extension (pkg.pr.new, GitHub
237 // codeload, etc.) classify correctly here.
238 if Self::looks_like_remote_tarball_url(spec) {
239 return Some(LocalSource::RemoteTarball(RemoteTarballSource {
240 url: spec.to_string(),
241 integrity: String::new(),
242 git_hosted: false,
243 }));
244 }
245 let (kind, rest) = if let Some(r) = spec.strip_prefix("file:") {
246 ("file", r)
247 } else if let Some(r) = spec.strip_prefix("link:") {
248 ("link", r)
249 } else if let Some(r) = spec.strip_prefix("portal:") {
250 ("portal", r)
251 } else {
252 let r = spec.strip_prefix("exec:")?;
253 return Some(LocalSource::Exec(PathBuf::from(r)));
254 };
255 let rel = PathBuf::from(rest);
256 let abs = project_root.join(&rel);
257 if kind == "link" {
258 return Some(LocalSource::Link(rel));
259 }
260 if kind == "portal" {
261 return Some(LocalSource::Portal(rel));
262 }
263 if abs.is_file() && Self::path_looks_like_tarball(&rel) {
264 return Some(LocalSource::Tarball(rel));
265 }
266 Some(LocalSource::Directory(rel))
267 }
268
269 /// Whether a specifier looks like a direct HTTP(S) URL that should
270 /// be fetched as a tarball. Per npm semantics, *any* `http://` or
271 /// `https://` URL in a dependency value is a tarball URL — services
272 /// like pkg.pr.new, GitHub codeload, and private registries with
273 /// auth-token query strings serve tarballs from URLs that don't
274 /// carry a `.tgz` extension. Git URLs must already have been
275 /// ruled out by the caller (see [`parse_git_spec`]) so a
276 /// `.git`-suffixed URL doesn't get misclassified here.
277 pub fn looks_like_remote_tarball_url(spec: &str) -> bool {
278 spec.starts_with("https://") || spec.starts_with("http://")
279 }
280
281 pub fn path_looks_like_tarball(path: &Path) -> bool {
282 let name = match path.file_name().and_then(|n| n.to_str()) {
283 Some(n) => n,
284 None => return false,
285 };
286 let lower = name.to_ascii_lowercase();
287 lower.ends_with(".tgz") || lower.ends_with(".tar.gz")
288 }
289}
290
291/// Resolve a transitive dependency's recorded spec *value* to the same
292/// `dep_path` key the lockfile parser assigns the target package, for
293/// the two content-pinned source kinds that get shared globally (git
294/// and remote tarball).
295///
296/// pnpm records a git / remote-tarball dependency inside a snapshot's
297/// `dependencies:` map by its *resolved spec* — `<url>#<sha>` for git,
298/// the tarball URL for remote tarballs (e.g. request-promise-core lists
299/// `request: https://github.com/request/request.git#<sha>`). The parser,
300/// however, keys the package itself under [`LocalSource::dep_path`] — the
301/// short `name@git+<hash>` / `name@url+<hash>` form. A naive
302/// `format!("{name}@{value}")` lookup therefore points at a key that was
303/// never inserted into the graph, so:
304///
305/// * the linker's sibling symlink dangles (Node resolves the wrong
306/// `<name>` or none — the request-promise-core crash), and
307/// * the graph hasher skips the child entirely, so neither its content
308/// fingerprint nor its build/engine taint cascades into the parent's
309/// global-virtual-store hash.
310///
311/// Mirror `pnpm::read::push_direct`'s keying so the resolved value lands
312/// on the exact `dep_path` the package was materialized under. Returns
313/// `None` for every other value (plain semver, `file:`, `link:`, npm
314/// aliases, …) so callers keep the verbatim `name@value` key those
315/// already resolve correctly with.
316pub fn shared_local_dep_path(dep_name: &str, dep_value: &str) -> Option<String> {
317 // pnpm appends a `(peer@ver)` suffix to some spec values; the parser
318 // strips it before classifying the source, so strip it here too.
319 //
320 // This MUST stay byte-for-byte identical to `pnpm::read::push_direct`'s
321 // `classify_version` (`info.version.split('(').next()`), which is what
322 // produced the `dep_path` keys in `graph.packages` we're matching
323 // against. A "smarter" strip (e.g. only a trailing `(peer@…)` via
324 // rfind) would *desync* the two: any value with a non-peer `(` would
325 // hash differently here than the key the parser inserted, silently
326 // re-skipping that child in the linker and graph hasher. If the
327 // first-`(` truncation is ever wrong for a real spec, fix it in
328 // `push_direct` and here together — never in isolation.
329 let classify = dep_value.split('(').next().unwrap_or(dep_value);
330 match LocalSource::parse(classify, Path::new("")) {
331 Some(LocalSource::Git(mut git)) => {
332 // Snapshot specs carry the pinned commit after `#`, which
333 // `parse` records as `committish` rather than `resolved`. The
334 // package was keyed with that commit promoted to `resolved`
335 // (see `push_direct`), so promote it here too — otherwise the
336 // `url#resolved` hash diverges from the package's dep_path.
337 if git.resolved.is_empty() {
338 git.resolved = git.committish.take()?;
339 }
340 Some(LocalSource::Git(git).dep_path(dep_name))
341 }
342 Some(tarball @ LocalSource::RemoteTarball(_)) => Some(tarball.dep_path(dep_name)),
343 _ => None,
344 }
345}
346
347/// Resolve a dependency edge `(name, tail)` to the graph key of the child
348/// package node, honoring every reader's storage convention. Returns the
349/// first candidate that satisfies `contains` (the caller's "is this a real
350/// package key?" predicate), or `None` when the edge points outside the
351/// graph (a pruned optional, an unresolved peer, a `link:` target, …).
352///
353/// Three conventions coexist because the readers disagree on what a
354/// dependency *value* holds, and a graph walker that only knows one of
355/// them silently drops the others:
356/// 1. `tail` verbatim — npm/yarn/bun store the full dep_path as the
357/// value (`"foo@1.2.3"`).
358/// 2. `name@tail` — the pnpm reader stores only the tail (`"1.2.3"`),
359/// so the key is the name re-joined to it.
360/// 3. [`shared_local_dep_path`] — git / remote-tarball deps store the
361/// resolved URL as the tail, but the node is keyed under the short
362/// `name@git+<hash>` / `name@url+<hash>` form. The linker's
363/// `materialize` already bridges the edge this way; reachability /
364/// marking walkers that skip it prune the entire git/tarball subtree
365/// (a content-pinned git/tarball child and everything under it
366/// vanishes from the walk once the node is keyed canonically).
367pub fn resolve_dep_edge(name: &str, tail: &str, contains: impl Fn(&str) -> bool) -> Option<String> {
368 if contains(tail) {
369 return Some(tail.to_string());
370 }
371 let rejoined = format!("{name}@{tail}");
372 if contains(&rejoined) {
373 return Some(rejoined);
374 }
375 shared_local_dep_path(name, tail).filter(|key| contains(key))
376}
377
378/// Parse a git dependency specifier into `(clone_url, committish)`.
379///
380/// Recognized forms:
381/// - `git+https://host/user/repo.git[#ref]`
382/// - `git+ssh://git@host/user/repo.git[#ref]`
383/// - `git://host/user/repo.git[#ref]`
384/// - `https://host/user/repo.git[#ref]` (only when ending in `.git`)
385/// - `user@host:path[.git][#ref]` (scp-form, only for github.com / gitlab.com /
386/// bitbucket.org — matches pnpm 11 behavior, where unknown SCP hosts are
387/// treated as local paths) → `ssh://user@host/path[.git]`
388/// - `github:user/repo[#ref]` → `https://github.com/user/repo.git`
389/// - `gitlab:user/repo[#ref]` → `https://gitlab.com/user/repo.git`
390/// - `bitbucket:user/repo[#ref]` → `https://bitbucket.org/user/repo.git`
391/// - `user/repo[#ref]` (bare GitHub shorthand, npm/pnpm compat)
392/// → `https://github.com/user/repo.git`
393///
394/// Returns `None` for any specifier that doesn't look like a git URL,
395/// so the caller can fall through to other protocol parsers.
396pub fn parse_git_spec(spec: &str) -> Option<(String, Option<String>, Option<String>)> {
397 let (body, committish, subpath) = match spec.find('#') {
398 Some(idx) => {
399 let (c, s) = parse_git_fragment(&spec[idx + 1..]);
400 (&spec[..idx], c, s)
401 }
402 None => (spec, None, None),
403 };
404 let is_bare_transport = body.starts_with("https://")
405 || body.starts_with("http://")
406 || body.starts_with("ssh://")
407 || body.starts_with("file://");
408 let url = if let Some(rest) = body.strip_prefix("git+") {
409 // `git+` explicitly tags the URL as git, so the `.git`
410 // suffix is optional (GitHub/GitLab accept both forms).
411 rest.to_string()
412 } else if body.starts_with("git://") {
413 body.to_string()
414 } else if let Some(scp) = parse_scp_url(body) {
415 scp
416 } else if let Some(path) = body.strip_prefix("github:") {
417 format!("https://github.com/{path}.git")
418 } else if let Some(path) = body.strip_prefix("gitlab:") {
419 format!("https://gitlab.com/{path}.git")
420 } else if let Some(path) = body.strip_prefix("bitbucket:") {
421 format!("https://bitbucket.org/{path}.git")
422 } else if is_bare_transport && body.ends_with(".git") {
423 body.to_string()
424 } else if is_bare_transport
425 && committish
426 .as_deref()
427 .is_some_and(|c| c.len() == 40 && c.chars().all(|ch| ch.is_ascii_hexdigit()))
428 {
429 // Lockfile round-trip form: `specifier()` writes the stored
430 // URL verbatim plus `#<sha>`. URLs that dropped the `git+`
431 // prefix (and happen to lack `.git`) are disambiguated from
432 // plain tarball URLs by the 40-hex committish suffix.
433 body.to_string()
434 } else if is_bare_github_shorthand(body) {
435 // npm/pnpm bare GitHub shorthand: `user/repo` expands to
436 // `github:user/repo`. Placed last so all explicit URL/scheme
437 // forms above shadow it.
438 format!("https://github.com/{body}.git")
439 } else {
440 return None;
441 };
442 Some((url, committish, subpath))
443}
444
445/// `user/repo` — a single `/`, both segments non-empty, ASCII
446/// alphanumeric + `_.-` only, owner doesn't start with `.` so
447/// single-component relative paths (`./repo`, `../repo`) are rejected.
448/// Excludes scoped npm names (`@scope/pkg`) and file paths. Other
449/// URL/SCP forms are ruled out by placement order in `parse_git_spec`.
450fn is_bare_github_shorthand(body: &str) -> bool {
451 let Some((owner, repo)) = body.split_once('/') else {
452 return false;
453 };
454 !owner.is_empty()
455 && !owner.starts_with('.')
456 && !repo.is_empty()
457 && !repo.contains('/')
458 && owner
459 .bytes()
460 .all(|b| b.is_ascii_alphanumeric() || matches!(b, b'_' | b'.' | b'-'))
461 && repo
462 .bytes()
463 .all(|b| b.is_ascii_alphanumeric() || matches!(b, b'_' | b'.' | b'-'))
464}
465
466/// A git URL that maps to one of the three "hosted" providers npm /
467/// pnpm both special-case (github / gitlab / bitbucket). For these
468/// hosts a public read can be served as a flat HTTPS tarball over
469/// `codeload.github.com` (or each host's equivalent), bypassing `git`
470/// entirely. The lockfile's stored URL is canonical-identity only —
471/// pnpm and npm both re-derive the fetch URL from `(host, owner,
472/// repo)` on every install rather than dialing whatever scheme
473/// happens to be in `resolved:`.
474#[derive(Debug, Clone, PartialEq, Eq)]
475pub struct HostedGit {
476 pub host: HostedGitHost,
477 pub owner: String,
478 pub repo: String,
479}
480
481#[derive(Debug, Clone, Copy, PartialEq, Eq)]
482pub enum HostedGitHost {
483 GitHub,
484 GitLab,
485 Bitbucket,
486}
487
488impl HostedGit {
489 /// `https://github.com/<owner>/<repo>.git` — the form `git fetch`
490 /// can dial without an SSH key. Used as the runtime fetch URL when
491 /// the lockfile's stored URL is `git+ssh://git@…` (npm canonical
492 /// identity) but the actual install host has no SSH configured.
493 pub fn https_url(&self) -> String {
494 let host = self.host.host_domain();
495 format!("https://{host}/{}/{}.git", self.owner, self.repo)
496 }
497
498 /// `https://codeload.github.com/<owner>/<repo>/tar.gz/<sha>` (or
499 /// each host's equivalent) — a flat HTTPS tarball at the given
500 /// commit. Returns `None` unless `committish` is a 40-char hex
501 /// SHA, since the codeload path can't be verified after extraction
502 /// without `.git/` metadata. Branch / tag names round-trip through
503 /// `git ls-remote` to get pinned to a SHA first.
504 pub fn tarball_url(&self, committish: &str) -> Option<String> {
505 if committish.len() != 40 || !committish.chars().all(|c| c.is_ascii_hexdigit()) {
506 return None;
507 }
508 let sha = committish.to_ascii_lowercase();
509 Some(match self.host {
510 HostedGitHost::GitHub => format!(
511 "https://codeload.github.com/{}/{}/tar.gz/{sha}",
512 self.owner, self.repo
513 ),
514 HostedGitHost::GitLab => format!(
515 "https://gitlab.com/{}/{}/-/archive/{sha}/{}-{sha}.tar.gz",
516 self.owner, self.repo, self.repo
517 ),
518 HostedGitHost::Bitbucket => format!(
519 "https://bitbucket.org/{}/{}/get/{sha}.tar.gz",
520 self.owner, self.repo
521 ),
522 })
523 }
524}
525
526impl HostedGitHost {
527 fn from_domain(domain: &str) -> Option<Self> {
528 match domain {
529 "github.com" => Some(HostedGitHost::GitHub),
530 "gitlab.com" => Some(HostedGitHost::GitLab),
531 "bitbucket.org" => Some(HostedGitHost::Bitbucket),
532 _ => None,
533 }
534 }
535
536 pub fn host_domain(self) -> &'static str {
537 match self {
538 HostedGitHost::GitHub => "github.com",
539 HostedGitHost::GitLab => "gitlab.com",
540 HostedGitHost::Bitbucket => "bitbucket.org",
541 }
542 }
543}
544
545/// Parse a clone URL — in any form `parse_git_spec` accepts as input
546/// or produces as output — into its `(host, owner, repo)` components,
547/// when the host is one of the three providers npm / pnpm route
548/// through HTTPS tarballs. Returns `None` for any other host (including
549/// self-hosted GitLab / Gitea / Bitbucket Data Center): those still
550/// need a real `git clone` because no codeload-style HTTP archive is
551/// available.
552///
553/// Accepts:
554/// - `https://github.com/owner/repo[.git]`
555/// - `git+https://github.com/owner/repo[.git]`
556/// - `git://github.com/owner/repo[.git]`
557/// - `ssh://git@github.com/owner/repo[.git]`
558/// - `git+ssh://git@github.com/owner/repo[.git]` (npm canonical lockfile form)
559/// - `git@github.com:owner/repo[.git]` (scp shorthand, in case a caller
560/// parses raw lockfile fields without going through `parse_git_spec`)
561pub fn parse_hosted_git(url: &str) -> Option<HostedGit> {
562 let body = url.strip_prefix("git+").unwrap_or(url);
563 let after_scheme = if let Some(rest) = body.strip_prefix("https://") {
564 rest
565 } else if let Some(rest) = body.strip_prefix("http://") {
566 rest
567 } else if let Some(rest) = body.strip_prefix("ssh://") {
568 rest
569 } else if let Some(rest) = body.strip_prefix("git://") {
570 rest
571 } else {
572 // scp shorthand `user@host:path` — not produced by parse_git_spec
573 // but accepted defensively in case a raw lockfile string ever
574 // bypasses it.
575 let scp_path = parse_scp_url(body)?;
576 return parse_hosted_git(&scp_path);
577 };
578 // Strip optional `user@` (always `git@` for hosted forms).
579 let host_and_path = match after_scheme.split_once('@') {
580 Some((_, rest)) => rest,
581 None => after_scheme,
582 };
583 let (host, path) = host_and_path.split_once('/')?;
584 let host = HostedGitHost::from_domain(host)?;
585 // Take exactly two path segments: owner and repo. Anything beyond
586 // (subgroup-style GitLab paths) doesn't have a stable HTTPS tarball
587 // form on the three providers we care about, so refuse and let the
588 // caller fall back to clone.
589 let mut segs = path.splitn(3, '/');
590 let owner = segs.next()?;
591 let repo = segs.next()?;
592 if owner.is_empty() || repo.is_empty() || segs.next().is_some() {
593 return None;
594 }
595 let repo = repo
596 .strip_suffix(".git")
597 .unwrap_or(repo)
598 .trim_end_matches('/');
599 if repo.is_empty() {
600 return None;
601 }
602 Some(HostedGit {
603 host,
604 owner: owner.to_string(),
605 repo: repo.to_string(),
606 })
607}
608
609fn parse_scp_url(body: &str) -> Option<String> {
610 if body.contains("://") {
611 return None;
612 }
613 let colon = body.find(':')?;
614 let before = &body[..colon];
615 let path = &body[colon + 1..];
616 if before.is_empty() || path.is_empty() {
617 return None;
618 }
619 if path.starts_with('/') {
620 return None;
621 }
622 let at = before.find('@')?;
623 let user = &before[..at];
624 let host = &before[at + 1..];
625 if user.is_empty() || host.is_empty() || host.contains('/') || host.contains('@') {
626 return None;
627 }
628 // pnpm 11 only resolves SCP-form as hosted Git for the three known
629 // providers; other hosts (e.g. `git@example.com:foo/bar.git`) are
630 // treated as local paths, and `host:path` without a user errors.
631 if !matches!(host, "github.com" | "gitlab.com" | "bitbucket.org") {
632 return None;
633 }
634 Some(format!("ssh://{user}@{host}/{path}"))
635}
636
637/// Normalize git URL fragments used by npm-compatible lockfiles.
638///
639/// Plain git accepts `#<ref>`, while npm and Yarn Berry also write
640/// key/value fragments such as `#commit=<sha>` for pinned git deps.
641/// Downstream code passes this value directly to `git ls-remote` and
642/// `git checkout`, so strip the selector key here and keep only the
643/// actual ref name or SHA.
644pub(crate) fn normalize_git_fragment(fragment: &str) -> Option<String> {
645 parse_git_fragment(fragment).0
646}
647
648/// Parse a git URL fragment into `(committish, subpath)`. Handles the
649/// pnpm/hosted-git-info form `<ref>&path:/sub/dir` (the `path:` key
650/// uses a colon, not `=`, by historical convention) as well as the
651/// `key=value` form npm/Yarn Berry write. Unknown selectors are
652/// ignored. Subpath is returned without leading slash so the caller
653/// can join it with a clone dir without tripping the absolute-path
654/// branch of `Path::join`.
655pub(crate) fn parse_git_fragment(fragment: &str) -> (Option<String>, Option<String>) {
656 if fragment.is_empty() {
657 return (None, None);
658 }
659
660 let mut fallback: Option<&str> = None;
661 let mut preferred: Option<&str> = None;
662 let mut subpath: Option<String> = None;
663 for part in fragment.split('&') {
664 if part.is_empty() {
665 continue;
666 }
667 // Try `key=value` first; fall back to `key:value` only for
668 // the small set of selectors we actually handle below. A tag
669 // name with a colon (e.g. `release:2026-01`) is left alone —
670 // and `semver:^1.0.0` stays as a literal ref so `ls-remote`
671 // surfaces an explicit error rather than silently HEAD-ing.
672 let split = part.split_once('=').or_else(|| {
673 part.split_once(':')
674 .filter(|(k, _)| matches!(*k, "commit" | "tag" | "head" | "branch" | "path"))
675 });
676 let (key, value) = split.unwrap_or(("", part));
677 if value.is_empty() {
678 continue;
679 }
680 match key {
681 "commit" => {
682 preferred.get_or_insert(value);
683 }
684 "tag" | "head" | "branch" => {
685 fallback.get_or_insert(value);
686 }
687 "path" => {
688 // Strip leading slashes (pnpm writes `path:/sub`) and
689 // reject any `..` / `.` component. Without this, a
690 // crafted spec like `&path:/../../etc` would let the
691 // resolver and installer escape the clone dir and
692 // import an arbitrary host directory into the store.
693 if subpath.is_some() {
694 // First-wins, matching the other selectors above.
695 continue;
696 }
697 let trimmed = value.trim_start_matches('/');
698 if trimmed.is_empty() {
699 continue;
700 }
701 if trimmed
702 .split('/')
703 .any(|c| c.is_empty() || c == "." || c == "..")
704 {
705 continue;
706 }
707 subpath = Some(trimmed.to_string());
708 }
709 "" => {
710 fallback.get_or_insert(value);
711 }
712 _ => {}
713 }
714 }
715
716 (preferred.or(fallback).map(ToString::to_string), subpath)
717}
718
719#[cfg(test)]
720mod tests {
721 use super::*;
722
723 #[test]
724 fn matches_https_tgz() {
725 assert!(LocalSource::looks_like_remote_tarball_url(
726 "https://example.com/pkg-1.0.0.tgz"
727 ));
728 }
729
730 #[test]
731 fn matches_http_tar_gz() {
732 assert!(LocalSource::looks_like_remote_tarball_url(
733 "http://example.com/pkg-1.0.0.tar.gz"
734 ));
735 }
736
737 #[test]
738 fn strips_fragment_before_suffix_check() {
739 assert!(LocalSource::looks_like_remote_tarball_url(
740 "https://example.com/pkg-1.0.0.tgz#sha512-abc"
741 ));
742 }
743
744 #[test]
745 fn strips_query_string_before_suffix_check() {
746 // Auth-token URLs from private registries (JFrog, Nexus,
747 // CodeArtifact, …) routinely trail `?token=…` after the
748 // filename. Must still classify as a tarball URL.
749 assert!(LocalSource::looks_like_remote_tarball_url(
750 "https://registry.example.com/pkg/-/pkg-1.0.0.tgz?token=abc"
751 ));
752 assert!(LocalSource::looks_like_remote_tarball_url(
753 "https://example.com/pkg-1.0.0.tar.gz?v=2&signed=1"
754 ));
755 }
756
757 #[test]
758 fn matches_bare_http_url_without_tarball_suffix() {
759 // pkg.pr.new serves tarballs from URLs without a `.tgz`
760 // extension; npm treats all non-git http(s) URLs as tarball
761 // URLs, so these must classify as remote tarballs.
762 assert!(LocalSource::looks_like_remote_tarball_url(
763 "https://pkg.pr.new/lunariajs/lunaria/@lunariajs/core@904b935"
764 ));
765 assert!(LocalSource::looks_like_remote_tarball_url(
766 "https://codeload.github.com/user/repo/tar.gz/main"
767 ));
768 }
769
770 #[test]
771 fn git_commits_match_only_allows_full_sha_prefix_pairs() {
772 let full = "abcdef0123456789abcdef0123456789abcdef01";
773 assert!(git_commits_match(full, "abcdef0"));
774 assert!(git_commits_match("abcdef0", full));
775 assert!(git_commits_match(full, full));
776 assert!(!git_commits_match("abcdef0", "abcdef012"));
777 assert!(!git_commits_match(full, "abcdef1"));
778 assert!(!git_commits_match("main", full));
779 }
780
781 #[test]
782 fn rejects_non_http_schemes() {
783 assert!(!LocalSource::looks_like_remote_tarball_url(
784 "ftp://example.com/pkg.tgz"
785 ));
786 assert!(!LocalSource::looks_like_remote_tarball_url(
787 "git://example.com/repo.git"
788 ));
789 }
790
791 #[test]
792 fn parse_classifies_bare_http_url_as_remote_tarball() {
793 use std::path::Path;
794 let parsed = LocalSource::parse(
795 "https://pkg.pr.new/lunariajs/lunaria/@lunariajs/core@904b935",
796 Path::new(""),
797 );
798 assert!(matches!(parsed, Some(LocalSource::RemoteTarball(_))));
799 }
800
801 #[test]
802 fn parse_prefers_git_over_tarball_for_dot_git_url() {
803 use std::path::Path;
804 let parsed = LocalSource::parse("https://github.com/user/repo.git", Path::new(""));
805 assert!(matches!(parsed, Some(LocalSource::Git(_))));
806 }
807
808 #[test]
809 fn parse_classifies_exec_as_local_source() {
810 let parsed = LocalSource::parse("exec:./scripts/generate.js", Path::new(""));
811 assert_eq!(
812 parsed,
813 Some(LocalSource::Exec(PathBuf::from("./scripts/generate.js")))
814 );
815 }
816
817 #[test]
818 fn git_plus_https_without_dot_git_roundtrips_via_lockfile_form() {
819 // Initial parse: `git+https://…/repo` (no `.git`).
820 let (url, committish, subpath) = parse_git_spec("git+https://host/user/repo").unwrap();
821 assert_eq!(url, "https://host/user/repo");
822 assert_eq!(committish, None);
823 assert_eq!(subpath, None);
824
825 // After resolving, the serializer writes `<url>#<sha>` into
826 // the lockfile's importer `version:` field.
827 let sha = "abcdef0123456789abcdef0123456789abcdef01";
828 let source = LocalSource::Git(GitSource {
829 url: url.clone(),
830 committish: None,
831 resolved: sha.to_string(),
832 integrity: None,
833 subpath: None,
834 });
835 let lockfile_version = source.specifier();
836 assert_eq!(lockfile_version, format!("https://host/user/repo#{sha}"));
837
838 // Re-parse must recognize the bare URL because the 40-hex
839 // committish suffix unambiguously tags it as git.
840 let (round_url, round_committish, round_subpath) =
841 parse_git_spec(&lockfile_version).unwrap();
842 assert_eq!(round_url, "https://host/user/repo");
843 assert_eq!(round_committish.as_deref(), Some(sha));
844 assert_eq!(round_subpath, None);
845 }
846
847 #[test]
848 fn bare_https_without_dot_git_and_no_committish_is_not_git() {
849 // A plain `https://…` URL with no `.git` and no SHA could be
850 // anything (including a tarball); don't claim it.
851 assert!(parse_git_spec("https://example.com/pkg").is_none());
852 }
853
854 #[test]
855 fn github_shorthand_expands_and_roundtrips() {
856 let (url, _, _) = parse_git_spec("github:user/repo").unwrap();
857 assert_eq!(url, "https://github.com/user/repo.git");
858 }
859
860 #[test]
861 fn bare_user_repo_expands_to_github() {
862 let (url, committish, subpath) = parse_git_spec("kevva/is-negative").unwrap();
863 assert_eq!(url, "https://github.com/kevva/is-negative.git");
864 assert!(committish.is_none());
865 assert!(subpath.is_none());
866 }
867
868 #[test]
869 fn bare_user_repo_with_committish_preserved() {
870 let (url, committish, _) = parse_git_spec("kevva/is-negative#v1.0.0").unwrap();
871 assert_eq!(url, "https://github.com/kevva/is-negative.git");
872 assert_eq!(committish.as_deref(), Some("v1.0.0"));
873 }
874
875 #[test]
876 fn bare_scope_pkg_is_not_git_shorthand() {
877 // npm-style `@scope/pkg` is a registry name, not a GitHub shorthand.
878 assert!(parse_git_spec("@types/node").is_none());
879 }
880
881 #[test]
882 fn bare_relative_path_is_not_git_shorthand() {
883 // Single-component relative paths split as owner=".", owner="..",
884 // so owner-starts-with-`.` is the load-bearing guard here.
885 assert!(parse_git_spec("./repo").is_none());
886 assert!(parse_git_spec("../repo").is_none());
887 // Multi-component relative paths additionally fail the
888 // single-`/`-only guard.
889 assert!(parse_git_spec("./local/path").is_none());
890 assert!(parse_git_spec("../local/path").is_none());
891 }
892
893 #[test]
894 fn bare_path_with_extra_slashes_is_not_git_shorthand() {
895 // Real GitHub shorthand is exactly `user/repo` — anything with a
896 // second `/` is a path, not a shorthand.
897 assert!(parse_git_spec("path/with/slashes/extra").is_none());
898 }
899
900 #[test]
901 fn bare_scp_form_unknown_host_is_not_github_shorthand() {
902 // `user@host:repo.git` is scp form (handled or rejected above);
903 // the bare-shorthand branch must not pick it up.
904 assert!(parse_git_spec("user@host:repo.git").is_none());
905 }
906
907 #[test]
908 fn scp_form_recognized() {
909 let (url, committish, _) =
910 parse_git_spec("git@github.com:EthanHenrickson/math-mcp.git").unwrap();
911 assert_eq!(url, "ssh://git@github.com/EthanHenrickson/math-mcp.git");
912 assert!(committish.is_none());
913 }
914
915 #[test]
916 fn scp_form_with_ref_recognized() {
917 let (url, committish, _) =
918 parse_git_spec("git@github.com:EthanHenrickson/math-mcp.git#0.1.5").unwrap();
919 assert_eq!(url, "ssh://git@github.com/EthanHenrickson/math-mcp.git");
920 assert_eq!(committish.as_deref(), Some("0.1.5"));
921 }
922
923 #[test]
924 fn scp_form_bitbucket_recognized() {
925 let (url, _, _) = parse_git_spec("git@bitbucket.org:pnpmjs/git-resolver.git").unwrap();
926 assert_eq!(url, "ssh://git@bitbucket.org/pnpmjs/git-resolver.git");
927 }
928
929 #[test]
930 fn scp_form_unknown_host_rejected() {
931 // pnpm 11 treats `user@unknown-host:path` as a local path, not Git.
932 assert!(parse_git_spec("git@example.com:org/repo.git").is_none());
933 assert!(parse_git_spec("alice@host.example.com:org/repo.git").is_none());
934 }
935
936 #[test]
937 fn scp_form_without_user_rejected() {
938 // pnpm 11 errors on bare `host:path` as unsupported.
939 assert!(parse_git_spec("github.com:user/repo.git").is_none());
940 }
941
942 #[test]
943 fn commit_selector_fragment_normalizes_to_sha() {
944 let sha = "abcdef0123456789abcdef0123456789abcdef01";
945 let (url, committish, _) =
946 parse_git_spec(&format!("https://host/user/repo.git#commit={sha}")).unwrap();
947 assert_eq!(url, "https://host/user/repo.git");
948 assert_eq!(committish.as_deref(), Some(sha));
949 }
950
951 #[test]
952 fn named_selector_fragment_normalizes_to_ref() {
953 let (url, committish, _) = parse_git_spec("git+https://host/user/repo#tag=v1.2.3").unwrap();
954 assert_eq!(url, "https://host/user/repo");
955 assert_eq!(committish.as_deref(), Some("v1.2.3"));
956 }
957
958 #[test]
959 fn pnpm_path_subpath_extracted_from_fragment() {
960 // pnpm syntax: `<url>#<ref>&path:/<subdir>` selects a
961 // subdirectory of the cloned repo as the package root.
962 let (url, committish, subpath) =
963 parse_git_spec("github:org/dep#v0.1.4&path:/packages/special").unwrap();
964 assert_eq!(url, "https://github.com/org/dep.git");
965 assert_eq!(committish.as_deref(), Some("v0.1.4"));
966 assert_eq!(subpath.as_deref(), Some("packages/special"));
967 }
968
969 #[test]
970 fn path_subpath_roundtrips_via_specifier() {
971 let sha = "abcdef0123456789abcdef0123456789abcdef01";
972 let source = LocalSource::Git(GitSource {
973 url: "https://github.com/org/dep.git".to_string(),
974 committish: None,
975 resolved: sha.to_string(),
976 integrity: None,
977 subpath: Some("packages/special".to_string()),
978 });
979 let spec = source.specifier();
980 assert_eq!(
981 spec,
982 format!("https://github.com/org/dep.git#{sha}&path:/packages/special")
983 );
984 let (url, committish, subpath) = parse_git_spec(&spec).unwrap();
985 assert_eq!(url, "https://github.com/org/dep.git");
986 assert_eq!(committish.as_deref(), Some(sha));
987 assert_eq!(subpath.as_deref(), Some("packages/special"));
988 }
989
990 #[test]
991 fn parse_hosted_git_recognizes_canonical_forms() {
992 // All these point at the same (github.com, owner, repo) tuple
993 // and must map to the same HostedGit so the runtime fetch URL
994 // doesn't depend on which scheme the lockfile happens to record.
995 let canonical = HostedGit {
996 host: HostedGitHost::GitHub,
997 owner: "owner".to_string(),
998 repo: "repo".to_string(),
999 };
1000 for spec in [
1001 "https://github.com/owner/repo.git",
1002 "https://github.com/owner/repo",
1003 "http://github.com/owner/repo.git",
1004 "git+https://github.com/owner/repo.git",
1005 "git+https://github.com/owner/repo",
1006 "git://github.com/owner/repo.git",
1007 "ssh://git@github.com/owner/repo.git",
1008 "git+ssh://git@github.com/owner/repo.git",
1009 "git@github.com:owner/repo.git",
1010 ] {
1011 assert_eq!(
1012 parse_hosted_git(spec).as_ref(),
1013 Some(&canonical),
1014 "spec {spec} should map to canonical HostedGit",
1015 );
1016 }
1017 }
1018
1019 #[test]
1020 fn parse_hosted_git_returns_none_for_non_hosted() {
1021 // Self-hosted GitLab / Gitea / arbitrary hosts: no codeload
1022 // template, so the codeload fast path doesn't apply.
1023 for spec in [
1024 "https://example.com/owner/repo.git",
1025 "ssh://git@gitea.internal/owner/repo.git",
1026 "git+ssh://git@gitlab.example.com/group/sub/repo.git",
1027 "https://github.com/owner/repo/sub",
1028 "https://github.com/owner",
1029 ] {
1030 assert!(
1031 parse_hosted_git(spec).is_none(),
1032 "spec {spec} must not match a hosted provider",
1033 );
1034 }
1035 }
1036
1037 #[test]
1038 fn hosted_tarball_url_only_for_full_sha() {
1039 let g = HostedGit {
1040 host: HostedGitHost::GitHub,
1041 owner: "o".to_string(),
1042 repo: "r".to_string(),
1043 };
1044 let sha = "abcdef0123456789abcdef0123456789abcdef01";
1045 assert_eq!(
1046 g.tarball_url(sha).as_deref(),
1047 Some("https://codeload.github.com/o/r/tar.gz/abcdef0123456789abcdef0123456789abcdef01"),
1048 );
1049 // Branch / tag / abbreviated SHA don't take the fast path —
1050 // codeload accepts them but the wrapper-dir name varies and
1051 // we can't verify a non-SHA committish post-extraction.
1052 assert!(g.tarball_url("main").is_none());
1053 assert!(g.tarball_url("v1.2.3").is_none());
1054 assert!(g.tarball_url("abcdef0").is_none());
1055 }
1056
1057 #[test]
1058 fn hosted_tarball_url_per_provider() {
1059 let sha = "abcdef0123456789abcdef0123456789abcdef01";
1060 let gitlab = HostedGit {
1061 host: HostedGitHost::GitLab,
1062 owner: "g".to_string(),
1063 repo: "r".to_string(),
1064 }
1065 .tarball_url(sha)
1066 .unwrap();
1067 assert!(gitlab.starts_with("https://gitlab.com/g/r/-/archive/"));
1068 assert!(gitlab.ends_with("/r-abcdef0123456789abcdef0123456789abcdef01.tar.gz"));
1069 let bitbucket = HostedGit {
1070 host: HostedGitHost::Bitbucket,
1071 owner: "g".to_string(),
1072 repo: "r".to_string(),
1073 }
1074 .tarball_url(sha)
1075 .unwrap();
1076 assert_eq!(
1077 bitbucket,
1078 "https://bitbucket.org/g/r/get/abcdef0123456789abcdef0123456789abcdef01.tar.gz",
1079 );
1080 }
1081
1082 #[test]
1083 fn hosted_https_url_normalizes() {
1084 let g = parse_hosted_git("git+ssh://git@github.com/owner/repo.git").unwrap();
1085 assert_eq!(g.https_url(), "https://github.com/owner/repo.git");
1086 }
1087
1088 #[test]
1089 fn path_traversal_components_in_subpath_are_rejected() {
1090 // `..` and `.` components would let a crafted spec escape the
1091 // clone dir at install time. The parser drops them so the
1092 // resolver/installer never see a traversal-laden subpath.
1093 let cases = [
1094 "github:org/dep#main&path:/../../etc",
1095 "github:org/dep#main&path:/packages/../../../etc",
1096 "github:org/dep#main&path:/./packages/foo",
1097 "github:org/dep#main&path:/packages//foo",
1098 ];
1099 for spec in cases {
1100 let (_, _, subpath) = parse_git_spec(spec).unwrap();
1101 assert_eq!(subpath, None, "spec should drop subpath: {spec}");
1102 }
1103 }
1104
1105 #[test]
1106 fn dep_path_distinguishes_subpaths_under_same_commit() {
1107 // Two packages from the same repo+commit but different
1108 // subdirs must hash to distinct dep_paths so the linker
1109 // doesn't collapse them.
1110 let sha = "abcdef0123456789abcdef0123456789abcdef01";
1111 let a = LocalSource::Git(GitSource {
1112 url: "https://example.com/r.git".to_string(),
1113 committish: None,
1114 resolved: sha.to_string(),
1115 integrity: None,
1116 subpath: Some("packages/a".to_string()),
1117 });
1118 let b = LocalSource::Git(GitSource {
1119 url: "https://example.com/r.git".to_string(),
1120 committish: None,
1121 resolved: sha.to_string(),
1122 integrity: None,
1123 subpath: Some("packages/b".to_string()),
1124 });
1125 assert_ne!(a.dep_path("dep"), b.dep_path("dep"));
1126 }
1127
1128 const SHARED_SHA: &str = "0123456789abcdef0123456789abcdef01234567";
1129
1130 /// The dep_path the lockfile parser keys a git package under, given
1131 /// its normalized clone URL and pinned commit.
1132 fn git_key(url: &str, resolved: &str) -> String {
1133 LocalSource::Git(GitSource {
1134 url: url.to_string(),
1135 committish: None,
1136 resolved: resolved.to_string(),
1137 integrity: None,
1138 subpath: None,
1139 })
1140 .dep_path("request")
1141 }
1142
1143 /// The dep_path the lockfile parser keys a remote-tarball package
1144 /// under, given its fetch URL.
1145 fn tarball_key(url: &str) -> String {
1146 LocalSource::RemoteTarball(RemoteTarballSource {
1147 url: url.to_string(),
1148 integrity: String::new(),
1149 git_hosted: false,
1150 })
1151 .dep_path("request")
1152 }
1153
1154 #[test]
1155 fn shared_github_shorthand_maps_to_git_dep_path() {
1156 // A dependent records its git `request` via the `github:` spec,
1157 // but the package is keyed under the hashed `git+` dep_path. The
1158 // sibling symlink / hasher lookup must use that same key or it
1159 // dangles / silently skips the child.
1160 let got = shared_local_dep_path("request", &format!("github:request/request#{SHARED_SHA}"))
1161 .expect("github: spec is a shareable local source");
1162 assert_eq!(
1163 got,
1164 git_key("https://github.com/request/request.git", SHARED_SHA)
1165 );
1166 assert!(got.starts_with("request@git+"), "unexpected key: {got}");
1167 }
1168
1169 #[test]
1170 fn shared_git_url_and_shorthand_converge() {
1171 // Whether the dependent recorded the shorthand or the resolved
1172 // `<url>.git#<sha>` form, both must canonicalize to one key.
1173 let from_shorthand =
1174 shared_local_dep_path("request", &format!("github:request/request#{SHARED_SHA}"))
1175 .unwrap();
1176 let from_url = shared_local_dep_path(
1177 "request",
1178 &format!("https://github.com/request/request.git#{SHARED_SHA}"),
1179 )
1180 .unwrap();
1181 assert_eq!(from_shorthand, from_url);
1182 }
1183
1184 #[test]
1185 fn shared_missing_resolved_is_promoted_from_committish() {
1186 // A lockfile round-trip that never re-resolved leaves `resolved`
1187 // empty and only carries `#<committish>`; the helper must promote
1188 // it so the hash matches the package's `<url>#<sha>` key.
1189 let got = shared_local_dep_path(
1190 "request",
1191 &format!("https://github.com/request/request.git#{SHARED_SHA}"),
1192 )
1193 .unwrap();
1194 assert_eq!(
1195 got,
1196 git_key("https://github.com/request/request.git", SHARED_SHA)
1197 );
1198 }
1199
1200 #[test]
1201 fn shared_codeload_tarball_maps_to_url_dep_path() {
1202 // The exact form pnpm records for a `github:` dep that resolves to
1203 // a codeload archive. This is the case that crashed
1204 // request-promise-core under the global virtual store.
1205 let url = format!("https://codeload.github.com/request/request/tar.gz/{SHARED_SHA}");
1206 let got = shared_local_dep_path("request", &url).unwrap();
1207 assert_eq!(got, tarball_key(&url));
1208 assert!(got.starts_with("request@url+"), "unexpected key: {got}");
1209 }
1210
1211 #[test]
1212 fn shared_strips_peer_suffix_before_classifying() {
1213 let url = format!("https://codeload.github.com/request/request/tar.gz/{SHARED_SHA}");
1214 let with_peer = format!("{url}(typescript@5.8.3)");
1215 assert_eq!(
1216 shared_local_dep_path("request", &with_peer),
1217 shared_local_dep_path("request", &url),
1218 );
1219 }
1220
1221 #[test]
1222 fn shared_returns_none_for_non_shareable_specs() {
1223 for value in [
1224 "4.18.1",
1225 "^1.2.3",
1226 "link:../sibling",
1227 "file:./vendor/x",
1228 "npm:lodash@4.18.1",
1229 ] {
1230 assert!(
1231 shared_local_dep_path("dep", value).is_none(),
1232 "{value:?} must not be treated as a shareable local source",
1233 );
1234 }
1235 }
1236}