@dxos/messaging 0.8.3 → 0.8.4-main.1068cf700f

package/package.json

@@ -1,23 +1,27 @@
 {
   "name": "@dxos/messaging",
-  "version": "0.8.3",
+  "version": "0.8.4-main.1068cf700f",
   "description": "Messaging",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/dxos/dxos"
+  },
   "license": "MIT",
   "author": "DXOS.org",
-  "sideEffects": true,
+  "sideEffects": false,
   "type": "module",
   "exports": {
     ".": {
+      "source": "./src/index.ts",
       "types": "./dist/types/src/index.d.ts",
-      "browser": "./dist/lib/browser/index.mjs",
-      "node": "./dist/lib/node-esm/index.mjs"
+      "default": "./dist/lib/neutral/index.mjs"
     },
     "./testing": {
+      "source": "./src/testing/index.ts",
       "types": "./dist/types/src/testing/index.d.ts",
-      "browser": "./dist/lib/browser/testing/index.mjs",
-      "node": "./dist/lib/node-esm/testing/index.mjs"
+      "default": "./dist/lib/neutral/testing/index.mjs"
     }
   },
   "types": "dist/types/src/index.d.ts",
@@ -36,23 +40,23 @@
   "dependencies": {
     "isomorphic-ws": "^5.0.0",
     "ws": "^8.14.2",
-    "@dxos/async": "0.8.3",
-    "@dxos/context": "0.8.3",
-    "@dxos/edge-client": "0.8.3",
-    "@dxos/codec-protobuf": "0.8.3",
-    "@dxos/invariant": "0.8.3",
-    "@dxos/keys": "0.8.3",
-    "@dxos/log": "0.8.3",
-    "@dxos/node-std": "0.8.3",
-    "@dxos/protocols": "0.8.3",
-    "@dxos/rpc": "0.8.3",
-    "@dxos/tracing": "0.8.3",
-    "@dxos/util": "0.8.3"
+    "@dxos/async": "0.8.4-main.1068cf700f",
+    "@dxos/context": "0.8.4-main.1068cf700f",
+    "@dxos/edge-client": "0.8.4-main.1068cf700f",
+    "@dxos/codec-protobuf": "0.8.4-main.1068cf700f",
+    "@dxos/invariant": "0.8.4-main.1068cf700f",
+    "@dxos/keys": "0.8.4-main.1068cf700f",
+    "@dxos/log": "0.8.4-main.1068cf700f",
+    "@dxos/node-std": "0.8.4-main.1068cf700f",
+    "@dxos/protocols": "0.8.4-main.1068cf700f",
+    "@dxos/tracing": "0.8.4-main.1068cf700f",
+    "@dxos/rpc": "0.8.4-main.1068cf700f",
+    "@dxos/util": "0.8.4-main.1068cf700f"
   },
   "devDependencies": {
-    "@dxos/keyring": "0.8.3",
-    "@dxos/test-utils": "0.8.3",
-    "@dxos/signal": "0.8.3"
+    "@dxos/keyring": "0.8.4-main.1068cf700f",
+    "@dxos/test-utils": "0.8.4-main.1068cf700f",
+    "@dxos/signal": "0.8.4-main.1068cf700f"
   },
   "publishConfig": {
     "access": "public"

package/src/messenger.blueprint-test.ts

@@ -2,14 +2,14 @@
 // Copyright 2024 DXOS.org
 //
 
-import { describe, expect, test, onTestFinished } from 'vitest';
+import { describe, expect, onTestFinished, test } from 'vitest';
 
 import { asyncTimeout, latch, sleep } from '@dxos/async';
 import { range } from '@dxos/util';
 
 import { WebsocketSignalManager } from './signal-manager';
 import { type Message } from './signal-methods';
-import { messageEqual, PAYLOAD_1, PAYLOAD_2, PAYLOAD_3, TestBuilder } from './testing';
+import { PAYLOAD_1, PAYLOAD_2, PAYLOAD_3, TestBuilder, messageEqual } from './testing';
 
 export const messengerTests = (signalManagerFactory: TestBuilder['createSignalManager']) => {
   test('Message between peers', async () => {

package/src/messenger.node.test.ts

@@ -2,48 +2,17 @@
 // Copyright 2022 DXOS.org
 //
 
-import { afterAll, onTestFinished, beforeAll, test, describe } from 'vitest';
-
-import { asyncTimeout } from '@dxos/async';
-import { runTestSignalServer, type SignalServerRunner } from '@dxos/signal';
+import { beforeEach, describe } from 'vitest';
 
 import { messengerTests } from './messenger.blueprint-test';
-import { WebsocketSignalManager } from './signal-manager';
-import { type Message } from './signal-methods';
-import { PAYLOAD_1, TestBuilder } from './testing';
+import { MemorySignalManager, MemorySignalManagerContext } from './signal-manager';
 
+// TODO(mykola): Use EDGE signal server.
 describe('Messenger with WebsocketSignalManager', () => {
-  let broker: SignalServerRunner;
-
-  beforeAll(async () => {
-    broker = await runTestSignalServer();
-  });
-
-  afterAll(() => {
-    void broker.stop();
+  let context: MemorySignalManagerContext;
+  beforeEach(async () => {
+    context = new MemorySignalManagerContext();
   });
 
-  messengerTests(async () => new WebsocketSignalManager([{ server: broker.url() }]));
-
-  test('Message with broken signal server', { timeout: 1000 }, async () => {
-    const builder = new TestBuilder({
-      signalManagerFactory: async () =>
-        new WebsocketSignalManager([{ server: 'ws://broken.kube.' }, { server: broker.url() }]),
-    });
-    onTestFinished(() => builder.close());
-    const peer1 = await builder.createPeer();
-    const peer2 = await builder.createPeer();
-
-    const message: Message = {
-      author: peer1.peerInfo,
-      recipient: peer2.peerInfo,
-      payload: PAYLOAD_1,
-    };
-
-    {
-      const receivePromise = peer2.waitTillReceive(message);
-      await peer1.messenger.sendMessage(message);
-      await asyncTimeout(receivePromise, 1_000);
-    }
-  });
+  messengerTests(async () => new MemorySignalManager(context));
 });

package/src/messenger.ts

@@ -15,7 +15,7 @@ import { ComplexMap, ComplexSet } from '@dxos/util';
 
 import { MessengerMonitor } from './messenger-monitor';
 import { type SignalManager } from './signal-manager';
-import { type PeerInfo, type Message } from './signal-methods';
+import { type Message, type PeerInfo } from './signal-methods';
 import { MESSAGE_TIMEOUT } from './timeouts';
 
 export type OnMessage = (params: Message) => Promise<void>;
@@ -140,10 +140,10 @@ export class Messenger {
         log('message not delivered', { messageId: reliablePayload.messageId });
         this._onAckCallbacks.delete(reliablePayload.messageId!);
         timeoutHit(
-          new ProtocolTimeoutError(
-            'signaling message not delivered',
-            new TimeoutError(MESSAGE_TIMEOUT, 'Message not delivered'),
-          ),
+          new ProtocolTimeoutError({
+            message: 'signaling message not delivered',
+            cause: new TimeoutError(MESSAGE_TIMEOUT, 'Message not delivered'),
+          }),
         );
         void messageContext.dispose();
         this._monitor.recordReliableMessage({ sendAttempts, sent: false });

package/src/signal-client/signal-client.node.test.ts

@@ -2,19 +2,20 @@
 // Copyright 2020 DXOS.org
 //
 
-import { afterAll, beforeAll, describe, expect, test, onTestFinished } from 'vitest';
+import { afterAll, beforeAll, describe, expect, onTestFinished, test } from 'vitest';
 
 import { asyncTimeout, waitForCondition } from '@dxos/async';
 import { type Any, type TaggedType } from '@dxos/codec-protobuf';
 import { PublicKey } from '@dxos/keys';
 import { log } from '@dxos/log';
 import { type TYPES } from '@dxos/protocols/proto';
-import { runTestSignalServer, type SignalServerRunner } from '@dxos/signal';
+import { type SignalServerRunner, runTestSignalServer } from '@dxos/signal';
 import { ComplexSet, range } from '@dxos/util';
 
-import { SignalClient } from './signal-client';
 import { type Message, type PeerInfo } from '../signal-methods';
 
+import { SignalClient } from './signal-client';
+
 const PAYLOAD: TaggedType<TYPES, 'google.protobuf.Any'> = {
   '@type': 'google.protobuf.Any',
   type_url: 'google.protobuf.Any',

package/src/signal-client/signal-client.ts

@@ -3,26 +3,27 @@
 //
 
 import { DeferredTask, Event, Trigger, scheduleTask, scheduleTaskInterval, sleep } from '@dxos/async';
-import { type Context, cancelWithContext, Resource } from '@dxos/context';
+import { type Context, Resource, cancelWithContext } from '@dxos/context';
 import { invariant } from '@dxos/invariant';
 import { PublicKey } from '@dxos/keys';
 import { log } from '@dxos/log';
 import { trace } from '@dxos/protocols';
 import { type SwarmResponse } from '@dxos/protocols/proto/dxos/edge/messenger';
-import { type QueryRequest, type JoinRequest, type LeaveRequest } from '@dxos/protocols/proto/dxos/edge/signal';
+import { type JoinRequest, type LeaveRequest, type QueryRequest } from '@dxos/protocols/proto/dxos/edge/signal';
 import { SignalState } from '@dxos/protocols/proto/dxos/mesh/signal';
 
-import { SignalClientMonitor } from './signal-client-monitor';
-import { SignalLocalState } from './signal-local-state';
-import { SignalRPCClient } from './signal-rpc-client';
 import {
-  type PeerInfo,
   type Message,
+  type PeerInfo,
   type SignalClientMethods,
   type SignalStatus,
   type SwarmEvent,
 } from '../signal-methods';
 
+import { SignalClientMonitor } from './signal-client-monitor';
+import { SignalLocalState } from './signal-local-state';
+import { SignalRPCClient } from './signal-rpc-client';
+
 const DEFAULT_RECONNECT_TIMEOUT = 100;
 const MAX_RECONNECT_TIMEOUT = 5_000;
 const ERROR_RECONCILE_DELAY = 1_000;

package/src/signal-client/signal-local-state.ts

@@ -2,9 +2,9 @@
 // Copyright 2024 DXOS.org
 //
 
-import { asyncTimeout, Event } from '@dxos/async';
+import { Event, asyncTimeout } from '@dxos/async';
 import type { Stream } from '@dxos/codec-protobuf/stream';
-import { cancelWithContext, type Context } from '@dxos/context';
+import { type Context, cancelWithContext } from '@dxos/context';
 import { PublicKey } from '@dxos/keys';
 import { log } from '@dxos/log';
 import {
@@ -13,9 +13,10 @@ import {
 } from '@dxos/protocols/proto/dxos/mesh/signal';
 import { ComplexMap, ComplexSet, safeAwaitAll } from '@dxos/util';
 
-import { type SignalRPCClient } from './signal-rpc-client';
 import type { Message, SwarmEvent } from '../signal-methods';
 
+import { type SignalRPCClient } from './signal-rpc-client';
+
 export class SignalLocalState {
   /**
    * Swarm events streams. Keys represent actually joined topic and peerId.

package/src/signal-client/signal-rpc-client.node.test.ts

@@ -9,7 +9,7 @@ import { PublicKey } from '@dxos/keys';
 import { log } from '@dxos/log';
 import { schema } from '@dxos/protocols/proto';
 import { type Message as SignalMessage, type SwarmEvent } from '@dxos/protocols/proto/dxos/mesh/signal';
-import { runTestSignalServer, type SignalServerRunner } from '@dxos/signal';
+import { type SignalServerRunner, runTestSignalServer } from '@dxos/signal';
 
 import { SignalRPCClient } from './signal-rpc-client';
 

package/src/signal-client/signal-rpc-client.ts

@@ -4,7 +4,7 @@
 
 import WebSocket from 'isomorphic-ws';
 
-import { scheduleTaskInterval, TimeoutError, Trigger } from '@dxos/async';
+import { TimeoutError, Trigger, scheduleTaskInterval } from '@dxos/async';
 import { type Any, type Stream } from '@dxos/codec-protobuf';
 import { Context } from '@dxos/context';
 import { invariant } from '@dxos/invariant';
@@ -12,8 +12,8 @@ import { PublicKey } from '@dxos/keys';
 import { log } from '@dxos/log';
 import { trace } from '@dxos/protocols';
 import { schema } from '@dxos/protocols/proto';
-import { type Message as SignalMessage, type Signal } from '@dxos/protocols/proto/dxos/mesh/signal';
-import { createProtoRpcPeer, type ProtoRpcPeer } from '@dxos/rpc';
+import { type Signal, type Message as SignalMessage } from '@dxos/protocols/proto/dxos/mesh/signal';
+import { type ProtoRpcPeer, createProtoRpcPeer } from '@dxos/rpc';
 
 import { SignalRpcClientMonitor } from './signal-rpc-client-monitor';
 
@@ -36,7 +36,7 @@ export type SignalCallbacks = {
   getMetadata?: () => any;
 };
 
-export type SignalRPCClientParams = {
+export type SignalRPCClientProps = {
   url: string;
   callbacks?: SignalCallbacks;
 };
@@ -61,7 +61,7 @@ export class SignalRPCClient {
 
   private readonly _monitor = new SignalRpcClientMonitor();
 
-  constructor({ url, callbacks = {} }: SignalRPCClientParams) {
+  constructor({ url, callbacks = {} }: SignalRPCClientProps) {
     const traceId = PublicKey.random().toHex();
     log.trace('dxos.mesh.signal-rpc-client.constructor', trace.begin({ id: traceId }));
     this._url = url;
@@ -169,7 +169,7 @@ export class SignalRPCClient {
 
       await this._closeComplete.wait({ timeout: 1_000 });
     } catch (err) {
-      const failureReason = err instanceof TimeoutError ? 'timeout' : err?.constructor?.name ?? 'unknown';
+      const failureReason = err instanceof TimeoutError ? 'timeout' : (err?.constructor?.name ?? 'unknown');
       this._monitor.recordClientCloseFailure({ failureReason });
     }
   }

package/src/signal-manager/edge-signal-manager.ts

@@ -3,25 +3,26 @@
 //
 
 import { Event, scheduleMicroTask } from '@dxos/async';
-import { cancelWithContext, Resource } from '@dxos/context';
-import { type EdgeConnection, protocol } from '@dxos/edge-client';
+import { Resource, cancelWithContext } from '@dxos/context';
+import { type EdgeConnection, EdgeIdentityChangedError, protocol } from '@dxos/edge-client';
 import { invariant } from '@dxos/invariant';
 import { PublicKey } from '@dxos/keys';
 import { log } from '@dxos/log';
 import { EdgeService } from '@dxos/protocols';
 import { type buf, bufWkt } from '@dxos/protocols/buf';
 import {
-  SwarmRequestSchema,
-  SwarmRequest_Action as SwarmRequestAction,
-  SwarmResponseSchema,
   type Message as EdgeMessage,
   type PeerSchema,
+  SwarmRequest_Action as SwarmRequestAction,
+  SwarmRequestSchema,
+  SwarmResponseSchema,
 } from '@dxos/protocols/buf/dxos/edge/messenger_pb';
 import { type SwarmResponse } from '@dxos/protocols/proto/dxos/edge/messenger';
 import { ComplexMap, ComplexSet } from '@dxos/util';
 
+import { type Message, type PeerInfo, PeerInfoHash, type SwarmEvent } from '../signal-methods';
+
 import { type SignalManager } from './signal-manager';
-import { type PeerInfo, type Message, type SwarmEvent, PeerInfoHash } from '../signal-methods';
 
 export class EdgeSignalManager extends Resource implements SignalManager {
   /**
@@ -86,13 +87,22 @@ export class EdgeSignalManager extends Resource implements SignalManager {
 
   async leave({ topic, peer }: { topic: PublicKey; peer: PeerInfo }): Promise<void> {
     this._swarmPeers.delete(topic);
-    await this._edgeConnection.send(
-      protocol.createMessage(SwarmRequestSchema, {
-        serviceId: EdgeService.SWARM,
-        source: createMessageSource(topic, peer),
-        payload: { action: SwarmRequestAction.LEAVE, swarmKeys: [topic.toHex()] },
-      }),
-    );
+    try {
+      await this._edgeConnection.send(
+        protocol.createMessage(SwarmRequestSchema, {
+          serviceId: EdgeService.SWARM,
+          source: createMessageSource(topic, peer),
+          payload: { action: SwarmRequestAction.LEAVE, swarmKeys: [topic.toHex()] },
+        }),
+      );
+    } catch (err) {
+      if (err instanceof EdgeIdentityChangedError) {
+        // Note: On edge identity change, the connection is closed and EDGE will remove us from the swarm.
+        //       So we should just delete the swarm from _swarmPeers.
+        return;
+      }
+      throw err;
+    }
   }
 
   async query({ topic }: { topic: PublicKey }): Promise<SwarmResponse> {

package/src/signal-manager/index.ts

@@ -3,7 +3,7 @@
 //
 
 export * from './memory-signal-manager';
-export * from './signal-manager';
+export type * from './signal-manager';
 export * from './websocket-signal-manager';
 export * from './edge-signal-manager';
 export * from './utils';

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

@@ -13,8 +13,9 @@ import { type SwarmResponse } from '@dxos/protocols/proto/dxos/edge/messenger';
 import { type QueryRequest } from '@dxos/protocols/proto/dxos/edge/signal';
 import { ComplexMap, ComplexSet } from '@dxos/util';
 
+import { type Message, type PeerInfo, PeerInfoHash, type SignalStatus, type SwarmEvent } from '../signal-methods';
+
 import { type SignalManager } from './signal-manager';
-import { type SwarmEvent, type PeerInfo, type SignalStatus, type Message, PeerInfoHash } from '../signal-methods';
 
 /**
  * Common signaling context that connects multiple MemorySignalManager instances.

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

@@ -5,7 +5,7 @@
 import { type Event } from '@dxos/async';
 import { type Lifecycle } from '@dxos/context';
 
-import { type SignalStatus, type SignalMethods } from '../signal-methods';
+import { type SignalMethods, type SignalStatus } from '../signal-methods';
 
 /**
  * Manages a collection of signaling clients.

package/src/signal-manager/websocket-signal-manager.node.test.ts

@@ -6,12 +6,13 @@ import { afterAll, beforeAll, describe, test } from 'vitest';
 
 import { asyncTimeout, sleep } from '@dxos/async';
 import { PublicKey } from '@dxos/keys';
-import { runTestSignalServer, type SignalServerRunner } from '@dxos/signal';
+import { type SignalServerRunner, runTestSignalServer } from '@dxos/signal';
 import { openAndClose } from '@dxos/test-utils';
 
-import { WebsocketSignalManager } from './websocket-signal-manager';
 import { createMessage, expectPeerAvailable, expectReceivedMessage } from '../testing';
 
+import { WebsocketSignalManager } from './websocket-signal-manager';
+
 describe.skip('WebSocketSignalManager', () => {
   let broker1: SignalServerRunner;
   let broker2: SignalServerRunner;

package/src/signal-manager/websocket-signal-manager.ts

@@ -13,18 +13,19 @@ import { type SwarmResponse } from '@dxos/protocols/proto/dxos/edge/messenger';
 import { type JoinRequest, type LeaveRequest, type QueryRequest } from '@dxos/protocols/proto/dxos/edge/signal';
 import { BitField, safeAwaitAll } from '@dxos/util';
 
-import { type SignalManager } from './signal-manager';
-import { WebsocketSignalManagerMonitor } from './websocket-signal-manager-monitor';
 import { SignalClient } from '../signal-client';
 import {
-  type PeerInfo,
   type Message,
+  type PeerInfo,
   type SignalClientMethods,
   type SignalMethods,
   type SignalStatus,
   type SwarmEvent,
 } from '../signal-methods';
 
+import { type SignalManager } from './signal-manager';
+import { WebsocketSignalManagerMonitor } from './websocket-signal-manager-monitor';
+
 const MAX_SERVER_FAILURES = 5;
 const WSS_SIGNAL_SERVER_REBOOT_DELAY = 3_000;
 

package/src/signal-methods.ts

@@ -4,13 +4,13 @@
 
 import { type Event } from '@dxos/async';
 import { type Lifecycle } from '@dxos/context';
-import { type SwarmResponse, type Peer } from '@dxos/protocols/proto/dxos/edge/messenger';
+import { type Peer, type SwarmResponse } from '@dxos/protocols/proto/dxos/edge/messenger';
 import {
+  type JoinRequest,
   type LeaveRequest,
   type Message,
-  type SwarmEvent,
-  type JoinRequest,
   type QueryRequest,
+  type SwarmEvent,
 } from '@dxos/protocols/proto/dxos/edge/signal';
 import { type SignalState } from '@dxos/protocols/proto/dxos/mesh/signal';
 

package/src/testing/test-builder.ts

@@ -2,10 +2,11 @@
 // Copyright 2022 DXOS.org
 //
 
-import { TestPeer } from './test-peer';
-import { type SignalManager, MemorySignalManager, MemorySignalManagerContext } from '../signal-manager';
+import { MemorySignalManager, MemorySignalManagerContext, type SignalManager } from '../signal-manager';
 import { type Message } from '../signal-methods';
 
+import { TestPeer } from './test-peer';
+
 export type TestBuilderOptions = {
   signalManagerFactory?: (peer: TestPeer) => Promise<SignalManager>;
   messageDisruption?: (msg: Message) => Message[];

package/src/testing/test-peer.ts

@@ -9,12 +9,13 @@ import { PublicKey } from '@dxos/keys';
 import { log } from '@dxos/log';
 import { buf } from '@dxos/protocols/buf';
 
-import { type TestBuilder } from './test-builder';
-import { expectPeerAvailable, expectPeerLeft, expectReceivedMessage } from './utils';
 import { Messenger } from '../messenger';
 import { type SignalManager } from '../signal-manager';
 import { type Message, type PeerInfo } from '../signal-methods';
 
+import { type TestBuilder } from './test-builder';
+import { expectPeerAvailable, expectPeerLeft, expectReceivedMessage } from './utils';
+
 export class TestPeer extends Resource {
   public peerId = PublicKey.random();
   public signalManager!: SignalManager;

package/src/testing/utils.ts

@@ -2,12 +2,13 @@
 // Copyright 2022 DXOS.org
 //
 
-import { asyncTimeout, type Event } from '@dxos/async';
+import { type Event, asyncTimeout } from '@dxos/async';
 import { type Any } from '@dxos/codec-protobuf';
 import { PublicKey } from '@dxos/keys';
 
+import { type Message, type PeerInfo, type SignalMethods } from '../signal-methods';
+
 import { PAYLOAD_1 } from './test-messages';
-import { type SignalMethods, type Message, type PeerInfo } from '../signal-methods';
 
 export const expectPeerAvailable = (client: SignalMethods, expectedTopic: PublicKey, peer: PeerInfo) =>
   asyncTimeout(