node-datachannel 0.10.1 → 0.12.0

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

@@ -25,6 +25,7 @@ jobs:
             libc: musl
             gcc_install: clang lld
             gcc: clang
+            gxx: clang++
           # libc is intentionally not set here, as prebuild-install requires libc to not be set for glibc builds
           - triple: "linux-gnu"
             platform: debian
@@ -43,15 +44,17 @@ jobs:
             arch: arm64
             flags: -march=armv8-a -fPIC
           # Set edge case overrides for specific platform + architecture
-          # also define gcc commands for each architecture 
+          # also define gcc commands for each architecture
           - arch: amd64
             platform: debian
             gcc_install: gcc g++
             gcc: gcc
+            gxx: g++
           - arch: arm64
             platform: debian
             gcc_install: gcc-aarch64-linux-gnu g++-aarch64-linux-gnu
             gcc: aarch64-linux-gnu-gcc
+            gxx: aarch64-linux-gnu-g++
           # debian uses the triple `arm-linux-gnueabihf` instead of alpine's `armv7-alpine-linux-musleabihf`
           # because of this, we explicitly override triple_arch for debian arm
           - triple_arch: arm
@@ -59,6 +62,7 @@ jobs:
             platform: debian
             gcc_install: gcc-arm-linux-gnueabihf g++-arm-linux-gnueabihf
             gcc: arm-linux-gnueabihf-gcc
+            gxx: arm-linux-gnueabihf-g++
 
     steps:
       - uses: actions/checkout@v4
@@ -87,13 +91,14 @@ jobs:
         id: sysroot
         run: echo "sysroot=$(sudo podman image mount ndc-buildroot:${{ matrix.platform }}-${{ matrix.arch }})" >> $GITHUB_OUTPUT
       - name: Build
-        run: sudo --preserve-env=SYSROOT,TRIPLE,COMPILER_FLAGS,LIBC,GCC,CI,PATH node_modules/.bin/prebuild --arch ${{ matrix.node_arch }} -r napi --backend cmake-js -- --CDCMAKE_TOOLCHAIN_FILE:FILEPATH=./cmake/toolchain/ci.cmake
+        run: sudo --preserve-env=SYSROOT,TRIPLE,COMPILER_FLAGS,LIBC,GCC,GXX,CI,PATH node_modules/.bin/prebuild --arch ${{ matrix.node_arch }} -r napi --backend cmake-js -- --CDCMAKE_TOOLCHAIN_FILE:FILEPATH=./cmake/toolchain/ci.cmake
         env:
           SYSROOT: ${{ steps.sysroot.outputs.sysroot }}
           TRIPLE: ${{ matrix.triple_arch }}-${{ matrix.triple }}${{ matrix.triple_postfix }}
           COMPILER_FLAGS: ${{ matrix.flags }}
           LIBC: ${{ matrix.libc }}
           GCC: ${{ matrix.gcc }}
+          GXX: ${{ matrix.gxx }}
           CI: true
       - name: Test
         run: sudo podman run --rm -v $(pwd):/usr/app/ -e CI=true --platform linux/${{ matrix.arch }} -t ndc-buildroot:${{ matrix.platform }}-${{ matrix.arch }} npm run test

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.1)
+project(node_datachannel VERSION 0.12.0)
 
 # -Dnapi_build_version=8
 add_definitions(-DNAPI_VERSION=8)

package/README.md

@@ -1,11 +1,12 @@
-# WebRTC For Node.js and Electron
+# 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)
 
 -   Lightweight
     -   No need to deal with WebRTC stack!
-    -   Small binary sizes (~8MB for Linux X64)
+    -   Small binary sizes (~8MB for Linux x64)
 -   Type infos for Typescript
+-   Integrated WebSocket Client & Server Implementation
 
 This project is Node.js bindings for [libdatachannel](https://github.com/paullouisageneau/libdatachannel) library.
 
@@ -35,7 +36,17 @@ Please check [electron demo](/examples/electron-demo)
 
 WebRTC polyfills to be used for libraries like `simple-peer`.
 
-Please check [here](/polyfill)
+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
 
@@ -45,6 +56,9 @@ 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;
 
@@ -105,7 +119,7 @@ Please check [docs](/API.md) page
 
 ## Contributing
 
-Contributions welcome!
+Contributions are welcome!
 
 ## Thanks
 

package/cmake/toolchain/ci.cmake

@@ -3,7 +3,7 @@ set(triple $ENV{TRIPLE})
 
 # use clang and lld
 set(CMAKE_C_COMPILER $ENV{GCC})
-set(CMAKE_CXX_COMPILER $ENV{GCC})
+set(CMAKE_CXX_COMPILER $ENV{GXX})
 if (CMAKE_C_COMPILER MATCHES clang)
     add_link_options("-fuse-ld=lld")
 endif()

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.