Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: support compilation.hooks.runtimeRequirementInTree #7917

Merged
merged 6 commits into from
Sep 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 33 additions & 22 deletions crates/node_binding/binding.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -717,6 +717,15 @@ export interface JsRuntimeModuleArg {
chunk: JsChunk
}

export interface JsRuntimeRequirementInTreeArg {
chunk: JsChunk
runtimeRequirements: JsRuntimeGlobals
}

export interface JsRuntimeRequirementInTreeResult {
runtimeRequirements: JsRuntimeGlobals
}

export interface JsStatsAsset {
type: string
name: string
Expand Down Expand Up @@ -1828,28 +1837,29 @@ export enum RegisterJsTapKind {
CompilationOptimizeTree = 15,
CompilationOptimizeChunkModules = 16,
CompilationAdditionalTreeRuntimeRequirements = 17,
CompilationRuntimeModule = 18,
CompilationChunkHash = 19,
CompilationChunkAsset = 20,
CompilationProcessAssets = 21,
CompilationAfterProcessAssets = 22,
CompilationSeal = 23,
CompilationAfterSeal = 24,
NormalModuleFactoryBeforeResolve = 25,
NormalModuleFactoryFactorize = 26,
NormalModuleFactoryResolve = 27,
NormalModuleFactoryAfterResolve = 28,
NormalModuleFactoryCreateModule = 29,
NormalModuleFactoryResolveForScheme = 30,
ContextModuleFactoryBeforeResolve = 31,
ContextModuleFactoryAfterResolve = 32,
JavascriptModulesChunkHash = 33,
HtmlPluginBeforeAssetTagGeneration = 34,
HtmlPluginAlterAssetTags = 35,
HtmlPluginAlterAssetTagGroups = 36,
HtmlPluginAfterTemplateExecution = 37,
HtmlPluginBeforeEmit = 38,
HtmlPluginAfterEmit = 39
CompilationRuntimeRequirementInTree = 18,
CompilationRuntimeModule = 19,
CompilationChunkHash = 20,
CompilationChunkAsset = 21,
CompilationProcessAssets = 22,
CompilationAfterProcessAssets = 23,
CompilationSeal = 24,
CompilationAfterSeal = 25,
NormalModuleFactoryBeforeResolve = 26,
NormalModuleFactoryFactorize = 27,
NormalModuleFactoryResolve = 28,
NormalModuleFactoryAfterResolve = 29,
NormalModuleFactoryCreateModule = 30,
NormalModuleFactoryResolveForScheme = 31,
ContextModuleFactoryBeforeResolve = 32,
ContextModuleFactoryAfterResolve = 33,
JavascriptModulesChunkHash = 34,
HtmlPluginBeforeAssetTagGeneration = 35,
HtmlPluginAlterAssetTags = 36,
HtmlPluginAlterAssetTagGroups = 37,
HtmlPluginAfterTemplateExecution = 38,
HtmlPluginBeforeEmit = 39,
HtmlPluginAfterEmit = 40
}

export interface RegisterJsTaps {
Expand All @@ -1866,6 +1876,7 @@ export interface RegisterJsTaps {
registerCompilationSucceedModuleTaps: (stages: Array<number>) => Array<{ function: ((arg: JsModule) => void); stage: number; }>
registerCompilationExecuteModuleTaps: (stages: Array<number>) => Array<{ function: ((arg: JsExecuteModuleArg) => void); stage: number; }>
registerCompilationAdditionalTreeRuntimeRequirements: (stages: Array<number>) => Array<{ function: ((arg: JsAdditionalTreeRuntimeRequirementsArg) => JsAdditionalTreeRuntimeRequirementsResult | undefined); stage: number; }>
registerCompilationRuntimeRequirementInTree: (stages: Array<number>) => Array<{ function: ((arg: JsRuntimeRequirementInTreeArg) => JsRuntimeRequirementInTreeResult | undefined); stage: number; }>
registerCompilationRuntimeModuleTaps: (stages: Array<number>) => Array<{ function: ((arg: JsRuntimeModuleArg) => JsRuntimeModule | undefined); stage: number; }>
registerCompilationFinishModulesTaps: (stages: Array<number>) => Array<{ function: ((arg: JsCompilation) => Promise<void>); stage: number; }>
registerCompilationOptimizeModulesTaps: (stages: Array<number>) => Array<{ function: (() => boolean | undefined); stage: number; }>
Expand Down
62 changes: 55 additions & 7 deletions crates/node_binding/src/plugins/interceptor.rs
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,8 @@ use rspack_binding_values::{
JsContextModuleFactoryBeforeResolveResult, JsCreateData, JsExecuteModuleArg, JsFactorizeArgs,
JsFactorizeOutput, JsModule, JsNormalModuleFactoryCreateModuleArgs, JsResolveArgs,
JsResolveForSchemeArgs, JsResolveForSchemeOutput, JsResolveOutput, JsRuntimeGlobals,
JsRuntimeModule, JsRuntimeModuleArg, ToJsCompatSource, ToJsModule,
JsRuntimeModule, JsRuntimeModuleArg, JsRuntimeRequirementInTreeArg,
JsRuntimeRequirementInTreeResult, ToJsCompatSource, ToJsModule,
};
use rspack_collections::IdentifierSet;
use rspack_core::{
Expand All @@ -36,12 +37,13 @@ use rspack_core::{
CompilationOptimizeChunkModulesHook, CompilationOptimizeModules, CompilationOptimizeModulesHook,
CompilationOptimizeTree, CompilationOptimizeTreeHook, CompilationParams,
CompilationProcessAssets, CompilationProcessAssetsHook, CompilationRuntimeModule,
CompilationRuntimeModuleHook, CompilationSeal, CompilationSealHook, CompilationStillValidModule,
CompilationStillValidModuleHook, CompilationSucceedModule, CompilationSucceedModuleHook,
CompilerAfterEmit, CompilerAfterEmitHook, CompilerAssetEmitted, CompilerAssetEmittedHook,
CompilerCompilation, CompilerCompilationHook, CompilerEmit, CompilerEmitHook, CompilerFinishMake,
CompilerFinishMakeHook, CompilerMake, CompilerMakeHook, CompilerShouldEmit,
CompilerShouldEmitHook, CompilerThisCompilation, CompilerThisCompilationHook,
CompilationRuntimeModuleHook, CompilationRuntimeRequirementInTree,
CompilationRuntimeRequirementInTreeHook, CompilationSeal, CompilationSealHook,
CompilationStillValidModule, CompilationStillValidModuleHook, CompilationSucceedModule,
CompilationSucceedModuleHook, CompilerAfterEmit, CompilerAfterEmitHook, CompilerAssetEmitted,
CompilerAssetEmittedHook, CompilerCompilation, CompilerCompilationHook, CompilerEmit,
CompilerEmitHook, CompilerFinishMake, CompilerFinishMakeHook, CompilerMake, CompilerMakeHook,
CompilerShouldEmit, CompilerShouldEmitHook, CompilerThisCompilation, CompilerThisCompilationHook,
ContextModuleFactoryAfterResolve, ContextModuleFactoryAfterResolveHook,
ContextModuleFactoryBeforeResolve, ContextModuleFactoryBeforeResolveHook, ExecuteModuleId,
ModuleFactoryCreateData, ModuleIdentifier, NormalModuleCreateData,
Expand Down Expand Up @@ -321,6 +323,7 @@ pub enum RegisterJsTapKind {
CompilationOptimizeTree,
CompilationOptimizeChunkModules,
CompilationAdditionalTreeRuntimeRequirements,
CompilationRuntimeRequirementInTree,
CompilationRuntimeModule,
CompilationChunkHash,
CompilationChunkAsset,
Expand Down Expand Up @@ -417,6 +420,12 @@ pub struct RegisterJsTaps {
JsAdditionalTreeRuntimeRequirementsArg,
Option<JsAdditionalTreeRuntimeRequirementsResult>,
>,
#[napi(
ts_type = "(stages: Array<number>) => Array<{ function: ((arg: JsRuntimeRequirementInTreeArg) => JsRuntimeRequirementInTreeResult | undefined); stage: number; }>"
)]
pub register_compilation_runtime_requirement_in_tree:
RegisterFunction<JsRuntimeRequirementInTreeArg, Option<JsRuntimeRequirementInTreeResult>>,

#[napi(
ts_type = "(stages: Array<number>) => Array<{ function: ((arg: JsRuntimeModuleArg) => JsRuntimeModule | undefined); stage: number; }>"
)]
Expand Down Expand Up @@ -689,6 +698,14 @@ define_register!(
kind = RegisterJsTapKind::CompilationAdditionalTreeRuntimeRequirements,
skip = true,
);
define_register!(
RegisterCompilationRuntimeRequirementInTreeTaps,
tap = CompilationRuntimeRequirementInTreeTap<JsRuntimeRequirementInTreeArg, Option<JsRuntimeRequirementInTreeResult>> @ CompilationRuntimeRequirementInTreeHook,
cache = true,
sync = true,
kind = RegisterJsTapKind::CompilationRuntimeRequirementInTree,
skip = true,
);
define_register!(
RegisterCompilationRuntimeModuleTaps,
tap = CompilationRuntimeModuleTap<JsRuntimeModuleArg, Option<JsRuntimeModule>> @ CompilationRuntimeModuleHook,
Expand Down Expand Up @@ -1139,6 +1156,37 @@ impl CompilationAdditionalTreeRuntimeRequirements
}
}

#[async_trait]
impl CompilationRuntimeRequirementInTree for CompilationRuntimeRequirementInTreeTap {
fn run(
&self,
compilation: &mut Compilation,
chunk_ukey: &ChunkUkey,
all_runtime_requirements: &RuntimeGlobals,
_runtime_requirements: &RuntimeGlobals,
runtime_requirements_mut: &mut RuntimeGlobals,
) -> rspack_error::Result<Option<()>> {
let chunk = compilation.chunk_by_ukey.expect_get(chunk_ukey);
let arg = JsRuntimeRequirementInTreeArg {
chunk: JsChunk::from(chunk),
runtime_requirements: JsRuntimeGlobals::from(*all_runtime_requirements),
};
let result = self.function.blocking_call_with_sync(arg)?;
if let Some(result) = result {
runtime_requirements_mut.extend(
result
.as_runtime_globals()
.difference(*all_runtime_requirements),
);
}
Ok(None)
}

fn stage(&self) -> i32 {
self.stage
}
}

#[async_trait]
impl CompilationRuntimeModule for CompilationRuntimeModuleTap {
async fn run(
Expand Down
15 changes: 15 additions & 0 deletions crates/node_binding/src/plugins/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ pub struct JsHooksAdapterPlugin {
register_compilation_optimize_chunk_modules_taps: RegisterCompilationOptimizeChunkModulesTaps,
register_compilation_additional_tree_runtime_requirements:
RegisterCompilationAdditionalTreeRuntimeRequirementsTaps,
register_compilation_runtime_requirement_in_tree: RegisterCompilationRuntimeRequirementInTreeTaps,
register_compilation_runtime_module_taps: RegisterCompilationRuntimeModuleTaps,
register_compilation_chunk_hash_taps: RegisterCompilationChunkHashTaps,
register_compilation_chunk_asset_taps: RegisterCompilationChunkAssetTaps,
Expand Down Expand Up @@ -187,6 +188,15 @@ impl rspack_core::Plugin for JsHooksAdapterPlugin {
.register_compilation_additional_tree_runtime_requirements
.clone(),
);
ctx
.context
.compilation_hooks
.runtime_requirement_in_tree
.intercept(
self
.register_compilation_runtime_requirement_in_tree
.clone(),
);
ctx
.context
.compilation_hooks
Expand Down Expand Up @@ -433,6 +443,11 @@ impl JsHooksAdapterPlugin {
register_js_taps.register_compilation_additional_tree_runtime_requirements,
non_skippable_registers.clone(),
),
register_compilation_runtime_requirement_in_tree:
RegisterCompilationRuntimeRequirementInTreeTaps::new(
register_js_taps.register_compilation_runtime_requirement_in_tree,
non_skippable_registers.clone(),
),
register_compilation_runtime_module_taps: RegisterCompilationRuntimeModuleTaps::new(
register_js_taps.register_compilation_runtime_module_taps,
non_skippable_registers.clone(),
Expand Down
31 changes: 31 additions & 0 deletions crates/rspack_binding_values/src/runtime.rs
Original file line number Diff line number Diff line change
Expand Up @@ -141,3 +141,34 @@ impl JsAdditionalTreeRuntimeRequirementsResult {
runtime_requirements
}
}

#[napi(object)]
pub struct JsRuntimeRequirementInTreeArg {
pub chunk: JsChunk,
pub runtime_requirements: JsRuntimeGlobals,
}

#[derive(Debug)]
#[napi(object)]
pub struct JsRuntimeRequirementInTreeResult {
pub runtime_requirements: JsRuntimeGlobals,
}

impl JsRuntimeRequirementInTreeResult {
pub fn as_runtime_globals(&self) -> RuntimeGlobals {
let mut runtime_requirements = RuntimeGlobals::default();

for item in self.runtime_requirements.value.iter() {
let snake_name = item.to_snake_case();

if let Some(item) = RUNTIME_GLOBAL_MAP
.1
.get(snake_name.cow_to_uppercase().as_ref())
{
runtime_requirements.extend(*item);
}
}

runtime_requirements
}
}
18 changes: 12 additions & 6 deletions crates/rspack_core/src/compiler/compilation.rs
Original file line number Diff line number Diff line change
Expand Up @@ -66,10 +66,10 @@ define_hook!(CompilationOptimizeChunkModules: AsyncSeriesBail(compilation: &mut
define_hook!(CompilationModuleIds: SyncSeries(compilation: &mut Compilation));
define_hook!(CompilationChunkIds: SyncSeries(compilation: &mut Compilation));
define_hook!(CompilationRuntimeModule: AsyncSeries(compilation: &mut Compilation, module: &ModuleIdentifier, chunk: &ChunkUkey));
define_hook!(CompilationRuntimeRequirementInModule: SyncSeriesBail(compilation: &Compilation, module_identifier: &ModuleIdentifier, runtime_requirements: &RuntimeGlobals, runtime_requirements_mut: &mut RuntimeGlobals));
define_hook!(CompilationRuntimeRequirementInModule: SyncSeriesBail(compilation: &Compilation, module_identifier: &ModuleIdentifier, all_runtime_requirements: &RuntimeGlobals, runtime_requirements: &RuntimeGlobals, runtime_requirements_mut: &mut RuntimeGlobals));
define_hook!(CompilationAdditionalChunkRuntimeRequirements: SyncSeries(compilation: &mut Compilation, chunk_ukey: &ChunkUkey, runtime_requirements: &mut RuntimeGlobals));
define_hook!(CompilationAdditionalTreeRuntimeRequirements: AsyncSeries(compilation: &mut Compilation, chunk_ukey: &ChunkUkey, runtime_requirements: &mut RuntimeGlobals));
define_hook!(CompilationRuntimeRequirementInTree: SyncSeriesBail(compilation: &mut Compilation, chunk_ukey: &ChunkUkey, runtime_requirements: &RuntimeGlobals, runtime_requirements_mut: &mut RuntimeGlobals));
define_hook!(CompilationRuntimeRequirementInTree: SyncSeriesBail(compilation: &mut Compilation, chunk_ukey: &ChunkUkey, all_runtime_requirements: &RuntimeGlobals, runtime_requirements: &RuntimeGlobals, runtime_requirements_mut: &mut RuntimeGlobals));
define_hook!(CompilationOptimizeCodeGeneration: SyncSeries(compilation: &mut Compilation));
define_hook!(CompilationChunkHash: AsyncSeries(compilation: &Compilation, chunk_ukey: &ChunkUkey, hasher: &mut RspackHash));
define_hook!(CompilationContentHash: AsyncSeries(compilation: &Compilation, chunk_ukey: &ChunkUkey, hashes: &mut HashMap<SourceType, RspackHash>));
Expand Down Expand Up @@ -1361,15 +1361,19 @@ impl Compilation {
) -> Result<()> {
fn process_runtime_requirement_hook(
requirements: &mut RuntimeGlobals,
mut call_hook: impl FnMut(&RuntimeGlobals, &mut RuntimeGlobals) -> Result<()>,
mut call_hook: impl FnMut(&RuntimeGlobals, &RuntimeGlobals, &mut RuntimeGlobals) -> Result<()>,
) -> Result<()> {
let mut runtime_requirements_mut = *requirements;
let mut runtime_requirements;

loop {
runtime_requirements = runtime_requirements_mut;
runtime_requirements_mut = RuntimeGlobals::default();
call_hook(&runtime_requirements, &mut runtime_requirements_mut)?;
call_hook(
requirements,
&runtime_requirements,
&mut runtime_requirements_mut,
)?;
runtime_requirements_mut =
runtime_requirements_mut.difference(requirements.intersection(runtime_requirements_mut));
if runtime_requirements_mut.is_empty() {
Expand Down Expand Up @@ -1401,13 +1405,14 @@ impl Compilation {
.get_runtime_requirements(&module, Some(runtime));
process_runtime_requirement_hook(
&mut runtime_requirements,
|runtime_requirements, runtime_requirements_mut| {
|all_runtime_requirements, runtime_requirements, runtime_requirements_mut| {
plugin_driver
.compilation_hooks
.runtime_requirement_in_module
.call(
self,
&module,
all_runtime_requirements,
runtime_requirements,
runtime_requirements_mut,
)?;
Expand Down Expand Up @@ -1475,13 +1480,14 @@ impl Compilation {

process_runtime_requirement_hook(
&mut set,
|runtime_requirements, runtime_requirements_mut| {
|all_runtime_requirements, runtime_requirements, runtime_requirements_mut| {
plugin_driver
.compilation_hooks
.runtime_requirement_in_tree
.call(
self,
&entry_ukey,
all_runtime_requirements,
runtime_requirements,
runtime_requirements_mut,
)?;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -183,6 +183,7 @@ fn runtime_requirements_in_tree(
&self,
compilation: &mut Compilation,
chunk_ukey: &ChunkUkey,
_all_runtime_requirements: &RuntimeGlobals,
runtime_requirements: &RuntimeGlobals,
runtime_requirements_mut: &mut RuntimeGlobals,
) -> Result<Option<()>> {
Expand Down
1 change: 1 addition & 0 deletions crates/rspack_plugin_extract_css/src/plugin.rs
Original file line number Diff line number Diff line change
Expand Up @@ -448,6 +448,7 @@ fn runtime_requirements_in_tree(
&self,
compilation: &mut Compilation,
chunk_ukey: &ChunkUkey,
_all_runtime_requirements: &RuntimeGlobals,
runtime_requirements: &RuntimeGlobals,
runtime_requirements_mut: &mut RuntimeGlobals,
) -> Result<Option<()>> {
Expand Down
1 change: 1 addition & 0 deletions crates/rspack_plugin_mf/src/container/container_plugin.rs
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,7 @@ fn runtime_requirements_in_tree(
&self,
compilation: &mut Compilation,
chunk_ukey: &ChunkUkey,
_all_runtime_requirements: &RuntimeGlobals,
runtime_requirements: &RuntimeGlobals,
runtime_requirements_mut: &mut RuntimeGlobals,
) -> Result<Option<()>> {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,7 @@ fn runtime_requirements_in_tree(
&self,
compilation: &mut Compilation,
chunk_ukey: &ChunkUkey,
_all_runtime_requirements: &RuntimeGlobals,
runtime_requirements: &RuntimeGlobals,
runtime_requirements_mut: &mut RuntimeGlobals,
) -> Result<Option<()>> {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ fn runtime_requirements_in_tree(
&self,
compilation: &mut Compilation,
chunk_ukey: &ChunkUkey,
_all_runtime_requirements: &RuntimeGlobals,
runtime_requirements: &RuntimeGlobals,
_runtime_requirements_mut: &mut RuntimeGlobals,
) -> Result<Option<()>> {
Expand Down
1 change: 1 addition & 0 deletions crates/rspack_plugin_runtime/src/bundler_info.rs
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@ fn runtime_requirements_in_tree(
&self,
compilation: &mut Compilation,
chunk_ukey: &ChunkUkey,
_all_runtime_requirements: &RuntimeGlobals,
runtime_requirements: &RuntimeGlobals,
_runtime_requirements_mut: &mut RuntimeGlobals,
) -> Result<Option<()>> {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ fn runtime_requirements_in_tree(
&self,
compilation: &mut Compilation,
chunk_ukey: &ChunkUkey,
_all_runtime_requirements: &RuntimeGlobals,
runtime_requirements: &RuntimeGlobals,
runtime_requirements_mut: &mut RuntimeGlobals,
) -> Result<Option<()>> {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ fn runtime_requirements_in_tree(
&self,
compilation: &mut Compilation,
chunk_ukey: &ChunkUkey,
_all_runtime_requirements: &RuntimeGlobals,
runtime_requirements: &RuntimeGlobals,
runtime_requirements_mut: &mut RuntimeGlobals,
) -> Result<Option<()>> {
Expand Down
1 change: 1 addition & 0 deletions crates/rspack_plugin_runtime/src/jsonp_chunk_loading.rs
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ fn runtime_requirements_in_tree(
&self,
compilation: &mut Compilation,
chunk_ukey: &ChunkUkey,
_all_runtime_requirements: &RuntimeGlobals,
runtime_requirements: &RuntimeGlobals,
runtime_requirements_mut: &mut RuntimeGlobals,
) -> Result<Option<()>> {
Expand Down
1 change: 1 addition & 0 deletions crates/rspack_plugin_runtime/src/module_chunk_loading.rs
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ fn runtime_requirements_in_tree(
&self,
compilation: &mut Compilation,
chunk_ukey: &ChunkUkey,
_all_runtime_requirements: &RuntimeGlobals,
runtime_requirements: &RuntimeGlobals,
runtime_requirements_mut: &mut RuntimeGlobals,
) -> Result<Option<()>> {
Expand Down
Loading
Loading