@dxos/network-manager 0.1.4 → 0.1.6

package/src/testing/test-builder.ts

@@ -0,0 +1,99 @@
+//
+// Copyright 2022 DXOS.org
+//
+
+import { PublicKey } from '@dxos/keys';
+import { MemorySignalManager, MemorySignalManagerContext, WebsocketSignalManager } from '@dxos/messaging';
+import { afterTest } from '@dxos/testutils';
+
+import { NetworkManager } from '../network-manager';
+import { FullyConnectedTopology, Topology } from '../topology';
+import { MemoryTransportFactory, TransportFactory } from '../transport';
+import { TestProtocolPlugin, testProtocolProvider } from './test-protocol';
+
+// Signal server will be started by the setup script.
+export const TEST_SIGNAL_URL = 'ws://localhost:4000/.well-known/dx/signal';
+
+export type TestBuilderOptions = {
+  signalUrl?: string;
+};
+
+// TODO(burdon): Builder pattern (see feed-store).
+export class TestBuilder {
+  private _signalContext = new MemorySignalManagerContext();
+
+  constructor(private _options: TestBuilderOptions = {}) {}
+
+  createSignalManager() {
+    if (this._options.signalUrl) {
+      return new WebsocketSignalManager([this._options.signalUrl]);
+    }
+
+    return new MemorySignalManager(this._signalContext);
+  }
+
+  createNetworkManager() {
+    return new NetworkManager({
+      signalManager: new MemorySignalManager(this._signalContext),
+      transportFactory: MemoryTransportFactory
+    });
+  }
+}
+
+export interface CreatePeerOptions {
+  topic: PublicKey;
+  peerId: PublicKey;
+  topology?: Topology;
+  signalHosts?: string[];
+  transportFactory: TransportFactory;
+}
+
+// TODO(burdon): Remove.
+const signalContext = new MemorySignalManagerContext();
+
+/**
+ * @deprecated
+ */
+export const createPeer = async ({
+  topic,
+  peerId,
+  topology = new FullyConnectedTopology(),
+  signalHosts,
+  transportFactory
+}: CreatePeerOptions) => {
+  const signalManager = signalHosts ? new WebsocketSignalManager(signalHosts!) : new MemorySignalManager(signalContext);
+  await signalManager.subscribeMessages(peerId);
+  const networkManager = new NetworkManager({
+    signalManager,
+    transportFactory
+  });
+
+  afterTest(() => networkManager.destroy());
+
+  // TODO(burdon): Use keys everywhere.
+  const plugin = new TestProtocolPlugin(peerId.asBuffer());
+  const protocolProvider = testProtocolProvider(topic.asBuffer(), peerId, plugin);
+  await networkManager.openSwarmConnection({ topic, peerId, protocol: protocolProvider, topology });
+
+  return {
+    networkManager,
+    plugin
+  };
+};
+
+// const createMemoryNetworkManager = (signalContext: MemorySignalManagerContext) => {
+//   return new NetworkManager({
+//     signalManager: new MemorySignalManager(signalContext),
+//     transportFactory: MemoryTransportFactory
+//   });
+// };
+
+// const createWebRTCNetworkManager = async (config: any, peerId: PublicKey) => {
+//   const signalManager = new WebsocketSignalManager(signalHosts!);
+//   await signalManager.subscribeMessages(peerId);
+//
+//   return new NetworkManager({
+//     signalManager,
+//     transportFactory: createWebRTCTransportFactory(config)
+//   });
+// };

package/src/testing/test-protocol.ts

@@ -31,10 +31,10 @@ export const getPeerId = (protocol: Protocol) => {
  */
 export class TestProtocolPlugin extends EventEmitter {
   /** @type {Map<string, {Protocol}>} */
-  _peers;
+  private readonly _peers = new Map(); // TODO(burdon): Complex map.
 
   /** @type {Buffer} */
-  _peerId;
+  _peerId; // TODO(burdon): PublicKey.
 
   /** @type {Boolean} */
   _uppercase;
@@ -55,21 +55,14 @@ export class TestProtocolPlugin extends EventEmitter {
     // TODO(dboreham): Mis-named because this is OUR node ID, not the id of any peer.
     this._peerId = peerId;
     this._uppercase = uppercase;
-    this._peers = new Map();
   }
 
-  /**
-   * This node's id.
-   * @return {Buffer}
-   */
+  // TODO(burdon): Expose key directly.
   get peerId() {
     return this._peerId;
   }
 
-  /**
-   * Array of the currently connected peers' node ids (not including our id).
-   * @return {{Protocol}[]}
-   */
+  // TODO(burdon): Map of keys.
   get peers() {
     return Array.from(this._peers.values());
   }
@@ -80,6 +73,7 @@ export class TestProtocolPlugin extends EventEmitter {
    * @return {Extension}
    */
   createExtension() {
+    log('creating extension', { peerId: PublicKey.from(this.peerId) }); // TODO(burdon): Just key.
     return new Extension(EXTENSION_NAME, { binary: true })
       .setInitHandler(this._init.bind(this))
       .setMessageHandler(this._receive.bind(this))
@@ -103,7 +97,8 @@ export class TestProtocolPlugin extends EventEmitter {
     // TODO(dboreham): Throw fatal error if peer not found.
     const extension = peer.getExtension(EXTENSION_NAME);
     const encoded = Buffer.from(payload);
-    log('Sent', { peerIdStr, payload });
+
+    log('sent', { peerIdStr, payload });
     return await extension.send(encoded, { oneway: true });
   }
 
@@ -119,7 +114,8 @@ export class TestProtocolPlugin extends EventEmitter {
     if (this._uppercase) {
       payload = payload.toUpperCase();
     }
-    log('Received', { peerIdStr, payload });
+
+    log('received', { peerIdStr, payload });
     this.emit('receive', protocol, payload);
   }
 
@@ -152,9 +148,11 @@ export class TestProtocolPlugin extends EventEmitter {
  * @return {ProtocolProvider}
  */
 // TODO(dboreham): Try to encapsulate swarm_key, nodeId.
-export const testProtocolProvider = (swarmKey: Buffer, nodeId: Buffer, protocolPlugin: any) =>
-  protocolFactory({
+export const testProtocolProvider = (swarmKey: Buffer, peerId: PublicKey, protocolPlugin: any) => {
+  log('creating protocol factory', { swarmKey: PublicKey.from(swarmKey), peerId });
+  return protocolFactory({
     getTopics: () => [swarmKey],
-    session: { peerId: PublicKey.stringify(nodeId) },
+    session: { peerId: peerId.toHex() },
     plugins: [protocolPlugin]
   });
+};

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

@@ -24,7 +24,7 @@ const createPair = () => {
   const peer2Id = PublicKey.random();
 
   const plugin1 = new TestProtocolPlugin(peer1Id.asBuffer());
-  const protocolProvider1 = testProtocolProvider(topic.asBuffer(), peer1Id.asBuffer(), plugin1);
+  const protocolProvider1 = testProtocolProvider(topic.asBuffer(), peer1Id, plugin1);
   const connection1 = new MemoryTransport({
     stream: protocolProvider1({ channel: discoveryKey(topic), initiator: true }).stream,
     sendSignal: async (signal) => {
@@ -37,7 +37,7 @@ const createPair = () => {
   afterTest(() => connection1.errors.assertNoUnhandledErrors());
 
   const plugin2 = new TestProtocolPlugin(peer2Id.asBuffer());
-  const protocolProvider2 = testProtocolProvider(topic.asBuffer(), peer2Id.asBuffer(), plugin2);
+  const protocolProvider2 = testProtocolProvider(topic.asBuffer(), peer2Id, plugin2);
   const connection2 = new MemoryTransport({
     stream: protocolProvider2({ channel: discoveryKey(topic), initiator: false }).stream,
     sendSignal: async (signal) => {
@@ -82,7 +82,7 @@ describe('MemoryTransport', function () {
     });
   });
 
-  it('10 pairs of peers connecting at the same time', async function () {
+  it.skip('10 pairs of peers connecting at the same time', async function () {
     await Promise.all(
       range(10).map(async () => {
         const { plugin1, plugin2, peer1Id } = createPair();

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

@@ -108,7 +108,7 @@ describe('WebRTCTransportProxy', function () {
     const peer2Id = PublicKey.random();
 
     const plugin1 = new TestProtocolPlugin(peer1Id.asBuffer());
-    const protocolProvider1 = testProtocolProvider(topic.asBuffer(), peer1Id.asBuffer(), plugin1);
+    const protocolProvider1 = testProtocolProvider(topic.asBuffer(), peer1Id, plugin1);
     const { webRTCTransportProxy: connection1 } = await setupProxy({
       initiator: true,
       stream: protocolProvider1({
@@ -123,7 +123,7 @@ describe('WebRTCTransportProxy', function () {
     afterTest(() => connection1.errors.assertNoUnhandledErrors());
 
     const plugin2 = new TestProtocolPlugin(peer2Id.asBuffer());
-    const protocolProvider2 = testProtocolProvider(topic.asBuffer(), peer2Id.asBuffer(), plugin2);
+    const protocolProvider2 = testProtocolProvider(topic.asBuffer(), peer2Id, plugin2);
     const { webRTCTransportProxy: connection2 } = await setupProxy({
       initiator: false,
       stream: protocolProvider2({
@@ -201,7 +201,7 @@ describe('WebRTCTransportProxy', function () {
       const peer2Id = PublicKey.random();
 
       const plugin1 = new TestProtocolPlugin(peer1Id.asBuffer());
-      const protocolProvider1 = testProtocolProvider(topic.asBuffer(), peer1Id.asBuffer(), plugin1);
+      const protocolProvider1 = testProtocolProvider(topic.asBuffer(), peer1Id, plugin1);
       const proxy1 = new WebRTCTransportProxy({
         initiator: true,
         stream: protocolProvider1({
@@ -217,7 +217,7 @@ describe('WebRTCTransportProxy', function () {
       afterTest(() => proxy1.errors.assertNoUnhandledErrors());
 
       const plugin2 = new TestProtocolPlugin(peer2Id.asBuffer());
-      const protocolProvider2 = testProtocolProvider(topic.asBuffer(), peer2Id.asBuffer(), plugin2);
+      const protocolProvider2 = testProtocolProvider(topic.asBuffer(), peer2Id, plugin2);
       const proxy2 = new WebRTCTransportProxy({
         initiator: false,
         stream: protocolProvider2({

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

@@ -46,7 +46,7 @@ describe('WebRTCTransport', function () {
     const peer2Id = PublicKey.random();
 
     const plugin1 = new TestProtocolPlugin(peer1Id.asBuffer());
-    const protocolProvider1 = testProtocolProvider(topic.asBuffer(), peer1Id.asBuffer(), plugin1);
+    const protocolProvider1 = testProtocolProvider(topic.asBuffer(), peer1Id, plugin1);
     const connection1 = new WebRTCTransport({
       initiator: true,
       stream: protocolProvider1({
@@ -62,7 +62,7 @@ describe('WebRTCTransport', function () {
     afterTest(() => connection1.errors.assertNoUnhandledErrors());
 
     const plugin2 = new TestProtocolPlugin(peer2Id.asBuffer());
-    const protocolProvider2 = testProtocolProvider(topic.asBuffer(), peer2Id.asBuffer(), plugin2);
+    const protocolProvider2 = testProtocolProvider(topic.asBuffer(), peer2Id, plugin2);
     const connection2 = new WebRTCTransport({
       initiator: false,
       stream: protocolProvider2({

package/src/transport/webrtc-transport.ts

@@ -61,10 +61,6 @@ export class WebRTCTransport implements Transport {
     });
   }
 
-  get peer() {
-    return this._peer;
-  }
-
   async close() {
     log('closing...');
     await this._disconnectStreams();