mirror of
https://github.com/jparkerweb/plan2code.git
synced 2026-11-16 20:45:33 -08:00
175 lines
7.0 KiB
Rust
175 lines
7.0 KiB
Rust
//! The Node 18+ check (FR-13). The console and the skills run on Node, so the
|
|||
|
|
//! app refuses to start without it and says what to install.
|
||
|
|
//!
|
||
|
|
//! An app started from the Dock, Finder or a `.desktop` file, rather than a
|
||
|
|
//! terminal, inherits a minimal PATH: none of nvm, Homebrew or Volta's
|
||
|
|
//! directories, which a login shell's own profile adds. `resolved_path`
|
||
|
|
//! (Task 9.9) is what every process this app spawns (the console, an update,
|
||
|
|
//! an agent CLI) should run with, not the bare inherited one; `node_check`,
|
||
|
|
//! `console_supervisor`, `versions` and `agents` all use it.
|
||
|
|
|
||
|
|
use std::process::Command;
|
||
|
|
use std::sync::OnceLock;
|
||
|
|
|
||
|
|
pub const MIN_NODE_MAJOR: u32 = 18;
|
||
|
|
|
||
|
|
#[derive(Debug, PartialEq, Eq)]
|
||
|
|
pub enum NodeStatus {
|
||
|
|
Ok(String),
|
||
|
|
TooOld(String),
|
||
|
|
Missing,
|
||
|
|
}
|
||
|
|
|
||
|
|
/// Major version from `node --version` output such as `v20.11.1`.
|
||
|
|
pub fn parse_node_major(output: &str) -> Option<u32> {
|
||
|
|
let text = output.trim().strip_prefix('v')?;
|
||
|
|
text.split('.').next()?.parse().ok()
|
||
|
|
}
|
||
|
|
|
||
|
|
/// Classify the output of `node --version`.
|
||
|
|
pub fn classify(output: &str) -> NodeStatus {
|
||
|
|
let version = output.trim().to_string();
|
||
|
|
match parse_node_major(output) {
|
||
|
|
Some(major) if major >= MIN_NODE_MAJOR => NodeStatus::Ok(version),
|
||
|
|
Some(_) => NodeStatus::TooOld(version),
|
||
|
|
None => NodeStatus::Missing,
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
pub fn check_node() -> NodeStatus {
|
||
|
|
match Command::new("node").env("PATH", resolved_path()).arg("--version").output() {
|
||
|
|
Ok(out) if out.status.success() => classify(&String::from_utf8_lossy(&out.stdout)),
|
||
|
|
_ => NodeStatus::Missing,
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
/// `--node <path>` or `--node=<path>`: the launcher's own `node`, already
|
||
|
|
/// resolved under the person's real shell. Only its directory is used here,
|
||
|
|
/// so it joins the PATH the normal way rather than replacing every lookup.
|
||
|
|
fn node_override_dir(args: &[String]) -> Option<String> {
|
||
|
|
let mut i = 1; // args[0] is the program name
|
||
|
|
while i < args.len() {
|
||
|
|
let value = if args[i] == "--node" {
|
||
|
|
args.get(i + 1).cloned()
|
||
|
|
} else {
|
||
|
|
args[i].strip_prefix("--node=").map(str::to_string)
|
||
|
|
};
|
||
|
|
if let Some(path) = value.filter(|v| !v.is_empty()) {
|
||
|
|
return std::path::Path::new(&path).parent().map(|dir| dir.to_string_lossy().into_owned());
|
||
|
|
}
|
||
|
|
i += 1;
|
||
|
|
}
|
||
|
|
None
|
||
|
|
}
|
||
|
|
|
||
|
|
/// The login shell's own PATH: running it as a login shell sources
|
||
|
|
/// `.zprofile`, `.bash_profile` or `.profile`, which a GUI launch never does.
|
||
|
|
/// Windows sets PATH outside any shell's startup files, so this is unix only.
|
||
|
|
#[cfg(unix)]
|
||
|
|
fn login_shell_path() -> Option<String> {
|
||
|
|
let shell = std::env::var("SHELL").unwrap_or_else(|_| "/bin/sh".to_string());
|
||
|
|
let out = Command::new(&shell).args(["-lc", "echo $PATH"]).output().ok()?;
|
||
|
|
let path = String::from_utf8_lossy(&out.stdout).trim().to_string();
|
||
|
|
(out.status.success() && !path.is_empty()).then_some(path)
|
||
|
|
}
|
||
|
|
|
||
|
|
/// The PATH every process this app spawns should run with: an explicit
|
||
|
|
/// `--node`'s directory first, then (macOS and Linux) the login shell's own
|
||
|
|
/// PATH, then this process's own PATH, each included only once. Resolved
|
||
|
|
/// once per launch: none of these change while the app runs.
|
||
|
|
pub fn resolved_path() -> &'static str {
|
||
|
|
static PATH: OnceLock<String> = OnceLock::new();
|
||
|
|
PATH.get_or_init(|| {
|
||
|
|
let args: Vec<String> = std::env::args().collect();
|
||
|
|
let inherited = std::env::var("PATH").unwrap_or_default();
|
||
|
|
let mut parts = Vec::new();
|
||
|
|
if let Some(dir) = node_override_dir(&args) {
|
||
|
|
parts.push(dir);
|
||
|
|
}
|
||
|
|
#[cfg(unix)]
|
||
|
|
if let Some(login) = login_shell_path() {
|
||
|
|
parts.push(login);
|
||
|
|
}
|
||
|
|
if !inherited.is_empty() {
|
||
|
|
parts.push(inherited);
|
||
|
|
}
|
||
|
|
parts.join(if cfg!(windows) { ";" } else { ":" })
|
||
|
|
})
|
||
|
|
}
|
||
|
|
|
||
|
|
/// Where `node` actually resolves, with `resolved_path`: for the first-run
|
||
|
|
/// checklist to name (Task 9.9), not for `check_node` itself to decide with.
|
||
|
|
pub fn node_binary_path() -> Option<String> {
|
||
|
|
let (program, arg) = if cfg!(windows) { ("where", "node") } else { ("which", "node") };
|
||
|
|
let out = Command::new(program).env("PATH", resolved_path()).arg(arg).output().ok()?;
|
||
|
|
if !out.status.success() {
|
||
|
|
return None;
|
||
|
|
}
|
||
|
|
String::from_utf8_lossy(&out.stdout).lines().next().map(str::trim).filter(|s| !s.is_empty()).map(str::to_string)
|
||
|
|
}
|
||
|
|
|
||
|
|
/// The plain message shown when the check fails; `None` when Node is fine.
|
||
|
|
pub fn problem_message(status: &NodeStatus) -> Option<String> {
|
||
|
|
match status {
|
||
|
|
NodeStatus::Ok(_) => None,
|
||
|
|
NodeStatus::TooOld(v) => Some(format!(
|
||
|
|
"Plan2Code needs Node.js {MIN_NODE_MAJOR} or newer, and this computer has {v}.\n\nInstall the current LTS release from https://nodejs.org and start Plan2Code again."
|
||
|
|
)),
|
||
|
|
NodeStatus::Missing => Some(format!(
|
||
|
|
"Plan2Code needs Node.js {MIN_NODE_MAJOR} or newer, and it was not found.\n\nInstall the current LTS release from https://nodejs.org and start Plan2Code again."
|
||
|
|
)),
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
#[cfg(test)]
|
||
|
|
mod tests {
|
||
|
|
use super::*;
|
||
|
|
|
||
|
|
#[test]
|
||
|
|
fn accepts_node_18_and_newer() {
|
||
|
|
assert_eq!(classify("v18.0.0\n"), NodeStatus::Ok("v18.0.0".into()));
|
||
|
|
assert_eq!(classify("v20.11.1"), NodeStatus::Ok("v20.11.1".into()));
|
||
|
|
assert_eq!(classify("v24.12.0\r\n"), NodeStatus::Ok("v24.12.0".into()));
|
||
|
|
}
|
||
|
|
|
||
|
|
#[test]
|
||
|
|
fn rejects_node_older_than_18() {
|
||
|
|
assert_eq!(classify("v16.20.2"), NodeStatus::TooOld("v16.20.2".into()));
|
||
|
|
assert_eq!(classify("v17.9.1"), NodeStatus::TooOld("v17.9.1".into()));
|
||
|
|
}
|
||
|
|
|
||
|
|
#[test]
|
||
|
|
fn treats_garbage_as_missing() {
|
||
|
|
assert_eq!(classify("not a version"), NodeStatus::Missing);
|
||
|
|
assert_eq!(classify(""), NodeStatus::Missing);
|
||
|
|
assert_eq!(classify("v"), NodeStatus::Missing);
|
||
|
|
assert_eq!(classify("vx.1.2"), NodeStatus::Missing);
|
||
|
|
}
|
||
|
|
|
||
|
|
#[test]
|
||
|
|
fn message_only_for_a_problem() {
|
||
|
|
assert!(problem_message(&NodeStatus::Ok("v20.0.0".into())).is_none());
|
||
|
|
assert!(problem_message(&NodeStatus::Missing).unwrap().contains("nodejs.org"));
|
||
|
|
assert!(problem_message(&NodeStatus::TooOld("v16.0.0".into())).unwrap().contains("v16.0.0"));
|
||
|
|
}
|
||
|
|
|
||
|
|
fn args(list: &[&str]) -> Vec<String> {
|
||
|
|
std::iter::once("plan2code-app").chain(list.iter().copied()).map(str::to_string).collect()
|
||
|
|
}
|
||
|
|
|
||
|
|
#[test]
|
||
|
|
fn the_node_override_names_its_directory_in_both_forms() {
|
||
|
|
let want = if cfg!(windows) { "C:\\nvm\\v20" } else { "/home/x/.nvm/v20" };
|
||
|
|
let bin = if cfg!(windows) { "C:\\nvm\\v20\\node.exe" } else { "/home/x/.nvm/v20/node" };
|
||
|
|
assert_eq!(node_override_dir(&args(&["--node", bin])).as_deref(), Some(want));
|
||
|
|
assert_eq!(node_override_dir(&args(&[&format!("--node={bin}")])).as_deref(), Some(want));
|
||
|
|
}
|
||
|
|
|
||
|
|
#[test]
|
||
|
|
fn no_override_or_a_missing_value_is_none() {
|
||
|
|
assert_eq!(node_override_dir(&args(&[])), None);
|
||
|
|
assert_eq!(node_override_dir(&args(&["--node"])), None);
|
||
|
|
assert_eq!(node_override_dir(&args(&["--node="])), None);
|
||
|
|
assert_eq!(node_override_dir(&args(&["--agent", "claude"])), None);
|
||
|
|
}
|
||
|
|
}
|