node-datachannel 0.2.4 → 0.3.2

package/.editorconfig

@@ -0,0 +1,12 @@
+# EditorConfig helps developers define and maintain consistent
+# coding styles between different editors and IDEs
+# http://editorconfig.org
+
+root = true
+
+[*]
+indent_style = space
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true

package/.eslintignore

@@ -0,0 +1,2 @@
+node_modules
+build

package/.eslintrc.js

@@ -0,0 +1,8 @@
+module.exports = {
+    parser: '@typescript-eslint/parser',
+    plugins: ['@typescript-eslint'],
+    extends: ['plugin:@typescript-eslint/recommended', 'plugin:prettier/recommended'],
+    env: {
+        node: true,
+    },
+};

package/.github/FUNDING.yml

@@ -0,0 +1,2 @@
+# These are supported funding model platforms
+open_collective: node-datachannel

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

@@ -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]
+        node-version: [10.x, 11.x, 12.x, 13.x, 14.x, 15.x, 16.x, 17.x]
 
     steps:
       - uses: actions/checkout@v2
@@ -40,7 +40,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [10.x, 11.x, 12.x, 13.x, 14.x, 15.x, 16.x]
+        node-version: [10.x, 11.x, 12.x, 13.x, 14.x, 15.x, 16.x, 17.x]
     steps:
       - uses: actions/checkout@v2
       - name: Prepare Cross Compile
@@ -68,7 +68,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [10.x, 11.x, 12.x, 13.x, 14.x, 15.x, 16.x]
+        node-version: [10.x, 11.x, 12.x, 13.x, 14.x, 15.x, 16.x, 17.x]
     steps:
       - uses: actions/checkout@v2
       - name: Prepare Cross Compile

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

@@ -14,7 +14,7 @@ jobs:
     runs-on: macos-latest
     strategy:
       matrix:
-        node-version: [10.x, 11.x, 12.x, 13.x, 14.x, 15.x, 16.x]
+        node-version: [10.x, 11.x, 12.x, 13.x, 14.x, 15.x, 16.x, 17.x]
 
     steps:
       - uses: actions/checkout@v2

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

@@ -11,10 +11,10 @@ env:
 
 jobs:
   build-windows-x64:
-    runs-on: windows-latest
+    runs-on: windows-2019
     strategy:
       matrix:
-        node-version: [10.x, 11.x, 12.x, 13.x, 14.x, 15.x, 16.x]
+        node-version: [10.x, 11.x, 12.x, 13.x, 14.x, 15.x, 16.x, 17.x]
 
     steps:
       - uses: actions/checkout@v2
@@ -39,10 +39,10 @@ jobs:
           CI: true
 
   build-windows-x86:
-    runs-on: windows-latest
+    runs-on: windows-2019
     strategy:
       matrix:
-        node_version: [10.x, 11.x, 12.x, 13.x, 14.x, 15.x, 16.x]
+        node_version: [10.x, 11.x, 12.x, 13.x, 14.x, 15.x, 16.x, 17.x]
         node_arch:
           - x86
     steps:

package/.github/workflows/lint.yml

@@ -0,0 +1,22 @@
+name: Lint
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+  workflow_dispatch:
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Use Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: '16.x'
+      - run: npm ci
+      - run: npm run lint      

package/.prettierrc.js

@@ -0,0 +1,7 @@
+module.exports =  {
+  semi:  true,
+  trailingComma:  'all',
+  singleQuote:  true,
+  printWidth:  120,
+  tabWidth:  4,
+};

package/CMakeLists.txt

@@ -1,6 +1,12 @@
 cmake_minimum_required(VERSION 3.15)
 cmake_policy(SET CMP0091 NEW)
-project(node_datachannel VERSION 0.2.4)
+project(node_datachannel VERSION 0.3.2)
+
+# Workaround for https://github.com/murat-dogan/node-datachannel/issues/65
+if( NODE_RUNTIMEVERSION VERSION_GREATER_EQUAL "17.0.0")
+    add_compile_definitions(OPENSSL_API_COMPAT=0x10100001L)
+    add_compile_definitions(OPENSSL_CONFIGURED_API=0x30000000L)
+endif()
 
 include_directories(${CMAKE_JS_INC})
 
@@ -27,7 +33,7 @@ include(FetchContent)
 FetchContent_Declare(
     libdatachannel
     GIT_REPOSITORY https://github.com/paullouisageneau/libdatachannel.git
-    GIT_TAG "v0.16.6"
+    GIT_TAG "v0.17.3"
 )
 
 option(NO_MEDIA "Disable media transport support in libdatachannel" OFF)

package/README.md

@@ -118,7 +118,7 @@ export const enum RelayType {
 
 export interface IceServer {
     hostname: string;
-    port: Number;
+    port: number;
     username?: string;
     password?: string;
     relayType?: RelayType;
@@ -271,15 +271,15 @@ Send Message as binary
 
 Query data-channel
 
-**bufferedAmount: () => Number**
+**bufferedAmount: () => number**
 
 Get current buffered amount level
 
-**maxMessageSize: () => Number**
+**maxMessageSize: () => number**
 
 Get max message size of the data-channel, that could be sent
 
-**setBufferedAmountLowThreshold: (newSize: Number) => void**
+**setBufferedAmountLowThreshold: (newSize: number) => void**
 
 Set buffer level of the `onBufferedAmountLow` callback
 

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

@@ -1,8 +1,9 @@
-const yargs = require('yargs/yargs')
-const { hideBin } = require('yargs/helpers')
+/* eslint-disable @typescript-eslint/no-var-requires */
+const yargs = require('yargs/yargs');
+const { hideBin } = require('yargs/helpers');
 const nodeDataChannel = require('../../lib/index');
 const WebSocket = require('ws');
-const readline = require("readline");
+const readline = require('readline');
 
 // Init Logger
 nodeDataChannel.initLogger('Debug');
@@ -26,38 +27,36 @@ const argv = yargs(hideBin(process.argv))
     .option('disableSend', {
         type: 'boolean',
         description: 'Disable Send',
-        default: false
+        default: false,
     })
     .option('wsUrl', {
         type: 'string',
         description: 'Web Socket URL',
-        default: 'ws://localhost:8000'
+        default: 'ws://localhost:8000',
     })
     .option('dataChannelCount', {
         type: 'number',
         description: 'Data Channel Count To Create',
-        default: 1
-    })
-    .argv;
+        default: 1,
+    }).argv;
 
 // Disable Send
-const disableSend = argv.disableSend
+const disableSend = argv.disableSend;
 if (disableSend) console.log('Send Disabled!');
 
 // Signaling Server
 const wsUrl = process.env.WS_URL || argv.wsUrl;
-console.log(wsUrl)
+console.log(wsUrl);
 const dataChannelCount = argv.dataChannelCount;
 
 // Read Line Interface
 const rl = readline.createInterface({
     input: process.stdin,
-    output: process.stdout
+    output: process.stdout,
 });
 
-
 const ws = new WebSocket(wsUrl + '/' + id, {
-    perMessageDeflate: false
+    perMessageDeflate: false,
 });
 
 console.log(`The local ID is: ${id}`);
@@ -104,7 +103,7 @@ function readUserInput() {
                 let dcArrItem = {
                     dc: null,
                     bytesSent: 0,
-                    bytesReceived: 0
+                    bytesReceived: 0,
                 };
                 console.log('Creating DataChannel with label "test-' + i + '"');
                 dcArrItem.dc = pcMap[peerId].createDataChannel('test-' + i);
@@ -112,16 +111,16 @@ function readUserInput() {
                 dcArrItem.dc.setBufferedAmountLowThreshold(BUFFER_SIZE);
                 dcArrItem.dc.onOpen(() => {
                     while (!disableSend && dcArrItem.dc.bufferedAmount() <= BUFFER_SIZE) {
-                        dcArrItem.dc.sendMessage(msgToSend)
-                        dcArrItem.bytesSent += msgToSend.length;;
-                    };
+                        dcArrItem.dc.sendMessage(msgToSend);
+                        dcArrItem.bytesSent += msgToSend.length;
+                    }
                 });
 
                 dcArrItem.dc.onBufferedAmountLow(() => {
                     while (!disableSend && dcArrItem.dc.bufferedAmount() <= BUFFER_SIZE) {
-                        dcArrItem.dc.sendMessage(msgToSend)
-                        dcArrItem.bytesSent += msgToSend.length;;
-                    };
+                        dcArrItem.dc.sendMessage(msgToSend);
+                        dcArrItem.bytesSent += msgToSend.length;
+                    }
                 });
 
                 dcArrItem.dc.onMessage((msg) => {
@@ -131,23 +130,36 @@ function readUserInput() {
                 dcArr.push(dcArrItem);
             }
 
-
             // Report
             let i = 0;
             setInterval(() => {
                 let totalBytesSent = 0;
                 let totalBytesReceived = 0;
                 for (let j = 0; j < dcArr.length; j++) {
-                    console.log(`${j == 0 ? i + '#' : ''} DC-${j + 1} Sent: ${byte2KB(dcArr[j].bytesSent)} KB/s / Received: ${byte2KB(dcArr[j].bytesReceived)} KB/s / SendBufferAmount: ${dcArr[j].dc.bufferedAmount()} / DataChannelOpen: ${dcArr[j].dc.isOpen()}`);
+                    console.log(
+                        `${j == 0 ? i + '#' : ''} DC-${j + 1} Sent: ${byte2KB(
+                            dcArr[j].bytesSent,
+                        )} KB/s / Received: ${byte2KB(dcArr[j].bytesReceived)} KB/s / SendBufferAmount: ${dcArr[
+                            j
+                        ].dc.bufferedAmount()} / DataChannelOpen: ${dcArr[j].dc.isOpen()}`,
+                    );
                     totalBytesSent += dcArr[j].bytesSent;
                     totalBytesReceived += dcArr[j].bytesReceived;
                     dcArr[j].bytesSent = 0;
                     dcArr[j].bytesReceived = 0;
                 }
-                console.log(`Total Sent: ${byte2KB(totalBytesSent)}  KB/s / Total Received: ${byte2KB(totalBytesReceived)}  KB/s`);
+                console.log(
+                    `Total Sent: ${byte2KB(totalBytesSent)}  KB/s / Total Received: ${byte2KB(
+                        totalBytesReceived,
+                    )}  KB/s`,
+                );
 
                 if (i % 5 == 0) {
-                    console.log(`Stats# Sent: ${byte2MB(pcMap[peerId].bytesSent())} MB / Received: ${byte2MB(pcMap[peerId].bytesReceived())} MB / rtt: ${pcMap[peerId].rtt()} ms`);
+                    console.log(
+                        `Stats# Sent: ${byte2MB(pcMap[peerId].bytesSent())} MB / Received: ${byte2MB(
+                            pcMap[peerId].bytesReceived(),
+                        )} MB / rtt: ${pcMap[peerId].rtt()} ms`,
+                    );
                     console.log(`Selected Candidates# ${JSON.stringify(pcMap[peerId].getSelectedCandidatePair())}`);
                     console.log(``);
                 }
@@ -179,16 +191,15 @@ function createPeerConnection(peerId) {
         let msgToSend = randomId(MESSAGE_SIZE);
 
         while (!disableSend && dc.bufferedAmount() <= BUFFER_SIZE) {
-            dc.sendMessage(msgToSend)
-        };
+            dc.sendMessage(msgToSend);
+        }
 
         dc.onBufferedAmountLow(() => {
             while (!disableSend && dc.bufferedAmount() <= BUFFER_SIZE) {
-                dc.sendMessage(msgToSend)
-            };
+                dc.sendMessage(msgToSend);
+            }
         });
 
-
         dc.onMessage((msg) => {
             // bytesReceived += msg.length;
         });
@@ -208,9 +219,9 @@ function randomId(length) {
 }
 
 function byte2KB(bytes) {
-    return `${Math.round(bytes / 1000)}`
+    return `${Math.round(bytes / 1000)}`;
 }
 
 function byte2MB(bytes) {
-    return `${Math.round(bytes / (1000 * 1000))}`
-}
+    return `${Math.round(bytes / (1000 * 1000))}`;
+}

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

@@ -1,6 +1,7 @@
+/* eslint-disable @typescript-eslint/no-var-requires */
 const nodeDataChannel = require('../../lib/index');
 const WebSocket = require('ws');
-const readline = require("readline");
+const readline = require('readline');
 
 // Init Logger
 nodeDataChannel.initLogger('Debug');
@@ -20,13 +21,13 @@ const BUFFER_SIZE = MESSAGE_SIZE * 10;
 // Read Line Interface
 const rl = readline.createInterface({
     input: process.stdin,
-    output: process.stdout
+    output: process.stdout,
 });
 
 // Signaling Server
-const WS_URL = process.env.WS_URL || "ws://localhost:8000"
+const WS_URL = process.env.WS_URL || 'ws://localhost:8000';
 const ws = new WebSocket(WS_URL + '/' + id, {
-    perMessageDeflate: false
+    perMessageDeflate: false,
 });
 
 console.log(`The local ID is: ${id}`);
@@ -77,7 +78,7 @@ function readUserInput() {
             dc.onOpen(() => {
                 setInterval(() => {
                     if (dc.bufferedAmount() <= BUFFER_SIZE) {
-                        dc.sendMessage(msgToSend)
+                        dc.sendMessage(msgToSend);
                         bytesSent += msgToSend.length;
                     }
                 }, 2);
@@ -90,13 +91,21 @@ function readUserInput() {
             // Report
             let i = 0;
             setInterval(() => {
-                console.log(`${i++}# Sent: ${byte2KB(bytesSent)} KB/s / Received: ${byte2KB(bytesReceived)} KB/s / SendBufferAmount: ${dc.bufferedAmount()} / DataChannelOpen: ${dc.isOpen()}`);
+                console.log(
+                    `${i++}# Sent: ${byte2KB(bytesSent)} KB/s / Received: ${byte2KB(
+                        bytesReceived,
+                    )} KB/s / SendBufferAmount: ${dc.bufferedAmount()} / DataChannelOpen: ${dc.isOpen()}`,
+                );
                 bytesSent = 0;
                 bytesReceived = 0;
             }, 1000);
 
             setInterval(() => {
-                console.log(`Stats# Sent: ${byte2MB(pcMap[peerId].bytesSent())} MB / Received: ${byte2MB(pcMap[peerId].bytesReceived())} MB / rtt: ${pcMap[peerId].rtt()} ms`);
+                console.log(
+                    `Stats# Sent: ${byte2MB(pcMap[peerId].bytesSent())} MB / Received: ${byte2MB(
+                        pcMap[peerId].bytesReceived(),
+                    )} MB / rtt: ${pcMap[peerId].rtt()} ms`,
+                );
                 console.log(`Selected Candidates# ${JSON.stringify(pcMap[peerId].getSelectedCandidatePair())}`);
                 console.log(``);
             }, 5 * 1000);
@@ -129,12 +138,11 @@ function createPeerConnection(peerId) {
 
         setInterval(() => {
             if (dc.bufferedAmount() <= BUFFER_SIZE) {
-                dc.sendMessage(msgToSend)
+                dc.sendMessage(msgToSend);
                 bytesSent += msgToSend.length;
             }
         }, 2);
 
-
         dc.onMessage((msg) => {
             bytesReceived += msg.length;
         });
@@ -142,13 +150,21 @@ function createPeerConnection(peerId) {
         // Report
         let i = 0;
         setInterval(() => {
-            console.log(`${i++}# Sent: ${byte2KB(bytesSent)} KB/s / Received: ${byte2KB(bytesReceived)} KB/s / SendBufferAmount: ${dc.bufferedAmount()} / DataChannelOpen: ${dc.isOpen()}`);
+            console.log(
+                `${i++}# Sent: ${byte2KB(bytesSent)} KB/s / Received: ${byte2KB(
+                    bytesReceived,
+                )} KB/s / SendBufferAmount: ${dc.bufferedAmount()} / DataChannelOpen: ${dc.isOpen()}`,
+            );
             bytesSent = 0;
             bytesReceived = 0;
         }, 1000);
 
         setInterval(() => {
-            console.log(`Stats# Sent: ${byte2MB(pcMap[peerId].bytesSent())} MB / Received: ${byte2MB(pcMap[peerId].bytesReceived())} MB / rtt: ${pcMap[peerId].rtt()} ms`);
+            console.log(
+                `Stats# Sent: ${byte2MB(pcMap[peerId].bytesSent())} MB / Received: ${byte2MB(
+                    pcMap[peerId].bytesReceived(),
+                )} MB / rtt: ${pcMap[peerId].rtt()} ms`,
+            );
             console.log(`Selected Candidates# ${JSON.stringify(pcMap[peerId].getSelectedCandidatePair())}`);
             console.log(``);
         }, 5 * 1000);
@@ -168,9 +184,9 @@ function randomId(length) {
 }
 
 function byte2KB(bytes) {
-    return `${Math.round(bytes / 1024)}`
+    return `${Math.round(bytes / 1024)}`;
 }
 
 function byte2MB(bytes) {
-    return `${Math.round(bytes / (1024 * 1024))}`
-}
+    return `${Math.round(bytes / (1024 * 1024))}`;
+}

package/examples/client-server/client.js

@@ -1,6 +1,7 @@
+/* eslint-disable @typescript-eslint/no-var-requires */
 const nodeDataChannel = require('../../lib/index');
 const WebSocket = require('ws');
-const readline = require("readline");
+const readline = require('readline');
 
 // Init Logger
 nodeDataChannel.initLogger('Error');
@@ -12,9 +13,9 @@ const pcMap = {};
 const id = randomId(4);
 
 // Signaling Server
-const WS_URL = process.env.WS_URL || "ws://localhost:8000"
+const WS_URL = process.env.WS_URL || 'ws://localhost:8000';
 const ws = new WebSocket(WS_URL + '/' + id, {
-    perMessageDeflate: false
+    perMessageDeflate: false,
 });
 
 console.log(`The local ID is: ${id}`);
@@ -52,7 +53,7 @@ function readUserInput() {
     // Read Line Interface
     const rl = readline.createInterface({
         input: process.stdin,
-        output: process.stdout
+        output: process.stdout,
     });
 
     rl.question('Enter a remote ID to send an offer:\n', (peerId) => {
@@ -110,4 +111,4 @@ function randomId(length) {
         result += characters.charAt(Math.floor(Math.random() * charactersLength));
     }
     return result;
-}
+}