@dxos/network-manager 2.33.9-dev.d0ae5f95 → 2.33.9-dev.d0dce35f

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

@@ -25,21 +25,16 @@ const log = debug('dxos:network-manager:test');
 interface CreatePeerOptions {
   topic: PublicKey
   peerId: PublicKey
-  inMemory?: boolean
   topology?: Topology
   signal?: string[]
   ice?: any
 }
 
-const signalApiPort = 12098;
-const signalApiUrl = 'ws://0.0.0.0:' + signalApiPort;
-
 const createPeer = async ({
   topic,
   peerId,
-  inMemory,
   topology = new FullyConnectedTopology(),
-  signal = !inMemory ? [signalApiUrl] : undefined,
+  signal,
   ice
 }: CreatePeerOptions) => {
   const networkManager = new NetworkManager({ signal, ice });
@@ -55,14 +50,14 @@ const createPeer = async ({
   };
 };
 
-const sharedTests = (inMemory: boolean) => {
+const sharedTests = ({ inMemory, signalUrl } : { inMemory: boolean, signalUrl?: string }) => {
   it('two peers connect to each other', async () => {
     const topic = PublicKey.random();
     const peer1Id = PublicKey.random();
     const peer2Id = PublicKey.random();
 
-    const { plugin: plugin1, networkManager: nm1 } = await createPeer({ topic, peerId: peer1Id, inMemory });
-    const { plugin: plugin2, networkManager: nm2 } = await createPeer({ topic, peerId: peer2Id, inMemory });
+    const { plugin: plugin1, networkManager: nm1 } = await createPeer({ topic, peerId: peer1Id, signal: !inMemory ? [signalUrl!] : undefined });
+    const { plugin: plugin2, networkManager: nm2 } = await createPeer({ topic, peerId: peer2Id, signal: !inMemory ? [signalUrl!] : undefined });
 
     const received: any[] = [];
     const mockReceive = (p: Protocol, s: string) => {
@@ -74,24 +69,22 @@ const sharedTests = (inMemory: boolean) => {
     plugin2.on('connect', async () => {
       await plugin2.send(peer1Id.asBuffer(), 'Foo');
     });
-
     await waitForExpect(() => {
       expect(received.length).toBe(2);
       expect(received[0]).toBeInstanceOf(Protocol);
       expect(received[1]).toBe('Foo');
     });
-
     await nm1.destroy();
     await nm2.destroy();
-  }).timeout(10_000).retries(3);
+  }).timeout(10_000).retries(10);
 
   it('join and leave swarm', async () => {
     const topic = PublicKey.random();
     const peer1Id = PublicKey.random();
     const peer2Id = PublicKey.random();
 
-    const { networkManager: networkManager1, plugin: plugin1 } = await createPeer({ topic, peerId: peer1Id, inMemory });
-    const { networkManager: networkManager2, plugin: plugin2 } = await createPeer({ topic, peerId: peer2Id, inMemory });
+    const { networkManager: networkManager1, plugin: plugin1 } = await createPeer({ topic, peerId: peer1Id, signal: !inMemory ? [signalUrl!] : undefined });
+    const { networkManager: networkManager2, plugin: plugin2 } = await createPeer({ topic, peerId: peer2Id, signal: !inMemory ? [signalUrl!] : undefined });
 
     await Promise.all([
       Event.wrap(plugin1, 'connect').waitForCount(1),
@@ -117,11 +110,53 @@ const sharedTests = (inMemory: boolean) => {
     log('Peer1 destroyed');
     await networkManager2.destroy();
     log('Peer2 destroyed');
-  }).timeout(10_000).retries(3);
+  }).timeout(10_000).retries(10);
+
+  it('join and leave swarm and reconnect', async () => {
+    const topic = PublicKey.random();
+    const peer1Id = PublicKey.random();
+    const peer2Id = PublicKey.random();
+
+    const { networkManager: networkManager1, plugin: plugin1 } = await createPeer({ topic, peerId: peer1Id, signal: !inMemory ? [signalUrl!] : undefined });
+    const { networkManager: networkManager2, plugin: plugin2 } = await createPeer({ topic, peerId: peer2Id, signal: !inMemory ? [signalUrl!] : undefined });
+
+    await Promise.all([
+      Event.wrap(plugin1, 'connect').waitForCount(1),
+      Event.wrap(plugin2, 'connect').waitForCount(1)
+    ]);
+
+    log('Connected');
+
+    const disconnectPromises = Promise.all([
+      Event.wrap(plugin1, 'disconnect').waitForCount(1),
+      Event.wrap(plugin2, 'disconnect').waitForCount(1)
+    ]);
+
+    const connectPromises = Promise.all([
+      Event.wrap(plugin1, 'connect').waitForCount(1),
+      Event.wrap(plugin2, 'connect').waitForCount(1)
+    ]);
+
+    log('Disconnecting peer2');
+    await networkManager2.leaveProtocolSwarm(topic);
+
+    log('Reconnecting peer2');
+    const newPeer2Id = PublicKey.random();
+    networkManager2.joinProtocolSwarm({ topic, peerId: newPeer2Id, protocol: testProtocolProvider(topic.asBuffer(), peer2Id.asBuffer(), plugin2), topology: new FullyConnectedTopology() });
+
+    await disconnectPromises;
+
+    await connectPromises;
+
+    await networkManager1.destroy();
+    log('Peer1 destroyed');
+    await networkManager2.destroy();
+    log('Peer2 destroyed');
+  }).timeout(10_000).retries(10);
 };
 
 // eslint-disable-next-line jest/no-export
-export const webRTCTests = () => {
+export const webRTCTests = ({ signalUrl } : { signalUrl?: string } = {}) => {
   let topic: PublicKey;
   let peer1Id: PublicKey;
   let peer2Id: PublicKey;
@@ -132,7 +167,7 @@ export const webRTCTests = () => {
     peer2Id = PublicKey.random();
   });
 
-  sharedTests(false);
+  sharedTests({ inMemory: false, signalUrl });
 
   it.skip('two peers with different signal & turn servers', async () => {
     const { networkManager: networkManager1, plugin: plugin1 } = await createPeer({ topic, peerId: peer1Id, signal: ['wss://apollo3.kube.moon.dxos.network/dxos/signal'], ice: [{ urls: 'turn:apollo3.kube.moon.dxos.network:3478', username: 'dxos', credential: 'dxos' }] });
@@ -158,7 +193,7 @@ export const webRTCTests = () => {
 
     await networkManager1.destroy();
     await networkManager2.destroy();
-  }).timeout(10_000).retries(3);
+  }).timeout(10_000).retries(10);
 
   describe('StarTopology', () => {
     it('two peers connect to each other', async () => {
@@ -181,13 +216,13 @@ export const webRTCTests = () => {
         expect(received[0]).toBeInstanceOf(Protocol);
         expect(received[1]).toBe('Foo');
       });
-    }).timeout(10_000).retries(3);
+    }).timeout(10_000).retries(10);
   });
 };
 
 // eslint-disable-next-line jest/no-export
 export function inMemoryTests () {
-  sharedTests(true);
+  sharedTests({ inMemory: true });
 
   it('two swarms at the same time', async () => {
     const topicA = PublicKey.random();
@@ -197,10 +232,10 @@ export function inMemoryTests () {
     const peerB1Id = PublicKey.random();
     const peerB2Id = PublicKey.random();
 
-    const { plugin: pluginA1 } = await createPeer({ topic: topicA, peerId: peerA1Id, inMemory: true });
-    const { plugin: pluginA2 } = await createPeer({ topic: topicA, peerId: peerA2Id, inMemory: true });
-    const { plugin: pluginB1 } = await createPeer({ topic: topicB, peerId: peerB1Id, inMemory: true });
-    const { plugin: pluginB2 } = await createPeer({ topic: topicB, peerId: peerB2Id, inMemory: true });
+    const { plugin: pluginA1 } = await createPeer({ topic: topicA, peerId: peerA1Id });
+    const { plugin: pluginA2 } = await createPeer({ topic: topicA, peerId: peerA2Id });
+    const { plugin: pluginB1 } = await createPeer({ topic: topicB, peerId: peerB1Id });
+    const { plugin: pluginB2 } = await createPeer({ topic: topicB, peerId: peerB2Id });
 
     const receivedA: any[] = [];
     const mockReceiveA = (p: Protocol, s: string) => {
@@ -241,7 +276,7 @@ export function inMemoryTests () {
 
       await Promise.all(range(peersPerTopic).map(async (_, index) => {
         const peerId = PublicKey.random();
-        const { plugin } = await createPeer({ topic, peerId, inMemory: true });
+        const { plugin } = await createPeer({ topic, peerId });
 
         const [done, pongReceived] = latch(peersPerTopic - 1);
 
@@ -455,5 +490,5 @@ export function inMemoryTests () {
         ]
       }
     );
-  }).timeout(30_000).retries(3);
+  }).timeout(30_000).retries(10);
 }

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

@@ -6,7 +6,7 @@ import { inMemoryTests, webRTCTests } from './network-manager.blueprint-test';
 
 describe('Network manager', () => {
   describe('WebRTC transport', () => {
-    webRTCTests();
+    webRTCTests({ signalUrl: 'ws://localhost:12087/.well-known/dx/signal' });
   }).timeout(10_000);
 
   // TODO(marik-d): In-memory tests seem to be broken in the browser. Need more investigation.

package/src/network-manager.test.ts

@@ -2,24 +2,25 @@
 // Copyright 2021 DXOS.org
 //
 
-import { Awaited } from '@dxos/async';
-import { createTestBroker } from '@dxos/signal';
+import { createTestBroker, TestBroker } from '@dxos/signal';
 
 import { webRTCTests, inMemoryTests } from './network-manager.blueprint-test';
 
+const PORT = 12087;
+
 describe('Network manager', () => {
   describe('WebRTC transport', () => {
-    let broker: Awaited<ReturnType<typeof createTestBroker>>;
+    let broker: TestBroker;
 
     before(async () => {
-      broker = await createTestBroker(12098);
+      broker = await createTestBroker(PORT);
     });
 
-    after(async () => {
-      await broker?.stop();
+    after(() => {
+      broker?.stop();
     });
 
-    webRTCTests();
+    webRTCTests({ signalUrl: `ws://localhost:${PORT}/.well-known/dx/signal` });
   }).timeout(10_000);
 
   describe('In-memory transport', () => {

package/src/network-manager.ts

@@ -12,8 +12,8 @@ import { PublicKey } from '@dxos/protocols';
 import { ComplexMap } from '@dxos/util';
 
 import { ConnectionLog } from './connection-log';
-import { Message } from './proto/gen/dxos/mesh/signal';
-import { InMemorySignalManager, SignalManager, WebsocketSignalManager } from './signal';
+import { SignalMessage } from './proto/gen/dxos/mesh/signalMessage';
+import { InMemorySignalManager, SignalManager, SignalManagerImpl } from './signal';
 import { MessageRouter } from './signal/message-router';
 import { Swarm, SwarmMapper } from './swarm';
 import { Topology } from './topology';
@@ -48,20 +48,20 @@ export class NetworkManager {
   constructor (options: NetworkManagerOptions = {}) {
     this._ice = options.ice ?? [];
 
-    const onOffer = async (message: Message) =>
+    const onOffer = async (message: SignalMessage) =>
       await this._swarms.get(message.topic!)?.onOffer(message) ?? { accept: false };
 
     this._signalManager = options.signal
-      ? new WebsocketSignalManager(options.signal, onOffer)
+      ? new SignalManagerImpl(options.signal)
       : new InMemorySignalManager(onOffer);
 
-    this._signalManager.peerCandidatesChanged
-      .on(([topic, candidates]) => this._swarms.get(topic)?.onPeerCandidatesChanged(candidates));
+    this._signalManager.swarmEvent
+      .on(([topic, event]) => this._swarms.get(topic)?.onSwarmEvent(event));
 
-    this._signalManager.onSignal.on(msg => this._messageRouter.receiveMessage(msg));
+    this._signalManager.onMessage.on(msg => this._messageRouter.receiveMessage(msg));
 
     this._messageRouter = new MessageRouter({
-      sendMessage: msg => this._signalManager.signal(msg),
+      sendMessage: msg => this._signalManager.message(msg),
       onSignal: async (msg) => this._swarms.get(msg.topic!)?.onSignal(msg),
       onOffer: msg => onOffer(msg)
     });
@@ -118,7 +118,6 @@ export class NetworkManager {
       topology,
       protocol,
       this._messageRouter,
-      this._signalManager.lookup.bind(this._signalManager),
       transportFactory,
       options.label
     );

package/src/proto/defs/dxos/mesh/signal.proto

@@ -1,51 +1,69 @@
-//
-// Copyright 2020 DXOS.org
-//
-
 syntax = "proto3";
 
-import "@dxos/protocols/src/proto/dxos/halo/keys.proto";
+import "google/protobuf/any.proto";
+import "google/protobuf/empty.proto";
+import "google/protobuf/timestamp.proto";
 
 package dxos.mesh.signal;
 
+option go_package = "github.com/dxos/kube/go/signal/pb";
+
+message JoinRequest {
+    bytes swarm = 1;
+    bytes peer = 2;
+}
+
 message Message {
-  /// Sender's public key.
-  PubKey id = 1;
-  /// Receiver`s public key.
-  PubKey remoteId = 2;
-  /// Swarm identefier.
-  PubKey topic = 3;
-  /// Unique connection identifier.
-  PubKey sessionId = 4;
-  /// Message payload.
-  MessageData data = 5;
-  /// Unique message identifier. Used for Acknolegment and matching Anwers to Offers.
-  PubKey messageId = 6;
+    bytes author = 1;
+    bytes recipient = 2;
+    google.protobuf.Any payload = 3;
 }
 
-message MessageData {
-  oneof payload {
-    Offer offer = 1;
-    Answer answer = 2;
-    Signal signal = 3;
-    Acknowledgement ack = 4;
-  }
+message ReceptionRequest {
+    bytes peer = 1;
 }
 
-message Offer {
+// Goes on Pub/Sub swarm topic and as a Join stream in RPC.
+message SwarmEvent {
+    message PeerAvailable {
+        bytes peer = 1;
+        google.protobuf.Timestamp since = 2;
+        // When, if at all (handle the default value as not), this availability would expires were it not re-announced, like
+        // periodically in Pub/Sub with some margin such that Pub/Sub network partitions lead to offline statuses.
+        optional google.protobuf.Timestamp until = 3;
+
+        // Only relevant in Pub/Sub. Optional, the host topic to eagerly send PeerAvailable messages back to.
+        optional bytes announceBackToHost = 4;
+    }
+
+    message PeerLeft {
+        bytes peer = 1;
+    }
+
+    oneof event {
+        // The peer was announced as available on the swarm.
+        PeerAvailable peerAvailable = 1;
+        // The peer left, or their announcement timed out.
+        PeerLeft peerLeft = 2;
+    }
 }
 
-message Answer {
-  bool accept = 1;
-  /// MessageId of the Offer being answered.
-  PubKey offerMessageId = 2;
+// Goes on a Pub/Sub host topic.
+message HostEvent {
+    oneof event {
+        SwarmEvent.PeerAvailable peerAvailable = 1;
+    }
 }
 
-message Signal {
-  string json = 1;
+// Goes on Pub/Sub peer topic.
+message PeerEvent {
+    oneof event {
+        Message message = 1;
+    }
 }
 
-message Acknowledgement {
-  // MessageId of the Message being acknowledged.
-  PubKey messageId = 1;
- }
+service Signal {
+    rpc Join(JoinRequest) returns (stream SwarmEvent);
+    rpc ReceiveMessages(ReceptionRequest) returns (stream Message);
+    rpc SendMessage(Message) returns (google.protobuf.Empty);
+}

package/src/proto/defs/dxos/mesh/signalMessage.proto

@@ -0,0 +1,51 @@
+//
+// Copyright 2020 DXOS.org
+//
+
+syntax = "proto3";
+
+import "@dxos/protocols/src/proto/dxos/halo/keys.proto";
+
+package dxos.mesh.signalMessage;
+
+message SignalMessage {
+  /// Sender's public key.
+  PubKey id = 1;
+  /// Receiver`s public key.
+  PubKey remoteId = 2;
+  /// Swarm identefier.
+  PubKey topic = 3;
+  /// Unique connection identifier.
+  PubKey sessionId = 4;
+  /// Message payload.
+  MessageData data = 5;
+  /// Unique message identifier. Used for Acknolegment and matching Anwers to Offers.
+  optional PubKey messageId = 6;
+}
+
+message MessageData {
+  oneof payload {
+    Offer offer = 1;
+    Answer answer = 2;
+    Signal signal = 3;
+    Acknowledgement ack = 4;
+  }
+}
+
+message Offer {
+}
+
+message Answer {
+  bool accept = 1;
+  /// MessageId of the Offer being answered.
+  optional PubKey offerMessageId = 2;
+}
+
+message Signal {
+  string json = 1;
+}
+
+message Acknowledgement {
+  // MessageId of the Message being acknowledged.
+  PubKey messageId = 1;
+ }

package/src/proto/gen/dxos/credentials.ts

@@ -2,26 +2,66 @@ import type { Stream } from "@dxos/codec-protobuf";
 import substitutions from "../../substitutions";
 import * as dxos_halo_keys from "./halo/keys";
 import * as dxos_mesh_signal from "./mesh/signal";
+import * as dxos_mesh_signalMessage from "./mesh/signalMessage";
 import * as google_protobuf from "../google/protobuf";
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../common/protocols/src/proto/dxos/halo/signed.proto}
+ */
 export interface Message {
     payload: google_protobuf.Any;
 }
 /**
  * A generic container message used whenever messages are signed (e.g. PartyCredential)
+ *
+ * Defined in:
+ *   {@link file://./../../../../../../common/protocols/src/proto/dxos/halo/signed.proto}
  */
 export interface SignedMessage {
+    /**
+     * The signed message contents.
+     */
     signed: SignedMessage.Signed;
+    /**
+     * An array of Signatures, one for each key that signed the message.
+     */
     signatures?: SignedMessage.Signature[];
 }
 export namespace SignedMessage {
+    /**
+     * Defined in:
+     *   {@link file://./../../../../../../common/protocols/src/proto/dxos/halo/signed.proto}
+     */
     export interface Signed {
+        /**
+         * RFC-3339 datetime string.
+         */
         created: string;
         nonce: Uint8Array;
+        /**
+         * The payload to be signed.
+         */
         payload: google_protobuf.Any;
     }
+    /**
+     * Defined in:
+     *   {@link file://./../../../../../../common/protocols/src/proto/dxos/halo/signed.proto}
+     */
     export interface Signature {
+        /**
+         * The publicKey of the keypair that made this signature.
+         */
         key: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
+        /**
+         * The bytes of the signature.
+         */
         signature: Uint8Array;
+        /**
+         * The certification chain of SignedMessages for this key.
+         *
+         * Options:
+         *   - proto3_optional = true
+         */
         keyChain?: dxos_halo_keys.KeyChain;
     }
 }

package/src/proto/gen/dxos/halo/keys.ts

@@ -2,7 +2,12 @@ import type { Stream } from "@dxos/codec-protobuf";
 import substitutions from "../../../substitutions";
 import * as dxos_credentials from "../credentials";
 import * as dxos_mesh_signal from "../mesh/signal";
+import * as dxos_mesh_signalMessage from "../mesh/signalMessage";
 import * as google_protobuf from "../../google/protobuf";
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/halo/keys.proto}
+ */
 export enum KeyType {
     UNKNOWN = 0,
     IDENTITY = 1,
@@ -11,12 +16,24 @@ export enum KeyType {
     FEED = 4,
     DXNS_ADDRESS = 5
 }
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/halo/keys.proto}
+ */
 export interface PubKey {
-    data?: Uint8Array;
+    data: Uint8Array;
 }
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/halo/keys.proto}
+ */
 export interface PrivKey {
-    data?: Uint8Array;
+    data: Uint8Array;
 }
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/halo/keys.proto}
+ */
 export interface KeyRecord {
     /**
      * The `KeyType` type of the key. This is often unknown for keys from other sources.
@@ -28,33 +45,59 @@ export interface KeyRecord {
     publicKey: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
     /**
      * The secret key as a Buffer (this will never be visible outside the Keyring).
+     *
+     * Options:
+     *   - proto3_optional = true
      */
     secretKey?: ReturnType<(typeof substitutions)["dxos.halo.keys.PrivKey"]["decode"]>;
     /**
      * Is this key from a Greeting "hint"?
+     *
+     * Options:
+     *   - proto3_optional = true
      */
     hint?: boolean;
     /**
      * Determines if this is our key?
      * Usually true if `secretKey` is present; may be false for "inception keys" such as the Party key.
+     *
+     * Options:
+     *   - proto3_optional = true
      */
     own?: boolean;
     /**
      * Is this key to be trusted?
+     *
+     * Options:
+     *   - proto3_optional = true
      */
     trusted?: boolean;
     /**
      * An RFC-3339 date/time string for when the key was added to the Keyring.
+     *
+     * Options:
+     *   - proto3_optional = true
      */
     added?: string;
     /**
      * An RFC-3339 date/time string for when the key was created.
+     *
+     * Options:
+     *   - proto3_optional = true
      */
     created?: string;
 }
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/halo/keys.proto}
+ */
 export interface KeyRecordList {
     keys?: KeyRecord[];
 }
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/halo/keys.proto}
+ */
 export interface KeyChain {
     publicKey: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
     message: dxos_credentials.SignedMessage;