@dxos/network-manager 0.6.13 → 0.6.14-main.1366248

package/src/tests/memory-transport.test.ts

@@ -2,10 +2,10 @@
 // Copyright 2021 DXOS.org
 //
 
-import { randomBytes } from 'crypto';
+import { randomBytes } from 'node:crypto';
+import { describe, test } from 'vitest';
 
 import { PublicKey } from '@dxos/keys';
-import { test } from '@dxos/test';
 import { range } from '@dxos/util';
 
 import { basicTestSuite } from './basic-test-suite';
@@ -17,47 +17,45 @@ describe('Memory transport', () => {
   const testBuilder = new TestBuilder();
   basicTestSuite(testBuilder);
 
-  test
-    .skip('load', async () => {
-      const NUM_PAIRS = 100;
-      const NUM_ROUNDS = 10_000;
-      const PACKET_SIZE = 1_000;
-
-      const pairs = await Promise.all(
-        range(NUM_PAIRS).map(async () => {
-          const peer1 = testBuilder.createPeer();
-          const peer2 = testBuilder.createPeer();
-          await openAndCloseAfterTest([peer1, peer2]);
-
-          const topic = PublicKey.random();
-          const [swarm1, swarm2] = await joinSwarm([peer1, peer2], topic, () => new FullyConnectedTopology());
-
-          return {
-            peer1,
-            peer2,
-            topic,
-            swarm1,
-            swarm2,
-          };
-        }),
-      );
-
-      const message = randomBytes(PACKET_SIZE / 2).toString('hex');
-
-      for (let i = 0; i < NUM_ROUNDS; i++) {
-        // console.log(`Round ${i}/${NUM_ROUNDS}`);
-        await Promise.all(
-          pairs.map(async ({ swarm1, swarm2 }) => {
-            await exchangeMessages(swarm1, swarm2, message);
-          }),
-        );
-      }
-
+  test.skip('load', { timeout: 1_000_000 }, async () => {
+    const NUM_PAIRS = 100;
+    const NUM_ROUNDS = 10_000;
+    const PACKET_SIZE = 1_000;
+
+    const pairs = await Promise.all(
+      range(NUM_PAIRS).map(async () => {
+        const peer1 = testBuilder.createPeer();
+        const peer2 = testBuilder.createPeer();
+        await openAndCloseAfterTest([peer1, peer2]);
+
+        const topic = PublicKey.random();
+        const [swarm1, swarm2] = await joinSwarm([peer1, peer2], topic, () => new FullyConnectedTopology());
+
+        return {
+          peer1,
+          peer2,
+          topic,
+          swarm1,
+          swarm2,
+        };
+      }),
+    );
+
+    const message = randomBytes(PACKET_SIZE / 2).toString('hex');
+
+    for (let i = 0; i < NUM_ROUNDS; i++) {
+      // console.log(`Round ${i}/${NUM_ROUNDS}`);
       await Promise.all(
-        pairs.map(async ({ peer1, peer2, topic }) => {
-          await leaveSwarm([peer1, peer2], topic);
+        pairs.map(async ({ swarm1, swarm2 }) => {
+          await exchangeMessages(swarm1, swarm2, message);
         }),
       );
-    })
-    .timeout(1_000_000);
+    }
+
+    await Promise.all(
+      pairs.map(async ({ peer1, peer2, topic }) => {
+        await leaveSwarm([peer1, peer2], topic);
+      }),
+    );
+  });
 });

package/src/tests/property-test-suite.ts

@@ -4,11 +4,10 @@
 
 import * as fc from 'fast-check';
 import { type ModelRunSetup } from 'fast-check';
-import waitForExpect from 'wait-for-expect';
+import { test } from 'vitest';
 
 import { todo } from '@dxos/debug';
 import { PublicKey } from '@dxos/keys';
-import { test } from '@dxos/test';
 import { ComplexMap, ComplexSet, range } from '@dxos/util';
 
 import { type SwarmNetworkManager } from '../network-manager';
@@ -37,29 +36,29 @@ export const propertyTestSuite = () => {
     }
 
     const assertState = async (model: Model, real: Real) => {
-      await waitForExpect(() => {
-        for (const peer of real.peers.values()) {
-          if (peer.presence) {
-            for (const expectedPeerId of model.joinedPeers) {
-              if (expectedPeerId.equals(peer.presence.peerId)) {
-                continue;
-              }
-
-              const actuallyConnectedPeers = peer.presence!.peers;
-              if (!actuallyConnectedPeers.some((peer: any) => PublicKey.equals(expectedPeerId, peer))) {
-                // TODO(burdon): More concise error.
-                const context = {
-                  peerId: peer.presence.peerId,
-                  expectedPeerId: expectedPeerId.truncate(),
-                  connectedPeerIds: actuallyConnectedPeers.map((key: any) => key.toString('hex')),
-                };
-
-                throw new Error(`Expected peer to be in the list of joined peers: ${context}`);
-              }
+      // await waitForExpect(() => {
+      for (const peer of real.peers.values()) {
+        if (peer.presence) {
+          for (const expectedPeerId of model.joinedPeers) {
+            if (expectedPeerId.equals(peer.presence.peerId)) {
+              continue;
+            }
+
+            const actuallyConnectedPeers = peer.presence!.peers;
+            if (!actuallyConnectedPeers.some((peer: any) => PublicKey.equals(expectedPeerId, peer))) {
+              // TODO(burdon): More concise error.
+              const context = {
+                peerId: peer.presence.peerId,
+                expectedPeerId: expectedPeerId.truncate(),
+                connectedPeerIds: actuallyConnectedPeers.map((key: any) => key.toString('hex')),
+              };
+
+              throw new Error(`Expected peer to be in the list of joined peers: ${context}`);
             }
           }
         }
-      }, 5_000);
+      }
+      // }, 5_000);
 
       real.peers.forEach((peer) =>
         peer.networkManager.topics.forEach((topic) => {

package/src/tests/tcp-transport.node.test.ts

@@ -0,0 +1,65 @@
+//
+// Copyright 2021 DXOS.org
+//
+
+import { randomBytes } from 'node:crypto';
+import { describe, test } from 'vitest';
+
+import { PublicKey } from '@dxos/keys';
+import { range } from '@dxos/util';
+
+import { basicTestSuite } from './basic-test-suite';
+import { exchangeMessages, joinSwarm, leaveSwarm, openAndCloseAfterTest } from './utils';
+import { TestBuilder } from '../testing';
+import { FullyConnectedTopology } from '../topology';
+import { TransportKind } from '../transport';
+
+describe('Tcp transport', () => {
+  const testBuilder = new TestBuilder({
+    transport: TransportKind.TCP,
+  });
+
+  basicTestSuite(testBuilder);
+
+  test.skip('load', { timeout: 1_000_000 }, async () => {
+    const NUM_PAIRS = 100;
+    const NUM_ROUNDS = 10_000;
+    const PACKET_SIZE = 1_000;
+
+    const pairs = await Promise.all(
+      range(NUM_PAIRS).map(async () => {
+        const peer1 = testBuilder.createPeer();
+        const peer2 = testBuilder.createPeer();
+        await openAndCloseAfterTest([peer1, peer2]);
+
+        const topic = PublicKey.random();
+        const [swarm1, swarm2] = await joinSwarm([peer1, peer2], topic, () => new FullyConnectedTopology());
+
+        return {
+          peer1,
+          peer2,
+          topic,
+          swarm1,
+          swarm2,
+        };
+      }),
+    );
+
+    const message = randomBytes(PACKET_SIZE / 2).toString('hex');
+
+    for (let i = 0; i < NUM_ROUNDS; i++) {
+      // console.log(`Round ${i}/${NUM_ROUNDS}`);
+      await Promise.all(
+        pairs.map(async ({ swarm1, swarm2 }) => {
+          await exchangeMessages(swarm1, swarm2, message);
+        }),
+      );
+    }
+
+    await Promise.all(
+      pairs.map(async ({ peer1, peer2, topic }) => {
+        await leaveSwarm([peer1, peer2], topic);
+      }),
+    );
+  });
+});

package/src/tests/utils.ts

@@ -2,9 +2,10 @@
 // Copyright 2022 DXOS.org
 //
 
+import { onTestFinished } from 'vitest';
+
 import { asyncTimeout } from '@dxos/async';
 import { type PublicKey } from '@dxos/keys';
-import { afterTest } from '@dxos/test';
 import { type Provider } from '@dxos/util';
 
 import { type TestPeer, type TestSwarmConnection } from '../testing';
@@ -19,7 +20,7 @@ import { type Topology } from '../topology';
  */
 export const openAndCloseAfterTest = async (peers: TestPeer[]) => {
   await Promise.all(peers.map((peer) => peer.open()));
-  afterTest(async () => {
+  onTestFinished(async () => {
     await asyncTimeout(Promise.all(peers.map((peer) => peer.close())), 1_000);
   });
 };

package/src/tests/webrtc-transport.test.ts

@@ -2,29 +2,29 @@
 // Copyright 2021 DXOS.org
 //
 
-import { describe } from '@dxos/test';
+import { describe } from 'vitest';
 
 import { basicTestSuite } from './basic-test-suite';
 import { TEST_SIGNAL_HOSTS, TestBuilder } from '../testing';
 
-describe('WebRTC transport', () => {
+describe('WebRTC transport', { timeout: 10_000 }, () => {
   const testBuilder = new TestBuilder();
   basicTestSuite(testBuilder);
-}).timeout(10_000);
+});
 
-describe('WebRTC transport proxy', () => {
+describe('WebRTC transport proxy', { timeout: 10_000 }, () => {
   const testBuilder = new TestBuilder({ bridge: true });
   basicTestSuite(testBuilder);
-}).timeout(10_000);
+});
 
-describe('test with signal server', () => {
-  describe('WebRTC transport', () => {
+describe.skip('test with signal server', () => {
+  describe('WebRTC transport', { timeout: 10_000 }, () => {
     const testBuilder = new TestBuilder({ signalHosts: TEST_SIGNAL_HOSTS });
     basicTestSuite(testBuilder);
-  }).timeout(10_000);
+  });
 
-  describe('WebRTC transport proxy', () => {
+  describe('WebRTC transport proxy', { timeout: 10_000 }, () => {
     const testBuilder = new TestBuilder({ signalHosts: TEST_SIGNAL_HOSTS, bridge: true });
     basicTestSuite(testBuilder);
-  }).timeout(10_000);
+  });
 });

package/src/transport/index.ts

@@ -4,8 +4,4 @@
 
 export * from './memory-transport';
 export * from './transport';
-export * from './simplepeer-transport';
-export * from './simplepeer-transport-service';
-export * from './simplepeer-transport-proxy';
-export * from './libdatachannel-transport';
-export * from './tcp-transport';
+export * from './webrtc';

package/src/transport/memory-transport.ts

@@ -123,6 +123,7 @@ export class MemoryTransport implements Transport {
           this.errors.raise(err);
         });
     }
+    return this;
   }
 
   async close() {
@@ -155,6 +156,7 @@ export class MemoryTransport implements Transport {
 
     this.closed.emit();
     log('closed');
+    return this;
   }
 
   async onSignal({ payload }: Signal) {

package/src/transport/tcp/index.ts

@@ -0,0 +1,5 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+export * from './tcp-transport';

package/src/transport/{tcp-transport.browser.ts → tcp/tcp-transport.browser.ts}

@@ -5,7 +5,7 @@
 import { Event } from '@dxos/async';
 import { ErrorStream } from '@dxos/debug';
 
-import { type Transport, type TransportFactory, type TransportStats } from './transport';
+import { type Transport, type TransportFactory, type TransportStats } from '../transport';
 
 export const TcpTransportFactory: TransportFactory = {
   createTransport: () => new TcpTransport(),
@@ -23,9 +23,13 @@ export class TcpTransport implements Transport {
     return true;
   }
 
-  async open() {}
+  async open() {
+    return this;
+  }
 
-  async close() {}
+  async close() {
+    return this;
+  }
 
   async onSignal() {
     throw new Error('Method not implemented.');

package/src/transport/{tcp-transport.ts → tcp/tcp-transport.ts}

@@ -9,7 +9,7 @@ import { ErrorStream } from '@dxos/debug';
 import { log } from '@dxos/log';
 import { type Signal } from '@dxos/protocols/proto/dxos/mesh/swarm';
 
-import { type Transport, type TransportFactory, type TransportOptions, type TransportStats } from './transport';
+import { type Transport, type TransportFactory, type TransportOptions, type TransportStats } from '../transport';
 
 export const TcpTransportFactory: TransportFactory = {
   createTransport: (options) => new TcpTransport(options),
@@ -72,6 +72,7 @@ export class TcpTransport implements Transport {
         this._server.listen(0);
       });
     }
+    return this;
   }
 
   async close() {
@@ -79,6 +80,7 @@ export class TcpTransport implements Transport {
     this._socket?.destroy();
     this._server?.close();
     this._closed = true;
+    return this;
   }
 
   async onSignal({ payload }: Signal) {

package/src/transport/transport.ts

@@ -8,9 +8,8 @@ import { type PublicKey } from '@dxos/keys';
 import { type Signal } from '@dxos/protocols/proto/dxos/mesh/swarm';
 
 export enum TransportKind {
-  SIMPLE_PEER = 'SIMPLE_PEER',
-  SIMPLE_PEER_PROXY = 'SIMPLE_PEER_PROXY',
-  LIBDATACHANNEL = 'LIBDATACHANNEL',
+  WEB_RTC = 'WEB-RTC',
+  WEB_RTC_PROXY = 'WEB-RTC_PROXY',
   MEMORY = 'MEMORY',
   TCP = 'TCP',
 }
@@ -25,10 +24,8 @@ export interface Transport {
   connected: Event;
   errors: ErrorStream;
 
-  open(): Promise<void>;
-  close(): Promise<void>;
-
-  get isOpen(): boolean;
+  open(): Promise<this>;
+  close(): Promise<this>;
 
   /**
    * Handle message from signaling.
@@ -50,6 +47,10 @@ export interface Transport {
  * Common options for all transports.
  */
 export type TransportOptions = {
+  ownPeerKey: string;
+  remotePeerKey: string;
+
+  topic: string;
   /**
    * Did local node initiate this connection.
    */

package/src/transport/webrtc/index.ts

@@ -0,0 +1,7 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+export * from './rtc-transport-factory';
+export * from './rtc-transport-proxy';
+export * from './rtc-transport-service';

package/src/transport/webrtc/rtc-connection-factory.ts

@@ -0,0 +1,82 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import { Mutex } from '@dxos/async';
+
+export type ConnectionInfo = {
+  initiator: boolean;
+};
+
+export interface RtcConnectionFactory {
+  initialize(): Promise<void>;
+  onConnectionDestroyed(): Promise<void>;
+  createConnection(config: RTCConfiguration): Promise<RTCPeerConnection>;
+  initConnection(connection: RTCPeerConnection, info: ConnectionInfo): Promise<void>;
+}
+
+/**
+ * Use built-in browser RTCPeerConnection.
+ */
+class BrowserRtcConnectionFactory implements RtcConnectionFactory {
+  async initialize() {}
+  async onConnectionDestroyed() {}
+
+  async createConnection(config: RTCConfiguration) {
+    return new RTCPeerConnection(config);
+  }
+
+  async initConnection(connection: RTCPeerConnection, info: ConnectionInfo): Promise<void> {}
+}
+
+/**
+ * Use `node-datachannel` polyfill.
+ * https://github.com/paullouisageneau/libdatachannel
+ */
+class NodeRtcConnectionFactory implements RtcConnectionFactory {
+  private static _createdConnections = 0;
+  private static _cleanupMutex = new Mutex();
+
+  // This should be inside the function to avoid triggering `eval` in the global scope.
+  // eslint-disable-next-line no-new-func
+
+  // TODO(burdon): Do imports here?
+  async initialize() {}
+  async onConnectionDestroyed() {
+    return NodeRtcConnectionFactory._cleanupMutex.executeSynchronized(async () => {
+      if (--NodeRtcConnectionFactory._createdConnections === 0) {
+        (await import('#node-datachannel')).cleanup();
+      }
+    });
+  }
+
+  async createConnection(config: RTCConfiguration) {
+    return NodeRtcConnectionFactory._cleanupMutex.executeSynchronized(async () => {
+      const { RTCPeerConnection } = await import('#node-datachannel/polyfill');
+      NodeRtcConnectionFactory._createdConnections++;
+      return new RTCPeerConnection(config);
+    });
+  }
+
+  async initConnection(connection: RTCPeerConnection, info: ConnectionInfo): Promise<void> {
+    // Initiator peer is responsible for data-channel creation. This triggers the callback in browsers.
+    // In node-datachannel/polyfill createOffer() / setLocalDescription(offer) are no-ops, the process
+    // is handled by c++ implementation when a data-channel gets created.
+    // By calling the method here we'll start waiting for an offer promise that'll resolve on data-channel creation
+    // at which point we'll need to send an SDP to a remote peer.
+    // https://github.com/murat-dogan/node-datachannel/blob/master/polyfill/RTCPeerConnection.js#L452C1-L459C6
+    //
+    if (info.initiator) {
+      connection.onnegotiationneeded?.(null as any);
+    }
+  }
+}
+
+/**
+ * Create platform-specific connection factory.
+ */
+export const getRtcConnectionFactory = (): RtcConnectionFactory => {
+  return typeof (globalThis as any).RTCPeerConnection === 'undefined'
+    ? new NodeRtcConnectionFactory()
+    : new BrowserRtcConnectionFactory();
+};