feat: NormalModuleFactory and resolveForScheme hook (#2356)

* chore: 🤖 init nmf

* feat: 🎸 finish normalmodulefactory resolveForScheme

* chore: 🤖 recover

* chore: 🤖 recover

* chore: 🤖 recover

* chore: 🤖 lint

* chore: 🤖 compile

* chore: 🤖 fix compile error

* chore: 🤖 changeset

Author: IWANABETHATGUY

.changeset/hungry-otters-kneel.md

@@ -0,0 +1,6 @@
+---
+"@rspack/binding": patch
+"@rspack/core": patch
+---
+
+feat: add normalModuleFactory and resolveForScheme hook

.gitignore

@@ -194,3 +194,4 @@ npm/**/*.node
 
 # Precompiled config schema
 packages/rspack/src/config/schema.check.js
+justfile

crates/loader_runner/src/runner.rs

@@ -10,7 +10,7 @@ use rustc_hash::FxHashSet as HashSet;
 
 use crate::{Content, LoaderRunnerPlugin};
 
-#[derive(Debug, Clone)]
+#[derive(Debug, Clone, Default)]
 pub struct ResourceData {
   /// Resource with absolute path, query and fragment
   pub resource: String,

crates/node_binding/binding.d.ts

@@ -426,12 +426,27 @@ export interface JsHooks {
   afterEmit: (...args: any[]) => any
   make: (...args: any[]) => any
   optimizeChunkModule: (...args: any[]) => any
+  normalModuleFactoryResolveForScheme: (...args: any[]) => any
 }
 export interface JsModule {
   originalSource?: JsCompatSource
   resource: string
   moduleIdentifier: string
 }
+export interface SchemeAndJsResourceData {
+  resourceData: JsResourceData
+  scheme: string
+}
+export interface JsResourceData {
+  /** Resource with absolute path, query and fragment */
+  resource: string
+  /** Absolute resource path only */
+  path: string
+  /** Resource query with `?` prefix */
+  query?: string
+  /** Resource fragment with `#` prefix */
+  fragment?: string
+}
 export interface JsCompatSource {
   /** Whether the underlying data structure is a `RawSource` */
   isRaw: boolean

crates/node_binding/src/js_values/hooks.rs

@@ -14,4 +14,5 @@ pub struct JsHooks {
   pub after_emit: JsFunction,
   pub make: JsFunction,
   pub optimize_chunk_module: JsFunction,
+  pub normal_module_factory_resolve_for_scheme: JsFunction,
 }

crates/node_binding/src/js_values/mod.rs

@@ -4,6 +4,7 @@ mod chunk_group;
 mod compilation;
 mod hooks;
 mod module;
+mod normal_module_factory;
 mod source;
 mod stats;
 
@@ -12,5 +13,6 @@ pub use chunk::*;
 pub use chunk_group::*;
 pub use compilation::*;
 pub use hooks::*;
+pub use normal_module_factory::*;
 pub use source::*;
 pub use stats::*;

crates/node_binding/src/js_values/normal_module_factory.rs

@@ -0,0 +1,39 @@
+use rspack_core::{NormalModuleFactoryResolveForSchemeArgs, ResourceData};
+
+#[napi(object)]
+pub struct SchemeAndJsResourceData {
+  pub resource_data: JsResourceData,
+  pub scheme: String,
+}
+
+#[napi(object)]
+pub struct JsResourceData {
+  /// Resource with absolute path, query and fragment
+  pub resource: String,
+  /// Absolute resource path only
+  pub path: String,
+  /// Resource query with `?` prefix
+  pub query: Option<String>,
+  /// Resource fragment with `#` prefix
+  pub fragment: Option<String>,
+}
+
+impl From<ResourceData> for JsResourceData {
+  fn from(value: ResourceData) -> Self {
+    Self {
+      resource: value.resource,
+      path: value.resource_path.to_string_lossy().to_string(),
+      query: value.resource_query,
+      fragment: value.resource_fragment,
+    }
+  }
+}
+
+impl From<NormalModuleFactoryResolveForSchemeArgs> for SchemeAndJsResourceData {
+  fn from(value: NormalModuleFactoryResolveForSchemeArgs) -> Self {
+    Self {
+      resource_data: value.resource.into(),
+      scheme: value.scheme,
+    }
+  }
+}

crates/node_binding/src/plugins/mod.rs

@@ -1,12 +1,18 @@
 use std::fmt::Debug;
+use std::path::PathBuf;
 
 use async_trait::async_trait;
 use napi::{Env, Result};
 use rspack_binding_macros::js_fn_into_theadsafe_fn;
+use rspack_core::{
+  NormalModuleFactoryResolveForSchemeArgs, PluginNormalModuleFactoryResolveForSchemeOutput,
+  ResourceData,
+};
 use rspack_error::internal_error;
 use rspack_napi_shared::threadsafe_function::{ThreadsafeFunction, ThreadsafeFunctionCallMode};
 use rspack_napi_shared::NapiResultExt;
 
+use crate::js_values::{JsResourceData, SchemeAndJsResourceData};
 use crate::{DisabledHooks, Hook, JsCompilation, JsHooks};
 
 pub struct JsHooksAdapter {
@@ -23,6 +29,8 @@ pub struct JsHooksAdapter {
   pub emit_tsfn: ThreadsafeFunction<(), ()>,
   pub after_emit_tsfn: ThreadsafeFunction<(), ()>,
   pub optimize_chunk_modules_tsfn: ThreadsafeFunction<JsCompilation, ()>,
+  pub normal_module_factory_resolve_for_scheme:
+    ThreadsafeFunction<SchemeAndJsResourceData, JsResourceData>,
 }
 
 impl Debug for JsHooksAdapter {
@@ -100,6 +108,28 @@ impl rspack_core::Plugin for JsHooksAdapter {
       .map_err(|err| internal_error!("Failed to call make: {err}",))?
   }
 
+  async fn normal_module_factory_resolve_for_scheme(
+    &self,
+    _ctx: rspack_core::PluginContext,
+    args: &NormalModuleFactoryResolveForSchemeArgs,
+  ) -> PluginNormalModuleFactoryResolveForSchemeOutput {
+    let res = self
+      .normal_module_factory_resolve_for_scheme
+      .call(args.clone().into(), ThreadsafeFunctionCallMode::NonBlocking)
+      .into_rspack_result()?
+      .await
+      .map_err(|err| internal_error!("Failed to call this_compilation: {err}"))?;
+    res.map(|res| {
+      Some(ResourceData {
+        resource: res.resource,
+        resource_fragment: res.fragment,
+        resource_path: PathBuf::from(res.path),
+        resource_query: res.query,
+        resource_description: None,
+      })
+    })
+  }
+
   async fn process_assets_stage_additional(
     &mut self,
     _ctx: rspack_core::PluginContext,
@@ -205,6 +235,28 @@ impl rspack_core::Plugin for JsHooksAdapter {
       .map_err(|err| internal_error!("Failed to call process assets stage report: {err}",))?
   }
 
+  async fn optimize_chunk_modules(
+    &mut self,
+    args: rspack_core::OptimizeChunksArgs<'_>,
+  ) -> rspack_error::Result<()> {
+    if self.is_hook_disabled(&Hook::OptimizeChunkModules) {
+      return Ok(());
+    }
+
+    let compilation = JsCompilation::from_compilation(unsafe {
+      std::mem::transmute::<&'_ mut rspack_core::Compilation, &'static mut rspack_core::Compilation>(
+        args.compilation,
+      )
+    });
+
+    self
+      .optimize_chunk_modules_tsfn
+      .call(compilation, ThreadsafeFunctionCallMode::NonBlocking)
+      .into_rspack_result()?
+      .await
+      .map_err(|err| internal_error!("Failed to compilation: {err}"))?
+  }
+
   async fn emit(&mut self, _: &mut rspack_core::Compilation) -> rspack_error::Result<()> {
     if self.is_hook_disabled(&Hook::Emit) {
       return Ok(());
@@ -230,28 +282,6 @@ impl rspack_core::Plugin for JsHooksAdapter {
       .await
       .map_err(|err| internal_error!("Failed to call after emit: {err}",))?
   }
-
-  async fn optimize_chunk_modules(
-    &mut self,
-    args: rspack_core::OptimizeChunksArgs<'_>,
-  ) -> rspack_error::Result<()> {
-    if self.is_hook_disabled(&Hook::OptimizeChunkModules) {
-      return Ok(());
-    }
-
-    let compilation = JsCompilation::from_compilation(unsafe {
-      std::mem::transmute::<&'_ mut rspack_core::Compilation, &'static mut rspack_core::Compilation>(
-        args.compilation,
-      )
-    });
-
-    self
-      .optimize_chunk_modules_tsfn
-      .call(compilation, ThreadsafeFunctionCallMode::NonBlocking)
-      .into_rspack_result()?
-      .await
-      .map_err(|err| internal_error!("Failed to compilation: {err}"))?
-  }
 }
 
 impl JsHooksAdapter {
@@ -269,6 +299,7 @@ impl JsHooksAdapter {
       emit,
       after_emit,
       optimize_chunk_module,
+      normal_module_factory_resolve_for_scheme,
     } = js_hooks;
 
     let process_assets_stage_additional_tsfn: ThreadsafeFunction<(), ()> =
@@ -293,6 +324,11 @@ impl JsHooksAdapter {
     let optimize_chunk_modules_tsfn: ThreadsafeFunction<JsCompilation, ()> =
       js_fn_into_theadsafe_fn!(optimize_chunk_module, env);
 
+    let normal_module_factory_resolve_for_scheme: ThreadsafeFunction<
+      SchemeAndJsResourceData,
+      JsResourceData,
+    > = js_fn_into_theadsafe_fn!(normal_module_factory_resolve_for_scheme, env);
+
     Ok(JsHooksAdapter {
       disabled_hooks,
       make_tsfn,
@@ -307,6 +343,7 @@ impl JsHooksAdapter {
       emit_tsfn,
       after_emit_tsfn,
       optimize_chunk_modules_tsfn,
+      normal_module_factory_resolve_for_scheme,
     })
   }