mirror of
https://github.com/denoland/deno.git
synced 2024-11-24 15:19:26 -05:00
c5887708a9
* cts support * better cjs/cts type checking * deno compile cjs/cts support * More efficient detect cjs (going towards stabilization) * Determination of whether .js, .ts, .jsx, or .tsx is cjs or esm is only done after loading * Support `import x = require(...);` Co-authored-by: Bartek Iwańczuk <biwanczuk@gmail.com>
1065 lines
33 KiB
Rust
1065 lines
33 KiB
Rust
// Copyright 2018-2024 the Deno authors. All rights reserved. MIT license.
|
|
|
|
use async_trait::async_trait;
|
|
use dashmap::DashMap;
|
|
use dashmap::DashSet;
|
|
use deno_ast::MediaType;
|
|
use deno_ast::ModuleKind;
|
|
use deno_config::workspace::MappedResolution;
|
|
use deno_config::workspace::MappedResolutionDiagnostic;
|
|
use deno_config::workspace::MappedResolutionError;
|
|
use deno_config::workspace::WorkspaceResolver;
|
|
use deno_core::anyhow::anyhow;
|
|
use deno_core::anyhow::Context;
|
|
use deno_core::error::AnyError;
|
|
use deno_core::url::Url;
|
|
use deno_core::ModuleSourceCode;
|
|
use deno_core::ModuleSpecifier;
|
|
use deno_graph::source::ResolutionMode;
|
|
use deno_graph::source::ResolveError;
|
|
use deno_graph::source::Resolver;
|
|
use deno_graph::source::UnknownBuiltInNodeModuleError;
|
|
use deno_graph::source::DEFAULT_JSX_IMPORT_SOURCE_MODULE;
|
|
use deno_graph::NpmLoadError;
|
|
use deno_graph::NpmResolvePkgReqsResult;
|
|
use deno_npm::resolution::NpmResolutionError;
|
|
use deno_package_json::PackageJsonDepValue;
|
|
use deno_resolver::sloppy_imports::SloppyImportsResolutionMode;
|
|
use deno_resolver::sloppy_imports::SloppyImportsResolver;
|
|
use deno_runtime::colors;
|
|
use deno_runtime::deno_fs;
|
|
use deno_runtime::deno_fs::FileSystem;
|
|
use deno_runtime::deno_node::is_builtin_node_module;
|
|
use deno_runtime::deno_node::NodeResolver;
|
|
use deno_runtime::deno_node::PackageJsonResolver;
|
|
use deno_semver::npm::NpmPackageReqReference;
|
|
use deno_semver::package::PackageReq;
|
|
use node_resolver::errors::ClosestPkgJsonError;
|
|
use node_resolver::errors::NodeResolveError;
|
|
use node_resolver::errors::NodeResolveErrorKind;
|
|
use node_resolver::errors::PackageFolderResolveErrorKind;
|
|
use node_resolver::errors::PackageFolderResolveIoError;
|
|
use node_resolver::errors::PackageNotFoundError;
|
|
use node_resolver::errors::PackageResolveErrorKind;
|
|
use node_resolver::errors::PackageSubpathResolveError;
|
|
use node_resolver::InNpmPackageChecker;
|
|
use node_resolver::NodeModuleKind;
|
|
use node_resolver::NodeResolution;
|
|
use node_resolver::NodeResolutionMode;
|
|
use std::borrow::Cow;
|
|
use std::path::Path;
|
|
use std::path::PathBuf;
|
|
use std::sync::Arc;
|
|
use thiserror::Error;
|
|
|
|
use crate::args::JsxImportSourceConfig;
|
|
use crate::args::DENO_DISABLE_PEDANTIC_NODE_WARNINGS;
|
|
use crate::node::CliNodeCodeTranslator;
|
|
use crate::npm::CliNpmResolver;
|
|
use crate::npm::InnerCliNpmResolverRef;
|
|
use crate::util::sync::AtomicFlag;
|
|
use crate::util::text_encoding::from_utf8_lossy_owned;
|
|
|
|
pub struct ModuleCodeStringSource {
|
|
pub code: ModuleSourceCode,
|
|
pub found_url: ModuleSpecifier,
|
|
pub media_type: MediaType,
|
|
}
|
|
|
|
#[derive(Debug, Clone)]
|
|
pub struct CliDenoResolverFs(pub Arc<dyn FileSystem>);
|
|
|
|
impl deno_resolver::fs::DenoResolverFs for CliDenoResolverFs {
|
|
fn read_to_string_lossy(&self, path: &Path) -> std::io::Result<String> {
|
|
self
|
|
.0
|
|
.read_text_file_lossy_sync(path, None)
|
|
.map_err(|e| e.into_io_error())
|
|
}
|
|
|
|
fn realpath_sync(&self, path: &Path) -> std::io::Result<PathBuf> {
|
|
self.0.realpath_sync(path).map_err(|e| e.into_io_error())
|
|
}
|
|
|
|
fn is_dir_sync(&self, path: &Path) -> bool {
|
|
self.0.is_dir_sync(path)
|
|
}
|
|
|
|
fn read_dir_sync(
|
|
&self,
|
|
dir_path: &Path,
|
|
) -> std::io::Result<Vec<deno_resolver::fs::DirEntry>> {
|
|
self
|
|
.0
|
|
.read_dir_sync(dir_path)
|
|
.map(|entries| {
|
|
entries
|
|
.into_iter()
|
|
.map(|e| deno_resolver::fs::DirEntry {
|
|
name: e.name,
|
|
is_file: e.is_file,
|
|
is_directory: e.is_directory,
|
|
})
|
|
.collect::<Vec<_>>()
|
|
})
|
|
.map_err(|err| err.into_io_error())
|
|
}
|
|
}
|
|
|
|
#[derive(Debug)]
|
|
pub struct CliNodeResolver {
|
|
cjs_tracker: Arc<CjsTracker>,
|
|
fs: Arc<dyn deno_fs::FileSystem>,
|
|
in_npm_pkg_checker: Arc<dyn InNpmPackageChecker>,
|
|
node_resolver: Arc<NodeResolver>,
|
|
npm_resolver: Arc<dyn CliNpmResolver>,
|
|
}
|
|
|
|
impl CliNodeResolver {
|
|
pub fn new(
|
|
cjs_tracker: Arc<CjsTracker>,
|
|
fs: Arc<dyn deno_fs::FileSystem>,
|
|
in_npm_pkg_checker: Arc<dyn InNpmPackageChecker>,
|
|
node_resolver: Arc<NodeResolver>,
|
|
npm_resolver: Arc<dyn CliNpmResolver>,
|
|
) -> Self {
|
|
Self {
|
|
cjs_tracker,
|
|
fs,
|
|
in_npm_pkg_checker,
|
|
node_resolver,
|
|
npm_resolver,
|
|
}
|
|
}
|
|
|
|
pub fn in_npm_package(&self, specifier: &ModuleSpecifier) -> bool {
|
|
self.in_npm_pkg_checker.in_npm_package(specifier)
|
|
}
|
|
|
|
pub fn resolve_if_for_npm_pkg(
|
|
&self,
|
|
specifier: &str,
|
|
referrer: &ModuleSpecifier,
|
|
mode: NodeResolutionMode,
|
|
) -> Result<Option<NodeResolution>, AnyError> {
|
|
let resolution_result = self.resolve(specifier, referrer, mode);
|
|
match resolution_result {
|
|
Ok(res) => Ok(Some(res)),
|
|
Err(err) => {
|
|
let err = err.into_kind();
|
|
match err {
|
|
NodeResolveErrorKind::RelativeJoin(_)
|
|
| NodeResolveErrorKind::PackageImportsResolve(_)
|
|
| NodeResolveErrorKind::UnsupportedEsmUrlScheme(_)
|
|
| NodeResolveErrorKind::DataUrlReferrer(_)
|
|
| NodeResolveErrorKind::TypesNotFound(_)
|
|
| NodeResolveErrorKind::FinalizeResolution(_) => Err(err.into()),
|
|
NodeResolveErrorKind::PackageResolve(err) => {
|
|
let err = err.into_kind();
|
|
match err {
|
|
PackageResolveErrorKind::ClosestPkgJson(_)
|
|
| PackageResolveErrorKind::InvalidModuleSpecifier(_)
|
|
| PackageResolveErrorKind::ExportsResolve(_)
|
|
| PackageResolveErrorKind::SubpathResolve(_) => Err(err.into()),
|
|
PackageResolveErrorKind::PackageFolderResolve(err) => {
|
|
match err.as_kind() {
|
|
PackageFolderResolveErrorKind::Io(
|
|
PackageFolderResolveIoError { package_name, .. },
|
|
)
|
|
| PackageFolderResolveErrorKind::PackageNotFound(
|
|
PackageNotFoundError { package_name, .. },
|
|
) => {
|
|
if self.in_npm_package(referrer) {
|
|
return Err(err.into());
|
|
}
|
|
if let Some(byonm_npm_resolver) =
|
|
self.npm_resolver.as_byonm()
|
|
{
|
|
if byonm_npm_resolver
|
|
.find_ancestor_package_json_with_dep(
|
|
package_name,
|
|
referrer,
|
|
)
|
|
.is_some()
|
|
{
|
|
return Err(anyhow!(
|
|
concat!(
|
|
"Could not resolve \"{}\", but found it in a package.json. ",
|
|
"Deno expects the node_modules/ directory to be up to date. ",
|
|
"Did you forget to run `deno install`?"
|
|
),
|
|
specifier
|
|
));
|
|
}
|
|
}
|
|
Ok(None)
|
|
}
|
|
PackageFolderResolveErrorKind::ReferrerNotFound(_) => {
|
|
if self.in_npm_package(referrer) {
|
|
return Err(err.into());
|
|
}
|
|
Ok(None)
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
pub fn resolve(
|
|
&self,
|
|
specifier: &str,
|
|
referrer: &ModuleSpecifier,
|
|
mode: NodeResolutionMode,
|
|
) -> Result<NodeResolution, NodeResolveError> {
|
|
let referrer_kind = if self
|
|
.cjs_tracker
|
|
.is_maybe_cjs(referrer, MediaType::from_specifier(referrer))
|
|
.map_err(|err| NodeResolveErrorKind::PackageResolve(err.into()))?
|
|
{
|
|
NodeModuleKind::Cjs
|
|
} else {
|
|
NodeModuleKind::Esm
|
|
};
|
|
|
|
let res =
|
|
self
|
|
.node_resolver
|
|
.resolve(specifier, referrer, referrer_kind, mode)?;
|
|
Ok(res)
|
|
}
|
|
|
|
pub fn resolve_req_reference(
|
|
&self,
|
|
req_ref: &NpmPackageReqReference,
|
|
referrer: &ModuleSpecifier,
|
|
mode: NodeResolutionMode,
|
|
) -> Result<ModuleSpecifier, AnyError> {
|
|
self.resolve_req_with_sub_path(
|
|
req_ref.req(),
|
|
req_ref.sub_path(),
|
|
referrer,
|
|
mode,
|
|
)
|
|
}
|
|
|
|
pub fn resolve_req_with_sub_path(
|
|
&self,
|
|
req: &PackageReq,
|
|
sub_path: Option<&str>,
|
|
referrer: &ModuleSpecifier,
|
|
mode: NodeResolutionMode,
|
|
) -> Result<ModuleSpecifier, AnyError> {
|
|
let package_folder = self
|
|
.npm_resolver
|
|
.resolve_pkg_folder_from_deno_module_req(req, referrer)?;
|
|
let resolution_result = self.resolve_package_sub_path_from_deno_module(
|
|
&package_folder,
|
|
sub_path,
|
|
Some(referrer),
|
|
mode,
|
|
);
|
|
match resolution_result {
|
|
Ok(url) => Ok(url),
|
|
Err(err) => {
|
|
if self.npm_resolver.as_byonm().is_some() {
|
|
let package_json_path = package_folder.join("package.json");
|
|
if !self.fs.exists_sync(&package_json_path) {
|
|
return Err(anyhow!(
|
|
"Could not find '{}'. Deno expects the node_modules/ directory to be up to date. Did you forget to run `deno install`?",
|
|
package_json_path.display(),
|
|
));
|
|
}
|
|
}
|
|
Err(err.into())
|
|
}
|
|
}
|
|
}
|
|
|
|
pub fn resolve_package_sub_path_from_deno_module(
|
|
&self,
|
|
package_folder: &Path,
|
|
sub_path: Option<&str>,
|
|
maybe_referrer: Option<&ModuleSpecifier>,
|
|
mode: NodeResolutionMode,
|
|
) -> Result<ModuleSpecifier, PackageSubpathResolveError> {
|
|
self.node_resolver.resolve_package_subpath_from_deno_module(
|
|
package_folder,
|
|
sub_path,
|
|
maybe_referrer,
|
|
mode,
|
|
)
|
|
}
|
|
|
|
pub fn handle_if_in_node_modules(
|
|
&self,
|
|
specifier: &ModuleSpecifier,
|
|
) -> Result<Option<ModuleSpecifier>, AnyError> {
|
|
// skip canonicalizing if we definitely know it's unnecessary
|
|
if specifier.scheme() == "file"
|
|
&& specifier.path().contains("/node_modules/")
|
|
{
|
|
// Specifiers in the node_modules directory are canonicalized
|
|
// so canoncalize then check if it's in the node_modules directory.
|
|
// If so, check if we need to store this specifier as being a CJS
|
|
// resolution.
|
|
let specifier = crate::node::resolve_specifier_into_node_modules(
|
|
specifier,
|
|
self.fs.as_ref(),
|
|
);
|
|
return Ok(Some(specifier));
|
|
}
|
|
|
|
Ok(None)
|
|
}
|
|
}
|
|
|
|
#[derive(Debug, Error)]
|
|
#[error("{media_type} files are not supported in npm packages: {specifier}")]
|
|
pub struct NotSupportedKindInNpmError {
|
|
pub media_type: MediaType,
|
|
pub specifier: Url,
|
|
}
|
|
|
|
// todo(dsherret): move to module_loader.rs (it seems to be here due to use in standalone)
|
|
#[derive(Clone)]
|
|
pub struct NpmModuleLoader {
|
|
cjs_tracker: Arc<CjsTracker>,
|
|
fs: Arc<dyn deno_fs::FileSystem>,
|
|
node_code_translator: Arc<CliNodeCodeTranslator>,
|
|
}
|
|
|
|
impl NpmModuleLoader {
|
|
pub fn new(
|
|
cjs_tracker: Arc<CjsTracker>,
|
|
fs: Arc<dyn deno_fs::FileSystem>,
|
|
node_code_translator: Arc<CliNodeCodeTranslator>,
|
|
) -> Self {
|
|
Self {
|
|
cjs_tracker,
|
|
node_code_translator,
|
|
fs,
|
|
}
|
|
}
|
|
|
|
pub async fn load(
|
|
&self,
|
|
specifier: &ModuleSpecifier,
|
|
maybe_referrer: Option<&ModuleSpecifier>,
|
|
) -> Result<ModuleCodeStringSource, AnyError> {
|
|
let file_path = specifier.to_file_path().unwrap();
|
|
let code = self
|
|
.fs
|
|
.read_file_async(file_path.clone(), None)
|
|
.await
|
|
.map_err(AnyError::from)
|
|
.with_context(|| {
|
|
if file_path.is_dir() {
|
|
// directory imports are not allowed when importing from an
|
|
// ES module, so provide the user with a helpful error message
|
|
let dir_path = file_path;
|
|
let mut msg = "Directory import ".to_string();
|
|
msg.push_str(&dir_path.to_string_lossy());
|
|
if let Some(referrer) = &maybe_referrer {
|
|
msg.push_str(" is not supported resolving import from ");
|
|
msg.push_str(referrer.as_str());
|
|
let entrypoint_name = ["index.mjs", "index.js", "index.cjs"]
|
|
.iter()
|
|
.find(|e| dir_path.join(e).is_file());
|
|
if let Some(entrypoint_name) = entrypoint_name {
|
|
msg.push_str("\nDid you mean to import ");
|
|
msg.push_str(entrypoint_name);
|
|
msg.push_str(" within the directory?");
|
|
}
|
|
}
|
|
msg
|
|
} else {
|
|
let mut msg = "Unable to load ".to_string();
|
|
msg.push_str(&file_path.to_string_lossy());
|
|
if let Some(referrer) = &maybe_referrer {
|
|
msg.push_str(" imported from ");
|
|
msg.push_str(referrer.as_str());
|
|
}
|
|
msg
|
|
}
|
|
})?;
|
|
|
|
let media_type = MediaType::from_specifier(specifier);
|
|
if media_type.is_emittable() {
|
|
return Err(AnyError::from(NotSupportedKindInNpmError {
|
|
media_type,
|
|
specifier: specifier.clone(),
|
|
}));
|
|
}
|
|
|
|
let code = if self.cjs_tracker.is_maybe_cjs(specifier, media_type)? {
|
|
// translate cjs to esm if it's cjs and inject node globals
|
|
let code = from_utf8_lossy_owned(code);
|
|
ModuleSourceCode::String(
|
|
self
|
|
.node_code_translator
|
|
.translate_cjs_to_esm(specifier, Some(Cow::Owned(code)))
|
|
.await?
|
|
.into_owned()
|
|
.into(),
|
|
)
|
|
} else {
|
|
// esm and json code is untouched
|
|
ModuleSourceCode::Bytes(code.into_boxed_slice().into())
|
|
};
|
|
|
|
Ok(ModuleCodeStringSource {
|
|
code,
|
|
found_url: specifier.clone(),
|
|
media_type: MediaType::from_specifier(specifier),
|
|
})
|
|
}
|
|
}
|
|
|
|
pub struct CjsTrackerOptions {
|
|
pub unstable_detect_cjs: bool,
|
|
}
|
|
|
|
/// Keeps track of what module specifiers were resolved as CJS.
|
|
///
|
|
/// Modules that are `.js` or `.ts` are only known to be CJS or
|
|
/// ESM after they're loaded based on their contents. So these files
|
|
/// will be "maybe CJS" until they're loaded.
|
|
#[derive(Debug)]
|
|
pub struct CjsTracker {
|
|
in_npm_pkg_checker: Arc<dyn InNpmPackageChecker>,
|
|
pkg_json_resolver: Arc<PackageJsonResolver>,
|
|
unstable_detect_cjs: bool,
|
|
known: DashMap<ModuleSpecifier, ModuleKind>,
|
|
}
|
|
|
|
impl CjsTracker {
|
|
pub fn new(
|
|
in_npm_pkg_checker: Arc<dyn InNpmPackageChecker>,
|
|
pkg_json_resolver: Arc<PackageJsonResolver>,
|
|
options: CjsTrackerOptions,
|
|
) -> Self {
|
|
Self {
|
|
in_npm_pkg_checker,
|
|
pkg_json_resolver,
|
|
unstable_detect_cjs: options.unstable_detect_cjs,
|
|
known: Default::default(),
|
|
}
|
|
}
|
|
|
|
/// Checks whether the file might be treated as CJS, but it's not for sure
|
|
/// yet because the source hasn't been loaded to see whether it contains
|
|
/// imports or exports.
|
|
pub fn is_maybe_cjs(
|
|
&self,
|
|
specifier: &ModuleSpecifier,
|
|
media_type: MediaType,
|
|
) -> Result<bool, ClosestPkgJsonError> {
|
|
self.treat_as_cjs_with_is_script(specifier, media_type, None)
|
|
}
|
|
|
|
/// Gets whether the file is CJS. If true, this is for sure
|
|
/// cjs because `is_script` is provided.
|
|
///
|
|
/// `is_script` should be `true` when the contents of the file at the
|
|
/// provided specifier are known to be a script and not an ES module.
|
|
pub fn is_cjs_with_known_is_script(
|
|
&self,
|
|
specifier: &ModuleSpecifier,
|
|
media_type: MediaType,
|
|
is_script: bool,
|
|
) -> Result<bool, ClosestPkgJsonError> {
|
|
self.treat_as_cjs_with_is_script(specifier, media_type, Some(is_script))
|
|
}
|
|
|
|
fn treat_as_cjs_with_is_script(
|
|
&self,
|
|
specifier: &ModuleSpecifier,
|
|
media_type: MediaType,
|
|
is_script: Option<bool>,
|
|
) -> Result<bool, ClosestPkgJsonError> {
|
|
let kind = match self
|
|
.get_known_kind_with_is_script(specifier, media_type, is_script)
|
|
{
|
|
Some(kind) => kind,
|
|
None => self.check_based_on_pkg_json(specifier)?,
|
|
};
|
|
Ok(kind.is_cjs())
|
|
}
|
|
|
|
pub fn get_known_kind(
|
|
&self,
|
|
specifier: &ModuleSpecifier,
|
|
media_type: MediaType,
|
|
) -> Option<ModuleKind> {
|
|
self.get_known_kind_with_is_script(specifier, media_type, None)
|
|
}
|
|
|
|
fn get_known_kind_with_is_script(
|
|
&self,
|
|
specifier: &ModuleSpecifier,
|
|
media_type: MediaType,
|
|
is_script: Option<bool>,
|
|
) -> Option<ModuleKind> {
|
|
if specifier.scheme() != "file" {
|
|
return Some(ModuleKind::Esm);
|
|
}
|
|
|
|
match media_type {
|
|
MediaType::Mts | MediaType::Mjs | MediaType::Dmts => Some(ModuleKind::Esm),
|
|
MediaType::Cjs | MediaType::Cts | MediaType::Dcts => Some(ModuleKind::Cjs),
|
|
MediaType::Dts => {
|
|
// dts files are always determined based on the package.json because
|
|
// they contain imports/exports even when considered CJS
|
|
if let Some(value) = self.known.get(specifier).map(|v| *v) {
|
|
Some(value)
|
|
} else {
|
|
let value = self.check_based_on_pkg_json(specifier).ok();
|
|
if let Some(value) = value {
|
|
self.known.insert(specifier.clone(), value);
|
|
}
|
|
Some(value.unwrap_or(ModuleKind::Esm))
|
|
}
|
|
}
|
|
MediaType::Wasm |
|
|
MediaType::Json => Some(ModuleKind::Esm),
|
|
MediaType::JavaScript
|
|
| MediaType::Jsx
|
|
| MediaType::TypeScript
|
|
| MediaType::Tsx
|
|
// treat these as unknown
|
|
| MediaType::Css
|
|
| MediaType::SourceMap
|
|
| MediaType::Unknown => {
|
|
if let Some(value) = self.known.get(specifier).map(|v| *v) {
|
|
if value.is_cjs() && is_script == Some(false) {
|
|
// we now know this is actually esm
|
|
self.known.insert(specifier.clone(), ModuleKind::Esm);
|
|
Some(ModuleKind::Esm)
|
|
} else {
|
|
Some(value)
|
|
}
|
|
} else if is_script == Some(false) {
|
|
// we know this is esm
|
|
self.known.insert(specifier.clone(), ModuleKind::Esm);
|
|
Some(ModuleKind::Esm)
|
|
} else {
|
|
None
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
fn check_based_on_pkg_json(
|
|
&self,
|
|
specifier: &ModuleSpecifier,
|
|
) -> Result<ModuleKind, ClosestPkgJsonError> {
|
|
if self.in_npm_pkg_checker.in_npm_package(specifier) {
|
|
if let Some(pkg_json) =
|
|
self.pkg_json_resolver.get_closest_package_json(specifier)?
|
|
{
|
|
let is_file_location_cjs = pkg_json.typ != "module";
|
|
Ok(ModuleKind::from_is_cjs(is_file_location_cjs))
|
|
} else {
|
|
Ok(ModuleKind::Cjs)
|
|
}
|
|
} else if self.unstable_detect_cjs {
|
|
if let Some(pkg_json) =
|
|
self.pkg_json_resolver.get_closest_package_json(specifier)?
|
|
{
|
|
let is_cjs_type = pkg_json.typ == "commonjs";
|
|
Ok(ModuleKind::from_is_cjs(is_cjs_type))
|
|
} else {
|
|
Ok(ModuleKind::Esm)
|
|
}
|
|
} else {
|
|
Ok(ModuleKind::Esm)
|
|
}
|
|
}
|
|
}
|
|
|
|
pub type CliSloppyImportsResolver =
|
|
SloppyImportsResolver<SloppyImportsCachedFs>;
|
|
|
|
/// A resolver that takes care of resolution, taking into account loaded
|
|
/// import map, JSX settings.
|
|
#[derive(Debug)]
|
|
pub struct CliGraphResolver {
|
|
node_resolver: Option<Arc<CliNodeResolver>>,
|
|
npm_resolver: Option<Arc<dyn CliNpmResolver>>,
|
|
sloppy_imports_resolver: Option<Arc<CliSloppyImportsResolver>>,
|
|
workspace_resolver: Arc<WorkspaceResolver>,
|
|
maybe_default_jsx_import_source: Option<String>,
|
|
maybe_default_jsx_import_source_types: Option<String>,
|
|
maybe_jsx_import_source_module: Option<String>,
|
|
maybe_vendor_specifier: Option<ModuleSpecifier>,
|
|
found_package_json_dep_flag: AtomicFlag,
|
|
bare_node_builtins_enabled: bool,
|
|
warned_pkgs: DashSet<PackageReq>,
|
|
}
|
|
|
|
pub struct CliGraphResolverOptions<'a> {
|
|
pub node_resolver: Option<Arc<CliNodeResolver>>,
|
|
pub npm_resolver: Option<Arc<dyn CliNpmResolver>>,
|
|
pub sloppy_imports_resolver: Option<Arc<CliSloppyImportsResolver>>,
|
|
pub workspace_resolver: Arc<WorkspaceResolver>,
|
|
pub bare_node_builtins_enabled: bool,
|
|
pub maybe_jsx_import_source_config: Option<JsxImportSourceConfig>,
|
|
pub maybe_vendor_dir: Option<&'a PathBuf>,
|
|
}
|
|
|
|
impl CliGraphResolver {
|
|
pub fn new(options: CliGraphResolverOptions) -> Self {
|
|
Self {
|
|
node_resolver: options.node_resolver,
|
|
npm_resolver: options.npm_resolver,
|
|
sloppy_imports_resolver: options.sloppy_imports_resolver,
|
|
workspace_resolver: options.workspace_resolver,
|
|
maybe_default_jsx_import_source: options
|
|
.maybe_jsx_import_source_config
|
|
.as_ref()
|
|
.and_then(|c| c.default_specifier.clone()),
|
|
maybe_default_jsx_import_source_types: options
|
|
.maybe_jsx_import_source_config
|
|
.as_ref()
|
|
.and_then(|c| c.default_types_specifier.clone()),
|
|
maybe_jsx_import_source_module: options
|
|
.maybe_jsx_import_source_config
|
|
.map(|c| c.module),
|
|
maybe_vendor_specifier: options
|
|
.maybe_vendor_dir
|
|
.and_then(|v| ModuleSpecifier::from_directory_path(v).ok()),
|
|
found_package_json_dep_flag: Default::default(),
|
|
bare_node_builtins_enabled: options.bare_node_builtins_enabled,
|
|
warned_pkgs: Default::default(),
|
|
}
|
|
}
|
|
|
|
pub fn as_graph_resolver(&self) -> &dyn Resolver {
|
|
self
|
|
}
|
|
|
|
pub fn create_graph_npm_resolver(&self) -> WorkerCliNpmGraphResolver {
|
|
WorkerCliNpmGraphResolver {
|
|
npm_resolver: self.npm_resolver.as_ref(),
|
|
found_package_json_dep_flag: &self.found_package_json_dep_flag,
|
|
bare_node_builtins_enabled: self.bare_node_builtins_enabled,
|
|
}
|
|
}
|
|
}
|
|
|
|
impl Resolver for CliGraphResolver {
|
|
fn default_jsx_import_source(&self) -> Option<String> {
|
|
self.maybe_default_jsx_import_source.clone()
|
|
}
|
|
|
|
fn default_jsx_import_source_types(&self) -> Option<String> {
|
|
self.maybe_default_jsx_import_source_types.clone()
|
|
}
|
|
|
|
fn jsx_import_source_module(&self) -> &str {
|
|
self
|
|
.maybe_jsx_import_source_module
|
|
.as_deref()
|
|
.unwrap_or(DEFAULT_JSX_IMPORT_SOURCE_MODULE)
|
|
}
|
|
|
|
fn resolve(
|
|
&self,
|
|
raw_specifier: &str,
|
|
referrer_range: &deno_graph::Range,
|
|
mode: ResolutionMode,
|
|
) -> Result<ModuleSpecifier, ResolveError> {
|
|
fn to_node_mode(mode: ResolutionMode) -> NodeResolutionMode {
|
|
match mode {
|
|
ResolutionMode::Execution => NodeResolutionMode::Execution,
|
|
ResolutionMode::Types => NodeResolutionMode::Types,
|
|
}
|
|
}
|
|
|
|
let referrer = &referrer_range.specifier;
|
|
|
|
// Use node resolution if we're in an npm package
|
|
if let Some(node_resolver) = self.node_resolver.as_ref() {
|
|
if referrer.scheme() == "file" && node_resolver.in_npm_package(referrer) {
|
|
return node_resolver
|
|
.resolve(raw_specifier, referrer, to_node_mode(mode))
|
|
.map(|res| res.into_url())
|
|
.map_err(|e| ResolveError::Other(e.into()));
|
|
}
|
|
}
|
|
|
|
// Attempt to resolve with the workspace resolver
|
|
let result: Result<_, ResolveError> = self
|
|
.workspace_resolver
|
|
.resolve(raw_specifier, referrer)
|
|
.map_err(|err| match err {
|
|
MappedResolutionError::Specifier(err) => ResolveError::Specifier(err),
|
|
MappedResolutionError::ImportMap(err) => {
|
|
ResolveError::Other(err.into())
|
|
}
|
|
MappedResolutionError::Workspace(err) => {
|
|
ResolveError::Other(err.into())
|
|
}
|
|
});
|
|
let result = match result {
|
|
Ok(resolution) => match resolution {
|
|
MappedResolution::Normal {
|
|
specifier,
|
|
maybe_diagnostic,
|
|
}
|
|
| MappedResolution::ImportMap {
|
|
specifier,
|
|
maybe_diagnostic,
|
|
} => {
|
|
if let Some(diagnostic) = maybe_diagnostic {
|
|
match &*diagnostic {
|
|
MappedResolutionDiagnostic::ConstraintNotMatchedLocalVersion { reference, .. } => {
|
|
if self.warned_pkgs.insert(reference.req().clone()) {
|
|
log::warn!("{} {}\n at {}", colors::yellow("Warning"), diagnostic, referrer_range);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
// do sloppy imports resolution if enabled
|
|
if let Some(sloppy_imports_resolver) = &self.sloppy_imports_resolver {
|
|
Ok(
|
|
sloppy_imports_resolver
|
|
.resolve(
|
|
&specifier,
|
|
match mode {
|
|
ResolutionMode::Execution => {
|
|
SloppyImportsResolutionMode::Execution
|
|
}
|
|
ResolutionMode::Types => SloppyImportsResolutionMode::Types,
|
|
},
|
|
)
|
|
.map(|s| s.into_specifier())
|
|
.unwrap_or(specifier),
|
|
)
|
|
} else {
|
|
Ok(specifier)
|
|
}
|
|
}
|
|
MappedResolution::WorkspaceJsrPackage { specifier, .. } => {
|
|
Ok(specifier)
|
|
}
|
|
MappedResolution::WorkspaceNpmPackage {
|
|
target_pkg_json: pkg_json,
|
|
sub_path,
|
|
..
|
|
} => self
|
|
.node_resolver
|
|
.as_ref()
|
|
.unwrap()
|
|
.resolve_package_sub_path_from_deno_module(
|
|
pkg_json.dir_path(),
|
|
sub_path.as_deref(),
|
|
Some(referrer),
|
|
to_node_mode(mode),
|
|
)
|
|
.map_err(|e| ResolveError::Other(e.into())),
|
|
MappedResolution::PackageJson {
|
|
dep_result,
|
|
alias,
|
|
sub_path,
|
|
..
|
|
} => {
|
|
// found a specifier in the package.json, so mark that
|
|
// we need to do an "npm install" later
|
|
self.found_package_json_dep_flag.raise();
|
|
|
|
dep_result
|
|
.as_ref()
|
|
.map_err(|e| ResolveError::Other(e.clone().into()))
|
|
.and_then(|dep| match dep {
|
|
PackageJsonDepValue::Req(req) => {
|
|
ModuleSpecifier::parse(&format!(
|
|
"npm:{}{}",
|
|
req,
|
|
sub_path.map(|s| format!("/{}", s)).unwrap_or_default()
|
|
))
|
|
.map_err(|e| ResolveError::Other(e.into()))
|
|
}
|
|
PackageJsonDepValue::Workspace(version_req) => self
|
|
.workspace_resolver
|
|
.resolve_workspace_pkg_json_folder_for_pkg_json_dep(
|
|
alias,
|
|
version_req,
|
|
)
|
|
.map_err(|e| ResolveError::Other(e.into()))
|
|
.and_then(|pkg_folder| {
|
|
self
|
|
.node_resolver
|
|
.as_ref()
|
|
.unwrap()
|
|
.resolve_package_sub_path_from_deno_module(
|
|
pkg_folder,
|
|
sub_path.as_deref(),
|
|
Some(referrer),
|
|
to_node_mode(mode),
|
|
)
|
|
.map_err(|e| ResolveError::Other(e.into()))
|
|
}),
|
|
})
|
|
}
|
|
},
|
|
Err(err) => Err(err),
|
|
};
|
|
|
|
// When the user is vendoring, don't allow them to import directly from the vendor/ directory
|
|
// as it might cause them confusion or duplicate dependencies. Additionally, this folder has
|
|
// special treatment in the language server so it will definitely cause issues/confusion there
|
|
// if they do this.
|
|
if let Some(vendor_specifier) = &self.maybe_vendor_specifier {
|
|
if let Ok(specifier) = &result {
|
|
if specifier.as_str().starts_with(vendor_specifier.as_str()) {
|
|
return Err(ResolveError::Other(anyhow!("Importing from the vendor directory is not permitted. Use a remote specifier instead or disable vendoring.")));
|
|
}
|
|
}
|
|
}
|
|
|
|
let Some(node_resolver) = &self.node_resolver else {
|
|
return result;
|
|
};
|
|
|
|
let is_byonm = self
|
|
.npm_resolver
|
|
.as_ref()
|
|
.is_some_and(|r| r.as_byonm().is_some());
|
|
match result {
|
|
Ok(specifier) => {
|
|
if let Ok(npm_req_ref) =
|
|
NpmPackageReqReference::from_specifier(&specifier)
|
|
{
|
|
// check if the npm specifier resolves to a workspace member
|
|
if let Some(pkg_folder) = self
|
|
.workspace_resolver
|
|
.resolve_workspace_pkg_json_folder_for_npm_specifier(
|
|
npm_req_ref.req(),
|
|
)
|
|
{
|
|
return node_resolver
|
|
.resolve_package_sub_path_from_deno_module(
|
|
pkg_folder,
|
|
npm_req_ref.sub_path(),
|
|
Some(referrer),
|
|
to_node_mode(mode),
|
|
)
|
|
.map_err(|e| ResolveError::Other(e.into()));
|
|
}
|
|
|
|
// do npm resolution for byonm
|
|
if is_byonm {
|
|
return node_resolver
|
|
.resolve_req_reference(&npm_req_ref, referrer, to_node_mode(mode))
|
|
.map_err(|err| err.into());
|
|
}
|
|
}
|
|
|
|
Ok(match node_resolver.handle_if_in_node_modules(&specifier)? {
|
|
Some(specifier) => specifier,
|
|
None => specifier,
|
|
})
|
|
}
|
|
Err(err) => {
|
|
// If byonm, check if the bare specifier resolves to an npm package
|
|
if is_byonm && referrer.scheme() == "file" {
|
|
let maybe_resolution = node_resolver
|
|
.resolve_if_for_npm_pkg(raw_specifier, referrer, to_node_mode(mode))
|
|
.map_err(ResolveError::Other)?;
|
|
if let Some(res) = maybe_resolution {
|
|
match res {
|
|
NodeResolution::Module(url) => return Ok(url),
|
|
NodeResolution::BuiltIn(_) => {
|
|
// don't resolve bare specifiers for built-in modules via node resolution
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
Err(err)
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
#[derive(Debug)]
|
|
pub struct WorkerCliNpmGraphResolver<'a> {
|
|
npm_resolver: Option<&'a Arc<dyn CliNpmResolver>>,
|
|
found_package_json_dep_flag: &'a AtomicFlag,
|
|
bare_node_builtins_enabled: bool,
|
|
}
|
|
|
|
#[async_trait(?Send)]
|
|
impl<'a> deno_graph::source::NpmResolver for WorkerCliNpmGraphResolver<'a> {
|
|
fn resolve_builtin_node_module(
|
|
&self,
|
|
specifier: &ModuleSpecifier,
|
|
) -> Result<Option<String>, UnknownBuiltInNodeModuleError> {
|
|
if specifier.scheme() != "node" {
|
|
return Ok(None);
|
|
}
|
|
|
|
let module_name = specifier.path().to_string();
|
|
if is_builtin_node_module(&module_name) {
|
|
Ok(Some(module_name))
|
|
} else {
|
|
Err(UnknownBuiltInNodeModuleError { module_name })
|
|
}
|
|
}
|
|
|
|
fn on_resolve_bare_builtin_node_module(
|
|
&self,
|
|
module_name: &str,
|
|
range: &deno_graph::Range,
|
|
) {
|
|
let deno_graph::Range {
|
|
start, specifier, ..
|
|
} = range;
|
|
let line = start.line + 1;
|
|
let column = start.character + 1;
|
|
if !*DENO_DISABLE_PEDANTIC_NODE_WARNINGS {
|
|
log::warn!("{} Resolving \"{module_name}\" as \"node:{module_name}\" at {specifier}:{line}:{column}. If you want to use a built-in Node module, add a \"node:\" prefix.", colors::yellow("Warning"))
|
|
}
|
|
}
|
|
|
|
fn load_and_cache_npm_package_info(&self, package_name: &str) {
|
|
match self.npm_resolver {
|
|
Some(npm_resolver) if npm_resolver.as_managed().is_some() => {
|
|
let npm_resolver = npm_resolver.clone();
|
|
let package_name = package_name.to_string();
|
|
deno_core::unsync::spawn(async move {
|
|
if let Some(managed) = npm_resolver.as_managed() {
|
|
let _ignore = managed.cache_package_info(&package_name).await;
|
|
}
|
|
});
|
|
}
|
|
_ => {}
|
|
}
|
|
}
|
|
|
|
async fn resolve_pkg_reqs(
|
|
&self,
|
|
package_reqs: &[PackageReq],
|
|
) -> NpmResolvePkgReqsResult {
|
|
match &self.npm_resolver {
|
|
Some(npm_resolver) => {
|
|
let npm_resolver = match npm_resolver.as_inner() {
|
|
InnerCliNpmResolverRef::Managed(npm_resolver) => npm_resolver,
|
|
// if we are using byonm, then this should never be called because
|
|
// we don't use deno_graph's npm resolution in this case
|
|
InnerCliNpmResolverRef::Byonm(_) => unreachable!(),
|
|
};
|
|
|
|
let top_level_result = if self.found_package_json_dep_flag.is_raised() {
|
|
npm_resolver
|
|
.ensure_top_level_package_json_install()
|
|
.await
|
|
.map(|_| ())
|
|
} else {
|
|
Ok(())
|
|
};
|
|
|
|
let result = npm_resolver.add_package_reqs_raw(package_reqs).await;
|
|
|
|
NpmResolvePkgReqsResult {
|
|
results: result
|
|
.results
|
|
.into_iter()
|
|
.map(|r| {
|
|
r.map_err(|err| match err {
|
|
NpmResolutionError::Registry(e) => {
|
|
NpmLoadError::RegistryInfo(Arc::new(e.into()))
|
|
}
|
|
NpmResolutionError::Resolution(e) => {
|
|
NpmLoadError::PackageReqResolution(Arc::new(e.into()))
|
|
}
|
|
NpmResolutionError::DependencyEntry(e) => {
|
|
NpmLoadError::PackageReqResolution(Arc::new(e.into()))
|
|
}
|
|
})
|
|
})
|
|
.collect(),
|
|
dep_graph_result: match top_level_result {
|
|
Ok(()) => result.dependencies_result.map_err(Arc::new),
|
|
Err(err) => Err(Arc::new(err)),
|
|
},
|
|
}
|
|
}
|
|
None => {
|
|
let err = Arc::new(anyhow!(
|
|
"npm specifiers were requested; but --no-npm is specified"
|
|
));
|
|
NpmResolvePkgReqsResult {
|
|
results: package_reqs
|
|
.iter()
|
|
.map(|_| Err(NpmLoadError::RegistryInfo(err.clone())))
|
|
.collect(),
|
|
dep_graph_result: Err(err),
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
fn enables_bare_builtin_node_module(&self) -> bool {
|
|
self.bare_node_builtins_enabled
|
|
}
|
|
}
|
|
|
|
#[derive(Debug)]
|
|
pub struct SloppyImportsCachedFs {
|
|
fs: Arc<dyn deno_fs::FileSystem>,
|
|
cache: Option<
|
|
DashMap<
|
|
PathBuf,
|
|
Option<deno_resolver::sloppy_imports::SloppyImportsFsEntry>,
|
|
>,
|
|
>,
|
|
}
|
|
|
|
impl SloppyImportsCachedFs {
|
|
pub fn new(fs: Arc<dyn FileSystem>) -> Self {
|
|
Self {
|
|
fs,
|
|
cache: Some(Default::default()),
|
|
}
|
|
}
|
|
|
|
pub fn new_without_stat_cache(fs: Arc<dyn FileSystem>) -> Self {
|
|
Self { fs, cache: None }
|
|
}
|
|
}
|
|
|
|
impl deno_resolver::sloppy_imports::SloppyImportResolverFs
|
|
for SloppyImportsCachedFs
|
|
{
|
|
fn stat_sync(
|
|
&self,
|
|
path: &Path,
|
|
) -> Option<deno_resolver::sloppy_imports::SloppyImportsFsEntry> {
|
|
if let Some(cache) = &self.cache {
|
|
if let Some(entry) = cache.get(path) {
|
|
return *entry;
|
|
}
|
|
}
|
|
|
|
let entry = self.fs.stat_sync(path).ok().and_then(|stat| {
|
|
if stat.is_file {
|
|
Some(deno_resolver::sloppy_imports::SloppyImportsFsEntry::File)
|
|
} else if stat.is_directory {
|
|
Some(deno_resolver::sloppy_imports::SloppyImportsFsEntry::Dir)
|
|
} else {
|
|
None
|
|
}
|
|
});
|
|
|
|
if let Some(cache) = &self.cache {
|
|
cache.insert(path.to_owned(), entry);
|
|
}
|
|
entry
|
|
}
|
|
}
|