Skip to content

Commit

Permalink
fix(node): use closest package.json to resolve package.json imports (d…
Browse files Browse the repository at this point in the history
  • Loading branch information
dsherret committed Nov 4, 2023
1 parent 0b75a71 commit e4c947d
Show file tree
Hide file tree
Showing 25 changed files with 149 additions and 123 deletions.
25 changes: 13 additions & 12 deletions cli/lsp/analysis.rs
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ use super::tsc;

use crate::npm::CliNpmResolver;
use crate::tools::lint::create_linter;
use crate::util::path::specifier_to_file_path;

use deno_ast::SourceRange;
use deno_ast::SourceRangedForSpanned;
Expand All @@ -20,9 +21,10 @@ use deno_core::serde_json;
use deno_core::serde_json::json;
use deno_core::ModuleSpecifier;
use deno_lint::rules::LintRule;
use deno_runtime::deno_node::NodeResolver;
use deno_runtime::deno_node::NpmResolver;
use deno_runtime::deno_node::PackageJson;
use deno_runtime::deno_node::PathClean;
use deno_runtime::permissions::PermissionsContainer;
use deno_semver::package::PackageReq;
use import_map::ImportMap;
use once_cell::sync::Lazy;
Expand Down Expand Up @@ -161,18 +163,21 @@ fn code_as_string(code: &Option<lsp::NumberOrString>) -> String {
pub struct TsResponseImportMapper<'a> {
documents: &'a Documents,
maybe_import_map: Option<&'a ImportMap>,
node_resolver: Option<&'a NodeResolver>,
npm_resolver: Option<&'a dyn CliNpmResolver>,
}

impl<'a> TsResponseImportMapper<'a> {
pub fn new(
documents: &'a Documents,
maybe_import_map: Option<&'a ImportMap>,
node_resolver: Option<&'a NodeResolver>,
npm_resolver: Option<&'a dyn CliNpmResolver>,
) -> Self {
Self {
documents,
maybe_import_map,
node_resolver,
npm_resolver,
}
}
Expand Down Expand Up @@ -249,18 +254,14 @@ impl<'a> TsResponseImportMapper<'a> {
&self,
specifier: &ModuleSpecifier,
) -> Option<String> {
let specifier_path = specifier.to_file_path().ok()?;
let root_folder = self
.npm_resolver
.as_ref()
.and_then(|r| r.resolve_package_folder_from_path(specifier).ok())
let node_resolver = self.node_resolver?;
let package_json = node_resolver
.get_closest_package_json(specifier, &PermissionsContainer::allow_all())
.ok()
.flatten()?;
let package_json_path = root_folder.join("package.json");
let package_json_text = std::fs::read_to_string(&package_json_path).ok()?;
let package_json =
PackageJson::load_from_string(package_json_path, package_json_text)
.ok()?;
let root_folder = package_json.path.parent()?;

let specifier_path = specifier_to_file_path(specifier).ok()?;
let mut search_paths = vec![specifier_path.clone()];
// TypeScript will provide a .js extension for quick fixes, so do
// a search for the .d.ts file instead
Expand All @@ -271,7 +272,7 @@ impl<'a> TsResponseImportMapper<'a> {
for search_path in search_paths {
if let Some(exports) = &package_json.exports {
if let Some(result) = try_reverse_map_package_json_exports(
&root_folder,
root_folder,
&search_path,
exports,
) {
Expand Down
1 change: 1 addition & 0 deletions cli/lsp/language_server.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2127,6 +2127,7 @@ impl Inner {
TsResponseImportMapper::new(
&self.documents,
self.maybe_import_map.as_deref(),
self.npm.node_resolver.as_deref(),
self.npm.resolver.as_deref(),
)
}
Expand Down
44 changes: 3 additions & 41 deletions cli/npm/byonm.rs
Original file line number Diff line number Diff line change
Expand Up @@ -91,16 +91,16 @@ impl NpmResolver for ByonmCliNpmResolver {
fn inner(
fs: &dyn FileSystem,
name: &str,
package_root_path: &Path,
referrer: &ModuleSpecifier,
mode: NodeResolutionMode,
) -> Result<PathBuf, AnyError> {
let referrer_file = specifier_to_file_path(referrer)?;
let types_pkg_name = if mode.is_types() && !name.starts_with("@types/") {
Some(types_package_name(name))
} else {
None
};
let mut current_folder = package_root_path;
let mut current_folder = referrer_file.parent().unwrap();
loop {
let node_modules_folder = if current_folder.ends_with("node_modules") {
Cow::Borrowed(current_folder)
Expand Down Expand Up @@ -135,48 +135,10 @@ impl NpmResolver for ByonmCliNpmResolver {
);
}

let package_root_path =
self.resolve_package_folder_from_path(referrer)?.unwrap(); // todo(byonm): don't unwrap
let path = inner(&*self.fs, name, &package_root_path, referrer, mode)?;
let path = inner(&*self.fs, name, referrer, mode)?;
Ok(self.fs.realpath_sync(&path)?)
}

fn resolve_package_folder_from_path(
&self,
specifier: &deno_core::ModuleSpecifier,
) -> Result<Option<PathBuf>, AnyError> {
let path = specifier.to_file_path().unwrap(); // todo(byonm): don't unwrap
let path = self.fs.realpath_sync(&path)?;
if self.in_npm_package(specifier) {
let mut path = path.as_path();
while let Some(parent) = path.parent() {
if parent
.file_name()
.and_then(|f| f.to_str())
.map(|s| s.to_ascii_lowercase())
.as_deref()
== Some("node_modules")
{
return Ok(Some(path.to_path_buf()));
} else {
path = parent;
}
}
} else {
// find the folder with a package.json
// todo(dsherret): not exactly correct, but good enough for a first pass
let mut path = path.as_path();
while let Some(parent) = path.parent() {
if self.fs.exists_sync(&parent.join("package.json")) {
return Ok(Some(parent.to_path_buf()));
} else {
path = parent;
}
}
}
Ok(None)
}

fn in_npm_package(&self, specifier: &ModuleSpecifier) -> bool {
specifier.scheme() == "file"
&& specifier
Expand Down
18 changes: 0 additions & 18 deletions cli/npm/managed/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -505,24 +505,6 @@ impl NpmResolver for ManagedCliNpmResolver {
Ok(path)
}

fn resolve_package_folder_from_path(
&self,
specifier: &ModuleSpecifier,
) -> Result<Option<PathBuf>, AnyError> {
let Some(path) = self
.fs_resolver
.resolve_package_folder_from_specifier(specifier)?
else {
return Ok(None);
};
log::debug!(
"Resolved package folder of {} to {}",
specifier,
path.display()
);
Ok(Some(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('/'));
Expand Down
25 changes: 25 additions & 0 deletions cli/tests/integration/npm_tests.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2505,3 +2505,28 @@ console.log(add(1, 2));
.run();
output.assert_matches_text("Check file:https:///[WILDCARD]/project-b/main.ts\n");
}

itest!(imports_package_json {
args: "run --node-modules-dir=false npm/imports_package_json/main.js",
output: "npm/imports_package_json/main.out",
envs: env_vars_for_npm_tests(),
http_server: true,
});

itest!(imports_package_json_import_not_defined {
args:
"run --node-modules-dir=false npm/imports_package_json/import_not_defined.js",
output: "npm/imports_package_json/import_not_defined.out",
envs: env_vars_for_npm_tests(),
exit_code: 1,
http_server: true,
});

itest!(imports_package_json_sub_path_import_not_defined {
args:
"run --node-modules-dir=false npm/imports_package_json/sub_path_import_not_defined.js",
output: "npm/imports_package_json/sub_path_import_not_defined.out",
envs: env_vars_for_npm_tests(),
exit_code: 1,
http_server: true,
});
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
import data from "@denotest/imports-package-json/import-not-defined";

console.log(data);
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Download https://localhost:4545/npm/registry/@denotest/imports-package-json
Download https://localhost:4545/npm/registry/@denotest/imports-package-json/1.0.0.tgz
error: Could not resolve '#not-defined' from 'file:https:///[WILDCARD]/@denotest/imports-package-json/1.0.0/import_not_defined.js'.

Caused by:
[ERR_PACKAGE_IMPORT_NOT_DEFINED] Package import specifier "#not-defined" is not defined in package [WILDCARD]package.json imported from [WILDCARD]import_not_defined.js
4 changes: 4 additions & 0 deletions cli/tests/testdata/npm/imports_package_json/main.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
import data from "@denotest/imports-package-json";

console.log(data.hi);
console.log(data.bye);
4 changes: 4 additions & 0 deletions cli/tests/testdata/npm/imports_package_json/main.out
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
Download https://localhost:4545/npm/registry/@denotest/imports-package-json
Download https://localhost:4545/npm/registry/@denotest/imports-package-json/1.0.0.tgz
hi
bye
6 changes: 6 additions & 0 deletions cli/tests/testdata/npm/imports_package_json/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"name": "my-test",
"dependencies": {
"@denotest/imports-package-json": "1.0.0"
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
import data from "@denotest/imports-package-json/sub-path-import-not-defined";

console.log(data);
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Download https://localhost:4545/npm/registry/@denotest/imports-package-json
Download https://localhost:4545/npm/registry/@denotest/imports-package-json/1.0.0.tgz
error: Could not resolve '#hi' from 'file:https:///[WILDCARD]/@denotest/imports-package-json/1.0.0/sub_path/import_not_defined.js'.

Caused by:
[ERR_PACKAGE_IMPORT_NOT_DEFINED] Package import specifier "#hi" is not defined in package [WILDCARD]sub_path[WILDCARD]package.json imported from [WILDCARD]import_not_defined.js
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
export default "hi";
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
import notDefined from "#not-defined";

export default notDefined;
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
import hi from "#hi";
import bye from "./sub_path/main.js";

export default {
hi,
bye,
};
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
{
"name": "imports-package-json",
"type": "module",
"version": "1.0.0",
"description": "",
"license": "ISC",
"author": "",
"exports": {
".": "./main.js",
"./import-not-defined": "./import_not_defined.js",
"./sub-path-import-not-defined": "./sub_path/import_not_defined.js"
},
"imports": {
"#hi": "./hi.js"
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
export default "bye";
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
// this won't be defined in the closest package.json and will fail
import hi from "#hi";

export default hi;
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
import bye from "#bye";

export default bye;
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"type": "module",
"imports": {
"#bye": "./bye.js"
}
}
5 changes: 3 additions & 2 deletions ext/node/errors.rs
Original file line number Diff line number Diff line change
Expand Up @@ -138,11 +138,12 @@ pub fn err_package_import_not_defined(
base: &str,
) -> AnyError {
let mut msg = format!(
"[ERR_PACKAGE_IMPORT_NOT_DEFINED] Package import specifier \"{specifier}\" is not defined in"
"[ERR_PACKAGE_IMPORT_NOT_DEFINED] Package import specifier \"{specifier}\" is not defined"
);

if let Some(package_path) = package_path {
msg = format!("{msg} in package {package_path}package.json");
let pkg_json_path = PathBuf::from(package_path).join("package.json");
msg = format!("{} in package {}", msg, pkg_json_path.display());
}

msg = format!("{msg} imported from {base}");
Expand Down
6 changes: 0 additions & 6 deletions ext/node/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -81,12 +81,6 @@ pub trait NpmResolver: std::fmt::Debug + MaybeSend + MaybeSync {
mode: NodeResolutionMode,
) -> Result<PathBuf, AnyError>;

/// Resolves the npm package folder path from the specified path.
fn resolve_package_folder_from_path(
&self,
specifier: &ModuleSpecifier,
) -> Result<Option<PathBuf>, AnyError>;

fn in_npm_package(&self, specifier: &ModuleSpecifier) -> bool;

fn in_npm_package_at_path(&self, path: &Path) -> bool {
Expand Down
2 changes: 1 addition & 1 deletion ext/node/ops/require.rs
Original file line number Diff line number Diff line change
Expand Up @@ -389,7 +389,7 @@ where
let node_resolver = state.borrow::<Rc<NodeResolver>>();
let permissions = state.borrow::<P>();
let pkg = node_resolver
.get_package_scope_config(
.get_closest_package_json(
&Url::from_file_path(parent_path.unwrap()).unwrap(),
permissions,
)
Expand Down
Loading

0 comments on commit e4c947d

Please sign in to comment.