rspack_plugin_runtime 0.100.1

rspack runtime plugin
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
use std::hash::Hash;

use rspack_core::{
  ChunkGraph, ChunkKind, ChunkUkey, Compilation, CompilationAdditionalChunkRuntimeRequirements,
  CompilationDependentFullHash, CompilationParams, CompilerCompilation, ModuleIdentifier, Plugin,
  RuntimeCodeTemplate, RuntimeGlobals, RuntimeModule, RuntimeVariable, SourceType,
  rspack_sources::{ConcatSource, RawStringSource, Source, SourceExt},
};
use rspack_error::Result;
use rspack_hash::RspackHash;
use rspack_hook::{plugin, plugin_hook};
use rspack_plugin_javascript::{
  JavascriptModulesChunkHash, JavascriptModulesRenderChunk, JavascriptModulesRenderStartup,
  JsPlugin, RenderSource, impl_plugin_for_js_plugin::chunk_has_js,
  runtime::render_chunk_runtime_modules,
};
use rspack_util::itoa;
use rustc_hash::FxHashSet as HashSet;

use super::update_hash_for_entry_startup;
use crate::{
  get_all_chunks, get_chunk_output_name, get_relative_path, get_runtime_chunk_output_name,
  runtime_chunk_has_hash,
};

const PLUGIN_NAME: &str = "rspack.ModuleChunkFormatPlugin";

#[plugin]
#[derive(Debug, Default)]
pub struct ModuleChunkFormatPlugin;

#[plugin_hook(CompilerCompilation for ModuleChunkFormatPlugin)]
async fn compilation(
  &self,
  compilation: &mut Compilation,
  _params: &mut CompilationParams,
) -> Result<()> {
  let hooks = JsPlugin::get_compilation_hooks_mut(compilation.id());
  let mut hooks = hooks.write().await;
  hooks.render_chunk.tap(render_chunk::new(self));
  hooks.render_startup.tap(render_startup::new(self));
  hooks.chunk_hash.tap(js_chunk_hash::new(self));
  Ok(())
}

#[plugin_hook(CompilationAdditionalChunkRuntimeRequirements for ModuleChunkFormatPlugin)]
async fn additional_chunk_runtime_requirements(
  &self,
  compilation: &Compilation,
  chunk_ukey: &ChunkUkey,
  runtime_requirements: &mut RuntimeGlobals,
  _runtime_modules: &mut Vec<Box<dyn RuntimeModule>>,
) -> Result<()> {
  let chunk = compilation
    .build_chunk_graph_artifact
    .chunk_by_ukey
    .expect_get(chunk_ukey);

  if chunk.has_runtime(&compilation.build_chunk_graph_artifact.chunk_group_by_ukey) {
    return Ok(());
  }

  if compilation
    .build_chunk_graph_artifact
    .chunk_graph
    .get_number_of_entry_modules(chunk_ukey)
    > 0
  {
    runtime_requirements.insert(RuntimeGlobals::EXTERNAL_INSTALL_CHUNK);
  }

  Ok(())
}

#[plugin_hook(JavascriptModulesChunkHash for ModuleChunkFormatPlugin)]
async fn js_chunk_hash(
  &self,
  compilation: &Compilation,
  chunk_ukey: &ChunkUkey,
  hasher: &mut RspackHash,
) -> Result<()> {
  let chunk = compilation
    .build_chunk_graph_artifact
    .chunk_by_ukey
    .expect_get(chunk_ukey);
  if chunk.has_runtime(&compilation.build_chunk_graph_artifact.chunk_group_by_ukey) {
    return Ok(());
  }

  PLUGIN_NAME.hash(hasher);

  update_hash_for_entry_startup(
    hasher,
    compilation,
    compilation
      .build_chunk_graph_artifact
      .chunk_graph
      .get_chunk_entry_modules_with_chunk_group_iterable(chunk_ukey),
    chunk_ukey,
  );

  Ok(())
}

#[plugin_hook(CompilationDependentFullHash for ModuleChunkFormatPlugin)]
fn compilation_dependent_full_hash(
  &self,
  compilation: &Compilation,
  chunk_ukey: &ChunkUkey,
  dependent_full_hash: &mut bool,
) -> Result<()> {
  if !chunk_has_js(chunk_ukey, compilation) {
    return Ok(());
  }

  let chunk = compilation
    .build_chunk_graph_artifact
    .chunk_by_ukey
    .expect_get(chunk_ukey);

  if !chunk.has_entry_module(&compilation.build_chunk_graph_artifact.chunk_graph) {
    return Ok(());
  }

  if runtime_chunk_has_hash(compilation, chunk_ukey)? {
    *dependent_full_hash = true;
  }

  Ok(())
}

#[plugin_hook(JavascriptModulesRenderChunk for ModuleChunkFormatPlugin)]
async fn render_chunk(
  &self,
  compilation: &Compilation,
  chunk_ukey: &ChunkUkey,
  render_source: &mut RenderSource,
  runtime_template: &RuntimeCodeTemplate<'_>,
) -> Result<()> {
  let hooks = JsPlugin::get_compilation_hooks(compilation.id());
  let chunk = compilation
    .build_chunk_graph_artifact
    .chunk_by_ukey
    .expect_get(chunk_ukey);
  let base_chunk_output_name = get_chunk_output_name(chunk, compilation).await?;

  let chunk_id_expr = rspack_util::json_stringify(chunk.expect_id());

  let mut sources = ConcatSource::default();
  sources.add(RawStringSource::from(format!(
    "export const __rspack_esm_id = {chunk_id_expr};\n",
  )));
  sources.add(RawStringSource::from(format!(
    "export const __rspack_esm_ids = [{chunk_id_expr}];\n",
  )));
  sources.add(RawStringSource::from(format!(
    "export const {} = ",
    runtime_template.render_runtime_variable(&RuntimeVariable::Modules),
  )));
  sources.add(render_source.source.clone());
  sources.add(RawStringSource::from_static(";\n"));

  if compilation
    .build_chunk_graph_artifact
    .chunk_graph
    .has_chunk_runtime_modules(chunk_ukey)
  {
    sources.add(RawStringSource::from_static(
      "export const __rspack_esm_runtime = ",
    ));
    sources.add(render_chunk_runtime_modules(compilation, chunk_ukey, runtime_template).await?);
    sources.add(RawStringSource::from_static(";\n"));
  }

  if matches!(chunk.kind(), ChunkKind::HotUpdate) {
    render_source.source = sources.boxed();
    return Ok(());
  }

  if chunk.has_entry_module(&compilation.build_chunk_graph_artifact.chunk_graph) {
    let runtime_chunk_output_name = get_runtime_chunk_output_name(compilation, chunk_ukey).await?;
    sources.add(RawStringSource::from(format!(
      "import {{ {} }} from '{}';\n",
      runtime_template.render_runtime_globals(&RuntimeGlobals::REQUIRE),
      get_relative_path(
        base_chunk_output_name
          .trim_start_matches("/")
          .trim_start_matches("\\"),
        &runtime_chunk_output_name
      )
    )));

    let entries = compilation
      .build_chunk_graph_artifact
      .chunk_graph
      .get_chunk_entry_modules_with_chunk_group_iterable(chunk_ukey);

    let mut startup_source = vec![];
    let runtime_requirements = ChunkGraph::get_tree_runtime_requirements(compilation, chunk_ukey);
    let use_startup_entrypoint = runtime_requirements.contains(RuntimeGlobals::STARTUP_ENTRYPOINT);
    let mut entry_module_ids = Vec::new();

    startup_source.push(format!(
      "var {} = function(moduleId) {{ return {}({} = moduleId); }}",
      runtime_template.render_runtime_variable(&RuntimeVariable::StartupExec),
      runtime_template.render_runtime_globals(&RuntimeGlobals::REQUIRE),
      runtime_template.render_runtime_globals(&RuntimeGlobals::ENTRY_MODULE_ID)
    ));

    let module_graph = compilation.get_module_graph();
    let mut loaded_chunks = HashSet::default();
    for (i, (module, entry)) in entries.iter().enumerate() {
      if !module_graph
        .module_by_identifier(module)
        .is_some_and(|module| {
          module
            .source_types(module_graph)
            .contains(&SourceType::JavaScript)
        })
      {
        continue;
      }
      let module_id = ChunkGraph::get_module_id(&compilation.module_ids_artifact, *module)
        .expect("should have module id");
      let runtime_chunk = compilation
        .build_chunk_graph_artifact
        .chunk_group_by_ukey
        .expect_get(entry)
        .get_runtime_chunk(&compilation.build_chunk_graph_artifact.chunk_group_by_ukey);
      let chunks = get_all_chunks(
        entry,
        &runtime_chunk,
        None,
        &compilation.build_chunk_graph_artifact.chunk_group_by_ukey,
      );

      for chunk_ukey in chunks.iter() {
        // Skip processing if the chunk doesn't have any JavaScript
        if !chunk_has_js(chunk_ukey, compilation) {
          continue;
        }
        if loaded_chunks.contains(chunk_ukey) {
          continue;
        }
        loaded_chunks.insert(*chunk_ukey);
        let index = loaded_chunks.len();
        let chunk = compilation
          .build_chunk_graph_artifact
          .chunk_by_ukey
          .expect_get(chunk_ukey);
        let other_chunk_output_name = get_chunk_output_name(chunk, compilation).await?;
        let mut index_buffer = itoa::Buffer::new();
        let index_str = index_buffer.format(index);
        startup_source.push(format!(
          "import * as __rspack_chunk_{} from '{}';",
          index_str,
          get_relative_path(&base_chunk_output_name, &other_chunk_output_name)
        ));
        let mut index_buffer2 = itoa::Buffer::new();
        let index_str2 = index_buffer2.format(index);
        startup_source.push(format!(
          "{}(__rspack_chunk_{});",
          runtime_template.render_runtime_globals(&RuntimeGlobals::EXTERNAL_INSTALL_CHUNK),
          index_str2
        ));
      }

      let module_id_expr = rspack_util::json_stringify(module_id);

      if use_startup_entrypoint {
        entry_module_ids.push(module_id_expr);
      } else {
        startup_source.push(format!(
          "{}{}({module_id_expr});",
          if i + 1 == entries.len() {
            format!(
              "var {} = ",
              runtime_template.render_runtime_variable(&RuntimeVariable::Exports)
            )
          } else {
            String::new()
          },
          runtime_template.render_runtime_variable(&RuntimeVariable::StartupExec),
        ));
      }
    }

    if use_startup_entrypoint && !entry_module_ids.is_empty() {
      let startup_exec = runtime_template.render_runtime_variable(&RuntimeVariable::StartupExec);
      let module_ids_code = entry_module_ids
        .iter()
        .map(|module_id_expr| format!("{startup_exec}({module_id_expr})"))
        .collect::<Vec<_>>()
        .join(", ");
      startup_source.push(format!(
        "var {} = {}(0, [], function() {{\n        return {};\n      }});",
        runtime_template.render_runtime_variable(&RuntimeVariable::Exports),
        runtime_template.render_runtime_globals(&RuntimeGlobals::STARTUP_ENTRYPOINT),
        module_ids_code
      ));
    }

    let last_entry_module = entries
      .keys()
      .next_back()
      .expect("should have last entry module");
    let mut render_source = RenderSource {
      source: RawStringSource::from(startup_source.join("\n")).boxed(),
    };
    hooks
      .try_read()
      .expect("should have js plugin drive")
      .render_startup
      .call(
        compilation,
        chunk_ukey,
        last_entry_module,
        &mut render_source,
        runtime_template,
      )
      .await?;
    sources.add(render_source.source);
  }
  render_source.source = sources.boxed();
  Ok(())
}

fn render_chunk_import(named_import: &str, import_source: &str) -> String {
  format!("import * as {named_import} from '{import_source}';\n")
}
#[plugin_hook(JavascriptModulesRenderStartup for ModuleChunkFormatPlugin)]
async fn render_startup(
  &self,
  compilation: &Compilation,
  chunk_ukey: &ChunkUkey,
  _module: &ModuleIdentifier,
  render_source: &mut RenderSource,
  runtime_template: &RuntimeCodeTemplate<'_>,
) -> Result<()> {
  let chunk = compilation
    .build_chunk_graph_artifact
    .chunk_by_ukey
    .expect_get(chunk_ukey);
  let entries_count = compilation
    .build_chunk_graph_artifact
    .chunk_graph
    .get_number_of_entry_modules(chunk_ukey);
  let has_runtime = chunk.has_runtime(&compilation.build_chunk_graph_artifact.chunk_group_by_ukey);

  if entries_count > 0 && has_runtime {
    let dependent_chunks = compilation
      .build_chunk_graph_artifact
      .chunk_graph
      .get_chunk_entry_dependent_chunks_iterable(
        chunk_ukey,
        &compilation.build_chunk_graph_artifact.chunk_by_ukey,
        &compilation.build_chunk_graph_artifact.chunk_group_by_ukey,
      );

    let base_chunk_output_name = get_chunk_output_name(chunk, compilation).await?;

    let mut dependent_load = ConcatSource::default();
    for (index, ck) in dependent_chunks.enumerate() {
      if !chunk_has_js(&ck, compilation) {
        continue;
      }

      let dependant_chunk = compilation
        .build_chunk_graph_artifact
        .chunk_by_ukey
        .expect_get(&ck);

      let named_import = format!("__rspack_imports_{index}");

      let dependant_chunk_name = get_chunk_output_name(dependant_chunk, compilation).await?;

      let imported = get_relative_path(&base_chunk_output_name, &dependant_chunk_name);

      dependent_load.add(RawStringSource::from(render_chunk_import(
        &named_import,
        &imported,
      )));
      dependent_load.add(RawStringSource::from(format!(
        "{}({});\n",
        runtime_template.render_runtime_globals(&RuntimeGlobals::EXTERNAL_INSTALL_CHUNK),
        named_import
      )));
    }

    if !dependent_load.source().is_empty() {
      let mut sources = ConcatSource::default();
      sources.add(dependent_load);
      sources.add(render_source.source.clone());
      render_source.source = sources.boxed();
    }
  }
  Ok(())
}

impl Plugin for ModuleChunkFormatPlugin {
  fn name(&self) -> &'static str {
    PLUGIN_NAME
  }

  fn apply(&self, ctx: &mut rspack_core::ApplyContext<'_>) -> Result<()> {
    ctx.compiler_hooks.compilation.tap(compilation::new(self));
    ctx
      .compilation_hooks
      .additional_chunk_runtime_requirements
      .tap(additional_chunk_runtime_requirements::new(self));
    ctx
      .compilation_hooks
      .dependent_full_hash
      .tap(compilation_dependent_full_hash::new(self));
    Ok(())
  }
}