refactor: extract structs for downloading tarballs and npm registry packuments (#24067)

1 files changed, 0 insertions, 309 deletions

diff --git a/cli/npm/managed/cache.rs b/cli/npm/managed/cache.rs
deleted file mode 100644
index 4056c97ad..000000000
--- a/cli/npm/managed/cache.rs
+++ /dev/null
@@ -1,309 +0,0 @@
-// Copyright 2018-2024 the Deno authors. All rights reserved. MIT license.
-
-use std::collections::HashSet;
-use std::fs;
-use std::path::Path;
-use std::path::PathBuf;
-use std::sync::Arc;
-
-use deno_ast::ModuleSpecifier;
-use deno_core::anyhow::bail;
-use deno_core::anyhow::Context;
-use deno_core::error::custom_error;
-use deno_core::error::AnyError;
-use deno_core::parking_lot::Mutex;
-use deno_core::url::Url;
-use deno_npm::npm_rc::ResolvedNpmRc;
-use deno_npm::registry::NpmPackageVersionDistInfo;
-use deno_npm::NpmPackageCacheFolderId;
-use deno_runtime::deno_fs;
-use deno_semver::package::PackageNv;
-
-use crate::args::CacheSetting;
-use crate::http_util::HttpClient;
-use crate::npm::common::maybe_auth_header_for_npm_registry;
-use crate::npm::NpmCacheDir;
-use crate::util::fs::hard_link_dir_recursive;
-use crate::util::progress_bar::ProgressBar;
-
-use super::tarball::verify_and_extract_tarball;
-use super::tarball::TarballExtractionMode;
-
-/// Stores a single copy of npm packages in a cache.
-#[derive(Debug)]
-pub struct NpmCache {
-  cache_dir: NpmCacheDir,
-  cache_setting: CacheSetting,
-  fs: Arc<dyn deno_fs::FileSystem>,
-  http_client: Arc<HttpClient>,
-  progress_bar: ProgressBar,
-  pub(crate) npmrc: Arc<ResolvedNpmRc>,
-  /// ensures a package is only downloaded once per run
-  previously_reloaded_packages: Mutex<HashSet<PackageNv>>,
-}
-
-impl NpmCache {
-  pub fn new(
-    cache_dir: NpmCacheDir,
-    cache_setting: CacheSetting,
-    fs: Arc<dyn deno_fs::FileSystem>,
-    http_client: Arc<HttpClient>,
-    progress_bar: ProgressBar,
-    npmrc: Arc<ResolvedNpmRc>,
-  ) -> Self {
-    Self {
-      cache_dir,
-      cache_setting,
-      fs,
-      http_client,
-      progress_bar,
-      previously_reloaded_packages: Default::default(),
-      npmrc,
-    }
-  }
-
-  pub fn cache_setting(&self) -> &CacheSetting {
-    &self.cache_setting
-  }
-
-  pub fn root_dir_url(&self) -> &Url {
-    self.cache_dir.root_dir_url()
-  }
-
-  /// Checks if the cache should be used for the provided name and version.
-  /// NOTE: Subsequent calls for the same package will always return `true`
-  /// to ensure a package is only downloaded once per run of the CLI. This
-  /// prevents downloads from re-occurring when someone has `--reload` and
-  /// and imports a dynamic import that imports the same package again for example.
-  fn should_use_cache_for_package(&self, package: &PackageNv) -> bool {
-    self.cache_setting.should_use_for_npm_package(&package.name)
-      || !self
-        .previously_reloaded_packages
-        .lock()
-        .insert(package.clone())
-  }
-
-  pub async fn ensure_package(
-    &self,
-    package: &PackageNv,
-    dist: &NpmPackageVersionDistInfo,
-  ) -> Result<(), AnyError> {
-    self
-      .ensure_package_inner(package, dist)
-      .await
-      .with_context(|| format!("Failed caching npm package '{package}'."))
-  }
-
-  async fn ensure_package_inner(
-    &self,
-    package_nv: &PackageNv,
-    dist: &NpmPackageVersionDistInfo,
-  ) -> Result<(), AnyError> {
-    let registry_url = self.npmrc.get_registry_url(&package_nv.name);
-    let registry_config = self.npmrc.get_registry_config(&package_nv.name);
-
-    let package_folder = self
-      .cache_dir
-      .package_folder_for_name_and_version(package_nv, registry_url);
-    let should_use_cache = self.should_use_cache_for_package(package_nv);
-    let package_folder_exists = self.fs.exists_sync(&package_folder);
-    if should_use_cache && package_folder_exists {
-      return Ok(());
-    } else if self.cache_setting == CacheSetting::Only {
-      return Err(custom_error(
-        "NotCached",
-        format!(
-          "An npm specifier not found in cache: \"{}\", --cached-only is specified.",
-          &package_nv.name
-        )
-      )
-      );
-    }
-
-    if dist.tarball.is_empty() {
-      bail!("Tarball URL was empty.");
-    }
-
-    let maybe_auth_header = maybe_auth_header_for_npm_registry(registry_config);
-
-    let guard = self.progress_bar.update(&dist.tarball);
-    let maybe_bytes = self
-      .http_client
-      .download_with_progress(&dist.tarball, maybe_auth_header, &guard)
-      .await?;
-    match maybe_bytes {
-      Some(bytes) => {
-        let extraction_mode = if should_use_cache || !package_folder_exists {
-          TarballExtractionMode::SiblingTempDir
-        } else {
-          // The user ran with `--reload`, so overwrite the package instead of
-          // deleting it since the package might get corrupted if a user kills
-          // their deno process while it's deleting a package directory
-          //
-          // We can't rename this folder and delete it because the folder
-          // may be in use by another process or may now contain hardlinks,
-          // which will cause windows to throw an "AccessDenied" error when
-          // renaming. So we settle for overwriting.
-          TarballExtractionMode::Overwrite
-        };
-        let dist = dist.clone();
-        let package_nv = package_nv.clone();
-        deno_core::unsync::spawn_blocking(move || {
-          verify_and_extract_tarball(
-            &package_nv,
-            &bytes,
-            &dist,
-            &package_folder,
-            extraction_mode,
-          )
-        })
-        .await?
-      }
-      None => {
-        bail!("Could not find npm package tarball at: {}", dist.tarball);
-      }
-    }
-  }
-
-  /// Ensures a copy of the package exists in the global cache.
-  ///
-  /// This assumes that the original package folder being hard linked
-  /// from exists before this is called.
-  pub fn ensure_copy_package(
-    &self,
-    folder_id: &NpmPackageCacheFolderId,
-  ) -> Result<(), AnyError> {
-    let registry_url = self.npmrc.get_registry_url(&folder_id.nv.name);
-    assert_ne!(folder_id.copy_index, 0);
-    let package_folder = self
-      .cache_dir
-      .package_folder_for_id(folder_id, registry_url);
-
-    if package_folder.exists()
-      // if this file exists, then the package didn't successfully initialize
-      // the first time, or another process is currently extracting the zip file
-      && !package_folder.join(NPM_PACKAGE_SYNC_LOCK_FILENAME).exists()
-      && self.cache_setting.should_use_for_npm_package(&folder_id.nv.name)
-    {
-      return Ok(());
-    }
-
-    let original_package_folder = self
-      .cache_dir
-      .package_folder_for_name_and_version(&folder_id.nv, registry_url);
-
-    // it seems Windows does an "AccessDenied" error when moving a
-    // directory with hard links, so that's why this solution is done
-    with_folder_sync_lock(&folder_id.nv, &package_folder, || {
-      hard_link_dir_recursive(&original_package_folder, &package_folder)
-    })?;
-    Ok(())
-  }
-
-  pub fn package_folder_for_id(&self, id: &NpmPackageCacheFolderId) -> PathBuf {
-    let registry_url = self.npmrc.get_registry_url(&id.nv.name);
-    self.cache_dir.package_folder_for_id(id, registry_url)
-  }
-
-  pub fn package_folder_for_name_and_version(
-    &self,
-    package: &PackageNv,
-  ) -> PathBuf {
-    let registry_url = self.npmrc.get_registry_url(&package.name);
-    self
-      .cache_dir
-      .package_folder_for_name_and_version(package, registry_url)
-  }
-
-  pub fn package_name_folder(&self, name: &str) -> PathBuf {
-    let registry_url = self.npmrc.get_registry_url(name);
-    self.cache_dir.package_name_folder(name, registry_url)
-  }
-
-  pub fn root_folder(&self) -> PathBuf {
-    self.cache_dir.root_dir().to_owned()
-  }
-
-  pub fn resolve_package_folder_id_from_specifier(
-    &self,
-    specifier: &ModuleSpecifier,
-  ) -> Option<NpmPackageCacheFolderId> {
-    self
-      .cache_dir
-      .resolve_package_folder_id_from_specifier(specifier)
-  }
-}
-
-const NPM_PACKAGE_SYNC_LOCK_FILENAME: &str = ".deno_sync_lock";
-
-fn with_folder_sync_lock(
-  package: &PackageNv,
-  output_folder: &Path,
-  action: impl FnOnce() -> Result<(), AnyError>,
-) -> Result<(), AnyError> {
-  fn inner(
-    output_folder: &Path,
-    action: impl FnOnce() -> Result<(), AnyError>,
-  ) -> Result<(), AnyError> {
-    fs::create_dir_all(output_folder).with_context(|| {
-      format!("Error creating '{}'.", output_folder.display())
-    })?;
-
-    // This sync lock file is a way to ensure that partially created
-    // npm package directories aren't considered valid. This could maybe
-    // be a bit smarter in the future to not bother extracting here
-    // if another process has taken the lock in the past X seconds and
-    // wait for the other process to finish (it could try to create the
-    // file with `create_new(true)` then if it exists, check the metadata
-    // then wait until the other process finishes with a timeout), but
-    // for now this is good enough.
-    let sync_lock_path = output_folder.join(NPM_PACKAGE_SYNC_LOCK_FILENAME);
-    match fs::OpenOptions::new()
-      .write(true)
-      .create(true)
-      .truncate(false)
-      .open(&sync_lock_path)
-    {
-      Ok(_) => {
-        action()?;
-        // extraction succeeded, so only now delete this file
-        let _ignore = std::fs::remove_file(&sync_lock_path);
-        Ok(())
-      }
-      Err(err) => {
-        bail!(
-          concat!(
-            "Error creating package sync lock file at '{}'. ",
-            "Maybe try manually deleting this folder.\n\n{:#}",
-          ),
-          output_folder.display(),
-          err
-        );
-      }
-    }
-  }
-
-  match inner(output_folder, action) {
-    Ok(()) => Ok(()),
-    Err(err) => {
-      if let Err(remove_err) = fs::remove_dir_all(output_folder) {
-        if remove_err.kind() != std::io::ErrorKind::NotFound {
-          bail!(
-            concat!(
-              "Failed setting up package cache directory for {}, then ",
-              "failed cleaning it up.\n\nOriginal error:\n\n{}\n\n",
-              "Remove error:\n\n{}\n\nPlease manually ",
-              "delete this folder or you will run into issues using this ",
-              "package in the future:\n\n{}"
-            ),
-            package,
-            err,
-            remove_err,
-            output_folder.display(),
-          );
-        }
-      }
-      Err(err)
-    }
-  }
-}