rspack_core 0.100.1

rspack core
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
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
use std::sync::{
  Arc, RwLock,
  atomic::{AtomicBool, Ordering},
};

use concatenated_module_entries::*;
pub use determine_export_assignments::DetermineExportAssignmentsKey;
use determine_export_assignments::*;
use get_exports_type::*;
use get_mode::*;
use get_side_effects_connection_state::*;
use module_graph_hash::*;
use rustc_hash::{FxHashMap as HashMap, FxHashSet as HashSet};
use swc_core::atoms::Atom;

use crate::{
  ConcatenationEntry, ConnectionState, DependencyId, ExportInfo, ExportsType, ModuleIdentifier,
  RuntimeKey,
};
pub type ModuleGraphCacheArtifact = Arc<ModuleGraphCacheArtifactInner>;

/// This is a rust port of `ModuleGraph.cached` and `ModuleGraph.dependencyCacheProvide` in webpack.
/// We use this to cache the result of functions with high computational overhead.
#[derive(Debug, Default)]
pub struct ModuleGraphCacheArtifactInner {
  /// Webpack enables module graph caches by creating new cache maps and disable them by setting them to undefined.
  /// But in rust I think it's better to use a bool flag to avoid memory reallocation.
  freezed: AtomicBool,
  get_mode_cache: GetModeCache,
  determine_export_assignments_cache: DetermineExportAssignmentsCache,
  get_exports_type_cache: GetExportsTypeCache,
  get_side_effects_connection_state_cache: GetSideEffectsConnectionStateCache,
  concatenated_module_entries: ConcatenatedModuleEntriesCache,
  module_graph_hash_cache: ModuleGraphHashCache,
}

impl ModuleGraphCacheArtifactInner {
  pub fn freeze(&self) {
    self.get_mode_cache.freeze();
    self.determine_export_assignments_cache.freeze();
    self.get_exports_type_cache.freeze();
    self.get_side_effects_connection_state_cache.freeze();
    self.concatenated_module_entries.freeze();
    self.module_graph_hash_cache.freeze();
    self.freezed.store(true, Ordering::Release);
  }

  pub fn unfreeze(&self) {
    self.freezed.store(false, Ordering::Release);
  }

  pub fn cached_get_exports_type<F: FnOnce() -> ExportsType>(
    &self,
    key: GetExportsTypeCacheKey,
    f: F,
  ) -> ExportsType {
    if !self.freezed.load(Ordering::Acquire) {
      return f();
    }

    match self.get_exports_type_cache.get(&key) {
      Some(value) => value,
      None => {
        let value = f();
        self.get_exports_type_cache.set(key, value);
        value
      }
    }
  }

  pub fn cached_get_mode<F: FnOnce() -> ExportMode>(
    &self,
    key: GetModeCacheKey,
    f: F,
  ) -> ExportMode {
    if !self.freezed.load(Ordering::Acquire) {
      return f();
    }

    match self.get_mode_cache.get(&key) {
      Some(value) => value,
      None => {
        let value = f();
        self.get_mode_cache.set(key, value.clone());
        value
      }
    }
  }

  pub fn cached_determine_export_assignments<F: FnOnce() -> DetermineExportAssignmentsValue>(
    &self,
    key: DetermineExportAssignmentsKey,
    f: F,
  ) -> DetermineExportAssignmentsValue {
    if !self.freezed.load(Ordering::Acquire) {
      return f();
    }

    match self.determine_export_assignments_cache.get(&key) {
      Some(value) => value,
      None => {
        let value = f();
        self
          .determine_export_assignments_cache
          .set(key, value.clone());
        value
      }
    }
  }

  pub fn cached_get_side_effects_connection_state<F: FnOnce() -> ConnectionState>(
    &self,
    key: ModuleIdentifier,
    f: F,
  ) -> ConnectionState {
    if !self.freezed.load(Ordering::Acquire) {
      return f();
    }

    match self.get_side_effects_connection_state_cache.get(&key) {
      Some(value) => value,
      None => {
        let value = f();
        self.get_side_effects_connection_state_cache.set(key, value);
        value
      }
    }
  }

  pub fn cached_concatenated_module_entries<F: FnOnce() -> Vec<ConcatenationEntry>>(
    &self,
    key: ConcatenatedModuleEntriesCacheKey,
    f: F,
  ) -> Vec<ConcatenationEntry> {
    if !self.freezed.load(Ordering::Acquire) {
      return f();
    }

    match self.concatenated_module_entries.get(&key) {
      Some(value) => value,
      None => {
        let value = f();
        self.concatenated_module_entries.set(key, value.clone());
        value
      }
    }
  }

  pub fn cached_module_graph_hash<F: FnOnce() -> u64>(
    &self,
    key: ModuleGraphHashCacheKey,
    f: F,
  ) -> u64 {
    if !self.freezed.load(Ordering::Acquire) {
      return f();
    }

    match self.module_graph_hash_cache.get(&key) {
      Some(value) => value,
      None => {
        let value = f();
        self.module_graph_hash_cache.set(key, value);
        value
      }
    }
  }
}

pub(super) mod module_graph_hash {
  use rspack_util::fx_hash::FxDashMap;

  use crate::{ModuleIdentifier, RuntimeKey};

  pub type ModuleGraphHashCacheKey = (ModuleIdentifier, Option<RuntimeKey>);

  #[derive(Debug, Default)]
  pub struct ModuleGraphHashCache {
    cache: FxDashMap<ModuleGraphHashCacheKey, u64>,
  }

  impl ModuleGraphHashCache {
    pub fn freeze(&self) {
      self.cache.clear();
    }

    pub fn get(&self, key: &ModuleGraphHashCacheKey) -> Option<u64> {
      self.cache.get(key).map(|v| *v.value())
    }

    pub fn set(&self, key: ModuleGraphHashCacheKey, value: u64) {
      self.cache.insert(key, value);
    }
  }
}
pub(super) mod concatenated_module_entries {
  use rspack_util::fx_hash::FxDashMap;

  use super::*;
  use crate::ModuleIdentifier;

  pub type ConcatenatedModuleEntriesCacheKey = (ModuleIdentifier, Option<RuntimeKey>);

  #[derive(Debug, Default)]
  pub struct ConcatenatedModuleEntriesCache {
    cache: FxDashMap<ConcatenatedModuleEntriesCacheKey, Vec<ConcatenationEntry>>,
  }

  impl ConcatenatedModuleEntriesCache {
    pub fn freeze(&self) {
      self.cache.clear();
    }

    pub fn get(&self, key: &ConcatenatedModuleEntriesCacheKey) -> Option<Vec<ConcatenationEntry>> {
      self.cache.get(key).map(|v| v.value().clone())
    }

    pub fn set(&self, key: ConcatenatedModuleEntriesCacheKey, value: Vec<ConcatenationEntry>) {
      self.cache.insert(key, value);
    }
  }
}

pub(super) mod get_side_effects_connection_state {
  use rspack_collections::IdentifierDashMap;

  use crate::{ConnectionState, ModuleIdentifier};

  #[derive(Debug, Default)]
  pub struct GetSideEffectsConnectionStateCache {
    cache: IdentifierDashMap<ConnectionState>,
  }

  impl GetSideEffectsConnectionStateCache {
    pub fn freeze(&self) {
      self.cache.clear();
    }

    pub fn get(&self, key: &ModuleIdentifier) -> Option<ConnectionState> {
      self.cache.get(key).map(|v| *v.value())
    }

    pub fn set(&self, key: ModuleIdentifier, value: ConnectionState) {
      self.cache.insert(key, value);
    }
  }
}

pub(super) mod get_exports_type {
  use rspack_collections::IdentifierDashMap;

  use crate::{ExportsType, ModuleIdentifier};

  pub type GetExportsTypeCacheKey = (ModuleIdentifier, bool);

  #[derive(Debug, Default)]
  pub struct GetExportsTypeCache {
    strict_cache: IdentifierDashMap<ExportsType>,
    dynamic_cache: IdentifierDashMap<ExportsType>,
  }

  impl GetExportsTypeCache {
    pub fn freeze(&self) {
      self.strict_cache.clear();
      self.dynamic_cache.clear();
    }

    pub fn get(&self, key: &GetExportsTypeCacheKey) -> Option<ExportsType> {
      let (module_identifier, strict) = key;
      if *strict {
        self.strict_cache.get(module_identifier).map(|x| *x)
      } else {
        self.dynamic_cache.get(module_identifier).map(|x| *x)
      }
    }

    pub fn set(&self, key: GetExportsTypeCacheKey, value: ExportsType) {
      let (module_identifier, strict) = key;
      if strict {
        self.strict_cache.insert(module_identifier, value);
      } else {
        self.dynamic_cache.insert(module_identifier, value);
      }
    }
  }
}

pub(super) mod get_mode {
  use super::*;

  pub type GetModeCacheKey = (DependencyId, Option<RuntimeKey>);

  #[derive(Debug, Default)]
  pub struct GetModeCache {
    cache: RwLock<HashMap<GetModeCacheKey, ExportMode>>,
  }

  impl GetModeCache {
    pub fn freeze(&self) {
      self.cache.write().expect("should get lock").clear();
    }

    pub fn get(&self, key: &GetModeCacheKey) -> Option<ExportMode> {
      let inner = self.cache.read().expect("should get lock");
      inner.get(key).cloned()
    }

    pub fn set(&self, key: GetModeCacheKey, value: ExportMode) {
      self
        .cache
        .write()
        .expect("should get lock")
        .insert(key, value);
    }
  }
}

pub(super) mod determine_export_assignments {
  use super::*;
  use crate::ModuleIdentifier;

  /// Webpack cache the result of `determineExportAssignments` with the keys of dependencies arraris of `allStarExports.dependencies` and `otherStarExports` + `this`(DependencyId).
  /// See: https://github.com/webpack/webpack/blob/19ca74127f7668aaf60d59f4af8fcaee7924541a/lib/dependencies/HarmonyExportImportedSpecifierDependency.js#L645
  ///
  /// However, we can simplify the cache key since dependencies under the same parent module share `allStarExports` and copy their own `otherStarExports`.
  #[derive(Debug, PartialEq, Eq, Hash)]
  pub enum DetermineExportAssignmentsKey {
    All(ModuleIdentifier),
    Other(DependencyId),
  }
  pub type DetermineExportAssignmentsValue = (Vec<Atom>, Vec<usize>);

  #[derive(Debug, Default)]
  pub struct DetermineExportAssignmentsCache {
    cache: RwLock<HashMap<DetermineExportAssignmentsKey, DetermineExportAssignmentsValue>>,
  }

  impl DetermineExportAssignmentsCache {
    pub fn freeze(&self) {
      self.cache.write().expect("should get lock").clear();
    }

    pub fn get(
      &self,
      key: &DetermineExportAssignmentsKey,
    ) -> Option<DetermineExportAssignmentsValue> {
      let inner = self.cache.read().expect("should get lock");
      inner.get(key).cloned()
    }

    pub fn set(&self, key: DetermineExportAssignmentsKey, value: DetermineExportAssignmentsValue) {
      self
        .cache
        .write()
        .expect("should get lock")
        .insert(key, value);
    }
  }
}

#[derive(Debug, Clone)]
pub struct NormalReexportItem {
  pub name: Atom,
  pub ids: Vec<Atom>,
  pub hidden: bool,
  pub checked: bool,
  pub export_info: ExportInfo,
}

#[derive(Debug, Clone)]
pub enum ExportMode {
  Missing,
  LazyMake,
  Unused(ExportModeUnused),
  EmptyStar(ExportModeEmptyStar),
  ReexportDynamicDefault(ExportModeReexportDynamicDefault),
  ReexportNamedDefault(ExportModeReexportNamedDefault),
  ReexportNamespaceObject(ExportModeReexportNamespaceObject),
  ReexportFakeNamespaceObject(ExportModeFakeNamespaceObject),
  ReexportUndefined(ExportModeReexportUndefined),
  NormalReexport(ExportModeNormalReexport),
  DynamicReexport(Box<ExportModeDynamicReexport>),
}

#[derive(Debug, Clone)]
pub struct ExportModeUnused {
  pub name: Atom,
}

#[derive(Debug, Clone)]
pub struct ExportModeEmptyStar {
  pub hidden: Option<HashSet<Atom>>,
}

#[derive(Debug, Clone)]
pub struct ExportModeReexportDynamicDefault {
  pub name: Atom,
}

#[derive(Debug, Clone)]
pub struct ExportModeReexportNamedDefault {
  pub name: Atom,
  pub partial_namespace_export_info: ExportInfo,
}

#[derive(Debug, Clone)]
pub struct ExportModeReexportNamespaceObject {
  pub name: Atom,
  pub partial_namespace_export_info: ExportInfo,
}

#[derive(Debug, Clone)]
pub struct ExportModeFakeNamespaceObject {
  pub name: Atom,
  pub fake_type: u8,
  pub partial_namespace_export_info: ExportInfo,
}

#[derive(Debug, Clone)]
pub struct ExportModeReexportUndefined {
  pub name: Atom,
}

#[derive(Debug, Clone)]
pub struct ExportModeNormalReexport {
  pub items: Vec<NormalReexportItem>,
}

#[derive(Debug, Clone)]
pub struct ExportModeDynamicReexport {
  pub ignored: HashSet<Atom>,
  pub hidden: Option<HashSet<Atom>>,
}

#[derive(Debug, Default)]
pub struct StarReexportsInfo {
  pub exports: Option<HashSet<Atom>>,
  pub checked: Option<HashSet<Atom>>,
  pub ignored_exports: HashSet<Atom>,
  pub hidden: Option<HashSet<Atom>>,
}