node-datachannel 0.10.1 → 0.12.0

package/src/peer-connection-wrapper.cpp

@@ -100,8 +100,17 @@ PeerConnectionWrapper::PeerConnectionWrapper(const Napi::CallbackInfo &info) : N
     Napi::Array iceServers = config.Get("iceServers").As<Napi::Array>();
     for (uint32_t i = 0; i < iceServers.Length(); i++)
     {
-        if (iceServers.Get(i).IsString())
-            rtcConfig.iceServers.emplace_back(iceServers.Get(i).As<Napi::String>().ToString());
+        if (iceServers.Get(i).IsString()){
+            try
+            {
+                rtcConfig.iceServers.emplace_back(iceServers.Get(i).As<Napi::String>().ToString());
+            }
+            catch(std::exception &ex)
+            {
+                Napi::TypeError::New(env, "SyntaxError: IceServer config error: " + std::string(ex.what())).ThrowAsJavaScriptException();
+                return;
+            }
+        }
         else
         {
             if (!iceServers.Get(i).IsObject())
@@ -116,7 +125,6 @@ PeerConnectionWrapper::PeerConnectionWrapper(const Napi::CallbackInfo &info) : N
                 Napi::TypeError::New(env, "IceServer config error (hostname OR/AND port is not suitable)").ThrowAsJavaScriptException();
                 return;
             }
-
             if (iceServer.Get("relayType").IsString() &&
                 (!iceServer.Get("username").IsString() || !iceServer.Get("password").IsString()))
             {

package/src/web-socket-server-wrapper.cpp

@@ -2,6 +2,9 @@
 
 #include "plog/Log.h"
 
+Napi::FunctionReference WebSocketServerWrapper::constructor;
+std::unordered_set<WebSocketServerWrapper *> WebSocketServerWrapper::instances;
+
 void WebSocketServerWrapper::StopAll()
 {
     PLOG_DEBUG << "StopAll() called";
@@ -10,9 +13,6 @@ void WebSocketServerWrapper::StopAll()
         inst->doStop();
 }
 
-Napi::FunctionReference WebSocketServerWrapper::constructor;
-std::unordered_set<WebSocketServerWrapper *> WebSocketServerWrapper::instances;
-
 Napi::Object WebSocketServerWrapper::Init(Napi::Env env, Napi::Object exports)
 {
     Napi::HandleScope scope(env);
@@ -36,7 +36,6 @@ Napi::Object WebSocketServerWrapper::Init(Napi::Env env, Napi::Object exports)
 WebSocketServerWrapper::WebSocketServerWrapper(const Napi::CallbackInfo &info) : Napi::ObjectWrap<WebSocketServerWrapper>(info)
 {
     PLOG_DEBUG << "Constructor called";
-    
     Napi::Env env = info.Env();
 
     // Create WebSocketServer without config
@@ -52,7 +51,7 @@ WebSocketServerWrapper::WebSocketServerWrapper(const Napi::CallbackInfo &info) :
             Napi::Error::New(env, std::string("libdatachannel error while creating WebSocketServer without config: ") + ex.what()).ThrowAsJavaScriptException();
             return;
         }
- 
+
         PLOG_DEBUG << "WebSocketServer created without config";
 
         instances.insert(this);
@@ -60,14 +59,14 @@ WebSocketServerWrapper::WebSocketServerWrapper(const Napi::CallbackInfo &info) :
     }
 
     // Create WebSocketServer with config
-    
-    Napi::Object config = info[0].As<Napi::Object>();    
+
+    Napi::Object config = info[0].As<Napi::Object>();
     rtc::WebSocketServerConfiguration webSocketServerConfig;
 
     // Port
     if (config.Has("port"))
     {
-        if (!config.Get("port").IsNumber()) 
+        if (!config.Get("port").IsNumber())
         {
             Napi::TypeError::New(info.Env(), "port must be a number").ThrowAsJavaScriptException();
             return;
@@ -78,7 +77,7 @@ WebSocketServerWrapper::WebSocketServerWrapper(const Napi::CallbackInfo &info) :
     // Enable TLS
     if (config.Has("enableTls"))
     {
-        if (!config.Get("enableTls").IsBoolean()) 
+        if (!config.Get("enableTls").IsBoolean())
         {
             Napi::TypeError::New(info.Env(), "enableTls must be boolean").ThrowAsJavaScriptException();
             return;
@@ -89,7 +88,7 @@ WebSocketServerWrapper::WebSocketServerWrapper(const Napi::CallbackInfo &info) :
     // Certificate PEM File
     if (config.Has("certificatePemFile"))
     {
-        if (!config.Get("certificatePemFile").IsString()) 
+        if (!config.Get("certificatePemFile").IsString())
         {
             Napi::TypeError::New(info.Env(), "certificatePemFile must be a string").ThrowAsJavaScriptException();
             return;
@@ -100,7 +99,7 @@ WebSocketServerWrapper::WebSocketServerWrapper(const Napi::CallbackInfo &info) :
     // Key PEM File
     if (config.Has("keyPemFile"))
     {
-        if (!config.Get("keyPemFile").IsString()) 
+        if (!config.Get("keyPemFile").IsString())
         {
             Napi::TypeError::New(info.Env(), "keyPemFile must be a string").ThrowAsJavaScriptException();
             return;
@@ -111,7 +110,7 @@ WebSocketServerWrapper::WebSocketServerWrapper(const Napi::CallbackInfo &info) :
     // Key PEM Pass
     if (config.Has("keyPemPass"))
     {
-        if (!config.Get("keyPemPass").IsString()) 
+        if (!config.Get("keyPemPass").IsString())
         {
             Napi::TypeError::New(info.Env(), "keyPemPass must be a string").ThrowAsJavaScriptException();
             return;
@@ -122,7 +121,7 @@ WebSocketServerWrapper::WebSocketServerWrapper(const Napi::CallbackInfo &info) :
     // Bind Address
     if (config.Has("bindAddress"))
     {
-        if (!config.Get("bindAddress").IsString()) 
+        if (!config.Get("bindAddress").IsString())
         {
             Napi::TypeError::New(info.Env(), "bindAddress must be a string").ThrowAsJavaScriptException();
             return;
@@ -133,7 +132,7 @@ WebSocketServerWrapper::WebSocketServerWrapper(const Napi::CallbackInfo &info) :
     // Connection Timeout
     if (config.Has("connectionTimeout"))
     {
-        if (!config.Get("connectionTimeout").IsNumber()) 
+        if (!config.Get("connectionTimeout").IsNumber())
         {
             Napi::TypeError::New(info.Env(), "connectionTimeout must be a number").ThrowAsJavaScriptException();
             return;
@@ -144,7 +143,7 @@ WebSocketServerWrapper::WebSocketServerWrapper(const Napi::CallbackInfo &info) :
     // Max Message Size
     if (config.Has("maxMessageSize"))
     {
-        if (!config.Get("maxMessageSize").IsNumber()) 
+        if (!config.Get("maxMessageSize").IsNumber())
         {
             Napi::TypeError::New(info.Env(), "maxMessageSize must be a number").ThrowAsJavaScriptException();
             return;
@@ -163,7 +162,7 @@ WebSocketServerWrapper::WebSocketServerWrapper(const Napi::CallbackInfo &info) :
         Napi::Error::New(env, std::string("libdatachannel error while creating WebSocketServer: ") + ex.what()).ThrowAsJavaScriptException();
         return;
     }
- 
+
     PLOG_DEBUG << "WebSocketServer created";
     instances.insert(this);
 }
@@ -179,7 +178,7 @@ void WebSocketServerWrapper::doStop()
     PLOG_DEBUG << "doStop() called";
     if (mWebSocketServerPtr)
     {
-        PLOG_DEBUG << "Closing...";
+        PLOG_DEBUG << "Stopping...";
         try
         {
             mWebSocketServerPtr->stop();
@@ -187,13 +186,12 @@ void WebSocketServerWrapper::doStop()
         }
         catch (std::exception &ex)
         {
-            std::cerr << std::string("libWebRtc error while closing WebSocketServer: ") + ex.what() << std::endl;
+            std::cerr << std::string("libdatachannel error while closing WebSocketServer: ") + ex.what() << std::endl;
             return;
         }
     }
 
     mOnClientCallback.reset();
-
     instances.erase(this);
 }
 
@@ -238,7 +236,7 @@ void WebSocketServerWrapper::onClient(const Napi::CallbackInfo &info)
 
     if (length < 1 || !info[0].IsFunction())
     {
-        Napi::TypeError::New(env, "Function expected as onClient calback").ThrowAsJavaScriptException();
+        Napi::TypeError::New(env, "Function expected as onClient callback").ThrowAsJavaScriptException();
         return;
     }
 
@@ -246,7 +244,7 @@ void WebSocketServerWrapper::onClient(const Napi::CallbackInfo &info)
     mOnClientCallback = std::make_unique<ThreadSafeCallback>(info[0].As<Napi::Function>());
 
     mWebSocketServerPtr->onClient([&](std::shared_ptr<rtc::WebSocket> ws)
-                                   {
+                                  {
         PLOG_DEBUG << "onClient ws received from WebSocketServer";
         if (mOnClientCallback)
             mOnClientCallback->call([this, ws](Napi::Env env, std::vector<napi_value> &args) {
@@ -258,8 +256,10 @@ void WebSocketServerWrapper::onClient(const Napi::CallbackInfo &info)
                 // This will run in main thread and needs to construct the
                 // arguments for the call
                 std::shared_ptr<rtc::WebSocket> webSocket = ws;
-                auto instance = WebSocketWrapper::constructor.New({Napi::External<std::shared_ptr<rtc::WebSocket>>::New(env, nullptr), Napi::External<std::shared_ptr<rtc::WebSocket>>::New(env, &webSocket)});
+                // First argument is just a placeholder
+                auto instance = WebSocketWrapper::constructor.New({Napi::Boolean::New(env, false), Napi::External<std::shared_ptr<rtc::WebSocket>>::New(env, &webSocket)});
                 args = {instance};
                 PLOG_DEBUG << "mOnClientCallback call(2)";
-            }); });
+            });
+    });
 }

package/src/web-socket-server-wrapper.h

@@ -16,13 +16,11 @@
 class WebSocketServerWrapper : public Napi::ObjectWrap<WebSocketServerWrapper>
 {
 public:
-  static Napi::FunctionReference constructor;
   static Napi::Object Init(Napi::Env env, Napi::Object exports);
   WebSocketServerWrapper(const Napi::CallbackInfo &info);
   ~WebSocketServerWrapper();
 
   // Functions
-
   void stop(const Napi::CallbackInfo &info);
   Napi::Value port(const Napi::CallbackInfo &info);
 
@@ -31,13 +29,17 @@ public:
 
   // Close all existing WebSocketServers
   static void StopAll();
- 
+
 private:
-  static std::unordered_set<WebSocketServerWrapper*> instances;
-  std::unique_ptr<rtc::WebSocketServer> mWebSocketServerPtr = nullptr;
-  std::unique_ptr<ThreadSafeCallback> mOnClientCallback = nullptr;
+  static Napi::FunctionReference constructor;
+  static std::unordered_set<WebSocketServerWrapper *> instances;
 
   void doStop();
+
+  std::unique_ptr<rtc::WebSocketServer> mWebSocketServerPtr = nullptr;
+
+  // Callback Ptrs
+  std::unique_ptr<ThreadSafeCallback> mOnClientCallback = nullptr;
 };
 
 #endif // WEB_SOCKET_SERVER_WRAPPER_H

package/src/web-socket-wrapper.cpp

@@ -65,6 +65,9 @@ WebSocketWrapper::WebSocketWrapper(const Napi::CallbackInfo &info) : Napi::Objec
         mWebSocketPtr = *(info[1].As<Napi::External<std::shared_ptr<rtc::WebSocket>>>().Data());
         PLOG_DEBUG << "Using WebSocket got from WebSocketServer";
         instances.insert(this);
+
+        // Closed callback must be set to trigger cleanup
+        mOnClosedCallback = std::make_unique<ThreadSafeCallback>(Napi::Function::New(info.Env(), [](const Napi::CallbackInfo &) {}));
         return;
     }
 
@@ -82,6 +85,9 @@ WebSocketWrapper::WebSocketWrapper(const Napi::CallbackInfo &info) : Napi::Objec
             return;
         }
         instances.insert(this);
+
+        // Closed callback must be set to trigger cleanup
+        mOnClosedCallback = std::make_unique<ThreadSafeCallback>(Napi::Function::New(info.Env(), [](const Napi::CallbackInfo &) {}));
         return;
     }
 
@@ -240,7 +246,7 @@ WebSocketWrapper::WebSocketWrapper(const Napi::CallbackInfo &info) : Napi::Objec
     PLOG_DEBUG << "WebSocket created";
 
     // Closed callback must set to trigger cleanup
-    mOnClosedCallback = std::make_unique<ThreadSafeCallback>(Napi::Function::New(info.Env(), [](const Napi::CallbackInfo&){}));
+    mOnClosedCallback = std::make_unique<ThreadSafeCallback>(Napi::Function::New(info.Env(), [](const Napi::CallbackInfo &) {}));
 
     instances.insert(this);
 }

package/test/connectivity.js

@@ -1,30 +1,16 @@
 import nodeDataChannel from '../lib/index.js';
 
 nodeDataChannel.initLogger('Debug');
-nodeDataChannel.preload();
 
 let dc1 = null;
 let dc2 = null;
 
-// Config options
-// export interface RtcConfig {
-//     iceServers: string[];
-//     proxyServer?: ProxyServer;
-//     bindAddress?: string;
-//     enableIceTcp?: boolean;
-//     portRangeBegin?: number;
-//     portRangeEnd?: number;
-//     maxMessageSize?: number;
-//     iceTransportPolicy?: TransportPolicy;
-// }
-//
 // "iceServers" option is an array of stun/turn server urls
 // Examples;
 // STUN Server Example          : stun:stun.l.google.com:19302
 // TURN Server Example          : turn:USERNAME:PASSWORD@TURN_IP_OR_ADDRESS:PORT
 // TURN Server Example (TCP)    : turn:USERNAME:PASSWORD@TURN_IP_OR_ADDRESS:PORT?transport=tcp
 // TURN Server Example (TLS)    : turns:USERNAME:PASSWORD@TURN_IP_OR_ADDRESS:PORT
-
 let peer1 = new nodeDataChannel.PeerConnection('Peer1', { iceServers: ['stun:stun.l.google.com:19302'] });
 
 // Set Callbacks
@@ -78,15 +64,7 @@ peer2.onDataChannel((dc) => {
     });
 });
 
-// DataChannel Options
-// export interface DataChannelInitConfig {
-//     protocol?: string;
-//     negotiated?: boolean;
-//     id?: number;
-//     ordered?: boolean;
-//     maxPacketLifeTime?: number;
-//     maxRetransmits?: number;
-// }
+// Create DataChannel
 dc1 = peer1.createDataChannel('test');
 dc1.onOpen(() => {
     dc1.sendMessage('Hello from Peer1');

package/test/wpt-tests/README.md

@@ -0,0 +1,46 @@
+# Setup (First time usage)
+
+> cd test/wpt-tests
+
+> npm i
+
+> git submodule update --init --recursive --depth 1
+
+> cd wpt
+
+> ./wpt make-hosts-file | sudo tee -a /etc/hosts
+
+After your hosts file is configured, the servers will be locally accessible at:
+
+http://web-platform.test:8000/
+
+https://web-platform.test:8443/ \*
+
+To use the web-based runner point your browser to:
+
+http://web-platform.test:8000/tools/runner/index.html
+
+https://web-platform.test:8443/tools/runner/index.html \*
+
+# Running Tests
+
+> npm run test
+
+OR
+
+> npm run:wpt  (Let this run)
+
+> npm run:test (In an other console)
+
+The files that tested are listed in `wpt-test-list.js`. The commented lines need still to be one-by-one tested and uncommented.
+
+Contributions are welcome!
+
+# Run a test for Chrome
+
+./wpt run chrome /webrtc/RTCPeerConnection-addIceCandidate.html
+
+# Latest Test Results
+
+Please check [last-test-results.md](./last-test-results.md) page
+

package/test/wpt-tests/chrome-failed-tests.js

@@ -0,0 +1,42 @@
+import { runWptTests } from './wpt.js';
+
+// Some tests also fail in Chrome
+// We don't also care of them
+let chromeFailedTests = [];
+let totalNumberOfTests = 0;
+
+export async function runChromeTests(wptTestList) {
+    chromeFailedTests = [];
+    totalNumberOfTests = 0;
+    let results = await runWptTests(wptTestList, true);
+    for (let i = 0; i < results.length; i++) {
+        totalNumberOfTests += results[i].result?.length || 0;
+        if (results[i].result && results[i].result.some((test) => test.status === 1)) {
+            chromeFailedTests.push({
+                test: results[i].test,
+                result: results[i].result.filter((test) => test.status === 1),
+            });
+        }
+    }
+}
+
+export function getChromeFailedTests() {
+    return chromeFailedTests;
+}
+
+export function isTestForChromeFailed(testPath, testName) {
+    return chromeFailedTests.some(
+        (test) =>
+            test.test === testPath && test.result.some((result) => result.name === testName && result.status === 1),
+    );
+}
+
+export function getTotalNumberOfTests() {
+    return totalNumberOfTests;
+}
+
+// Test
+// (async () => {
+//     await runChromeTests();
+//     console.log(getChromeFailedTests());
+// })();

package/test/wpt-tests/index.js

@@ -0,0 +1,96 @@
+import ndc from '../../lib/index.js';
+import wptTestList from './wpt-test-list.js';
+import { runWptTests } from './wpt.js';
+import { runChromeTests, isTestForChromeFailed, getTotalNumberOfTests } from './chrome-failed-tests.js';
+
+// Set the log level, for debugging purposes
+// ndc.initLogger('Debug');
+
+// Catch unhandled exceptions
+process.on('unhandledRejection', (reason, promise) => {
+    console.error('Unhandled Rejection at:', promise, 'reason:', reason);
+    process.exit(1);
+});
+
+// Run tests for Chrome
+console.log('# Running tests for Chrome...');
+await runChromeTests(wptTestList);
+//console.log(JSON.stringify(getChromeFailedTests(), null, 2));
+
+// Run tests for node-datachannel
+console.log('');
+console.log('# Running tests for node-datachannel...');
+let results = await runWptTests(wptTestList);
+
+// Calc total number of tests
+let totalTests = 0;
+results.forEach((result) => {
+    totalTests += result.result.length;
+});
+
+// Compare results
+// Filter failed tests for node-datachannel
+let failedTestsLibrary = [];
+results.forEach((result) => {
+    if (result.result.some((test) => test.status === 1)) {
+        failedTestsLibrary.push({
+            test: result.test,
+            result: result.result.filter((test) => test.status === 1),
+        });
+    }
+});
+let totalFailedTestsLibrary = 0;
+failedTestsLibrary.forEach((result) => {
+    totalFailedTestsLibrary += result.result.length;
+});
+// console.log(JSON.stringify(failedTestsLibrary, null, 2));
+
+// Filter out any failed tests that also failed in Chrome
+let failedTests = [];
+failedTestsLibrary.forEach((result) => {
+    if (result.result.some((test) => !isTestForChromeFailed(result.test, test.name))) {
+        failedTests.push({
+            test: result.test,
+            result: result.result.filter((test) => !isTestForChromeFailed(result.test, test.name)),
+        });
+    }
+});
+let totalFailedTests = 0;
+failedTests.forEach((result) => {
+    totalFailedTests += result.result.length;
+});
+// console.log(JSON.stringify(failedTests, null, 2));
+
+// Print Report
+// Print Test Names
+console.log('');
+console.log('# Tests Report');
+// Total number of tests
+console.log('Total Tests [Chrome]: ', getTotalNumberOfTests(), '  ');
+console.log('Total Tests [Library]: ', totalTests, ' (We expect this to be equal to Total Tests [Chrome])  ');
+// Number of passed tests
+console.log('Passed Tests: ', totalTests - totalFailedTestsLibrary, '  ');
+// Number of failed tests for chrome + node-datachannel
+console.log(
+    'Failed Tests (Chrome + Library): ',
+    totalFailedTestsLibrary - totalFailedTests,
+    " (We don't care about these tests)  ",
+);
+// Number of failed tests
+console.log('Failed Tests: ', totalFailedTests, '   ');
+
+// Print Failed Tests
+console.log('');
+console.log('## Failed Tests');
+for (let i = 0; i < failedTests.length; i++) {
+    console.log(`### ${failedTests[i].test}`);
+    for (let j = 0; j < failedTests[i].result.length; j++) {
+        console.log(`- name: ${failedTests[i].result[j].name}  `);
+        console.log(`  message: ${failedTests[i].result[j].message}  `);
+    }
+}
+
+// Sometimes failed tests are not cleaned up
+// This can prevent the process from exiting
+ndc.cleanup();
+console.log('End of tests');