Deno/deno
1
0
Fork 0
mirror of https://github.com/denoland/deno.git synced 2024-11-22 04:51:22 +00:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity

BREAKING(unstable): remove --compat mode (#15678)

Browse Source 
This commit removes "compat" mode. We shipped support for "npm:" specifier
support in v1.25 and that is preferred way to interact with Node code that we
will iterate and improve upon.
This commit is contained in:
Bartek Iwańczuk 2022-09-03 18:19:30 +02:00 committed by GitHub
parent fc4025c878
commit e324151520
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
79 changed files with 12 additions and 2355 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
cli/args/flags.rs
View File

@ -312,9 +312,6 @@ pub struct Flags {
pub lock: Option<PathBuf>,
pub log_level: Option<Level>,
pub no_remote: bool,
/// If true, a list of Node built-in modules will be injected into
/// the import map.
pub compat: bool,
pub no_prompt: bool,
pub reload: bool,
pub seed: Option<u64>,
@ -1869,7 +1866,6 @@ fn runtime_args(
.arg(v8_flags_arg())
.arg(seed_arg())
.arg(enable_testing_features_arg())
.arg(compat_arg())
}
fn inspect_args(app: Command) -> Command {
@ -2009,21 +2005,6 @@ fn seed_arg<'a>() -> Arg<'a> {
})
}
static COMPAT_HELP: Lazy<String> = Lazy::new(|| {
format!(
"See https://deno.land/manual@v{}/node/compatibility_mode",
SHORT_VERSION.as_str()
)
});
fn compat_arg<'a>() -> Arg<'a> {
Arg::new("compat")
.long("compat")
.requires("unstable")
.help("UNSTABLE: Node compatibility mode.")
.long_help(COMPAT_HELP.as_str())
}
fn watch_arg<'a>(takes_files: bool) -> Arg<'a> {
let arg = Arg::new("watch")
.long("watch")
@ -2916,7 +2897,6 @@ fn runtime_args_parse(
location_arg_parse(flags, matches);
v8_flags_arg_parse(flags, matches);
seed_arg_parse(flags, matches);
compat_arg_parse(flags, matches);
enable_testing_features_arg_parse(flags, matches);
}
@ -3001,12 +2981,6 @@ fn seed_arg_parse(flags: &mut Flags, matches: &ArgMatches) {
}
}
fn compat_arg_parse(flags: &mut Flags, matches: &ArgMatches) {
if matches.is_present("compat") {
flags.compat = true;
}
}
fn no_check_arg_parse(flags: &mut Flags, matches: &clap::ArgMatches) {
if let Some(cache_type) = matches.value_of("no-check") {
match cache_type {
@ -5565,23 +5539,6 @@ mod tests {
.contains("Expected protocol \"http\" or \"https\""));
}
#[test]
fn compat() {
let r =
flags_from_vec(svec!["deno", "run", "--compat", "--unstable", "foo.js"]);
assert_eq!(
r.unwrap(),
Flags {
subcommand: DenoSubcommand::Run(RunFlags {
script: "foo.js".to_string(),
}),
compat: true,
unstable: true,
..Flags::default()
}
);
}
#[test]
fn test_config_path_args() {
let flags = flags_from_vec(svec!["deno", "run", "foo.js"]).unwrap();

8
cli/args/mod.rs
View File

@ -35,7 +35,6 @@ use std::net::SocketAddr;
use std::path::PathBuf;
use crate::args::config_file::JsxImportSourceConfig;
use crate::compat;
use crate::deno_dir::DenoDir;
use crate::emit::get_ts_config_for_emit;
use crate::emit::TsConfigType;
@ -230,9 +229,6 @@ impl CliOptions {
imports.extend(config_imports);
}
}
if self.flags.compat {
imports.extend(compat::get_node_imports());
}
if imports.is_empty() {
Ok(None)
} else {
@ -277,10 +273,6 @@ impl CliOptions {
.unwrap_or(false)
}
pub fn compat(&self) -> bool {
self.flags.compat
}
pub fn coverage_dir(&self) -> Option<String> {
fn allow_coverage(sub_command: &DenoSubcommand) -> bool {
match sub_command {

1288
cli/compat/esm_resolver.rs
View File

File diff suppressed because it is too large Load Diff

190
cli/compat/mod.rs
View File

@ -1,190 +0,0 @@
// Copyright 2018-2022 the Deno authors. All rights reserved. MIT license.
mod esm_resolver;
use crate::file_fetcher::FileFetcher;
use crate::node::NODE_COMPAT_URL;
use crate::node::SUPPORTED_MODULES;
use deno_ast::MediaType;
use deno_core::error::AnyError;
use deno_core::located_script_name;
use deno_core::url::Url;
use deno_core::JsRuntime;
use deno_core::ModuleSpecifier;
use once_cell::sync::Lazy;
pub use esm_resolver::check_if_should_use_esm_loader;
pub use esm_resolver::NodeEsmResolver;
pub static GLOBAL_URL: Lazy<Url> =
Lazy::new(|| NODE_COMPAT_URL.join("node/global.ts").unwrap());
pub static MODULE_URL: Lazy<Url> =
Lazy::new(|| NODE_COMPAT_URL.join("node/module.ts").unwrap());
static COMPAT_IMPORT_URL: Lazy<Url> =
Lazy::new(|| Url::parse("flags:compat").unwrap());
/// Provide imports into a module graph when the compat flag is true.
pub fn get_node_imports() -> Vec<(Url, Vec<String>)> {
vec![(
COMPAT_IMPORT_URL.clone(),
vec![GLOBAL_URL.as_str().to_owned()],
)]
}
pub fn load_cjs_module(
js_runtime: &mut JsRuntime,
module: &str,
main: bool,
) -> Result<(), AnyError> {
let source_code = &format!(
r#"(async function loadCjsModule(module) {{
const Module = await import("{module_loader}");
Module.default._load(module, null, {main});
}})('{module}');"#,
module_loader = MODULE_URL.as_str(),
main = main,
module = escape_for_single_quote_string(module),
);
js_runtime.execute_script(&located_script_name!(), source_code)?;
Ok(())
}
pub fn add_global_require(
js_runtime: &mut JsRuntime,
main_module: &str,
) -> Result<(), AnyError> {
let source_code = &format!(
r#"(async function setupGlobalRequire(main) {{
const Module = await import("{}");
const require = Module.createRequire(main);
globalThis.require = require;
}})('{}');"#,
MODULE_URL.as_str(),
escape_for_single_quote_string(main_module),
);
js_runtime.execute_script(&located_script_name!(), source_code)?;
Ok(())
}
fn escape_for_single_quote_string(text: &str) -> String {
text.replace('\\', r"\\").replace('\'', r"\'")
}
pub fn setup_builtin_modules(
js_runtime: &mut JsRuntime,
) -> Result<(), AnyError> {
let mut script = String::new();
for module in SUPPORTED_MODULES {
// skipping the modules that contains '/' as they are not available in NodeJS repl as well
if !module.name.contains('/') {
script = format!(
"{}const {MODULE_NAME} = require('{MODULE_NAME}');\n",
script,
MODULE_NAME = module.name
);
}
}
js_runtime.execute_script("setup_node_builtins.js", &script)?;
Ok(())
}
/// Translates given CJS module into ESM. This function will perform static
/// analysis on the file to find defined exports and reexports.
///
/// For all discovered reexports the analysis will be performed recursively.
///
/// If successful a source code for equivalent ES module is returned.
pub fn translate_cjs_to_esm(
file_fetcher: &FileFetcher,
specifier: &ModuleSpecifier,
code: String,
media_type: MediaType,
) -> Result<String, AnyError> {
let parsed_source = deno_ast::parse_script(deno_ast::ParseParams {
specifier: specifier.to_string(),
text_info: deno_ast::SourceTextInfo::new(code.into()),
media_type,
capture_tokens: true,
scope_analysis: false,
maybe_syntax: None,
})?;
let analysis = parsed_source.analyze_cjs();
let mut source = vec![
r#"import { createRequire } from "node:module";"#.to_string(),
r#"const require = createRequire(import.meta.url);"#.to_string(),
];
// if there are reexports, handle them first
for (idx, reexport) in analysis.reexports.iter().enumerate() {
// Firstly, resolve relate reexport specifier
let resolved_reexport = node_resolver::resolve(
reexport,
&specifier.to_file_path().unwrap(),
// FIXME(bartlomieju): check if these conditions are okay, probably
// should be `deno-require`, because `deno` is already used in `esm_resolver.rs`
&["deno", "require", "default"],
)?;
let reexport_specifier =
ModuleSpecifier::from_file_path(&resolved_reexport).unwrap();
// Secondly, read the source code from disk
let reexport_file = file_fetcher.get_source(&reexport_specifier).unwrap();
// Now perform analysis again
{
let parsed_source = deno_ast::parse_script(deno_ast::ParseParams {
specifier: reexport_specifier.to_string(),
text_info: deno_ast::SourceTextInfo::new(reexport_file.source),
media_type: reexport_file.media_type,
capture_tokens: true,
scope_analysis: false,
maybe_syntax: None,
})?;
let analysis = parsed_source.analyze_cjs();
source.push(format!(
"const reexport{} = require(\"{}\");",
idx, reexport
));
for export in analysis.exports.iter().filter(|e| e.as_str() != "default")
{
// TODO(bartlomieju): Node actually checks if a given export exists in `exports` object,
// but it might not be necessary here since our analysis is more detailed?
source.push(format!(
"export const {0} = Deno[Deno.internal].require.bindExport(reexport{1}.{2}, reexport{1});",
export, idx, export
));
}
}
}
source.push(format!(
"const mod = require(\"{}\");",
specifier
.to_file_path()
.unwrap()
.to_str()
.unwrap()
.replace('\\', "\\\\")
.replace('\'', "\\\'")
.replace('\"', "\\\"")
));
source.push("export default mod;".to_string());
for export in analysis.exports.iter().filter(|e| e.as_str() != "default") {
// TODO(bartlomieju): Node actually checks if a given export exists in `exports` object,
// but it might not be necessary here since our analysis is more detailed?
source.push(format!(
"export const {} = Deno[Deno.internal].require.bindExport(mod.{}, mod);",
export, export
));
}
let translated_source = source.join("\n");
Ok(translated_source)
}

1
cli/compat/testdata/basic/main.js vendored
View File

@ -1 +0,0 @@
import "foo";

0
cli/compat/testdata/basic/node_modules/foo/index.js generated vendored
View File

5
cli/compat/testdata/basic/node_modules/foo/package.json generated vendored
View File

@ -1,5 +0,0 @@
{
"name": "foo",
"type": "module",
"exports": "./index.js"
}

7
cli/compat/testdata/basic/package.json vendored
View File

@ -1,7 +0,0 @@
{
"name": "bar",
"type": "module",
"dependencies": {
"foo": "1.0.0"
}
}

1
cli/compat/testdata/basic_deps/main.js vendored
View File

@ -1 +0,0 @@
import "foo";

1
cli/compat/testdata/basic_deps/node_modules/bar/bar.js generated vendored
View File

@ -1 +0,0 @@
export const BAR = 123;

6
cli/compat/testdata/basic_deps/node_modules/bar/package.json generated vendored
View File

@ -1,6 +0,0 @@
{
"name": "bar",
"version": "0.1.2",
"type": "module",
"exports": "./bar.js"
}

1
cli/compat/testdata/basic_deps/node_modules/foo/foo.js generated vendored
View File

@ -1 +0,0 @@
import "bar";

8
cli/compat/testdata/basic_deps/node_modules/foo/package.json generated vendored
View File

@ -1,8 +0,0 @@
{
"name": "foo",
"type": "module",
"exports": "./foo.js",
"dependencies": {
"bar": "0.1.2"
}
}

7
cli/compat/testdata/basic_deps/package.json vendored
View File

@ -1,7 +0,0 @@
{
"name": "main_program",
"type": "module",
"dependencies": {
"foo": "1.0.0"
}
}

1
cli/compat/testdata/conditions/main.js vendored
View File

@ -1 +0,0 @@
import "imports_exports";

6
cli/compat/testdata/conditions/node_modules/imports_exports/import_export.js generated vendored
View File

@ -1,6 +0,0 @@
import dep from "#dep";
export default {
bar: "bar",
dep,
};

3
cli/compat/testdata/conditions/node_modules/imports_exports/import_polyfill.js generated vendored
View File

@ -1,3 +0,0 @@
export default {
polyfill: "import",
};

17
cli/compat/testdata/conditions/node_modules/imports_exports/package.json generated vendored
View File

@ -1,17 +0,0 @@
{
"version": "1.0.0",
"name": "imports_exports",
"main": "./require_export.cjs",
"imports": {
"#dep": {
"import": "./import_polyfill.js",
"require": "./require_polyfill.js"
}
},
"exports": {
".": {
"import": "./import_export.js",
"require": "./require_export.cjs"
}
}
}

6
cli/compat/testdata/conditions/node_modules/imports_exports/require_export.cjs generated vendored
View File

@ -1,6 +0,0 @@
const dep = require("#dep");
module.exports = {
foo: "foo",
dep,
};

3
cli/compat/testdata/conditions/node_modules/imports_exports/require_polyfill.js generated vendored
View File

@ -1,3 +0,0 @@
module.exports = {
polyfill: "require",
};

7
cli/compat/testdata/conditions/package.json vendored
View File

@ -1,7 +0,0 @@
{
"name": "conditions",
"type": "module",
"dependencies": {
"imports_exports": "1.0.0"
}
}

1
cli/compat/testdata/deep/a/b/c/d/main.js vendored
View File

@ -1 +0,0 @@
import "foo";

0
cli/compat/testdata/deep/node_modules/foo/index.js generated vendored
View File

5
cli/compat/testdata/deep/node_modules/foo/package.json generated vendored
View File

@ -1,5 +0,0 @@
{
"name": "foo",
"type": "module",
"exports": "./index.js"
}

1
cli/compat/testdata/not_esm/main.js vendored
View File

@ -1 +0,0 @@
require("foo");

0
cli/compat/testdata/not_esm/node_modules/foo/index.js generated vendored
View File

5
cli/compat/testdata/not_esm/node_modules/foo/package.json generated vendored
View File

@ -1,5 +0,0 @@
{
"name": "foo",
"type": "module",
"exports": "./index.js"
}

6
cli/compat/testdata/not_esm/package.json vendored
View File

@ -1,6 +0,0 @@
{
"name": "bar",
"dependencies": {
"foo": "1.0.0"
}
}

2
cli/compat/testdata/subpath/main.js vendored
View File

@ -1,2 +0,0 @@
import "foo";
import "foo/server.js";

0
cli/compat/testdata/subpath/node_modules/foo/index.js generated vendored
View File

4
cli/compat/testdata/subpath/node_modules/foo/package.json generated vendored
View File

@ -1,4 +0,0 @@
{
"name": "foo",
"main": "index.js"
}

0
cli/compat/testdata/subpath/node_modules/foo/server.js generated vendored
View File

14
cli/graph_util.rs
View File

@ -441,20 +441,6 @@ impl GraphData {
None
}
// TODO(bartlomieju): after saving translated source
// it's never removed, potentially leading to excessive
// memory consumption
pub fn add_cjs_esm_translation(
&mut self,
specifier: &ModuleSpecifier,
source: String,
) {
let prev = self
.cjs_esm_translations
.insert(specifier.to_owned(), source);
assert!(prev.is_none());
}
pub fn get_cjs_esm_translation<'a>(
&'a self,
specifier: &ModuleSpecifier,

3
cli/main.rs
View File

@ -5,7 +5,6 @@ mod auth_tokens;
mod cache;
mod cdp;
mod checksum;
mod compat;
mod deno_dir;
mod deno_std;
mod diagnostics;
@ -806,8 +805,6 @@ async fn run_command(
return run_with_watch(flags, run_flags.script).await;
}
// TODO(bartlomieju): it should not be resolved here if we're in compat mode
// because it might be a bare specifier
// TODO(bartlomieju): actually I think it will also fail if there's an import
// map specified and bare specifier is used on the command line - this should
// probably call `ProcState::resolve` instead

91
cli/node/errors.rs
View File

@ -22,27 +22,6 @@ pub fn err_invalid_module_specifier(
type_error(msg)
}
pub fn err_invalid_package_config(
path: &str,
maybe_base: Option<String>,
maybe_message: Option<String>,
) -> AnyError {
let mut msg = format!(
"[ERR_INVALID_PACKAGE_CONFIG] Invalid package config {}",
path
);
if let Some(base) = maybe_base {
msg = format!("{} while importing {}", msg, base);
}
if let Some(message) = maybe_message {
msg = format!("{}. {}", msg, message);
}
generic_error(msg)
}
pub fn err_module_not_found(path: &str, base: &str, typ: &str) -> AnyError {
generic_error(format!(
"[ERR_MODULE_NOT_FOUND] Cannot find {} \"{}\" imported from \"{}\"",
@ -69,73 +48,3 @@ pub fn err_unsupported_esm_url_scheme(url: &Url) -> AnyError {
msg = format!("{}. Received protocol '{}'", msg, url.scheme());
generic_error(msg)
}
pub fn err_invalid_package_target(
pkg_path: String,
key: String,
target: String,
is_import: bool,
maybe_base: Option<String>,
) -> AnyError {
let rel_error = !is_import && !target.is_empty() && !target.starts_with("./");
let mut msg = "[ERR_INVALID_PACKAGE_TARGET]".to_string();
if key == "." {
assert!(!is_import);
msg = format!("{} Invalid \"exports\" main target {} defined in the package config {}package.json", msg, target, pkg_path)
} else {
let ie = if is_import { "imports" } else { "exports" };
msg = format!("{} Invalid \"{}\" target {} defined for '{}' in the package config {}package.json", msg, ie, target, key, pkg_path)
};
if let Some(base) = maybe_base {
msg = format!("{} imported from {}", msg, base);
};
if rel_error {
msg = format!("{}; target must start with \"./\"", msg);
}
generic_error(msg)
}
pub fn err_package_path_not_exported(
pkg_path: String,
subpath: String,
maybe_base: Option<String>,
) -> AnyError {
let mut msg = "[ERR_PACKAGE_PATH_NOT_EXPORTED]".to_string();
if subpath == "." {
msg = format!(
"{} No \"exports\" main defined in {}package.json",
msg, pkg_path
);
} else {
msg = format!("{} Package subpath \'{}\' is not defined by \"exports\" in {}package.json", msg, subpath, pkg_path);
};
if let Some(base) = maybe_base {
msg = format!("{} imported from {}", msg, base);
}
generic_error(msg)
}
pub fn err_package_import_not_defined(
specifier: &str,
package_path: Option<String>,
base: &str,
) -> AnyError {
let mut msg = format!(
"[ERR_PACKAGE_IMPORT_NOT_DEFINED] Package import specifier \"{}\" is not defined in",
specifier
);
if let Some(package_path) = package_path {
msg = format!("{} in package {}package.json", msg, package_path);
}
msg = format!("{} imported from {}", msg, base);
type_error(msg)
}

44
cli/proc_state.rs
View File

@ -9,8 +9,6 @@ use crate::cache::EmitCache;
use crate::cache::FastInsecureHasher;
use crate::cache::ParsedSourceCache;
use crate::cache::TypeCheckCache;
use crate::compat;
use crate::compat::NodeEsmResolver;
use crate::deno_dir;
use crate::emit::emit_parsed_source;
use crate::emit::TsConfigType;
@ -186,9 +184,6 @@ impl ProcState {
// FIXME(bartlomieju): `NodeEsmResolver` is not aware of JSX resolver
// created below
let node_resolver = NodeEsmResolver::new(
maybe_import_map.clone().map(ImportMapResolver::new),
);
let maybe_import_map_resolver =
maybe_import_map.clone().map(ImportMapResolver::new);
let maybe_jsx_resolver = cli_options
@ -196,9 +191,7 @@ impl ProcState {
.map(|cfg| JsxResolver::new(cfg, maybe_import_map_resolver.clone()));
let maybe_resolver: Option<
Arc<dyn deno_graph::source::Resolver + Send + Sync>,
> = if cli_options.compat() {
Some(Arc::new(node_resolver))
} else if let Some(jsx_resolver) = maybe_jsx_resolver {
> = if let Some(jsx_resolver) = maybe_jsx_resolver {
// the JSX resolver offloads to the import map if present, otherwise uses
// the default Deno explicit import resolution.
Some(Arc::new(jsx_resolver))
@ -286,7 +279,7 @@ impl ProcState {
// One might argue that this is a code smell, and I would agree. However
// due to flux in "Node compatibility" it's not clear where it should be
// decided what `ModuleKind` is decided for root specifier.
let roots = roots
let roots: Vec<(deno_core::url::Url, deno_graph::ModuleKind)> = roots
.into_iter()
.map(|r| {
if let Some(resolver) = &maybe_resolver {
@ -306,13 +299,6 @@ impl ProcState {
// TODO(bartlomieju): this is very make-shift, is there an existing API
// that we could include it like with "maybe_imports"?
let roots = if self.options.compat() {
let mut r = vec![(compat::GLOBAL_URL.clone(), ModuleKind::Esm)];
r.extend(roots);
r
} else {
roots
};
if !reload_on_watch {
let graph_data = self.graph_data.read();
if self.options.type_check_mode() == TypeCheckMode::None
@ -389,32 +375,6 @@ impl ProcState {
)
.await;
let needs_cjs_esm_translation = graph
.modules()
.iter()
.any(|m| m.kind == ModuleKind::CommonJs);
if needs_cjs_esm_translation {
for module in graph.modules() {
// TODO(bartlomieju): this is overly simplistic heuristic, once we are
// in compat mode, all files ending with plain `.js` extension are
// considered CommonJs modules. Which leads to situation where valid
// ESM modules with `.js` extension might undergo translation (it won't
// work in this situation).
if module.kind == ModuleKind::CommonJs {
let translated_source = compat::translate_cjs_to_esm(
&self.file_fetcher,
&module.specifier,
module.maybe_source.as_ref().unwrap().to_string(),
module.media_type,
)?;
let mut graph_data = self.graph_data.write();
graph_data
.add_cjs_esm_translation(&module.specifier, translated_source);
}
}
}
// If there was a locker, validate the integrity of all the modules in the
// locker.
graph_lock_or_exit(&graph);

194
cli/tests/integration/compat_tests.rs
View File

@ -1,194 +0,0 @@
// Copyright 2018-2022 the Deno authors. All rights reserved. MIT license.
use crate::itest;
use deno_core::url::Url;
use test_util as util;
/// Tests in this file should use `std_file_url` to override `DENO_NODE_COMPAT_URL`
/// env variable. This speeds up tests significantly as they no longer
/// download contents of `deno_std` from `https://deno.land` in each test.
/// Return a file URL pointing to "std" submodule
/// in "test_util" directory. It must have a trailing slash.
fn std_file_url() -> String {
let u = Url::from_directory_path(util::std_path()).unwrap();
u.to_string()
}
itest!(globals {
args: "run --compat --no-check --unstable --allow-read --allow-env compat/globals.ts",
output: "compat/globals.out",
envs: vec![("DENO_NODE_COMPAT_URL".to_string(), std_file_url())],
});
itest!(fs_promises {
args: "run --compat --no-check --unstable -A compat/fs_promises.mjs",
output: "compat/fs_promises.out",
envs: vec![("DENO_NODE_COMPAT_URL".to_string(), std_file_url())],
});
// https://github.com/denoland/deno/issues/12494
itest_flaky!(node_prefix_fs_promises {
args: "run --compat --no-check --unstable -A compat/node_fs_promises.mjs",
output: "compat/fs_promises.out",
envs: vec![("DENO_NODE_COMPAT_URL".to_string(), std_file_url())],
});
itest!(compat_with_import_map_and_https_imports {
args: "run --quiet --no-check --compat --unstable -A --import-map=compat/import_map.json compat/import_map_https_imports.mjs",
output: "compat/import_map_https_imports.out",
envs: vec![("DENO_NODE_COMPAT_URL".to_string(), std_file_url())],
});
itest!(compat_dyn_import_rejects_with_node_compatible_error {
args:
"run --quiet --no-check --compat --unstable -A compat/dyn_import_reject.js",
output: "compat/dyn_import_reject.out",
envs: vec![("DENO_NODE_COMPAT_URL".to_string(), std_file_url())],
});
itest!(import_esm_from_cjs {
args:
"run --compat --unstable -A --quiet compat/import_esm_from_cjs/index.js",
output_str: Some("function\n"),
envs: vec![("DENO_NODE_COMPAT_URL".to_string(), std_file_url())],
});
itest!(test_runner_cjs {
args: "test --compat --unstable -A --quiet compat/test_runner/cjs.js",
exit_code: 1,
output: "compat/test_runner/cjs.out",
envs: vec![("DENO_NODE_COMPAT_URL".to_string(), std_file_url())],
});
itest!(test_runner_esm {
args: "test --compat --unstable -A --quiet compat/test_runner/esm.mjs",
exit_code: 1,
output: "compat/test_runner/esm.out",
envs: vec![("DENO_NODE_COMPAT_URL".to_string(), std_file_url())],
});
// Top level assertion test mostly just make sure that the test runner finishes correctly on compat mode
// when there is no tests
itest!(top_level_assertion_cjs {
args: "test --compat --unstable -A --quiet compat/test_runner/top_level_assertion_cjs.js",
exit_code: 0,
output: "compat/test_runner/top_level_assertion_cjs.out",
envs: vec![("DENO_NODE_COMPAT_URL".to_string(), std_file_url())],
});
itest!(top_level_assertion_esm {
args: "test --compat --unstable -A --quiet compat/test_runner/top_level_assertion_esm.mjs",
exit_code: 0,
output: "compat/test_runner/top_level_assertion_esm.out",
envs: vec![("DENO_NODE_COMPAT_URL".to_string(), std_file_url())],
});
itest!(top_level_fail_cjs {
args: "test --compat --unstable -A --quiet compat/test_runner/top_level_fail_cjs.js",
exit_code: 1,
output: "compat/test_runner/top_level_fail_cjs.out",
envs: vec![("DENO_NODE_COMPAT_URL".to_string(), std_file_url())],
});
itest!(top_level_fail_esm {
args: "test --compat --unstable -A --quiet compat/test_runner/top_level_fail_esm.mjs",
exit_code: 1,
output: "compat/test_runner/top_level_fail_esm.out",
envs: vec![("DENO_NODE_COMPAT_URL".to_string(), std_file_url())],
});
itest!(compat_worker {
args: "run --compat --unstable -A --quiet --no-check compat/worker/worker_test.mjs",
output: "compat/worker/worker_test.out",
envs: vec![("DENO_NODE_COMPAT_URL".to_string(), std_file_url())],
});
itest!(cjs_esm_interop {
args:
"run --compat --unstable -A --quiet --no-check compat/import_cjs_from_esm/main.mjs",
output: "compat/import_cjs_from_esm.out",
envs: vec![("DENO_NODE_COMPAT_URL".to_string(), std_file_url())],
});
itest!(cjs_esm_interop_dynamic {
args:
"run --compat --unstable -A --quiet --no-check compat/import_cjs_from_esm/main_dynamic.mjs",
output: "compat/import_cjs_from_esm.out",
envs: vec![("DENO_NODE_COMPAT_URL".to_string(), std_file_url())],
});
#[test]
fn globals_in_repl() {
let (out, _err) = util::run_and_collect_output_with_args(
true,
vec!["repl", "--compat", "--unstable", "--no-check", "--quiet"],
Some(vec!["global.window == window"]),
Some(vec![("DENO_NODE_COMPAT_URL".to_string(), std_file_url())]),
false,
);
assert!(out.contains("true"));
}
#[test]
fn require_in_repl() {
let (out, _err) = util::run_and_collect_output_with_args(
true,
vec!["repl", "--compat", "--unstable", "--quiet"],
Some(vec![
"const foo = require('./compat/import_esm_from_cjs/index');",
]),
Some(vec![("DENO_NODE_COMPAT_URL".to_string(), std_file_url())]),
false,
);
assert!(out.contains("function"));
}
#[test]
fn node_compat_url() {
let (out, err) = util::run_and_collect_output_with_args(
false,
vec!["repl", "--compat", "--unstable", "--no-check", "--quiet"],
None,
Some(vec![(
"DENO_NODE_COMPAT_URL".to_string(),
"file:///non_existent/".to_string(),
)]),
false,
);
assert!(out.is_empty());
assert!(!err.is_empty());
assert!(err.contains("file:///non_existent/node/global.ts"));
}
#[test]
fn native_modules_as_global_vars() {
let (out, _err) = util::run_and_collect_output_with_args(
true,
vec!["repl", "--compat", "--unstable", "--quiet"],
Some(vec!["if(cluster && v8 && sys) { true } else { false }"]),
Some(vec![("DENO_NODE_COMPAT_URL".to_string(), std_file_url())]),
false,
);
assert!(out.contains("true"));
}
#[ignore] // todo(dsherret): re-enable
#[test]
fn ext_node_cjs_execution() {
let (out, _err) = util::run_and_collect_output_with_args(
true,
vec![
"run",
"-A",
"--unstable",
"--quiet",
"commonjs/init.js",
"./example.js",
],
None,
Some(vec![("DENO_NODE_COMPAT_URL".to_string(), std_file_url())]),
false,
);
assert!(out.contains("{ hello: \"world\" }"));
}

2
cli/tests/integration/mod.rs
View File

@ -60,8 +60,6 @@ mod bundle;
mod cache;
#[path = "check_tests.rs"]
mod check;
#[path = "compat_tests.rs"]
mod compat;
#[path = "compile_tests.rs"]
mod compile;
#[path = "coverage_tests.rs"]

4
cli/tests/testdata/compat/dyn_import_reject.js vendored
View File

@ -1,4 +0,0 @@
import("./foobar.js").catch((e) => {
console.log(e);
console.log(e.code);
});

2
cli/tests/testdata/compat/dyn_import_reject.out vendored
View File

@ -1,2 +0,0 @@
TypeError: [ERR_MODULE_NOT_FOUND] Cannot find module "file://[WILDCARD]/testdata/compat/foobar.js" imported from "file://[WILDCARD]/testdata/compat/dyn_import_reject.js"
ERR_MODULE_NOT_FOUND

3
cli/tests/testdata/compat/fs_promises.mjs vendored
View File

@ -1,3 +0,0 @@
import fs from "fs/promises";
const data = await fs.readFile("compat/test.txt", "utf-8");
console.log(data);

2
cli/tests/testdata/compat/fs_promises.out vendored
View File

@ -1,2 +0,0 @@
[WILDCARD]
This is some example text that will be read using compatiblity mode.

9
cli/tests/testdata/compat/globals.out vendored
View File

@ -1,9 +0,0 @@
[WILDCARD]
process {
[WILDCARD]
}
[Function: Buffer] {
[WILDCARD]
}
[Function: setImmediate]
[Function: clearTimeout]

4
cli/tests/testdata/compat/globals.ts vendored
View File

@ -1,4 +0,0 @@
console.log(process);
console.log(Buffer);
console.log(setImmediate);
console.log(clearImmediate);

1
cli/tests/testdata/compat/import_cjs_from_esm.out vendored
View File

@ -1 +0,0 @@
{ a: "A", b: "B", foo: "foo", bar: "bar", fizz: { buzz: "buzz", fizz: "FIZZ" } }

9
cli/tests/testdata/compat/import_cjs_from_esm/imported.js vendored
View File

@ -1,9 +0,0 @@
exports = {
a: "A",
b: "B",
};
exports.foo = "foo";
exports.bar = "bar";
exports.fizz = require("./reexports.js");
console.log(exports);

1
cli/tests/testdata/compat/import_cjs_from_esm/main.mjs vendored
View File

@ -1 +0,0 @@
import "./imported.js";

2
cli/tests/testdata/compat/import_cjs_from_esm/main_dynamic.mjs vendored
View File

@ -1,2 +0,0 @@
const url = import.meta.resolve("./imported.js");
await import(url);

1
cli/tests/testdata/compat/import_cjs_from_esm/reexports.js vendored
View File

@ -1 +0,0 @@
module.exports = require("./reexports2.js");

2
cli/tests/testdata/compat/import_cjs_from_esm/reexports2.js vendored
View File

@ -1,2 +0,0 @@
exports.buzz = "buzz";
exports.fizz = "FIZZ";

1
cli/tests/testdata/compat/import_esm_from_cjs/index.js vendored
View File

@ -1 +0,0 @@
require("pure-cjs");

4
cli/tests/testdata/compat/import_esm_from_cjs/node_modules/pure-cjs/index.js generated vendored
View File

@ -1,4 +0,0 @@
async function run() {
const _result = await import('pure-esm');
}
run()

4
cli/tests/testdata/compat/import_esm_from_cjs/node_modules/pure-cjs/package.json generated vendored
View File

@ -1,4 +0,0 @@
{
"name": "pure-cjs",
"main": "./index.js"
}

2
cli/tests/testdata/compat/import_esm_from_cjs/node_modules/pure-esm/index.js generated vendored
View File

@ -1,2 +0,0 @@
import fs from 'node:fs';
console.log(typeof fs.chmod);

5
cli/tests/testdata/compat/import_esm_from_cjs/node_modules/pure-esm/package.json generated vendored
View File

@ -1,5 +0,0 @@
{
"name": "pure-esm",
"type": "module",
"main": "./index.js"
}

5
cli/tests/testdata/compat/import_map.json vendored
View File

@ -1,5 +0,0 @@
{
"imports": {
"std/": "https://deno.land/std@0.126.0/"
}
}

7
cli/tests/testdata/compat/import_map_https_imports.mjs vendored
View File

@ -1,7 +0,0 @@
import { sortBy } from "std/collections/sort_by.ts";
import { findSingle } from "https://deno.land/std@0.126.0/collections/find_single.ts";
import os from "node:os";
console.log(sortBy([2, 3, 1], (it) => it));
console.log(findSingle([2, 3, 1], (it) => it == 2));
console.log("arch", os.arch());

3
cli/tests/testdata/compat/import_map_https_imports.out vendored
View File

@ -1,3 +0,0 @@
[ 1, 2, 3 ]
2
arch [WILDCARD]

3
cli/tests/testdata/compat/node_fs_promises.mjs vendored
View File

@ -1,3 +0,0 @@
import fs from "node:fs/promises";
const data = await fs.readFile("compat/test.txt", "utf-8");
console.log(data);

1
cli/tests/testdata/compat/test.txt vendored
View File

@ -1 +0,0 @@
This is some example text that will be read using compatiblity mode.

9
cli/tests/testdata/compat/test_runner/cjs.js vendored
View File

@ -1,9 +0,0 @@
const { strictEqual } = require("assert");
Deno.test("Correct assertion", () => {
strictEqual(20, 20);
});
Deno.test("Failed assertion", () => {
strictEqual(10, 20);
});

27
cli/tests/testdata/compat/test_runner/cjs.out vendored
View File

@ -1,27 +0,0 @@
running 2 tests from ./compat/test_runner/cjs.js
Correct assertion ... ok ([WILDCARD])
Failed assertion ... FAILED ([WILDCARD])
ERRORS
Failed assertion => ./compat/test_runner/cjs.js:[WILDCARD]
error: AssertionError: Values are not strictly equal:
[Diff] Actual / Expected
- 10
+ 20
Error.captureStackTrace(this, stackStartFn || stackStartFunction);
^
[WILDCARD]
FAILURES
Failed assertion => ./compat/test_runner/cjs.js:[WILDCARD]
FAILED | 1 passed | 1 failed ([WILDCARD])
error: Test failed

9
cli/tests/testdata/compat/test_runner/esm.mjs vendored
View File

@ -1,9 +0,0 @@
import { strictEqual } from "assert";
Deno.test("Correct assertion", () => {
strictEqual(20, 20);
});
Deno.test("Failed assertion", () => {
strictEqual(10, 20);
});

27
cli/tests/testdata/compat/test_runner/esm.out vendored
View File

@ -1,27 +0,0 @@
running 2 tests from ./compat/test_runner/esm.mjs
Correct assertion ... ok ([WILDCARD])
Failed assertion ... FAILED ([WILDCARD])
ERRORS
Failed assertion => ./compat/test_runner/esm.mjs:[WILDCARD]
error: AssertionError: Values are not strictly equal:
[Diff] Actual / Expected
- 10
+ 20
Error.captureStackTrace(this, stackStartFn || stackStartFunction);
^
[WILDCARD]
FAILURES
Failed assertion => ./compat/test_runner/esm.mjs:[WILDCARD]
FAILED | 1 passed | 1 failed ([WILDCARD])
error: Test failed

4
cli/tests/testdata/compat/test_runner/top_level_assertion_cjs.js vendored
View File

@ -1,4 +0,0 @@
const { notStrictEqual, strictEqual } = require("assert");
notStrictEqual(require.main, module, "The module was loaded as a main module");
strictEqual(20, 20);

4
cli/tests/testdata/compat/test_runner/top_level_assertion_cjs.out vendored
View File

@ -1,4 +0,0 @@
running 0 tests from [WILDCARD]
ok | 0 passed | 0 failed ([WILDCARD])

4
cli/tests/testdata/compat/test_runner/top_level_assertion_esm.mjs vendored
View File

@ -1,4 +0,0 @@
import assert, { strictEqual } from "assert";
assert(!import.meta.main, "The module was loaded as a main module");
strictEqual(20, 20);

4
cli/tests/testdata/compat/test_runner/top_level_assertion_esm.out vendored
View File

@ -1,4 +0,0 @@
running 0 tests from [WILDCARD]
ok | 0 passed | 0 failed ([WILDCARD])

4
cli/tests/testdata/compat/test_runner/top_level_fail_cjs.js vendored
View File

@ -1,4 +0,0 @@
const { notStrictEqual, strictEqual } = require("assert");
notStrictEqual(require.main, module, "The module was loaded as a main module");
strictEqual(10, 20);

27
cli/tests/testdata/compat/test_runner/top_level_fail_cjs.out vendored
View File

@ -1,27 +0,0 @@
Uncaught error from ./compat/test_runner/top_level_fail_cjs.js FAILED
ERRORS
./compat/test_runner/top_level_fail_cjs.js (uncaught error)
error: (in promise) AssertionError: Values are not strictly equal:
[Diff] Actual / Expected
- 10
+ 20
Error.captureStackTrace(this, stackStartFn || stackStartFunction);
^
at [WILDCARD]
This error was not caught from a test and caused the test runner to fail on the referenced module.
It most likely originated from a dangling promise, event/timeout handler or top-level code.
FAILURES
./compat/test_runner/top_level_fail_cjs.js (uncaught error)
FAILED | 0 passed | 1 failed ([WILDCARD])
error: Test failed

4
cli/tests/testdata/compat/test_runner/top_level_fail_esm.mjs vendored
View File

@ -1,4 +0,0 @@
import assert, { strictEqual } from "assert";
assert(!import.meta.main, "The module was loaded as a main module");
strictEqual(10, 20);

27
cli/tests/testdata/compat/test_runner/top_level_fail_esm.out vendored
View File

@ -1,27 +0,0 @@
Uncaught error from ./compat/test_runner/top_level_fail_esm.mjs FAILED
ERRORS
./compat/test_runner/top_level_fail_esm.mjs (uncaught error)
error: AssertionError: Values are not strictly equal:
[Diff] Actual / Expected
- 10
+ 20
Error.captureStackTrace(this, stackStartFn || stackStartFunction);
^
at [WILDCARD]
This error was not caught from a test and caused the test runner to fail on the referenced module.
It most likely originated from a dangling promise, event/timeout handler or top-level code.
FAILURES
./compat/test_runner/top_level_fail_esm.mjs (uncaught error)
FAILED | 0 passed | 1 failed ([WILDCARD])
error: Test failed

9
cli/tests/testdata/compat/worker/worker.mjs vendored
View File

@ -1,9 +0,0 @@
console.log("hello from worker");
self.onmessage = (e) => {
if (e.data != "hello") {
throw new Error("wrong message");
}
self.postMessage({ pid: process.pid });
}

18
cli/tests/testdata/compat/worker/worker_test.mjs vendored
View File

@ -1,18 +0,0 @@
import { deferred } from "../../../../../test_util/std/async/deferred.ts";
const promise = deferred();
const url = import.meta.resolve("./worker.mjs");
const worker = new Worker(url, { type: "module" });
worker.onmessage = (e) => {
const pid = e.data.pid;
if (typeof pid != "number") {
throw new Error("pid is not a number");
}
console.log("process.pid from worker:", pid);
promise.resolve();
};
worker.postMessage("hello");
await promise;
worker.terminate();

2
cli/tests/testdata/compat/worker/worker_test.out vendored
View File

@ -1,2 +0,0 @@
hello from worker
process.pid from worker: [WILDCARD]

6
cli/tools/installer.rs
View File

@ -333,10 +333,6 @@ fn resolve_shim_data(
executable_args.push("--no-prompt".to_string());
}
if flags.compat {
executable_args.push("--compat".to_string());
}
if !flags.v8_flags.is_empty() {
executable_args.push(format!("--v8-flags={}", flags.v8_flags.join(",")));
}
@ -592,7 +588,6 @@ mod tests {
allow_read: Some(vec![]),
type_check_mode: TypeCheckMode::None,
log_level: Some(Level::Error),
compat: true,
..Flags::default()
},
&InstallFlags {
@ -613,7 +608,6 @@ mod tests {
"--allow-read",
"--allow-net",
"--quiet",
"--compat",
"http://localhost:4545/echo_server.ts",
"--foobar",
]

1
cli/tools/standalone.rs
View File

@ -275,7 +275,6 @@ pub fn compile_to_runtime_flags(
lock: None,
log_level: flags.log_level,
type_check_mode: TypeCheckMode::Local,
compat: flags.compat,
unsafely_ignore_certificate_errors: flags
.unsafely_ignore_certificate_errors
.clone(),

124
cli/worker.rs
View File

@ -23,7 +23,6 @@ use deno_runtime::BootstrapOptions;
use crate::args::DenoSubcommand;
use crate::checksum;
use crate::compat;
use crate::errors;
use crate::module_loader::CliModuleLoader;
use crate::node;
@ -52,15 +51,6 @@ impl CliMainWorker {
}
pub async fn setup_repl(&mut self) -> Result<(), AnyError> {
if self.ps.options.compat() {
self.worker.execute_side_module(&compat::GLOBAL_URL).await?;
compat::add_global_require(
&mut self.worker.js_runtime,
self.main_module.as_str(),
)?;
self.worker.run_event_loop(false).await?;
compat::setup_builtin_modules(&mut self.worker.js_runtime)?;
}
self.worker.run_event_loop(false).await?;
Ok(())
}
@ -70,39 +60,7 @@ impl CliMainWorker {
self.maybe_setup_coverage_collector().await?;
log::debug!("main_module {}", self.main_module);
if self.ps.options.compat() {
// TODO(bartlomieju): fix me
assert_eq!(self.main_module.scheme(), "file");
// Set up Node globals
self.worker.execute_side_module(&compat::GLOBAL_URL).await?;
// And `module` module that we'll use for checking which
// loader to use and potentially load CJS module with.
// This allows to skip permission check for `--allow-net`
// which would otherwise be requested by dynamically importing
// this file.
self.worker.execute_side_module(&compat::MODULE_URL).await?;
let use_esm_loader =
compat::check_if_should_use_esm_loader(&self.main_module)?;
if use_esm_loader {
// ES module execution in Node compatiblity mode
self.worker.execute_main_module(&self.main_module).await?;
} else {
// CJS module execution in Node compatiblity mode
compat::load_cjs_module(
&mut self.worker.js_runtime,
&self
.main_module
.to_file_path()
.unwrap()
.display()
.to_string(),
true,
)?;
}
} else if self.is_main_cjs {
if self.is_main_cjs {
self.initialize_main_module_for_node().await?;
node::load_cjs_module_from_ext_node(
&mut self.worker.js_runtime,
@ -160,13 +118,6 @@ impl CliMainWorker {
/// Execute the given main module emitting load and unload events before and after execution
/// respectively.
pub async fn execute(&mut self) -> Result<(), AnyError> {
if self.inner.ps.options.compat() {
self
.inner
.worker
.execute_side_module(&compat::GLOBAL_URL)
.await?;
}
self.inner.execute_main_module_possibly_with_npm().await?;
self
.inner
@ -240,32 +191,8 @@ impl CliMainWorker {
// We only execute the specifier as a module if it is tagged with TestMode::Module or
// TestMode::Both.
if mode != TestMode::Documentation {
if self.ps.options.compat() {
self.worker.execute_side_module(&compat::GLOBAL_URL).await?;
self.worker.execute_side_module(&compat::MODULE_URL).await?;
let use_esm_loader =
compat::check_if_should_use_esm_loader(&self.main_module)?;
if use_esm_loader {
self.worker.execute_side_module(&self.main_module).await?;
} else {
compat::load_cjs_module(
&mut self.worker.js_runtime,
&self
.main_module
.to_file_path()
.unwrap()
.display()
.to_string(),
false,
)?;
self.worker.run_event_loop(false).await?;
}
} else {
// We execute the module module as a side module so that import.meta.main is not set.
self.execute_side_module_possibly_with_npm().await?;
}
// We execute the module module as a side module so that import.meta.main is not set.
self.execute_side_module_possibly_with_npm().await?;
}
self.worker.dispatch_load_event(&located_script_name!())?;
@ -331,32 +258,8 @@ impl CliMainWorker {
pub async fn run_bench_specifier(&mut self) -> Result<(), AnyError> {
self.worker.enable_bench();
if self.ps.options.compat() {
self.worker.execute_side_module(&compat::GLOBAL_URL).await?;
self.worker.execute_side_module(&compat::MODULE_URL).await?;
let use_esm_loader =
compat::check_if_should_use_esm_loader(&self.main_module)?;
if use_esm_loader {
self.worker.execute_side_module(&self.main_module).await?;
} else {
compat::load_cjs_module(
&mut self.worker.js_runtime,
&self
.main_module
.to_file_path()
.unwrap()
.display()
.to_string(),
false,
)?;
self.worker.run_event_loop(false).await?;
}
} else {
// We execute the module module as a side module so that import.meta.main is not set.
self.execute_side_module_possibly_with_npm().await?;
}
// We execute the module module as a side module so that import.meta.main is not set.
self.execute_side_module_possibly_with_npm().await?;
self.worker.dispatch_load_event(&located_script_name!())?;
self.worker.run_benchmarks().await?;
@ -543,20 +446,13 @@ pub async fn create_main_worker(
})
}
// TODO(bartlomieju): this callback could have default value
// and not be required
fn create_web_worker_preload_module_callback(
ps: ProcState,
_ps: ProcState,
) -> Arc<WorkerEventCb> {
let compat = ps.options.compat();
Arc::new(move |mut worker| {
let fut = async move {
if compat {
worker.execute_side_module(&compat::GLOBAL_URL).await?;
worker.execute_side_module(&compat::MODULE_URL).await?;
}
Ok(worker)
};
Arc::new(move |worker| {
let fut = async move { Ok(worker) };
LocalFutureObj::new(Box::new(fut))
})
}

1
ext/node/package_json.rs
View File

@ -11,7 +11,6 @@ use serde::Serialize;
use std::io::ErrorKind;
use std::path::PathBuf;
// TODO(bartlomieju): deduplicate with cli/compat/esm_resolver.rs
#[derive(Clone, Debug, Serialize)]
pub struct PackageJson {
pub exists: bool,