feat(napi): add async API (#191)

Author: Boshen

.taplo.toml

@@ -1,4 +1,4 @@
-include = ["*.toml"]
+include = ["Cargo.toml", "napi/Cargo.toml"]
 
 [formatting]
 align_entries = true

Cargo.lock

@@ -0,0 +1 @@
+*.node

napi/.gitignore

@@ -1,7 +1,9 @@
 [package]
-name    = "oxc_napi_resolver"
-version = "0.0.0"
-publish = false
+name         = "oxc_napi_resolver"
+version      = "0.0.0"
+publish      = false
+edition      = "2021"
+rust-version = "1.71"
 
 [lib]
 crate-type = ["cdylib"]
@@ -10,8 +12,9 @@ doctest    = false
 
 [dependencies]
 oxc_resolver = { path = ".." }
-napi         = { version = "2.16.6", default-features = false, features = ["napi3", "serde-json"] }
+napi         = { version = "2.16.6", default-features = false, features = ["napi3", "serde-json", "async"] }
 napi-derive  = { version = "2.16.5" }
+tokio        = "1.38.0"
 
 [build-dependencies]
 napi-build = "2.1.3"

napi/Cargo.toml

@@ -1,6 +1,5 @@
 /* auto-generated by NAPI-RS */
 /* eslint-disable */
-
 export class ResolverFactory {
   constructor(options: NapiResolveOptions)
   static default(): ResolverFactory
@@ -9,6 +8,7 @@ export class ResolverFactory {
   /** Clear the underlying cache. */
   clearCache(): void
   sync(path: string, request: string): ResolveResult
+  async(path: string, request: string): Promise<ResolveResult>
 }
 
 export const enum EnforceExtension {
@@ -80,6 +80,15 @@ export interface NapiResolveOptions {
    * Default `[["exports"]]`.
    */
   exportsFields?: (string | string[])[]
+  /**
+   * Fields from `package.json` which are used to provide the internal requests of a package
+   * (requests starting with # are considered internal).
+   *
+   * Can be a path to a JSON object such as `["path", "to", "imports"]`.
+   *
+   * Default `[["imports"]]`.
+   */
+  importsFields?: (string | string[])[]
   /**
    * An object which maps extension to extension aliases.
    *

napi/index.d.ts

@@ -246,7 +246,20 @@ function requireNative() {
 
       }
     } else if (process.arch === 'arm') {
+      if (isMusl()) {
+        try {
+        return require('./resolver.linux-arm-musleabihf.node')
+      } catch (e) {
+        loadErrors.push(e)
+      }
       try {
+        return require('@oxc-resolver/binding-linux-arm-musleabihf')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+
+      } else {
+        try {
         return require('./resolver.linux-arm-gnueabihf.node')
       } catch (e) {
         loadErrors.push(e)
@@ -257,6 +270,7 @@ function requireNative() {
         loadErrors.push(e)
       }
 
+      }
     } else if (process.arch === 'riscv64') {
       if (isMusl()) {
         try {
@@ -283,6 +297,18 @@ function requireNative() {
       }
 
       }
+    } else if (process.arch === 'ppc64') {
+      try {
+        return require('./resolver.linux-ppc64-gnu.node')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+      try {
+        return require('@oxc-resolver/binding-linux-ppc64-gnu')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+
     } else if (process.arch === 's390x') {
       try {
         return require('./resolver.linux-s390x-gnu.node')

napi/index.js

@@ -2,7 +2,10 @@ extern crate napi;
 extern crate napi_derive;
 extern crate oxc_resolver;
 
-use std::path::{Path, PathBuf};
+use std::{
+    path::{Path, PathBuf},
+    sync::Arc,
+};
 
 use napi_derive::napi;
 use oxc_resolver::{ResolveOptions, Resolver};
@@ -37,26 +40,28 @@ pub fn sync(path: String, request: String) -> ResolveResult {
 
 #[napi]
 pub struct ResolverFactory {
-    resolver: Resolver,
+    resolver: Arc<Resolver>,
 }
 
 #[napi]
 impl ResolverFactory {
     #[napi(constructor)]
     pub fn new(options: NapiResolveOptions) -> Self {
-        Self { resolver: Resolver::new(Self::normalize_options(options)) }
+        Self { resolver: Arc::new(Resolver::new(Self::normalize_options(options))) }
     }
 
     #[napi]
     pub fn default() -> Self {
         let default_options = ResolveOptions::default();
-        Self { resolver: Resolver::new(default_options) }
+        Self { resolver: Arc::new(Resolver::new(default_options)) }
     }
 
     /// Clone the resolver using the same underlying cache.
     #[napi]
     pub fn clone_with_options(&self, options: NapiResolveOptions) -> Self {
-        Self { resolver: self.resolver.clone_with_options(Self::normalize_options(options)) }
+        Self {
+            resolver: Arc::new(self.resolver.clone_with_options(Self::normalize_options(options))),
+        }
     }
 
     /// Clear the underlying cache.
@@ -72,6 +77,14 @@ impl ResolverFactory {
         resolve(&self.resolver, &path, &request)
     }
 
+    #[allow(clippy::needless_pass_by_value)]
+    #[napi(js_name = "async")]
+    pub async fn resolve_async(&self, path: String, request: String) -> ResolveResult {
+        let path = PathBuf::from(path);
+        let resolver = self.resolver.clone();
+        tokio::spawn(async move { resolve(&resolver, &path, &request) }).await.unwrap()
+    }
+
     fn normalize_options(op: NapiResolveOptions) -> ResolveOptions {
         let default = ResolveOptions::default();
         // merging options

napi/src/lib.rs

@@ -15,6 +15,9 @@ assert.deepStrictEqual(resolver.sync(cwd, "./index.js").path, path.join(cwd, 'in
 
 assert.strict(resolver.sync(cwd, "./ts").error.length > 0);
 
+resolver.async(cwd, "./ts")
+  .then((result) => assert.strict(result.error.length > 0));
+
 const newResolver = resolver.cloneWithOptions({});
 newResolver.clearCache();