refactor: render javascript runtime globals according to compiler options (#12371)

* refactor: render javascript runtime globals according to compiler options

* refactor: render javascript runtime globals according to compiler options

* refactor: render javascript runtime globals according to compiler options

* refactor: remove unnecessary template string in RuntimeGlobals

* feat: add missing RuntimeGlobals from Rust implementation

- Add startupChunkDependencies
- Add rspackVersion (internal)
- Add rspackUniqueId (internal)

These RuntimeGlobals exist in Rust but were missing in TypeScript.

* chore: update API documentation for RuntimeGlobals

* refactor: render javascript runtime globals according to compiler options

Author: LingyuCoder

crates/rspack_binding_api/src/runtime.rs

@@ -21,88 +21,11 @@ static RUNTIME_GLOBAL_MAP: LazyLock<RuntimeGlobalMap> = LazyLock::new(|| {
   let mut to_js_map = FxHashMap::default();
   let mut from_js_map = FxHashMap::default();
 
-  macro_rules! declare_runtime_global {
-    ($name:ident) => {
-      to_js_map.insert(
-        RuntimeGlobals::$name,
-        stringify!($name).to_lower_camel_case().into(),
-      );
-      from_js_map.insert(stringify!($name), RuntimeGlobals::$name);
-    };
+  for (name, value) in RuntimeGlobals::all().iter_names() {
+    to_js_map.insert(value, name.to_lower_camel_case());
+    from_js_map.insert(name, value);
   }
 
-  declare_runtime_global!(REQUIRE_SCOPE);
-  declare_runtime_global!(MODULE);
-  declare_runtime_global!(MODULE_ID);
-  declare_runtime_global!(REQUIRE);
-  declare_runtime_global!(MODULE_CACHE);
-  declare_runtime_global!(ENSURE_CHUNK);
-  declare_runtime_global!(ENSURE_CHUNK_HANDLERS);
-  declare_runtime_global!(PUBLIC_PATH);
-  declare_runtime_global!(GET_CHUNK_SCRIPT_FILENAME);
-  declare_runtime_global!(GET_CHUNK_CSS_FILENAME);
-  declare_runtime_global!(LOAD_SCRIPT);
-  declare_runtime_global!(HAS_OWN_PROPERTY);
-  declare_runtime_global!(MODULE_FACTORIES_ADD_ONLY);
-  declare_runtime_global!(ON_CHUNKS_LOADED);
-  declare_runtime_global!(CHUNK_CALLBACK);
-  declare_runtime_global!(MODULE_FACTORIES);
-  declare_runtime_global!(INTERCEPT_MODULE_EXECUTION);
-  declare_runtime_global!(HMR_DOWNLOAD_MANIFEST);
-  declare_runtime_global!(HMR_DOWNLOAD_UPDATE_HANDLERS);
-  declare_runtime_global!(GET_UPDATE_MANIFEST_FILENAME);
-  declare_runtime_global!(GET_CHUNK_UPDATE_SCRIPT_FILENAME);
-  declare_runtime_global!(GET_CHUNK_UPDATE_CSS_FILENAME);
-  declare_runtime_global!(HMR_MODULE_DATA);
-  declare_runtime_global!(HMR_RUNTIME_STATE_PREFIX);
-  declare_runtime_global!(EXTERNAL_INSTALL_CHUNK);
-  declare_runtime_global!(GET_FULL_HASH);
-  declare_runtime_global!(GLOBAL);
-  declare_runtime_global!(RETURN_EXPORTS_FROM_RUNTIME);
-  declare_runtime_global!(INSTANTIATE_WASM);
-  declare_runtime_global!(ASYNC_MODULE);
-  declare_runtime_global!(BASE_URI);
-  declare_runtime_global!(MODULE_LOADED);
-  declare_runtime_global!(STARTUP_ENTRYPOINT);
-  declare_runtime_global!(STARTUP_CHUNK_DEPENDENCIES);
-  declare_runtime_global!(CREATE_SCRIPT_URL);
-  declare_runtime_global!(CREATE_SCRIPT);
-  declare_runtime_global!(GET_TRUSTED_TYPES_POLICY);
-  declare_runtime_global!(DEFINE_PROPERTY_GETTERS);
-  declare_runtime_global!(ENTRY_MODULE_ID);
-  declare_runtime_global!(STARTUP_NO_DEFAULT);
-  declare_runtime_global!(ENSURE_CHUNK_INCLUDE_ENTRIES);
-  declare_runtime_global!(STARTUP);
-  declare_runtime_global!(MAKE_NAMESPACE_OBJECT);
-  declare_runtime_global!(EXPORTS);
-  declare_runtime_global!(COMPAT_GET_DEFAULT_EXPORT);
-  declare_runtime_global!(CREATE_FAKE_NAMESPACE_OBJECT);
-  declare_runtime_global!(NODE_MODULE_DECORATOR);
-  declare_runtime_global!(ESM_MODULE_DECORATOR);
-  declare_runtime_global!(SYSTEM_CONTEXT);
-  declare_runtime_global!(THIS_AS_EXPORTS);
-  declare_runtime_global!(CURRENT_REMOTE_GET_SCOPE);
-  declare_runtime_global!(SHARE_SCOPE_MAP);
-  declare_runtime_global!(INITIALIZE_SHARING);
-  declare_runtime_global!(SCRIPT_NONCE);
-  declare_runtime_global!(RELATIVE_URL);
-  declare_runtime_global!(CHUNK_NAME);
-  declare_runtime_global!(RUNTIME_ID);
-  declare_runtime_global!(PREFETCH_CHUNK);
-  declare_runtime_global!(PREFETCH_CHUNK_HANDLERS);
-  declare_runtime_global!(PRELOAD_CHUNK);
-  declare_runtime_global!(PRELOAD_CHUNK_HANDLERS);
-  declare_runtime_global!(UNCAUGHT_ERROR_HANDLER);
-  declare_runtime_global!(RSPACK_VERSION);
-  declare_runtime_global!(HAS_CSS_MODULES);
-  declare_runtime_global!(RSPACK_UNIQUE_ID);
-  declare_runtime_global!(HAS_FETCH_PRIORITY);
-  declare_runtime_global!(AMD_DEFINE);
-  declare_runtime_global!(AMD_OPTIONS);
-  declare_runtime_global!(ASYNC_MODULE_EXPORT_SYMBOL);
-  declare_runtime_global!(MAKE_DEFERRED_NAMESPACE_OBJECT);
-  declare_runtime_global!(MAKE_DEFERRED_NAMESPACE_OBJECT_SYMBOL);
-
   to_js_map.shrink_to_fit();
   from_js_map.shrink_to_fit();
   (to_js_map, from_js_map)

crates/rspack_core/src/compilation/build_module_graph/module_executor/execute.rs

@@ -382,7 +382,9 @@ impl Task<ExecutorTaskContext> for ExecuteTask {
         let identifier = runtime_module.identifier();
         ExecutedRuntimeModule {
           identifier,
-          name: runtime_module.name().to_string(),
+          name: runtime_module
+            .readable_identifier(&compilation.options.context)
+            .into(),
           name_for_condition: runtime_module.name_for_condition().map(|n| n.to_string()),
           module_type: *runtime_module.module_type(),
           cacheable: !(runtime_module.full_hash() || runtime_module.dependent_hash()),

crates/rspack_core/src/stats/mod.rs

@@ -1302,7 +1302,7 @@ impl Stats<'_> {
         == 0;
 
       stats.identifier = Some(module.identifier());
-      stats.name = Some(module.name().as_str().into());
+      stats.name = Some(module.readable_identifier(&self.compilation.options.context));
       stats.name_for_condition = module.name_for_condition().map(|n| n.to_string());
       stats.cacheable = Some(!(module.full_hash() || module.dependent_hash()));
       stats.optional = Some(false);

crates/rspack_plugin_extract_css/src/runtime.rs

@@ -328,7 +328,7 @@ impl RuntimeModule for CssLoadingRuntimeModule {
 
 impl CssLoadingRuntimeModule {
   fn template_id(&self, id: TemplateId) -> String {
-    let base_id = self.name().to_string();
+    let base_id = self.id.to_string();
 
     match id {
       TemplateId::Raw => base_id,

packages/rspack-test-tools/src/helper/hot-update/plugin.ts

@@ -137,6 +137,7 @@ export class HotUpdatePlugin {
 	}
 
 	apply(compiler: Compiler) {
+		const RuntimeGlobals = compiler.rspack.RuntimeGlobals;
 		const options = compiler.options;
 		options.context = this.tempDir;
 		options.module.rules ??= [];
@@ -160,7 +161,7 @@ export class HotUpdatePlugin {
 			compilation.hooks.additionalTreeRuntimeRequirements.tap(
 				PLUGIN_NAME,
 				(_chunk: any, set: any) => {
-					set.add(compiler.webpack.RuntimeGlobals.moduleCache);
+					set.add(compiler.rspack.RuntimeGlobals.moduleCache);
 				}
 			);
 			compilation.hooks.runtimeModule.tap(
@@ -169,9 +170,9 @@ export class HotUpdatePlugin {
 					if (module.constructorName === "DefinePropertyGettersRuntimeModule") {
 						module.source.source = Buffer.from(
 							`
-										__webpack_require__.d = function (exports, definition) {
+										${RuntimeGlobals.definePropertyGetters} = function (exports, definition) {
 												for (var key in definition) {
-														if (__webpack_require__.o(definition, key) && !__webpack_require__.o(exports, key)) {
+														if (${RuntimeGlobals.hasOwnProperty}(definition, key) && !${RuntimeGlobals.hasOwnProperty}(exports, key)) {
 																Object.defineProperty(exports, key, { configurable: true, enumerable: true, get: definition[key] });
 														}
 												}

packages/rspack/etc/core.api.md

@@ -2349,7 +2349,7 @@ interface ExecuteModuleArgument {
 // @public (undocumented)
 interface ExecuteModuleContext {
     // (undocumented)
-    __webpack_require__: (id: string) => any;
+    [key: string]: (id: string) => any;
 }
 
 // @public (undocumented)
@@ -7115,81 +7115,93 @@ const RuntimeChunkPlugin: {
 };
 
 // @public (undocumented)
-export const RuntimeGlobals: {
-    readonly require: "__webpack_require__";
-    readonly requireScope: "__webpack_require__.*";
-    readonly exports: "__webpack_exports__";
-    readonly thisAsExports: "top-level-this-exports";
-    readonly returnExportsFromRuntime: "return-exports-from-runtime";
-    readonly module: "module";
-    readonly moduleId: "module.id";
-    readonly moduleLoaded: "module.loaded";
-    readonly publicPath: "__webpack_require__.p";
-    readonly entryModuleId: "__webpack_require__.s";
-    readonly moduleCache: "__webpack_require__.c";
-    readonly moduleFactories: "__webpack_require__.m";
-    readonly moduleFactoriesAddOnly: "__webpack_require__.m (add only)";
-    readonly ensureChunk: "__webpack_require__.e";
-    readonly ensureChunkHandlers: "__webpack_require__.f";
-    readonly ensureChunkIncludeEntries: "__webpack_require__.f (include entries)";
-    readonly prefetchChunk: "__webpack_require__.E";
-    readonly prefetchChunkHandlers: "__webpack_require__.F";
-    readonly preloadChunk: "__webpack_require__.G";
-    readonly preloadChunkHandlers: "__webpack_require__.H";
-    readonly definePropertyGetters: "__webpack_require__.d";
-    readonly makeNamespaceObject: "__webpack_require__.r";
-    readonly createFakeNamespaceObject: "__webpack_require__.t";
-    readonly compatGetDefaultExport: "__webpack_require__.n";
-    readonly harmonyModuleDecorator: "__webpack_require__.hmd";
-    readonly nodeModuleDecorator: "__webpack_require__.nmd";
-    readonly getFullHash: "__webpack_require__.h";
-    readonly wasmInstances: "__webpack_require__.w";
-    readonly instantiateWasm: "__webpack_require__.v";
-    readonly uncaughtErrorHandler: "__webpack_require__.oe";
-    readonly scriptNonce: "__webpack_require__.nc";
-    readonly loadScript: "__webpack_require__.l";
-    readonly createScript: "__webpack_require__.ts";
-    readonly createScriptUrl: "__webpack_require__.tu";
-    readonly getTrustedTypesPolicy: "__webpack_require__.tt";
-    readonly hasFetchPriority: "has fetch priority";
-    readonly chunkName: "__webpack_require__.cn";
-    readonly runtimeId: "__webpack_require__.j";
-    readonly getChunkScriptFilename: "__webpack_require__.u";
-    readonly getChunkCssFilename: "__webpack_require__.k";
-    readonly hasCssModules: "has css modules";
-    readonly getChunkUpdateScriptFilename: "__webpack_require__.hu";
-    readonly getChunkUpdateCssFilename: "__webpack_require__.hk";
-    readonly startup: "__webpack_require__.x";
-    readonly startupNoDefault: "__webpack_require__.x (no default handler)";
-    readonly startupOnlyAfter: "__webpack_require__.x (only after)";
-    readonly startupOnlyBefore: "__webpack_require__.x (only before)";
-    readonly chunkCallback: "webpackChunk";
-    readonly startupEntrypoint: "__webpack_require__.X";
-    readonly onChunksLoaded: "__webpack_require__.O";
-    readonly externalInstallChunk: "__webpack_require__.C";
-    readonly interceptModuleExecution: "__webpack_require__.i";
-    readonly global: "__webpack_require__.g";
-    readonly shareScopeMap: "__webpack_require__.S";
-    readonly initializeSharing: "__webpack_require__.I";
-    readonly currentRemoteGetScope: "__webpack_require__.R";
-    readonly getUpdateManifestFilename: "__webpack_require__.hmrF";
-    readonly hmrDownloadManifest: "__webpack_require__.hmrM";
-    readonly hmrDownloadUpdateHandlers: "__webpack_require__.hmrC";
-    readonly hmrModuleData: "__webpack_require__.hmrD";
-    readonly hmrInvalidateModuleHandlers: "__webpack_require__.hmrI";
-    readonly hmrRuntimeStatePrefix: "__webpack_require__.hmrS";
-    readonly amdDefine: "__webpack_require__.amdD";
-    readonly amdOptions: "__webpack_require__.amdO";
-    readonly system: "__webpack_require__.System";
-    readonly hasOwnProperty: "__webpack_require__.o";
-    readonly systemContext: "__webpack_require__.y";
-    readonly baseURI: "__webpack_require__.b";
-    readonly relativeUrl: "__webpack_require__.U";
-    readonly asyncModule: "__webpack_require__.a";
-    readonly asyncModuleExportSymbol: "__webpack_require__.aE";
-    readonly makeDeferredNamespaceObject: "__webpack_require__.z";
-    readonly makeDeferredNamespaceObjectSymbol: "__webpack_require__.zS";
-};
+export const RuntimeGlobals: typeof RuntimeGlobals_2;
+
+// @public (undocumented)
+enum RuntimeGlobals_2 {
+    amdDefine = 65,
+    amdOptions = 66,
+    asyncModule = 72,
+    // (undocumented)
+    asyncModuleExportSymbol = 73,
+    baseURI = 70,
+    chunkCallback = 49,
+    chunkName = 36,
+    compatGetDefaultExport = 23,
+    createFakeNamespaceObject = 22,
+    createScript = 32,
+    createScriptUrl = 33,
+    currentRemoteGetScope = 58,
+    definePropertyGetters = 20,
+    ensureChunk = 13,
+    ensureChunkHandlers = 14,
+    ensureChunkIncludeEntries = 15,
+    entryModuleId = 9,
+    exports = 2,
+    externalInstallChunk = 53,
+    getChunkCssFilename = 39,
+    getChunkScriptFilename = 38,
+    getChunkUpdateCssFilename = 44,
+    getChunkUpdateScriptFilename = 43,
+    getFullHash = 26,
+    getTrustedTypesPolicy = 34,
+    getUpdateManifestFilename = 59,
+    global = 55,
+    harmonyModuleDecorator = 24,
+    hasCssModules = 41,
+    hasFetchPriority = 35,
+    hasOwnProperty = 68,
+    hmrDownloadManifest = 60,
+    hmrDownloadUpdateHandlers = 61,
+    hmrInvalidateModuleHandlers = 63,
+    hmrModuleData = 62,
+    hmrRuntimeStatePrefix = 64,
+    initializeSharing = 57,
+    instantiateWasm = 28,
+    interceptModuleExecution = 54,
+    loadScript = 31,
+    // (undocumented)
+    makeDeferredNamespaceObject = 74,
+    // (undocumented)
+    makeDeferredNamespaceObjectSymbol = 75,
+    makeNamespaceObject = 21,
+    module = 5,
+    moduleCache = 10,
+    moduleFactories = 11,
+    moduleFactoriesAddOnly = 12,
+    moduleId = 6,
+    moduleLoaded = 7,
+    nodeModuleDecorator = 25,
+    onChunksLoaded = 52,
+    prefetchChunk = 16,
+    prefetchChunkHandlers = 17,
+    preloadChunk = 18,
+    preloadChunkHandlers = 19,
+    publicPath = 8,
+    relativeUrl = 71,
+    require = 0,
+    requireScope = 1,
+    returnExportsFromRuntime = 4,
+    // @internal
+    rspackUniqueId = 42,
+    // @internal
+    rspackVersion = 40,
+    runtimeId = 37,
+    scriptNonce = 30,
+    shareScopeMap = 56,
+    startup = 45,
+    startupChunkDependencies = 51,
+    startupEntrypoint = 50,
+    // @deprecated (undocumented)
+    startupNoDefault = 46,
+    startupOnlyAfter = 47,
+    startupOnlyBefore = 48,
+    system = 67,
+    systemContext = 69,
+    thisAsExports = 3,
+    uncaughtErrorHandler = 29,
+    wasmInstances = 27
+}
 
 // @public (undocumented)
 export class RuntimeModule {

packages/rspack/src/Compilation.ts

@@ -124,7 +124,7 @@ export interface ExecuteModuleArgument {
 }
 
 export interface ExecuteModuleContext {
-	__webpack_require__: (id: string) => any;
+	[key: string]: (id: string) => any;
 }
 
 export interface KnownNormalizedStatsOptions {

packages/rspack/src/Compiler.ts

@@ -46,6 +46,7 @@ import { Logger } from "./logging/Logger";
 import { NormalModuleFactory } from "./NormalModuleFactory";
 import { ResolverFactory } from "./ResolverFactory";
 import { RuleSetCompiler } from "./RuleSetCompiler";
+import { createCompilerRuntimeGlobals } from "./RuntimeGlobals";
 import { Stats } from "./Stats";
 import {
 	createCompilationHooksRegisters,
@@ -245,8 +246,15 @@ class Compiler {
 			additionalPass: new liteTapable.AsyncSeriesHook([])
 		};
 
-		this.webpack = rspack;
-		this.rspack = rspack;
+		const compilerRuntimeGlobals = createCompilerRuntimeGlobals(options);
+		this.webpack = {
+			...rspack,
+			RuntimeGlobals: compilerRuntimeGlobals
+		} as typeof rspack;
+		this.rspack = {
+			...rspack,
+			RuntimeGlobals: compilerRuntimeGlobals
+		} as typeof rspack;
 		this.root = this;
 		this.outputPath = "";
 

packages/rspack/src/ExecuteModulePlugin.ts

@@ -1,5 +1,5 @@
-import { RuntimeGlobals } from ".";
 import type { Compiler } from "./Compiler";
+import { RuntimeVariable, renderRuntimeVariables } from "./RuntimeGlobals";
 
 export default class ExecuteModulePlugin {
 	apply(compiler: Compiler) {
@@ -19,7 +19,7 @@ export default class ExecuteModulePlugin {
 
 					try {
 						const fn = vm.runInThisContext(
-							`(function(module, __webpack_module__, __webpack_exports__, exports, ${RuntimeGlobals.require}) {\n${code}\n})`,
+							`(function(module, ${renderRuntimeVariables(RuntimeVariable.Module, compiler.options)}, ${renderRuntimeVariables(RuntimeVariable.Exports, compiler.options)}, exports, ${renderRuntimeVariables(RuntimeVariable.Require, compiler.options)}) {\n${code}\n})`,
 							{
 								filename: moduleObject.id
 							}
@@ -31,7 +31,12 @@ export default class ExecuteModulePlugin {
 							moduleObject,
 							moduleObject.exports,
 							moduleObject.exports,
-							context.__webpack_require__
+							context[
+								renderRuntimeVariables(
+									RuntimeVariable.Require,
+									compiler.options
+								)
+							]
 						);
 					} catch (e: any) {
 						const err = e instanceof Error ? e : new Error(e);