fix(install): peer/dev/optional = false lockfile fix (#15874)

Co-authored-by: Jarred Sumner <[email protected]>

docs/cli/bun-install.md

@@ -57,12 +57,15 @@ frozenLockfile = false
 dryRun = true
 
 # Install optionalDependencies (default: true)
+# Setting this to false is equivalent to the `--omit=optional` CLI argument
 optional = true
 
 # Install local devDependencies (default: true)
+# Setting this to false is equivalent to the `--omit=dev` CLI argument
 dev = true
 
 # Install peerDependencies (default: true)
+# Setting this to false is equivalent to the `--omit=peer` CLI argument
 peer = true
 
 # Max number of concurrent lifecycle scripts (default: (cpu count or GOMAXPROCS) x2)

docs/cli/install.md

@@ -130,6 +130,20 @@ $ bun install --frozen-lockfile
 
 For more information on Bun's binary lockfile `bun.lockb`, refer to [Package manager > Lockfile](https://bun.sh/docs/install/lockfile).
 
+## Omitting dependencies
+
+To omit dev, peer, or optional dependencies use the `--omit` flag.
+
+```bash
+# Exclude "devDependencies" from the installation. This will apply to the
+# root package and workspaces if they exist. Transitive dependencies will
+# not have "devDependencies".
+$ bun install --omit dev
+
+# Install only dependencies from "dependencies"
+$ bun install --omit=dev --omit=peer --omit=optional
+```
+
 ## Dry run
 
 To perform a dry run (i.e. don't actually install anything):

docs/install/index.md

@@ -55,6 +55,13 @@ To install dependencies without allowing changes to lockfile (useful on CI):
 $ bun install --frozen-lockfile
 ```
 
+To exclude dependency types from installing, use `--omit` with `dev`, `optional`, or `peer`:
+
+```bash
+# Disable devDependencies and optionalDependencies
+$ bun install --omit=dev --omit=optional
+```
+
 To perform a dry run (i.e. don't actually install anything):
 
 ```bash

src/ini.zig

@@ -971,6 +971,68 @@ pub fn loadNpmrc(
         }
     }
 
+    if (out.asProperty("omit")) |omit| {
+        switch (omit.expr.data) {
+            .e_string => |str| {
+                if (str.eqlComptime("dev")) {
+                    install.save_dev = false;
+                } else if (str.eqlComptime("peer")) {
+                    install.save_peer = false;
+                } else if (str.eqlComptime("optional")) {
+                    install.save_optional = false;
+                }
+            },
+            .e_array => |arr| {
+                for (arr.items.slice()) |item| {
+                    switch (item.data) {
+                        .e_string => |str| {
+                            if (str.eqlComptime("dev")) {
+                                install.save_dev = false;
+                            } else if (str.eqlComptime("peer")) {
+                                install.save_peer = false;
+                            } else if (str.eqlComptime("optional")) {
+                                install.save_optional = false;
+                            }
+                        },
+                        else => {},
+                    }
+                }
+            },
+            else => {},
+        }
+    }
+
+    if (out.asProperty("include")) |omit| {
+        switch (omit.expr.data) {
+            .e_string => |str| {
+                if (str.eqlComptime("dev")) {
+                    install.save_dev = true;
+                } else if (str.eqlComptime("peer")) {
+                    install.save_peer = true;
+                } else if (str.eqlComptime("optional")) {
+                    install.save_optional = true;
+                }
+            },
+            .e_array => |arr| {
+                for (arr.items.slice()) |item| {
+                    switch (item.data) {
+                        .e_string => |str| {
+                            if (str.eqlComptime("dev")) {
+                                install.save_dev = true;
+                            } else if (str.eqlComptime("peer")) {
+                                install.save_peer = true;
+                            } else if (str.eqlComptime("optional")) {
+                                install.save_optional = true;
+                            }
+                        },
+                        else => {},
+                    }
+                }
+            },
+            else => {},
+        }
+    }
+
     var registry_map = install.scoped orelse bun.Schema.Api.NpmRegistryMap{};
 
     // Process scopes

src/install/bun.lock.zig

@@ -246,11 +246,7 @@ pub const Stringifier = struct {
     //     _ = this;
     // }
 
-    pub fn saveFromBinary(allocator: std.mem.Allocator, lockfile: *const BinaryLockfile) OOM!string {
-        var writer_buf = MutableString.initEmpty(allocator);
-        var buffered_writer = writer_buf.bufferedWriter();
-        var writer = buffered_writer.writer();
-
+    pub fn saveFromBinary(allocator: std.mem.Allocator, lockfile: *const BinaryLockfile, writer: anytype) @TypeOf(writer).Error!void {
         const buf = lockfile.buffers.string_bytes.items;
         const deps_buf = lockfile.buffers.dependencies.items;
         const resolution_buf = lockfile.buffers.resolutions.items;
@@ -594,15 +590,17 @@ pub const Stringifier = struct {
                         TreeDepsSortCtx.isLessThan,
                     );
 
-                    // first index is resolution for all dependency types
-                    // npm         -> [ "name@version", registry or "" (default), deps..., integrity, ... ]
-                    // symlink     -> [ "name@link:path", deps..., ... ]
-                    // folder      -> [ "name@path", deps..., ... ]
-                    // workspace   -> [ "name@workspace:path", version or "", deps..., ... ]
-                    // tarball     -> [ "name@tarball", deps..., ... ]
-                    // root        -> [ "name@root:", bins ]
-                    // git         -> [ "name@git+repo", deps..., ... ]
-                    // github      -> [ "name@github:user/repo", deps..., ... ]
+                    // INFO = { prod/dev/optional/peer dependencies, os, cpu, libc (TODO), bin, binDir }
+
+                    // first index is resolution for each type of package
+                    // npm         -> [ "name@version", registry (TODO: remove if default), INFO, integrity]
+                    // symlink     -> [ "name@link:path", INFO ]
+                    // folder      -> [ "name@file:path", INFO ]
+                    // workspace   -> [ "name@workspace:path", INFO ]
+                    // tarball     -> [ "name@tarball", INFO ]
+                    // root        -> [ "name@root:", { bin, binDir } ]
+                    // git         -> [ "name@git+repo", INFO, .bun-tag string (TODO: remove this) ]
+                    // github      -> [ "name@github:user/repo", INFO, .bun-tag string (TODO: remove this) ]
 
                     switch (res.tag) {
                         .root => {
@@ -716,9 +714,6 @@ pub const Stringifier = struct {
         }
         try decIndent(writer, indent);
         try writer.writeAll("}\n");
-
-        try buffered_writer.flush();
-        return writer_buf.list.items;
     }
 
     /// Writes a single line object. Contains dependencies, os, cpu, libc (soon), and bin
@@ -1218,21 +1213,26 @@ pub fn parseIntoBinaryLockfile(
     var optional_peers_buf: std.AutoHashMapUnmanaged(u64, void) = .{};
     defer optional_peers_buf.deinit(allocator);
 
-    if (maybe_root_pkg) |root_pkg| {
-        const maybe_name = if (root_pkg.get("name")) |name| name.asString(allocator) orelse {
+    const root_pkg_exr = maybe_root_pkg orelse {
+        try log.addError(source, workspaces.loc, "Expected root package");
+        return error.InvalidWorkspaceObject;
+    };
+
+    {
+        const maybe_name = if (root_pkg_exr.get("name")) |name| name.asString(allocator) orelse {
             try log.addError(source, name.loc, "Expected a string");
             return error.InvalidWorkspaceObject;
         } else null;
 
-        const off, var len = try parseAppendDependencies(lockfile, allocator, &root_pkg, &string_buf, log, source, &optional_peers_buf);
+        const off, var len = try parseAppendDependencies(lockfile, allocator, &root_pkg_exr, &string_buf, log, source, &optional_peers_buf);
 
-        var pkg: BinaryLockfile.Package = .{};
-        pkg.meta.id = 0;
+        var root_pkg: BinaryLockfile.Package = .{};
+        root_pkg.meta.id = 0;
 
         if (maybe_name) |name| {
             const name_hash = String.Builder.stringHash(name);
-            pkg.name = try string_buf.appendWithHash(name, name_hash);
-            pkg.name_hash = name_hash;
+            root_pkg.name = try string_buf.appendWithHash(name, name_hash);
+            root_pkg.name_hash = name_hash;
         }
 
         workspaces: for (lockfile.workspace_paths.values()) |workspace_path| {
@@ -1262,15 +1262,12 @@ pub fn parseIntoBinaryLockfile(
             }
         }
 
-        pkg.dependencies = .{ .off = off, .len = len };
-        pkg.resolutions = .{ .off = off, .len = len };
+        root_pkg.dependencies = .{ .off = off, .len = len };
+        root_pkg.resolutions = .{ .off = off, .len = len };
 
-        pkg.meta.id = 0;
-        try lockfile.packages.append(allocator, pkg);
-        try lockfile.getOrPutID(0, pkg.name_hash);
-    } else {
-        try log.addError(source, workspaces.loc, "Expected root package");
-        return error.InvalidWorkspaceObject;
+        root_pkg.meta.id = 0;
+        try lockfile.packages.append(allocator, root_pkg);
+        try lockfile.getOrPutID(0, root_pkg.name_hash);
     }
 
     var pkg_map = bun.StringArrayHashMap(PackageID).init(allocator);
@@ -1491,9 +1488,15 @@ pub fn parseIntoBinaryLockfile(
                 const dep_id: DependencyID = @intCast(_dep_id);
                 const dep = lockfile.buffers.dependencies.items[dep_id];
 
-                if (pkg_map.get(dep.name.slice(lockfile.buffers.string_bytes.items))) |res_pkg_id| {
-                    lockfile.buffers.resolutions.items[dep_id] = res_pkg_id;
-                }
+                const res_pkg_id = pkg_map.get(dep.name.slice(lockfile.buffers.string_bytes.items)) orelse {
+                    if (dep.behavior.optional) {
+                        continue;
+                    }
+                    try dependencyResolutionFailure(&dep, null, allocator, lockfile.buffers.string_bytes.items, source, log, root_pkg_exr.loc);
+                    return error.InvalidPackageInfo;
+                };
+
+                lockfile.buffers.resolutions.items[dep_id] = res_pkg_id;
             }
 
             // TODO(dylan-conway) should we handle workspaces separately here for custom hoisting
@@ -1533,10 +1536,10 @@ pub fn parseIntoBinaryLockfile(
                     }
 
                     if (offset == 0) {
-                        if (dep.behavior.isOptionalPeer()) {
+                        if (dep.behavior.optional) {
                             continue :deps;
                         }
-                        try log.addError(source, key.loc, "Unable to resolve dependencies for package");
+                        try dependencyResolutionFailure(&dep, pkg_path, allocator, lockfile.buffers.string_bytes.items, source, log, key.loc);
                         return error.InvalidPackageInfo;
                     }
 
@@ -1584,7 +1587,7 @@ pub fn parseIntoBinaryLockfile(
             }
         }
 
-        lockfile.hoist(log, if (manager) |pm| pm.options.local_package_features.dev_dependencies else true) catch |err| {
+        lockfile.hoist(log, .resolvable, {}) catch |err| {
             switch (err) {
                 error.OutOfMemory => |oom| return oom,
                 else => {
@@ -1599,6 +1602,32 @@ pub fn parseIntoBinaryLockfile(
     lockfile.initEmpty(allocator);
 }
 
+fn dependencyResolutionFailure(dep: *const Dependency, pkg_path: ?string, allocator: std.mem.Allocator, buf: string, source: *const logger.Source, log: *logger.Log, loc: logger.Loc) OOM!void {
+    const behavior_str = if (dep.behavior.isDev())
+        "dev"
+    else if (dep.behavior.isOptional())
+        "optional"
+    else if (dep.behavior.isPeer())
+        "peer"
+    else if (dep.behavior.isWorkspaceOnly())
+        "workspace"
+    else
+        "prod";
+
+    if (pkg_path) |path| {
+        try log.addErrorFmt(source, loc, allocator, "Failed to resolve {s} dependency '{s}' for package '{s}'", .{
+            behavior_str,
+            dep.name.slice(buf),
+            path,
+        });
+    } else {
+        try log.addErrorFmt(source, loc, allocator, "Failed to resolve root {s} dependency '{s}'", .{
+            behavior_str,
+            dep.name.slice(buf),
+        });
+    }
+}
+
 fn parseAppendDependencies(
     lockfile: *BinaryLockfile,
     allocator: std.mem.Allocator,

src/install/extract_tarball.zig

@@ -53,8 +53,8 @@ pub fn buildURL(
     full_name_: strings.StringOrTinyString,
     version: Semver.Version,
     string_buf: []const u8,
-) !string {
-    return try buildURLWithPrinter(
+) OOM!string {
+    return buildURLWithPrinter(
         registry_,
         full_name_,
         version,