From 8b6bba1fc11b151911008472102c3bed8156b384 Mon Sep 17 00:00:00 2001
From: tison <wander4096@gmail.com>
Date: Mon, 8 Jul 2024 10:50:06 -0700
Subject: [PATCH] feat(bindings/nodejs): better error code

Signed-off-by: tison <wander4096@gmail.com>
---
 bin/ofs/Cargo.lock              | 18 +++++++--
 bindings/nodejs/CONTRIBUTING.md | 12 ++++--
 bindings/nodejs/src/lib.rs      | 65 +++++++++++++++++++++++++++++++--
 3 files changed, 83 insertions(+), 12 deletions(-)

diff --git a/bin/ofs/Cargo.lock b/bin/ofs/Cargo.lock
index 2268a79e6929..54f45c64b6ce 100644
--- a/bin/ofs/Cargo.lock
+++ b/bin/ofs/Cargo.lock
@@ -1011,7 +1011,7 @@ dependencies = [
  "md-5",
  "once_cell",
  "percent-encoding",
- "quick-xml",
+ "quick-xml 0.31.0",
  "rand",
  "reqsign",
  "reqwest",
@@ -1101,6 +1101,16 @@ dependencies = [
  "serde",
 ]
 
+[[package]]
+name = "quick-xml"
+version = "0.35.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "86e446ed58cef1bbfe847bc2fda0e2e4ea9f0e57b90c507d4781292590d72a4e"
+dependencies = [
+ "memchr",
+ "serde",
+]
+
 [[package]]
 name = "quinn"
 version = "0.11.2"
@@ -1218,9 +1228,9 @@ checksum = "7a66a03ae7c801facd77a29370b4faec201768915ac14a721ba36f20bc9c209b"
 
 [[package]]
 name = "reqsign"
-version = "0.15.2"
+version = "0.16.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "70fe66d4cd0b5ed9b1abbfe639bf6baeaaf509f7da2d51b31111ba945be59286"
+checksum = "03dd4ba7c3901dd43e6b8c7446a760d45bc1ea4301002e1a6fa48f97c3a796fa"
 dependencies = [
  "anyhow",
  "async-trait",
@@ -1234,7 +1244,7 @@ dependencies = [
  "http",
  "log",
  "percent-encoding",
- "quick-xml",
+ "quick-xml 0.35.0",
  "rand",
  "reqwest",
  "rust-ini",
diff --git a/bindings/nodejs/CONTRIBUTING.md b/bindings/nodejs/CONTRIBUTING.md
index 01d49424b85a..d304ec88054e 100644
--- a/bindings/nodejs/CONTRIBUTING.md
+++ b/bindings/nodejs/CONTRIBUTING.md
@@ -79,11 +79,11 @@ Contains the following tools:
 
 ```bash
 # Install dependencies.
-> pnpm install
+pnpm install
 # Build from source.
-> pnpm build
+pnpm build
 # Build from source with debug info.
-> pnpm build:debug
+pnpm build:debug
 ```
 
 ## Test
@@ -92,8 +92,12 @@ We are using our own developed behavior testing framework.
 Taking 'service-memory' as an example, you can use the following command to run it.
 
 ```bash
-> OPENDAL_TEST=memory pnpm test
+OPENDAL_TEST=memory pnpm test
+```
+
+which will output:
 
+```
 ✓ |opendal| tests/service.test.mjs  (8 tests | 2 skipped) 40ms
 
  Test Files  1 passed (1)
diff --git a/bindings/nodejs/src/lib.rs b/bindings/nodejs/src/lib.rs
index dcc45f15c9cd..687c7671a1bd 100644
--- a/bindings/nodejs/src/lib.rs
+++ b/bindings/nodejs/src/lib.rs
@@ -30,6 +30,8 @@ use napi::bindgen_prelude::*;
 
 mod capability;
 
+type Result<T> = napi::Result<T, ErrorCode>;
+
 #[napi]
 pub struct Operator(opendal::Operator);
 
@@ -1144,9 +1146,64 @@ impl RetryLayer {
     }
 }
 
+#[repr(i32)]
+#[non_exhaustive]
+#[derive(Eq, PartialEq, Debug, Clone, Copy)]
+enum ErrorCode {
+    Unexpected = 1001,
+    Unsupported = 1002,
+    ConfigInvalid = 1003,
+    NotFound = 1004,
+    PermissionDenied = 1005,
+    IsADirectory = 1006,
+    NotADirectory = 1007,
+    AlreadyExists = 1008,
+    RateLimited = 1009,
+    IsSameFile = 1010,
+    ConditionNotMatch = 1011,
+    RangeNotSatisfied = 1012,
+}
+
+impl AsRef<str> for ErrorCode {
+    fn as_ref(&self) -> &str {
+        match self {
+            ErrorCode::Unexpected => "Unexpected",
+            ErrorCode::Unsupported => "Unsupported",
+            ErrorCode::ConfigInvalid => "ConfigInvalid",
+            ErrorCode::NotFound => "NotFound",
+            ErrorCode::PermissionDenied => "PermissionDenied",
+            ErrorCode::IsADirectory => "IsADirectory",
+            ErrorCode::NotADirectory => "NotADirectory",
+            ErrorCode::AlreadyExists => "AlreadyExists",
+            ErrorCode::RateLimited => "RateLimited",
+            ErrorCode::IsSameFile => "IsSameFile",
+            ErrorCode::ConditionNotMatch => "ConditionNotMatch",
+            ErrorCode::RangeNotSatisfied => "RangeNotSatisfied",
+        }
+    }
+}
+
+impl From<opendal::Error> for ErrorCode {
+    fn from(err: opendal::Error) -> Self {
+        match err.kind() {
+            opendal::ErrorKind::Unexpected => ErrorCode::Unexpected,
+            opendal::ErrorKind::Unsupported => ErrorCode::Unsupported,
+            opendal::ErrorKind::ConfigInvalid => ErrorCode::ConfigInvalid,
+            opendal::ErrorKind::NotFound => ErrorCode::NotFound,
+            opendal::ErrorKind::PermissionDenied => ErrorCode::PermissionDenied,
+            opendal::ErrorKind::IsADirectory => ErrorCode::IsADirectory,
+            opendal::ErrorKind::NotADirectory => ErrorCode::NotADirectory,
+            opendal::ErrorKind::AlreadyExists => ErrorCode::AlreadyExists,
+            opendal::ErrorKind::RateLimited => ErrorCode::RateLimited,
+            opendal::ErrorKind::IsSameFile => ErrorCode::IsSameFile,
+            opendal::ErrorKind::ConditionNotMatch => ErrorCode::ConditionNotMatch,
+            opendal::ErrorKind::RangeNotSatisfied => ErrorCode::RangeNotSatisfied,
+            kind => unimplemented!("error kind not supported: {:?}", kind),
+        }
+    }
+}
+
 /// Format opendal error to napi error.
-///
-/// FIXME: handle error correctly.
-fn format_napi_error(err: impl Display) -> Error {
-    Error::from_reason(format!("{}", err))
+fn format_napi_error(err: opendal::Error) -> Error<ErrorCode> {
+    Error::new(err.kind().into(), err.to_string())
 }