feat: using dojang to render runtime_template (#9422)

* feat: using dojang to render runtime_template

* fix: normalize line endings in runtime template rendering

* refactor: use cow_replace for line ending normalization

* chore: add comment explaining line ending normalization

* fix: update variable names to use camelCase in auto public path template

crates/rspack_core/src/runtime_template.rs

@@ -4,6 +4,7 @@ use std::{
   sync::{LazyLock, Mutex},
 };
 
+use cow_utils::CowUtils;
 use itertools::Itertools;
 use rspack_dojang::{Context, Dojang, Operand};
 use rspack_error::{miette, Result};
@@ -119,6 +120,8 @@ impl RuntimeTemplate {
           file_content,
           &mut Mutex::new(HashMap::new()),
         )
+        // Replace Windows-style line endings (\r\n) with Unix-style (\n) to ensure consistent runtime templates across platforms
+        .map(|render| render.cow_replace("\r\n", "\n").to_string())
         .map_err(|err| {
           miette::Error::msg(format!(
             "Runtime module: failed to render template {key} from: {err}"

crates/rspack_plugin_runtime/src/runtime_module/auto_public_path.rs

@@ -3,7 +3,7 @@ use rspack_core::{
   get_js_chunk_filename_template, get_undo_path, impl_runtime_module,
   rspack_sources::{BoxSource, RawStringSource, SourceExt},
   ChunkUkey, Compilation, OutputOptions, PathData, RuntimeGlobals, RuntimeModule,
-  RuntimeModuleStage, SourceType,
+  RuntimeModuleStage, RuntimeTemplate, SourceType,
 };
 
 #[impl_runtime_module]
@@ -32,6 +32,13 @@ impl RuntimeModule for AutoPublicPathRuntimeModule {
     RuntimeModuleStage::Attach
   }
 
+  fn template(&self) -> Vec<(String, String)> {
+    vec![(
+      self.id.to_string(),
+      include_str!("runtime/auto_public_path.ejs").to_string(),
+    )]
+  }
+
   fn generate(&self, compilation: &Compilation) -> rspack_error::Result<BoxSource> {
     let chunk = self.chunk.expect("The chunk should be attached");
     let chunk = compilation.chunk_by_ukey.expect_get(&chunk);
@@ -61,15 +68,22 @@ impl RuntimeModule for AutoPublicPathRuntimeModule {
     )?;
     Ok(
       RawStringSource::from(auto_public_path_template(
+        &compilation.runtime_template,
+        &self.id,
         &filename,
         &compilation.options.output,
-      ))
+      )?)
       .boxed(),
     )
   }
 }
 
-fn auto_public_path_template(filename: &str, output: &OutputOptions) -> String {
+fn auto_public_path_template(
+  runtime_template: &RuntimeTemplate,
+  id: &str,
+  filename: &str,
+  output: &OutputOptions,
+) -> rspack_error::Result<String> {
   let output_path = output.path.as_str().to_string();
   let undo_path = get_undo_path(filename, output_path, false);
   let assign = if undo_path.is_empty() {
@@ -80,45 +94,14 @@ fn auto_public_path_template(filename: &str, output: &OutputOptions) -> String {
       RuntimeGlobals::PUBLIC_PATH
     )
   };
-  let global = RuntimeGlobals::GLOBAL.name();
   let import_meta_name = output.import_meta_name.clone();
 
-  let script_url_template = if output.script_type.eq("module") {
-    format!(
-      r#"var scriptUrl;
-    if (typeof {import_meta_name}.url === "string") scriptUrl = {import_meta_name}.url
-    "#
-    )
-    .to_string()
-  } else {
-    format!(
-      r#"var scriptUrl;
-    if ({global}.importScripts) scriptUrl = {global}.location + "";
-    var document = {global}.document;
-    if (!scriptUrl && document) {{
-      // Technically we could use `document.currentScript instanceof window.HTMLScriptElement`,
-      // but an attacker could try to inject `<script>HTMLScriptElement = HTMLImageElement</script>`
-      // and use `<img name="currentScript" src="https://attacker.controlled.server/"></img>`
-      if (document.currentScript && document.currentScript.tagName.toUpperCase() === 'SCRIPT') scriptUrl = document.currentScript.src;
-      if (!scriptUrl) {{
-        var scripts = document.getElementsByTagName("script");
-            if (scripts.length) {{
-              var i = scripts.length - 1;
-              while (i > -1 && (!scriptUrl || !/^http(s?):/.test(scriptUrl))) scriptUrl = scripts[i--].src;
-            }}
-      }}
-      }}
-    "#
-    )
-  };
-  format!(
-    r#"
-    {script_url_template}
-    // When supporting browsers where an automatic publicPath is not supported you must specify an output.publicPath manually via configuration",
-    // or pass an empty string ("") and set the __webpack_public_path__ variable from your code to use your own logic.',
-    if (!scriptUrl) throw new Error("Automatic publicPath is not supported in this browser");
-    scriptUrl = scriptUrl.replace(/^blob:/, "").replace(/#.*$/, "").replace(/\?.*$/, "").replace(/\/[^\/]+$/, "/");
-    {assign}
-    "#
+  runtime_template.render(
+    id,
+    Some(serde_json::json!({
+      "script_type": output.script_type,
+      "import_meta_name": import_meta_name,
+      "assign": assign
+    })),
   )
 }

crates/rspack_plugin_runtime/src/runtime_module/compat_get_default_export.rs

@@ -24,7 +24,16 @@ impl RuntimeModule for CompatGetDefaultExportRuntimeModule {
     self.id
   }
 
-  fn generate(&self, _compilation: &Compilation) -> rspack_error::Result<BoxSource> {
-    Ok(RawStringSource::from_static(include_str!("runtime/compat_get_default_export.js")).boxed())
+  fn template(&self) -> Vec<(String, String)> {
+    vec![(
+      self.id.to_string(),
+      include_str!("runtime/compat_get_default_export.ejs").to_string(),
+    )]
+  }
+
+  fn generate(&self, compilation: &Compilation) -> rspack_error::Result<BoxSource> {
+    let source = compilation.runtime_template.render(&self.id, None)?;
+
+    Ok(RawStringSource::from(source).boxed())
   }
 }

crates/rspack_plugin_runtime/src/runtime_module/create_fake_namespace_object.rs

@@ -24,9 +24,16 @@ impl RuntimeModule for CreateFakeNamespaceObjectRuntimeModule {
     self.id
   }
 
-  fn generate(&self, _compilation: &Compilation) -> rspack_error::Result<BoxSource> {
-    Ok(
-      RawStringSource::from_static(include_str!("runtime/create_fake_namespace_object.js")).boxed(),
-    )
+  fn template(&self) -> Vec<(String, String)> {
+    vec![(
+      self.id.to_string(),
+      include_str!("runtime/create_fake_namespace_object.ejs").to_string(),
+    )]
+  }
+
+  fn generate(&self, compilation: &Compilation) -> rspack_error::Result<BoxSource> {
+    let source = compilation.runtime_template.render(&self.id, None)?;
+
+    Ok(RawStringSource::from(source).boxed())
   }
 }

crates/rspack_plugin_runtime/src/runtime_module/runtime/auto_public_path.ejs

@@ -0,0 +1,25 @@
+var scriptUrl;
+<% if (script_type == "module") { %>
+if (typeof <%- import_meta_name %>.url === "string") scriptUrl = <%- import_meta_name %>.url
+<% } else { %>
+if (<%- GLOBAL %>.importScripts) scriptUrl = <%- GLOBAL %>.location + "";
+var document = <%- GLOBAL %>.document;
+if (!scriptUrl && document) {
+  // Technically we could use `document.currentScript instanceof window.HTMLScriptElement`,
+  // but an attacker could try to inject `<script>HTMLScriptElement = HTMLImageElement</script>`
+  // and use `<img name="currentScript" src="https://attacker.controlled.server/"></img>`
+  if (document.currentScript && document.currentScript.tagName.toUpperCase() === 'SCRIPT') scriptUrl = document.currentScript.src;
+  if (!scriptUrl) {
+    var scripts = document.getElementsByTagName("script");
+    if (scripts.length) {
+      var i = scripts.length - 1;
+      while (i > -1 && (!scriptUrl || !/^http(s?):/.test(scriptUrl))) scriptUrl = scripts[i--].src;
+    }
+  }
+}
+<% } %>
+// When supporting browsers where an automatic publicPath is not supported you must specify an output.publicPath manually via configuration",
+// or pass an empty string ("") and set the __webpack_public_path__ variable from your code to use your own logic.',
+if (!scriptUrl) throw new Error("Automatic publicPath is not supported in this browser");
+scriptUrl = scriptUrl.replace(/^blob:/, "").replace(/#.*$/, "").replace(/\?.*$/, "").replace(/\/[^\/]+$/, "/");
+<%- assign %>

crates/rspack_plugin_runtime/src/runtime_module/runtime/compat_get_default_export.ejs

@@ -0,0 +1,8 @@
+// getDefaultExport function for compatibility with non-ESM modules
+<%- COMPAT_GET_DEFAULT_EXPORT %> = <%- basicFunction("module") %> {
+	var getter = module && module.__esModule ?
+		<%- returningFunction("module['default']", "") %> :
+		<%- returningFunction("module", "") %>;
+	<%- DEFINE_PROPERTY_GETTERS %>(getter, { a: getter });
+	return getter;
+};

crates/rspack_plugin_runtime/src/runtime_module/runtime/create_fake_namespace_object.js → crates/rspack_plugin_runtime/src/runtime_module/runtime/create_fake_namespace_object.ejs

@@ -1,26 +1,26 @@
-var getProto = Object.getPrototypeOf ? function(obj) { return Object.getPrototypeOf(obj); } : function(obj) { return obj.__proto__ };
+var getProto = Object.getPrototypeOf ? <%- returningFunction("Object.getPrototypeOf(obj)", "obj") %> : <%- returningFunction("obj.__proto__", "obj") %>;
 var leafPrototypes;
 // create a fake namespace object
 // mode & 1: value is a module id, require it
 // mode & 2: merge all properties of value into the ns
 // mode & 4: return value when already ns object
 // mode & 16: return value when it's Promise-like
 // mode & 8|1: behave like require
-__webpack_require__.t = function(value, mode) {
+<%- CREATE_FAKE_NAMESPACE_OBJECT %> = function(value, mode) {
 	if(mode & 1) value = this(value);
 	if(mode & 8) return value;
 	if(typeof value === 'object' && value) {
 		if((mode & 4) && value.__esModule) return value;
 		if((mode & 16) && typeof value.then === 'function') return value;
 	}
 	var ns = Object.create(null);
-	__webpack_require__.r(ns);
+  <%- MAKE_NAMESPACE_OBJECT %>(ns);
 	var def = {};
 	leafPrototypes = leafPrototypes || [null, getProto({}), getProto([]), getProto(getProto)];
 	for(var current = mode & 2 && value; typeof current == 'object' && !~leafPrototypes.indexOf(current); current = getProto(current)) {
-		Object.getOwnPropertyNames(current).forEach(function(key) { def[key] = function() { return  value[key]; } });
+		Object.getOwnPropertyNames(current).forEach(<%- basicFunction("key") %> { def[key] = <%- returningFunction("value[key]", "") %> });
 	}
-	def['default'] = function() { return value };
-	__webpack_require__.d(ns, def);
+	def['default'] = <%- returningFunction("value", "") %>;
+	<%- DEFINE_PROPERTY_GETTERS %>(ns, def);
 	return ns;
 };

packages/rspack-test-tools/tests/__snapshots__/Config.test.js.snap

@@ -471,17 +471,14 @@ return module.exports;
 // webpack/runtime/compat_get_default_export
 (() => {
 // getDefaultExport function for compatibility with non-ESM modules
-__webpack_require__.n = function (module) {
+__webpack_require__.n = (module) => {
 	var getter = module && module.__esModule ?
-		function () { return module['default']; } :
-		function () { return module; };
+		() => (module['default']) :
+		() => (module);
 	__webpack_require__.d(getter, { a: getter });
 	return getter;
 };
 
-
-
-
 })();
 // webpack/runtime/define_property_getters
 (() => {
@@ -611,17 +608,14 @@ return module.exports;
 // webpack/runtime/compat_get_default_export
 (() => {
 // getDefaultExport function for compatibility with non-ESM modules
-__webpack_require__.n = function (module) {
+__webpack_require__.n = (module) => {
 	var getter = module && module.__esModule ?
-		function () { return module['default']; } :
-		function () { return module; };
+		() => (module['default']) :
+		() => (module);
 	__webpack_require__.d(getter, { a: getter });
 	return getter;
 };
 
-
-
-
 })();
 // webpack/runtime/define_property_getters
 (() => {
@@ -696,17 +690,14 @@ return module.exports;
 // webpack/runtime/compat_get_default_export
 (() => {
 // getDefaultExport function for compatibility with non-ESM modules
-__webpack_require__.n = function (module) {
+__webpack_require__.n = (module) => {
 	var getter = module && module.__esModule ?
-		function () { return module['default']; } :
-		function () { return module; };
+		() => (module['default']) :
+		() => (module);
 	__webpack_require__.d(getter, { a: getter });
 	return getter;
 };
 
-
-
-
 })();
 // webpack/runtime/define_property_getters
 (() => {

packages/rspack-test-tools/tests/__snapshots__/NewCodeSplitting-config.test.js.snap

@@ -471,17 +471,14 @@ return module.exports;
 // webpack/runtime/compat_get_default_export
 (() => {
 // getDefaultExport function for compatibility with non-ESM modules
-__webpack_require__.n = function (module) {
+__webpack_require__.n = (module) => {
 	var getter = module && module.__esModule ?
-		function () { return module['default']; } :
-		function () { return module; };
+		() => (module['default']) :
+		() => (module);
 	__webpack_require__.d(getter, { a: getter });
 	return getter;
 };
 
-
-
-
 })();
 // webpack/runtime/define_property_getters
 (() => {
@@ -611,17 +608,14 @@ return module.exports;
 // webpack/runtime/compat_get_default_export
 (() => {
 // getDefaultExport function for compatibility with non-ESM modules
-__webpack_require__.n = function (module) {
+__webpack_require__.n = (module) => {
 	var getter = module && module.__esModule ?
-		function () { return module['default']; } :
-		function () { return module; };
+		() => (module['default']) :
+		() => (module);
 	__webpack_require__.d(getter, { a: getter });
 	return getter;
 };
 
-
-
-
 })();
 // webpack/runtime/define_property_getters
 (() => {
@@ -696,17 +690,14 @@ return module.exports;
 // webpack/runtime/compat_get_default_export
 (() => {
 // getDefaultExport function for compatibility with non-ESM modules
-__webpack_require__.n = function (module) {
+__webpack_require__.n = (module) => {
 	var getter = module && module.__esModule ?
-		function () { return module['default']; } :
-		function () { return module; };
+		() => (module['default']) :
+		() => (module);
 	__webpack_require__.d(getter, { a: getter });
 	return getter;
 };
 
-
-
-
 })();
 // webpack/runtime/define_property_getters
 (() => {

packages/rspack-test-tools/tests/__snapshots__/NewCodeSplitting-stats-output.test.js.snap

@@ -58,7 +58,7 @@ runtime modules xx KiB
     [no exports]
     [used exports unknown]
   
-Rspack compiled successfully (fc4b68e80ae135da)
+Rspack compiled successfully (ea70de85332c1294)
 `;
 
 exports[`new code splitting stats output new code splitting stats output/builtin-swc-loader-parse-error should print correct stats for: NewCodeSplittingStatsOutput 1`] = `
@@ -452,7 +452,7 @@ Rspack x.x.x compiled successfully in X s
 
 exports[`new code splitting stats output new code splitting stats output/simple-module-source should print correct stats for: NewCodeSplittingStatsOutput 1`] = `
 asset bundle.js xx KiB [emitted] (name: main)
-runtime modules 702 bytes 3 modules
+runtime modules 661 bytes 3 modules
 orphan modules 1 bytes [orphan] 1 module
 cacheable modules 82 bytes
   ./index.js 75 bytes [built] [code generated]