node-datachannel 0.10.0 → 0.11.0

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

@@ -6,25 +6,26 @@ on:
   #   tags:
   #     - v*
 
+
 env:
   ACTIONS_ALLOW_UNSECURE_COMMANDS: true
 
 jobs:
   build-macos:
-    runs-on: macos-11
+    runs-on: macos-13
     strategy:
       matrix:
         node-version: [16.x]
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Install OpenSSL
         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
+          wget https://mac.r-project.org/bin/darwin20/arm64/openssl-1.1.1t-darwin.20-arm64.tar.xz
+          tar -xf openssl-1.1.1t-darwin.20-arm64.tar.xz -C /tmp
+          rm -rf openssl-1.1.1t-darwin.20-arm64.tar.xz
       - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node-version }}
       - name: Build

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

@@ -11,25 +11,25 @@ env:
 
 jobs:
   build-macos:
-    runs-on: macos-11
+    runs-on: macos-13
     strategy:
       matrix:
         node-version: [16.x]
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Install OpenSSL
         run: HOMEBREW_NO_INSTALL_CLEANUP=1 brew reinstall openssl@1.1
       - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node-version }}
       - 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
+          OPENSSL_ROOT_DIR: /usr/local/opt/openssl@1.1
+          OPENSSL_LIBRARIES: /usr/local/opt/openssl@1.1/lib
       - name: Test
         run: npm run test
         env:

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

@@ -17,12 +17,12 @@ jobs:
         node-version: [16.x]
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - uses: ilammy/msvc-dev-cmd@v1
       - name: Install OpenSSL
         run: choco install openssl
       - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node-version }}
       - name: Build
@@ -46,7 +46,7 @@ jobs:
         node_arch:
           - x86
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - uses: ilammy/msvc-dev-cmd@v1
         with:
           arch: x86

package/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "test/wpt-tests/wpt"]
+	path = test/wpt-tests/wpt
+	url = https://github.com/web-platform-tests/wpt.git

package/CMakeLists.txt

@@ -2,7 +2,7 @@ cmake_minimum_required(VERSION 3.15)
 cmake_policy(SET CMP0091 NEW)
 cmake_policy(SET CMP0042 NEW)
 
-project(node_datachannel VERSION 0.10.0)
+project(node_datachannel VERSION 0.11.0)
 
 # -Dnapi_build_version=8
 add_definitions(-DNAPI_VERSION=8)
@@ -29,7 +29,7 @@ include(FetchContent)
 FetchContent_Declare(
     libdatachannel
     GIT_REPOSITORY https://github.com/paullouisageneau/libdatachannel.git
-    GIT_TAG "v0.21.1"
+    GIT_TAG "v0.21.2"
 )
 
 option(NO_MEDIA "Disable media transport support in libdatachannel" OFF)

package/README.md

@@ -1,16 +1,14 @@
-# Easy to use WebRTC data channels and media transport
+# WebRTC For Node.js and Electron ( with WebSocket)
 
 ![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
+    -   Small binary sizes (~8MB for Linux x64)
 -   Type infos for Typescript
+-   Integrated WebSocket Client & Server Implementation
 
-This project is NodeJS bindings for [libdatachannel](https://github.com/paullouisageneau/libdatachannel) library.
-
-Please check [libdatachannel](https://github.com/paullouisageneau/libdatachannel) for Compatibility & WebRTC details.
+This project is Node.js bindings for [libdatachannel](https://github.com/paullouisageneau/libdatachannel) library.
 
 ## Install
 
@@ -20,11 +18,11 @@ npm install node-datachannel
 
 ## Supported Platforms
 
-`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).
+`node-datachannel` targets N-API version 8 and supports Node.js 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).
 
-|                         | Linux [x64,armv7,arm64] (1) | Windows [x86,x64] | Mac [M1,x64] |
-| ----------------------- | :-------------------------: | :---------------: | :----------: |
-| NAPI V8 (>= NodeJS V16) |              +              |         +         |      +       |
+|                           | Linux [x64,armv7,arm64] (1) | Windows [x86,x64] | Mac [M1,x64] |
+| ------------------------- | :-------------------------: | :---------------: | :----------: |
+| N-API v8 (>= Node.js v16) |              +              |         +         |      +       |
 
 **(1)** For Linux musl + libc
 
@@ -34,6 +32,22 @@ npm install node-datachannel
 
 Please check [electron demo](/examples/electron-demo)
 
+## WebRTC Polyfills
+
+WebRTC polyfills to be used for libraries like `simple-peer`.
+
+Please check [here for more](/polyfill)
+
+### web-platform-tests
+
+Please check actual situation [here](/test/wpt-tests/)
+
+## WebSocket Client & Server
+
+Integrated WebSocket Client & Server is available, which can be used separately or for signaling.
+
+For an example usage, [check here](/examples/websocket)
+
 ## Example Usage
 
 ```js
@@ -42,34 +56,30 @@ import nodeDataChannel from 'node-datachannel';
 // Log Level
 nodeDataChannel.initLogger('Debug');
 
+// Integrated WebSocket available and can be used for signaling etc
+// const ws = new nodeDataChannel.WebSocket();
+
 let dc1 = null;
 let dc2 = null;
 
 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);
     peer2.setRemoteDescription(sdp, type);
 });
 peer1.onLocalCandidate((candidate, mid) => {
-    console.log('Peer1 Candidate:', candidate);
     peer2.addRemoteCandidate(candidate, mid);
 });
 
 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);
     peer1.setRemoteDescription(sdp, type);
 });
 peer2.onLocalCandidate((candidate, mid) => {
-    console.log('Peer2 Candidate:', candidate);
     peer1.addRemoteCandidate(candidate, mid);
 });
 peer2.onDataChannel((dc) => {
-    console.log('Peer2 Got DataChannel: ', dc.getLabel());
     dc2 = dc;
     dc2.onMessage((msg) => {
         console.log('Peer2 Received Msg:', msg);
@@ -86,19 +96,11 @@ dc1.onOpen(() => {
 dc1.onMessage((msg) => {
     console.log('Peer1 Received Msg:', msg);
 });
-
-setTimeout(() => {
-    dc1.close();
-    dc2.close();
-    peer1.close();
-    peer2.close();
-    nodeDataChannel.cleanup();
-}, 10 * 1000);
 ```
 
-## WebRTC Polyfills
+## Examples
 
-Please check [here](/polyfill)
+Please check [examples](/examples/) folder
 
 ## Test
 
@@ -111,14 +113,14 @@ node test/connectivity.js     # Connectivity
 
 Please check [here](/BULDING.md)
 
-## Examples
-
-Please check [examples](/examples/) folder
-
 ## API Docs
 
 Please check [docs](/API.md) page
 
+## Contributing
+
+Contributions are welcome!
+
 ## Thanks
 
 Thanks to [Streamr](https://streamr.network/) for supporting this project by being a Sponsor!

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

@@ -6,7 +6,6 @@ const require = createRequire(import.meta.url);
 const yargs = require('yargs/yargs');
 const { hideBin } = require('yargs/helpers');
 
-import WebSocket from 'ws';
 import readline from 'readline';
 import nodeDataChannel from '../../lib/index.js';
 
@@ -60,23 +59,22 @@ const rl = readline.createInterface({
     output: process.stdout,
 });
 
-const ws = new WebSocket(wsUrl + '/' + id, {
-    perMessageDeflate: false,
-});
+const ws = new nodeDataChannel.WebSocket();
+ws.open(wsUrl + '/' + id);
 
 console.log(`The local ID is: ${id}`);
 console.log(`Waiting for signaling to be connected...`);
 
-ws.on('open', () => {
+ws.onOpen(() => {
     console.log('WebSocket connected, signaling ready');
     readUserInput();
 });
 
-ws.on('error', (err) => {
+ws.onError((err) => {
     console.log('WebSocket Error: ', err);
 });
 
-ws.on('message', (msgStr) => {
+ws.onMessage((msgStr) => {
     let msg = JSON.parse(msgStr);
     switch (msg.type) {
         case 'offer':
@@ -184,10 +182,10 @@ function createPeerConnection(peerId) {
         console.log('GatheringState: ', state);
     });
     peerConnection.onLocalDescription((description, type) => {
-        ws.send(JSON.stringify({ id: peerId, type, description }));
+        ws.sendMessage(JSON.stringify({ id: peerId, type, description }));
     });
     peerConnection.onLocalCandidate((candidate, mid) => {
-        ws.send(JSON.stringify({ id: peerId, type: 'candidate', candidate, mid }));
+        ws.sendMessage(JSON.stringify({ id: peerId, type: 'candidate', candidate, mid }));
     });
     peerConnection.onDataChannel((dc) => {
         rl.close();

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

@@ -1,4 +1,3 @@
-import WebSocket from 'ws';
 import readline from 'readline';
 import nodeDataChannel from '../../lib/index.js';
 
@@ -25,23 +24,22 @@ const rl = readline.createInterface({
 
 // Signaling Server
 const WS_URL = process.env.WS_URL || 'ws://localhost:8000';
-const ws = new WebSocket(WS_URL + '/' + id, {
-    perMessageDeflate: false,
-});
+const ws = new nodeDataChannel.WebSocket();
+ws.open(WS_URL + '/' + id);
 
 console.log(`The local ID is: ${id}`);
 console.log(`Waiting for signaling to be connected...`);
 
-ws.on('open', () => {
+ws.onOpen(() => {
     console.log('WebSocket connected, signaling ready');
     readUserInput();
 });
 
-ws.on('error', (err) => {
+ws.onError((err) => {
     console.log('WebSocket Error: ', err);
 });
 
-ws.on('message', (msgStr) => {
+ws.onMessage((msgStr) => {
     let msg = JSON.parse(msgStr);
     switch (msg.type) {
         case 'offer':
@@ -122,10 +120,10 @@ function createPeerConnection(peerId) {
         console.log('GatheringState: ', state);
     });
     peerConnection.onLocalDescription((description, type) => {
-        ws.send(JSON.stringify({ id: peerId, type, description }));
+        ws.sendMessage(JSON.stringify({ id: peerId, type, description }));
     });
     peerConnection.onLocalCandidate((candidate, mid) => {
-        ws.send(JSON.stringify({ id: peerId, type: 'candidate', candidate, mid }));
+        ws.sendMessage(JSON.stringify({ id: peerId, type: 'candidate', candidate, mid }));
     });
     peerConnection.onDataChannel((dc) => {
         rl.close();

package/examples/client-server/client.js

@@ -1,4 +1,3 @@
-import WebSocket from 'ws';
 import readline from 'readline';
 import nodeDataChannel from '../../lib/index.js';
 
@@ -13,23 +12,22 @@ const id = randomId(4);
 
 // Signaling Server
 const WS_URL = process.env.WS_URL || 'ws://localhost:8000';
-const ws = new WebSocket(WS_URL + '/' + id, {
-    perMessageDeflate: false,
-});
+const ws = new nodeDataChannel.WebSocket();
+ws.open(WS_URL + '/' + id);
 
 console.log(`The local ID is: ${id}`);
 console.log(`Waiting for signaling to be connected...`);
 
-ws.on('open', () => {
+ws.onOpen(() => {
     console.log('WebSocket connected, signaling ready');
     readUserInput();
 });
 
-ws.on('error', (err) => {
+ws.onError((err) => {
     console.log('WebSocket Error: ', err);
 });
 
-ws.on('message', (msgStr) => {
+ws.onMessage((msgStr) => {
     let msg = JSON.parse(msgStr);
     switch (msg.type) {
         case 'offer':
@@ -86,10 +84,10 @@ function createPeerConnection(peerId) {
         console.log('GatheringState: ', state);
     });
     peerConnection.onLocalDescription((description, type) => {
-        ws.send(JSON.stringify({ id: peerId, type, description }));
+        ws.sendMessage(JSON.stringify({ id: peerId, type, description }));
     });
     peerConnection.onLocalCandidate((candidate, mid) => {
-        ws.send(JSON.stringify({ id: peerId, type: 'candidate', candidate, mid }));
+        ws.sendMessage(JSON.stringify({ id: peerId, type: 'candidate', candidate, mid }));
     });
     peerConnection.onDataChannel((dc) => {
         console.log('DataChannel from ' + peerId + ' received with label "', dc.getLabel() + '"');

package/examples/client-server/package-lock.json

@@ -9,7 +9,6 @@
             "version": "1.0.0",
             "license": "ISC",
             "dependencies": {
-                "ws": "^7.5.3",
                 "yargs": "^16.2.0"
             }
         },
@@ -138,26 +137,6 @@
                 "url": "https://github.com/chalk/wrap-ansi?sponsor=1"
             }
         },
-        "node_modules/ws": {
-            "version": "7.5.10",
-            "resolved": "https://registry.npmjs.org/ws/-/ws-7.5.10.tgz",
-            "integrity": "sha512-+dbF1tHwZpXcbOJdVOkzLDxZP1ailvSxM6ZweXTegylPny803bFhA+vqBYw4s31NSAk4S2Qz+AKXK9a4wkdjcQ==",
-            "engines": {
-                "node": ">=8.3.0"
-            },
-            "peerDependencies": {
-                "bufferutil": "^4.0.1",
-                "utf-8-validate": "^5.0.2"
-            },
-            "peerDependenciesMeta": {
-                "bufferutil": {
-                    "optional": true
-                },
-                "utf-8-validate": {
-                    "optional": true
-                }
-            }
-        },
         "node_modules/y18n": {
             "version": "5.0.8",
             "resolved": "https://registry.npmjs.org/y18n/-/y18n-5.0.8.tgz",
@@ -282,12 +261,6 @@
                 "strip-ansi": "^6.0.0"
             }
         },
-        "ws": {
-            "version": "7.5.10",
-            "resolved": "https://registry.npmjs.org/ws/-/ws-7.5.10.tgz",
-            "integrity": "sha512-+dbF1tHwZpXcbOJdVOkzLDxZP1ailvSxM6ZweXTegylPny803bFhA+vqBYw4s31NSAk4S2Qz+AKXK9a4wkdjcQ==",
-            "requires": {}
-        },
         "y18n": {
             "version": "5.0.8",
             "resolved": "https://registry.npmjs.org/y18n/-/y18n-5.0.8.tgz",

package/examples/client-server/package.json

@@ -11,7 +11,6 @@
     "author": "",
     "license": "ISC",
     "dependencies": {
-        "ws": "^7.5.3",
         "yargs": "^16.2.0"
     }
 }

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

@@ -1,15 +1,22 @@
-import WebSocket from 'ws';
+import nodeDataChannel from '../../lib/index.js';
+
+// Init Logger
+nodeDataChannel.initLogger('Debug');
 
 const clients = {};
 
-const wss = new WebSocket.Server({ port: 8000 });
+const wsServer = new nodeDataChannel.WebSocketServer({ bindAddress: '127.0.0.1', port: 8000 });
+
+wsServer.onClient((ws) => {
+    let id = '';
 
-wss.on('connection', (ws, req) => {
-    const id = req.url.replace('/', '');
-    console.log(`New Connection from ${id}`);
+    ws.onOpen(() => {
+        id = ws.path().replace('/', '');
+        console.log(`New Connection from ${id}`);
+        clients[id] = ws;
+    });
 
-    clients[id] = ws;
-    ws.on('message', (buffer) => {
+    ws.onMessage((buffer) => {
         let msg = JSON.parse(buffer);
         let peerId = msg.id;
         let peerWs = clients[peerId];
@@ -18,11 +25,15 @@ wss.on('connection', (ws, req) => {
         if (!peerWs) return console.error(`Can not find peer with ID ${peerId}`);
 
         msg.id = id;
-        peerWs.send(JSON.stringify(msg));
+        peerWs.sendMessage(JSON.stringify(msg));
     });
 
-    ws.on('close', () => {
-        console.log(`${id} disconected`);
+    ws.onClosed(() => {
+        console.log(`${id} disconnected`);
         delete clients[id];
     });
+
+    ws.onError((err) => {
+        console.error(err);
+    });
 });

package/examples/electron-demo/README.md

@@ -6,7 +6,7 @@ Project created with
 
 ## Electron Compatibility and Rebuilding
 
-`node-datachannel` uses N-API for creating binaries. Normally `electron` is compatible with N-API binarıes, so you should not need to rebuild the binaries.
+`node-datachannel` uses N-API for creating binaries. Normally `electron` is compatible with N-API binaries, so you should not need to rebuild the binaries.
 
 ### If you need anyway, you can use `electron-rebuild` package with some modifications.
 

package/examples/websocket/websocket-client.js

@@ -0,0 +1,20 @@
+import * as nodeDataChannel from '../../lib/index.js';
+
+const clientSocket = new nodeDataChannel.WebSocket();
+
+clientSocket.open('ws://127.0.0.1:3000');
+
+clientSocket.onOpen(() => {
+    console.log('Client socket opened');
+    clientSocket.sendMessage('Echo this!');
+});
+
+clientSocket.onMessage((message) => {
+    console.log('Message from server: ' + message);
+});
+
+clientSocket.onClosed(() => {
+    console.log('Client socket closed');
+});
+
+// clientSocket.close();

package/examples/websocket/websocket-server.js

@@ -0,0 +1,22 @@
+import * as nodeDataChannel from '../../lib/index.js';
+
+const ws = new nodeDataChannel.WebSocketServer({ bindAddress: '127.0.0.1', port: 3000 });
+
+ws.onClient((clientSocket) => {
+    clientSocket.onOpen(() => {
+        console.log('Client socket opened');
+        clientSocket.sendMessage('Hello from server');
+    });
+
+    clientSocket.onMessage((message) => {
+        console.log('Message from client: ' + message);
+        clientSocket.sendMessage(message);
+    });
+
+    clientSocket.onClosed(() => {
+        console.log('Client socket closed');
+    });
+});
+
+// When done, close the server
+// ws.stop();

package/lib/index.cjs

@@ -4,8 +4,14 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var module$1 = require('module');
 var stream = require('stream');
+var events = require('events');
 
 var _documentCurrentScript = typeof document !== 'undefined' ? document.currentScript : null;
+// createRequire is native in node version >= 12
+const require$1 = module$1.createRequire((typeof document === 'undefined' ? require('u' + 'rl').pathToFileURL(__filename).href : (_documentCurrentScript && _documentCurrentScript.src || new URL('index.cjs', document.baseURI).href)));
+
+const nodeDataChannel = require$1('../build/Release/node_datachannel.node');
+
 /**
  * Turns a node-datachannel DataChannel into a real Node.js stream, complete with buffering,
  * backpressure (up to a point - if the buffer fills up, messages are dropped), and
@@ -101,10 +107,37 @@ class DataChannelStream extends stream.Duplex {
     }
 }
 
-// createRequire is native in node version >= 12
-const require$1 = module$1.createRequire((typeof document === 'undefined' ? require('u' + 'rl').pathToFileURL(__filename).href : (_documentCurrentScript && _documentCurrentScript.src || new URL('index.cjs', document.baseURI).href)));
+class WebSocketServer extends events.EventEmitter {
+    #server;
+    #clients = [];
 
-const nodeDataChannel = require$1('../build/Release/node_datachannel.node');
+    constructor(options) {
+        super();
+        this.#server = new nodeDataChannel.WebSocketServer(options);
+
+        this.#server.onClient((client) => {
+            this.emit('client', client);
+            this.#clients.push(client);
+        });
+    }
+
+    port() {
+        return this.#server?.port() || 0;
+    }
+
+    stop() {
+        this.#clients.forEach((client) => {
+            client?.close();
+        });
+        this.#server?.stop();
+        this.#server = null;
+        this.removeAllListeners();
+    }
+
+    onClient(cb) {
+        if (this.#server) this.on('client', cb);
+    }
+}
 
 const {
     initLogger,
@@ -118,14 +151,8 @@ const {
     DataChannel,
     PeerConnection,
     WebSocket,
-    WebSocketServer,
 } = nodeDataChannel;
 
-var index = {
-    ...nodeDataChannel,
-    DataChannelStream,
-};
-
 const DescriptionType = {
     Unspec: 'unspec',
     Offer: 'offer',
@@ -134,6 +161,22 @@ const DescriptionType = {
     Rollback: 'rollback',
 };
 
+var index = {
+    initLogger,
+    cleanup,
+    preload,
+    setSctpSettings,
+    RtcpReceivingSession,
+    Track,
+    Video,
+    Audio,
+    DataChannel,
+    PeerConnection,
+    WebSocket,
+    WebSocketServer,
+    DataChannelStream,
+};
+
 exports.Audio = Audio;
 exports.DataChannel = DataChannel;
 exports.DataChannelStream = DataChannelStream;