node-datachannel 0.12.0 → 0.20.0-alpha.2

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

@@ -1,109 +0,0 @@
-name: Build - Linux
-
-on:
-  workflow_dispatch:
-  # push:
-  #   tags:
-  #     - v*
-
-env:
-  ACTIONS_ALLOW_UNSECURE_COMMANDS: true
-
-jobs:
-  build-linux:
-    runs-on: ubuntu-20.04
-    strategy:
-      matrix:
-        node-version: [16]
-        arch: [amd64, arm64, arm]
-        platform: [debian, alpine]
-        include:
-          # Set baselines per platform
-          - triple: "alpine-linux-musl"
-            platform: alpine
-            version: 3.16
-            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
-            version: bullseye
-          # Set baselines per architecture
-          - triple_arch: x86_64
-            node_arch: x64
-            arch: amd64
-          - triple_arch: armv7
-            node_arch: arm
-            triple_postfix: eabihf
-            arch: arm
-            flags: -march=armv7-a -mfpu=neon-vfpv4 -mfloat-abi=hard -fPIC
-          - triple_arch: aarch64
-            node_arch: arm64
-            arch: arm64
-            flags: -march=armv8-a -fPIC
-          # Set edge case overrides for specific platform + 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
-            arch: arm
-            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
-      - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v4
-        with:
-          node-version: ${{ matrix.node-version }}
-      - name: Install node dependencies
-        run: npm install --ignore-scripts
-        env:
-          CI: true
-      - if: matrix.arch != 'amd64'
-        name: Set up QEMU
-        uses: docker/setup-qemu-action@v3
-        with:
-          platforms: ${{ matrix.arch }}
-      - name: Install system dependencies
-        run: |
-          sudo apt update
-          sudo apt install -y podman ninja-build ${{ matrix.gcc_install }}
-      - name: List installed libc
-        run: apt list --installed | grep libc6-dev
-      - name: Build sysroot
-        run: sudo podman build --isolation=chroot -t ndc-buildroot:${{ matrix.platform }}-${{ matrix.arch }} ./build-containers --file Dockerfile.${{ matrix.platform }} --platform linux/${{ matrix.arch }} --build-arg="version=${{ matrix.version }}" --build-arg="node_version=${{ matrix.node-version }}"
-      - name: Mount sysroot
-        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,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
-      - name: Upload
-        run: sudo --preserve-env=CI,LIBC node_modules/.bin/prebuild --arch ${{ matrix.node_arch }} -r napi --upload -u ${{ secrets.GITHUB_TOKEN }}
-        env:
-          LIBC: ${{ matrix.libc }}
-          CI: true

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

@@ -1,38 +0,0 @@
-name: Build - Mac M1
-
-on:
-  workflow_dispatch:
-  # push:
-  #   tags:
-  #     - v*
-
-
-env:
-  ACTIONS_ALLOW_UNSECURE_COMMANDS: true
-
-jobs:
-  build-macos:
-    runs-on: macos-13
-    strategy:
-      matrix:
-        node-version: [16.x]
-
-    steps:
-      - uses: actions/checkout@v4
-      - name: Install OpenSSL
-        run: |
-          wget https://mac.r-project.org/bin/darwin20/arm64/openssl-1.1.1t-darwin.20-arm64.tar.xz
-          tar -xf openssl-1.1.1t-darwin.20-arm64.tar.xz -C /tmp
-          rm -rf openssl-1.1.1t-darwin.20-arm64.tar.xz
-      - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v4
-        with:
-          node-version: ${{ matrix.node-version }}
-      - name: Build
-        run: |
-          npm install --ignore-scripts
-          node_modules/.bin/prebuild -r napi --backend cmake-js --arch arm64 --upload -u ${{ secrets.GITHUB_TOKEN }} -- --CDCMAKE_OSX_ARCHITECTURES="arm64"
-        env:
-          CI: true
-          OPENSSL_ROOT_DIR: /tmp/opt/R/arm64
-          OPENSSL_LIBRARIES: /tmp/opt/R/arm64/lib

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

@@ -1,40 +0,0 @@
-name: Build - Mac x64
-
-on:
-  workflow_dispatch:
-  # push:
-  #   tags:
-  #     - v*
-
-env:
-  ACTIONS_ALLOW_UNSECURE_COMMANDS: true
-
-jobs:
-  build-macos:
-    runs-on: macos-13
-    strategy:
-      matrix:
-        node-version: [16.x]
-
-    steps:
-      - uses: actions/checkout@v4
-      - name: Install OpenSSL
-        run: HOMEBREW_NO_INSTALL_CLEANUP=1 brew reinstall openssl@1.1
-      - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v4
-        with:
-          node-version: ${{ matrix.node-version }}
-      - name: Build
-        run: npm install --build-from-source
-        env:
-          CI: true
-          OPENSSL_ROOT_DIR: /usr/local/opt/openssl@1.1
-          OPENSSL_LIBRARIES: /usr/local/opt/openssl@1.1/lib
-      - name: Test
-        run: npm run test
-        env:
-          CI: true
-      - name: Upload
-        run: node_modules/.bin/prebuild -r napi --upload -u ${{ secrets.GITHUB_TOKEN }}
-        env:
-          CI: true

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

@@ -1,74 +0,0 @@
-name: Build - Win
-
-on:
-  workflow_dispatch:
-  # push:
-  #   tags:
-  #     - v*
-
-env:
-  ACTIONS_ALLOW_UNSECURE_COMMANDS: true
-
-jobs:
-  build-windows-x64:
-    runs-on: windows-2019
-    strategy:
-      matrix:
-        node-version: [16.x]
-
-    steps:
-      - 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@v4
-        with:
-          node-version: ${{ matrix.node-version }}
-      - name: Build
-        run: set npm_config_cache= && set NPM_CONFIG_CACHE= && npm install --build-from-source
-        env:
-          CI: true
-      # - name: Test
-      #   run: npm run test
-      #   env:
-      #     CI: true
-      - name: Upload
-        run: node_modules/.bin/prebuild -r napi --upload -u ${{ secrets.GITHUB_TOKEN }}
-        env:
-          CI: true
-
-  build-windows-x86:
-    runs-on: windows-2019
-    strategy:
-      matrix:
-        node_version: [16.x]
-        node_arch:
-          - x86
-    steps:
-      - uses: actions/checkout@v4
-      - uses: ilammy/msvc-dev-cmd@v1
-        with:
-          arch: x86
-      - name: Install OpenSSL
-      # openssl v3.1.1 [Approved]
-      # openssl package files install completed. Performing other installation steps.
-      # ERROR: 32-bit installation is not supported for openssl
-        run: choco install openssl --x86=true --version=1.1.1.2100
-      - name: Use Node.js ${{ matrix.node_version }}
-        uses: aminya/setup-node@x86
-        with:
-          node-version: ${{ matrix.node_version }}
-          node-arch: ${{ matrix.node_arch }}
-      - name: Build
-        run: set npm_config_cache= && set NPM_CONFIG_CACHE= && npm install --build-from-source
-        env:
-          CI: true
-      # - name: Test
-      #   run: npm run test
-      #   env:
-      #     CI: true
-      - name: Upload
-        run: node_modules/.bin/prebuild -r napi --upload -u ${{ secrets.GITHUB_TOKEN }}
-        env:
-          CI: true

package/.github/workflows/lint.yml

@@ -1,20 +0,0 @@
-name: Lint
-
-on:
-  pull_request:
-  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
-      - run: npm run test-types

package/.github/workflows/npm-publish-manual.yml

@@ -1,23 +0,0 @@
-name: npm Publish
-
-on:
-  workflow_dispatch:
-
-jobs:
-  npm-publish:
-    name: npm-publish
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout repository
-        uses: actions/checkout@v2
-      - name: Set up Node.js
-        uses: actions/setup-node@v1
-        with:
-          node-version: 20.x
-          registry-url: "https://registry.npmjs.org"
-      - name: Publish
-        run: |
-          npm install
-          npm publish
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}

package/.prettierrc.cjs

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

package/build-containers/Dockerfile.alpine

@@ -1,6 +0,0 @@
-ARG version=3.16
-ARG node_version=16
-FROM node:${node_version}-alpine${version}
-RUN apk add build-base openssl-libs-static openssl-dev
-
-WORKDIR /usr/app/

package/build-containers/Dockerfile.debian

@@ -1,7 +0,0 @@
-ARG version=bullseye
-ARG node_version=16
-FROM node:${node_version}-${version}
-RUN apt update
-RUN apt install -y build-essential libssl-dev
-
-WORKDIR /usr/app/

package/cmake/toolchain/ci.cmake

@@ -1,23 +0,0 @@
-set(CMAKE_SYSTEM_NAME Linux)
-set(triple $ENV{TRIPLE})
-
-# use clang and lld
-set(CMAKE_C_COMPILER $ENV{GCC})
-set(CMAKE_CXX_COMPILER $ENV{GXX})
-if (CMAKE_C_COMPILER MATCHES clang)
-    add_link_options("-fuse-ld=lld")
-endif()
-
-set(CMAKE_SYSROOT "$ENV{SYSROOT}")
-message(STATUS "Using sysroot: ${CMAKE_SYSROOT}")
-
-set(CMAKE_FIND_ROOT_PATH_MODE_PROGRAM NEVER)
-set(CMAKE_FIND_ROOT_PATH_MODE_LIBRARY ONLY)
-set(CMAKE_FIND_ROOT_PATH_MODE_INCLUDE ONLY)
-
-set(CMAKE_C_COMPILER_TARGET ${triple})
-set(CMAKE_CXX_COMPILER_TARGET ${triple})
-message(STATUS "Compiling for: ${triple}")
-
-set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} $ENV{COMPILER_FLAGS}")
-set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} $ENV{COMPILER_FLAGS}")

package/examples/client-server/README.md

@@ -1,22 +0,0 @@
-# client-server Example
-
--   You can use client-server example project to test WebRTC Data Channels with WebSocket signaling.
--   It uses same logic of [libdatachannel/examples/client](https://github.com/paullouisageneau/libdatachannel/tree/master/examples) project.
--   Contains an equivalent implementation for a node.js signaling server
-
-## How to Use?
-
--   Prepare Project
-    -   cd examples/client-server
-    -   npm i
--   Start ws signaling server;
-    -   node signaling-server.js
--   Start answerer (On a new Console);
-    -   node client.js
-    -   Note local ID
--   Start Offerer (On a new Console);
-
-    -   node client.js
-    -   Enter answerer ID
-
-    > You can also use [libdatachannel/examples/client](https://github.com/paullouisageneau/libdatachannel/tree/master/examples) project's client & signaling server

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

@@ -1,230 +0,0 @@
-// createRequire is native in node version >= 12
-import { createRequire } from 'module';
-const require = createRequire(import.meta.url);
-
-// yargs down not supports ES Modules
-const yargs = require('yargs/yargs');
-const { hideBin } = require('yargs/helpers');
-
-import readline from 'readline';
-import nodeDataChannel from '../../lib/index.js';
-
-// Init Logger
-nodeDataChannel.initLogger('Info');
-
-// PeerConnection Map
-const pcMap = {};
-
-const dcArr = [];
-
-// Local ID
-const id = randomId(4);
-
-// Message Size
-const MESSAGE_SIZE = 65535;
-
-// Buffer Size
-const BUFFER_SIZE = MESSAGE_SIZE * 0;
-
-// Args
-const argv = yargs(hideBin(process.argv))
-    .option('disableSend', {
-        type: 'boolean',
-        description: 'Disable Send',
-        default: false,
-    })
-    .option('wsUrl', {
-        type: 'string',
-        description: 'Web Socket URL',
-        default: 'ws://localhost:8000',
-    })
-    .option('dataChannelCount', {
-        type: 'number',
-        description: 'Data Channel Count To Create',
-        default: 1,
-    }).argv;
-
-// Disable Send
-const disableSend = argv.disableSend;
-if (disableSend) console.log('Send Disabled!');
-
-// Signaling Server
-const wsUrl = process.env.WS_URL || argv.wsUrl;
-console.log(wsUrl);
-const dataChannelCount = argv.dataChannelCount;
-
-// Read Line Interface
-const rl = readline.createInterface({
-    input: process.stdin,
-    output: process.stdout,
-});
-
-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.onOpen(() => {
-    console.log('WebSocket connected, signaling ready');
-    readUserInput();
-});
-
-ws.onError((err) => {
-    console.log('WebSocket Error: ', err);
-});
-
-ws.onMessage((msgStr) => {
-    let msg = JSON.parse(msgStr);
-    switch (msg.type) {
-        case 'offer':
-            createPeerConnection(msg.id);
-            pcMap[msg.id].setRemoteDescription(msg.description, msg.type);
-            break;
-        case 'answer':
-            pcMap[msg.id].setRemoteDescription(msg.description, msg.type);
-            break;
-        case 'candidate':
-            pcMap[msg.id].addRemoteCandidate(msg.candidate, msg.mid);
-            break;
-
-        default:
-            break;
-    }
-});
-
-function readUserInput() {
-    rl.question('Enter a remote ID to send an offer: ', (peerId) => {
-        if (peerId && peerId.length > 2) {
-            rl.close();
-            console.log('Offering to ', peerId);
-            createPeerConnection(peerId);
-
-            let msgToSend = randomId(MESSAGE_SIZE);
-
-            for (let i = 1; i <= dataChannelCount; i++) {
-                let dcArrItem = {
-                    dc: null,
-                    bytesSent: 0,
-                    bytesReceived: 0,
-                };
-                console.log('Creating DataChannel with label "test-' + i + '"');
-                dcArrItem.dc = pcMap[peerId].createDataChannel('test-' + i);
-
-                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.onBufferedAmountLow(() => {
-                    while (!disableSend && dcArrItem.dc.bufferedAmount() <= BUFFER_SIZE) {
-                        dcArrItem.dc.sendMessage(msgToSend);
-                        dcArrItem.bytesSent += msgToSend.length;
-                    }
-                });
-
-                dcArrItem.dc.onMessage((msg) => {
-                    dcArrItem.bytesReceived += msg.length;
-                });
-
-                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()}`,
-                    );
-                    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`,
-                );
-
-                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(`Selected Candidates# ${JSON.stringify(pcMap[peerId].getSelectedCandidatePair())}`);
-                    console.log(``);
-                }
-                i++;
-            }, 1000);
-        }
-    });
-}
-
-function createPeerConnection(peerId) {
-    // Create PeerConnection
-    let peerConnection = new nodeDataChannel.PeerConnection('pc', { iceServers: ['stun:stun.l.google.com:19302'] });
-    peerConnection.onStateChange((state) => {
-        console.log('State: ', state);
-    });
-    peerConnection.onGatheringStateChange((state) => {
-        console.log('GatheringState: ', state);
-    });
-    peerConnection.onLocalDescription((description, type) => {
-        ws.sendMessage(JSON.stringify({ id: peerId, type, description }));
-    });
-    peerConnection.onLocalCandidate((candidate, mid) => {
-        ws.sendMessage(JSON.stringify({ id: peerId, type: 'candidate', candidate, mid }));
-    });
-    peerConnection.onDataChannel((dc) => {
-        rl.close();
-        console.log('DataChannel from ' + peerId + ' received with label "', dc.getLabel() + '"');
-
-        let msgToSend = randomId(MESSAGE_SIZE);
-
-        while (!disableSend && dc.bufferedAmount() <= BUFFER_SIZE) {
-            dc.sendMessage(msgToSend);
-        }
-
-        dc.onBufferedAmountLow(() => {
-            while (!disableSend && dc.bufferedAmount() <= BUFFER_SIZE) {
-                dc.sendMessage(msgToSend);
-            }
-        });
-
-        dc.onMessage((msg) => {
-            // bytesReceived += msg.length;
-        });
-    });
-
-    pcMap[peerId] = peerConnection;
-}
-
-function randomId(length) {
-    var result = '';
-    var characters = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789';
-    var charactersLength = characters.length;
-    for (var i = 0; i < length; i++) {
-        result += characters.charAt(Math.floor(Math.random() * charactersLength));
-    }
-    return result;
-}
-
-function byte2KB(bytes) {
-    return `${Math.round(bytes / 1000)}`;
-}
-
-function byte2MB(bytes) {
-    return `${Math.round(bytes / (1000 * 1000))}`;
-}