node-datachannel 0.5.5 → 0.7.0

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

@@ -76,8 +76,8 @@ jobs:
           sudo apt update
           sudo apt install -y g++-aarch64-linux-gnu gcc-aarch64-linux-gnu
           mkdir sysroot && cd sysroot
-          wget https://commondatastorage.googleapis.com/chrome-linux-sysroot/toolchain/953c2471bc7e71a788309f6c2d2003e8b703305d/debian_sid_arm64_sysroot.tar.xz
-          tar xf debian_sid_arm64_sysroot.tar.xz
+          wget https://commondatastorage.googleapis.com/chrome-linux-sysroot/toolchain/41a6c8dec4c4304d6509e30cbaf9218dffb4438e/debian_bullseye_arm64_sysroot.tar.xz
+          tar xf debian_bullseye_arm64_sysroot.tar.xz
           echo "ARM64_SYSROOT=$(pwd)" >> $GITHUB_ENV
           ls -l
       - name: Use Node.js ${{ matrix.node-version }}

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.5.5)
+project(node_datachannel VERSION 0.7.0)
 
 # -Dnapi_build_version=8
 add_definitions(-DNAPI_VERSION=8)
@@ -20,14 +20,8 @@ if(CMAKE_HOST_SYSTEM_NAME STREQUAL "Android")
     set(CMAKE_C_FLAGS "-Wno-error=unused-but-set-variable -Wno-error=strict-prototypes")
 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)
-endif()
+set(OPENSSL_USE_STATIC_LIBS TRUE)
+find_package(OpenSSL REQUIRED)
 
 include(FetchContent)
 
@@ -39,7 +33,7 @@ FetchContent_Declare(
 )
 
 option(NO_MEDIA "Disable media transport support in libdatachannel" OFF)
-option(NO_WEBSOCKET "Disable WebSocket support in libdatachannel" ON)
+option(NO_WEBSOCKET "Disable WebSocket support in libdatachannel" OFF)
 
 FetchContent_GetProperties(libdatachannel)
 
@@ -58,6 +52,8 @@ add_library(${PROJECT_NAME} SHARED
     src/data-channel-wrapper.cpp
     src/peer-connection-wrapper.cpp
     src/thread-safe-callback.cpp
+    src/web-socket-wrapper.cpp
+    src/web-socket-server-wrapper.cpp
     src/main.cpp
     ${CMAKE_JS_SRC}
 )

package/examples/electron-demo/package-lock.json

@@ -3832,9 +3832,9 @@
             }
         },
         "node_modules/follow-redirects": {
-            "version": "1.15.4",
-            "resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.15.4.tgz",
-            "integrity": "sha512-Cr4D/5wlrb0z9dgERpUL3LrmPKVDsETIJhaCMeDfuFYcqa5bldGV6wBsAN6X/vxlXQtFBMrXdXxdL8CbDTGniw==",
+            "version": "1.15.6",
+            "resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.15.6.tgz",
+            "integrity": "sha512-wWN62YITEaOpSK584EZXJafH1AGpO8RVgElfkuXbTOrPX4fIfOyEpW/CsiNd8JdYrAoOvafRTOEnvsO++qCqFA==",
             "dev": true,
             "funding": [
                 {
@@ -11877,9 +11877,9 @@
             }
         },
         "follow-redirects": {
-            "version": "1.15.4",
-            "resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.15.4.tgz",
-            "integrity": "sha512-Cr4D/5wlrb0z9dgERpUL3LrmPKVDsETIJhaCMeDfuFYcqa5bldGV6wBsAN6X/vxlXQtFBMrXdXxdL8CbDTGniw==",
+            "version": "1.15.6",
+            "resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.15.6.tgz",
+            "integrity": "sha512-wWN62YITEaOpSK584EZXJafH1AGpO8RVgElfkuXbTOrPX4fIfOyEpW/CsiNd8JdYrAoOvafRTOEnvsO++qCqFA==",
             "dev": true
         },
         "foreground-child": {

package/examples/media/README.md

@@ -20,3 +20,15 @@ Use the following gstreamer demo pipeline to display the traffic
 ```
 $ gst-launch-1.0 udpsrc address=127.0.0.1 port=5000 caps="application/x-rtp" ! queue ! rtph264depay ! video/x-h264,stream-format=byte-stream ! queue ! avdec_h264 ! queue ! autovideosink
 ```
+
+For saving the stream to a file, use the following pipeline (mp4):
+
+```
+gst-launch-1.0 -e udpsrc address=127.0.0.1 port=5000 caps="application/x-rtp" ! queue ! rtph264depay ! h264parse ! mp4mux ! filesink location=out.mp4
+```
+
+## Requirements
+
+-   GStreamer 1.0
+-   gstreamer1.0-libav (sudo apt-get install gstreamer1.0-libav)
+-   h264enc (sudo apt-get install h264enc)

package/jest.config.cjs

@@ -0,0 +1,7 @@
+/** @type {import('jest').Config} */
+const config = {
+    verbose: true,
+    testPathIgnorePatterns: ['<rootDir>/node_modules/', 'multiple-run.test'],
+};
+
+module.exports = config;

package/lib/index.cjs

@@ -0,0 +1,142 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var module$1 = require('module');
+var stream = require('stream');
+
+var _documentCurrentScript = typeof document !== 'undefined' ? document.currentScript : null;
+/**
+ * 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
+ * support for piping data elsewhere.
+ *
+ * Read & written data may be either UTF-8 strings or Buffers - this difference exists at
+ * the protocol level, and is preserved here throughout.
+ */
+class DataChannelStream extends stream.Duplex {
+    constructor(rawChannel, streamOptions) {
+        super({
+            allowHalfOpen: false, // Default to autoclose on end().
+            ...streamOptions,
+            objectMode: true, // Preserve the string/buffer distinction (WebRTC treats them differently)
+        });
+
+        this._rawChannel = rawChannel;
+        this._readActive = true;
+
+        rawChannel.onMessage((msg) => {
+            if (!this._readActive) return; // If the buffer is full, drop messages.
+
+            // If the push is rejected, we pause reading until the next call to _read().
+            this._readActive = this.push(msg);
+        });
+
+        // When the DataChannel closes, the readable & writable ends close
+        rawChannel.onClosed(() => {
+            this.push(null);
+            this.destroy();
+        });
+
+        rawChannel.onError((errMsg) => {
+            this.destroy(new Error(`DataChannel error: ${errMsg}`));
+        });
+
+        // Buffer all writes until the DataChannel opens
+        if (!rawChannel.isOpen()) {
+            this.cork();
+            rawChannel.onOpen(() => this.uncork());
+        }
+    }
+
+    _read() {
+        // Stop dropping messages, if the buffer filling up meant we were doing so before.
+        this._readActive = true;
+    }
+
+    _write(chunk, encoding, callback) {
+        let sentOk;
+
+        try {
+            if (Buffer.isBuffer(chunk)) {
+                sentOk = this._rawChannel.sendMessageBinary(chunk);
+            } else if (typeof chunk === 'string') {
+                sentOk = this._rawChannel.sendMessage(chunk);
+            } else {
+                const typeName = chunk.constructor.name || typeof chunk;
+                throw new Error(`Cannot write ${typeName} to DataChannel stream`);
+            }
+        } catch (err) {
+            return callback(err);
+        }
+
+        if (sentOk) {
+            callback(null);
+        } else {
+            callback(new Error('Failed to write to DataChannel'));
+        }
+    }
+
+    _final(callback) {
+        if (!this.allowHalfOpen) this.destroy();
+        callback(null);
+    }
+
+    _destroy(maybeErr, callback) {
+        // When the stream is destroyed, we close the DataChannel.
+        this._rawChannel.close();
+        callback(maybeErr);
+    }
+
+    get label() {
+        return this._rawChannel.getLabel();
+    }
+
+    get id() {
+        return this._rawChannel.getId();
+    }
+
+    get protocol() {
+        return this._rawChannel.getProtocol();
+    }
+}
+
+// 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');
+
+const {
+    initLogger,
+    cleanup,
+    preload,
+    setSctpSettings,
+    RtcpReceivingSession,
+    Track,
+    Video,
+    Audio,
+    DataChannel,
+    PeerConnection,
+    WebSocket,
+    WebSocketServer,
+} = nodeDataChannel;
+
+var index = {
+    ...nodeDataChannel,
+    DataChannelStream,
+};
+
+exports.Audio = Audio;
+exports.DataChannel = DataChannel;
+exports.DataChannelStream = DataChannelStream;
+exports.PeerConnection = PeerConnection;
+exports.RtcpReceivingSession = RtcpReceivingSession;
+exports.Track = Track;
+exports.Video = Video;
+exports.WebSocket = WebSocket;
+exports.WebSocketServer = WebSocketServer;
+exports.cleanup = cleanup;
+exports.default = index;
+exports.initLogger = initLogger;
+exports.preload = preload;
+exports.setSctpSettings = setSctpSettings;

package/lib/index.d.ts

@@ -189,11 +189,58 @@ export class Track {
     onMessage(cb: (msg: Buffer) => void): void;
 }
 
-export class DataChannel {
+export interface Channel {
     close(): void;
+    sendMessage(msg: string): boolean;
+    sendMessageBinary(buffer: Uint8Array): boolean;
+    isOpen(): boolean;
+    bufferedAmount(): number;
+    maxMessageSize(): number;
+    setBufferedAmountLowThreshold(newSize: number): void;
+    onOpen(cb: () => void): void;
+    onClosed(cb: () => void): void;
+    onError(cb: (err: string) => void): void;
+    onBufferedAmountLow(cb: () => void): void;
+    onMessage(cb: (msg: string | Buffer) => void): void;
+}
+export class DataChannel implements Channel {
     getLabel(): string;
     getId(): number;
     getProtocol(): string;
+
+    // Channel implementation
+    close(): void;
+    sendMessage(msg: string): boolean;
+    sendMessageBinary(buffer: Uint8Array): boolean;
+    isOpen(): boolean;
+    bufferedAmount(): number;
+    maxMessageSize(): number;
+    setBufferedAmountLowThreshold(newSize: number): void;
+    onOpen(cb: () => void): void;
+    onClosed(cb: () => void): void;
+    onError(cb: (err: string) => void): void;
+    onBufferedAmountLow(cb: () => void): void;
+    onMessage(cb: (msg: string | Buffer) => void): void;
+}
+
+export interface WebSocketConfiguration {
+    disableTlsVerification?: boolean; // default = false, if true, don't verify the TLS certificate
+    proxyServer?: ProxyServer; // only non-authenticated http supported for now
+    protocols?: string[];
+    connectionTimeout?: number; // miliseconds, zero to disable
+    pingInterval?: number; // millisecondrs, zero to disable
+    maxOutstandingPings?: number;
+    caCertificatePemFile?: string;
+    certificatePemFile?: string;
+    keyPemFile?: string;
+    keyPemPass?: string;
+    maxMessageSize: number;
+}
+export class WebSocket implements Channel {
+    constructor(config?: WebSocketConfiguration);
+
+    // Channel implementation
+    close(): void;
     sendMessage(msg: string): boolean;
     sendMessageBinary(buffer: Uint8Array): boolean;
     isOpen(): boolean;
@@ -207,10 +254,27 @@ export class DataChannel {
     onMessage(cb: (msg: string | Buffer) => void): void;
 }
 
+export interface WebSocketServerConfiguration {
+    port?: number; // default 8080
+    enableTls?: boolean; // default = false;
+    certificatePemFile?: string;
+    keyPemFile?: string;
+    keyPemPass?: string;
+    bindAddress?: string;
+    connectionTimeout?: number; // milliseconds
+    maxMessageSize?: number;
+}
+
+export class WebSocketServer {
+    constructor(config?: WebSocketServerConfiguration);
+    port(): number;
+    stop(): void;
+    onClient(cb: (ws: WebSocket) => void): void;
+}
+
 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/lib/index.js

@@ -16,6 +16,8 @@ const {
     Audio,
     DataChannel,
     PeerConnection,
+    WebSocket,
+    WebSocketServer,
 } = nodeDataChannel;
 
 export {
@@ -29,6 +31,8 @@ export {
     Audio,
     DataChannel,
     PeerConnection,
+    WebSocket,
+    WebSocketServer,
     // Extra exports
     DataChannelStream,
 };

package/package.json

@@ -1,11 +1,17 @@
 {
     "name": "node-datachannel",
-    "version": "0.5.5",
+    "version": "0.7.0",
     "description": "libdatachannel node bindings",
     "type": "module",
     "exports": {
-        ".": "./lib/index.js",
-        "./polyfill": "./polyfill/index.js"
+        ".": {
+            "import": "./lib/index.js",
+            "require": "./lib/index.cjs"
+        },
+        "./polyfill": {
+            "import": "./polyfill/index.js",
+            "require": "./polyfill/polyfill.cjs"
+        }
     },
     "typings": "lib/index.d.ts",
     "engines": {
@@ -27,7 +33,8 @@
         "lint": "eslint lib/**/* test/**/*",
         "test": "NODE_OPTIONS=--experimental-vm-modules jest",
         "wpt-test": "node test/wpt.js",
-        "test-types": "tsc"
+        "test-types": "tsc",
+        "prepublishOnly": "rollup lib/index.js --file lib/index.cjs --format cjs && rollup polyfill/index.js --file polyfill/polyfill.cjs --format cjs"
     },
     "binary": {
         "napi_versions": [
@@ -44,7 +51,8 @@
         "p2p",
         "peer-to-peer",
         "datachannel",
-        "data channel"
+        "data channel",
+        "websocket"
     ],
     "contributors": [
         {
@@ -77,6 +85,7 @@
     },
     "dependencies": {
         "node-domexception": "^2.0.1",
-        "prebuild-install": "^7.0.1"
+        "prebuild-install": "^7.0.1",
+        "rollup": "^4.14.1"
     }
 }

package/polyfill/RTCPeerConnection.js

@@ -222,7 +222,6 @@ export default class _RTCPeerConnection extends EventTarget {
         });
 
         this.#peerConnection.close();
-        this.#peerConnection.destroy();
     }
 
     createAnswer() {