// Copyright 2018-2024 the Deno authors. All rights reserved. MIT license. use std::path::Path; use std::path::PathBuf; use std::sync::Arc; use deno_ast::ModuleSpecifier; use deno_core::anyhow::Context; use deno_core::error::AnyError; use deno_core::parking_lot::Mutex; use deno_core::serde_json; use deno_graph::NpmPackageReqResolution; use deno_npm::npm_rc::ResolvedNpmRc; use deno_npm::registry::NpmRegistryApi; use deno_npm::resolution::NpmResolutionSnapshot; use deno_npm::resolution::PackageReqNotFoundError; use deno_npm::resolution::ValidSerializedNpmResolutionSnapshot; use deno_npm::NpmPackageId; use deno_npm::NpmResolutionPackage; use deno_npm::NpmSystemInfo; use deno_runtime::deno_fs::FileSystem; use deno_runtime::deno_node::NodePermissions; use deno_runtime::deno_node::NodeResolutionMode; use deno_runtime::deno_node::NpmResolver; use deno_semver::package::PackageNv; use deno_semver::package::PackageReq; use crate::args::Lockfile; use crate::args::NpmProcessState; use crate::args::NpmProcessStateKind; use crate::args::PackageJsonDepsProvider; use crate::cache::FastInsecureHasher; use crate::util::fs::canonicalize_path_maybe_not_exists_with_fs; use crate::util::progress_bar::ProgressBar; use self::cache::NpmCache; use self::installer::PackageJsonDepsInstaller; use self::registry::CliNpmRegistryApi; use self::resolution::NpmResolution; use self::resolvers::create_npm_fs_resolver; use self::resolvers::NpmPackageFsResolver; use super::CliNpmResolver; use super::InnerCliNpmResolverRef; use super::NpmCacheDir; mod cache; mod installer; mod registry; mod resolution; mod resolvers; mod tarball; pub enum CliNpmResolverManagedSnapshotOption { ResolveFromLockfile(Arc>), Specified(Option), } pub enum CliNpmResolverManagedPackageJsonInstallerOption { ConditionalInstall(Arc), NoInstall, } pub struct CliNpmResolverManagedCreateOptions { pub snapshot: CliNpmResolverManagedSnapshotOption, pub maybe_lockfile: Option>>, pub fs: Arc, pub http_client: Arc, pub npm_global_cache_dir: PathBuf, pub cache_setting: crate::args::CacheSetting, pub text_only_progress_bar: crate::util::progress_bar::ProgressBar, pub maybe_node_modules_path: Option, pub npm_system_info: NpmSystemInfo, pub package_json_installer: CliNpmResolverManagedPackageJsonInstallerOption, pub npmrc: Arc, } pub async fn create_managed_npm_resolver_for_lsp( options: CliNpmResolverManagedCreateOptions, ) -> Arc { let npm_cache = create_cache(&options); let npm_api = create_api(&options, npm_cache.clone()); let snapshot = match resolve_snapshot(&npm_api, options.snapshot).await { Ok(snapshot) => snapshot, Err(err) => { log::warn!("failed to resolve snapshot: {}", err); None } }; create_inner( npm_cache, npm_api, snapshot, options.maybe_lockfile, options.fs, options.text_only_progress_bar, options.maybe_node_modules_path, options.package_json_installer, options.npm_system_info, ) } pub async fn create_managed_npm_resolver( options: CliNpmResolverManagedCreateOptions, ) -> Result, AnyError> { let npm_cache = create_cache(&options); let npm_api = create_api(&options, npm_cache.clone()); let snapshot = resolve_snapshot(&npm_api, options.snapshot).await?; Ok(create_inner( npm_cache, npm_api, snapshot, options.maybe_lockfile, options.fs, options.text_only_progress_bar, options.maybe_node_modules_path, options.package_json_installer, options.npm_system_info, )) } #[allow(clippy::too_many_arguments)] fn create_inner( npm_cache: Arc, npm_api: Arc, snapshot: Option, maybe_lockfile: Option>>, fs: Arc, text_only_progress_bar: crate::util::progress_bar::ProgressBar, node_modules_dir_path: Option, package_json_installer: CliNpmResolverManagedPackageJsonInstallerOption, npm_system_info: NpmSystemInfo, ) -> Arc { let resolution = Arc::new(NpmResolution::from_serialized( npm_api.clone(), snapshot, maybe_lockfile.clone(), )); let npm_fs_resolver = create_npm_fs_resolver( fs.clone(), npm_cache.clone(), &text_only_progress_bar, resolution.clone(), node_modules_dir_path, npm_system_info.clone(), ); let package_json_deps_installer = match package_json_installer { CliNpmResolverManagedPackageJsonInstallerOption::ConditionalInstall( provider, ) => Arc::new(PackageJsonDepsInstaller::new( provider, npm_api.clone(), resolution.clone(), )), CliNpmResolverManagedPackageJsonInstallerOption::NoInstall => { Arc::new(PackageJsonDepsInstaller::no_op()) } }; Arc::new(ManagedCliNpmResolver::new( npm_api, fs, resolution, npm_fs_resolver, npm_cache, maybe_lockfile, package_json_deps_installer, text_only_progress_bar, npm_system_info, )) } fn create_cache(options: &CliNpmResolverManagedCreateOptions) -> Arc { Arc::new(NpmCache::new( NpmCacheDir::new( options.npm_global_cache_dir.clone(), options.npmrc.get_all_known_registries_urls(), ), options.cache_setting.clone(), options.fs.clone(), options.http_client.clone(), options.text_only_progress_bar.clone(), options.npmrc.clone(), )) } fn create_api( options: &CliNpmResolverManagedCreateOptions, npm_cache: Arc, ) -> Arc { Arc::new(CliNpmRegistryApi::new( npm_cache.clone(), options.http_client.clone(), options.npmrc.clone(), options.text_only_progress_bar.clone(), )) } async fn resolve_snapshot( api: &CliNpmRegistryApi, snapshot: CliNpmResolverManagedSnapshotOption, ) -> Result, AnyError> { match snapshot { CliNpmResolverManagedSnapshotOption::ResolveFromLockfile(lockfile) => { if !lockfile.lock().overwrite { let snapshot = snapshot_from_lockfile(lockfile.clone(), api) .await .with_context(|| { format!( "failed reading lockfile '{}'", lockfile.lock().filename.display() ) })?; // clear the memory cache to reduce memory usage api.clear_memory_cache(); Ok(Some(snapshot)) } else { Ok(None) } } CliNpmResolverManagedSnapshotOption::Specified(snapshot) => Ok(snapshot), } } async fn snapshot_from_lockfile( lockfile: Arc>, api: &dyn NpmRegistryApi, ) -> Result { let (incomplete_snapshot, skip_integrity_check) = { let lock = lockfile.lock(); ( deno_npm::resolution::incomplete_snapshot_from_lockfile(&lock)?, lock.overwrite, ) }; let snapshot = deno_npm::resolution::snapshot_from_lockfile( deno_npm::resolution::SnapshotFromLockfileParams { incomplete_snapshot, api, skip_integrity_check, }, ) .await?; Ok(snapshot) } /// An npm resolver where the resolution is managed by Deno rather than /// the user bringing their own node_modules (BYONM) on the file system. pub struct ManagedCliNpmResolver { api: Arc, fs: Arc, fs_resolver: Arc, global_npm_cache: Arc, resolution: Arc, maybe_lockfile: Option>>, npm_system_info: NpmSystemInfo, progress_bar: ProgressBar, package_json_deps_installer: Arc, } impl std::fmt::Debug for ManagedCliNpmResolver { fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { f.debug_struct("ManagedNpmResolver") .field("", &"") .finish() } } impl ManagedCliNpmResolver { #[allow(clippy::too_many_arguments)] pub fn new( api: Arc, fs: Arc, resolution: Arc, fs_resolver: Arc, global_npm_cache: Arc, maybe_lockfile: Option>>, package_json_deps_installer: Arc, progress_bar: ProgressBar, npm_system_info: NpmSystemInfo, ) -> Self { Self { api, fs, fs_resolver, global_npm_cache, resolution, maybe_lockfile, package_json_deps_installer, progress_bar, npm_system_info, } } pub fn resolve_pkg_folder_from_pkg_id( &self, pkg_id: &NpmPackageId, ) -> Result { let path = self.fs_resolver.package_folder(pkg_id)?; let path = canonicalize_path_maybe_not_exists_with_fs(&path, self.fs.as_ref())?; log::debug!( "Resolved package folder of {} to {}", pkg_id.as_serialized(), path.display() ); Ok(path) } /// Resolves the package nv from the provided specifier. pub fn resolve_pkg_id_from_specifier( &self, specifier: &ModuleSpecifier, ) -> Result, AnyError> { let Some(cache_folder_id) = self .fs_resolver .resolve_package_cache_folder_id_from_specifier(specifier)? else { return Ok(None); }; Ok(Some( self .resolution .resolve_pkg_id_from_pkg_cache_folder_id(&cache_folder_id)?, )) } pub fn resolve_pkg_reqs_from_pkg_id( &self, id: &NpmPackageId, ) -> Vec { self.resolution.resolve_pkg_reqs_from_pkg_id(id) } /// Attempts to get the package size in bytes. pub fn package_size( &self, package_id: &NpmPackageId, ) -> Result { let package_folder = self.fs_resolver.package_folder(package_id)?; Ok(crate::util::fs::dir_size(&package_folder)?) } pub fn all_system_packages( &self, system_info: &NpmSystemInfo, ) -> Vec { self.resolution.all_system_packages(system_info) } /// Checks if the provided package req's folder is cached. pub fn is_pkg_req_folder_cached(&self, req: &PackageReq) -> bool { self .resolve_pkg_id_from_pkg_req(req) .ok() .and_then(|id| self.fs_resolver.package_folder(&id).ok()) .map(|folder| folder.exists()) .unwrap_or(false) } /// Adds package requirements to the resolver and ensures everything is setup. pub async fn add_package_reqs( &self, packages: &[PackageReq], ) -> Result<(), AnyError> { if packages.is_empty() { return Ok(()); } self.resolution.add_package_reqs(packages).await?; self.fs_resolver.cache_packages().await?; // If there's a lock file, update it with all discovered npm packages if let Some(lockfile_mutex) = &self.maybe_lockfile { let mut lockfile = lockfile_mutex.lock(); self.lock(&mut lockfile)?; } Ok(()) } /// Sets package requirements to the resolver, removing old requirements and adding new ones. /// /// This will retrieve and resolve package information, but not cache any package files. pub async fn set_package_reqs( &self, packages: &[PackageReq], ) -> Result<(), AnyError> { self.resolution.set_package_reqs(packages).await } pub fn snapshot(&self) -> NpmResolutionSnapshot { self.resolution.snapshot() } pub fn serialized_valid_snapshot_for_system( &self, system_info: &NpmSystemInfo, ) -> ValidSerializedNpmResolutionSnapshot { self .resolution .serialized_valid_snapshot_for_system(system_info) } pub fn lock(&self, lockfile: &mut Lockfile) -> Result<(), AnyError> { self.resolution.lock(lockfile) } pub async fn inject_synthetic_types_node_package( &self, ) -> Result<(), AnyError> { // add and ensure this isn't added to the lockfile let package_reqs = vec![PackageReq::from_str("@types/node").unwrap()]; self.resolution.add_package_reqs(&package_reqs).await?; self.fs_resolver.cache_packages().await?; Ok(()) } pub async fn resolve_pending(&self) -> Result<(), AnyError> { self.resolution.resolve_pending().await?; self.cache_packages().await } pub async fn cache_packages(&self) -> Result<(), AnyError> { self.fs_resolver.cache_packages().await } /// Resolves a package requirement for deno graph. This should only be /// called by deno_graph's NpmResolver or for resolving packages in /// a package.json pub fn resolve_npm_for_deno_graph( &self, pkg_req: &PackageReq, ) -> NpmPackageReqResolution { let result = self.resolution.resolve_pkg_req_as_pending(pkg_req); match result { Ok(nv) => NpmPackageReqResolution::Ok(nv), Err(err) => { if self.api.mark_force_reload() { log::debug!("Restarting npm specifier resolution to check for new registry information. Error: {:#}", err); NpmPackageReqResolution::ReloadRegistryInfo(err.into()) } else { NpmPackageReqResolution::Err(err.into()) } } } } pub fn resolve_pkg_folder_from_deno_module( &self, nv: &PackageNv, ) -> Result { let pkg_id = self.resolution.resolve_pkg_id_from_deno_module(nv)?; self.resolve_pkg_folder_from_pkg_id(&pkg_id) } fn resolve_pkg_id_from_pkg_req( &self, req: &PackageReq, ) -> Result { self.resolution.resolve_pkg_id_from_pkg_req(req) } pub async fn ensure_top_level_package_json_install( &self, ) -> Result<(), AnyError> { self .package_json_deps_installer .ensure_top_level_install() .await } pub async fn cache_package_info( &self, package_name: &str, ) -> Result<(), AnyError> { // this will internally cache the package information self .api .package_info(package_name) .await .map(|_| ()) .map_err(|err| err.into()) } pub fn global_cache_root_folder(&self) -> PathBuf { self.global_npm_cache.root_folder() } } impl NpmResolver for ManagedCliNpmResolver { /// Gets the state of npm for the process. fn get_npm_process_state(&self) -> String { serde_json::to_string(&NpmProcessState { kind: NpmProcessStateKind::Snapshot( self .resolution .serialized_valid_snapshot() .into_serialized(), ), local_node_modules_path: self .fs_resolver .node_modules_path() .map(|p| p.to_string_lossy().to_string()), }) .unwrap() } fn resolve_package_folder_from_package( &self, name: &str, referrer: &ModuleSpecifier, mode: NodeResolutionMode, ) -> Result { let path = self .fs_resolver .resolve_package_folder_from_package(name, referrer, mode)?; let path = canonicalize_path_maybe_not_exists_with_fs(&path, self.fs.as_ref())?; log::debug!("Resolved {} from {} to {}", name, referrer, path.display()); Ok(path) } fn in_npm_package(&self, specifier: &ModuleSpecifier) -> bool { let root_dir_url = self.fs_resolver.root_dir_url(); debug_assert!(root_dir_url.as_str().ends_with('/')); specifier.as_ref().starts_with(root_dir_url.as_str()) } fn ensure_read_permission( &self, permissions: &dyn NodePermissions, path: &Path, ) -> Result<(), AnyError> { self.fs_resolver.ensure_read_permission(permissions, path) } } impl CliNpmResolver for ManagedCliNpmResolver { fn into_npm_resolver(self: Arc) -> Arc { self } fn clone_snapshotted(&self) -> Arc { // create a new snapshotted npm resolution and resolver let npm_resolution = Arc::new(NpmResolution::new( self.api.clone(), self.resolution.snapshot(), self.maybe_lockfile.clone(), )); Arc::new(ManagedCliNpmResolver::new( self.api.clone(), self.fs.clone(), npm_resolution.clone(), create_npm_fs_resolver( self.fs.clone(), self.global_npm_cache.clone(), &self.progress_bar, npm_resolution, self.root_node_modules_path().map(ToOwned::to_owned), self.npm_system_info.clone(), ), self.global_npm_cache.clone(), self.maybe_lockfile.clone(), self.package_json_deps_installer.clone(), self.progress_bar.clone(), self.npm_system_info.clone(), )) } fn as_inner(&self) -> InnerCliNpmResolverRef { InnerCliNpmResolverRef::Managed(self) } fn root_node_modules_path(&self) -> Option<&PathBuf> { self.fs_resolver.node_modules_path() } fn resolve_pkg_folder_from_deno_module_req( &self, req: &PackageReq, _referrer: &ModuleSpecifier, ) -> Result { let pkg_id = self.resolve_pkg_id_from_pkg_req(req)?; self.resolve_pkg_folder_from_pkg_id(&pkg_id) } fn check_state_hash(&self) -> Option { // We could go further and check all the individual // npm packages, but that's probably overkill. let mut package_reqs = self .resolution .package_reqs() .into_iter() .collect::>(); package_reqs.sort_by(|a, b| a.0.cmp(&b.0)); // determinism let mut hasher = FastInsecureHasher::new(); // ensure the cache gets busted when turning nodeModulesDir on or off // as this could cause changes in resolution hasher.write_hashable(self.fs_resolver.node_modules_path().is_some()); for (pkg_req, pkg_nv) in package_reqs { hasher.write_hashable(&pkg_req); hasher.write_hashable(&pkg_nv); } Some(hasher.finish()) } }