Unverified Commit 2308ce05 authored by zoomdong's avatar zoomdong Committed by GitHub

feat(turbopack): externalType support script (#80768)

This pr introduce a new external type: `Script`, which has the same
behaviour as webpack's
https://webpack.js.org/configuration/externals/#externalstypescript

And i also refer to the webpack's implement, this external type accept a
request like: `root@script_url` which same as webpack:


![image](https://github.com/user-attachments/assets/f5b7489d-c4e5-4daa-aa5b-f92e10051c0d)

In the utoo, we use it as follows:


https://github.com/umijs/mako/blob/next/crates/pack-core/src/shared/resolve/externals_plugin.rs#L202-L208

It will generate runtime code to load the external package from the
`script_url`
parent a9fac70b
...@@ -475,6 +475,7 @@ pub enum ExternalType { ...@@ -475,6 +475,7 @@ pub enum ExternalType {
CommonJs, CommonJs,
EcmaScriptModule, EcmaScriptModule,
Global, Global,
Script,
} }
impl Display for ExternalType { impl Display for ExternalType {
...@@ -484,6 +485,7 @@ impl Display for ExternalType { ...@@ -484,6 +485,7 @@ impl Display for ExternalType {
ExternalType::EcmaScriptModule => write!(f, "esm"), ExternalType::EcmaScriptModule => write!(f, "esm"),
ExternalType::Url => write!(f, "url"), ExternalType::Url => write!(f, "url"),
ExternalType::Global => write!(f, "global"), ExternalType::Global => write!(f, "global"),
ExternalType::Script => write!(f, "script"),
} }
} }
} }
...@@ -2779,7 +2781,6 @@ async fn resolve_import_map_result( ...@@ -2779,7 +2781,6 @@ async fn resolve_import_map_result(
**alias_lookup_path, **alias_lookup_path,
request, request,
match ty { match ty {
ExternalType::Url => options,
// TODO is that root correct? // TODO is that root correct?
ExternalType::CommonJs => { ExternalType::CommonJs => {
node_cjs_resolve_options(alias_lookup_path.root()) node_cjs_resolve_options(alias_lookup_path.root())
...@@ -2787,7 +2788,7 @@ async fn resolve_import_map_result( ...@@ -2787,7 +2788,7 @@ async fn resolve_import_map_result(
ExternalType::EcmaScriptModule => { ExternalType::EcmaScriptModule => {
node_esm_resolve_options(alias_lookup_path.root()) node_esm_resolve_options(alias_lookup_path.root())
} }
ExternalType::Global => options, ExternalType::Script | ExternalType::Url | ExternalType::Global => options,
}, },
) )
.await? .await?
......
...@@ -23,6 +23,7 @@ use crate::{ ...@@ -23,6 +23,7 @@ use crate::{
references::async_module::{AsyncModule, OptionAsyncModule}, references::async_module::{AsyncModule, OptionAsyncModule},
runtime_functions::{ runtime_functions::{
TURBOPACK_EXPORT_NAMESPACE, TURBOPACK_EXTERNAL_IMPORT, TURBOPACK_EXTERNAL_REQUIRE, TURBOPACK_EXPORT_NAMESPACE, TURBOPACK_EXTERNAL_IMPORT, TURBOPACK_EXTERNAL_REQUIRE,
TURBOPACK_LOAD_BY_URL,
}, },
utils::StringifyJs, utils::StringifyJs,
}; };
...@@ -45,6 +46,7 @@ pub enum CachedExternalType { ...@@ -45,6 +46,7 @@ pub enum CachedExternalType {
EcmaScriptViaRequire, EcmaScriptViaRequire,
EcmaScriptViaImport, EcmaScriptViaImport,
Global, Global,
Script,
} }
impl Display for CachedExternalType { impl Display for CachedExternalType {
...@@ -54,6 +56,7 @@ impl Display for CachedExternalType { ...@@ -54,6 +56,7 @@ impl Display for CachedExternalType {
CachedExternalType::EcmaScriptViaRequire => write!(f, "esm_require"), CachedExternalType::EcmaScriptViaRequire => write!(f, "esm_require"),
CachedExternalType::EcmaScriptViaImport => write!(f, "esm_import"), CachedExternalType::EcmaScriptViaImport => write!(f, "esm_import"),
CachedExternalType::Global => write!(f, "global"), CachedExternalType::Global => write!(f, "global"),
CachedExternalType::Script => write!(f, "script"),
} }
} }
} }
...@@ -103,6 +106,60 @@ impl CachedExternalModule { ...@@ -103,6 +106,60 @@ impl CachedExternalModule {
)?; )?;
} }
} }
CachedExternalType::Script => {
// Parse the request format: "variableName@url"
// e.g., "foo@https://test.test.com"
if let Some(at_index) = self.request.find('@') {
let variable_name = &self.request[..at_index];
let url = &self.request[at_index + 1..];
// Wrap the loading and variable access in a try-catch block
writeln!(code, "let mod;")?;
writeln!(code, "try {{")?;
// First load the URL
writeln!(
code,
" await {TURBOPACK_LOAD_BY_URL}({});",
StringifyJs(url)
)?;
// Then get the variable from global with existence check
writeln!(
code,
" if (typeof global[{}] === 'undefined') {{",
StringifyJs(variable_name)
)?;
writeln!(
code,
" throw new Error('Variable {} is not available on global object after \
loading {}');",
StringifyJs(variable_name),
StringifyJs(url)
)?;
writeln!(code, " }}")?;
writeln!(code, " mod = global[{}];", StringifyJs(variable_name))?;
// Catch and re-throw errors with more context
writeln!(code, "}} catch (error) {{")?;
writeln!(
code,
" throw new Error('Failed to load external URL module {}: ' + \
(error.message || error));",
StringifyJs(&self.request)
)?;
writeln!(code, "}}")?;
} else {
// Invalid format - throw error
writeln!(
code,
"throw new Error('Invalid URL external format. Expected \"variable@url\", \
got: {}');",
StringifyJs(&self.request)
)?;
writeln!(code, "const mod = undefined;")?;
}
}
CachedExternalType::EcmaScriptViaRequire | CachedExternalType::CommonJs => { CachedExternalType::EcmaScriptViaRequire | CachedExternalType::CommonJs => {
writeln!( writeln!(
code, code,
......
...@@ -668,8 +668,7 @@ async fn externals_tracing_module_context(ty: ExternalType) -> Result<Vc<ModuleA ...@@ -668,8 +668,7 @@ async fn externals_tracing_module_context(ty: ExternalType) -> Result<Vc<ModuleA
custom_conditions: match ty { custom_conditions: match ty {
ExternalType::CommonJs => vec!["require".into()], ExternalType::CommonJs => vec!["require".into()],
ExternalType::EcmaScriptModule => vec!["import".into()], ExternalType::EcmaScriptModule => vec!["import".into()],
ExternalType::Url => vec![], ExternalType::Url | ExternalType::Global | ExternalType::Script => vec![],
ExternalType::Global => vec![],
}, },
..Default::default() ..Default::default()
}; };
...@@ -1019,6 +1018,7 @@ pub async fn replace_external( ...@@ -1019,6 +1018,7 @@ pub async fn replace_external(
} }
} }
ExternalType::Global => CachedExternalType::Global, ExternalType::Global => CachedExternalType::Global,
ExternalType::Script => CachedExternalType::Script,
ExternalType::Url => { ExternalType::Url => {
// we don't want to wrap url externals. // we don't want to wrap url externals.
return Ok(None); return Ok(None);
......
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