node-datachannel 0.12.0 → 0.20.0-alpha.2

package/polyfill/index.d.cts

@@ -1,37 +0,0 @@
-import RTCCertificate from './RTCCertificate.js';
-import RTCDataChannel from './RTCDataChannel.js';
-import RTCDtlsTransport from './RTCDtlsTransport.js';
-import RTCIceCandidate from './RTCIceCandidate.js';
-import RTCIceTransport from './RTCIceTransport.js';
-import RTCPeerConnection from './RTCPeerConnection.js';
-import RTCSctpTransport from './RTCSctpTransport.js';
-import RTCSessionDescription from './RTCSessionDescription.js';
-import { RTCDataChannelEvent, RTCPeerConnectionIceEvent } from './Events.js';
-
-export {
-    RTCCertificate,
-    RTCDataChannel,
-    RTCDtlsTransport,
-    RTCIceCandidate,
-    RTCIceTransport,
-    RTCPeerConnection,
-    RTCSctpTransport,
-    RTCSessionDescription,
-    RTCDataChannelEvent,
-    RTCPeerConnectionIceEvent,
-};
-
-declare const _default: {
-    RTCCertificate: typeof RTCCertificate;
-    RTCDataChannel: typeof RTCDataChannel;
-    RTCDtlsTransport: typeof RTCDtlsTransport;
-    RTCIceCandidate: typeof RTCIceCandidate;
-    RTCIceTransport: typeof RTCIceTransport;
-    RTCPeerConnection: typeof RTCPeerConnection;
-    RTCSctpTransport: typeof RTCSctpTransport;
-    RTCSessionDescription: typeof RTCSessionDescription;
-    RTCDataChannelEvent: typeof RTCDataChannelEvent;
-    RTCPeerConnectionIceEvent: typeof RTCPeerConnectionIceEvent;
-};
-
-export default _default;

package/test/connectivity.js

@@ -1,86 +0,0 @@
-import nodeDataChannel from '../lib/index.js';
-
-nodeDataChannel.initLogger('Debug');
-
-let dc1 = null;
-let dc2 = null;
-
-// "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
-peer1.onStateChange((state) => {
-    console.log('Peer1 State:', state);
-});
-peer1.onIceStateChange((state) => {
-    console.log('Peer1 IceState:', state);
-});
-peer1.onGatheringStateChange((state) => {
-    console.log('Peer1 GatheringState:', state);
-});
-peer1.onLocalDescription((sdp, type) => {
-    console.log('Peer1 SDP:', sdp, ' Type:', type);
-    peer2.setRemoteDescription(sdp, type);
-});
-peer1.onLocalCandidate((candidate, mid) => {
-    console.log('Peer1 Candidate:', candidate);
-    peer2.addRemoteCandidate(candidate, mid);
-});
-
-let peer2 = new nodeDataChannel.PeerConnection('Peer2', { iceServers: ['stun:stun.l.google.com:19302'] });
-
-// Set Callbacks
-peer2.onStateChange((state) => {
-    console.log('Peer2 State:', state);
-});
-peer2.onIceStateChange((state) => {
-    console.log('Peer2 IceState:', state);
-});
-peer2.onGatheringStateChange((state) => {
-    console.log('Peer2 GatheringState:', state);
-});
-peer2.onLocalDescription((sdp, type) => {
-    console.log('Peer2 SDP:', sdp, ' Type:', type);
-    peer1.setRemoteDescription(sdp, type);
-});
-peer2.onLocalCandidate((candidate, mid) => {
-    console.log('Peer2 Candidate:', candidate);
-    peer1.addRemoteCandidate(candidate, mid);
-});
-peer2.onDataChannel((dc) => {
-    console.log('Peer2 Got DataChannel: ', dc.getLabel());
-    dc2 = dc;
-    dc2.onMessage((msg) => {
-        console.log('Peer2 Received Msg:', msg);
-    });
-    dc2.sendMessage('Hello From Peer2');
-    dc2.onClosed(() => {
-        console.log('dc2 closed');
-    });
-});
-
-// Create DataChannel
-dc1 = peer1.createDataChannel('test');
-dc1.onOpen(() => {
-    dc1.sendMessage('Hello from Peer1');
-    // Binary message: Use sendMessageBinary(Buffer)
-});
-dc1.onMessage((msg) => {
-    console.log('Peer1 Received Msg:', msg);
-});
-dc1.onClosed(() => {
-    console.log('dc1 closed');
-});
-
-setTimeout(() => {
-    if (dc1) dc1.close();
-    if (dc2) dc2.close();
-    peer1.close();
-    peer2.close();
-    nodeDataChannel.cleanup();
-}, 5 * 1000);

package/test/jest-tests/basic.test.js

@@ -1,37 +0,0 @@
-import * as nodeDataChannel from '../../lib';
-
-describe('Module Definition', () => {
-    test('Module Defined', () => {
-        expect(nodeDataChannel).toBeDefined();
-        expect(nodeDataChannel.initLogger).toBeDefined();
-        expect(nodeDataChannel.PeerConnection).toBeDefined();
-        expect(typeof nodeDataChannel.PeerConnection).toBe('function');
-        expect(nodeDataChannel.DataChannel).toBeDefined();
-        expect(typeof nodeDataChannel.DataChannel).toBe('function');
-    });
-});
-
-describe('PeerConnection Classes', () => {
-    test('Create PeerConnection', () => {
-        let peer = new nodeDataChannel.PeerConnection('Peer', { iceServers: ['stun:stun.l.google.com:19302'] });
-        expect(peer).toBeDefined();
-        expect(peer.onStateChange).toBeDefined();
-        expect(peer.createDataChannel).toBeDefined();
-
-        peer.close();
-    });
-
-    test('Create Data Channel', () => {
-        let peer = new nodeDataChannel.PeerConnection('Peer', { iceServers: ['stun:stun.l.google.com:19302'] });
-        let dc = peer.createDataChannel('test', { protocol: 'test-protocol' });
-        expect(dc).toBeDefined();
-        expect(dc.getId()).toBeDefined();
-        expect(dc.getProtocol()).toBe('test-protocol');
-        expect(dc.getLabel()).toBe('test');
-        expect(dc.onOpen).toBeDefined();
-        expect(dc.onMessage).toBeDefined();
-
-        dc.close();
-        peer.close();
-    });
-});

package/test/jest-tests/multiple-run.test.js

@@ -1,73 +0,0 @@
-import { jest } from '@jest/globals';
-import * as nodeDataChannel from '../../lib';
-
-describe('P2P', () => {
-    // Default is 5000 ms but we need more
-    jest.setTimeout(12000);
-
-    test.each(Array(100).fill(0))('P2P Test-%p', (i) => {
-        return new Promise((done) => {
-            let peer1 = new nodeDataChannel.PeerConnection('Peer1', { iceServers: ['stun:stun.l.google.com:19302'] });
-            let peer2 = new nodeDataChannel.PeerConnection('Peer2', { iceServers: ['stun:stun.l.google.com:19302'] });
-            let dc1 = null;
-            let dc2 = null;
-
-            // Mocks
-            const p1DCMessageMock = jest.fn();
-            const p2DCMessageMock = jest.fn();
-
-            // Set Callbacks
-            peer1.onStateChange(() => {
-                /** */
-            });
-            peer1.onGatheringStateChange(() => {
-                /** */
-            });
-            peer1.onLocalDescription((sdp, type) => {
-                peer2.setRemoteDescription(sdp, type);
-            });
-            peer1.onLocalCandidate((candidate, mid) => {
-                peer2.addRemoteCandidate(candidate, mid);
-            });
-
-            // Set Callbacks
-            peer2.onStateChange(() => {
-                /** */
-            });
-            peer2.onGatheringStateChange(() => {
-                /** */
-            });
-            peer2.onLocalDescription((sdp, type) => {
-                peer1.setRemoteDescription(sdp, type);
-            });
-            peer2.onLocalCandidate((candidate, mid) => {
-                peer1.addRemoteCandidate(candidate, mid);
-            });
-            peer2.onDataChannel((dc) => {
-                dc2 = dc;
-                dc2.onMessage((msg) => {
-                    p2DCMessageMock(msg);
-                    dc2.sendMessage('Hello From Peer2');
-                });
-            });
-
-            dc1 = peer1.createDataChannel('test-p2p');
-            dc1.onOpen(() => {
-                dc1.sendMessage('Hello From Peer1');
-            });
-            dc1.onMessage((msg) => {
-                p1DCMessageMock(msg);
-                peer1.close();
-                peer2.close();
-
-                // DataChannel
-                expect(p1DCMessageMock.mock.calls.length).toBe(1);
-                expect(p1DCMessageMock.mock.calls[0][0]).toEqual('Hello From Peer2');
-                expect(p2DCMessageMock.mock.calls.length).toBe(1);
-                expect(p2DCMessageMock.mock.calls[0][0]).toEqual('Hello From Peer1');
-
-                done();
-            });
-        });
-    });
-});

package/test/jest-tests/p2p.test.js

@@ -1,99 +0,0 @@
-import { jest } from '@jest/globals';
-import * as nodeDataChannel from '../../lib';
-
-describe('P2P', () => {
-    // Default is 5000 ms but we need more
-    jest.setTimeout(30000);
-
-    test('P2P Test', () => {
-        return new Promise((done) => {
-            let peer1 = new nodeDataChannel.PeerConnection('Peer1', { iceServers: ['stun:stun.l.google.com:19302'] });
-            let peer2 = new nodeDataChannel.PeerConnection('Peer2', { iceServers: ['stun:stun.l.google.com:19302'] });
-            let dc1 = null;
-            let dc2 = null;
-
-            // Mocks
-            const p1StateMock = jest.fn();
-            const p1GatheringStateMock = jest.fn();
-            const p2StateMock = jest.fn();
-            const p2GatheringStateMock = jest.fn();
-            const p1SDPMock = jest.fn();
-            const p1CandidateMock = jest.fn();
-            const p2SDPMock = jest.fn();
-            const p2CandidateMock = jest.fn();
-
-            const p1DCMock = jest.fn();
-            const p1DCMessageMock = jest.fn();
-            const p2DCMock = jest.fn();
-            const p2DCMessageMock = jest.fn();
-
-            // Set Callbacks
-            peer1.onStateChange(p1StateMock);
-            peer1.onGatheringStateChange(p1GatheringStateMock);
-            peer1.onLocalDescription((sdp, type) => {
-                p1SDPMock();
-                peer2.setRemoteDescription(sdp, type);
-            });
-            peer1.onLocalCandidate((candidate, mid) => {
-                p1CandidateMock();
-                peer2.addRemoteCandidate(candidate, mid);
-            });
-
-            // Set Callbacks
-            peer2.onStateChange(p2StateMock);
-            peer2.onGatheringStateChange(p2GatheringStateMock);
-            peer2.onLocalDescription((sdp, type) => {
-                p2SDPMock();
-                peer1.setRemoteDescription(sdp, type);
-            });
-            peer2.onLocalCandidate((candidate, mid) => {
-                p2CandidateMock();
-                peer1.addRemoteCandidate(candidate, mid);
-            });
-            peer2.onDataChannel((dc) => {
-                p2DCMock();
-                dc2 = dc;
-                dc2.onMessage((msg) => {
-                    p2DCMessageMock(msg);
-                    dc2.sendMessage('Hello From Peer2');
-                });
-            });
-
-            dc1 = peer1.createDataChannel('test-p2p');
-            dc1.onOpen(() => {
-                p1DCMock();
-                dc1.sendMessage('Hello From Peer1');
-            });
-            dc1.onMessage((msg) => {
-                p1DCMessageMock(msg);
-                peer1.close();
-                peer2.close();
-
-                // State Callbacks
-                expect(p1StateMock.mock.calls.length).toBeGreaterThanOrEqual(1);
-                expect(p1GatheringStateMock.mock.calls.length).toBeGreaterThanOrEqual(1);
-                expect(p2StateMock.mock.calls.length).toBeGreaterThanOrEqual(1);
-                expect(p2GatheringStateMock.mock.calls.length).toBeGreaterThanOrEqual(1);
-
-                // SDP
-                expect(p1SDPMock.mock.calls.length).toBe(1);
-                expect(p2SDPMock.mock.calls.length).toBe(1);
-
-                // Candidates
-                expect(p1CandidateMock.mock.calls.length).toBeGreaterThanOrEqual(1);
-                expect(p2CandidateMock.mock.calls.length).toBeGreaterThanOrEqual(1);
-
-                // DataChannel
-                expect(p1DCMock.mock.calls.length).toBe(1);
-                expect(p1DCMessageMock.mock.calls.length).toBe(1);
-                expect(p1DCMessageMock.mock.calls[0][0]).toEqual('Hello From Peer2');
-                expect(p2DCMock.mock.calls.length).toBe(1);
-
-                expect(p2DCMessageMock.mock.calls.length).toBe(1);
-                expect(p2DCMessageMock.mock.calls[0][0]).toEqual('Hello From Peer1');
-
-                done();
-            });
-        });
-    });
-});

package/test/jest-tests/polyfill.test.js

@@ -1,10 +0,0 @@
-import { expect } from '@jest/globals';
-import polyfill from '../../polyfill/index.js';
-
-describe('polyfill', () => {
-    test('generateCertificate should throw', () => {
-        expect(async () => {
-            await polyfill.RTCPeerConnection.generateCertificate({});
-        }).rejects.toEqual(new DOMException('Not implemented'));
-    });
-});

package/test/jest-tests/streams.test.js

@@ -1,48 +0,0 @@
-import * as nodeDataChannel from '../../lib';
-
-function waitForGathering(peer) {
-    return new Promise((resolve) => {
-        peer.onGatheringStateChange((state) => {
-            if (state === 'complete') resolve();
-        });
-        // Handle race conditions where gathering has already completed
-        if (peer.gatheringState() === 'complete') resolve();
-
-        resolve();
-    });
-}
-
-describe('DataChannel streams', () => {
-    test('can build an echo pipeline', async () => {
-        let clientPeer = new nodeDataChannel.PeerConnection('Client', { iceServers: [] });
-        let echoPeer = new nodeDataChannel.PeerConnection('Client', { iceServers: [] });
-
-        const echoStream = new nodeDataChannel.DataChannelStream(echoPeer.createDataChannel('echo-channel'));
-        echoStream.pipe(echoStream); // Echo all received data back to the client
-
-        await waitForGathering(echoPeer);
-
-        const { sdp: echoDescSdp, type: echoDescType } = echoPeer.localDescription();
-        clientPeer.setRemoteDescription(echoDescSdp, echoDescType);
-        await waitForGathering(clientPeer);
-
-        const { sdp: clientDescSdp, type: clientDescType } = clientPeer.localDescription();
-        echoPeer.setRemoteDescription(clientDescSdp, clientDescType);
-
-        const clientChannel = await new Promise((resolve) => clientPeer.onDataChannel(resolve));
-
-        const clientResponsePromise = new Promise((resolve) => clientChannel.onMessage(resolve));
-        clientChannel.sendMessage('test message');
-
-        expect(await clientResponsePromise).toBe('test message');
-
-        clientChannel.close();
-        clientPeer.close();
-        echoPeer.close();
-    });
-});
-
-afterAll(() => {
-    // Properly cleanup so Jest does not complain about asynchronous operations that weren't stopped.
-    nodeDataChannel.cleanup();
-});

package/test/jest-tests/websocket.test.js

@@ -1,69 +0,0 @@
-import { jest } from '@jest/globals';
-import * as nodeDataChannel from '../../lib';
-
-describe('Websocket', () => {
-    const webSocketServer = new nodeDataChannel.WebSocketServer({ bindAddress: '127.0.0.1', port: 1987 });
-    const clientSocket = new nodeDataChannel.WebSocket();
-
-    // Mocks
-    const clientOnOpenMock = jest.fn();
-    const clientOnMessageMock = jest.fn();
-    const clientOnCLosedMock = jest.fn();
-
-    const webServerOnClientMock = jest.fn();
-    const webServerOnOpenMock = jest.fn();
-    const webServerOnMessageMock = jest.fn();
-    const webServerOnClosedMock = jest.fn();
-
-    webSocketServer.onClient((serverSocket) => {
-        webServerOnClientMock();
-
-        serverSocket.onOpen(() => {
-            webServerOnOpenMock();
-        });
-
-        serverSocket.onMessage((message) => {
-            webServerOnMessageMock(message);
-            serverSocket.sendMessage('reply to ' + message);
-            serverSocket.close();
-        });
-
-        serverSocket.onClosed(() => {
-            webServerOnClosedMock();
-            serverSocket.close();
-        });
-    });
-
-    test('can create a websocket client and connect to a server', (done) => {
-        clientSocket.open('ws://127.0.0.1:1987');
-        clientSocket.onOpen(() => {
-            clientOnOpenMock();
-            clientSocket.sendMessage('Hello');
-        });
-
-        clientSocket.onMessage((message) => {
-            clientOnMessageMock(message);
-        });
-
-        clientSocket.onClosed(() => {
-            clientOnCLosedMock();
-        });
-
-        setTimeout(() => {
-            expect(clientOnMessageMock.mock.calls[0][0]).toEqual('reply to Hello');
-            expect(clientOnOpenMock.mock.calls.length).toBe(1);
-            expect(clientOnMessageMock.mock.calls.length).toBe(1);
-            expect(clientOnCLosedMock.mock.calls.length).toBe(1);
-
-            expect(webServerOnMessageMock.mock.calls[0][0]).toEqual('Hello');
-            expect(webServerOnOpenMock.mock.calls.length).toBe(1);
-            expect(webServerOnMessageMock.mock.calls.length).toBe(1);
-            expect(webServerOnClosedMock.mock.calls.length).toBe(1);
-
-            clientSocket.close();
-            webSocketServer.stop();
-
-            done();
-        }, 3000);
-    });
-});

package/test/polyfill-connectivity.js

@@ -1,89 +0,0 @@
-import polyfill from '../polyfill/index.js';
-import nodeDataChannel from '../lib/index.js';
-
-nodeDataChannel.initLogger('Info');
-
-let dc1 = null;
-let dc2 = null;
-
-let peer1 = new polyfill.RTCPeerConnection({
-    peerIdentity: 'peer1',
-    iceServers: [{ urls: ['stun:stun.l.google.com:19302'] }],
-});
-
-// Set Callbacks
-peer1.onconnectionstatechange = () => {
-    console.log('Peer1 State:', peer1.connectionState);
-};
-peer1.oniceconnectionstatechange = () => {
-    console.log('Peer1 IceState:', peer1.iceConnectionState);
-};
-peer1.onicegatheringstatechange = () => {
-    console.log('Peer1 GatheringState:', peer1.iceGatheringState);
-};
-peer1.onicecandidate = (e) => {
-    console.log('Peer1 Candidate:', e.candidate.candidate);
-    peer2.addIceCandidate(e.candidate);
-};
-
-let peer2 = new polyfill.RTCPeerConnection({
-    peerIdentity: 'peer2',
-    iceServers: [{ urls: ['stun:stun.l.google.com:19302'] }],
-});
-
-// Set Callbacks
-peer2.onconnectionstatechange = () => {
-    console.log('Peer2 State:', peer2.connectionState);
-};
-peer2.oniceconnectionstatechange = () => {
-    console.log('Peer2 IceState:', peer2.iceConnectionState);
-};
-peer2.onicegatheringstatechange = () => {
-    console.log('Peer2 GatheringState:', peer2.iceGatheringState);
-};
-peer2.onicecandidate = (e) => {
-    console.log('Peer2 Candidate:', e.candidate.candidate);
-    peer1.addIceCandidate(e.candidate);
-};
-peer2.ondatachannel = (dce) => {
-    console.log('Peer2 Got DataChannel: ', dce.channel.label);
-    dc2 = dce.channel;
-    dc2.onmessage = (msg) => {
-        console.log('Peer2 Received Msg:', msg.data.toString());
-    };
-    dc2.send('Hello From Peer2');
-    dc2.onclose = () => {
-        console.log('dc2 closed');
-    };
-};
-
-dc1 = peer1.createDataChannel('test');
-dc1.onopen = () => {
-    dc1.send('Hello from Peer1');
-};
-dc1.onmessage = (msg) => {
-    console.log('Peer1 Received Msg:', msg.data.toString());
-};
-dc1.onclose = () => {
-    console.log('dc1 closed');
-};
-
-peer1
-    .createOffer({})
-    .then((desc) => {
-        // console.log(122222, desc);
-        peer2.setRemoteDescription(desc);
-    })
-    .catch((err) => console.error(err));
-
-peer2
-    .createAnswer({})
-    .then((answerDesc) => {
-        peer1.setRemoteDescription(answerDesc);
-    })
-    .catch((err) => console.error("Couldn't create answer", err));
-
-setTimeout(() => {
-    peer1.close();
-    peer2.close();
-}, 5 * 1000);

package/test/websockets.js

@@ -1,50 +0,0 @@
-import nodeDataChannel from '../lib/index.js';
-
-nodeDataChannel.initLogger('Debug');
-nodeDataChannel.preload();
-
-const webSocketServer = new nodeDataChannel.WebSocketServer({ bindAddress: '127.0.0.1', port: 1987 });
-
-webSocketServer.onClient((serverSocket) => {
-    console.log(
-        'webSocketServer.onClient() remoteAddress: ' + serverSocket.remoteAddress() + ', path: ' + serverSocket.path(),
-    );
-
-    serverSocket.onOpen(() => {
-        console.log('serverSocket.onOpen()');
-    });
-
-    serverSocket.onMessage((message) => {
-        console.log('serverSocket.onMessage():', message);
-        serverSocket.sendMessage('reply to ' + message);
-    });
-
-    serverSocket.onClosed(() => {
-        console.log('serverSocket.onClosed()');
-        serverSocket.close();
-    });
-});
-
-const clientSocket = new nodeDataChannel.WebSocket();
-
-clientSocket.onOpen(() => {
-    console.log('clientSocket.onOpen()');
-    clientSocket.sendMessage('Hello');
-});
-
-clientSocket.onMessage((message) => {
-    console.log('clientSocket.onMessage():', message);
-    clientSocket.forceClose();
-    webSocketServer.stop();
-});
-
-clientSocket.onClosed(() => {
-    console.log('clientSocket.onClosed()');
-    clientSocket.close();
-});
-
-clientSocket.open('ws://127.0.0.1:1987');
-
-setTimeout(() => {
-    nodeDataChannel.cleanup();
-}, 1000);

package/test/wpt-tests/README.md

@@ -1,46 +0,0 @@
-# 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
-