@dxos/network-manager 2.31.6 → 2.31.8-dev.47b118c8

package/src/network-manager.blueprint-test.ts

@@ -276,6 +276,8 @@ export function inMemoryTests () {
       peers: ComplexSet<PublicKey>
       joinedPeers: ComplexSet<PublicKey>
     }
+
+    // TODO(burdon): Name?
     interface Real {
       peers: ComplexMap<PublicKey, {
         networkManager: NetworkManager
@@ -283,11 +285,11 @@ export function inMemoryTests () {
       }>
     }
 
-    async function assertState (m: Model, r: Real) {
+    async function assertState (model: Model, real: Real) {
       await waitForExpect(() => {
-        for (const peer of r.peers.values()) {
+        for (const peer of real.peers.values()) {
           if (peer.presence) {
-            for (const expectedJoinedPeer of m.joinedPeers) {
+            for (const expectedJoinedPeer of model.joinedPeers) {
               if (expectedJoinedPeer.equals(peer.presence.peerId)) {
                 continue;
               }
@@ -301,7 +303,7 @@ export function inMemoryTests () {
         }
       }, 5_000);
 
-      r.peers.forEach(peer => peer.networkManager.topics.forEach(topic => {
+      real.peers.forEach(peer => peer.networkManager.topics.forEach(topic => {
         peer.networkManager.getSwarm(topic)!.errors.assertNoUnhandledErrors();
       }));
     }
@@ -309,19 +311,19 @@ export function inMemoryTests () {
     class CreatePeerCommand implements fc.AsyncCommand<Model, Real> {
       constructor (readonly peerId: PublicKey) {}
 
-      check = (m: Model) => !m.peers.has(this.peerId);
+      check = (model: Model) => !model.peers.has(this.peerId);
 
-      async run (m: Model, r: Real) {
-        m.peers.add(this.peerId);
+      async run (model: Model, real: Real) {
+        model.peers.add(this.peerId);
 
         const networkManager = new NetworkManager();
         afterTest(() => networkManager.destroy());
 
-        r.peers.set(this.peerId, {
+        real.peers.set(this.peerId, {
           networkManager
         });
 
-        await assertState(m, r);
+        await assertState(model, real);
       }
 
       toString = () => `CreatePeer(${this.peerId})`;
@@ -330,17 +332,17 @@ export function inMemoryTests () {
     class RemovePeerCommand implements fc.AsyncCommand<Model, Real> {
       constructor (readonly peerId: PublicKey) {}
 
-      check = (m: Model) => m.peers.has(this.peerId);
+      check = (model: Model) => model.peers.has(this.peerId);
 
-      async run (m: Model, r: Real) {
-        m.peers.delete(this.peerId);
-        m.joinedPeers.delete(this.peerId);
+      async run (model: Model, real: Real) {
+        model.peers.delete(this.peerId);
+        model.joinedPeers.delete(this.peerId);
 
-        const peer = r.peers.get(this.peerId);
+        const peer = real.peers.get(this.peerId);
         await peer!.networkManager.destroy();
-        r.peers.delete(this.peerId);
+        real.peers.delete(this.peerId);
 
-        await assertState(m, r);
+        await assertState(model, real);
       }
 
       toString = () => `RemovePeer(${this.peerId})`;
@@ -349,22 +351,20 @@ export function inMemoryTests () {
     class JoinTopicCommand implements fc.AsyncCommand<Model, Real> {
       constructor (readonly peerId: PublicKey) {}
 
-      check = (m: Model) =>
-        m.peers.has(this.peerId) &&
-        !m.joinedPeers.has(this.peerId);
+      check = (model: Model) => model.peers.has(this.peerId) && !model.joinedPeers.has(this.peerId);
 
-      async run (m: Model, r: Real) {
-        m.joinedPeers.add(this.peerId);
+      async run (model: Model, real: Real) {
+        model.joinedPeers.add(this.peerId);
 
-        const peer = r.peers.get(this.peerId)!;
+        const peer = real.peers.get(this.peerId)!;
 
         const presence = new PresencePlugin(this.peerId.asBuffer());
         afterTest(() => presence.stop());
-        const protocol = createProtocolFactory(m.topic, this.peerId, [presence]);
+        const protocol = createProtocolFactory(model.topic, this.peerId, [presence]);
 
         peer.networkManager.joinProtocolSwarm({
           peerId: this.peerId, // TODO(burdon): `this`?
-          topic: m.topic,
+          topic: model.topic,
           protocol,
           topology: new FullyConnectedTopology(),
           presence
@@ -372,7 +372,7 @@ export function inMemoryTests () {
 
         peer.presence = presence;
 
-        await assertState(m, r);
+        await assertState(model, real);
       }
 
       toString = () => `JoinTopic(peerId=${this.peerId})`;
@@ -381,19 +381,17 @@ export function inMemoryTests () {
     class LeaveTopicCommand implements fc.AsyncCommand<Model, Real> {
       constructor (readonly peerId: PublicKey) {}
 
-      check = (m: Model) =>
-        m.peers.has(this.peerId) &&
-        m.joinedPeers.has(this.peerId);
+      check = (model: Model) => model.peers.has(this.peerId) && model.joinedPeers.has(this.peerId);
 
-      async run (m: Model, r: Real) {
-        m.joinedPeers.delete(this.peerId);
+      async run (model: Model, real: Real) {
+        model.joinedPeers.delete(this.peerId);
 
-        const peer = r.peers.get(this.peerId)!;
+        const peer = real.peers.get(this.peerId)!;
 
-        await peer.networkManager.leaveProtocolSwarm(m.topic);
+        await peer.networkManager.leaveProtocolSwarm(model.topic);
         peer.presence = undefined;
 
-        await assertState(m, r);
+        await assertState(model, real);
       }
 
       toString = () => `LeaveTopic(peerId=${this.peerId})`;

package/src/network-manager.ts

@@ -35,35 +35,24 @@ const log = debug('dxos:network-manager');
  */
 export class NetworkManager {
   private readonly _ice?: any[];
-  private readonly _swarms = new ComplexMap<PublicKey, Swarm>(x => x.toHex());
-  private readonly _maps = new ComplexMap<PublicKey, SwarmMapper>(x => x.toHex());
+  private readonly _swarms = new ComplexMap<PublicKey, Swarm>(key => key.toHex());
+  private readonly _maps = new ComplexMap<PublicKey, SwarmMapper>(key => key.toHex());
   private readonly _signal: SignalManager;
   private readonly _connectionLog?: ConnectionLog;
 
   public readonly topicsUpdated = new Event<void>();
 
-  get signal () {
-    return this._signal;
-  }
-
-  get topics () {
-    return Array.from(this._swarms.keys());
-  }
-
-  get connectionLog () {
-    return this._connectionLog;
-  }
-
   constructor (options: NetworkManagerOptions = {}) {
     this._ice = options.ice ?? [];
 
-    const onOffer = async (msg: SignalApi.SignalMessage) => await this._swarms.get(msg.topic)?.onOffer(msg) ?? { accept: false };
-
+    const onOffer = async (message: SignalApi.SignalMessage) =>
+      await this._swarms.get(message.topic)?.onOffer(message) ?? { accept: false };
     this._signal = options.signal
       ? new WebsocketSignalManager(options.signal, onOffer)
       : new InMemorySignalManager(onOffer);
 
-    this._signal.peerCandidatesChanged.on(([topic, candidates]) => this._swarms.get(topic)?.onPeerCandidatesChanged(candidates));
+    this._signal.peerCandidatesChanged.on(([topic, candidates]) =>
+      this._swarms.get(topic)?.onPeerCandidatesChanged(candidates));
     this._signal.onSignal.on(msg => this._swarms.get(msg.topic)?.onSignal(msg));
 
     if (options.log) {
@@ -71,6 +60,18 @@ export class NetworkManager {
     }
   }
 
+  get signal () {
+    return this._signal;
+  }
+
+  get topics () {
+    return Array.from(this._swarms.keys());
+  }
+
+  get connectionLog () {
+    return this._connectionLog;
+  }
+
   getSwarmMap (topic: PublicKey): SwarmMapper | undefined {
     return this._maps.get(topic);
   }
@@ -80,29 +81,36 @@ export class NetworkManager {
   }
 
   joinProtocolSwarm (options: SwarmOptions) {
+    // TODO(burdon): Use TS to constrain properties.
     assert(typeof options === 'object', 'Incorrect arguments format.');
     const { topic, peerId, topology, protocol, presence } = options;
     assert(PublicKey.isPublicKey(topic), 'Incorrect arguments format.');
     assert(PublicKey.isPublicKey(peerId), 'Incorrect arguments format.');
     assert(topology, 'Incorrect arguments format.');
     assert(typeof protocol === 'function', 'Incorrect arguments format.');
-    log(`Join ${options.topic} as ${options.peerId} with ${options.topology.toString()} topology.`);
 
+    log(`Join ${options.topic} as ${options.peerId} with ${options.topology.toString()} topology.`);
     if (this._swarms.has(topic)) {
-      throw new ERR_EXTENSION_RESPONSE_FAILED(GreetingCommandPlugin.EXTENSION_NAME, ERR_GREET_ALREADY_CONNECTED_TO_SWARM, `Already connected to swarm ${topic}`);
+      throw new ERR_EXTENSION_RESPONSE_FAILED(
+        GreetingCommandPlugin.EXTENSION_NAME, ERR_GREET_ALREADY_CONNECTED_TO_SWARM, `Already connected to swarm ${topic}`);
     }
 
+    // TODO(burdon): Bundle common transport related classes.
+    const transportFactory = this._signal instanceof InMemorySignalManager
+      ? inMemoryTransportFactory : createWebRtcTransportFactory({ iceServers: this._ice });
+
     const swarm = new Swarm(
       topic,
       peerId,
       topology,
       protocol,
+
+      // TODO(burdon): Merge.
       async offer => this._signal.offer(offer),
       async msg => this._signal.signal(msg),
-      () => {
-        this._signal.lookup(topic);
-      },
-      this._signal instanceof InMemorySignalManager ? inMemoryTransportFactory : createWebRtcTransportFactory({ iceServers: this._ice }),
+      () => this._signal.lookup(topic),
+
+      transportFactory,
       options.label
     );
 
@@ -144,10 +152,10 @@ export class NetworkManager {
     await this.topicsUpdated.emit();
   }
 
-  // TODO(marik-d): Remove.
   /**
-   * @default
+   * @deprecated
    */
+  // TODO(marik-d): Remove.
   async start () {
     console.warn('NetworkManger.start is deprecated.');
   }
@@ -159,6 +167,7 @@ export class NetworkManager {
         log(err);
       });
     }
+
     await this._signal.destroy();
   }
 }

package/src/swarm/swarm.ts

@@ -57,6 +57,7 @@ export class Swarm {
 
   readonly errors = new ErrorStream();
 
+  // TODO(burdon): Split up properties.
   constructor (
     private readonly _topic: PublicKey,
     private readonly _ownPeerId: PublicKey,

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

@@ -32,6 +32,7 @@ function createPair () {
     topic,
     protocolProvider1({ channel: discoveryKey(topic), initiator: true }).stream
   );
+
   afterTest(() => connection1.close());
   afterTest(() => connection1.errors.assertNoUnhandledErrors());
 
@@ -44,6 +45,7 @@ function createPair () {
     topic,
     protocolProvider2({ channel: discoveryKey(topic), initiator: false }).stream
   );
+
   afterTest(() => connection2.close());
   afterTest(() => connection2.errors.assertNoUnhandledErrors());
 

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

@@ -16,17 +16,20 @@ import { Transport, TransportFactory } from './transport';
 
 const log = debug('dxos:network-manager:swarm:transport:in-memory-transport');
 
-type ConnectionKey = [topic: PublicKey, nodeId: PublicKey, remoteId: PublicKey];
+type ConnectionKey = [topic: PublicKey, nodeId: PublicKey, remoteId: PublicKey]
 
 // Delay (in milliseconds) for data being sent through in-memory connections to simulate network latency.
 const IN_MEMORY_TRANSPORT_DELAY = 1;
 
+// TODO(burdon): Rename.
 export class InMemoryTransport implements Transport {
-  private static readonly _connections = new ComplexMap<ConnectionKey, InMemoryTransport>(([topic, nodeId, remoteId]) => topic.toHex() + nodeId.toHex() + remoteId.toHex());
+
+  // TODO(burdon): Remove global properties.
+  private static readonly _connections = new ComplexMap<ConnectionKey, InMemoryTransport>(
+    ([topic, nodeId, remoteId]) => topic.toHex() + nodeId.toHex() + remoteId.toHex());
 
   public readonly closed = new Event<void>();
   public readonly connected = new Event<void>();
-
   public readonly errors = new ErrorStream();
 
   private readonly _ownKey: ConnectionKey;
@@ -99,7 +102,6 @@ export class InMemoryTransport implements Transport {
       this._incomingDelay.unpipe();
 
       this._remoteConnection.closed.emit();
-
       this._remoteConnection._remoteConnection = undefined;
       this._remoteConnection = undefined;
     }
@@ -109,6 +111,7 @@ export class InMemoryTransport implements Transport {
   }
 }
 
+// TODO(burdon): Remove.
 export const inMemoryTransportFactory: TransportFactory = opts => new InMemoryTransport(
   opts.ownId,
   opts.remoteId,
@@ -120,11 +123,11 @@ export const inMemoryTransportFactory: TransportFactory = opts => new InMemoryTr
 /**
  * Creates a binary stream that delays data being sent through the stream by the specified amount of time.
  */
-function createStreamDelay (delay: number): NodeJS.ReadWriteStream {
+const createStreamDelay = (delay: number): NodeJS.ReadWriteStream => {
   return new Transform({
     objectMode: true,
     transform: (chunk, enc, cb) => {
       setTimeout(() => cb(null, chunk), delay);
     }
   });
-}
+};

package/src/transport/webrtc-transport.ts

@@ -105,7 +105,7 @@ export class WebrtcTransport implements Transport {
   }
 }
 
-export function createWebRtcTransportFactory (webrtcConfig?: any): TransportFactory {
+export const createWebRtcTransportFactory = (webrtcConfig?: any): TransportFactory => {
   return opts => new WebrtcTransport(
     opts.initiator,
     opts.stream,
@@ -116,4 +116,4 @@ export function createWebRtcTransportFactory (webrtcConfig?: any): TransportFact
     opts.sendSignal,
     webrtcConfig
   );
-}
+};