@dxos/network-manager 2.33.9-dev.e605934d → 2.33.9-dev.eb69ac10

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

@@ -13,9 +13,14 @@ message Message {
   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 {
@@ -23,6 +28,7 @@ message MessageData {
     Offer offer = 1;
     Answer answer = 2;
     Signal signal = 3;
+    Acknowledgement ack = 4;
   }
 }
 
@@ -31,8 +37,15 @@ 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

@@ -3,25 +3,64 @@ import substitutions from "../../substitutions";
 import * as dxos_halo_keys from "./halo/keys";
 import * as dxos_mesh_signal from "./mesh/signal";
 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

@@ -3,6 +3,10 @@ import substitutions from "../../../substitutions";
 import * as dxos_credentials from "../credentials";
 import * as dxos_mesh_signal from "../mesh/signal";
 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 +15,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 +44,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;

package/src/proto/gen/dxos/mesh/signal.ts

@@ -3,29 +3,80 @@ import substitutions from "../../../substitutions";
 import * as dxos_credentials from "../credentials";
 import * as dxos_halo_keys from "../halo/keys";
 import * as google_protobuf from "../../google/protobuf";
+/**
+ * Defined in:
+ *   {@link file://./../../../defs/dxos/mesh/signal.proto}
+ */
 export interface Message {
     /**
      * Sender's public key.
      */
-    id?: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
+    id: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
     /**
      * Receiver`s public key.
      */
-    remoteId?: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
-    topic?: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
-    sessionId?: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
-    data?: MessageData;
+    remoteId: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
+    /**
+     * Swarm identefier.
+     */
+    topic: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
+    /**
+     * Unique connection identifier.
+     */
+    sessionId: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
+    /**
+     * Message payload.
+     */
+    data: MessageData;
+    /**
+     * Unique message identifier. Used for Acknolegment and matching Anwers to Offers.
+     *
+     * Options:
+     *   - proto3_optional = true
+     */
+    messageId?: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
 }
+/**
+ * Defined in:
+ *   {@link file://./../../../defs/dxos/mesh/signal.proto}
+ */
 export interface MessageData {
     offer?: Offer;
     answer?: Answer;
     signal?: Signal;
+    ack?: Acknowledgement;
 }
+/**
+ * Defined in:
+ *   {@link file://./../../../defs/dxos/mesh/signal.proto}
+ */
 export interface Offer {
 }
+/**
+ * Defined in:
+ *   {@link file://./../../../defs/dxos/mesh/signal.proto}
+ */
 export interface Answer {
-    accept?: boolean;
+    accept: boolean;
+    /**
+     * MessageId of the Offer being answered.
+     *
+     * Options:
+     *   - proto3_optional = true
+     */
+    offerMessageId?: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
 }
+/**
+ * Defined in:
+ *   {@link file://./../../../defs/dxos/mesh/signal.proto}
+ */
 export interface Signal {
-    json?: string;
+    json: string;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../defs/dxos/mesh/signal.proto}
+ */
+export interface Acknowledgement {
+    messageId: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
 }

package/src/proto/gen/google/protobuf.ts

@@ -4,6 +4,6 @@ import * as dxos_credentials from "../dxos/credentials";
 import * as dxos_halo_keys from "../dxos/halo/keys";
 import * as dxos_mesh_signal from "../dxos/mesh/signal";
 export interface Any {
-    type_url?: string;
-    value?: Uint8Array;
+    type_url: string;
+    value: Uint8Array;
 }

package/src/proto/gen/index.ts

@@ -15,6 +15,7 @@ export interface TYPES {
     "dxos.halo.keys.KeyType": dxos_halo_keys.KeyType;
     "dxos.halo.keys.PrivKey": dxos_halo_keys.PrivKey;
     "dxos.halo.keys.PubKey": dxos_halo_keys.PubKey;
+    "dxos.mesh.signal.Acknowledgement": dxos_mesh_signal.Acknowledgement;
     "dxos.mesh.signal.Answer": dxos_mesh_signal.Answer;
     "dxos.mesh.signal.Message": dxos_mesh_signal.Message;
     "dxos.mesh.signal.MessageData": dxos_mesh_signal.MessageData;
@@ -24,5 +25,5 @@ export interface TYPES {
 }
 export interface SERVICES {
 }
-export const schemaJson = JSON.parse("{\"nested\":{\"dxos\":{\"nested\":{\"credentials\":{\"nested\":{\"Message\":{\"fields\":{\"payload\":{\"rule\":\"required\",\"type\":\"google.protobuf.Any\",\"id\":1,\"comment\":null}},\"comment\":null},\"SignedMessage\":{\"fields\":{\"signed\":{\"rule\":\"required\",\"type\":\"Signed\",\"id\":1,\"comment\":null},\"signatures\":{\"rule\":\"repeated\",\"type\":\"Signature\",\"id\":2,\"comment\":null}},\"nested\":{\"Signature\":{\"fields\":{\"key\":{\"rule\":\"required\",\"type\":\"PubKey\",\"id\":1,\"comment\":null},\"signature\":{\"rule\":\"required\",\"type\":\"bytes\",\"id\":2,\"comment\":null},\"keyChain\":{\"type\":\"KeyChain\",\"id\":3,\"comment\":null}},\"comment\":null},\"Signed\":{\"fields\":{\"created\":{\"rule\":\"required\",\"type\":\"string\",\"id\":1,\"comment\":null},\"nonce\":{\"rule\":\"required\",\"type\":\"bytes\",\"id\":2,\"comment\":null},\"payload\":{\"rule\":\"required\",\"type\":\"google.protobuf.Any\",\"id\":10,\"comment\":null}},\"comment\":null}},\"comment\":\"A generic container message used whenever messages are signed (e.g. PartyCredential)\"}}},\"halo\":{\"nested\":{\"keys\":{\"nested\":{\"KeyChain\":{\"fields\":{\"publicKey\":{\"rule\":\"required\",\"type\":\"PubKey\",\"id\":1,\"comment\":null},\"message\":{\"rule\":\"required\",\"type\":\"SignedMessage\",\"id\":2,\"comment\":null},\"parents\":{\"rule\":\"repeated\",\"type\":\"KeyChain\",\"id\":3,\"comment\":null}},\"comment\":null},\"KeyRecord\":{\"fields\":{\"type\":{\"rule\":\"required\",\"type\":\"KeyType\",\"id\":1,\"comment\":\"The `KeyType` type of the key. This is often unknown for keys from other sources.\"},\"publicKey\":{\"rule\":\"required\",\"type\":\"PubKey\",\"id\":2,\"comment\":\"The public key as a Buffer (required).\"},\"secretKey\":{\"type\":\"PrivKey\",\"id\":3,\"comment\":\"The secret key as a Buffer (this will never be visible outside the Keyring).\"},\"hint\":{\"type\":\"bool\",\"id\":4,\"comment\":\"Is this key from a Greeting \\\"hint\\\"?\"},\"own\":{\"type\":\"bool\",\"id\":5,\"comment\":\"Determines if this is our key?\\nUsually true if `secretKey` is present; may be false for \\\"inception keys\\\" such as the Party key.\"},\"trusted\":{\"type\":\"bool\",\"id\":6,\"comment\":\"Is this key to be trusted?\"},\"added\":{\"type\":\"string\",\"id\":7,\"comment\":\"An RFC-3339 date/time string for when the key was added to the Keyring.\"},\"created\":{\"type\":\"string\",\"id\":8,\"comment\":\"An RFC-3339 date/time string for when the key was created.\"}},\"comment\":null},\"KeyRecordList\":{\"fields\":{\"keys\":{\"rule\":\"repeated\",\"type\":\"KeyRecord\",\"id\":1,\"comment\":null}},\"comment\":null},\"KeyType\":{\"values\":{\"UNKNOWN\":0,\"IDENTITY\":1,\"DEVICE\":2,\"PARTY\":3,\"FEED\":4,\"DXNS_ADDRESS\":5},\"comment\":null,\"comments\":{\"UNKNOWN\":null,\"IDENTITY\":null,\"DEVICE\":null,\"PARTY\":null,\"FEED\":null,\"DXNS_ADDRESS\":null}},\"PrivKey\":{\"fields\":{\"data\":{\"type\":\"bytes\",\"id\":1,\"comment\":null}},\"comment\":null},\"PubKey\":{\"fields\":{\"data\":{\"type\":\"bytes\",\"id\":1,\"comment\":null}},\"comment\":null}}}}},\"mesh\":{\"nested\":{\"signal\":{\"nested\":{\"Answer\":{\"fields\":{\"accept\":{\"type\":\"bool\",\"id\":1,\"comment\":null}},\"comment\":null},\"Message\":{\"fields\":{\"id\":{\"type\":\"PubKey\",\"id\":1,\"comment\":\"Sender's public key.\"},\"remoteId\":{\"type\":\"PubKey\",\"id\":2,\"comment\":\"Receiver`s public key.\"},\"topic\":{\"type\":\"PubKey\",\"id\":3,\"comment\":null},\"sessionId\":{\"type\":\"PubKey\",\"id\":4,\"comment\":null},\"data\":{\"type\":\"MessageData\",\"id\":5,\"comment\":null}},\"comment\":null},\"MessageData\":{\"oneofs\":{\"payload\":{\"oneof\":[\"offer\",\"answer\",\"signal\"],\"comment\":null}},\"fields\":{\"offer\":{\"type\":\"Offer\",\"id\":1,\"comment\":null},\"answer\":{\"type\":\"Answer\",\"id\":2,\"comment\":null},\"signal\":{\"type\":\"Signal\",\"id\":3,\"comment\":null}},\"comment\":null},\"Offer\":{\"fields\":{},\"comment\":null},\"Signal\":{\"fields\":{\"json\":{\"type\":\"string\",\"id\":1,\"comment\":null}},\"comment\":null}}}}}}},\"google\":{\"nested\":{\"protobuf\":{\"nested\":{\"Any\":{\"fields\":{\"type_url\":{\"type\":\"string\",\"id\":1},\"value\":{\"type\":\"bytes\",\"id\":2}},\"comment\":null}}}}}}}");
+export const schemaJson = JSON.parse("{\"nested\":{\"dxos\":{\"nested\":{\"credentials\":{\"nested\":{\"Message\":{\"fields\":{\"payload\":{\"rule\":\"required\",\"type\":\"google.protobuf.Any\",\"id\":1,\"comment\":null}},\"comment\":null},\"SignedMessage\":{\"fields\":{\"signed\":{\"rule\":\"required\",\"type\":\"Signed\",\"id\":1,\"comment\":\"The signed message contents.\"},\"signatures\":{\"rule\":\"repeated\",\"type\":\"Signature\",\"id\":2,\"comment\":\"An array of Signatures, one for each key that signed the message.\"}},\"nested\":{\"Signature\":{\"oneofs\":{\"_keyChain\":{\"oneof\":[\"keyChain\"]}},\"fields\":{\"key\":{\"rule\":\"required\",\"type\":\"PubKey\",\"id\":1,\"comment\":\"The publicKey of the keypair that made this signature.\"},\"signature\":{\"rule\":\"required\",\"type\":\"bytes\",\"id\":2,\"comment\":\"The bytes of the signature.\"},\"keyChain\":{\"type\":\"KeyChain\",\"id\":3,\"options\":{\"proto3_optional\":true},\"comment\":\"The certification chain of SignedMessages for this key.\"}},\"comment\":null},\"Signed\":{\"fields\":{\"created\":{\"rule\":\"required\",\"type\":\"string\",\"id\":1,\"comment\":\"RFC-3339 datetime string.\"},\"nonce\":{\"rule\":\"required\",\"type\":\"bytes\",\"id\":2,\"comment\":null},\"payload\":{\"rule\":\"required\",\"type\":\"google.protobuf.Any\",\"id\":10,\"comment\":\"The payload to be signed.\"}},\"comment\":null}},\"comment\":\"A generic container message used whenever messages are signed (e.g. PartyCredential)\"}}},\"halo\":{\"nested\":{\"keys\":{\"nested\":{\"KeyChain\":{\"fields\":{\"publicKey\":{\"rule\":\"required\",\"type\":\"PubKey\",\"id\":1,\"comment\":null},\"message\":{\"rule\":\"required\",\"type\":\"SignedMessage\",\"id\":2,\"comment\":null},\"parents\":{\"rule\":\"repeated\",\"type\":\"KeyChain\",\"id\":3,\"comment\":null}},\"comment\":null},\"KeyRecord\":{\"oneofs\":{\"_secretKey\":{\"oneof\":[\"secretKey\"]},\"_hint\":{\"oneof\":[\"hint\"]},\"_own\":{\"oneof\":[\"own\"]},\"_trusted\":{\"oneof\":[\"trusted\"]},\"_added\":{\"oneof\":[\"added\"]},\"_created\":{\"oneof\":[\"created\"]}},\"fields\":{\"type\":{\"rule\":\"required\",\"type\":\"KeyType\",\"id\":1,\"comment\":\"The `KeyType` type of the key. This is often unknown for keys from other sources.\"},\"publicKey\":{\"rule\":\"required\",\"type\":\"PubKey\",\"id\":2,\"comment\":\"The public key as a Buffer (required).\"},\"secretKey\":{\"type\":\"PrivKey\",\"id\":3,\"options\":{\"proto3_optional\":true},\"comment\":\"The secret key as a Buffer (this will never be visible outside the Keyring).\"},\"hint\":{\"type\":\"bool\",\"id\":4,\"options\":{\"proto3_optional\":true},\"comment\":\"Is this key from a Greeting \\\"hint\\\"?\"},\"own\":{\"type\":\"bool\",\"id\":5,\"options\":{\"proto3_optional\":true},\"comment\":\"Determines if this is our key?\\nUsually true if `secretKey` is present; may be false for \\\"inception keys\\\" such as the Party key.\"},\"trusted\":{\"type\":\"bool\",\"id\":6,\"options\":{\"proto3_optional\":true},\"comment\":\"Is this key to be trusted?\"},\"added\":{\"type\":\"string\",\"id\":7,\"options\":{\"proto3_optional\":true},\"comment\":\"An RFC-3339 date/time string for when the key was added to the Keyring.\"},\"created\":{\"type\":\"string\",\"id\":8,\"options\":{\"proto3_optional\":true},\"comment\":\"An RFC-3339 date/time string for when the key was created.\"}},\"comment\":null},\"KeyRecordList\":{\"fields\":{\"keys\":{\"rule\":\"repeated\",\"type\":\"KeyRecord\",\"id\":1,\"comment\":null}},\"comment\":null},\"KeyType\":{\"values\":{\"UNKNOWN\":0,\"IDENTITY\":1,\"DEVICE\":2,\"PARTY\":3,\"FEED\":4,\"DXNS_ADDRESS\":5},\"comment\":null,\"comments\":{\"UNKNOWN\":null,\"IDENTITY\":null,\"DEVICE\":null,\"PARTY\":null,\"FEED\":null,\"DXNS_ADDRESS\":null}},\"PrivKey\":{\"fields\":{\"data\":{\"type\":\"bytes\",\"id\":1,\"comment\":null}},\"comment\":null},\"PubKey\":{\"fields\":{\"data\":{\"type\":\"bytes\",\"id\":1,\"comment\":null}},\"comment\":null}}}}},\"mesh\":{\"nested\":{\"signal\":{\"nested\":{\"Acknowledgement\":{\"fields\":{\"messageId\":{\"type\":\"PubKey\",\"id\":1,\"comment\":null}},\"comment\":null},\"Answer\":{\"oneofs\":{\"_offerMessageId\":{\"oneof\":[\"offerMessageId\"]}},\"fields\":{\"accept\":{\"type\":\"bool\",\"id\":1,\"comment\":null},\"offerMessageId\":{\"type\":\"PubKey\",\"id\":2,\"options\":{\"proto3_optional\":true},\"comment\":\"MessageId of the Offer being answered.\"}},\"comment\":null},\"Message\":{\"oneofs\":{\"_messageId\":{\"oneof\":[\"messageId\"]}},\"fields\":{\"id\":{\"type\":\"PubKey\",\"id\":1,\"comment\":\"Sender's public key.\"},\"remoteId\":{\"type\":\"PubKey\",\"id\":2,\"comment\":\"Receiver`s public key.\"},\"topic\":{\"type\":\"PubKey\",\"id\":3,\"comment\":\"Swarm identefier.\"},\"sessionId\":{\"type\":\"PubKey\",\"id\":4,\"comment\":\"Unique connection identifier.\"},\"data\":{\"type\":\"MessageData\",\"id\":5,\"comment\":\"Message payload.\"},\"messageId\":{\"type\":\"PubKey\",\"id\":6,\"options\":{\"proto3_optional\":true},\"comment\":\"Unique message identifier. Used for Acknolegment and matching Anwers to Offers.\"}},\"comment\":null},\"MessageData\":{\"oneofs\":{\"payload\":{\"oneof\":[\"offer\",\"answer\",\"signal\",\"ack\"],\"comment\":null}},\"fields\":{\"offer\":{\"type\":\"Offer\",\"id\":1,\"comment\":null},\"answer\":{\"type\":\"Answer\",\"id\":2,\"comment\":null},\"signal\":{\"type\":\"Signal\",\"id\":3,\"comment\":null},\"ack\":{\"type\":\"Acknowledgement\",\"id\":4,\"comment\":null}},\"comment\":null},\"Offer\":{\"fields\":{},\"comment\":null},\"Signal\":{\"fields\":{\"json\":{\"type\":\"string\",\"id\":1,\"comment\":null}},\"comment\":null}}}}}}},\"google\":{\"nested\":{\"protobuf\":{\"nested\":{\"Any\":{\"fields\":{\"type_url\":{\"type\":\"string\",\"id\":1},\"value\":{\"type\":\"bytes\",\"id\":2}},\"comment\":null}}}}}}}");
 export const schema = Schema.fromJson<TYPES, SERVICES>(schemaJson, substitutions);

package/src/protocol-factory.ts

@@ -2,8 +2,8 @@
 // Copyright 2020 DXOS.org
 //
 
-import assert from 'assert';
 import debug from 'debug';
+import assert from 'node:assert';
 
 import { discoveryKey } from '@dxos/crypto';
 import { Extension, Protocol } from '@dxos/mesh-protocol';

package/src/signal/in-memory-signal-manager.ts

@@ -2,7 +2,7 @@
 // Copyright 2020 DXOS.org
 //
 
-import assert from 'assert';
+import assert from 'node:assert';
 
 import { Event } from '@dxos/async';
 import { PublicKey } from '@dxos/protocols';

package/src/signal/message-router.test.ts

@@ -40,11 +40,15 @@ describe('MessageRouter', () => {
     await broker1.stop();
   });
 
-  const createSignalClientAndMessageRouter = async (
-    signalApiUrl: string,
-    onSignal: (msg: Message) => Promise<void> = (async () => {}) as any,
-    onOffer: (msg: Message) => Promise<Answer> = async () => ({ accept: true })
-  ) => {
+  const createSignalClientAndMessageRouter = async ({
+    signalApiUrl,
+    onSignal = (async () => { }) as any,
+    onOffer = async () => ({ accept: true })
+  }: {
+    signalApiUrl: string;
+    onSignal?: (msg: Message) => Promise<void>;
+    onOffer?: (msg: Message) => Promise<Answer>;
+  }) => {
 
     // eslint-disable-next-line prefer-const
     let api: SignalClient;
@@ -54,6 +58,7 @@ describe('MessageRouter', () => {
       onSignal: onSignal,
       onOffer: onOffer
     });
+    afterTest(() => router.destroy());
 
     api = new SignalClient(
       signalApiUrl,
@@ -70,8 +75,8 @@ describe('MessageRouter', () => {
 
   test('signaling between 2 clients', async () => {
     const signalMock1 = mockFn<(msg: Message) => Promise<void>>().resolvesTo();
-    const { api: api1 } = await createSignalClientAndMessageRouter(signalApiUrl1, signalMock1);
-    const { api: api2, router: router2 } = await createSignalClientAndMessageRouter(signalApiUrl1);
+    const { api: api1 } = await createSignalClientAndMessageRouter({ signalApiUrl: signalApiUrl1, onSignal: signalMock1 });
+    const { api: api2, router: router2 } = await createSignalClientAndMessageRouter({ signalApiUrl: signalApiUrl1 });
 
     await api1.join(topic, peer1);
     await api2.join(topic, peer2);
@@ -92,15 +97,19 @@ describe('MessageRouter', () => {
 
   test('offer/answer', async () => {
     const { api: api1, router: router1 } = await createSignalClientAndMessageRouter(
-      signalApiUrl1,
-      (async () => {}) as any,
-      async () => ({ accept: true })
-    );
+      {
+        signalApiUrl: signalApiUrl1,
+        onSignal: (async () => { }) as any,
+        onOffer:
+          async () => ({ accept: true })
+      });
     const { api: api2 } = await createSignalClientAndMessageRouter(
-      signalApiUrl1,
-      (async () => {}) as any,
-      async () => ({ accept: true })
-    );
+      {
+        signalApiUrl: signalApiUrl1,
+        onSignal: (async () => { }) as any,
+        onOffer:
+          async () => ({ accept: true })
+      });
 
     await api1.join(topic, peer1);
     await api2.join(topic, peer2);
@@ -112,28 +121,34 @@ describe('MessageRouter', () => {
       topic,
       data: { offer: { } }
     });
-    expect(answer).toEqual({ accept: true });
+    expect(answer.accept).toEqual(true);
   }).timeout(5_000);
 
   test('signaling between 3 clients', async () => {
     const signalMock1 = mockFn<(msg: Message) => Promise<void>>().resolvesTo();
     const { api: api1, router: router1 } = await createSignalClientAndMessageRouter(
-      signalApiUrl1,
-      signalMock1,
-      async () => ({ accept: true })
-    );
+      {
+        signalApiUrl: signalApiUrl1,
+        onSignal: signalMock1,
+        onOffer:
+          async () => ({ accept: true })
+      });
     const signalMock2 = mockFn<(msg: Message) => Promise<void>>().resolvesTo();
     const { api: api2, router: router2 } = await createSignalClientAndMessageRouter(
-      signalApiUrl1,
-      signalMock2,
-      async () => ({ accept: true })
-    );
+      {
+        signalApiUrl: signalApiUrl1,
+        onSignal: signalMock2,
+        onOffer:
+          async () => ({ accept: true })
+      });
     const signalMock3 = mockFn<(msg: Message) => Promise<void>>().resolvesTo();
     const { api: api3, router: router3 } = await createSignalClientAndMessageRouter(
-      signalApiUrl1,
-      signalMock3,
-      async () => ({ accept: true })
-    );
+      {
+        signalApiUrl: signalApiUrl1,
+        onSignal: signalMock3,
+        onOffer:
+          async () => ({ accept: true })
+      });
 
     await api1.join(topic, peer1);
     await api2.join(topic, peer2);
@@ -182,15 +197,19 @@ describe('MessageRouter', () => {
 
   test('two offers', async () => {
     const { api: api1, router: router1 } = await createSignalClientAndMessageRouter(
-      signalApiUrl1,
-      (async () => {}) as any,
-      async () => ({ accept: true })
-    );
+      {
+        signalApiUrl: signalApiUrl1,
+        onSignal: (async () => { }) as any,
+        onOffer:
+          async () => ({ accept: true })
+      });
     const { api: api2, router: router2 } = await createSignalClientAndMessageRouter(
-      signalApiUrl1,
-      (async () => {}) as any,
-      async () => ({ accept: true })
-    );
+      {
+        signalApiUrl: signalApiUrl1,
+        onSignal: (async () => { }) as any,
+        onOffer:
+          async () => ({ accept: true })
+      });
 
     await api1.join(topic, peer1);
     await api2.join(topic, peer2);
@@ -203,7 +222,7 @@ describe('MessageRouter', () => {
       topic,
       data: { offer: {} }
     });
-    expect(answer1).toEqual({ accept: true });
+    expect(answer1.accept).toEqual(true);
 
     // sending offer from peer2 to peer1.
     const answer2 = await router2.offer({
@@ -213,6 +232,103 @@ describe('MessageRouter', () => {
       topic,
       data: { offer: {} }
     });
-    expect(answer2).toEqual({ accept: true });
+    expect(answer2.accept).toEqual(true);
   }).timeout(5_000);
+
+  describe('Reliability', () => {
+    const setup = ({
+      onSignal1 = async () => { },
+      onSignal2 = async () => { },
+      // Imitates signal network disruptions (e. g. message doubling, ).
+      messageDisruption = msg => [msg]
+    }: {
+      onSignal1?: (msg: Message) => Promise<void>;
+      onSignal2?: (msg: Message) => Promise<void>;
+      messageDisruption?: (msg: Message) => Message[];
+    }): {mr1: MessageRouter; mr2: MessageRouter} => {
+
+      const mr1: MessageRouter = new MessageRouter({
+        sendMessage: async msg => messageDisruption(msg).forEach(msg => mr2.receiveMessage(msg)),
+        onOffer: async () => ({ accept: true }),
+        onSignal: onSignal1
+      });
+      afterTest(() => mr1.destroy());
+
+      const mr2: MessageRouter = new MessageRouter({
+        sendMessage: async msg => messageDisruption(msg).forEach(msg => mr1.receiveMessage(msg)),
+        onOffer: async () => ({ accept: true }),
+        onSignal: onSignal2
+      });
+      afterTest(() => mr1.destroy());
+
+      return { mr1, mr2 };
+    };
+
+    test('signaling with non reliable connection', async () => {
+      // Simulate unreliable connection.
+      // Only each 3rd message is sent.
+      let i = 0;
+      const unreliableConnection = (msg: Message): Message[] => {
+        i++;
+        if (i % 3 !== 0) {
+          return [msg];
+        }
+        return [];
+      };
+
+      const received: Message[] = [];
+      const signalMock1 = async (msg: Message) => {
+        received.push(msg);
+      };
+
+      const { mr2 } = await setup({
+        onSignal1: signalMock1,
+        messageDisruption: unreliableConnection
+      });
+
+      // Sending 3 messages.
+      // Setup sends messages directly to between. So we don`t need to specify any ids.
+      Array(3).fill(0).forEach(async () => {
+        await mr2.signal({
+          id: PublicKey.random(),
+          remoteId: PublicKey.random(),
+          sessionId: PublicKey.random(),
+          topic: PublicKey.random(),
+          data: { signal: { json: 'asd' } }
+        });
+      });
+      // expect to receive 3 messages.
+      await waitForExpect(() => {
+        expect(received.length).toEqual(3);
+      }, 4_000);
+    }).timeout(5_000);
+
+    test('ignoring doubled messages', async () => {
+      // Message got doubled going through signal network.
+      const doublingMessage = (msg: Message) => [msg, msg];
+
+      const received: Message[] = [];
+      const signalMock1 = async (msg: Message) => {
+        received.push(msg);
+      };
+
+      const { mr2 } = setup({
+        onSignal1: signalMock1,
+        messageDisruption: doublingMessage
+      });
+
+      // sending message.
+      await mr2.signal({
+        id: PublicKey.random(),
+        remoteId: PublicKey.random(),
+        sessionId: PublicKey.random(),
+        topic: PublicKey.random(),
+        data: { signal: { json: 'asd' } }
+      });
+      // expect to receive 1 message.
+      await waitForExpect(() => {
+        expect(received.length).toEqual(1);
+      }, 4_000);
+    }).timeout(5_000);
+  });
 });