@dxos/edge-client 0.8.4-main.a4bbb77 → 0.8.4-main.abd8ff62ef

package/package.json

@@ -1,68 +1,65 @@
 {
   "name": "@dxos/edge-client",
-  "version": "0.8.4-main.a4bbb77",
+  "version": "0.8.4-main.abd8ff62ef",
   "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.92.1",
+    "@effect/platform": "0.94.4",
+    "@opentelemetry/api": "^1.9.0",
     "isomorphic-ws": "^5.0.0",
-    "ws": "^8.14.2",
-    "@dxos/async": "0.8.4-main.a4bbb77",
-    "@dxos/context": "0.8.4-main.a4bbb77",
-    "@dxos/credentials": "0.8.4-main.a4bbb77",
-    "@dxos/crypto": "0.8.4-main.a4bbb77",
-    "@dxos/debug": "0.8.4-main.a4bbb77",
-    "@dxos/invariant": "0.8.4-main.a4bbb77",
-    "@dxos/log": "0.8.4-main.a4bbb77",
-    "@dxos/keyring": "0.8.4-main.a4bbb77",
-    "@dxos/keys": "0.8.4-main.a4bbb77",
-    "@dxos/node-std": "0.8.4-main.a4bbb77",
-    "@dxos/protocols": "0.8.4-main.a4bbb77",
-    "@dxos/util": "0.8.4-main.a4bbb77"
+    "ws": "^8.17.1",
+    "@dxos/async": "0.8.4-main.abd8ff62ef",
+    "@dxos/context": "0.8.4-main.abd8ff62ef",
+    "@dxos/crypto": "0.8.4-main.abd8ff62ef",
+    "@dxos/credentials": "0.8.4-main.abd8ff62ef",
+    "@dxos/debug": "0.8.4-main.abd8ff62ef",
+    "@dxos/effect": "0.8.4-main.abd8ff62ef",
+    "@dxos/invariant": "0.8.4-main.abd8ff62ef",
+    "@dxos/keys": "0.8.4-main.abd8ff62ef",
+    "@dxos/keyring": "0.8.4-main.abd8ff62ef",
+    "@dxos/node-std": "0.8.4-main.abd8ff62ef",
+    "@dxos/log": "0.8.4-main.abd8ff62ef",
+    "@dxos/protocols": "0.8.4-main.abd8ff62ef",
+    "@dxos/tracing": "0.8.4-main.abd8ff62ef",
+    "@dxos/util": "0.8.4-main.abd8ff62ef"
   },
   "devDependencies": {
-    "@dxos/test-utils": "0.8.4-main.a4bbb77"
+    "@dxos/test-utils": "0.8.4-main.abd8ff62ef"
   },
   "peerDependencies": {
-    "effect": "^3.13.3"
+    "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,7 +2,15 @@
 // Copyright 2024 DXOS.org
 //
 
-import { Event, PersistentLifecycle, Trigger, TriggerState, scheduleMicroTask } from '@dxos/async';
+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';
@@ -17,6 +25,9 @@ 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;
 
@@ -25,6 +36,8 @@ export type MessengerConfig = {
   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> {
@@ -35,7 +48,7 @@ export interface EdgeConnection extends Required<Lifecycle> {
   get isOpen(): boolean;
   get status(): EdgeStatus;
   setIdentity(identity: EdgeIdentity): void;
-  send(message: Message): Promise<void>;
+  send(ctx: Context, message: Message): Promise<void>;
   onMessage(listener: MessageListener): () => void;
   onReconnected(listener: ReconnectListener): () => void;
 }
@@ -80,10 +93,19 @@ export class EdgeClient extends Resource implements EdgeConnection {
     };
   }
 
-  get status() {
-    return Boolean(this._currentConnection) && this._ready.state === TriggerState.RESOLVED
-      ? EdgeStatus.CONNECTED
-      : EdgeStatus.NOT_CONNECTED;
+  get status(): EdgeStatus {
+    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() {
@@ -107,7 +129,7 @@ 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) {
+  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 });
@@ -124,6 +146,15 @@ export class EdgeClient extends Resource implements EdgeConnection {
       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);
   }
 
@@ -159,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,
+    );
   }
 
   /**
@@ -188,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)) {

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

@@ -11,12 +11,13 @@ import { EdgeHttpClient } from './edge-http-client';
 const DEV_SERVER = 'https://edge.dxos.workers.dev';
 
 describe.skipIf(process.env.CI)('EdgeHttpClient', () => {
-  it.only('should get status', async ({ expect }) => {
+  it.skip('should get status', async ({ expect }) => {
     const client = new EdgeHttpClient(DEV_SERVER);
     const identity = await createEphemeralEdgeIdentity();
     client.setIdentity(identity);
 
-    const result = await client.getStatus();
+    const { Context } = await import('@dxos/context');
+    const result = await client.getStatus(Context.default());
     expect(result).toBeDefined();
   });
 });