1mod archive;
2
3use anyhow::{anyhow, bail, Context, Result};
4use async_compression::futures::bufread::GzipDecoder;
5use async_tar::Archive;
6use futures::AsyncReadExt;
7use http::HttpClient;
8use semver::Version;
9use serde::Deserialize;
10use smol::io::BufReader;
11use smol::{fs, lock::Mutex, process::Command};
12use std::io;
13use std::process::{Output, Stdio};
14use std::{
15 env::consts,
16 path::{Path, PathBuf},
17 sync::Arc,
18};
19use util::ResultExt;
20
21#[cfg(windows)]
22use smol::process::windows::CommandExt;
23
24const VERSION: &str = "v18.15.0";
25
26#[cfg(not(windows))]
27const NODE_PATH: &str = "bin/node";
28#[cfg(windows)]
29const NODE_PATH: &str = "node.exe";
30
31#[cfg(not(windows))]
32const NPM_PATH: &str = "bin/npm";
33#[cfg(windows)]
34const NPM_PATH: &str = "node_modules/npm/bin/npm-cli.js";
35
36enum ArchiveType {
37 TarGz,
38 Zip,
39}
40
41#[derive(Debug, Deserialize)]
42#[serde(rename_all = "kebab-case")]
43pub struct NpmInfo {
44 #[serde(default)]
45 dist_tags: NpmInfoDistTags,
46 versions: Vec<String>,
47}
48
49#[derive(Debug, Deserialize, Default)]
50pub struct NpmInfoDistTags {
51 latest: Option<String>,
52}
53
54#[async_trait::async_trait]
55pub trait NodeRuntime: Send + Sync {
56 async fn binary_path(&self) -> Result<PathBuf>;
57
58 async fn run_npm_subcommand(
59 &self,
60 directory: Option<&Path>,
61 subcommand: &str,
62 args: &[&str],
63 ) -> Result<Output>;
64
65 async fn npm_package_latest_version(&self, name: &str) -> Result<String>;
66
67 async fn npm_install_packages(&self, directory: &Path, packages: &[(&str, &str)])
68 -> Result<()>;
69
70 async fn npm_package_installed_version(
71 &self,
72 local_package_directory: &PathBuf,
73 name: &str,
74 ) -> Result<Option<String>>;
75
76 async fn should_install_npm_package(
77 &self,
78 package_name: &str,
79 local_executable_path: &Path,
80 local_package_directory: &PathBuf,
81 latest_version: &str,
82 ) -> bool {
83 // In the case of the local system not having the package installed,
84 // or in the instances where we fail to parse package.json data,
85 // we attempt to install the package.
86 if fs::metadata(local_executable_path).await.is_err() {
87 return true;
88 }
89
90 let Some(installed_version) = self
91 .npm_package_installed_version(local_package_directory, package_name)
92 .await
93 .log_err()
94 .flatten()
95 else {
96 return true;
97 };
98
99 let Some(installed_version) = Version::parse(&installed_version).log_err() else {
100 return true;
101 };
102 let Some(latest_version) = Version::parse(&latest_version).log_err() else {
103 return true;
104 };
105
106 installed_version < latest_version
107 }
108}
109
110pub struct RealNodeRuntime {
111 http: Arc<dyn HttpClient>,
112 installation_lock: Mutex<()>,
113}
114
115impl RealNodeRuntime {
116 pub fn new(http: Arc<dyn HttpClient>) -> Arc<dyn NodeRuntime> {
117 Arc::new(RealNodeRuntime {
118 http,
119 installation_lock: Mutex::new(()),
120 })
121 }
122
123 async fn install_if_needed(&self) -> Result<PathBuf> {
124 let _lock = self.installation_lock.lock().await;
125 log::info!("Node runtime install_if_needed");
126
127 let os = match consts::OS {
128 "macos" => "darwin",
129 "linux" => "linux",
130 "windows" => "win",
131 other => bail!("Running on unsupported os: {other}"),
132 };
133
134 let arch = match consts::ARCH {
135 "x86_64" => "x64",
136 "aarch64" => "arm64",
137 other => bail!("Running on unsupported architecture: {other}"),
138 };
139
140 let folder_name = format!("node-{VERSION}-{os}-{arch}");
141 let node_containing_dir = util::paths::SUPPORT_DIR.join("node");
142 let node_dir = node_containing_dir.join(folder_name);
143 let node_binary = node_dir.join(NODE_PATH);
144 let npm_file = node_dir.join(NPM_PATH);
145
146 let mut command = Command::new(&node_binary);
147
148 command
149 .env_clear()
150 .arg(npm_file)
151 .arg("--version")
152 .stdin(Stdio::null())
153 .stdout(Stdio::null())
154 .stderr(Stdio::null())
155 .args(["--cache".into(), node_dir.join("cache")])
156 .args(["--userconfig".into(), node_dir.join("blank_user_npmrc")])
157 .args(["--globalconfig".into(), node_dir.join("blank_global_npmrc")]);
158
159 #[cfg(windows)]
160 command.creation_flags(windows::Win32::System::Threading::CREATE_NO_WINDOW.0);
161
162 let result = command.status().await;
163 let valid = matches!(result, Ok(status) if status.success());
164
165 if !valid {
166 _ = fs::remove_dir_all(&node_containing_dir).await;
167 fs::create_dir(&node_containing_dir)
168 .await
169 .context("error creating node containing dir")?;
170
171 let archive_type = match consts::OS {
172 "macos" | "linux" => ArchiveType::TarGz,
173 "windows" => ArchiveType::Zip,
174 other => bail!("Running on unsupported os: {other}"),
175 };
176
177 let file_name = format!(
178 "node-{VERSION}-{os}-{arch}.{extension}",
179 extension = match archive_type {
180 ArchiveType::TarGz => "tar.gz",
181 ArchiveType::Zip => "zip",
182 }
183 );
184 let url = format!("https://nodejs.org/dist/{VERSION}/{file_name}");
185 let mut response = self
186 .http
187 .get(&url, Default::default(), true)
188 .await
189 .context("error downloading Node binary tarball")?;
190
191 let body = response.body_mut();
192 match archive_type {
193 ArchiveType::TarGz => {
194 let decompressed_bytes = GzipDecoder::new(BufReader::new(response.body_mut()));
195 let archive = Archive::new(decompressed_bytes);
196 archive.unpack(&node_containing_dir).await?;
197 }
198 ArchiveType::Zip => archive::extract_zip(&node_containing_dir, body).await?,
199 }
200 }
201
202 // Note: Not in the `if !valid {}` so we can populate these for existing installations
203 _ = fs::create_dir(node_dir.join("cache")).await;
204 _ = fs::write(node_dir.join("blank_user_npmrc"), []).await;
205 _ = fs::write(node_dir.join("blank_global_npmrc"), []).await;
206
207 anyhow::Ok(node_dir)
208 }
209}
210
211#[async_trait::async_trait]
212impl NodeRuntime for RealNodeRuntime {
213 async fn binary_path(&self) -> Result<PathBuf> {
214 let installation_path = self.install_if_needed().await?;
215 Ok(installation_path.join(NODE_PATH))
216 }
217
218 async fn run_npm_subcommand(
219 &self,
220 directory: Option<&Path>,
221 subcommand: &str,
222 args: &[&str],
223 ) -> Result<Output> {
224 let attempt = || async move {
225 let installation_path = self.install_if_needed().await?;
226
227 let node_binary = installation_path.join(NODE_PATH);
228 let npm_file = installation_path.join(NPM_PATH);
229 let mut env_path = node_binary
230 .parent()
231 .expect("invalid node binary path")
232 .to_path_buf();
233
234 if let Some(existing_path) = std::env::var_os("PATH") {
235 if !existing_path.is_empty() {
236 env_path.push(":");
237 env_path.push(&existing_path);
238 }
239 }
240
241 if smol::fs::metadata(&node_binary).await.is_err() {
242 return Err(anyhow!("missing node binary file"));
243 }
244
245 if smol::fs::metadata(&npm_file).await.is_err() {
246 return Err(anyhow!("missing npm file"));
247 }
248
249 let mut command = Command::new(node_binary);
250 command.env_clear();
251 command.env("PATH", env_path);
252 command.arg(npm_file).arg(subcommand);
253 command.args(["--cache".into(), installation_path.join("cache")]);
254 command.args([
255 "--userconfig".into(),
256 installation_path.join("blank_user_npmrc"),
257 ]);
258 command.args([
259 "--globalconfig".into(),
260 installation_path.join("blank_global_npmrc"),
261 ]);
262 command.args(args);
263
264 if let Some(directory) = directory {
265 command.current_dir(directory);
266 command.args(["--prefix".into(), directory.to_path_buf()]);
267 }
268
269 if let Some(proxy) = self.http.proxy() {
270 command.args(["--proxy", proxy]);
271 }
272
273 #[cfg(windows)]
274 {
275 // SYSTEMROOT is a critical environment variables for Windows.
276 if let Some(val) = std::env::var("SYSTEMROOT")
277 .context("Missing environment variable: SYSTEMROOT!")
278 .log_err()
279 {
280 command.env("SYSTEMROOT", val);
281 }
282 command.creation_flags(windows::Win32::System::Threading::CREATE_NO_WINDOW.0);
283 }
284
285 command.output().await.map_err(|e| anyhow!("{e}"))
286 };
287
288 let mut output = attempt().await;
289 if output.is_err() {
290 output = attempt().await;
291 if output.is_err() {
292 return Err(anyhow!(
293 "failed to launch npm subcommand {subcommand} subcommand\nerr: {:?}",
294 output.err()
295 ));
296 }
297 }
298
299 if let Ok(output) = &output {
300 if !output.status.success() {
301 return Err(anyhow!(
302 "failed to execute npm {subcommand} subcommand:\nstdout: {:?}\nstderr: {:?}",
303 String::from_utf8_lossy(&output.stdout),
304 String::from_utf8_lossy(&output.stderr)
305 ));
306 }
307 }
308
309 output.map_err(|e| anyhow!("{e}"))
310 }
311
312 async fn npm_package_latest_version(&self, name: &str) -> Result<String> {
313 let output = self
314 .run_npm_subcommand(
315 None,
316 "info",
317 &[
318 name,
319 "--json",
320 "--fetch-retry-mintimeout",
321 "2000",
322 "--fetch-retry-maxtimeout",
323 "5000",
324 "--fetch-timeout",
325 "5000",
326 ],
327 )
328 .await?;
329
330 let mut info: NpmInfo = serde_json::from_slice(&output.stdout)?;
331 info.dist_tags
332 .latest
333 .or_else(|| info.versions.pop())
334 .ok_or_else(|| anyhow!("no version found for npm package {}", name))
335 }
336
337 async fn npm_package_installed_version(
338 &self,
339 local_package_directory: &PathBuf,
340 name: &str,
341 ) -> Result<Option<String>> {
342 let mut package_json_path = local_package_directory.clone();
343 package_json_path.extend(["node_modules", name, "package.json"]);
344
345 let mut file = match fs::File::open(package_json_path).await {
346 Ok(file) => file,
347 Err(err) => {
348 if err.kind() == io::ErrorKind::NotFound {
349 return Ok(None);
350 }
351
352 Err(err)?
353 }
354 };
355
356 #[derive(Deserialize)]
357 struct PackageJson {
358 version: String,
359 }
360
361 let mut contents = String::new();
362 file.read_to_string(&mut contents).await?;
363 let package_json: PackageJson = serde_json::from_str(&contents)?;
364 Ok(Some(package_json.version))
365 }
366
367 async fn npm_install_packages(
368 &self,
369 directory: &Path,
370 packages: &[(&str, &str)],
371 ) -> Result<()> {
372 let packages: Vec<_> = packages
373 .into_iter()
374 .map(|(name, version)| format!("{name}@{version}"))
375 .collect();
376
377 let mut arguments: Vec<_> = packages.iter().map(|p| p.as_str()).collect();
378 arguments.extend_from_slice(&[
379 "--save-exact",
380 "--fetch-retry-mintimeout",
381 "2000",
382 "--fetch-retry-maxtimeout",
383 "5000",
384 "--fetch-timeout",
385 "5000",
386 ]);
387
388 self.run_npm_subcommand(Some(directory), "install", &arguments)
389 .await?;
390 Ok(())
391 }
392}
393
394pub struct FakeNodeRuntime;
395
396impl FakeNodeRuntime {
397 pub fn new() -> Arc<dyn NodeRuntime> {
398 Arc::new(Self)
399 }
400}
401
402#[async_trait::async_trait]
403impl NodeRuntime for FakeNodeRuntime {
404 async fn binary_path(&self) -> anyhow::Result<PathBuf> {
405 unreachable!()
406 }
407
408 async fn run_npm_subcommand(
409 &self,
410 _: Option<&Path>,
411 subcommand: &str,
412 args: &[&str],
413 ) -> anyhow::Result<Output> {
414 unreachable!("Should not run npm subcommand '{subcommand}' with args {args:?}")
415 }
416
417 async fn npm_package_latest_version(&self, name: &str) -> anyhow::Result<String> {
418 unreachable!("Should not query npm package '{name}' for latest version")
419 }
420
421 async fn npm_package_installed_version(
422 &self,
423 _local_package_directory: &PathBuf,
424 name: &str,
425 ) -> Result<Option<String>> {
426 unreachable!("Should not query npm package '{name}' for installed version")
427 }
428
429 async fn npm_install_packages(
430 &self,
431 _: &Path,
432 packages: &[(&str, &str)],
433 ) -> anyhow::Result<()> {
434 unreachable!("Should not install packages {packages:?}")
435 }
436}