node-datachannel 0.2.1 → 0.2.4

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

@@ -45,6 +45,7 @@ jobs:
       - uses: actions/checkout@v2
       - name: Prepare Cross Compile
         run: |
+          sudo apt update
           sudo apt install -y g++-arm-linux-gnueabihf gcc-arm-linux-gnueabihf
           mkdir sysroot && cd sysroot
           wget https://commondatastorage.googleapis.com/chrome-linux-sysroot/toolchain/ef5c4f84bcafb7a3796d36bb1db7826317dde51c/debian_sid_arm_sysroot.tar.xz        
@@ -72,6 +73,7 @@ jobs:
       - uses: actions/checkout@v2
       - name: Prepare Cross Compile
         run: |
+          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        

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

@@ -42,13 +42,7 @@ jobs:
     runs-on: windows-latest
     strategy:
       matrix:
-        node_version:
-          - 10
-          - 11
-          - 12
-          - 13
-          - 14
-          - 15
+        node_version: [10.x, 11.x, 12.x, 13.x, 14.x, 15.x, 16.x]
         node_arch:
           - x86
     steps:

package/CMakeLists.txt

@@ -1,6 +1,6 @@
 cmake_minimum_required(VERSION 3.15)
 cmake_policy(SET CMP0091 NEW)
-project(node_datachannel VERSION 0.2.1)
+project(node_datachannel VERSION 0.2.4)
 
 include_directories(${CMAKE_JS_INC})
 
@@ -27,7 +27,7 @@ include(FetchContent)
 FetchContent_Declare(
     libdatachannel
     GIT_REPOSITORY https://github.com/paullouisageneau/libdatachannel.git
-    GIT_TAG "v0.16.4"
+    GIT_TAG "v0.16.6"
 )
 
 option(NO_MEDIA "Disable media transport support in libdatachannel" OFF)

package/README.md

@@ -133,7 +133,7 @@ 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
 
-``` 
+```
 
 **close: () => void**
 
@@ -179,7 +179,18 @@ export interface DataChannelInitConfig {
 export const enum ReliabilityType {
     Reliable = 0, Rexmit = 1, Timed = 2
 }
-``` 
+```
+**state: () => string**
+
+Get current state
+
+**signalingState: () => string**
+
+Get current signaling state
+
+**gatheringState: () => string**
+
+Get current gathering state
 
 **onLocalDescription: (cb: (sdp: string, type: DescriptionType) => void) => void**
 
@@ -200,6 +211,10 @@ Local Candidate Callback
 
 State Change Callback
 
+**onSignalingStateChange: (state: (sdp: string) => void) => void**
+
+Signaling State Change Callback
+
 **onGatheringStateChange: (state: (sdp: string) => void) => void**
 
 Gathering State Change Callback
@@ -238,7 +253,7 @@ export interface SelectedCandidateInfo {
 
 **close: () => void**
 
-Close data channel 
+Close data channel
 
 **getLabel: () => string**
 

package/lib/datachannel-stream.js

@@ -0,0 +1,86 @@
+const stream = require('stream');
+
+/**
+ * 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.
+ */
+module.exports = 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;
+        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;
+            callback(new Error(`Cannot write ${typeName} to DataChannel stream`));
+            return;
+        }
+
+        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();
+    }
+
+}

package/lib/index.d.ts

@@ -1,3 +1,5 @@
+import * as stream from 'stream';
+
 export as namespace NodeDataChannel;
 
 // Enum in d.ts is tricky
@@ -90,7 +92,7 @@ export interface SelectedCandidateInfo {
 }
 
 // Must be same as rtc enum class Direction
-export enum Direction {
+export const enum Direction {
     SendOnly = 'SendOnly',
     RecvOnly = 'RecvOnly',
     SendRecv = 'SendRecv',
@@ -134,7 +136,7 @@ export class Video {
     addH264Codec: (payloadType: Number, profile?: string) => void;
     addVP8Codec: (payloadType: Number) => void;
     addVP9Codec: (payloadType: Number) => void;
-    
+
     direction: () => Direction;
     generateSdp: (eol: string, addr: string, port: string) => string;
     mid: () => string;
@@ -205,9 +207,13 @@ export class PeerConnection {
     createDataChannel: (label: string, config?: DataChannelInitConfig) => DataChannel;
     addTrack: (media: Video | Audio) => Track;
     hasMedia: () => boolean;
+    state: () => string;
+    signalingState: () => string;
+    gatheringState: () => string;
     onLocalDescription: (cb: (sdp: string, type: DescriptionType) => void) => void;
     onLocalCandidate: (cb: (candidate: string, mid: string) => void) => void;
     onStateChange: (cb: (state: string) => void) => void;
+    onSignalingStateChange: (state: (sdp: string) => void) => void;
     onGatheringStateChange: (state: (sdp: string) => void) => void;
     onDataChannel: (cb: (dc: DataChannel) => void) => void;
     onTrack: () => Track;
@@ -216,3 +222,11 @@ export class PeerConnection {
     rtt: () => number;
     getSelectedCandidatePair: () => { local: SelectedCandidateInfo, remote: SelectedCandidateInfo } | null;
 }
+
+export class DataChannelStream extends stream.Duplex {
+    constructor(
+        rawChannel: DataChannel,
+        options?: Omit<stream.DuplexOptions, 'objectMode'>
+    );
+    get label(): string;
+}

package/lib/index.js

@@ -1,2 +1,4 @@
 const nodeDataChannel = require("../build/Release/node_datachannel.node");
-module.exports = nodeDataChannel;
+module.exports = nodeDataChannel;
+
+module.exports.DataChannelStream = require('./datachannel-stream');

package/node_modules/decompress-response/index.d.ts

@@ -1,29 +1,22 @@
 /// <reference types="node"/>
 import {IncomingMessage} from 'http';
 
-declare const decompressResponse: {
-	/**
-	Decompress a HTTP response if needed.
+/**
+Decompress a HTTP response if needed.
 
-	@param response - The HTTP incoming stream with compressed data.
-	@returns The decompressed HTTP response stream.
+@param response - The HTTP incoming stream with compressed data.
+@returns The decompressed HTTP response stream.
 
-	@example
-	```
-	import {http} from 'http';
-	import decompressResponse = require('decompress-response');
+@example
+```
+import {http} from 'http';
+import decompressResponse = require('decompress-response');
 
-	http.get('https://sindresorhus.com', response => {
-		response = decompressResponse(response);
-	});
-	```
-	*/
-	(response: IncomingMessage): IncomingMessage;
-
-	// TODO: remove this in the next major version, refactor the whole definition to:
-	// declare function decompressResponse(response: IncomingMessage): IncomingMessage;
-	// export = decompressResponse;
-	default: typeof decompressResponse;
-};
+http.get('https://sindresorhus.com', response => {
+	response = decompressResponse(response);
+});
+```
+*/
+declare function decompressResponse(response: IncomingMessage): IncomingMessage;
 
 export = decompressResponse;

package/node_modules/decompress-response/index.js

@@ -1,40 +1,58 @@
 'use strict';
-const {PassThrough: PassThroughStream} = require('stream');
+const {Transform, PassThrough} = require('stream');
 const zlib = require('zlib');
 const mimicResponse = require('mimic-response');
 
-const decompressResponse = response => {
+module.exports = response => {
 	const contentEncoding = (response.headers['content-encoding'] || '').toLowerCase();
 
 	if (!['gzip', 'deflate', 'br'].includes(contentEncoding)) {
 		return response;
 	}
 
+	// TODO: Remove this when targeting Node.js 12.
 	const isBrotli = contentEncoding === 'br';
 	if (isBrotli && typeof zlib.createBrotliDecompress !== 'function') {
+		response.destroy(new Error('Brotli is not supported on Node.js < 12'));
 		return response;
 	}
 
-	const decompress = isBrotli ? zlib.createBrotliDecompress() : zlib.createUnzip();
-	const stream = new PassThroughStream();
+	let isEmpty = true;
 
-	mimicResponse(response, stream);
+	const checker = new Transform({
+		transform(data, _encoding, callback) {
+			isEmpty = false;
 
-	decompress.on('error', error => {
-		// Ignore empty response
-		if (error.code === 'Z_BUF_ERROR') {
-			stream.end();
+			callback(null, data);
+		},
+
+		flush(callback) {
+			callback();
+		}
+	});
+
+	const finalStream = new PassThrough({
+		autoDestroy: false,
+		destroy(error, callback) {
+			response.destroy();
+
+			callback(error);
+		}
+	});
+
+	const decompressStream = isBrotli ? zlib.createBrotliDecompress() : zlib.createUnzip();
+
+	decompressStream.once('error', error => {
+		if (isEmpty && !response.readable) {
+			finalStream.end();
 			return;
 		}
 
-		stream.emit('error', error);
+		finalStream.destroy(error);
 	});
 
-	response.pipe(decompress).pipe(stream);
+	mimicResponse(response, finalStream);
+	response.pipe(checker).pipe(decompressStream).pipe(finalStream);
 
-	return stream;
+	return finalStream;
 };
-
-module.exports = decompressResponse;
-// TODO: remove this in the next major version
-module.exports.default = decompressResponse;

package/node_modules/decompress-response/license

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (sindresorhus.com)
+Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (https://sindresorhus.com)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

package/node_modules/decompress-response/package.json

@@ -1,59 +1,60 @@
 {
   "_args": [
     [
-      "decompress-response@4.2.1",
+      "decompress-response@6.0.0",
       "/home/runner/work/node-datachannel/node-datachannel"
     ]
   ],
-  "_from": "decompress-response@4.2.1",
-  "_id": "decompress-response@4.2.1",
+  "_from": "decompress-response@6.0.0",
+  "_id": "decompress-response@6.0.0",
   "_inBundle": false,
-  "_integrity": "sha512-jOSne2qbyE+/r8G1VU+G/82LBs2Fs4LAsTiLSHOCOMZQl2OKZ6i8i4IyHemTe+/yIXOtTcRQMzPcgyhoFlqPkw==",
+  "_integrity": "sha512-aW35yZM6Bb/4oJlZncMH2LCoZtJXTRxES17vE3hoRiowU2kWHaJKFkSBDnDR+cm9J+9QhXmREyIfv0pji9ejCQ==",
   "_location": "/decompress-response",
   "_phantomChildren": {},
   "_requested": {
     "type": "version",
     "registry": true,
-    "raw": "decompress-response@4.2.1",
+    "raw": "decompress-response@6.0.0",
     "name": "decompress-response",
     "escapedName": "decompress-response",
-    "rawSpec": "4.2.1",
+    "rawSpec": "6.0.0",
     "saveSpec": null,
-    "fetchSpec": "4.2.1"
+    "fetchSpec": "6.0.0"
   },
   "_requiredBy": [
     "/simple-get"
   ],
-  "_resolved": "https://registry.npmjs.org/decompress-response/-/decompress-response-4.2.1.tgz",
-  "_spec": "4.2.1",
+  "_resolved": "https://registry.npmjs.org/decompress-response/-/decompress-response-6.0.0.tgz",
+  "_spec": "6.0.0",
   "_where": "/home/runner/work/node-datachannel/node-datachannel",
   "author": {
     "name": "Sindre Sorhus",
     "email": "sindresorhus@gmail.com",
-    "url": "sindresorhus.com"
+    "url": "https://sindresorhus.com"
   },
   "bugs": {
     "url": "https://github.com/sindresorhus/decompress-response/issues"
   },
   "dependencies": {
-    "mimic-response": "^2.0.0"
+    "mimic-response": "^3.1.0"
   },
   "description": "Decompress a HTTP response if needed",
   "devDependencies": {
-    "@types/node": "^12.7.1",
+    "@types/node": "^14.0.1",
     "ava": "^2.2.0",
     "get-stream": "^5.0.0",
-    "pify": "^4.0.1",
-    "tsd": "^0.7.1",
-    "xo": "^0.24.0"
+    "pify": "^5.0.0",
+    "tsd": "^0.11.0",
+    "xo": "^0.30.0"
   },
   "engines": {
-    "node": ">=8"
+    "node": ">=10"
   },
   "files": [
     "index.js",
     "index.d.ts"
   ],
+  "funding": "https://github.com/sponsors/sindresorhus",
   "homepage": "https://github.com/sindresorhus/decompress-response#readme",
   "keywords": [
     "decompress",
@@ -81,5 +82,10 @@
   "scripts": {
     "test": "xo && ava && tsd"
   },
-  "version": "4.2.1"
+  "version": "6.0.0",
+  "xo": {
+    "rules": {
+      "@typescript-eslint/prefer-readonly-parameter-types": "off"
+    }
+  }
 }

package/node_modules/decompress-response/readme.md

@@ -1,4 +1,4 @@
-# decompress-response [![Build Status](https://travis-ci.org/sindresorhus/decompress-response.svg?branch=master)](https://travis-ci.org/sindresorhus/decompress-response)
+# decompress-response [![Build Status](https://travis-ci.com/sindresorhus/decompress-response.svg?branch=master)](https://travis-ci.com/sindresorhus/decompress-response)
 
 > Decompress a HTTP response if needed
 
@@ -6,14 +6,12 @@ Decompresses the [response](https://nodejs.org/api/http.html#http_class_http_inc
 
 Used by [`got`](https://github.com/sindresorhus/got).
 
-
 ## Install
 
 ```
 $ npm install decompress-response
 ```
 
-
 ## Usage
 
 ```js
@@ -25,7 +23,6 @@ http.get('https://sindresorhus.com', response => {
 });
 ```
 
-
 ## API
 
 ### decompressResponse(response)
@@ -38,12 +35,11 @@ Type: [`http.IncomingMessage`](https://nodejs.org/api/http.html#http_class_http_
 
 The HTTP incoming stream with compressed data.
 
-
 ---
 
 <div align="center">
 	<b>
-		<a href="https://tidelift.com/subscription/pkg/npm-unzip-response?utm_source=npm-unzip-response&utm_medium=referral&utm_campaign=readme">Get professional support for this package with a Tidelift subscription</a>
+		<a href="https://tidelift.com/subscription/pkg/npm-decompress-response?utm_source=npm-decompress-response&utm_medium=referral&utm_campaign=readme">Get professional support for this package with a Tidelift subscription</a>
 	</b>
 	<br>
 	<sub>