1mod archive;
2
3use anyhow::{anyhow, bail, Context, Result};
4pub use archive::extract_zip;
5use async_compression::futures::bufread::GzipDecoder;
6use async_tar::Archive;
7use futures::AsyncReadExt;
8use http_client::{HttpClient, Uri};
9use semver::Version;
10use serde::Deserialize;
11use smol::io::BufReader;
12use smol::{fs, lock::Mutex, process::Command};
13use std::ffi::OsString;
14use std::io;
15use std::process::{Output, Stdio};
16use std::{
17 env::consts,
18 path::{Path, PathBuf},
19 sync::Arc,
20};
21use util::ResultExt;
22
23#[cfg(windows)]
24use smol::process::windows::CommandExt;
25
26#[derive(Clone, Debug, Default, Eq, PartialEq)]
27pub struct NodeBinaryOptions {
28 pub allow_path_lookup: bool,
29 pub allow_binary_download: bool,
30 pub use_paths: Option<(PathBuf, PathBuf)>,
31}
32
33#[derive(Clone)]
34pub struct NodeRuntime(Arc<Mutex<NodeRuntimeState>>);
35
36struct NodeRuntimeState {
37 http: Arc<dyn HttpClient>,
38 instance: Option<Box<dyn NodeRuntimeTrait>>,
39 last_options: Option<NodeBinaryOptions>,
40 options: async_watch::Receiver<Option<NodeBinaryOptions>>,
41}
42
43impl NodeRuntime {
44 pub fn new(
45 http: Arc<dyn HttpClient>,
46 options: async_watch::Receiver<Option<NodeBinaryOptions>>,
47 ) -> Self {
48 NodeRuntime(Arc::new(Mutex::new(NodeRuntimeState {
49 http,
50 instance: None,
51 last_options: None,
52 options,
53 })))
54 }
55
56 pub fn unavailable() -> Self {
57 NodeRuntime(Arc::new(Mutex::new(NodeRuntimeState {
58 http: Arc::new(http_client::BlockedHttpClient),
59 instance: None,
60 last_options: None,
61 options: async_watch::channel(Some(NodeBinaryOptions::default())).1,
62 })))
63 }
64
65 async fn instance(&self) -> Result<Box<dyn NodeRuntimeTrait>> {
66 let mut state = self.0.lock().await;
67
68 while state.options.borrow().is_none() {
69 state.options.changed().await?;
70 }
71 let options = state.options.borrow().clone().unwrap();
72 if state.last_options.as_ref() != Some(&options) {
73 state.instance.take();
74 }
75 if let Some(instance) = state.instance.as_ref() {
76 return Ok(instance.boxed_clone());
77 }
78
79 if let Some((node, npm)) = options.use_paths.as_ref() {
80 let instance = SystemNodeRuntime::new(node.clone(), npm.clone()).await?;
81 state.instance = Some(instance.boxed_clone());
82 return Ok(instance);
83 }
84
85 if options.allow_path_lookup {
86 if let Some(instance) = SystemNodeRuntime::detect().await {
87 state.instance = Some(instance.boxed_clone());
88 return Ok(instance);
89 }
90 }
91
92 let instance = if options.allow_binary_download {
93 ManagedNodeRuntime::install_if_needed(&state.http).await?
94 } else {
95 Box::new(UnavailableNodeRuntime)
96 };
97
98 state.instance = Some(instance.boxed_clone());
99 return Ok(instance);
100 }
101
102 pub async fn binary_path(&self) -> Result<PathBuf> {
103 self.instance().await?.binary_path()
104 }
105
106 pub async fn run_npm_subcommand(
107 &self,
108 directory: &Path,
109 subcommand: &str,
110 args: &[&str],
111 ) -> Result<Output> {
112 let http = self.0.lock().await.http.clone();
113 self.instance()
114 .await?
115 .run_npm_subcommand(Some(directory), http.proxy(), subcommand, args)
116 .await
117 }
118
119 pub async fn npm_package_installed_version(
120 &self,
121 local_package_directory: &Path,
122 name: &str,
123 ) -> Result<Option<String>> {
124 self.instance()
125 .await?
126 .npm_package_installed_version(local_package_directory, name)
127 .await
128 }
129
130 pub async fn npm_package_latest_version(&self, name: &str) -> Result<String> {
131 let http = self.0.lock().await.http.clone();
132 let output = self
133 .instance()
134 .await?
135 .run_npm_subcommand(
136 None,
137 http.proxy(),
138 "info",
139 &[
140 name,
141 "--json",
142 "--fetch-retry-mintimeout",
143 "2000",
144 "--fetch-retry-maxtimeout",
145 "5000",
146 "--fetch-timeout",
147 "5000",
148 ],
149 )
150 .await?;
151
152 let mut info: NpmInfo = serde_json::from_slice(&output.stdout)?;
153 info.dist_tags
154 .latest
155 .or_else(|| info.versions.pop())
156 .ok_or_else(|| anyhow!("no version found for npm package {}", name))
157 }
158
159 pub async fn npm_install_packages(
160 &self,
161 directory: &Path,
162 packages: &[(&str, &str)],
163 ) -> Result<()> {
164 let packages: Vec<_> = packages
165 .iter()
166 .map(|(name, version)| format!("{name}@{version}"))
167 .collect();
168
169 let mut arguments: Vec<_> = packages.iter().map(|p| p.as_str()).collect();
170 arguments.extend_from_slice(&[
171 "--save-exact",
172 "--fetch-retry-mintimeout",
173 "2000",
174 "--fetch-retry-maxtimeout",
175 "5000",
176 "--fetch-timeout",
177 "5000",
178 ]);
179
180 // This is also wrong because the directory is wrong.
181 self.run_npm_subcommand(directory, "install", &arguments)
182 .await?;
183 Ok(())
184 }
185
186 pub async fn should_install_npm_package(
187 &self,
188 package_name: &str,
189 local_executable_path: &Path,
190 local_package_directory: &Path,
191 latest_version: &str,
192 ) -> bool {
193 // In the case of the local system not having the package installed,
194 // or in the instances where we fail to parse package.json data,
195 // we attempt to install the package.
196 if fs::metadata(local_executable_path).await.is_err() {
197 return true;
198 }
199
200 let Some(installed_version) = self
201 .npm_package_installed_version(local_package_directory, package_name)
202 .await
203 .log_err()
204 .flatten()
205 else {
206 return true;
207 };
208
209 let Some(installed_version) = Version::parse(&installed_version).log_err() else {
210 return true;
211 };
212 let Some(latest_version) = Version::parse(latest_version).log_err() else {
213 return true;
214 };
215
216 installed_version < latest_version
217 }
218}
219
220enum ArchiveType {
221 TarGz,
222 Zip,
223}
224
225#[derive(Debug, Deserialize)]
226#[serde(rename_all = "kebab-case")]
227pub struct NpmInfo {
228 #[serde(default)]
229 dist_tags: NpmInfoDistTags,
230 versions: Vec<String>,
231}
232
233#[derive(Debug, Deserialize, Default)]
234pub struct NpmInfoDistTags {
235 latest: Option<String>,
236}
237
238#[async_trait::async_trait]
239trait NodeRuntimeTrait: Send + Sync {
240 fn boxed_clone(&self) -> Box<dyn NodeRuntimeTrait>;
241 fn binary_path(&self) -> Result<PathBuf>;
242
243 async fn run_npm_subcommand(
244 &self,
245 directory: Option<&Path>,
246 proxy: Option<&Uri>,
247 subcommand: &str,
248 args: &[&str],
249 ) -> Result<Output>;
250
251 async fn npm_package_installed_version(
252 &self,
253 local_package_directory: &Path,
254 name: &str,
255 ) -> Result<Option<String>>;
256}
257
258#[derive(Clone)]
259struct ManagedNodeRuntime {
260 installation_path: PathBuf,
261}
262
263impl ManagedNodeRuntime {
264 const VERSION: &str = "v22.5.1";
265
266 #[cfg(not(windows))]
267 const NODE_PATH: &str = "bin/node";
268 #[cfg(windows)]
269 const NODE_PATH: &str = "node.exe";
270
271 #[cfg(not(windows))]
272 const NPM_PATH: &str = "bin/npm";
273 #[cfg(windows)]
274 const NPM_PATH: &str = "node_modules/npm/bin/npm-cli.js";
275
276 async fn node_environment_path(&self) -> Result<OsString> {
277 let node_binary = self.installation_path.join(Self::NODE_PATH);
278 let mut env_path = vec![node_binary
279 .parent()
280 .expect("invalid node binary path")
281 .to_path_buf()];
282
283 if let Some(existing_path) = std::env::var_os("PATH") {
284 let mut paths = std::env::split_paths(&existing_path).collect::<Vec<_>>();
285 env_path.append(&mut paths);
286 }
287
288 std::env::join_paths(env_path).context("failed to create PATH env variable")
289 }
290
291 async fn install_if_needed(http: &Arc<dyn HttpClient>) -> Result<Box<dyn NodeRuntimeTrait>> {
292 log::info!("Node runtime install_if_needed");
293
294 let os = match consts::OS {
295 "macos" => "darwin",
296 "linux" => "linux",
297 "windows" => "win",
298 other => bail!("Running on unsupported os: {other}"),
299 };
300
301 let arch = match consts::ARCH {
302 "x86_64" => "x64",
303 "aarch64" => "arm64",
304 other => bail!("Running on unsupported architecture: {other}"),
305 };
306
307 let version = Self::VERSION;
308 let folder_name = format!("node-{version}-{os}-{arch}");
309 let node_containing_dir = paths::support_dir().join("node");
310 let node_dir = node_containing_dir.join(folder_name);
311 let node_binary = node_dir.join(Self::NODE_PATH);
312 let npm_file = node_dir.join(Self::NPM_PATH);
313
314 let mut command = Command::new(&node_binary);
315
316 command
317 .env_clear()
318 .arg(npm_file)
319 .arg("--version")
320 .stdin(Stdio::null())
321 .stdout(Stdio::null())
322 .stderr(Stdio::null())
323 .args(["--cache".into(), node_dir.join("cache")])
324 .args(["--userconfig".into(), node_dir.join("blank_user_npmrc")])
325 .args(["--globalconfig".into(), node_dir.join("blank_global_npmrc")]);
326
327 #[cfg(windows)]
328 command.creation_flags(windows::Win32::System::Threading::CREATE_NO_WINDOW.0);
329
330 let result = command.status().await;
331 let valid = matches!(result, Ok(status) if status.success());
332
333 if !valid {
334 _ = fs::remove_dir_all(&node_containing_dir).await;
335 fs::create_dir(&node_containing_dir)
336 .await
337 .context("error creating node containing dir")?;
338
339 let archive_type = match consts::OS {
340 "macos" | "linux" => ArchiveType::TarGz,
341 "windows" => ArchiveType::Zip,
342 other => bail!("Running on unsupported os: {other}"),
343 };
344
345 let version = Self::VERSION;
346 let file_name = format!(
347 "node-{version}-{os}-{arch}.{extension}",
348 extension = match archive_type {
349 ArchiveType::TarGz => "tar.gz",
350 ArchiveType::Zip => "zip",
351 }
352 );
353 let url = format!("https://nodejs.org/dist/{version}/{file_name}");
354 let mut response = http
355 .get(&url, Default::default(), true)
356 .await
357 .context("error downloading Node binary tarball")?;
358
359 let body = response.body_mut();
360 match archive_type {
361 ArchiveType::TarGz => {
362 let decompressed_bytes = GzipDecoder::new(BufReader::new(response.body_mut()));
363 let archive = Archive::new(decompressed_bytes);
364 archive.unpack(&node_containing_dir).await?;
365 }
366 ArchiveType::Zip => archive::extract_zip(&node_containing_dir, body).await?,
367 }
368 }
369
370 // Note: Not in the `if !valid {}` so we can populate these for existing installations
371 _ = fs::create_dir(node_dir.join("cache")).await;
372 _ = fs::write(node_dir.join("blank_user_npmrc"), []).await;
373 _ = fs::write(node_dir.join("blank_global_npmrc"), []).await;
374
375 anyhow::Ok(Box::new(ManagedNodeRuntime {
376 installation_path: node_dir,
377 }))
378 }
379}
380
381#[async_trait::async_trait]
382impl NodeRuntimeTrait for ManagedNodeRuntime {
383 fn boxed_clone(&self) -> Box<dyn NodeRuntimeTrait> {
384 Box::new(self.clone())
385 }
386
387 fn binary_path(&self) -> Result<PathBuf> {
388 Ok(self.installation_path.join(Self::NODE_PATH))
389 }
390
391 async fn run_npm_subcommand(
392 &self,
393 directory: Option<&Path>,
394 proxy: Option<&Uri>,
395 subcommand: &str,
396 args: &[&str],
397 ) -> Result<Output> {
398 let attempt = || async move {
399 let node_binary = self.installation_path.join(Self::NODE_PATH);
400 let npm_file = self.installation_path.join(Self::NPM_PATH);
401 let env_path = self.node_environment_path().await?;
402
403 if smol::fs::metadata(&node_binary).await.is_err() {
404 return Err(anyhow!("missing node binary file"));
405 }
406
407 if smol::fs::metadata(&npm_file).await.is_err() {
408 return Err(anyhow!("missing npm file"));
409 }
410
411 let mut command = Command::new(node_binary);
412 command.env_clear();
413 command.env("PATH", env_path);
414 command.arg(npm_file).arg(subcommand);
415 command.args(["--cache".into(), self.installation_path.join("cache")]);
416 command.args([
417 "--userconfig".into(),
418 self.installation_path.join("blank_user_npmrc"),
419 ]);
420 command.args([
421 "--globalconfig".into(),
422 self.installation_path.join("blank_global_npmrc"),
423 ]);
424 command.args(args);
425 configure_npm_command(&mut command, directory, proxy);
426 command.output().await.map_err(|e| anyhow!("{e}"))
427 };
428
429 let mut output = attempt().await;
430 if output.is_err() {
431 output = attempt().await;
432 if output.is_err() {
433 return Err(anyhow!(
434 "failed to launch npm subcommand {subcommand} subcommand\nerr: {:?}",
435 output.err()
436 ));
437 }
438 }
439
440 if let Ok(output) = &output {
441 if !output.status.success() {
442 return Err(anyhow!(
443 "failed to execute npm {subcommand} subcommand:\nstdout: {:?}\nstderr: {:?}",
444 String::from_utf8_lossy(&output.stdout),
445 String::from_utf8_lossy(&output.stderr)
446 ));
447 }
448 }
449
450 output.map_err(|e| anyhow!("{e}"))
451 }
452 async fn npm_package_installed_version(
453 &self,
454 local_package_directory: &Path,
455 name: &str,
456 ) -> Result<Option<String>> {
457 read_package_installed_version(local_package_directory.join("node_modules"), name).await
458 }
459}
460
461#[derive(Clone)]
462pub struct SystemNodeRuntime {
463 node: PathBuf,
464 npm: PathBuf,
465 global_node_modules: PathBuf,
466 scratch_dir: PathBuf,
467}
468
469impl SystemNodeRuntime {
470 const MIN_VERSION: semver::Version = Version::new(18, 0, 0);
471 async fn new(node: PathBuf, npm: PathBuf) -> Result<Box<dyn NodeRuntimeTrait>> {
472 let output = Command::new(&node)
473 .arg("--version")
474 .output()
475 .await
476 .with_context(|| format!("running node from {:?}", node))?;
477 if !output.status.success() {
478 anyhow::bail!(
479 "failed to run node --version. stdout: {}, stderr: {}",
480 String::from_utf8_lossy(&output.stdout),
481 String::from_utf8_lossy(&output.stderr),
482 );
483 }
484 let version_str = String::from_utf8_lossy(&output.stdout);
485 let version = semver::Version::parse(version_str.trim().trim_start_matches('v'))?;
486 if version < Self::MIN_VERSION {
487 anyhow::bail!(
488 "node at {} is too old. want: {}, got: {}",
489 node.to_string_lossy(),
490 Self::MIN_VERSION,
491 version
492 )
493 }
494
495 let scratch_dir = paths::support_dir().join("node");
496 fs::create_dir(&scratch_dir).await.ok();
497 fs::create_dir(scratch_dir.join("cache")).await.ok();
498 fs::write(scratch_dir.join("blank_user_npmrc"), [])
499 .await
500 .ok();
501 fs::write(scratch_dir.join("blank_global_npmrc"), [])
502 .await
503 .ok();
504
505 let mut this = Self {
506 node,
507 npm,
508 global_node_modules: PathBuf::default(),
509 scratch_dir,
510 };
511 let output = this.run_npm_subcommand(None, None, "root", &["-g"]).await?;
512 this.global_node_modules =
513 PathBuf::from(String::from_utf8_lossy(&output.stdout).to_string());
514
515 Ok(Box::new(this))
516 }
517
518 async fn detect() -> Option<Box<dyn NodeRuntimeTrait>> {
519 let node = which::which("node").ok()?;
520 let npm = which::which("npm").ok()?;
521 Self::new(node, npm).await.log_err()
522 }
523}
524
525#[async_trait::async_trait]
526impl NodeRuntimeTrait for SystemNodeRuntime {
527 fn boxed_clone(&self) -> Box<dyn NodeRuntimeTrait> {
528 Box::new(self.clone())
529 }
530
531 fn binary_path(&self) -> Result<PathBuf> {
532 Ok(self.node.clone())
533 }
534
535 async fn run_npm_subcommand(
536 &self,
537 directory: Option<&Path>,
538 proxy: Option<&Uri>,
539 subcommand: &str,
540 args: &[&str],
541 ) -> anyhow::Result<Output> {
542 let mut command = Command::new(self.npm.clone());
543 command
544 .env_clear()
545 .env("PATH", std::env::var_os("PATH").unwrap_or_default())
546 .arg(subcommand)
547 .args(["--cache".into(), self.scratch_dir.join("cache")])
548 .args([
549 "--userconfig".into(),
550 self.scratch_dir.join("blank_user_npmrc"),
551 ])
552 .args([
553 "--globalconfig".into(),
554 self.scratch_dir.join("blank_global_npmrc"),
555 ])
556 .args(args);
557 configure_npm_command(&mut command, directory, proxy);
558 let output = command.output().await?;
559 if !output.status.success() {
560 return Err(anyhow!(
561 "failed to execute npm {subcommand} subcommand:\nstdout: {:?}\nstderr: {:?}",
562 String::from_utf8_lossy(&output.stdout),
563 String::from_utf8_lossy(&output.stderr)
564 ));
565 }
566
567 Ok(output)
568 }
569
570 async fn npm_package_installed_version(
571 &self,
572 local_package_directory: &Path,
573 name: &str,
574 ) -> Result<Option<String>> {
575 read_package_installed_version(local_package_directory.join("node_modules"), name).await
576 // todo: allow returning a globally installed version (requires callers not to hard-code the path)
577 }
578}
579
580pub async fn read_package_installed_version(
581 node_module_directory: PathBuf,
582 name: &str,
583) -> Result<Option<String>> {
584 let package_json_path = node_module_directory.join(name).join("package.json");
585
586 let mut file = match fs::File::open(package_json_path).await {
587 Ok(file) => file,
588 Err(err) => {
589 if err.kind() == io::ErrorKind::NotFound {
590 return Ok(None);
591 }
592
593 Err(err)?
594 }
595 };
596
597 #[derive(Deserialize)]
598 struct PackageJson {
599 version: String,
600 }
601
602 let mut contents = String::new();
603 file.read_to_string(&mut contents).await?;
604 let package_json: PackageJson = serde_json::from_str(&contents)?;
605 Ok(Some(package_json.version))
606}
607
608pub struct UnavailableNodeRuntime;
609
610#[async_trait::async_trait]
611impl NodeRuntimeTrait for UnavailableNodeRuntime {
612 fn boxed_clone(&self) -> Box<dyn NodeRuntimeTrait> {
613 Box::new(UnavailableNodeRuntime)
614 }
615 fn binary_path(&self) -> Result<PathBuf> {
616 bail!("binary_path: no node runtime available")
617 }
618
619 async fn run_npm_subcommand(
620 &self,
621 _: Option<&Path>,
622 _: Option<&Uri>,
623 _: &str,
624 _: &[&str],
625 ) -> anyhow::Result<Output> {
626 bail!("run_npm_subcommand: no node runtime available")
627 }
628
629 async fn npm_package_installed_version(
630 &self,
631 _local_package_directory: &Path,
632 _: &str,
633 ) -> Result<Option<String>> {
634 bail!("npm_package_installed_version: no node runtime available")
635 }
636}
637
638fn configure_npm_command(command: &mut Command, directory: Option<&Path>, proxy: Option<&Uri>) {
639 if let Some(directory) = directory {
640 command.current_dir(directory);
641 command.args(["--prefix".into(), directory.to_path_buf()]);
642 }
643
644 if let Some(proxy) = proxy {
645 // Map proxy settings from `http://localhost:10809` to `http://127.0.0.1:10809`
646 // NodeRuntime without environment information can not parse `localhost`
647 // correctly.
648 // TODO: map to `[::1]` if we are using ipv6
649 let proxy = proxy
650 .to_string()
651 .to_ascii_lowercase()
652 .replace("localhost", "127.0.0.1");
653
654 command.args(["--proxy", &proxy]);
655 }
656
657 #[cfg(windows)]
658 {
659 // SYSTEMROOT is a critical environment variables for Windows.
660 if let Some(val) = std::env::var("SYSTEMROOT")
661 .context("Missing environment variable: SYSTEMROOT!")
662 .log_err()
663 {
664 command.env("SYSTEMROOT", val);
665 }
666 // Without ComSpec, the post-install will always fail.
667 if let Some(val) = std::env::var("ComSpec")
668 .context("Missing environment variable: ComSpec!")
669 .log_err()
670 {
671 command.env("ComSpec", val);
672 }
673 command.creation_flags(windows::Win32::System::Threading::CREATE_NO_WINDOW.0);
674 }
675}