node-datachannel 0.3.5 → 0.4.0

package/.github/workflows/build-linux-arm64-test.yml

@@ -2,9 +2,6 @@ name: Build - Linux-Arm64
 
 on:
   workflow_dispatch:
-  push:
-    tags:
-      - v*
 
 env:
   ACTIONS_ALLOW_UNSECURE_COMMANDS: true

package/.github/workflows/build-mac-m1.yml

@@ -11,31 +11,27 @@ env:
 
 jobs:
   build-macos:
-    runs-on: macos-11
+    runs-on: macos-latest
     strategy:
       matrix:
-        node-version: [ 16.x]
+        node-version: [10.x, 11.x, 12.x, 13.x, 14.x, 15.x, 16.x, 17.x, 18.x]
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Install OpenSSL
-        run: HOMEBREW_NO_INSTALL_CLEANUP=1 brew reinstall openssl@1.1
+        run: |
+          wget https://mac.r-project.org/bin/darwin20/arm64/openssl-1.1.1o-darwin.20-arm64.tar.xz
+          tar -xf openssl-1.1.1o-darwin.20-arm64.tar.xz -C /tmp
+          rm -rf openssl-1.1.1o-darwin.20-arm64.tar.xz
       - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v3
         with:
           node-version: ${{ matrix.node-version }}
-          architecture: x64
       - name: Build
-        run: npm install --build-from-source
-        env:
-          CI: true
-          OPENSSL_ROOT_DIR: /usr/local/opt/openssl
-          OPENSSL_LIBRARIES: /usr/local/opt/openssl/lib
-      - name: Test
-        run: npm run test
-        env:
-          CI: true
-      - name: Upload
-        run: node_modules/.bin/prebuild --upload -u ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          npm install --ignore-scripts
+          node_modules/.bin/prebuild --backend cmake-js --arch arm64 --upload -u ${{ secrets.GITHUB_TOKEN }} -- --CDCMAKE_OSX_ARCHITECTURES="arm64"
         env:
           CI: true
+          OPENSSL_ROOT_DIR: /tmp/opt/R/arm64
+          OPENSSL_LIBRARIES: /tmp/opt/R/arm64/lib

package/.github/workflows/{build-mac.yml → build-mac-x64.yml}

@@ -1,4 +1,4 @@
-name: Build - Mac
+name: Build - Mac x64
 
 on:
   workflow_dispatch:

package/API.md

@@ -49,6 +49,10 @@ TURN Server Example (TLS)    : turns:USERNAME:PASSWORD@TURN_IP_OR_ADDRESS:PORT
 
 Close Peer Connection
 
+**destroy: () => void**
+
+Close Peer Connection & Clear all callbacks
+
 **setRemoteDescription: (sdp: string, type: DescriptionType) => void**
 
 Set Remote Description

package/CMakeLists.txt

@@ -1,6 +1,6 @@
 cmake_minimum_required(VERSION 3.15)
 cmake_policy(SET CMP0091 NEW)
-project(node_datachannel VERSION 0.3.5)
+project(node_datachannel VERSION 0.4.0)
 
 # Workaround for https://github.com/murat-dogan/node-datachannel/issues/65
 if( NODE_RUNTIMEVERSION VERSION_GREATER_EQUAL "17.0.0")
@@ -17,13 +17,18 @@ if(WIN32)
     set(CMAKE_MSVC_RUNTIME_LIBRARY "MultiThreaded$<$<CONFIG:Debug>:Debug>")
 endif()
 
-# Got linker error for arm64
-# /usr/lib/gcc-cross/aarch64-linux-gnu/9/../../../../aarch64-linux-gnu/bin/ld: ../sysroot/usr/lib/aarch64-linux-gnu/libcrypto.a(sha1-armv8.o): relocation R_AARCH64_PREL64 against symbol `OPENSSL_armcap_P' which may bind externally can not be used when making a shared object; recompile with -fPIC
-# ../sysroot/usr/lib/aarch64-linux-gnu/libcrypto.a(sha1-armv8.o): in function `sha1_block_armv8':
-# (.text+0x1240): dangerous relocation: unsupported relocation
-if(NOT ${NODE_ARCH} STREQUAL "arm64")
-  set(OPENSSL_USE_STATIC_LIBS TRUE)
-  find_package(OpenSSL REQUIRED)
+if(APPLE)
+    set(OPENSSL_USE_STATIC_LIBS TRUE)
+    find_package(OpenSSL REQUIRED)
+elseif(UNIX)
+    # Got linker error for arm64
+    # /usr/lib/gcc-cross/aarch64-linux-gnu/9/../../../../aarch64-linux-gnu/bin/ld: ../sysroot/usr/lib/aarch64-linux-gnu/libcrypto.a(sha1-armv8.o): relocation R_AARCH64_PREL64 against symbol `OPENSSL_armcap_P' which may bind externally can not be used when making a shared object; recompile with -fPIC
+    # ../sysroot/usr/lib/aarch64-linux-gnu/libcrypto.a(sha1-armv8.o): in function `sha1_block_armv8':
+    # (.text+0x1240): dangerous relocation: unsupported relocation
+    if(NOT ${NODE_ARCH} STREQUAL "arm64")
+        set(OPENSSL_USE_STATIC_LIBS TRUE)
+        find_package(OpenSSL REQUIRED)
+    endif()
 endif()
 
 
@@ -33,7 +38,7 @@ include(FetchContent)
 FetchContent_Declare(
     libdatachannel
     GIT_REPOSITORY https://github.com/paullouisageneau/libdatachannel.git
-    GIT_TAG "v0.17.9"
+    GIT_TAG "v0.17.10"
 )
 
 option(NO_MEDIA "Disable media transport support in libdatachannel" OFF)
@@ -68,9 +73,12 @@ target_include_directories(${PROJECT_NAME} PRIVATE
     ${CMAKE_BINARY_DIR}/_deps/libdatachannel-src/include
 )
 
-# For compatibility with Node.js 12
-# This should be removed along with the napi-thread-safe-callback-cancellable dependency when dropping support at end-of-life
-target_compile_definitions(${PROJECT_NAME} PRIVATE -DLEGACY_NAPI_THREAD_SAFE_CALLBACK)
+if( NODE_RUNTIMEVERSION VERSION_LESS "16.0.0")
+    # For compatibility with Node.js 12
+    # This should be removed along with the napi-thread-safe-callback-cancellable dependency when dropping support at end-of-life
+    target_compile_definitions(${PROJECT_NAME} PRIVATE -DLEGACY_NAPI_THREAD_SAFE_CALLBACK)    
+endif()
+
 target_include_directories(${PROJECT_NAME} PRIVATE
     ${CMAKE_SOURCE_DIR}/node_modules/napi-thread-safe-callback-cancellable
 )
@@ -81,8 +89,7 @@ set(LINK_LIBRARIES
 )
 
 if(APPLE)
-    SET(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -arch x86_64 -arch arm64 ")
-    SET(CMAKE_CXX_FLAGS "${CMAKE_CXX_LINK_FLAGS} -arch x86_64 -arch arm64 ")
+    #
 elseif(UNIX)
     list(APPEND LINK_LIBRARIES -static-libgcc -static-libstdc++)
 endif()

package/README.md

@@ -20,18 +20,19 @@ npm install node-datachannel
 
 ## Supported Platforms
 
-|          | Linux-x64 | Linux-armv7 | Linux-arm64(1)   | Windows-x86 | Windows-x64 | Mac |
-|----------|:---------:|:-----------:|:----------------:|:-----------:|:-----------:|:---:|
-| Node V10 |     +     |      +      |      +           |      +      |      +      |  +  |
-| Node V11 |     +     |      +      |      +           |      +      |      +      |  +  |
-| Node V12 |     +     |      +      |      +           |      +      |      +      |  +  |
-| Node V13 |     +     |      +      |      +           |      +      |      +      |  +  |
-| Node V14 |     +     |      +      |      +           |      +      |      +      |  +  |
-| Node V15 |     +     |      +      |      +           |      +      |      +      |  +  |
-| Node V16 |     +     |      +      |      +           |      +      |      +      |  +  |
-| Node V17 |     +     |      +      |      +           |      +      |      +      |  +  |
-
-1) Please note that; For arm64 platform we need OpenSSL to be installed locally.
+|          | Linux-x64 | Linux-armv7 | Linux-arm64(1)   | Windows-x86 | Windows-x64 | Mac (M1 + x64) |
+|----------|:---------:|:-----------:|:----------------:|:-----------:|:-----------:|:--------------:|
+| Node V10 |     +     |      +      |      +           |      +      |      +      |       +        |
+| Node V11 |     +     |      +      |      +           |      +      |      +      |       +        |
+| Node V12 |     +     |      +      |      +           |      +      |      +      |       +        |
+| Node V13 |     +     |      +      |      +           |      +      |      +      |       +        |
+| Node V14 |     +     |      +      |      +           |      +      |      +      |       +        |
+| Node V15 |     +     |      +      |      +           |      +      |      +      |       +        |
+| Node V16 |     +     |      +      |      +           |      +      |      +      |       +        |
+| Node V17 |     +     |      +      |      +           |      +      |      +      |       +        |
+| Node V18 |     +     |      +      |      +           |      +      |      +      |       +        |
+
+1) Please note that; For Linux-arm64 platform we need OpenSSL to be installed locally.
 
 
 ## Example Usage

package/lib/index.d.ts

@@ -204,6 +204,7 @@ export class DataChannel {
 export class PeerConnection {
     constructor(peerName: string, config: RtcConfig);
     close(): void;
+    destroy(): void;
     setLocalDescription(type?: DescriptionType): void;
     setRemoteDescription(sdp: string, type: DescriptionType): void;
     localDescription(): { type: string; sdp: string } | null;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-datachannel",
-  "version": "0.3.5",
+  "version": "0.4.0",
   "description": "libdatachannel node bindings",
   "main": "lib/index.js",
   "typings": "lib/index.d.ts",
@@ -13,6 +13,7 @@
     "install": "prebuild-install || (npm install --ignore-scripts && npm run _prebuild)",
     "install-nice": "npm run clean && cmake-js build --CDUSE_NICE=1",
     "build": "cmake-js build",
+    "build:debug": "cmake-js build -D",
     "_prebuild": "prebuild --backend cmake-js",
     "clean": "cmake-js clean",
     "lint": "eslint lib/**/* test/**/*",

package/src/peer-connection-wrapper.cpp

@@ -17,6 +17,13 @@ void PeerConnectionWrapper::CloseAll()
         inst->doClose();
 }
 
+void PeerConnectionWrapper::ResetCallbacksAll()
+{
+    auto copy(instances);
+    for (auto inst : copy)
+        inst->doResetCallbacks();
+}
+
 Napi::Object PeerConnectionWrapper::Init(Napi::Env env, Napi::Object exports)
 {
     Napi::HandleScope scope(env);
@@ -26,6 +33,7 @@ Napi::Object PeerConnectionWrapper::Init(Napi::Env env, Napi::Object exports)
         "PeerConnection",
         {
             InstanceMethod("close", &PeerConnectionWrapper::close),
+            InstanceMethod("destroy", &PeerConnectionWrapper::destroy),
             InstanceMethod("setLocalDescription", &PeerConnectionWrapper::setLocalDescription),
             InstanceMethod("setRemoteDescription", &PeerConnectionWrapper::setRemoteDescription),
             InstanceMethod("localDescription", &PeerConnectionWrapper::localDescription),
@@ -225,7 +233,7 @@ PeerConnectionWrapper::PeerConnectionWrapper(const Napi::CallbackInfo &info) : N
 
 PeerConnectionWrapper::~PeerConnectionWrapper()
 {
-    doClose();
+    doDestroy();
 }
 
 void PeerConnectionWrapper::doClose()
@@ -243,7 +251,21 @@ void PeerConnectionWrapper::doClose()
             return;
         }
     }
+}
 
+void PeerConnectionWrapper::close(const Napi::CallbackInfo &info)
+{
+    doClose();
+}
+
+void PeerConnectionWrapper::doDestroy()
+{
+    doClose();
+    doResetCallbacks();
+}
+
+void PeerConnectionWrapper::doResetCallbacks()
+{  
     mOnLocalDescriptionCallback.reset();
     mOnLocalCandidateCallback.reset();
     mOnStateChangeCallback.reset();
@@ -254,9 +276,9 @@ void PeerConnectionWrapper::doClose()
     instances.erase(this);
 }
 
-void PeerConnectionWrapper::close(const Napi::CallbackInfo &info)
+void PeerConnectionWrapper::destroy(const Napi::CallbackInfo &info)
 {
-    doClose();
+    doDestroy();
 }
 
 void PeerConnectionWrapper::setLocalDescription(const Napi::CallbackInfo &info)
@@ -639,9 +661,8 @@ void PeerConnectionWrapper::onStateChange(const Napi::CallbackInfo &info)
 
     mRtcPeerConnPtr->onStateChange([&](rtc::PeerConnection::State state) {
         if (mOnStateChangeCallback)
-            mOnStateChangeCallback->call([this, state](Napi::Env env, std::vector<napi_value> &args) {
-                // Check the peer connection is not closed but still allow a call for State::Closed
-                if(state != rtc::PeerConnection::State::Closed && instances.find(this) == instances.end())
+            mOnStateChangeCallback->call([this, state](Napi::Env env, std::vector<napi_value> &args) {                
+                if(instances.find(this) == instances.end())
                     throw ThreadSafeCallback::CancelException();
 
                 // This will run in main thread and needs to construct the

package/src/peer-connection-wrapper.h

@@ -19,6 +19,8 @@ public:
   PeerConnectionWrapper(const Napi::CallbackInfo &info);
   ~PeerConnectionWrapper();
 
+  void destroy(const Napi::CallbackInfo &info);
+
   // Functions
   void close(const Napi::CallbackInfo &info);
   void setLocalDescription(const Napi::CallbackInfo &info);
@@ -47,14 +49,19 @@ public:
   Napi::Value rtt(const Napi::CallbackInfo &info);
   Napi::Value getSelectedCandidatePair(const Napi::CallbackInfo &info);
 
-  // Close all existing DataChannels
+  // Close all existing Peer Connections
   static void CloseAll();
 
+  // Reset all Callbacks for existing Peer Connections
+  static void ResetCallbacksAll();
+
 private:
   static Napi::FunctionReference constructor;
   static std::unordered_set<PeerConnectionWrapper *> instances;
 
   void doClose();
+  void doDestroy();
+  void doResetCallbacks();
 
   std::string mPeerName;
   std::unique_ptr<rtc::PeerConnection> mRtcPeerConnPtr = nullptr;

package/src/rtc-wrapper.cpp

@@ -82,7 +82,10 @@ void RtcWrapper::cleanup(const Napi::CallbackInfo &info)
         const auto timeout = std::chrono::seconds(10);
         if(rtc::Cleanup().wait_for(std::chrono::seconds(timeout)) == std::future_status::timeout)
             throw std::runtime_error("cleanup timeout (possible deadlock)");
-    }
+        
+        // Clear Callbacks    
+        PeerConnectionWrapper::ResetCallbacksAll();
+    }        
     catch (std::exception &ex)
     {
         Napi::Error::New(env, std::string("libdatachannel error# ") + ex.what()).ThrowAsJavaScriptException();