use std::any::Any;
use std::process::{Command, Stdio};
use std::sync::Arc;
use std::thread::JoinHandle;
use anyhow::{Result, bail};
use colored::Colorize;
use crate::chain::mux::{LineSink, StdioSink, prefix_width, render_prefix, spawn_readers};
use crate::resolver::{ResolutionOverrides, ResolveError, ScriptPolicy};
use crate::tool;
use crate::types::{DetectionWarning, PackageManager, ProjectContext, TaskRunner, version_matches};
pub(crate) fn install(
ctx: &ProjectContext,
overrides: &ResolutionOverrides,
frozen: bool,
) -> Result<i32> {
install_pms(ctx, overrides, frozen, None)
}
pub(crate) fn install_pms(
ctx: &ProjectContext,
overrides: &ResolutionOverrides,
frozen: bool,
_sink: super::WarningSink<'_>,
) -> Result<i32> {
if ctx.package_managers.is_empty() {
bail!("No package manager detected.");
}
let pms = select_install_pms(ctx, overrides)?;
warn_selected_collisions(ctx, &pms, overrides);
warn_unsupported_script_policy(&pms, overrides);
let _group = super::task_group(overrides, "install");
if let (Some(nv), Some(cur)) = (&ctx.node_version, &ctx.current_node)
&& !version_matches(&nv.expected, cur)
{
eprintln!(
"{} node expected {} ({}), current {}",
"warn:".yellow().bold(),
nv.expected,
nv.source,
cur,
);
suggest_version_switch(ctx);
}
if let [pm] = pms.as_slice() {
return install_single(ctx, *pm, frozen, overrides);
}
run_installs_parallel(ctx, &pms, frozen, overrides)
}
fn select_install_pms(
ctx: &ProjectContext,
overrides: &ResolutionOverrides,
) -> Result<Vec<PackageManager>, ResolveError> {
if let Some(o) = &overrides.pm {
return if ctx.package_managers.contains(&o.pm) {
Ok(vec![o.pm])
} else {
Err(ResolveError::PmOverrideNotDetected {
pm: o.pm,
origin: o.origin.clone(),
detected: ctx.package_managers.clone(),
})
};
}
if !overrides.install_pms.is_empty() {
let missing: Vec<PackageManager> = overrides
.install_pms
.iter()
.copied()
.filter(|pm| !ctx.package_managers.contains(pm))
.collect();
if !missing.is_empty() {
return Err(ResolveError::InstallPmsNotDetected {
missing,
detected: ctx.package_managers.clone(),
});
}
return Ok(ctx
.package_managers
.iter()
.copied()
.filter(|pm| overrides.install_pms.contains(pm))
.collect());
}
Ok(ctx.package_managers.clone())
}
fn warn_selected_collisions(
ctx: &ProjectContext,
pms: &[PackageManager],
overrides: &ResolutionOverrides,
) {
if overrides.no_warnings {
return;
}
for warning in &ctx.warnings {
if let Some(reduced) = still_colliding(warning, pms) {
eprintln!("{} {reduced}", "warn:".yellow().bold());
}
}
}
fn still_colliding(
warning: &DetectionWarning,
selected: &[PackageManager],
) -> Option<DetectionWarning> {
let DetectionWarning::InstallDirCollision { dir, pms: writers } = warning else {
return None;
};
let &dir = dir;
let still: Vec<PackageManager> = writers
.iter()
.copied()
.filter(|pm| selected.contains(pm))
.collect();
(still.len() >= 2).then_some(DetectionWarning::InstallDirCollision { dir, pms: still })
}
fn install_single(
ctx: &ProjectContext,
pm: PackageManager,
frozen: bool,
overrides: &ResolutionOverrides,
) -> Result<i32> {
eprintln!("{} {}", "installing with".dimmed(), pm.label().bold());
let mut cmd = build_install_command(ctx, pm, frozen, script_directive(overrides));
super::configure_command(&mut cmd, &ctx.root, overrides);
let status = cmd.status()?;
Ok(if status.success() {
0
} else {
super::exit_code(status)
})
}
fn run_installs_parallel(
ctx: &ProjectContext,
pms: &[PackageManager],
frozen: bool,
overrides: &ResolutionOverrides,
) -> Result<i32> {
use std::process::Child;
let names: Vec<&str> = pms.iter().map(|pm| pm.label()).collect();
let width = prefix_width(&names);
let colorize = colored::control::SHOULD_COLORIZE.should_colorize();
let sink: Arc<dyn LineSink> = Arc::new(StdioSink);
let directive = script_directive(overrides);
let mut children: Vec<(PackageManager, Child)> = Vec::with_capacity(pms.len());
let mut reader_handles = Vec::new();
let spawn_outcome: Result<()> = (|| {
for pm in pms {
eprintln!("{} {}", "installing with".dimmed(), pm.label().bold());
let mut cmd = build_install_command(ctx, *pm, frozen, directive);
super::configure_command(&mut cmd, &ctx.root, overrides);
cmd.stdin(Stdio::null())
.stdout(Stdio::piped())
.stderr(Stdio::piped());
let mut child = cmd.spawn()?;
let prefix = render_prefix(pm.label(), width, colorize);
let stdout: Box<dyn std::io::Read + Send> =
Box::new(child.stdout.take().expect("stdout piped"));
let stderr: Box<dyn std::io::Read + Send> =
Box::new(child.stderr.take().expect("stderr piped"));
reader_handles.extend(spawn_readers(
vec![
(prefix.clone(), false, stdout),
(prefix.clone(), true, stderr),
],
&sink,
));
children.push((*pm, child));
}
Ok(())
})();
if let Err(e) = spawn_outcome {
for (_, mut c) in children {
let _ = c.kill();
let _ = c.wait();
}
for h in reader_handles {
join_reader_thread(h);
}
return Err(e);
}
let mut first_failure: Option<i32> = None;
for (_, mut child) in children {
let status = child.wait()?;
if !status.success() {
first_failure.get_or_insert_with(|| super::exit_code(status));
}
}
for h in reader_handles {
join_reader_thread(h);
}
Ok(first_failure.unwrap_or(0))
}
fn join_reader_thread(handle: JoinHandle<()>) {
if let Err(payload) = handle.join() {
eprintln!(
"warn: install output reader thread panicked: {}",
panic_payload(&*payload),
);
}
}
fn panic_payload(payload: &(dyn Any + Send)) -> String {
if let Some(message) = payload.downcast_ref::<&str>() {
return (*message).to_string();
}
if let Some(message) = payload.downcast_ref::<String>() {
return message.clone();
}
"non-string panic payload".to_string()
}
fn build_install_command(
ctx: &ProjectContext,
pm: PackageManager,
frozen: bool,
scripts: tool::ScriptDirective,
) -> Command {
match pm {
PackageManager::Npm => tool::npm::install_cmd(frozen, scripts),
PackageManager::Yarn => tool::yarn::install_cmd(&ctx.root, frozen, scripts),
PackageManager::Pnpm => tool::pnpm::install_cmd(frozen, scripts),
PackageManager::Bun => tool::bun::install_cmd(frozen, scripts),
PackageManager::Cargo => tool::cargo_pm::install_cmd(frozen),
PackageManager::Deno => tool::deno::install_cmd(scripts),
PackageManager::Uv => tool::uv::install_cmd(frozen),
PackageManager::Poetry => tool::poetry::install_cmd(),
PackageManager::Pipenv => tool::pipenv::install_cmd(frozen),
PackageManager::Go => tool::go_pm::install_cmd(),
PackageManager::Bundler => tool::bundler::install_cmd(),
PackageManager::Composer => tool::composer::install_cmd(scripts),
}
}
const fn script_directive(overrides: &ResolutionOverrides) -> tool::ScriptDirective {
match overrides.script_policy {
ScriptPolicy::Default => tool::ScriptDirective::Default,
ScriptPolicy::Deny => tool::ScriptDirective::Deny,
ScriptPolicy::Allow => tool::ScriptDirective::ForceOn,
}
}
const fn deny_scripts(overrides: &ResolutionOverrides) -> bool {
matches!(overrides.script_policy, ScriptPolicy::Deny)
}
const fn force_scripts(overrides: &ResolutionOverrides) -> bool {
matches!(overrides.script_policy, ScriptPolicy::Allow)
}
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
enum DenySupport {
ViaFlag,
DefaultDeny,
Unsupported,
}
const fn deny_support(pm: PackageManager) -> DenySupport {
match pm {
PackageManager::Npm
| PackageManager::Yarn
| PackageManager::Pnpm
| PackageManager::Bun
| PackageManager::Composer => DenySupport::ViaFlag,
PackageManager::Deno => DenySupport::DefaultDeny,
PackageManager::Cargo
| PackageManager::Uv
| PackageManager::Poetry
| PackageManager::Pipenv
| PackageManager::Go
| PackageManager::Bundler => DenySupport::Unsupported,
}
}
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
enum ForceSupport {
ViaFlag,
AlreadyRuns,
NotExpressible,
}
const fn force_support(pm: PackageManager) -> ForceSupport {
match pm {
PackageManager::Npm | PackageManager::Deno | PackageManager::Yarn => ForceSupport::ViaFlag,
PackageManager::Bun | PackageManager::Pnpm => ForceSupport::NotExpressible,
PackageManager::Composer
| PackageManager::Cargo
| PackageManager::Uv
| PackageManager::Poetry
| PackageManager::Pipenv
| PackageManager::Go
| PackageManager::Bundler => ForceSupport::AlreadyRuns,
}
}
fn warn_unsupported_script_policy(pms: &[PackageManager], overrides: &ResolutionOverrides) {
for pm in unsupported_deny_managers(pms, overrides) {
eprintln!(
"{} {} cannot skip install scripts; deny policy not applied to it",
"warn:".yellow().bold(),
pm.label(),
);
}
for pm in unforceable_managers(pms, overrides) {
let allowlist = match pm {
PackageManager::Pnpm => "pnpm.onlyBuiltDependencies",
PackageManager::Bun => "trustedDependencies",
_ => "a manifest allowlist",
};
eprintln!(
"{} {} cannot force install scripts on; it denies dependency build scripts by default \
and only the {} allowlist (which runner won't write) re-enables them",
"warn:".yellow().bold(),
pm.label(),
allowlist,
);
}
}
fn unsupported_deny_managers(
pms: &[PackageManager],
overrides: &ResolutionOverrides,
) -> Vec<PackageManager> {
if !deny_scripts(overrides) {
return Vec::new();
}
pms.iter()
.copied()
.filter(|pm| deny_support(*pm) == DenySupport::Unsupported)
.collect()
}
fn unforceable_managers(
pms: &[PackageManager],
overrides: &ResolutionOverrides,
) -> Vec<PackageManager> {
if !force_scripts(overrides) {
return Vec::new();
}
pms.iter()
.copied()
.filter(|pm| force_support(*pm) == ForceSupport::NotExpressible)
.collect()
}
fn suggest_version_switch(ctx: &ProjectContext) {
let hint = if ctx
.node_version
.as_ref()
.is_some_and(|nv| nv.source == ".nvmrc")
{
"nvm use"
} else if ctx.task_runners.contains(&TaskRunner::Mise) {
"mise install"
} else {
"switch to the expected Node version"
};
eprintln!(" {} {}", "hint:".dimmed(), hint);
}
#[cfg(test)]
mod tests {
use std::collections::HashMap;
use std::path::PathBuf;
use super::{
DenySupport, ForceSupport, build_install_command, deny_support, force_support,
script_directive, select_install_pms, unforceable_managers, unsupported_deny_managers,
warn_unsupported_script_policy,
};
use crate::resolver::{
OverrideOrigin, PmOverride, ResolutionOverrides, ResolveError, ScriptPolicy,
};
use crate::tool::ScriptDirective;
use crate::types::{Ecosystem, PackageManager, ProjectContext};
fn context(pms: Vec<PackageManager>) -> ProjectContext {
ProjectContext {
root: PathBuf::from("/tmp/test"),
package_managers: pms,
task_runners: Vec::new(),
tasks: Vec::new(),
node_version: None,
current_node: None,
is_monorepo: false,
warnings: Vec::new(),
}
}
fn override_pm(pm: PackageManager, origin: OverrideOrigin) -> ResolutionOverrides {
ResolutionOverrides {
pm: Some(PmOverride { pm, origin }),
..Default::default()
}
}
#[test]
fn no_override_installs_with_every_detected_pm() {
let ctx = context(vec![PackageManager::Bun, PackageManager::Deno]);
let pms = select_install_pms(&ctx, &ResolutionOverrides::default())
.expect("default selection should succeed");
assert_eq!(pms, vec![PackageManager::Bun, PackageManager::Deno]);
}
#[test]
fn detected_override_installs_with_it_alone() {
let ctx = context(vec![PackageManager::Bun, PackageManager::Deno]);
let overrides = override_pm(PackageManager::Bun, OverrideOrigin::EnvVar);
let pms = select_install_pms(&ctx, &overrides).expect("detected override should filter");
assert_eq!(pms, vec![PackageManager::Bun]);
}
#[test]
fn undetected_override_errors_with_origin_and_detected_list() {
let ctx = context(vec![PackageManager::Cargo]);
let overrides = override_pm(PackageManager::Npm, OverrideOrigin::EnvVar);
let err = select_install_pms(&ctx, &overrides).expect_err("undetected override must error");
assert!(matches!(err, ResolveError::PmOverrideNotDetected { .. }));
let msg = format!("{err}");
assert!(msg.contains("RUNNER_PM"), "should name the source: {msg}");
assert!(msg.contains("cargo"), "should list detected PMs: {msg}");
}
#[test]
fn undetected_cli_override_names_the_flag() {
let ctx = context(vec![PackageManager::Cargo]);
let overrides = override_pm(PackageManager::Npm, OverrideOrigin::CliFlag);
let err = select_install_pms(&ctx, &overrides).expect_err("undetected override must error");
let msg = format!("{err}");
assert!(msg.contains("--pm"), "should name the flag: {msg}");
}
#[test]
fn still_colliding_clears_once_filtered_to_single_writer() {
use super::still_colliding;
use crate::types::DetectionWarning;
let warning = DetectionWarning::InstallDirCollision {
dir: "node_modules",
pms: vec![PackageManager::Bun, PackageManager::Deno],
};
assert!(still_colliding(&warning, &[PackageManager::Bun]).is_none());
let reduced = still_colliding(&warning, &[PackageManager::Bun, PackageManager::Deno])
.expect("two writers still collide");
match reduced {
DetectionWarning::InstallDirCollision { dir, pms } => {
assert_eq!(dir, "node_modules");
assert_eq!(pms, vec![PackageManager::Bun, PackageManager::Deno]);
}
other => panic!("expected collision, got {other:?}"),
}
}
#[test]
fn install_pms_allowlist_filters_to_listed_detected_pms() {
let ctx = context(vec![
PackageManager::Bun,
PackageManager::Deno,
PackageManager::Cargo,
]);
let overrides = ResolutionOverrides {
install_pms: vec![PackageManager::Bun],
..Default::default()
};
let pms = select_install_pms(&ctx, &overrides).expect("allowlist should filter");
assert_eq!(pms, vec![PackageManager::Bun]);
}
#[test]
fn install_pms_allowlist_preserves_detection_order() {
let ctx = context(vec![
PackageManager::Bun,
PackageManager::Cargo,
PackageManager::Uv,
]);
let overrides = ResolutionOverrides {
install_pms: vec![PackageManager::Uv, PackageManager::Bun],
..Default::default()
};
let pms = select_install_pms(&ctx, &overrides).expect("allowlist should filter");
assert_eq!(pms, vec![PackageManager::Bun, PackageManager::Uv]);
}
#[test]
fn install_pms_undetected_entry_errors() {
let ctx = context(vec![PackageManager::Bun]);
let overrides = ResolutionOverrides {
install_pms: vec![PackageManager::Bun, PackageManager::Pnpm],
..Default::default()
};
let err = select_install_pms(&ctx, &overrides).expect_err("undetected entry must error");
assert!(matches!(err, ResolveError::InstallPmsNotDetected { .. }));
let msg = format!("{err}");
assert!(msg.contains("pnpm"), "names the missing PM: {msg}");
assert!(msg.contains("bun"), "lists detected: {msg}");
}
#[test]
fn pm_override_wins_over_install_pms_allowlist() {
let ctx = context(vec![PackageManager::Bun, PackageManager::Deno]);
let mut overrides = override_pm(PackageManager::Deno, OverrideOrigin::EnvVar);
overrides.install_pms = vec![PackageManager::Bun];
let pms = select_install_pms(&ctx, &overrides).expect("override wins");
assert_eq!(pms, vec![PackageManager::Deno]);
}
#[test]
fn empty_install_pms_installs_with_every_detected_pm() {
let ctx = context(vec![PackageManager::Bun, PackageManager::Cargo]);
let pms = select_install_pms(&ctx, &ResolutionOverrides::default())
.expect("no allowlist installs all");
assert_eq!(pms, vec![PackageManager::Bun, PackageManager::Cargo]);
}
#[test]
fn ecosystem_config_override_does_not_filter_installs() {
let ctx = context(vec![PackageManager::Bun, PackageManager::Cargo]);
let mut pm_by_ecosystem = HashMap::new();
pm_by_ecosystem.insert(
Ecosystem::Node,
PmOverride {
pm: PackageManager::Pnpm,
origin: OverrideOrigin::ConfigFile {
path: PathBuf::from("/tmp/test/runner.toml"),
},
},
);
let overrides = ResolutionOverrides {
pm_by_ecosystem,
..Default::default()
};
let pms = select_install_pms(&ctx, &overrides).expect("config must not filter installs");
assert_eq!(pms, vec![PackageManager::Bun, PackageManager::Cargo]);
}
fn install_argv(pm: PackageManager, scripts: ScriptDirective) -> Vec<String> {
let ctx = context(vec![pm]);
build_install_command(&ctx, pm, false, scripts)
.get_args()
.map(|arg| arg.to_string_lossy().into_owned())
.collect()
}
#[test]
fn deny_support_classifies_every_pm() {
for pm in [
PackageManager::Npm,
PackageManager::Yarn,
PackageManager::Pnpm,
PackageManager::Bun,
PackageManager::Composer,
] {
assert_eq!(
deny_support(pm),
DenySupport::ViaFlag,
"{} via flag",
pm.label()
);
}
assert_eq!(deny_support(PackageManager::Deno), DenySupport::DefaultDeny);
for pm in [
PackageManager::Cargo,
PackageManager::Uv,
PackageManager::Poetry,
PackageManager::Pipenv,
PackageManager::Go,
PackageManager::Bundler,
] {
assert_eq!(
deny_support(pm),
DenySupport::Unsupported,
"{} unsupported",
pm.label(),
);
}
}
#[test]
fn force_support_classifies_every_pm() {
for pm in [
PackageManager::Npm,
PackageManager::Deno,
PackageManager::Yarn,
] {
assert_eq!(
force_support(pm),
ForceSupport::ViaFlag,
"{} via flag",
pm.label(),
);
}
for pm in [PackageManager::Bun, PackageManager::Pnpm] {
assert_eq!(
force_support(pm),
ForceSupport::NotExpressible,
"{} not expressible",
pm.label(),
);
}
for pm in [
PackageManager::Composer,
PackageManager::Cargo,
PackageManager::Uv,
PackageManager::Poetry,
PackageManager::Pipenv,
PackageManager::Go,
PackageManager::Bundler,
] {
assert_eq!(
force_support(pm),
ForceSupport::AlreadyRuns,
"{} already runs",
pm.label(),
);
}
}
#[test]
fn script_directive_lowers_every_policy() {
let directive = |policy| {
script_directive(&ResolutionOverrides {
script_policy: policy,
..ResolutionOverrides::default()
})
};
assert_eq!(directive(ScriptPolicy::Default), ScriptDirective::Default);
assert_eq!(directive(ScriptPolicy::Deny), ScriptDirective::Deny);
assert_eq!(directive(ScriptPolicy::Allow), ScriptDirective::ForceOn);
}
#[test]
fn deny_appends_skip_flag_for_flag_managers() {
assert_eq!(
install_argv(PackageManager::Npm, ScriptDirective::Deny),
["install", "--ignore-scripts"]
);
assert_eq!(
install_argv(PackageManager::Pnpm, ScriptDirective::Deny),
["install", "--ignore-scripts"]
);
assert_eq!(
install_argv(PackageManager::Bun, ScriptDirective::Deny),
["install", "--ignore-scripts"]
);
assert_eq!(
install_argv(PackageManager::Composer, ScriptDirective::Deny),
["install", "--no-scripts"]
);
}
#[test]
fn deny_is_noop_for_default_deny_and_unsupported_managers() {
assert_eq!(
install_argv(PackageManager::Deno, ScriptDirective::Deny),
["install"]
);
assert_eq!(
install_argv(PackageManager::Cargo, ScriptDirective::Deny),
["fetch"]
);
}
#[test]
fn force_on_appends_flag_for_flag_managers() {
assert_eq!(
install_argv(PackageManager::Npm, ScriptDirective::ForceOn),
["install", "--no-ignore-scripts"]
);
assert_eq!(
install_argv(PackageManager::Deno, ScriptDirective::ForceOn),
["install", "--allow-scripts"]
);
}
#[test]
fn force_on_is_noop_for_already_runs_and_unforceable_managers() {
assert_eq!(
install_argv(PackageManager::Composer, ScriptDirective::ForceOn),
["install"]
);
assert_eq!(
install_argv(PackageManager::Cargo, ScriptDirective::ForceOn),
["fetch"]
);
assert_eq!(
install_argv(PackageManager::Bun, ScriptDirective::ForceOn),
["install"]
);
assert_eq!(
install_argv(PackageManager::Pnpm, ScriptDirective::ForceOn),
["install"]
);
}
#[test]
fn default_adds_no_skip_flag() {
assert_eq!(
install_argv(PackageManager::Npm, ScriptDirective::Default),
["install"]
);
assert_eq!(
install_argv(PackageManager::Composer, ScriptDirective::Default),
["install"]
);
}
#[test]
fn deny_disclosure_fires_for_unsupported_pms_regardless_of_no_warnings() {
let pms = [PackageManager::Cargo, PackageManager::Npm];
assert!(unsupported_deny_managers(&pms, &ResolutionOverrides::default()).is_empty());
let denying = ResolutionOverrides {
script_policy: ScriptPolicy::Deny,
no_warnings: true,
..ResolutionOverrides::default()
};
assert_eq!(
unsupported_deny_managers(&pms, &denying),
vec![PackageManager::Cargo]
);
warn_unsupported_script_policy(&pms, &denying);
}
#[test]
fn force_disclosure_fires_for_unforceable_pms_regardless_of_no_warnings() {
let pms = [
PackageManager::Pnpm,
PackageManager::Npm,
PackageManager::Bun,
];
assert!(unforceable_managers(&pms, &ResolutionOverrides::default()).is_empty());
let forcing = ResolutionOverrides {
script_policy: ScriptPolicy::Allow,
no_warnings: true,
..ResolutionOverrides::default()
};
assert_eq!(
unforceable_managers(&pms, &forcing),
vec![PackageManager::Pnpm, PackageManager::Bun]
);
warn_unsupported_script_policy(&pms, &forcing);
}
}