node-datachannel 0.4.3 → 0.5.0

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

@@ -2,9 +2,9 @@ name: Build - Linux
 
 on:
   workflow_dispatch:
-  push:
-    tags:
-      - v*
+  # push:
+  #   tags:
+  #     - v*
 
 env:
   ACTIONS_ALLOW_UNSECURE_COMMANDS: true
@@ -14,7 +14,7 @@ jobs:
     runs-on: ubuntu-20.04
     strategy:
       matrix:
-        node-version: [10.x, 11.x, 12.x, 13.x, 14.x, 15.x, 16.x, 17.x, 18.x, 19.x, 20.x]
+        node-version: [ 16.x]
 
     steps:
       - uses: actions/checkout@v2
@@ -31,7 +31,7 @@ jobs:
         env:
           CI: true
       - name: Upload
-        run: node_modules/.bin/prebuild --upload -u ${{ secrets.GITHUB_TOKEN }}
+        run: node_modules/.bin/prebuild -r napi --upload -u ${{ secrets.GITHUB_TOKEN }}
         env:
           CI: true
 
@@ -40,7 +40,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [10.x, 11.x, 12.x, 13.x, 14.x, 15.x, 16.x, 17.x, 18.x, 19.x, 20.x]
+        node-version: [16.x]
     steps:
       - uses: actions/checkout@v2
       - name: Prepare Cross Compile
@@ -59,7 +59,7 @@ jobs:
       - name: Build & Upload
         run: |
           npm install --ignore-scripts
-          node_modules/.bin/prebuild --backend cmake-js --arch arm --upload -u ${{ secrets.GITHUB_TOKEN }} -- --CDCMAKE_TOOLCHAIN_FILE:FILEPATH=./cmake/toolchain/armv7.cmake
+          node_modules/.bin/prebuild -r napi --backend cmake-js --arch arm --upload -u ${{ secrets.GITHUB_TOKEN }} -- --CDCMAKE_TOOLCHAIN_FILE:FILEPATH=./cmake/toolchain/armv7.cmake
         env:
           CI: true
 
@@ -68,7 +68,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [10.x, 11.x, 12.x, 13.x, 14.x, 15.x, 16.x, 17.x, 18.x, 19.x, 20.x]
+        node-version: [16.x]
     steps:
       - uses: actions/checkout@v2
       - name: Prepare Cross Compile
@@ -87,7 +87,7 @@ jobs:
       - name: Build & Upload
         run: |
           npm install --ignore-scripts
-          node_modules/.bin/prebuild --backend cmake-js --arch arm64 --upload -u ${{ secrets.GITHUB_TOKEN }} -- --CDCMAKE_TOOLCHAIN_FILE:FILEPATH=./cmake/toolchain/arm64.cmake
+          node_modules/.bin/prebuild -r napi --backend cmake-js --arch arm64 --upload -u ${{ secrets.GITHUB_TOKEN }} -- --CDCMAKE_TOOLCHAIN_FILE:FILEPATH=./cmake/toolchain/arm64.cmake
         env:
           CI: true
 
@@ -101,7 +101,7 @@ jobs:
   #     - name: Set up Node.js
   #       uses: actions/setup-node@v1
   #       with:
-  #         node-version: 12.x
+  #         node-version: 16.x
   #         registry-url: "https://registry.npmjs.org"
   #     - name: Publish
   #       run: |

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

@@ -2,9 +2,9 @@ name: Build - Mac M1
 
 on:
   workflow_dispatch:
-  push:
-    tags:
-      - v*
+  # push:
+  #   tags:
+  #     - v*
 
 env:
   ACTIONS_ALLOW_UNSECURE_COMMANDS: true
@@ -14,7 +14,7 @@ jobs:
     runs-on: macos-11
     strategy:
       matrix:
-        node-version: [10.x, 11.x, 12.x, 13.x, 14.x, 15.x, 16.x, 17.x, 18.x, 19.x, 20.x]
+        node-version: [16.x]
 
     steps:
       - uses: actions/checkout@v3
@@ -30,7 +30,7 @@ jobs:
       - name: Build
         run: |
           npm install --ignore-scripts
-          node_modules/.bin/prebuild --backend cmake-js --arch arm64 --upload -u ${{ secrets.GITHUB_TOKEN }} -- --CDCMAKE_OSX_ARCHITECTURES="arm64"
+          node_modules/.bin/prebuild -r napi --backend cmake-js --arch arm64 --upload -u ${{ secrets.GITHUB_TOKEN }} -- --CDCMAKE_OSX_ARCHITECTURES="arm64"
         env:
           CI: true
           OPENSSL_ROOT_DIR: /tmp/opt/R/arm64

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

@@ -2,9 +2,9 @@ name: Build - Mac x64
 
 on:
   workflow_dispatch:
-  push:
-    tags:
-      - v*
+  # push:
+  #   tags:
+  #     - v*
 
 env:
   ACTIONS_ALLOW_UNSECURE_COMMANDS: true
@@ -14,7 +14,7 @@ jobs:
     runs-on: macos-11
     strategy:
       matrix:
-        node-version: [10.x, 11.x, 12.x, 13.x, 14.x, 15.x, 16.x, 17.x, 18.x, 19.x, 20.x]
+        node-version: [16.x]
 
     steps:
       - uses: actions/checkout@v2
@@ -35,6 +35,6 @@ jobs:
         env:
           CI: true
       - name: Upload
-        run: node_modules/.bin/prebuild --upload -u ${{ secrets.GITHUB_TOKEN }}
+        run: node_modules/.bin/prebuild -r napi --upload -u ${{ secrets.GITHUB_TOKEN }}
         env:
           CI: true

package/.github/workflows/build-win.yml

@@ -2,9 +2,9 @@ name: Build - Win
 
 on:
   workflow_dispatch:
-  push:
-    tags:
-      - v*
+  # push:
+  #   tags:
+  #     - v*
 
 env:
   ACTIONS_ALLOW_UNSECURE_COMMANDS: true
@@ -14,7 +14,7 @@ jobs:
     runs-on: windows-2019
     strategy:
       matrix:
-        node-version: [10.x, 11.x, 12.x, 13.x, 14.x, 15.x, 16.x, 17.x, 18.x, 19.x, 20.x]
+        node-version: [16.x]
 
     steps:
       - uses: actions/checkout@v2
@@ -34,7 +34,7 @@ jobs:
       #   env:
       #     CI: true
       - name: Upload
-        run: node_modules/.bin/prebuild --upload -u ${{ secrets.GITHUB_TOKEN }}
+        run: node_modules/.bin/prebuild -r napi --upload -u ${{ secrets.GITHUB_TOKEN }}
         env:
           CI: true
 
@@ -42,7 +42,7 @@ jobs:
     runs-on: windows-2019
     strategy:
       matrix:
-        node_version: [10.x, 11.x, 12.x, 13.x, 14.x, 15.x, 16.x, 17.x, 18.x, 19.x, 20.x]
+        node_version: [16.x]
         node_arch:
           - x86
     steps:
@@ -51,7 +51,10 @@ jobs:
         with:
           arch: x86
       - name: Install OpenSSL
-        run: choco install openssl --x86=true
+      # openssl v3.1.1 [Approved]
+      # openssl package files install completed. Performing other installation steps.
+      # ERROR: 32-bit installation is not supported for openssl
+        run: choco install openssl --x86=true --version=1.1.1.2100
       - name: Use Node.js ${{ matrix.node_version }}
         uses: aminya/setup-node@x86
         with:
@@ -66,6 +69,6 @@ jobs:
       #   env:
       #     CI: true
       - name: Upload
-        run: node_modules/.bin/prebuild --upload -u ${{ secrets.GITHUB_TOKEN }}
+        run: node_modules/.bin/prebuild -r napi --upload -u ${{ secrets.GITHUB_TOKEN }}
         env:
           CI: true

package/.github/workflows/lint.yml

@@ -16,4 +16,4 @@ jobs:
         with:
           node-version: '16.x'
       - run: npm ci
-      - run: npm run lint      
+      - run: npm run lint

package/.github/workflows/npm-publish-manual.yml

@@ -13,7 +13,7 @@ jobs:
       - name: Set up Node.js
         uses: actions/setup-node@v1
         with:
-          node-version: 12.x
+          node-version: 16.x
           registry-url: "https://registry.npmjs.org"
       - name: Publish
         run: |

package/{.prettierrc.js → .prettierrc.cjs}

@@ -4,4 +4,5 @@ module.exports =  {
   singleQuote:  true,
   printWidth:  120,
   tabWidth:  4,
+  endOfLine: 'auto'
 };

package/BULDING.md

@@ -14,6 +14,10 @@
 
 Other Options
 ```sh
-> npm run install -- -DUSE_GNUTLS=1  # Use GnuTLS instead of OpenSSL (Default False)
-> npm run install -- -DUSE_NICE=1    # Use libnice instead of libjuice (Default False)
-```
+# Use GnuTLS instead of OpenSSL (Default False)
+> npm run install-gnu-tls
+
+# Use libnice instead of libjuice (Default False)
+# libnice-dev packet should be installed. (eg. sudo apt install libnice-dev)
+> npm run install-nice
+```

package/CMakeLists.txt

@@ -1,12 +1,11 @@
 cmake_minimum_required(VERSION 3.15)
 cmake_policy(SET CMP0091 NEW)
-project(node_datachannel VERSION 0.4.3)
+cmake_policy(SET CMP0042 NEW)
 
-# Workaround for https://github.com/murat-dogan/node-datachannel/issues/65
-if( NODE_RUNTIMEVERSION VERSION_GREATER "17.0.0" AND NODE_RUNTIMEVERSION VERSION_LESS "18.0.0" )
-    add_compile_definitions(OPENSSL_API_COMPAT=0x10100001L)
-    add_compile_definitions(OPENSSL_CONFIGURED_API=0x30000000L)
-endif()
+project(node_datachannel VERSION 0.5.0)
+
+# -Dnapi_build_version=8
+add_definitions(-DNAPI_VERSION=8)
 
 include_directories(${CMAKE_JS_INC})
 
@@ -30,26 +29,25 @@ if(NOT ${NODE_ARCH} STREQUAL "arm64")
     find_package(OpenSSL REQUIRED)
 endif()
 
-
 include(FetchContent)
 
 # Fetch libdatachannel
 FetchContent_Declare(
     libdatachannel
     GIT_REPOSITORY https://github.com/paullouisageneau/libdatachannel.git
-    GIT_TAG "v0.18.5"
+    GIT_TAG "v0.19.2"
 )
 
 option(NO_MEDIA "Disable media transport support in libdatachannel" OFF)
 option(NO_WEBSOCKET "Disable WebSocket support in libdatachannel" ON)
 
 FetchContent_GetProperties(libdatachannel)
+
 if(NOT libdatachannel)
-  FetchContent_Populate(libdatachannel)
-  add_subdirectory(${libdatachannel_SOURCE_DIR} ${libdatachannel_BINARY_DIR} EXCLUDE_FROM_ALL)
+    FetchContent_Populate(libdatachannel)
+    add_subdirectory(${libdatachannel_SOURCE_DIR} ${libdatachannel_BINARY_DIR} EXCLUDE_FROM_ALL)
 endif()
 
-
 add_library(${PROJECT_NAME} SHARED
     src/rtc-wrapper.cpp
     src/media-direction.cpp
@@ -70,25 +68,17 @@ set_target_properties(${PROJECT_NAME} PROPERTIES PREFIX "" SUFFIX ".node")
 target_include_directories(${PROJECT_NAME} PRIVATE
     ${CMAKE_SOURCE_DIR}/node_modules/node-addon-api
     ${CMAKE_BINARY_DIR}/_deps/libdatachannel-src/include
-)
-
-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
+    ${CMAKE_BINARY_DIR}/_deps/libdatachannel-src/deps/plog
 )
 
 set(LINK_LIBRARIES
     ${CMAKE_JS_LIB}
     datachannel-static
+    plog::plog
 )
 
 if(APPLE)
-    #
+#
 elseif(CMAKE_HOST_SYSTEM_NAME STREQUAL "Android")
     list(APPEND LINK_LIBRARIES -static-libgcc)
 elseif(UNIX)

package/README.md

@@ -2,11 +2,11 @@
 
 ![Linux CI Build](https://github.com/murat-dogan/node-datachannel/workflows/Build%20-%20Linux/badge.svg) ![Windows CI Build](https://github.com/murat-dogan/node-datachannel/workflows/Build%20-%20Win/badge.svg) ![Mac x64 CI Build](https://github.com/murat-dogan/node-datachannel/workflows/Build%20-%20Mac%20x64/badge.svg) ![Mac M1 CI Build](https://github.com/murat-dogan/node-datachannel/workflows/Build%20-%20Mac%20M1/badge.svg)
 
-- Easy to use
-- Lightweight
-  - No need to deal with WebRTC stack!
-  - Small binary sizes
-- Type infos for Typescript
+-   Easy to use
+-   Lightweight
+    -   No need to deal with WebRTC stack!
+    -   Small binary sizes
+-   Type infos for Typescript
 
 This project is NodeJS bindings for [libdatachannel](https://github.com/paullouisageneau/libdatachannel) library.
 
@@ -20,70 +20,71 @@ npm install node-datachannel
 
 ## Supported Platforms
 
-|          | 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 |     +     |      +      |      +           |      +      |      +      |       +        |
-| Node V19 |     +     |      +      |      +           |      +      |      +      |       +        |
-| Node V20 |     +     |      +      |      +           |      +      |      +      |       +        |
+`node-datachannel` targets N-API version 8 and supports NodeJS v16 and above. It is tested on Linux, Windows and MacOS. For N-API compatibility please check [here](https://nodejs.org/api/n-api.html#n_api_n_api_version_matrix).
 
-1) Please note that; For Linux-arm64 platform we need OpenSSL to be installed locally.
+|          | Linux-x64 | Linux-armv7 | Linux-arm64(1) | Windows-x86 | Windows-x64 | Mac (M1 + x64) |
+| -------- | :-------: | :---------: | :------------: | :---------: | :---------: | :------------: |
+| Node V16 |     +     |      +      |       +        |      +      |      +      |       +        |
+| Node V17 |     +     |      +      |       +        |      +      |      +      |       +        |
+| Node V18 |     +     |      +      |       +        |      +      |      +      |       +        |
+| Node V19 |     +     |      +      |       +        |      +      |      +      |       +        |
+| Node V20 |     +     |      +      |       +        |      +      |      +      |       +        |
 
+1. Please note that; For Linux-arm64 platform we need OpenSSL to be installed locally.
+
+## Electron
+
+`node-datachannel` supports Electron.
+
+Please check [electron demo](/examples/electron-demo)
 
 ## Example Usage
 
 ```js
-const nodeDataChannel = require('node-datachannel');
+import nodeDataChannel from 'node-datachannel';
 
 // Log Level
-nodeDataChannel.initLogger("Debug");
+nodeDataChannel.initLogger('Debug');
 
 let dc1 = null;
 let dc2 = null;
 
-let peer1 = new nodeDataChannel.PeerConnection("Peer1", { iceServers: ["stun:stun.l.google.com:19302"] });
+let peer1 = new nodeDataChannel.PeerConnection('Peer1', { iceServers: ['stun:stun.l.google.com:19302'] });
 
 // Set Callbacks
 peer1.onLocalDescription((sdp, type) => {
-    console.log("Peer1 SDP:", sdp, " Type:", type);
+    console.log('Peer1 SDP:', sdp, ' Type:', type);
     peer2.setRemoteDescription(sdp, type);
 });
 peer1.onLocalCandidate((candidate, mid) => {
-    console.log("Peer1 Candidate:", candidate);
+    console.log('Peer1 Candidate:', candidate);
     peer2.addRemoteCandidate(candidate, mid);
 });
 
-let peer2 = new nodeDataChannel.PeerConnection("Peer2", { iceServers: ["stun:stun.l.google.com:19302"] });
+let peer2 = new nodeDataChannel.PeerConnection('Peer2', { iceServers: ['stun:stun.l.google.com:19302'] });
 
 // Set Callbacks
 peer2.onLocalDescription((sdp, type) => {
-    console.log("Peer2 SDP:", sdp, " Type:", type);
+    console.log('Peer2 SDP:', sdp, ' Type:', type);
     peer1.setRemoteDescription(sdp, type);
 });
 peer2.onLocalCandidate((candidate, mid) => {
-    console.log("Peer2 Candidate:", candidate);
+    console.log('Peer2 Candidate:', candidate);
     peer1.addRemoteCandidate(candidate, mid);
 });
 peer2.onDataChannel((dc) => {
-    console.log("Peer2 Got DataChannel: ", dc.getLabel());
+    console.log('Peer2 Got DataChannel: ', dc.getLabel());
     dc2 = dc;
     dc2.onMessage((msg) => {
         console.log('Peer2 Received Msg:', msg);
     });
-    dc2.sendMessage("Hello From Peer2");
+    dc2.sendMessage('Hello From Peer2');
 });
 
-dc1 = peer1.createDataChannel("test");
+dc1 = peer1.createDataChannel('test');
 
 dc1.onOpen(() => {
-    dc1.sendMessage("Hello from Peer1");
+    dc1.sendMessage('Hello from Peer1');
 });
 
 dc1.onMessage((msg) => {
@@ -99,13 +100,17 @@ setTimeout(() => {
 }, 10 * 1000);
 ```
 
+## WebRTC Polyfills
+
+Please check [here](/polyfill)
+
 ## Test
+
 ```sh
 npm run test                  # Unit tests
 node test/connectivity.js     # Connectivity
 ```
 
-
 ## Build
 
 Please check [here](/BULDING.md)
@@ -121,4 +126,3 @@ Please check [docs](/API.md) page
 ## Thanks
 
 Thanks to [Streamr](https://streamr.network/) for supporting this project by being a Sponsor!
-

package/cmake/toolchain/arm64.cmake

@@ -14,4 +14,4 @@ set(CMAKE_FIND_ROOT_PATH_MODE_LIBRARY ONLY)
 set(CMAKE_FIND_ROOT_PATH_MODE_INCLUDE ONLY)
 
 set(CMAKE_C_FLAGS "-march=armv8-a -fPIC -Wno-error=format-truncation" CACHE STRING "Compiler Flags")
-set(CMAKE_CXX_FLAGS "${CMAKE_C_FLAGS}" CACHE STRING "Compiler Flags")
+set(CMAKE_CXX_FLAGS "${CMAKE_C_FLAGS}" CACHE STRING "Compiler Flags")

package/examples/client-server/README.md

@@ -0,0 +1,22 @@
+# client-server Example
+
+-   You can use client-server example project to test WebRTC Data Channels with WebSocket signaling.
+-   It uses same logic of [libdatachannel/examples/client](https://github.com/paullouisageneau/libdatachannel/tree/master/examples) project.
+-   Contains an equivalent implementation for a node.js signaling server
+
+## How to Use?
+
+-   Prepare Project
+    -   cd examples/client-server
+    -   npm i
+-   Start ws signaling server;
+    -   node signaling-server.js
+-   Start answerer (On a new Console);
+    -   node client.js
+    -   Note local ID
+-   Start Offerer (On a new Console);
+
+    -   node client.js
+    -   Enter answerer ID
+
+    > You can also use [libdatachannel/examples/client](https://github.com/paullouisageneau/libdatachannel/tree/master/examples) project's client & signaling server

package/examples/client-server/client-benchmark.js

@@ -1,12 +1,17 @@
-/* eslint-disable @typescript-eslint/no-var-requires */
+// createRequire is native in node version >= 12
+import { createRequire } from 'module';
+const require = createRequire(import.meta.url);
+
+// yargs down not supports ES Modules
 const yargs = require('yargs/yargs');
 const { hideBin } = require('yargs/helpers');
-const nodeDataChannel = require('../../lib/index');
-const WebSocket = require('ws');
-const readline = require('readline');
+
+import WebSocket from 'ws';
+import readline from 'readline';
+import nodeDataChannel from '../../lib/index.js';
 
 // Init Logger
-nodeDataChannel.initLogger('Debug');
+nodeDataChannel.initLogger('Info');
 
 // PeerConnection Map
 const pcMap = {};
@@ -72,7 +77,7 @@ ws.on('error', (err) => {
 });
 
 ws.on('message', (msgStr) => {
-    msg = JSON.parse(msgStr);
+    let msg = JSON.parse(msgStr);
     switch (msg.type) {
         case 'offer':
             createPeerConnection(msg.id);

package/examples/client-server/client-periodic.js

@@ -1,10 +1,9 @@
-/* eslint-disable @typescript-eslint/no-var-requires */
-const nodeDataChannel = require('../../lib/index');
-const WebSocket = require('ws');
-const readline = require('readline');
+import WebSocket from 'ws';
+import readline from 'readline';
+import nodeDataChannel from '../../lib/index.js';
 
 // Init Logger
-nodeDataChannel.initLogger('Debug');
+nodeDataChannel.initLogger('Info');
 
 // PeerConnection Map
 const pcMap = {};
@@ -43,7 +42,7 @@ ws.on('error', (err) => {
 });
 
 ws.on('message', (msgStr) => {
-    msg = JSON.parse(msgStr);
+    let msg = JSON.parse(msgStr);
     switch (msg.type) {
         case 'offer':
             createPeerConnection(msg.id);

package/examples/client-server/client.js

@@ -1,7 +1,6 @@
-/* eslint-disable @typescript-eslint/no-var-requires */
-const nodeDataChannel = require('../../lib/index');
-const WebSocket = require('ws');
-const readline = require('readline');
+import WebSocket from 'ws';
+import readline from 'readline';
+import nodeDataChannel from '../../lib/index.js';
 
 // Init Logger
 nodeDataChannel.initLogger('Error');
@@ -31,7 +30,7 @@ ws.on('error', (err) => {
 });
 
 ws.on('message', (msgStr) => {
-    msg = JSON.parse(msgStr);
+    let msg = JSON.parse(msgStr);
     switch (msg.type) {
         case 'offer':
             createPeerConnection(msg.id);