feat: add bindSync and unbindSync for the sockets

zeromq · Dec 30, 2024 · f56863d · f56863d
1 parent d473c10
commit f56863d
Show file tree

Hide file tree

Showing 6 changed files with 117 additions and 67 deletions.
diff --git a/package.json b/package.json
@@ -25,7 +25,6 @@
   "devDependencies": {
     "@types/benchmark": "~2.1.5",
     "@types/chai": "^4",
-    "@types/deasync": "~0.1.5",
     "@types/eslint": "~9.6.1",
     "@types/fs-extra": "^11.0.4",
     "@types/gh-pages": "~6.1.0",
@@ -38,7 +37,6 @@
     "benchmark": "^2.1.4",
     "chai": "^4",
     "cross-env": "^7.0.3",
-    "deasync": "^0.1.30",
     "downlevel-dts": "^0.11.0",
     "electron": "^33.2.1",
     "electron-mocha": "^13.0.1",

diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/src/compat.ts b/src/compat.ts
@@ -327,34 +327,12 @@ class Socket extends EventEmitter {
     )
   }
 
-  bindSync(...args: Parameters<Socket["bind"]>) {
-    try {
-      Object.defineProperty(this, "bindSync", {
-        value: require("deasync")(this.bind),
-      })
-    } catch (err) {
-      throw new Error(
-        "bindSync() has been removed from compatibility mode; " +
-          "use bind() instead, or add 'deasync' to your project dependencies",
-      )
-    }
-
-    this.bindSync(...args)
+  bindSync(address: string) {
+    this._socket.bindSync(address)
   }
 
-  unbindSync(...args: Parameters<Socket["unbind"]>) {
-    try {
-      Object.defineProperty(this, "unbindSync", {
-        value: require("deasync")(this.unbind),
-      })
-    } catch (err) {
-      throw new Error(
-        "unbindSync() has been removed from compatibility mode; " +
-          "use unbind() instead, or add 'deasync' to your project dependencies",
-      )
-    }
-
-    this.unbindSync(...args)
+  unbindSync(address: string) {
+    this._socket.unbindSync(address)
   }
 
   pause() {

diff --git a/src/native.ts b/src/native.ts
@@ -539,6 +539,26 @@ export declare abstract class Socket {
    */
   bind(address: string): Promise<void>
 
+  /**
+   * Binds the socket to the given address. During {@link bind}() the socket
+   * cannot be used. Do not call any other methods until the returned promise
+   * resolves. Make sure to use `await`.
+   *
+   * You can use `*` in place of a hostname to bind on all interfaces/addresses,
+   * and you can use `*` in place of a port to bind to a random port (which can
+   * be retrieved with {@link lastEndpoint} later).
+   *
+   * ```typescript
+   * socket.bindSync("tcp://127.0.0.1:3456")
+   * socket.bindSync("tcp://*:3456")         // binds on all interfaces
+   * socket.bindSync("tcp://127.0.0.1:*")    // binds on random port
+   * ```
+   *
+   * @param address Address to bind this socket to.
+   * @returns Resolved when the socket was successfully bound.
+   */
+  bindSync(address: string): void
+
   /**
    * Unbinds the socket to the given address. During {@link unbind}() the socket
    * cannot be used. Do not call any other methods until the returned promise
@@ -549,6 +569,16 @@ export declare abstract class Socket {
    */
   unbind(address: string): Promise<void>
 
+  /**
+   * Unbinds the socket to the given address. During {@link unbind}() the socket
+   * cannot be used. Do not call any other methods until the returned promise
+   * resolves. Make sure to use `await`.
+   *
+   * @param address Address to unbind this socket from.
+   * @returns Resolved when the socket was successfully unbound.
+   * */
+  unbindSync(address: string): void
+
   /**
    * Connects to the socket at the given remote address and returns immediately.
    * The connection will be made asynchronously in the background.

diff --git a/src/socket.cc b/src/socket.cc
@@ -392,7 +392,7 @@ Napi::Value Socket::Bind(const Napi::CallbackInfo& info) {
             if (run_ctx->error != 0) {
                 res.Reject(ErrnoException(
                     Env(), static_cast<int32_t>(run_ctx->error), run_ctx->address)
-                        .Value());
+                               .Value());
                 return;
             }
 
@@ -407,6 +407,44 @@ Napi::Value Socket::Bind(const Napi::CallbackInfo& info) {
     return res.Promise();
 }
 
+Napi::Value Socket::BindSync(const Napi::CallbackInfo& info) {
+    Arg::Validator const args{
+        Arg::Required<Arg::String>("Address must be a string"),
+    };
+
+    if (args.ThrowIfInvalid(info)) {
+        return Env().Undefined();
+    }
+
+    if (!ValidateOpen()) {
+        return Env().Undefined();
+    }
+
+    state = Socket::State::Blocked;
+    auto run_ctx = std::make_shared<AddressContext>(info[0].As<Napi::String>());
+
+    while (zmq_bind(socket, run_ctx->address.c_str()) < 0) {
+        if (zmq_errno() != EINTR) {
+            run_ctx->error = static_cast<uint32_t>(zmq_errno());
+            break;
+        }
+    }
+
+    state = Socket::State::Open;
+    endpoints++;
+
+    if (request_close) {
+        Close();
+    }
+
+    if (run_ctx->error != 0) {
+        ErrnoException(Env(), static_cast<int32_t>(run_ctx->error), run_ctx->address)
+            .ThrowAsJavaScriptException();
+    }
+
+    return Env().Undefined();
+}
+
 Napi::Value Socket::Unbind(const Napi::CallbackInfo& info) {
     Arg::Validator const args{
         Arg::Required<Arg::String>("Address must be a string"),
@@ -448,7 +486,7 @@ Napi::Value Socket::Unbind(const Napi::CallbackInfo& info) {
             if (run_ctx->error != 0) {
                 res.Reject(ErrnoException(
                     Env(), static_cast<int32_t>(run_ctx->error), run_ctx->address)
-                        .Value());
+                               .Value());
                 return;
             }
 
@@ -463,6 +501,42 @@ Napi::Value Socket::Unbind(const Napi::CallbackInfo& info) {
     return res.Promise();
 }
 
+Napi::Value Socket::UnbindSync(const Napi::CallbackInfo& info) {
+    Arg::Validator const args{
+        Arg::Required<Arg::String>("Address must be a string"),
+    };
+
+    if (args.ThrowIfInvalid(info)) {
+        return Env().Undefined();
+    }
+
+    if (!ValidateOpen()) {
+        return Env().Undefined();
+    }
+
+    state = Socket::State::Blocked;
+
+    while (zmq_unbind(socket, info[0].As<Napi::String>().Utf8Value().c_str()) < 0) {
+        if (zmq_errno() != EINTR) {
+            break;
+        }
+    }
+
+    if (zmq_errno() == EADDRNOTAVAIL) {
+        // Unbind operation failed due to address not being bound.
+        return Env().Undefined();
+    }
+
+    state = Socket::State::Open;
+    --endpoints;
+
+    if (request_close) {
+        Close();
+    }
+
+    return Env().Undefined();
+}
+
 void Socket::Connect(const Napi::CallbackInfo& info) {
     Arg::Validator const args{
         Arg::Required<Arg::String>("Address must be a string"),
@@ -919,6 +993,10 @@ void Socket::Initialize(Module& module, Napi::Object& exports) {
     auto proto = {
         InstanceMethod<&Socket::Bind>("bind"),
         InstanceMethod<&Socket::Unbind>("unbind"),
+
+        InstanceMethod<&Socket::BindSync>("bindSync"),
+        InstanceMethod<&Socket::BindSync>("unbindSync"),
+
         InstanceMethod<&Socket::Connect>("connect"),
         InstanceMethod<&Socket::Disconnect>("disconnect"),
         InstanceMethod<&Socket::Close>("close"),

diff --git a/src/socket.h b/src/socket.h
@@ -35,7 +35,10 @@ class Socket : public Napi::ObjectWrap<Socket>, public Closable {
     inline void Close(const Napi::CallbackInfo& info);
 
     inline Napi::Value Bind(const Napi::CallbackInfo& info);
+    inline Napi::Value BindSync(const Napi::CallbackInfo& info);
+
     inline Napi::Value Unbind(const Napi::CallbackInfo& info);
+    inline Napi::Value UnbindSync(const Napi::CallbackInfo& info);
 
     inline void Connect(const Napi::CallbackInfo& info);
     inline void Disconnect(const Napi::CallbackInfo& info);