@dxos/messaging 0.8.4-main.dedc0f3 → 0.8.4-main.dfabb4ec29

package/package.json

@@ -1,35 +1,30 @@
 {
   "name": "@dxos/messaging",
-  "version": "0.8.4-main.dedc0f3",
+  "version": "0.8.4-main.dfabb4ec29",
   "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",
-  "typesVersions": {
-    "*": {
-      "testing": [
-        "dist/types/src/testing/index.d.ts"
-      ]
-    }
-  },
   "files": [
     "dist",
     "src",
@@ -37,24 +32,24 @@
   ],
   "dependencies": {
     "isomorphic-ws": "^5.0.0",
-    "ws": "^8.14.2",
-    "@dxos/async": "0.8.4-main.dedc0f3",
-    "@dxos/codec-protobuf": "0.8.4-main.dedc0f3",
-    "@dxos/context": "0.8.4-main.dedc0f3",
-    "@dxos/edge-client": "0.8.4-main.dedc0f3",
-    "@dxos/keys": "0.8.4-main.dedc0f3",
-    "@dxos/invariant": "0.8.4-main.dedc0f3",
-    "@dxos/log": "0.8.4-main.dedc0f3",
-    "@dxos/protocols": "0.8.4-main.dedc0f3",
-    "@dxos/rpc": "0.8.4-main.dedc0f3",
-    "@dxos/tracing": "0.8.4-main.dedc0f3",
-    "@dxos/node-std": "0.8.4-main.dedc0f3",
-    "@dxos/util": "0.8.4-main.dedc0f3"
+    "ws": "^8.17.1",
+    "@dxos/async": "0.8.4-main.dfabb4ec29",
+    "@dxos/codec-protobuf": "0.8.4-main.dfabb4ec29",
+    "@dxos/context": "0.8.4-main.dfabb4ec29",
+    "@dxos/keys": "0.8.4-main.dfabb4ec29",
+    "@dxos/log": "0.8.4-main.dfabb4ec29",
+    "@dxos/node-std": "0.8.4-main.dfabb4ec29",
+    "@dxos/protocols": "0.8.4-main.dfabb4ec29",
+    "@dxos/edge-client": "0.8.4-main.dfabb4ec29",
+    "@dxos/rpc": "0.8.4-main.dfabb4ec29",
+    "@dxos/invariant": "0.8.4-main.dfabb4ec29",
+    "@dxos/tracing": "0.8.4-main.dfabb4ec29",
+    "@dxos/util": "0.8.4-main.dfabb4ec29"
   },
   "devDependencies": {
-    "@dxos/signal": "0.8.4-main.dedc0f3",
-    "@dxos/keyring": "0.8.4-main.dedc0f3",
-    "@dxos/test-utils": "0.8.4-main.dedc0f3"
+    "@dxos/signal": "0.8.4-main.dfabb4ec29",
+    "@dxos/keyring": "0.8.4-main.dfabb4ec29",
+    "@dxos/test-utils": "0.8.4-main.dfabb4ec29"
   },
   "publishConfig": {
     "access": "public"

package/src/messenger.blueprint-test.ts

@@ -5,6 +5,7 @@
 import { describe, expect, onTestFinished, test } from 'vitest';
 
 import { asyncTimeout, latch, sleep } from '@dxos/async';
+import { Context } from '@dxos/context';
 import { range } from '@dxos/util';
 
 import { WebsocketSignalManager } from './signal-manager';
@@ -30,7 +31,7 @@ export const messengerTests = (signalManagerFactory: TestBuilder['createSignalMa
 
     const promise = peer2.waitTillReceive(message);
 
-    await peer1.messenger.sendMessage(message);
+    await peer1.messenger.sendMessage(Context.default(), message);
 
     await promise;
   });
@@ -52,7 +53,7 @@ export const messengerTests = (signalManagerFactory: TestBuilder['createSignalMa
       };
 
       const promise = peer2.waitTillReceive(message);
-      await peer1.messenger.sendMessage(message);
+      await peer1.messenger.sendMessage(Context.default(), message);
       await asyncTimeout(promise, 1_000);
     }
 
@@ -64,7 +65,7 @@ export const messengerTests = (signalManagerFactory: TestBuilder['createSignalMa
       };
 
       const promise = peer3.waitTillReceive(message);
-      await peer1.messenger.sendMessage(message);
+      await peer1.messenger.sendMessage(Context.default(), message);
       await asyncTimeout(promise, 1_000);
     }
 
@@ -76,7 +77,7 @@ export const messengerTests = (signalManagerFactory: TestBuilder['createSignalMa
       };
 
       const promise = peer1.waitTillReceive(message);
-      await peer2.messenger.sendMessage(message);
+      await peer2.messenger.sendMessage(Context.default(), message);
       await asyncTimeout(promise, 1_000);
     }
   });
@@ -128,7 +129,7 @@ export const messengerTests = (signalManagerFactory: TestBuilder['createSignalMa
       };
       const promise = peer2.waitTillReceive(message);
 
-      await peer1.messenger.sendMessage(message);
+      await peer1.messenger.sendMessage(Context.default(), message);
 
       // 3 listeners (default one that was returned by setupPeer() and 2 that listen for type "1") should receive message.
       await asyncTimeout(promise, 1_000);
@@ -175,7 +176,7 @@ export const messengerTests = (signalManagerFactory: TestBuilder['createSignalMa
       };
 
       const receivePromise = peer2.waitTillReceive(message);
-      await peer1.messenger.sendMessage(message);
+      await peer1.messenger.sendMessage(Context.default(), message);
 
       // 2 subscribed listeners should receive message.
       await asyncTimeout(receivePromise, 1_000);
@@ -195,7 +196,7 @@ export const messengerTests = (signalManagerFactory: TestBuilder['createSignalMa
       };
 
       const receivePromise = peer2.waitTillReceive(message);
-      await peer1.messenger.sendMessage(message);
+      await peer1.messenger.sendMessage(Context.default(), message);
 
       // 1 listener that was not unsubscribed should receive message.
       await asyncTimeout(receivePromise, 1_000);
@@ -221,7 +222,7 @@ export const messengerTests = (signalManagerFactory: TestBuilder['createSignalMa
 
     {
       const receivePromise = peer2.waitTillReceive(message);
-      await peer1.messenger.sendMessage(message);
+      await peer1.messenger.sendMessage(Context.default(), message);
       await asyncTimeout(receivePromise, 1_000);
     }
 
@@ -236,7 +237,7 @@ export const messengerTests = (signalManagerFactory: TestBuilder['createSignalMa
 
     {
       const receivePromise = peer2.waitTillReceive(message);
-      await peer1.messenger.sendMessage(message);
+      await peer1.messenger.sendMessage(Context.default(), message);
       await asyncTimeout(receivePromise, 1_000);
     }
   });
@@ -275,7 +276,7 @@ export const messengerTests = (signalManagerFactory: TestBuilder['createSignalMa
       Array(3)
         .fill(0)
         .forEach(async () => {
-          await peer2.messenger.sendMessage(message);
+          await peer2.messenger.sendMessage(Context.default(), message);
         });
 
       // expect to receive 3 messages.
@@ -302,7 +303,7 @@ export const messengerTests = (signalManagerFactory: TestBuilder['createSignalMa
         count = inc();
       });
       // sending message.
-      await peer2.messenger.sendMessage({
+      await peer2.messenger.sendMessage(Context.default(), {
         author: peer2.peerInfo,
         recipient: peer1.peerInfo,
         payload: PAYLOAD_1,
@@ -322,7 +323,7 @@ export const messengerTests = (signalManagerFactory: TestBuilder['createSignalMa
       void range(100).map(async () => {
         const peer = await builder.createPeer();
 
-        void peer.messenger.sendMessage({
+        void peer.messenger.sendMessage(Context.default(), {
           author: peer.peerInfo,
           recipient: peer.peerInfo,
           payload: {

package/src/messenger.node.test.ts

@@ -2,48 +2,17 @@
 // Copyright 2022 DXOS.org
 //
 
-import { afterAll, beforeAll, describe, onTestFinished, test } from 'vitest';
-
-import { asyncTimeout } from '@dxos/async';
-import { type SignalServerRunner, runTestSignalServer } 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

@@ -8,7 +8,7 @@ import { Context } from '@dxos/context';
 import { invariant } from '@dxos/invariant';
 import { PublicKey } from '@dxos/keys';
 import { log } from '@dxos/log';
-import { TimeoutError as ProtocolTimeoutError, trace } from '@dxos/protocols';
+import { TimeoutError as ProtocolTimeoutError } from '@dxos/protocols';
 import { schema } from '@dxos/protocols/proto';
 import { type ReliablePayload } from '@dxos/protocols/proto/dxos/mesh/messaging';
 import { ComplexMap, ComplexSet } from '@dxos/util';
@@ -68,8 +68,7 @@ export class Messenger {
     if (!this._closed) {
       return;
     }
-    const traceId = PublicKey.random().toHex();
-    log.trace('dxos.mesh.messenger.open', trace.begin({ id: traceId }));
+    log('opening messenger');
     this._ctx = new Context({
       onError: (err) => log.catch(err),
     });
@@ -90,7 +89,7 @@ export class Messenger {
     );
 
     this._closed = false;
-    log.trace('dxos.mesh.messenger.open', trace.end({ id: traceId }));
+    log('opened messenger');
   }
 
   async close(): Promise<void> {
@@ -101,7 +100,7 @@ export class Messenger {
     await this._ctx.dispose();
   }
 
-  async sendMessage({ author, recipient, payload }: Message): Promise<void> {
+  async sendMessage(ctx: Context, { author, recipient, payload }: Message): Promise<void> {
     invariant(!this._closed, 'Closed');
     const messageContext = this._ctx.derive();
 
@@ -127,7 +126,7 @@ export class Messenger {
       async () => {
         log('retrying message', { messageId: reliablePayload.messageId });
         sendAttempts++;
-        await this._encodeAndSend({ author, recipient, reliablePayload }).catch((err) =>
+        await this._encodeAndSend(ctx, { author, recipient, reliablePayload }).catch((err) =>
           log('failed to send message', { err }),
         );
       },
@@ -140,10 +139,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 });
@@ -158,7 +157,7 @@ export class Messenger {
       this._monitor.recordReliableMessage({ sendAttempts, sent: true });
     });
 
-    await this._encodeAndSend({ author, recipient, reliablePayload });
+    await this._encodeAndSend(ctx, { author, recipient, reliablePayload });
     return promise;
   }
 
@@ -204,16 +203,19 @@ export class Messenger {
     };
   }
 
-  private async _encodeAndSend({
-    author,
-    recipient,
-    reliablePayload,
-  }: {
-    author: PeerInfo;
-    recipient: PeerInfo;
-    reliablePayload: ReliablePayload;
-  }): Promise<void> {
-    await this._signalManager.sendMessage({
+  private async _encodeAndSend(
+    ctx: Context,
+    {
+      author,
+      recipient,
+      reliablePayload,
+    }: {
+      author: PeerInfo;
+      recipient: PeerInfo;
+      reliablePayload: ReliablePayload;
+    },
+  ): Promise<void> {
+    await this._signalManager.sendMessage(ctx, {
       author,
       recipient,
       payload: {
@@ -243,7 +245,7 @@ export class Messenger {
     log('handling message', { messageId: reliablePayload.messageId });
 
     try {
-      await this._sendAcknowledgement({
+      await this._sendAcknowledgement(this._ctx, {
         author,
         recipient,
         messageId: reliablePayload.messageId,
@@ -272,18 +274,21 @@ export class Messenger {
     this._onAckCallbacks.get(Acknowledgement.decode(payload.value).messageId)?.();
   }
 
-  private async _sendAcknowledgement({
-    author,
-    recipient,
-    messageId,
-  }: {
-    author: PeerInfo;
-    recipient: PeerInfo;
-    messageId: PublicKey;
-  }): Promise<void> {
+  private async _sendAcknowledgement(
+    ctx: Context,
+    {
+      author,
+      recipient,
+      messageId,
+    }: {
+      author: PeerInfo;
+      recipient: PeerInfo;
+      messageId: PublicKey;
+    },
+  ): Promise<void> {
     log('sending ACK', { messageId, from: recipient, to: author });
 
-    await this._signalManager.sendMessage({
+    await this._signalManager.sendMessage(ctx, {
       author: recipient,
       recipient: author,
       payload: {

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

@@ -6,6 +6,7 @@ import { afterAll, beforeAll, describe, expect, onTestFinished, test } from 'vit
 
 import { asyncTimeout, waitForCondition } from '@dxos/async';
 import { type Any, type TaggedType } from '@dxos/codec-protobuf';
+import { Context } from '@dxos/context';
 import { PublicKey } from '@dxos/keys';
 import { log } from '@dxos/log';
 import { type TYPES } from '@dxos/protocols/proto';
@@ -13,7 +14,6 @@ import { type SignalServerRunner, runTestSignalServer } from '@dxos/signal';
 import { ComplexSet, range } from '@dxos/util';
 
 import { type Message, type PeerInfo } from '../signal-methods';
-
 import { SignalClient } from './signal-client';
 
 const PAYLOAD: TaggedType<TYPES, 'google.protobuf.Any'> = {
@@ -43,7 +43,7 @@ describe('SignalClient', () => {
 
     const message = createMessage(peer2, peer1);
     const receivedMessage = peer1.waitForNextMessage();
-    await peer2.client.sendMessage(message);
+    await peer2.client.sendMessage(Context.default(), message);
     expect(await receivedMessage).toEqual(message);
   });
 
@@ -51,8 +51,8 @@ describe('SignalClient', () => {
     const topic = PublicKey.random();
     const [peer1, peer2] = setupPeers({ peerCount: 2 });
 
-    await peer1.client.join({ topic, peer: peer1.peerInfo });
-    await peer2.client.join({ topic, peer: peer2.peerInfo });
+    await peer1.client.join(Context.default(), { topic, peer: peer1.peerInfo });
+    await peer2.client.join(Context.default(), { topic, peer: peer2.peerInfo });
 
     await peer1.waitForPeer(peer2.peerKey);
     await peer2.waitForPeer(peer1.peerKey);
@@ -67,7 +67,7 @@ describe('SignalClient', () => {
     const message = createMessage(peer2, peer1);
     const receivedMessage = peer1.waitForNextMessage();
 
-    await peer1.client.sendMessage(message);
+    await peer1.client.sendMessage(Context.default(), message);
     expect(await receivedMessage).toEqual(message);
   });
 
@@ -82,7 +82,7 @@ describe('SignalClient', () => {
 
     {
       const receivedMessage = peer1.waitForNextMessage({ timeout: 1_000 });
-      await peer2.client.sendMessage(message);
+      await peer2.client.sendMessage(Context.default(), message);
       expect(await receivedMessage).toEqual(message);
     }
 
@@ -91,7 +91,7 @@ describe('SignalClient', () => {
 
     {
       const receivedMessage = peer1.waitForNextMessage({ timeout: 200 });
-      await peer2.client.sendMessage(message);
+      await peer2.client.sendMessage(Context.default(), message);
       await expect(receivedMessage).rejects.toBeDefined();
     }
   });
@@ -106,7 +106,7 @@ describe('SignalClient', () => {
 
     {
       const waitMessage = peer1.waitForNextMessage();
-      await peer2.client.sendMessage(message);
+      await peer2.client.sendMessage(Context.default(), message);
       expect(await waitMessage).toEqual(message);
     }
 
@@ -120,7 +120,7 @@ describe('SignalClient', () => {
 
     {
       const waitMessage = peer1.waitForNextMessage();
-      await peer2.client.sendMessage(message);
+      await peer2.client.sendMessage(Context.default(), message);
       expect(await waitMessage).toEqual(message);
     }
   });

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

@@ -7,7 +7,6 @@ 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 JoinRequest, type LeaveRequest, type QueryRequest } from '@dxos/protocols/proto/dxos/edge/signal';
 import { SignalState } from '@dxos/protocols/proto/dxos/mesh/signal';
@@ -19,7 +18,6 @@ import {
   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';
@@ -57,8 +55,6 @@ export class SignalClient extends Resource implements SignalClientMethods {
    */
   private _reconnectAfter = DEFAULT_RECONNECT_TIMEOUT;
 
-  private readonly _instanceId = PublicKey.random().toHex();
-
   /**
    * @internal
    */
@@ -94,7 +90,7 @@ export class SignalClient extends Resource implements SignalClientMethods {
   }
 
   protected override async _open(): Promise<void> {
-    log.trace('dxos.mesh.signal-client.open', trace.begin({ id: this._instanceId }));
+    log('opening signal client');
 
     if ([SignalState.CONNECTED, SignalState.CONNECTING].includes(this._state)) {
       return;
@@ -137,7 +133,7 @@ export class SignalClient extends Resource implements SignalClientMethods {
     });
 
     this._createClient();
-    log.trace('dxos.mesh.signal-client.open', trace.end({ id: this._instanceId }));
+    log('opened signal client');
   }
 
   protected override async _catch(err: Error): Promise<void> {
@@ -173,24 +169,24 @@ export class SignalClient extends Resource implements SignalClientMethods {
     };
   }
 
-  async join(args: JoinRequest): Promise<void> {
+  async join(_ctx: Context, args: JoinRequest): Promise<void> {
     log('joining', { topic: args.topic, peerId: args.peer.peerKey });
     this._monitor.recordJoin();
     this.localState.join({ topic: args.topic, peerId: PublicKey.from(args.peer.peerKey) });
     this._reconcileTask?.schedule();
   }
 
-  async leave(args: LeaveRequest): Promise<void> {
+  async leave(_ctx: Context, args: LeaveRequest): Promise<void> {
     log('leaving', { topic: args.topic, peerId: args.peer.peerKey });
     this._monitor.recordLeave();
     this.localState.leave({ topic: args.topic, peerId: PublicKey.from(args.peer.peerKey) });
   }
 
-  async query(params: QueryRequest): Promise<SwarmResponse> {
+  async query(_ctx: Context, params: QueryRequest): Promise<SwarmResponse> {
     throw new Error('Not implemented');
   }
 
-  async sendMessage(msg: Message): Promise<void> {
+  async sendMessage(_ctx: Context, msg: Message): Promise<void> {
     return this._monitor.recordMessageSending(msg, async () => {
       await this._clientReady.wait();
       invariant(this._state === SignalState.CONNECTED, 'Not connected to Signal Server');

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

@@ -14,7 +14,6 @@ import {
 import { ComplexMap, ComplexSet, safeAwaitAll } from '@dxos/util';
 
 import type { Message, SwarmEvent } from '../signal-methods';
-
 import { type SignalRPCClient } from './signal-rpc-client';
 
 export class SignalLocalState {

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

@@ -10,7 +10,6 @@ import { Context } from '@dxos/context';
 import { invariant } from '@dxos/invariant';
 import { PublicKey } from '@dxos/keys';
 import { log } from '@dxos/log';
-import { trace } from '@dxos/protocols';
 import { schema } from '@dxos/protocols/proto';
 import { type Signal, type Message as SignalMessage } from '@dxos/protocols/proto/dxos/mesh/signal';
 import { type ProtoRpcPeer, createProtoRpcPeer } from '@dxos/rpc';
@@ -36,7 +35,7 @@ export type SignalCallbacks = {
   getMetadata?: () => any;
 };
 
-export type SignalRPCClientParams = {
+export type SignalRPCClientProps = {
   url: string;
   callbacks?: SignalCallbacks;
 };
@@ -61,9 +60,8 @@ export class SignalRPCClient {
 
   private readonly _monitor = new SignalRpcClientMonitor();
 
-  constructor({ url, callbacks = {} }: SignalRPCClientParams) {
-    const traceId = PublicKey.random().toHex();
-    log.trace('dxos.mesh.signal-rpc-client.constructor', trace.begin({ id: traceId }));
+  constructor({ url, callbacks = {} }: SignalRPCClientProps) {
+    log('creating signal rpc client', { url });
     this._url = url;
     this._callbacks = callbacks;
     this._socket = new WebSocket(this._url);
@@ -149,7 +147,7 @@ export class SignalRPCClient {
       log.warn(`Socket ${event.type ?? 'unknown'} error`, { message: event.message, url: this._url });
     };
 
-    log.trace('dxos.mesh.signal-rpc-client.constructor', trace.end({ id: traceId }));
+    log('created signal rpc client', { url });
   }
 
   async close(): Promise<void> {