// Copyright 2018-2023 the Deno authors. All rights reserved. MIT license. mod common; mod global; mod local; use deno_ast::ModuleSpecifier; use deno_core::anyhow::bail; use deno_core::anyhow::Context; use deno_core::error::AnyError; use deno_core::parking_lot::Mutex; use deno_core::serde_json; use deno_graph::npm::NpmPackageNv; use deno_graph::npm::NpmPackageReq; use deno_runtime::deno_node::NodePermissions; use deno_runtime::deno_node::NodeResolutionMode; use deno_runtime::deno_node::PathClean; use deno_runtime::deno_node::RequireNpmResolver; use global::GlobalNpmPackageResolver; use serde::Deserialize; use serde::Serialize; use std::collections::HashMap; use std::path::Path; use std::path::PathBuf; use std::sync::Arc; use crate::args::Lockfile; use crate::util::fs::canonicalize_path_maybe_not_exists; use self::common::NpmPackageFsResolver; use self::local::LocalNpmPackageResolver; use super::resolution::NpmResolution; use super::NpmCache; use super::NpmPackageId; use super::NpmRegistryApi; use super::NpmResolutionSnapshot; /// State provided to the process via an environment variable. #[derive(Clone, Debug, Serialize, Deserialize)] pub struct NpmProcessState { pub snapshot: NpmResolutionSnapshot, pub local_node_modules_path: Option, } #[derive(Clone)] pub struct NpmPackageResolver { fs_resolver: Arc, local_node_modules_path: Option, api: NpmRegistryApi, resolution: NpmResolution, cache: NpmCache, maybe_lockfile: Option>>, } impl std::fmt::Debug for NpmPackageResolver { fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { f.debug_struct("NpmPackageResolver") .field("fs_resolver", &"") .field("local_node_modules_path", &self.local_node_modules_path) .field("api", &"") .field("resolution", &"") .field("cache", &"") .field("maybe_lockfile", &"") .finish() } } impl NpmPackageResolver { pub fn new(cache: NpmCache, api: NpmRegistryApi) -> Self { Self::new_inner(cache, api, None, None, None) } pub async fn new_with_maybe_lockfile( cache: NpmCache, api: NpmRegistryApi, local_node_modules_path: Option, initial_snapshot: Option, maybe_lockfile: Option>>, ) -> Result { let mut initial_snapshot = initial_snapshot; if initial_snapshot.is_none() { if let Some(lockfile) = &maybe_lockfile { if !lockfile.lock().overwrite { initial_snapshot = Some( NpmResolutionSnapshot::from_lockfile(lockfile.clone(), &api) .await .with_context(|| { format!( "failed reading lockfile '{}'", lockfile.lock().filename.display() ) })?, ) } } } Ok(Self::new_inner( cache, api, local_node_modules_path, initial_snapshot, maybe_lockfile, )) } fn new_inner( cache: NpmCache, api: NpmRegistryApi, local_node_modules_path: Option, maybe_snapshot: Option, maybe_lockfile: Option>>, ) -> Self { let registry_url = api.base_url().to_owned(); let resolution = NpmResolution::new(api.clone(), maybe_snapshot, maybe_lockfile.clone()); let fs_resolver: Arc = match &local_node_modules_path { Some(node_modules_folder) => Arc::new(LocalNpmPackageResolver::new( cache.clone(), registry_url, node_modules_folder.clone(), resolution.clone(), )), None => Arc::new(GlobalNpmPackageResolver::new( cache.clone(), registry_url, resolution.clone(), )), }; Self { fs_resolver, local_node_modules_path, api, resolution, cache, maybe_lockfile, } } pub fn api(&self) -> &NpmRegistryApi { &self.api } pub fn resolution(&self) -> &NpmResolution { &self.resolution } /// Resolves an npm package folder path from a Deno module. pub fn resolve_package_folder_from_deno_module( &self, pkg_nv: &NpmPackageNv, ) -> Result { let pkg_id = self.resolution.resolve_pkg_id_from_deno_module(pkg_nv)?; self.resolve_pkg_folder_from_deno_module_at_pkg_id(&pkg_id) } fn resolve_pkg_folder_from_deno_module_at_pkg_id( &self, pkg_id: &NpmPackageId, ) -> Result { let path = self .fs_resolver .resolve_package_folder_from_deno_module(pkg_id)?; let path = canonicalize_path_maybe_not_exists(&path)?; log::debug!( "Resolved package folder of {} to {}", pkg_id.as_serialized(), path.display() ); Ok(path) } /// Resolves an npm package folder path from an npm package referrer. pub 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)?; log::debug!("Resolved {} from {} to {}", name, referrer, path.display()); Ok(path) } /// Resolve the root folder of the package the provided specifier is in. /// /// This will error when the provided specifier is not in an npm package. pub fn resolve_package_folder_from_specifier( &self, specifier: &ModuleSpecifier, ) -> Result { let path = self .fs_resolver .resolve_package_folder_from_specifier(specifier)?; log::debug!( "Resolved package folder of {} to {}", specifier, path.display() ); Ok(path) } /// Attempts to get the package size in bytes. pub fn package_size( &self, package_id: &NpmPackageId, ) -> Result { self.fs_resolver.package_size(package_id) } /// Gets if the provided specifier is in an npm package. pub 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()) } /// If the resolver has resolved any npm packages. pub fn has_packages(&self) -> bool { self.resolution.has_packages() } /// Adds the package reqs from a package.json if they exist. pub async fn add_package_json_deps( &self, maybe_package_json_deps: Option<&HashMap>, ) -> Result<(), AnyError> { if let Some(deps) = maybe_package_json_deps { let mut package_reqs = deps.values().cloned().collect::>(); package_reqs.sort(); // deterministic resolution self.add_package_reqs(package_reqs).await?; } Ok(()) } /// Adds package requirements to the resolver and ensures everything is setup. pub async fn add_package_reqs( &self, packages: Vec, ) -> 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: Vec, ) -> Result<(), AnyError> { self.resolution.set_package_reqs(packages).await } /// Gets the state of npm for the process. pub fn get_npm_process_state(&self) -> String { serde_json::to_string(&NpmProcessState { snapshot: self.snapshot(), local_node_modules_path: self .local_node_modules_path .as_ref() .map(|p| p.to_string_lossy().to_string()), }) .unwrap() } /// Gets a new resolver with a new snapshotted state. pub fn snapshotted(&self) -> Self { Self::new_inner( self.cache.clone(), self.api.clone(), self.local_node_modules_path.clone(), Some(self.snapshot()), None, ) } pub fn snapshot(&self) -> NpmResolutionSnapshot { self.resolution.snapshot() } 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 self .resolution .add_package_reqs(vec![NpmPackageReq::from_str("@types/node").unwrap()]) .await?; self.fs_resolver.cache_packages().await?; Ok(()) } pub async fn resolve_pending(&self) -> Result<(), AnyError> { self.resolution.resolve_pending().await?; self.fs_resolver.cache_packages().await?; Ok(()) } } impl RequireNpmResolver for NpmPackageResolver { fn resolve_package_folder_from_package( &self, specifier: &str, referrer: &std::path::Path, mode: NodeResolutionMode, ) -> Result { let referrer = path_to_specifier(referrer)?; self.resolve_package_folder_from_package(specifier, &referrer, mode) } fn resolve_package_folder_from_path( &self, path: &Path, ) -> Result { let specifier = path_to_specifier(path)?; self.resolve_package_folder_from_specifier(&specifier) } fn in_npm_package(&self, path: &Path) -> bool { let specifier = match ModuleSpecifier::from_file_path(path.to_path_buf().clean()) { Ok(p) => p, Err(_) => return false, }; self .resolve_package_folder_from_specifier(&specifier) .is_ok() } fn ensure_read_permission( &self, permissions: &mut dyn NodePermissions, path: &Path, ) -> Result<(), AnyError> { self.fs_resolver.ensure_read_permission(permissions, path) } } fn path_to_specifier(path: &Path) -> Result { match ModuleSpecifier::from_file_path(path.to_path_buf().clean()) { Ok(specifier) => Ok(specifier), Err(()) => bail!("Could not convert '{}' to url.", path.display()), } }