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
use std::{
  fmt,
  path::{Path, PathBuf},
  sync::Arc,
};

use rspack_error::{Error, Severity, cyan, yellow};
use rspack_fs::ReadableFileSystem;
use rspack_loader_runner::DescriptionData;
use rspack_paths::{ArcPathSet, AssertUtf8};
use rspack_util::location::byte_line_column_to_offset;

use super::{ResolveResult, Resource, boxfs::BoxFS};
use crate::{
  Alias, AliasMap, DependencyCategory, Resolve, ResolveArgs, ResolveOptionsWithDependencyType,
};

#[derive(Debug, Default, Clone)]
pub struct ResolveContext {
  /// Files that was found on file system
  pub file_dependencies: ArcPathSet,
  /// Dependencies that was not found on file system
  pub missing_dependencies: ArcPathSet,
}

/// Proxy to [nodejs_resolver::Error] or [rspack_resolver::ResolveError]
#[derive(Debug)]
pub enum ResolveInnerError {
  RspackResolver(rspack_resolver::ResolveError),
}

impl fmt::Display for ResolveInnerError {
  fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
    match self {
      Self::RspackResolver(error) => write!(f, "{error:?}"),
    }
  }
}

/// Proxy to [rspack_resolver::ResolveOptions]
pub enum ResolveInnerOptions<'a> {
  RspackResolver(&'a rspack_resolver::ResolveOptions),
}

impl fmt::Debug for ResolveInnerOptions<'_> {
  fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
    match self {
      Self::RspackResolver(options) => {
        write!(f, "{options:?}")
      }
    }
  }
}

impl ResolveInnerOptions<'_> {
  pub fn is_enforce_extension_enabled(&self) -> bool {
    match self {
      Self::RspackResolver(options) => matches!(
        options.enforce_extension,
        rspack_resolver::EnforceExtension::Enabled
      ),
    }
  }

  pub fn extensions(&self) -> impl Iterator<Item = &String> {
    match self {
      Self::RspackResolver(options) => options.extensions.iter(),
    }
  }

  pub fn main_files(&self) -> impl Iterator<Item = &String> {
    match self {
      Self::RspackResolver(options) => options.main_files.iter(),
    }
  }

  pub fn modules(&self) -> impl Iterator<Item = &String> {
    match self {
      Self::RspackResolver(options) => options.modules.iter(),
    }
  }
}

/// Proxy to [rspack_resolver::Resolver]
///
/// Internal caches are shared.
#[derive(Debug)]
pub struct Resolver {
  inner_fs: Arc<dyn ReadableFileSystem>,
  resolver: rspack_resolver::ResolverGeneric<BoxFS>,
}

impl Resolver {
  pub fn new(options: Resolve, fs: Arc<dyn ReadableFileSystem>) -> Self {
    Self::new_rspack_resolver(options, fs)
  }

  fn new_rspack_resolver(options: Resolve, fs: Arc<dyn ReadableFileSystem>) -> Self {
    let options = to_rspack_resolver_options(options, false, DependencyCategory::Unknown);
    let boxfs = BoxFS::new(fs.clone());
    let resolver = rspack_resolver::ResolverGeneric::new_with_file_system(boxfs, options);
    Self {
      inner_fs: fs,
      resolver,
    }
  }

  /// Clear cache for all resolver instances
  pub fn clear_cache(&self) {
    self.resolver.clear_cache();
  }

  /// Create a new resolver by cloning its internal cache.
  pub fn clone_with_options(
    &self,
    options: Resolve,
    options_with_dependency_type: &ResolveOptionsWithDependencyType,
  ) -> Self {
    let resolver = &self.resolver;
    let options = to_rspack_resolver_options(
      options,
      options_with_dependency_type.resolve_to_context,
      options_with_dependency_type.dependency_category,
    );

    let resolver = resolver.clone_with_options(options);
    Self {
      inner_fs: self.inner_fs.clone(),
      resolver,
    }
  }

  /// Return the options from the resolver
  pub fn options(&self) -> ResolveInnerOptions<'_> {
    ResolveInnerOptions::RspackResolver(self.resolver.options())
  }

  /// Resolve a specifier to a given path.
  pub async fn resolve(
    &self,
    path: &Path,
    request: &str,
  ) -> Result<ResolveResult, ResolveInnerError> {
    match self.resolver.resolve(path, request).await {
      Ok(r) => Ok(ResolveResult::Resource(Resource {
        path: r.path().to_path_buf().assert_utf8(),
        query: r.query().unwrap_or_default().to_string(),
        fragment: r.fragment().unwrap_or_default().to_string(),
        description_data: r
          .package_json()
          .map(|d| DescriptionData::new(d.directory().to_path_buf(), Arc::clone(d.raw_json()))),
      })),
      Err(rspack_resolver::ResolveError::Ignored(_)) => Ok(ResolveResult::Ignored),
      Err(error) => Err(ResolveInnerError::RspackResolver(error)),
    }
  }

  /// Resolve a specifier to a given path.
  pub async fn resolve_with_context(
    &self,
    path: &Path,
    request: &str,
    resolve_context: &mut ResolveContext,
  ) -> Result<ResolveResult, ResolveInnerError> {
    let resolver = &self.resolver;
    let mut context = Default::default();
    let result = resolver
      .resolve_with_context(path, request, &mut context)
      .await;
    resolve_context
      .file_dependencies
      .extend(context.file_dependencies.into_iter().map(Into::into));
    resolve_context
      .missing_dependencies
      .extend(context.missing_dependencies.into_iter().map(Into::into));
    match result {
      Ok(r) => Ok(ResolveResult::Resource(Resource {
        path: r.path().to_path_buf().assert_utf8(),
        query: r.query().unwrap_or_default().to_string(),
        fragment: r.fragment().unwrap_or_default().to_string(),
        description_data: r
          .package_json()
          .map(|d| DescriptionData::new(d.directory().to_path_buf(), Arc::clone(d.raw_json()))),
      })),
      Err(rspack_resolver::ResolveError::Ignored(_)) => Ok(ResolveResult::Ignored),
      Err(error) => Err(ResolveInnerError::RspackResolver(error)),
    }
  }

  pub fn inner_fs(&self) -> Arc<dyn ReadableFileSystem> {
    self.inner_fs.clone()
  }
}

impl ResolveInnerError {
  pub fn into_resolve_error(self, args: &ResolveArgs<'_>) -> Error {
    match self {
      Self::RspackResolver(error) => map_rspack_resolver_error(error, args),
    }
  }
}

fn to_rspack_resolver_options(
  options: Resolve,
  resolve_to_context: bool,
  dependency_type: DependencyCategory,
) -> rspack_resolver::ResolveOptions {
  let options = options.merge_by_dependency(dependency_type);
  let tsconfig = options.tsconfig.map(|c| c.into());
  let enforce_extension =
    options
      .enforce_extension
      .map_or(rspack_resolver::EnforceExtension::Auto, |e| match e {
        true => rspack_resolver::EnforceExtension::Enabled,
        false => rspack_resolver::EnforceExtension::Disabled,
      });
  let description_files = options
    .description_files
    .unwrap_or_else(|| vec!["package.json".to_string()]);
  let imports_fields = options
    .imports_fields
    .unwrap_or_else(|| vec![vec!["imports".to_string()]]);
  let extensions = options
    .extensions
    .unwrap_or_else(|| vec![".js".to_string(), ".json".to_string(), ".wasm".to_string()]);
  let alias = match options.alias.unwrap_or_default() {
    Alias::OverwriteToNoAlias => vec![],
    Alias::MergeAlias(alias) => alias
      .into_iter()
      .map(|(key, value)| {
        let value = value
          .into_iter()
          .map(|x| match x {
            AliasMap::Path(target) => rspack_resolver::AliasValue::Path(target),
            AliasMap::Ignore => rspack_resolver::AliasValue::Ignore,
          })
          .collect();
        (key, value)
      })
      .collect(),
  };
  let prefer_relative = options.prefer_relative.unwrap_or(false);
  let prefer_absolute = options.prefer_absolute.unwrap_or(false);
  let symlinks = options.symlinks.unwrap_or(true);
  let main_files = options
    .main_files
    .unwrap_or_else(|| vec![String::from("index")]);
  let main_fields = options
    .main_fields
    .unwrap_or_else(|| vec![String::from("module"), String::from("main")]);
  let condition_names = options
    .condition_names
    .unwrap_or_else(|| vec!["module".to_string(), "import".to_string()]);
  let modules = options
    .modules
    .unwrap_or_else(|| vec!["node_modules".to_string()]);
  let fallback = match options.fallback.unwrap_or_default() {
    Alias::OverwriteToNoAlias => vec![],
    Alias::MergeAlias(items) => items
      .into_iter()
      .map(|(key, value)| {
        let value = value
          .into_iter()
          .map(|x| match x {
            AliasMap::Path(target) => rspack_resolver::AliasValue::Path(target),
            AliasMap::Ignore => rspack_resolver::AliasValue::Ignore,
          })
          .collect();
        (key, value)
      })
      .collect(),
  };
  let fully_specified = options.fully_specified.unwrap_or_default();
  let exports_fields = options
    .exports_fields
    .unwrap_or_else(|| vec![vec!["exports".to_string()]]);
  let extension_alias = options.extension_alias.unwrap_or_default();
  let alias_fields = options
    .alias_fields
    .unwrap_or_else(|| vec![vec![String::from("browser")]]);
  let restrictions = options
    .restrictions
    .unwrap_or_default()
    .into_iter()
    .map(|s| match s {
      crate::Restriction::Path(s) => rspack_resolver::Restriction::Path(s.into()),
      crate::Restriction::Regex(r) => {
        rspack_resolver::Restriction::Fn(Arc::new(move |path| match path.to_str() {
          Some(path) => r.test(path),
          None => false,
        }))
      }
    })
    .collect();
  let roots = options
    .roots
    .unwrap_or_default()
    .into_iter()
    .map(PathBuf::from)
    .collect();
  rspack_resolver::ResolveOptions {
    fallback,
    modules,
    extensions,
    enforce_extension,
    alias,
    prefer_relative,
    prefer_absolute,
    symlinks,
    alias_fields,
    description_files,
    main_files,
    main_fields,
    condition_names,
    tsconfig,
    resolve_to_context,
    fully_specified,
    exports_fields,
    extension_alias,
    restrictions,
    roots,
    builtin_modules: options.builtin_modules,
    imports_fields,
    enable_pnp: options.pnp.unwrap_or(false),
    node_path: false,
  }
}

fn map_rspack_resolver_error(
  error: rspack_resolver::ResolveError,
  args: &ResolveArgs<'_>,
) -> Error {
  match error {
    rspack_resolver::ResolveError::IOError(error) => rspack_error::error!(error.to_string()),
    rspack_resolver::ResolveError::Recursion => map_resolver_error(true, args),
    rspack_resolver::ResolveError::NotFound(_) => map_resolver_error(false, args),
    rspack_resolver::ResolveError::JSON(error) => {
      if let Some(content) = &error.content {
        let Some(offset) = byte_line_column_to_offset(content, error.line, error.column) else {
          return rspack_error::error!(format!(
            "JSON parse error: {:?} in '{}'",
            error,
            error.path.display()
          ));
        };

        fn ceil_char_boundary(content: &str, mut index: usize) -> usize {
          if index > content.len() {
            return content.len();
          }

          while !content.is_char_boundary(index) {
            if index == 0 {
              return 0;
            }
            index = index.saturating_sub(1);
          }

          index
        }

        let offset = ceil_char_boundary(content, offset);

        if content[offset..].starts_with('\u{feff}') {
          return Error::from_string(
            Some(content.clone()),
            offset,
            offset,
            "JSON parse error".to_string(),
            format!("BOM character found in '{}'", error.path.display()),
          );
        }

        Error::from_string(
          Some(content.clone()),
          offset,
          offset,
          "JSON parse error".to_string(),
          format!("{} in '{}'", error.message, error.path.display()),
        )
      } else {
        rspack_error::error!(format!(
          "JSON parse error: {:?} in '{}'",
          error,
          error.path.display()
        ))
      }
    }
    _ => Error::error(error.to_string()),
  }
}

fn map_resolver_error(is_recursion: bool, args: &ResolveArgs<'_>) -> Error {
  let request = &args.specifier;
  let context = &args.context;

  let importer = args.importer;
  if importer.is_none() {
    return rspack_error::error!(format!(
      "Module not found: Can't resolve {} in {}",
      yellow(&format!("'{request}'")),
      cyan(&format!("'{context}'")),
    ));
  }

  let message = format!(
    "Can't resolve {} in {}",
    yellow(&format!("'{request}'")),
    cyan(&format!("'{context}'"))
  );
  let mut error = Error::from_string(
    None,
    args
      .span
      .as_ref()
      .map(|span| span.start as usize)
      .unwrap_or_default(),
    args
      .span
      .as_ref()
      .map(|span| span.end as usize)
      .unwrap_or_default(),
    "Module not found".to_string(),
    message,
  );
  error.help = if is_recursion {
    Some("maybe it had cyclic aliases".into())
  } else {
    None
  };
  // See: https://github.com/webpack/webpack/blob/6be4065ade1e252c1d8dcba4af0f43e32af1bdc1/lib/Compilation.js#L1796
  error.severity = if args.optional {
    Severity::Warning
  } else {
    Severity::Error
  };
  error
}