@dxos/edge-client 0.8.3 → 0.8.4-main.1c7ec43d41

package/package.json

@@ -1,61 +1,65 @@
 {
   "name": "@dxos/edge-client",
-  "version": "0.8.3",
+  "version": "0.8.4-main.1c7ec43d41",
   "description": "EDGE Client",
   "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"
     },
     "./muxer": {
+      "source": "./src/edge-ws-muxer.ts",
       "types": "./dist/types/src/edge-ws-muxer.d.ts",
-      "browser": "./dist/lib/browser/edge-ws-muxer.mjs",
-      "node": "./dist/lib/node-esm/edge-ws-muxer.mjs"
+      "default": "./dist/lib/neutral/edge-ws-muxer.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",
     "README.md"
   ],
   "dependencies": {
+    "@effect/platform": "0.94.4",
+    "@opentelemetry/api": "^1.9.0",
     "isomorphic-ws": "^5.0.0",
-    "ws": "^8.14.2",
-    "@dxos/async": "0.8.3",
-    "@dxos/context": "0.8.3",
-    "@dxos/credentials": "0.8.3",
-    "@dxos/debug": "0.8.3",
-    "@dxos/invariant": "0.8.3",
-    "@dxos/keys": "0.8.3",
-    "@dxos/keyring": "0.8.3",
-    "@dxos/log": "0.8.3",
-    "@dxos/crypto": "0.8.3",
-    "@dxos/node-std": "0.8.3",
-    "@dxos/protocols": "0.8.3",
-    "@dxos/util": "0.8.3"
+    "ws": "^8.17.1",
+    "@dxos/async": "0.8.4-main.1c7ec43d41",
+    "@dxos/context": "0.8.4-main.1c7ec43d41",
+    "@dxos/credentials": "0.8.4-main.1c7ec43d41",
+    "@dxos/crypto": "0.8.4-main.1c7ec43d41",
+    "@dxos/invariant": "0.8.4-main.1c7ec43d41",
+    "@dxos/effect": "0.8.4-main.1c7ec43d41",
+    "@dxos/debug": "0.8.4-main.1c7ec43d41",
+    "@dxos/keyring": "0.8.4-main.1c7ec43d41",
+    "@dxos/keys": "0.8.4-main.1c7ec43d41",
+    "@dxos/log": "0.8.4-main.1c7ec43d41",
+    "@dxos/node-std": "0.8.4-main.1c7ec43d41",
+    "@dxos/tracing": "0.8.4-main.1c7ec43d41",
+    "@dxos/util": "0.8.4-main.1c7ec43d41",
+    "@dxos/protocols": "0.8.4-main.1c7ec43d41"
   },
   "devDependencies": {
-    "@dxos/test-utils": "0.8.3"
+    "@dxos/test-utils": "0.8.4-main.1c7ec43d41"
+  },
+  "peerDependencies": {
+    "effect": "3.20.0"
   },
   "publishConfig": {
     "access": "public"

package/src/edge-client.test.ts

@@ -5,6 +5,7 @@
 import { describe, expect, onTestFinished, test } from 'vitest';
 
 import { Trigger } from '@dxos/async';
+import { Context } from '@dxos/context';
 import { Keyring } from '@dxos/keyring';
 import { TextMessageSchema } from '@dxos/protocols/buf/dxos/edge/messenger_pb';
 import { EdgeStatus } from '@dxos/protocols/proto/dxos/client/services';
@@ -25,13 +26,13 @@ describe('EdgeClient', () => {
     onTestFinished(cleanup);
 
     const { client, reconnectTrigger } = await openNewClient(endpoint);
-    await client.send(textMessage('Hello world 1'));
+    await client.send(Context.default(), textMessage('Hello world 1'));
     expect(client.isOpen).is.true;
 
     reconnectTrigger.reset();
     await closeConnection();
     await reconnectTrigger.wait();
-    await expect(client.send(textMessage('Hello world 2'))).resolves.not.toThrow();
+    await expect(client.send(Context.default(), textMessage('Hello world 2'))).resolves.not.toThrow();
   });
 
   test('isConnected', async () => {
@@ -41,17 +42,17 @@ describe('EdgeClient', () => {
 
     const { client } = await openNewClient(endpoint);
 
-    expect(client.status).toBe(EdgeStatus.NOT_CONNECTED);
+    expect(client.status.state).toBe(EdgeStatus.ConnectionState.NOT_CONNECTED);
     admitConnection.wake();
-    await expect.poll(() => client.status).toBe(EdgeStatus.CONNECTED);
+    await expect.poll(() => client.status.state).toBe(EdgeStatus.ConnectionState.CONNECTED);
 
     admitConnection.reset();
     await closeConnection();
     expect(client.isOpen).is.true;
-    await expect.poll(() => client.status).toBe(EdgeStatus.NOT_CONNECTED);
+    await expect.poll(() => client.status.state).toBe(EdgeStatus.ConnectionState.NOT_CONNECTED);
 
     admitConnection.wake();
-    await expect.poll(() => client.status).toBe(EdgeStatus.CONNECTED);
+    await expect.poll(() => client.status.state).toBe(EdgeStatus.ConnectionState.CONNECTED);
   });
 
   test('set identity reconnects', async () => {
@@ -59,13 +60,13 @@ describe('EdgeClient', () => {
     onTestFinished(cleanup);
 
     const { client, reconnectTrigger } = await openNewClient(endpoint);
-    await client.send(textMessage('Hello world 1'));
+    await client.send(Context.default(), textMessage('Hello world 1'));
     expect(client.isOpen).is.true;
 
     reconnectTrigger.reset();
     client.setIdentity(await createEphemeralEdgeIdentity());
     await reconnectTrigger.wait();
-    await expect(client.send(textMessage('Hello world 2'))).resolves.not.toThrow();
+    await expect(client.send(Context.default(), textMessage('Hello world 2'))).resolves.not.toThrow();
   });
 
   test('send blocks until connection becomes ready', async () => {
@@ -75,7 +76,7 @@ describe('EdgeClient', () => {
 
     const { client } = await openNewClient(endpoint);
     setTimeout(() => admitConnection.wake(), 20);
-    await client.send(textMessage('Hello world 1'));
+    await client.send(Context.default(), textMessage('Hello world 1'));
     await expect.poll(() => messageSink.length).toBe(1);
   });
 
@@ -86,11 +87,13 @@ describe('EdgeClient', () => {
 
     const { client } = await openNewClient(endpoint);
     setTimeout(async () => client.setIdentity(await createEphemeralEdgeIdentity()));
-    await expect(client.send(textMessage('Hello world 1'))).rejects.toThrow(EdgeIdentityChangedError);
+    await expect(client.send(Context.default(), textMessage('Hello world 1'))).rejects.toThrow(
+      EdgeIdentityChangedError,
+    );
 
     // Test recovers.
     setTimeout(() => admitConnection.wake(), 20);
-    await client.send(textMessage('Hello world 1'));
+    await client.send(Context.default(), textMessage('Hello world 1'));
     await expect.poll(() => messageSink.length).toBe(1);
   });
 
@@ -101,7 +104,9 @@ describe('EdgeClient', () => {
 
     const { client } = await openNewClient(endpoint);
     setTimeout(() => client.close());
-    await expect(client.send(textMessage('Hello world 1'))).rejects.toThrow(EdgeConnectionClosedError);
+    await expect(client.send(Context.default(), textMessage('Hello world 1'))).rejects.toThrow(
+      EdgeConnectionClosedError,
+    );
   });
 
   test('onReconnect trigger', async () => {
@@ -129,12 +134,12 @@ describe('EdgeClient', () => {
     onTestFinished(cleanup);
 
     const { client, identity: oldIdentity } = await openNewClient(endpoint);
-    await client.send(textMessage('Hello world 1', oldIdentity));
+    await client.send(Context.default(), textMessage('Hello world 1', oldIdentity));
     expect(client.isOpen).is.true;
 
     const newIdentity = await createEphemeralEdgeIdentity();
     client.setIdentity(newIdentity);
-    await client.send(textMessage('Hello world 2', newIdentity));
+    await client.send(Context.default(), textMessage('Hello world 2', newIdentity));
     await expect.poll(() => messageSourceLog.length).toBe(2);
     expect(messageSourceLog.map((m) => m.peerKey)).toStrictEqual([oldIdentity.peerKey, newIdentity.peerKey]);
   });
@@ -147,7 +152,7 @@ describe('EdgeClient', () => {
 
     const client = new EdgeClient(identity, { socketEndpoint: process.env.EDGE_ENDPOINT! });
     await openAndClose(client);
-    await client.send(textMessage('Hello world 1'));
+    await client.send(Context.default(), textMessage('Hello world 1'));
     expect(client.isOpen).is.true;
   });
 

package/src/edge-client.ts

@@ -2,8 +2,16 @@
 // Copyright 2024 DXOS.org
 //
 
-import { Trigger, scheduleMicroTask, TriggerState, PersistentLifecycle, Event } from '@dxos/async';
-import { Resource, type Lifecycle } from '@dxos/context';
+import {
+  Event,
+  PersistentLifecycle,
+  Trigger,
+  TriggerState,
+  scheduleMicroTask,
+  scheduleTaskInterval,
+} from '@dxos/async';
+import { Context, TRACE_SPAN_ATTRIBUTE, type TraceContextData } from '@dxos/context';
+import { type Lifecycle, Resource } from '@dxos/context';
 import { log, logInfo } from '@dxos/log';
 import { type Message } from '@dxos/protocols/buf/dxos/edge/messenger_pb';
 import { EdgeStatus } from '@dxos/protocols/proto/dxos/client/services';
@@ -17,9 +25,21 @@ import { getEdgeUrlWithProtocol } from './utils';
 
 const DEFAULT_TIMEOUT = 10_000;
 
+// Refresh status every second: rtt, rate counters.
+const STATUS_REFRESH_INTERVAL = 1000;
+
 export type MessageListener = (message: Message) => void;
 export type ReconnectListener = () => void;
 
+export type MessengerConfig = {
+  socketEndpoint: string;
+  timeout?: number;
+  protocol?: Protocol;
+  disableAuth?: boolean;
+  /** Sent as `X-DXOS-Client-Tag` on the WebSocket upgrade (Node/`ws` only; ignored in browsers). */
+  clientTag?: string;
+};
+
 export interface EdgeConnection extends Required<Lifecycle> {
   statusChanged: Event<EdgeStatus>;
   get info(): any;
@@ -28,18 +48,11 @@ export interface EdgeConnection extends Required<Lifecycle> {
   get isOpen(): boolean;
   get status(): EdgeStatus;
   setIdentity(identity: EdgeIdentity): void;
+  send(ctx: Context, message: Message): Promise<void>;
   onMessage(listener: MessageListener): () => void;
   onReconnected(listener: ReconnectListener): () => void;
-  send(message: Message): Promise<void>;
 }
 
-export type MessengerConfig = {
-  socketEndpoint: string;
-  timeout?: number;
-  protocol?: Protocol;
-  disableAuth?: boolean;
-};
-
 /**
  * Messenger client for EDGE:
  *  - While open, uses PersistentLifecycle to keep an open EdgeWsConnection, reconnecting on failures.
@@ -81,9 +94,18 @@ export class EdgeClient extends Resource implements EdgeConnection {
   }
 
   get status(): EdgeStatus {
-    return Boolean(this._currentConnection) && this._ready.state === TriggerState.RESOLVED
-      ? EdgeStatus.CONNECTED
-      : EdgeStatus.NOT_CONNECTED;
+    return {
+      state:
+        Boolean(this._currentConnection) && this._ready.state === TriggerState.RESOLVED
+          ? EdgeStatus.ConnectionState.CONNECTED
+          : EdgeStatus.ConnectionState.NOT_CONNECTED,
+      uptime: this._currentConnection?.uptime ?? 0,
+      rtt: this._currentConnection?.rtt ?? 0,
+      rateBytesUp: this._currentConnection?.uploadRate ?? 0,
+      rateBytesDown: this._currentConnection?.downloadRate ?? 0,
+      messagesSent: this._currentConnection?.messagesSent ?? 0,
+      messagesReceived: this._currentConnection?.messagesReceived ?? 0,
+    };
   }
 
   get identityKey() {
@@ -94,7 +116,7 @@ export class EdgeClient extends Resource implements EdgeConnection {
     return this._identity.peerKey;
   }
 
-  setIdentity(identity: EdgeIdentity): void {
+  setIdentity(identity: EdgeIdentity) {
     if (identity.identityKey !== this._identity.identityKey || identity.peerKey !== this._identity.peerKey) {
       log('Edge identity changed', { identity, oldIdentity: this._identity });
       this._identity = identity;
@@ -103,12 +125,45 @@ export class EdgeClient extends Resource implements EdgeConnection {
     }
   }
 
-  public onMessage(listener: MessageListener): () => void {
+  /**
+   * Send message.
+   * NOTE: The message is guaranteed to be delivered but the service must respond with a message to confirm processing.
+   */
+  public async send(ctx: Context, message: Message) {
+    if (this._ready.state !== TriggerState.RESOLVED) {
+      log('waiting for websocket');
+      await this._ready.wait({ timeout: this._config.timeout ?? DEFAULT_TIMEOUT });
+    }
+
+    if (!this._currentConnection) {
+      throw new EdgeConnectionClosedError();
+    }
+
+    if (
+      message.source &&
+      (message.source.peerKey !== this._identity.peerKey || message.source.identityKey !== this.identityKey)
+    ) {
+      throw new EdgeIdentityChangedError();
+    }
+
+    const traceCtx = ctx.getAttribute(TRACE_SPAN_ATTRIBUTE) as TraceContextData | undefined;
+    if (traceCtx) {
+      message.traceContext = {
+        $typeName: 'dxos.edge.messenger.TraceContext',
+        traceparent: traceCtx.traceparent,
+        tracestate: traceCtx.tracestate,
+      };
+    }
+
+    this._currentConnection.send(message);
+  }
+
+  public onMessage(listener: MessageListener) {
     this._messageListeners.add(listener);
     return () => this._messageListeners.delete(listener);
   }
 
-  public onReconnected(listener: () => void): () => void {
+  public onReconnected(listener: () => void) {
     this._reconnectListeners.add(listener);
     if (this._ready.state === TriggerState.RESOLVED) {
       // Microtask so that listener is always called asynchronously, no matter the state of the ready trigger
@@ -123,6 +178,7 @@ export class EdgeClient extends Resource implements EdgeConnection {
         }
       });
     }
+
     return () => this._reconnectListeners.delete(listener);
   }
 
@@ -134,6 +190,18 @@ export class EdgeClient extends Resource implements EdgeConnection {
     this._persistentLifecycle.open().catch((err) => {
       log.warn('Error while opening connection', { err });
     });
+
+    // Notify about status changes (rtt, rate counters).
+    scheduleTaskInterval(
+      this._ctx,
+      async () => {
+        if (!this._currentConnection) {
+          return;
+        }
+        this.statusChanged.emit(this.status);
+      },
+      STATUS_REFRESH_INTERVAL,
+    );
   }
 
   /**
@@ -163,7 +231,11 @@ export class EdgeClient extends Resource implements EdgeConnection {
     log('Opening websocket', { url: url.toString(), protocolHeader });
     const connection = new EdgeWsConnection(
       identity,
-      { url, protocolHeader },
+      {
+        url,
+        protocolHeader,
+        headers: this._config.clientTag ? { 'X-DXOS-Client-Tag': this._config.clientTag } : undefined,
+      },
       {
         onConnected: () => {
           if (this._isActive(connection)) {
@@ -200,7 +272,6 @@ export class EdgeClient extends Resource implements EdgeConnection {
     // Race with restartRequired so that restart is not blocked by _connect execution.
     // Wait on ready to attempt a reconnect if it times out.
     await Promise.race([this._ready.wait({ timeout: this._config.timeout ?? DEFAULT_TIMEOUT }), restartRequired]);
-
     return connection;
   }
 
@@ -237,30 +308,6 @@ export class EdgeClient extends Resource implements EdgeConnection {
     }
   }
 
-  /**
-   * Send message.
-   * NOTE: The message is guaranteed to be delivered but the service must respond with a message to confirm processing.
-   */
-  public async send(message: Message): Promise<void> {
-    if (this._ready.state !== TriggerState.RESOLVED) {
-      log('waiting for websocket to become ready');
-      await this._ready.wait({ timeout: this._config.timeout ?? DEFAULT_TIMEOUT });
-    }
-
-    if (!this._currentConnection) {
-      throw new EdgeConnectionClosedError();
-    }
-
-    if (
-      message.source &&
-      (message.source.peerKey !== this._identity.peerKey || message.source.identityKey !== this.identityKey)
-    ) {
-      throw new EdgeIdentityChangedError();
-    }
-
-    this._currentConnection.send(message);
-  }
-
   private async _createAuthHeader(path: string): Promise<string | undefined> {
     const httpUrl = new URL(path, this._baseHttpUrl);
     httpUrl.protocol = getEdgeUrlWithProtocol(this._baseWsUrl.toString(), 'http');
@@ -277,7 +324,7 @@ export class EdgeClient extends Resource implements EdgeConnection {
 }
 
 const encodePresentationWsAuthHeader = (encodedPresentation: Uint8Array): string => {
-  // = and / characters are not allowed in the WebSocket subprotocol header.
+  // '=' and '/' characters are not allowed in the WebSocket subprotocol header.
   const encodedToken = Buffer.from(encodedPresentation).toString('base64').replace(/=*$/, '').replaceAll('/', '|');
   return `base64url.bearer.authorization.dxos.org.${encodedToken}`;
 };

package/src/edge-http-client.test.ts

@@ -0,0 +1,23 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { describe, it } from 'vitest';
+
+import { createEphemeralEdgeIdentity } from './auth';
+import { EdgeHttpClient } from './edge-http-client';
+
+// TODO(burdon): Factor out config.
+const DEV_SERVER = 'https://edge.dxos.workers.dev';
+
+describe.skipIf(process.env.CI)('EdgeHttpClient', () => {
+  it.skip('should get status', async ({ expect }) => {
+    const client = new EdgeHttpClient(DEV_SERVER);
+    const identity = await createEphemeralEdgeIdentity();
+    client.setIdentity(identity);
+
+    const { Context } = await import('@dxos/context');
+    const result = await client.getStatus(Context.default());
+    expect(result).toBeDefined();
+  });
+});