Add rust docs for resolver crate (#10002)

Author: devongovett

Cargo.lock

@@ -2,9 +2,7 @@
 resolver = "2"
 members = [
   "crates/*",
-  "packages/transformers/js/core",
-  "packages/utils/node-resolver-rs",
-  "packages/utils/dev-dep-resolver"
+  "packages/transformers/js/core"
 ]
 
 [profile.canary]

Cargo.toml

@@ -5,7 +5,7 @@ version = "0.1.0"
 edition = "2021"
 
 [dependencies]
-parcel-resolver = { path = "../node-resolver-rs" }
+parcel-resolver = { path = "../parcel-resolver" }
 es-module-lexer = { git = "https://github.com/devongovett/es-module-lexer" }
 serde_json = "1.0.91"
 rayon = "1.7.0"

packages/utils/dev-dep-resolver/Cargo.toml renamed to crates/dev-dep-resolver/Cargo.toml

@@ -6,8 +6,8 @@ use std::{
 use dashmap::{DashMap, DashSet};
 use es_module_lexer::{lex, ImportKind};
 use parcel_resolver::{
-  CacheCow, Invalidations, ModuleType, Resolution, ResolveOptions, Resolver, ResolverError,
-  Specifier, SpecifierError, SpecifierType,
+  Invalidations, ModuleType, Resolution, ResolutionAndQuery, ResolveOptions, Resolver,
+  ResolverError, Specifier, SpecifierError, SpecifierType,
 };
 // use rayon::prelude::{ParallelBridge, ParallelIterator};
 
@@ -103,7 +103,7 @@ impl<'a> EsmGraphBuilder<'a> {
       ModuleType::CommonJs | ModuleType::Json => &self.cjs_resolver,
       ModuleType::Module => &self.esm_resolver,
     };
-    let contents = resolver.cache.fs.read_to_string(file)?;
+    let contents = resolver.cache().fs.read_to_string(file)?;
     let module = lex(&contents)?;
     #[allow(clippy::map_collect_result_unit)]
     module
@@ -126,7 +126,10 @@ impl<'a> EsmGraphBuilder<'a> {
               return Ok(());
             }
 
-            if let Ok((Resolution::Path(p), _)) = resolver.resolve_with_invalidations(
+            if let Ok(ResolutionAndQuery {
+              resolution: Resolution::Path(p),
+              ..
+            }) = resolver.resolve_with_invalidations(
               &import.specifier(),
               file,
               SpecifierType::Esm,
@@ -140,7 +143,7 @@ impl<'a> EsmGraphBuilder<'a> {
               //   file,
               //   p
               // );
-              invalidations.invalidate_on_file_change(resolver.cache.get(&p));
+              invalidations.invalidate_on_file_change(resolver.cache().get(&p));
               self.build(&p)?;
             } else {
               // Ignore dependencies that don't resolve to anything.
@@ -184,7 +187,10 @@ impl<'a> EsmGraphBuilder<'a> {
           invalidations,
           ResolveOptions::default(),
         ) {
-          Ok((Resolution::Path(p), _)) => Cow::Owned(p.parent().unwrap().join(subpath.as_ref())),
+          Ok(ResolutionAndQuery {
+            resolution: Resolution::Path(p),
+            ..
+          }) => Cow::Owned(p.parent().unwrap().join(subpath.as_ref())),
           _ => return Ok(()),
         }
       }
@@ -202,7 +208,7 @@ impl<'a> EsmGraphBuilder<'a> {
 
     for path in glob::glob(pattern.to_string_lossy().as_ref())? {
       let path = path?;
-      invalidations.invalidate_on_file_change(resolver.cache.get(&path));
+      invalidations.invalidate_on_file_change(resolver.cache().get(&path));
       self.build(&path)?;
     }
 
@@ -490,14 +496,8 @@ pub fn build_esm_graph(
     visited: DashSet::new(),
     visited_globs: DashSet::new(),
     invalidations: Invalidations::default(),
-    cjs_resolver: Resolver::node(
-      Cow::Borrowed(project_root),
-      CacheCow::Borrowed(resolver_cache),
-    ),
-    esm_resolver: Resolver::node_esm(
-      Cow::Borrowed(project_root),
-      CacheCow::Borrowed(resolver_cache),
-    ),
+    cjs_resolver: Resolver::node(project_root, resolver_cache),
+    esm_resolver: Resolver::node_esm(project_root, resolver_cache),
     cache,
   };
 

packages/utils/dev-dep-resolver/src/lib.rs renamed to crates/dev-dep-resolver/src/lib.rs

@@ -1,23 +1,21 @@
-use std::{borrow::Cow, sync::Arc};
-
 use parcel_dev_dep_resolver::build_esm_graph;
-use parcel_resolver::{Cache, CacheCow, OsFileSystem, Resolution, Resolver, SpecifierType};
+use parcel_resolver::{Cache, Resolution, Resolver, SpecifierType};
 
 fn main() {
   let contents = std::fs::read_to_string("package.json").unwrap();
   let pkg: serde_json::Value = serde_json::from_str(&contents).unwrap();
   let deps = pkg.get("dependencies").unwrap().as_object().unwrap();
   let cwd = std::env::current_dir().unwrap();
 
-  let cache = Cache::new(Arc::new(OsFileSystem));
-  let cjs_resolver = Resolver::node(Cow::Borrowed(&cwd), CacheCow::Borrowed(&cache));
+  let cache = Cache::default();
+  let cjs_resolver = Resolver::node(&cwd, &cache);
   let esm_graph_cache = parcel_dev_dep_resolver::Cache::default();
 
   deps.keys().for_each(|dep| {
     #[cfg(debug_assertions)]
     println!("------------ {} -----------", dep);
     let resolved = match cjs_resolver.resolve(dep, &cwd, SpecifierType::Esm).result {
-      Ok(res) => res.0,
+      Ok(res) => res.resolution,
       Err(e) => {
         #[cfg(debug_assertions)]
         println!("FAILED TO RESOLVE {} {:?}", dep, e);

packages/utils/dev-dep-resolver/src/main.rs renamed to crates/dev-dep-resolver/src/main.rs

@@ -10,13 +10,13 @@ crate-type = ["cdylib"]
 [dependencies]
 napi-derive = "2.16.3"
 parcel-js-swc-core = { path = "../../packages/transformers/js/core" }
-parcel-resolver = { path = "../../packages/utils/node-resolver-rs" }
+parcel-resolver = { path = "../parcel-resolver" }
 dashmap = "6.1.0"
 xxhash-rust = { version = "0.8.2", features = ["xxh3"] }
 
 [target.'cfg(not(target_arch = "wasm32"))'.dependencies]
 napi = { version = "2.16.4", features = ["serde-json", "napi4", "napi5"] }
-parcel-dev-dep-resolver = { path = "../../packages/utils/dev-dep-resolver" }
+parcel-dev-dep-resolver = { path = "../dev-dep-resolver" }
 parcel-macros = { path = "../macros", features = ["napi"] }
 oxipng = "8.0.0"
 mozjpeg-sys = "2.0.0"

crates/json-comments-rs/Cargo.toml

@@ -5,7 +5,7 @@ use std::alloc::alloc;
 #[cfg(target_arch = "wasm32")]
 use std::alloc::Layout;
 
-#[cfg(all(target_os = "macos", not(miri), not(feature = "canary")))]
+#[cfg(all(target_os = "macos", not(miri)))]
 #[global_allocator]
 static GLOBAL: jemallocator::Jemalloc = jemallocator::Jemalloc;
 

crates/node-bindings/Cargo.toml

@@ -15,7 +15,8 @@ use napi_derive::napi;
 use parcel_resolver::OsFileSystem;
 use parcel_resolver::{
   ExportsCondition, Extensions, Fields, FileCreateInvalidation, FileKind, FileSystem, Flags,
-  IncludeNodeModules, Invalidations, ModuleType, Resolution, ResolverError, SpecifierType,
+  IncludeNodeModules, Invalidations, ModuleType, Resolution, ResolutionAndQuery, ResolverError,
+  SpecifierType,
 };
 
 type NapiSideEffectsVariants = Either3<bool, Vec<String>, HashMap<String, bool>>;
@@ -195,14 +196,12 @@ impl Resolver {
     };
 
     let mut resolver = match options.mode {
-      1 => parcel_resolver::Resolver::parcel(
-        Cow::Owned(project_root.into()),
-        parcel_resolver::CacheCow::Owned(parcel_resolver::Cache::new(fs)),
-      ),
-      2 => parcel_resolver::Resolver::node(
-        Cow::Owned(project_root.into()),
-        parcel_resolver::CacheCow::Owned(parcel_resolver::Cache::new(fs)),
-      ),
+      1 => {
+        parcel_resolver::Resolver::parcel(Path::new(&project_root), parcel_resolver::Cache::new(fs))
+      }
+      2 => {
+        parcel_resolver::Resolver::node(Path::new(&project_root), parcel_resolver::Cache::new(fs))
+      }
       _ => return Err(napi::Error::new(napi::Status::InvalidArg, "Invalid mode")),
     };
 
@@ -315,7 +314,7 @@ impl Resolver {
     match parcel_dev_dep_resolver::build_esm_graph(
       path,
       &self.resolver.project_root.as_path(),
-      &self.resolver.cache,
+      self.resolver.cache(),
       &self.invalidations_cache,
     ) {
       Ok(invalidations) => {
@@ -341,7 +340,7 @@ fn resolve_internal(
   mode: u8,
   options: ResolveOptions,
 ) -> napi::Result<(
-  std::result::Result<(Resolution, Option<String>), ResolverError>,
+  std::result::Result<ResolutionAndQuery, ResolverError>,
   ConvertedInvalidations,
   bool,
   u8,
@@ -373,7 +372,11 @@ fn resolve_internal(
     },
   );
 
-  let side_effects = if let Ok((Resolution::Path(p), _)) = &res.result {
+  let side_effects = if let Ok(ResolutionAndQuery {
+    resolution: Resolution::Path(p),
+    ..
+  }) = &res.result
+  {
     match resolver.resolve_side_effects(p, &res.invalidations) {
       Ok(side_effects) => side_effects,
       Err(err) => {
@@ -388,7 +391,11 @@ fn resolve_internal(
   let mut module_type = 0;
 
   if mode == 2 {
-    if let Ok((Resolution::Path(p), _)) = &res.result {
+    if let Ok(ResolutionAndQuery {
+      resolution: Resolution::Path(p),
+      ..
+    }) = &res.result
+    {
       module_type = match resolver.resolve_module_type(p, &res.invalidations) {
         Ok(t) => match t {
           ModuleType::CommonJs | ModuleType::Json => 1,
@@ -412,20 +419,20 @@ fn resolve_internal(
 
 fn resolve_result_to_js(
   env: Env,
-  res: std::result::Result<(Resolution, Option<String>), ResolverError>,
+  res: std::result::Result<ResolutionAndQuery, ResolverError>,
   invalidations: ConvertedInvalidations,
   side_effects: bool,
   module_type: u8,
 ) -> napi::Result<ResolveResult> {
   let (invalidate_on_file_change, invalidate_on_file_create) = invalidations;
 
   match res {
-    Ok((res, query)) => Ok(ResolveResult {
-      resolution: env.to_js_value(&res)?,
+    Ok(res) => Ok(ResolveResult {
+      resolution: env.to_js_value(&res.resolution)?,
       invalidate_on_file_change,
       invalidate_on_file_create,
       side_effects,
-      query,
+      query: res.query,
       error: env.get_undefined()?.into_unknown(),
       module_type,
     }),

crates/node-bindings/src/lib.rs

@@ -2,6 +2,10 @@
 authors = ["Devon Govett <devongovett@gmail.com>"]
 name = "parcel-resolver"
 version = "0.1.0"
+license = "MIT"
+repository = "https://github.com/parcel-bundler/parcel"
+keywords = ["resolver", "node", "cjs", "esm", "bundler"]
+description = "Node.js compatible module resolver used by the Parcel bundler"
 edition = "2021"
 
 [dependencies]
@@ -10,7 +14,6 @@ dashmap = { version = "6.1.0", features = ["raw-api"] }
 glob-match = "0.2.1"
 indexmap = { version = "1.9.2", features = ["serde"] }
 itertools = "0.10.5"
-json_comments = { path = "../../../crates/json-comments-rs" }
 parking_lot = "0.12"
 percent-encoding = "2.2.0"
 serde = { version = "1.0.152", features = ["derive"] }