Skip to content

install: migrate pnpm importer rows in the shape package.json parsing produces #38791

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
robobun wants to merge 1 commit into
base: main
Choose a base branch
from
Open

install: migrate pnpm importer rows in the shape package.json parsing produces #38791

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/pm/cli/install.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -523,6 +523,7 @@ The migration process handles:
- Converts `pnpm-lock.yaml` (lockfile versions 7–9, including pnpm 11's multi-document files) to `bun.lock`
- Preserves resolved versions and integrity hashes
- Preserves peer dependency ranges and `peerDependenciesMeta`, so the next `bun install` leaves the migrated lockfile unchanged
- Keeps `catalog:` and `workspace:` specifiers as written and records each workspace package's version, so `bun install --frozen-lockfile` accepts the migrated lockfile and the versions pnpm locked for each workspace are the ones installed
- Migrates git, GitHub, tarball URL, `file:`, and `npm:` alias dependencies, including transitive ones
- Resolves pnpm named registries (`name@registry:version`) via `namedRegistries` in `pnpm-workspace.yaml`
- Converts injected workspace packages (`dependenciesMeta.*.injected`) to ordinary workspace dependencies
Expand Down
34 changes: 21 additions & 13 deletions src/install/lockfile/bun.lock.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3442,22 +3442,30 @@ fn map_dep_to_pkg(
resolutions[dep_id as usize] = pkg_id;

if text_lockfile_version != Version::V0 {
let res = &pkg_resolutions[pkg_id as usize];
if res.tag == ResolutionTag::Workspace {
// Whole-struct assign so `DependencyVersion::Drop` frees any prior
// npm chain. SAFETY: `res.tag == Workspace` checked above.
let literal = dep.version.literal;
dep.version = DependencyVersion {
tag: DependencyVersionTag::Workspace,
literal,
value: DependencyVersionValue {
workspace: *res.workspace(),
},
};
}
adopt_workspace_resolution(dep, &pkg_resolutions[pkg_id as usize]);
}
}

/// An edge bound to a workspace member takes the shape `Package::parse_dependency`
/// gives it (`workspace` tag carrying the member's path, literal kept), so the
/// differ compares equal against a fresh package.json parse. Other targets leave
/// the edge as parsed.
pub(crate) fn adopt_workspace_resolution(dep: &mut Dependency, res: &Resolution) {
if res.tag != ResolutionTag::Workspace {
return;
}
// Whole-struct assign so `DependencyVersion::Drop` frees any prior
// npm chain. SAFETY: `res.tag == Workspace` checked above.
let literal = dep.version.literal;
dep.version = DependencyVersion {
tag: DependencyVersionTag::Workspace,
literal,
value: DependencyVersionValue {
workspace: *res.workspace(),
},
};
}

fn dependency_resolution_failure(
dep: &Dependency,
pkg_path: Option<&[u8]>,
Expand Down
83 changes: 44 additions & 39 deletions src/install/pnpm.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ use bun_collections::StringArrayHashMap;
use bun_ast::{self, self as js_ast, E, Expr, ExprData, G};
use bun_core::strings;
use bun_semver as semver;
use bun_semver::query::token::Wildcard;
use bun_semver::{ExternalString, String};
use bun_sys::{self as sys, Fd};

Expand Down Expand Up @@ -45,6 +46,21 @@ macro_rules! string_bytes {
};
}

// Binds a root or workspace edge the way bun.lock's reader does. `workspace:*` rows and ranges
// pnpm linked to a member arrive here parsed from their literal, while the package.json rows the
// differ compares them against carry the member's path. A macro so callers can keep slices of
// `string_bytes` alive across the call.
macro_rules! bind_importer_dependency {
($lockfile:expr, $dep_id:expr, $pkg_id:expr) => {{
let pkg_id: PackageID = $pkg_id;
$lockfile.buffers.resolutions[$dep_id as usize] = pkg_id;
lockfile::bun_lock::adopt_workspace_resolution(
&mut $lockfile.buffers.dependencies[$dep_id as usize],
&$lockfile.packages.items_resolution()[pkg_id as usize],
);
}};
}

/// returns (peers_index, patch_hash_index)
/// https://github.com/pnpm/pnpm/blob/102d5a01ddabda1184b88119adccfbe956d30579/packages/dependency-path/src/index.ts#L9-L31
fn index_of_dep_path_suffix(path: &[u8]) -> (Option<usize>, Option<usize>) {
Expand Down Expand Up @@ -780,20 +796,16 @@ pub(crate) fn migrate_pnpm_lockfile<'a>(
let path_str = sbuf!(lockfile).append(importer_path)?;
lockfile.workspace_paths.put(name_hash, path_str)?;

if let Some(version_expr) = value.get(b"version") {
let Some(version_raw) = as_string(&version_expr) else {
return Err(invalid_pnpm_lockfile());
};
// Same rule as the `workspaces` array parser: a version that does not parse, or has a
// wildcard, leaves the member unversioned.
if let Some((version_raw, _)) = get_string(workspace_root, b"version") {
let version_str = sbuf!(lockfile).append(version_raw)?;

let parsed = semver::Version::parse(version_str.sliced(string_bytes!(lockfile)));
if !parsed.valid {
return Err(invalid_pnpm_lockfile());
if parsed.valid && parsed.wildcard == Wildcard::None {
lockfile
.workspace_versions
.put(name_hash, parsed.version.min())?;
}

lockfile
.workspace_versions
.put(name_hash, parsed.version.min())?;
}
}

Expand Down Expand Up @@ -1440,14 +1452,14 @@ pub(crate) fn migrate_pnpm_lockfile<'a>(
let mut path_buf = bun_paths::AutoAbsPath::init_top_level_dir();
let _ = path_buf.join(&[workspace_path]); // path-buffer overflow unreachable for bounded inputs
if let Some(workspace_pkg_id) = pkg_map.get(path_buf.slice()) {
lockfile.buffers.resolutions[dep_id as usize] = *workspace_pkg_id;
bind_importer_dependency!(lockfile, dep_id, *workspace_pkg_id);
continue;
}
}

let dep_name = dep.name.slice(string_buf);
if let Some(peer_pkg_id) = resolve_peer_like_bun_lock(lockfile, &dep) {
lockfile.buffers.resolutions[dep_id as usize] = peer_pkg_id;
bind_importer_dependency!(lockfile, dep_id, peer_pkg_id);
continue;
}
let Some(mut version_maybe_alias) = importer_versions.get(dep_name).map(|v| &**v)
Expand Down Expand Up @@ -1476,7 +1488,7 @@ pub(crate) fn migrate_pnpm_lockfile<'a>(
let mut path_buf = bun_paths::AutoAbsPath::init_top_level_dir();
let _ = path_buf.join(&[maybe_symlink_or_folder_or_workspace_path]); // path-buffer overflow unreachable for bounded inputs
if let Some(pkg_id) = pkg_map.get(path_buf.slice()) {
lockfile.buffers.resolutions[dep_id as usize] = *pkg_id;
bind_importer_dependency!(lockfile, dep_id, *pkg_id);
continue;
}
}
Expand All @@ -1492,7 +1504,7 @@ pub(crate) fn migrate_pnpm_lockfile<'a>(
));
};

lockfile.buffers.resolutions[dep_id as usize] = *pkg_id;
bind_importer_dependency!(lockfile, dep_id, *pkg_id);
}
}

Expand All @@ -1514,7 +1526,7 @@ pub(crate) fn migrate_pnpm_lockfile<'a>(
let string_buf = string_bytes!(lockfile);
let dep_name = dep.name.slice(string_buf);
if let Some(peer_pkg_id) = resolve_peer_like_bun_lock(lockfile, &dep) {
lockfile.buffers.resolutions[dep_id as usize] = peer_pkg_id;
bind_importer_dependency!(lockfile, dep_id, peer_pkg_id);
continue;
}
let Some(mut version_maybe_alias) = importer_versions.get(dep_name).map(|v| &**v)
Expand Down Expand Up @@ -1544,7 +1556,7 @@ pub(crate) fn migrate_pnpm_lockfile<'a>(
let mut path_buf = bun_paths::AutoAbsPath::init_top_level_dir();
let _ = path_buf.join(&[workspace_path, maybe_symlink_or_folder_or_workspace_path]); // path-buffer overflow unreachable for bounded inputs
if let Some(link_pkg_id) = pkg_map.get(path_buf.slice()) {
lockfile.buffers.resolutions[dep_id as usize] = *link_pkg_id;
bind_importer_dependency!(lockfile, dep_id, *link_pkg_id);
continue;
}
}
Expand All @@ -1560,7 +1572,7 @@ pub(crate) fn migrate_pnpm_lockfile<'a>(
));
};

lockfile.buffers.resolutions[dep_id as usize] = *res_pkg_id;
bind_importer_dependency!(lockfile, dep_id, *res_pkg_id);
}
}

Expand Down Expand Up @@ -1983,36 +1995,29 @@ fn append_importer_dependency(
specifier_str: &[u8],
behavior: dependency::Behavior,
) -> Result<(), ParseAppendDependenciesError> {
if strings::has_prefix(specifier_str, b"catalog:") {
let name_hash = semver::string::Builder::string_hash(name_str);
let name = sbuf!(lockfile).append_external_with_hash(name_str, name_hash)?;
let mut catalog_group_name_str = specifier_str[b"catalog:".len()..].trim_ascii();
if catalog_group_name_str == b"default" {
catalog_group_name_str = b"";
}
let catalog_group_name = sbuf!(lockfile).append(catalog_group_name_str)?;
// `CatalogMap::get` borrows `&self` and the whole lockfile, so move catalogs out for the call.
let catalogs = core::mem::take(&mut lockfile.catalogs);
let dep_result = catalogs.get(lockfile, catalog_group_name, name.value);
lockfile.catalogs = catalogs;
let Some(mut dep) = dep_result else {
// catalog is missing an entry in the "catalogs" object in the lockfile
// The row keeps its `catalog:` reference, as the package.json parser and the bun.lock reader
// keep theirs; the importer's own `version:` field binds it below. Only the entry's existence
// is checked here.
if let Some(catalog_name) =
strings::without_prefix_if_possible_comptime(specifier_str, b"catalog:")
{
let catalog_name = catalog_name.trim_ascii();
if lockfile
.catalogs
.find(string_bytes!(lockfile), catalog_name, name_str)
.is_none()
{
log.add_error_fmt(
None,
bun_ast::Loc::EMPTY,
format_args!(
"pnpm-lock.yaml catalog '{}' missing entry for dependency '{}'",
bstr::BStr::new(specifier_str[b"catalog:".len()..].trim_ascii()),
bstr::BStr::new(catalog_name),
bstr::BStr::new(name_str)
),
);
return Err(ParseAppendDependenciesError::PnpmLockfileMissingCatalogEntry);
};

dep.behavior = behavior;

lockfile.buffers.dependencies.push(dep);
return Ok(());
}
}

append_manifest_dependency(lockfile, log, name_str, specifier_str, behavior)
Expand Down
3 changes: 3 additions & 0 deletions test/cli/install/migration/__snapshots__/pnpm-lock-migration.test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ exports[`pnpm-lock.yaml migration pnpm workspace lockfile migration: workspace-p
},
"apps/web": {
"name": "@repo/web",
"version": "1.0.0",
"dependencies": {
"@repo/ui": "workspace:*",
"@repo/utils": "workspace:*",
Expand All @@ -40,12 +41,14 @@ exports[`pnpm-lock.yaml migration pnpm workspace lockfile migration: workspace-p
},
"packages/ui": {
"name": "@repo/ui",
"version": "1.0.0",
"dependencies": {
"react": "^18.2.0",
},
},
"packages/utils": {
"name": "@repo/utils",
"version": "1.0.0",
"dependencies": {
"lodash": "^4.17.21",
},
Expand Down
7 changes: 5 additions & 2 deletions test/cli/install/migration/__snapshots__/pnpm-migration-complete.test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -248,8 +248,8 @@ exports[`PNPM Migration Complete Test Suite comprehensive PNPM migration with al
"": {
"name": "catalogs-test",
"dependencies": {
"lodash": "4.17.21",
"react": "18.2.0",
"lodash": "catalog:tools",
"react": "catalog:",
},
},
},
Expand Down Expand Up @@ -363,19 +363,22 @@ exports[`PNPM Migration Complete Test Suite comprehensive PNPM migration with al
},
"packages/pkg1": {
"name": "@workspace/pkg1",
"version": "1.0.0",
"dependencies": {
"@workspace/pkg2": "workspace:*",
"lodash": "^4.17.21",
},
},
"packages/pkg2": {
"name": "@workspace/pkg2",
"version": "1.0.0",
"dependencies": {
"@workspace/pkg3": "workspace:*",
},
},
"packages/pkg3": {
"name": "@workspace/pkg3",
"version": "1.0.0",
"dependencies": {
"@workspace/pkg1": "workspace:*",
},
Expand Down
Loading