Unverified Commit b25933af authored by Niklas Mischkulnig's avatar Niklas Mischkulnig Committed by GitHub

Turbopack: trace module.createRequire (#84335)

Only `module.createRequire(import.meta.url)` for now, but that seems to be the most popular use anyway.
parent 7182f909
...@@ -143,7 +143,7 @@ impl ExportUsage { ...@@ -143,7 +143,7 @@ impl ExportUsage {
} }
#[turbo_tasks::value(shared)] #[turbo_tasks::value(shared)]
#[derive(Clone)] #[derive(Clone, Debug)]
pub struct ModuleResolveResult { pub struct ModuleResolveResult {
pub primary: SliceMap<RequestKey, ModuleResolveResultItem>, pub primary: SliceMap<RequestKey, ModuleResolveResultItem>,
/// Affecting sources are other files that influence the resolve result. For example, /// Affecting sources are other files that influence the resolve result. For example,
......
...@@ -1784,6 +1784,10 @@ impl JsValue { ...@@ -1784,6 +1784,10 @@ impl JsValue {
"url", "url",
"The Node.js url module: https://nodejs.org/api/url.html", "The Node.js url module: https://nodejs.org/api/url.html",
), ),
WellKnownObjectKind::ModuleModule | WellKnownObjectKind::ModuleModuleDefault => (
"module",
"The Node.js `module` module: https://nodejs.org/api/module.html",
),
WellKnownObjectKind::ChildProcess | WellKnownObjectKind::ChildProcessDefault => ( WellKnownObjectKind::ChildProcess | WellKnownObjectKind::ChildProcessDefault => (
"child_process", "child_process",
"The Node.js child_process module: https://nodejs.org/api/child_process.html", "The Node.js child_process module: https://nodejs.org/api/child_process.html",
...@@ -1886,6 +1890,10 @@ impl JsValue { ...@@ -1886,6 +1890,10 @@ impl JsValue {
"url.pathToFileURL".to_string(), "url.pathToFileURL".to_string(),
"The Node.js url.pathToFileURL method: https://nodejs.org/api/url.html#urlpathtofileurlpath", "The Node.js url.pathToFileURL method: https://nodejs.org/api/url.html#urlpathtofileurlpath",
), ),
WellKnownFunctionKind::CreateRequire => (
"module.createRequire".to_string(),
"The Node.js module.createRequire method: https://nodejs.org/api/module.html#modulecreaterequirefilename",
),
WellKnownFunctionKind::ChildProcessSpawnMethod(name) => ( WellKnownFunctionKind::ChildProcessSpawnMethod(name) => (
format!("child_process.{name}"), format!("child_process.{name}"),
"A process spawning method from the Node.js child_process module: https://nodejs.org/api/child_process.html", "A process spawning method from the Node.js child_process module: https://nodejs.org/api/child_process.html",
...@@ -3456,6 +3464,8 @@ pub enum WellKnownObjectKind { ...@@ -3456,6 +3464,8 @@ pub enum WellKnownObjectKind {
FsModulePromises, FsModulePromises,
FsExtraModule, FsExtraModule,
FsExtraModuleDefault, FsExtraModuleDefault,
ModuleModule,
ModuleModuleDefault,
UrlModule, UrlModule,
UrlModuleDefault, UrlModuleDefault,
ChildProcess, ChildProcess,
...@@ -3596,6 +3606,7 @@ pub enum WellKnownFunctionKind { ...@@ -3596,6 +3606,7 @@ pub enum WellKnownFunctionKind {
Define, Define,
FsReadMethod(Atom), FsReadMethod(Atom),
PathToFileUrl, PathToFileUrl,
CreateRequire,
ChildProcessSpawnMethod(Atom), ChildProcessSpawnMethod(Atom),
ChildProcessFork, ChildProcessFork,
OsArch, OsArch,
...@@ -3684,6 +3695,25 @@ pub mod test_utils { ...@@ -3684,6 +3695,25 @@ pub mod test_utils {
} }
_ => v.into_unknown(true, "import() non constant"), _ => v.into_unknown(true, "import() non constant"),
}, },
JsValue::Call(
_,
box JsValue::WellKnownFunction(WellKnownFunctionKind::CreateRequire),
ref args,
) => {
if let [
JsValue::Member(
_,
box JsValue::WellKnownObject(WellKnownObjectKind::ImportMeta),
box JsValue::Constant(ConstantValue::Str(prop)),
),
] = &args[..]
&& prop.as_str() == "url"
{
JsValue::WellKnownFunction(WellKnownFunctionKind::Require)
} else {
v.into_unknown(true, "createRequire() non constant")
}
}
JsValue::Call( JsValue::Call(
_, _,
box JsValue::WellKnownFunction(WellKnownFunctionKind::RequireResolve), box JsValue::WellKnownFunction(WellKnownFunctionKind::RequireResolve),
......
...@@ -603,6 +603,9 @@ async fn well_known_object_member( ...@@ -603,6 +603,9 @@ async fn well_known_object_member(
WellKnownObjectKind::FsExtraModule | WellKnownObjectKind::FsExtraModuleDefault => { WellKnownObjectKind::FsExtraModule | WellKnownObjectKind::FsExtraModuleDefault => {
fs_extra_module_member(kind, prop) fs_extra_module_member(kind, prop)
} }
WellKnownObjectKind::ModuleModule | WellKnownObjectKind::ModuleModuleDefault => {
module_module_member(kind, prop)
}
WellKnownObjectKind::UrlModule | WellKnownObjectKind::UrlModuleDefault => { WellKnownObjectKind::UrlModule | WellKnownObjectKind::UrlModuleDefault => {
url_module_member(kind, prop) url_module_member(kind, prop)
} }
...@@ -735,6 +738,25 @@ fn fs_extra_module_member(kind: WellKnownObjectKind, prop: JsValue) -> JsValue { ...@@ -735,6 +738,25 @@ fn fs_extra_module_member(kind: WellKnownObjectKind, prop: JsValue) -> JsValue {
) )
} }
fn module_module_member(kind: WellKnownObjectKind, prop: JsValue) -> JsValue {
match (kind, prop.as_str()) {
(.., Some("createRequire")) => {
JsValue::WellKnownFunction(WellKnownFunctionKind::CreateRequire)
}
(WellKnownObjectKind::ModuleModule, Some("default")) => {
JsValue::WellKnownObject(WellKnownObjectKind::ModuleModuleDefault)
}
_ => JsValue::unknown(
JsValue::member(
Box::new(JsValue::WellKnownObject(WellKnownObjectKind::ModuleModule)),
Box::new(prop),
),
true,
"unsupported property on Node.js `module` module",
),
}
}
fn url_module_member(kind: WellKnownObjectKind, prop: JsValue) -> JsValue { fn url_module_member(kind: WellKnownObjectKind, prop: JsValue) -> JsValue {
match (kind, prop.as_str()) { match (kind, prop.as_str()) {
(.., Some("pathToFileURL")) => { (.., Some("pathToFileURL")) => {
......
...@@ -3053,6 +3053,26 @@ async fn value_visitor_inner( ...@@ -3053,6 +3053,26 @@ async fn value_visitor_inner(
"require.context() static analysis is currently limited", "require.context() static analysis is currently limited",
) )
} }
JsValue::Call(
_,
box JsValue::WellKnownFunction(WellKnownFunctionKind::CreateRequire),
ref args,
) => {
// Only support `createRequire(import.meta.url)` for now
if let [
JsValue::Member(
_,
box JsValue::WellKnownObject(WellKnownObjectKind::ImportMeta),
box JsValue::Constant(super::analyzer::ConstantValue::Str(prop)),
),
] = &args[..]
&& prop.as_str() == "url"
{
JsValue::WellKnownFunction(WellKnownFunctionKind::Require)
} else {
v.into_unknown(true, "createRequire() non constant")
}
}
JsValue::New( JsValue::New(
_, _,
box JsValue::WellKnownFunction(WellKnownFunctionKind::URLConstructor), box JsValue::WellKnownFunction(WellKnownFunctionKind::URLConstructor),
...@@ -3068,10 +3088,9 @@ async fn value_visitor_inner( ...@@ -3068,10 +3088,9 @@ async fn value_visitor_inner(
] = &args[..] ] = &args[..]
{ {
if prop.as_str() == "url" { if prop.as_str() == "url" {
// TODO avoid clone
JsValue::Url(url.clone(), JsValueUrlKind::Relative) JsValue::Url(url.clone(), JsValueUrlKind::Relative)
} else { } else {
v.into_unknown(true, "new non constant") v.into_unknown(true, "new URL() non constant")
} }
} else { } else {
v.into_unknown(true, "new non constant") v.into_unknown(true, "new non constant")
......
...@@ -201,6 +201,8 @@ pub fn module_value_to_well_known_object(module_value: &ModuleValue) -> Option<J ...@@ -201,6 +201,8 @@ pub fn module_value_to_well_known_object(module_value: &ModuleValue) -> Option<J
} }
"node:os" | "os" => JsValue::WellKnownObject(WellKnownObjectKind::OsModule), "node:os" | "os" => JsValue::WellKnownObject(WellKnownObjectKind::OsModule),
"node:process" | "process" => JsValue::WellKnownObject(WellKnownObjectKind::NodeProcess), "node:process" | "process" => JsValue::WellKnownObject(WellKnownObjectKind::NodeProcess),
"node:url" | "url" => JsValue::WellKnownObject(WellKnownObjectKind::UrlModule),
"node:module" | "module" => JsValue::WellKnownObject(WellKnownObjectKind::ModuleModule),
"node-pre-gyp" | "@mapbox/node-pre-gyp" => { "node-pre-gyp" | "@mapbox/node-pre-gyp" => {
JsValue::WellKnownObject(WellKnownObjectKind::NodePreGyp) JsValue::WellKnownObject(WellKnownObjectKind::NodePreGyp)
} }
......
moduleRequire (const after eval) = FreeVar(require)("module")
req_fail1 (const after eval) = moduleRequire["createRequire"](FreeVar(globalThis)["foo"])
req_ok1 (const after eval) = module<node:module, {}>["createRequire"](import.meta*0*["url"])
- *0* import.meta: The import.meta object
req_ok2 (const after eval) = moduleRequire["createRequire"](import.meta*0*["url"])
- *0* import.meta: The import.meta object
req_ok3 (const after eval) = moduleRequire["createRequire"](FreeVar(__filename))
[
(
"moduleRequire",
Call(
3,
FreeVar(
"require",
),
[
Constant(
Str(
Atom(
"module",
),
),
),
],
),
),
(
"req_fail1",
MemberCall(
6,
Variable(
(
"moduleRequire",
#2,
),
),
Constant(
Str(
Atom(
"createRequire",
),
),
),
[
Member(
3,
FreeVar(
"globalThis",
),
Constant(
Str(
Atom(
"foo",
),
),
),
),
],
),
),
(
"req_ok1",
MemberCall(
6,
Module(
ModuleValue {
module: "node:module",
annotations: ImportAnnotations {
map: {},
},
},
),
Constant(
Str(
Atom(
"createRequire",
),
),
),
[
Member(
3,
WellKnownObject(
ImportMeta,
),
Constant(
Str(
Atom(
"url",
),
),
),
),
],
),
),
(
"req_ok2",
MemberCall(
6,
Variable(
(
"moduleRequire",
#2,
),
),
Constant(
Str(
Atom(
"createRequire",
),
),
),
[
Member(
3,
WellKnownObject(
ImportMeta,
),
Constant(
Str(
Atom(
"url",
),
),
),
),
],
),
),
(
"req_ok3",
MemberCall(
4,
Variable(
(
"moduleRequire",
#2,
),
),
Constant(
Str(
Atom(
"createRequire",
),
),
),
[
FreeVar(
"__filename",
),
],
),
),
]
import * as moduleEsm from 'node:module'
const moduleRequire = require('module')
const req_ok1 = moduleEsm.createRequire(import.meta.url)
req_ok1('./file1')
const req_ok2 = moduleRequire.createRequire(import.meta.url)
req_ok2('./file2')
const req_ok3 = moduleRequire.createRequire(__filename)
req_ok3('./file3')
const req_fail1 = moduleRequire.createRequire(globalThis.foo)
req_fail1('./file4')
0 -> 1 free var = FreeVar(require)
0 -> 2 call = require*0*("module")
- *0* require: The require method from CommonJS
0 -> 7 member call = module*0*["createRequire"](import.meta*1*["url"])
- *0* module: The Node.js `module` module: https://nodejs.org/api/module.html
- *1* import.meta: The import.meta object
0 -> 8 call = require*0*("./file1")
- *0* require: The require method from CommonJS
0 -> 12 member call = module*0*["createRequire"](import.meta*1*["url"])
- *0* module: The Node.js `module` module: https://nodejs.org/api/module.html
- *1* import.meta: The import.meta object
0 -> 13 call = require*0*("./file2")
- *0* require: The require method from CommonJS
0 -> 15 free var = FreeVar(__filename)
0 -> 16 member call = module*0*["createRequire"]("__filename")
- *0* module: The Node.js `module` module: https://nodejs.org/api/module.html
0 -> 17 call = ???*0*("./file3")
- *0* module.createRequire*1*("__filename")
⚠️ createRequire() non constant
⚠️ This value might have side effects
- *1* module.createRequire: The Node.js module.createRequire method: https://nodejs.org/api/module.html#modulecreaterequirefilename
0 -> 20 free var = FreeVar(globalThis)
0 -> 21 member call = module*0*["createRequire"](???*1*)
- *0* module: The Node.js `module` module: https://nodejs.org/api/module.html
- *1* ???*2*["foo"]
⚠️ unknown object
⚠️ This value might have side effects
- *2* FreeVar(globalThis)
⚠️ unknown global
⚠️ This value might have side effects
0 -> 22 call = ???*0*("./file4")
- *0* module.createRequire*1*(???*2*)
⚠️ createRequire() non constant
⚠️ This value might have side effects
- *1* module.createRequire: The Node.js module.createRequire method: https://nodejs.org/api/module.html#modulecreaterequirefilename
- *2* ???*3*["foo"]
⚠️ unknown object
⚠️ This value might have side effects
- *3* FreeVar(globalThis)
⚠️ unknown global
⚠️ This value might have side effects
moduleRequire = module*0*
- *0* module: The Node.js `module` module: https://nodejs.org/api/module.html
req_fail1 = ???*0*
- *0* module.createRequire*1*(???*2*)
⚠️ createRequire() non constant
⚠️ This value might have side effects
- *1* module.createRequire: The Node.js module.createRequire method: https://nodejs.org/api/module.html#modulecreaterequirefilename
- *2* ???*3*["foo"]
⚠️ unknown object
⚠️ This value might have side effects
- *3* FreeVar(globalThis)
⚠️ unknown global
⚠️ This value might have side effects
req_ok1 = require*0*
- *0* require: The require method from CommonJS
req_ok2 = require*0*
- *0* require: The require method from CommonJS
req_ok3 = ???*0*
- *0* module.createRequire*1*("__filename")
⚠️ createRequire() non constant
⚠️ This value might have side effects
- *1* module.createRequire: The Node.js module.createRequire method: https://nodejs.org/api/module.html#modulecreaterequirefilename
...@@ -22,7 +22,6 @@ use turbopack::{ ...@@ -22,7 +22,6 @@ use turbopack::{
}, },
}; };
use turbopack_core::{ use turbopack_core::{
chunk::ChunkingType,
compile_time_info::CompileTimeInfo, compile_time_info::CompileTimeInfo,
context::AssetContext, context::AssetContext,
environment::{Environment, ExecutionEnvironment, NodeJsEnvironment}, environment::{Environment, ExecutionEnvironment, NodeJsEnvironment},
...@@ -30,7 +29,7 @@ use turbopack_core::{ ...@@ -30,7 +29,7 @@ use turbopack_core::{
ident::Layer, ident::Layer,
module::Module, module::Module,
output::OutputAsset, output::OutputAsset,
reference::{all_assets_from_entries, primary_chunkable_referenced_modules}, reference::all_assets_from_entries,
reference_type::ReferenceType, reference_type::ReferenceType,
traced_asset::TracedAsset, traced_asset::TracedAsset,
}; };
...@@ -66,10 +65,10 @@ static ALLOC: turbo_tasks_malloc::TurboMalloc = turbo_tasks_malloc::TurboMalloc; ...@@ -66,10 +65,10 @@ static ALLOC: turbo_tasks_malloc::TurboMalloc = turbo_tasks_malloc::TurboMalloc;
#[case::asset_fs_inlining_multi("asset-fs-inlining-multi")] #[case::asset_fs_inlining_multi("asset-fs-inlining-multi")]
#[case::asset_fs_logical("asset-fs-logical")] #[case::asset_fs_logical("asset-fs-logical")]
// #[case::asset_graceful_fs("asset-graceful-fs")] // #[case::asset_graceful_fs("asset-graceful-fs")]
// #[case::asset_node_require("asset-node-require")] #[case::asset_node_require("asset-node-require")]
#[case::asset_package_json("asset-package-json")] #[case::asset_package_json("asset-package-json")]
// #[case::asset_symlink("asset-symlink")] // #[case::asset_symlink("asset-symlink")]
// #[case::basic_analysis_require("basic-analysis-require")] #[case::basic_analysis_require("basic-analysis-require")]
// #[case::browser_remappings("browser-remappings")] // #[case::browser_remappings("browser-remappings")]
// #[case::browser_remappings_disabled("browser-remappings-disabled")] // #[case::browser_remappings_disabled("browser-remappings-disabled")]
// #[case::browser_remappings_false("browser-remappings-false")] // #[case::browser_remappings_false("browser-remappings-false")]
...@@ -85,9 +84,9 @@ static ALLOC: turbo_tasks_malloc::TurboMalloc = turbo_tasks_malloc::TurboMalloc; ...@@ -85,9 +84,9 @@ static ALLOC: turbo_tasks_malloc::TurboMalloc = turbo_tasks_malloc::TurboMalloc;
// #[case::dirname_emit("dirname-emit")] // #[case::dirname_emit("dirname-emit")]
// #[case::dirname_emit_concat("dirname-emit-concat")] // #[case::dirname_emit_concat("dirname-emit-concat")]
#[case::dirname_len("dirname-len")] #[case::dirname_len("dirname-len")]
// #[case::dot_dot("dot-dot")] #[case::dot_dot("dot-dot")]
// #[case::esm_dynamic_import("esm-dynamic-import")] #[case::esm_dynamic_import("esm-dynamic-import")]
// #[case::esm_export_wildcard("esm-export-wildcard")] #[case::esm_export_wildcard("esm-export-wildcard")]
// #[case::esm_paths("esm-paths")] // #[case::esm_paths("esm-paths")]
// #[case::esm_paths_trailer("esm-paths-trailer")] // #[case::esm_paths_trailer("esm-paths-trailer")]
// #[case::exports("exports")] // #[case::exports("exports")]
...@@ -111,7 +110,7 @@ static ALLOC: turbo_tasks_malloc::TurboMalloc = turbo_tasks_malloc::TurboMalloc; ...@@ -111,7 +110,7 @@ static ALLOC: turbo_tasks_malloc::TurboMalloc = turbo_tasks_malloc::TurboMalloc;
// #[case::jsx_input("jsx-input")] // #[case::jsx_input("jsx-input")]
// #[case::microtime_node_gyp("microtime-node-gyp")] // #[case::microtime_node_gyp("microtime-node-gyp")]
// #[case::mixed_esm_cjs("mixed-esm-cjs")] // #[case::mixed_esm_cjs("mixed-esm-cjs")]
// #[case::module_create_require("module-create-require")] #[case::module_create_require("module-create-require")]
// #[case::module_register("module-register")] // #[case::module_register("module-register")]
// #[case::module_require("module-require")] // #[case::module_require("module-require")]
// #[case::module_sync_condition_cjs("module-sync-condition-cjs")] // #[case::module_sync_condition_cjs("module-sync-condition-cjs")]
...@@ -234,27 +233,11 @@ async fn node_file_trace_operation(package_root: RcStr, input: RcStr) -> Result< ...@@ -234,27 +233,11 @@ async fn node_file_trace_operation(package_root: RcStr, input: RcStr) -> Result<
.process(Vc::upcast(source), ReferenceType::Undefined) .process(Vc::upcast(source), ReferenceType::Undefined)
.module(); .module();
// We treat the entry as bundled code, so start with the references. // We treat the entry as an external
let assets = primary_chunkable_referenced_modules(module, true) let mut paths = to_list(vec![ResolvedVc::upcast(
.await? TracedAsset::new(module).to_resolved().await?,
.iter() )])
.flat_map(|(ty, _, modules)| { .await?;
if *ty == ChunkingType::Traced {
Some(modules.into_iter())
} else {
None
}
})
.flatten()
.map(async |m| {
Ok(ResolvedVc::upcast(
TracedAsset::new(**m).to_resolved().await?,
))
})
.try_join()
.await?;
let mut paths = to_list(assets).await?;
paths.push(module.ident().path().await?.path.clone()); paths.push(module.ident().path().await?.path.clone());
Ok(Vc::cell(paths)) Ok(Vc::cell(paths))
...@@ -301,10 +284,7 @@ fn node_file_trace(input_path: &str) -> Result<()> { ...@@ -301,10 +284,7 @@ fn node_file_trace(input_path: &str) -> Result<()> {
.map(|s| s.to_string()) .map(|s| s.to_string())
.collect::<FxIndexSet<_>>(); .collect::<FxIndexSet<_>>();
// println!( // println!("issues: {:#?}", op.peek_issues().get_plain_issues().await?);
// "issues: {:#?}",
// op.peek_issues_with_path().await?.get_plain_issues().await?
// );
let reference = std::fs::read_to_string(reference)?; let reference = std::fs::read_to_string(reference)?;
// crude JS -> JSON conversion // crude JS -> JSON conversion
...@@ -315,7 +295,6 @@ fn node_file_trace(input_path: &str) -> Result<()> { ...@@ -315,7 +295,6 @@ fn node_file_trace(input_path: &str) -> Result<()> {
.replace('\'', "\""); .replace('\'', "\"");
let reference = serde_json::from_str::<Vec<String>>(&reference)? let reference = serde_json::from_str::<Vec<String>>(&reference)?
.into_iter() .into_iter()
.filter(|m| m != "package.json")
.collect::<FxIndexSet<_>>(); .collect::<FxIndexSet<_>>();
if reference == list { if reference == list {
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment