Skip to main content

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