@dxos/edge-client 0.8.4-main.fd6878d → 0.8.4-main.fffef41

package/src/edge-ws-connection.ts

@@ -32,6 +32,22 @@ export class EdgeWsConnection extends Resource {
   private _wsMuxer: WebSocketMuxer | undefined;
   private _lastReceivedMessageTimestamp = Date.now();
 
+  private _openTimestamp: number | undefined;
+
+  // Latency tracking.
+  private _pingTimestamp: number | undefined;
+  private _rtt = 0;
+
+  // Rate tracking with sliding window.
+  private _uploadRate = 0;
+  private _downloadRate = 0;
+  private readonly _rateWindow = 10000; // 10 second sliding window.
+  private readonly _rateUpdateInterval = 1000; // Update rates every second.
+  private _bytesSamples: Array<{ timestamp: number; sent: number; received: number }> = [];
+
+  private _messagesSent = 0;
+  private _messagesReceived = 0;
+
   constructor(
     private readonly _identity: EdgeIdentity,
     private readonly _connectionInfo: { url: URL; protocolHeader?: string },
@@ -49,10 +65,35 @@ export class EdgeWsConnection extends Resource {
     };
   }
 
+  public get rtt(): number {
+    return this._rtt;
+  }
+
+  public get uptime(): number {
+    return this._openTimestamp ? (Date.now() - this._openTimestamp) / 1000 : 0;
+  }
+
+  public get uploadRate(): number {
+    return this._uploadRate;
+  }
+
+  public get downloadRate(): number {
+    return this._downloadRate;
+  }
+
+  public get messagesSent(): number {
+    return this._messagesSent;
+  }
+
+  public get messagesReceived(): number {
+    return this._messagesReceived;
+  }
+
   public send(message: Message): void {
     invariant(this._ws);
     invariant(this._wsMuxer);
     log('sending...', { peerKey: this._identity.peerKey, payload: protocol.getPayloadType(message) });
+    this._messagesSent++;
     if (this._ws?.protocol.includes(EdgeWebsocketProtocol.V0)) {
       const binary = buf.toBinary(MessageSchema, message);
       if (binary.length > CLOUDFLARE_MESSAGE_MAX_BYTES) {
@@ -63,8 +104,12 @@ export class EdgeWsConnection extends Resource {
         });
         return;
       }
+      this._recordBytes(binary.byteLength, 0);
       this._ws.send(binary);
     } else {
+      // For muxer, we need to track the size of the message being sent.
+      const binary = buf.toBinary(MessageSchema, message);
+      this._recordBytes(binary.byteLength, 0);
       this._wsMuxer.send(message).catch((e) => log.catch(e));
     }
   }
@@ -83,20 +128,22 @@ export class EdgeWsConnection extends Resource {
     this._ws.onopen = () => {
       if (this.isOpen) {
         log('connected');
+        this._openTimestamp = Date.now();
         this._callbacks.onConnected();
         this._scheduleHeartbeats();
+        this._scheduleRateCalculation();
       } else {
         log.verbose('connected after becoming inactive', { currentIdentity: this._identity });
       }
     };
-    this._ws.onclose = (event) => {
+    this._ws.onclose = (event: WebSocket.CloseEvent) => {
       if (this.isOpen) {
-        log.warn('disconnected while being open', { code: event.code, reason: event.reason });
+        log.warn('server disconnected', { code: event.code, reason: event.reason });
         this._callbacks.onRestartRequired();
         muxer.destroy();
       }
     };
-    this._ws.onerror = (event) => {
+    this._ws.onerror = (event: WebSocket.ErrorEvent) => {
       if (this.isOpen) {
         log.warn('edge connection socket error', { error: event.error, info: event.message });
         this._callbacks.onRestartRequired();
@@ -107,21 +154,29 @@ export class EdgeWsConnection extends Resource {
     /**
      * https://developer.mozilla.org/en-US/docs/Web/API/MessageEvent/data
      */
-    this._ws.onmessage = async (event) => {
+    this._ws.onmessage = async (event: WebSocket.MessageEvent) => {
       if (!this.isOpen) {
         log.verbose('message ignored on closed connection', { event: event.type });
         return;
       }
       this._lastReceivedMessageTimestamp = Date.now();
       if (event.data === '__pong__') {
+        // Calculate latency.
+        if (this._pingTimestamp) {
+          this._rtt = Date.now() - this._pingTimestamp;
+          this._pingTimestamp = undefined;
+        }
         this._rescheduleHeartbeatTimeout();
         return;
       }
       const bytes = await toUint8Array(event.data);
+      this._recordBytes(0, bytes.byteLength);
       if (!this.isOpen) {
         return;
       }
 
+      this._messagesReceived++;
+
       const message = this._ws?.protocol?.includes(EdgeWebsocketProtocol.V0)
         ? buf.fromBinary(MessageSchema, bytes)
         : muxer.receiveData(bytes);
@@ -145,7 +200,7 @@ export class EdgeWsConnection extends Resource {
       if (err instanceof Error && err.message.includes('WebSocket is closed before the connection is established.')) {
         return;
       }
-      log.warn('Error closing websocket', { err });
+      log.warn('error closing websocket', { err });
     }
   }
 
@@ -156,10 +211,12 @@ export class EdgeWsConnection extends Resource {
       async () => {
         // TODO(mykola): use RFC6455 ping/pong once implemented in the browser?
         // Cloudflare's worker responds to this `without interrupting hibernation`. https://developers.cloudflare.com/durable-objects/api/websockets/#setwebsocketautoresponse
+        this._pingTimestamp = Date.now();
         this._ws?.send('__ping__');
       },
       SIGNAL_KEEPALIVE_INTERVAL,
     );
+    this._pingTimestamp = Date.now();
     this._ws.send('__ping__');
     this._rescheduleHeartbeatTimeout();
   }
@@ -187,4 +244,60 @@ export class EdgeWsConnection extends Resource {
       SIGNAL_KEEPALIVE_TIMEOUT,
     );
   }
+
+  private _recordBytes(sent: number, received: number): void {
+    const now = Date.now();
+
+    // Find if we have a sample for the current second.
+    const currentSecond = Math.floor(now / 1000) * 1000;
+    const existingSample = this._bytesSamples.find((s) => Math.floor(s.timestamp / 1000) * 1000 === currentSecond);
+
+    if (existingSample) {
+      existingSample.sent += sent;
+      existingSample.received += received;
+    } else {
+      this._bytesSamples.push({ timestamp: now, sent, received });
+    }
+  }
+
+  private _scheduleRateCalculation(): void {
+    scheduleTaskInterval(
+      this._ctx,
+      async () => {
+        this._calculateRates();
+      },
+      this._rateUpdateInterval,
+    );
+    // Calculate initial rates.
+    this._calculateRates();
+  }
+
+  private _calculateRates(): void {
+    const now = Date.now();
+    const cutoff = now - this._rateWindow;
+
+    // Remove old samples.
+    this._bytesSamples = this._bytesSamples.filter((s) => s.timestamp > cutoff);
+
+    if (this._bytesSamples.length === 0) {
+      this._uploadRate = 0;
+      this._downloadRate = 0;
+      return;
+    }
+
+    // Calculate total bytes and time span.
+    let totalSent = 0;
+    let totalReceived = 0;
+    const oldestTimestamp = Math.min(...this._bytesSamples.map((s) => s.timestamp));
+    const timeSpan = (now - oldestTimestamp) / 1000; // Convert to seconds.
+
+    for (const sample of this._bytesSamples) {
+      totalSent += sample.sent;
+      totalReceived += sample.received;
+    }
+
+    // Calculate rates (bytes per second).
+    this._uploadRate = timeSpan > 0 ? Math.round(totalSent / timeSpan) : 0;
+    this._downloadRate = timeSpan > 0 ? Math.round(totalReceived / timeSpan) : 0;
+  }
 }

package/src/http-client.test.ts

@@ -2,8 +2,10 @@
 // Copyright 2025 DXOS.org
 //
 
-import { FetchHttpClient, HttpClient } from '@effect/platform';
-import { Effect, pipe } from 'effect';
+import * as FetchHttpClient from '@effect/platform/FetchHttpClient';
+import * as HttpClient from '@effect/platform/HttpClient';
+import * as Effect from 'effect/Effect';
+import * as Function from 'effect/Function';
 import { afterEach, beforeEach, describe, it } from 'vitest';
 
 import { invariant } from '@dxos/invariant';
@@ -23,13 +25,14 @@ describe('HttpClient', () => {
     server = undefined;
   });
 
-  // TODO(burdon): Auth headers.
+  // TODO(burdon): Auth headers/API key for admin.
   // TODO(burdon): Add request/response schema type checking.
+  // TODO(burdon): Test swarm.
   it.skipIf(process.env.CI)('should retry', async ({ expect }) => {
     invariant(server);
 
     {
-      const result = await pipe(
+      const result = await Function.pipe(
         withRetry(HttpClient.get(server.url)),
         Effect.provide(FetchHttpClient.layer),
         Effect.withSpan('EdgeHttpClient'),
@@ -39,7 +42,7 @@ describe('HttpClient', () => {
     }
 
     {
-      const result = await pipe(
+      const result = await Function.pipe(
         HttpClient.get(server.url),
         withLogging,
         withRetryConfig,

package/src/http-client.ts

@@ -2,10 +2,14 @@
 // Copyright 2025 DXOS.org
 //
 
-import { type HttpClient } from '@effect/platform';
-import { type HttpClientError } from '@effect/platform/HttpClientError';
-import { type HttpClientResponse } from '@effect/platform/HttpClientResponse';
-import { Context, Duration, Effect, Layer, Schedule } from 'effect';
+import type * as HttpClient from '@effect/platform/HttpClient';
+import type * as HttpClientError from '@effect/platform/HttpClientError';
+import type * as HttpClientResponse from '@effect/platform/HttpClientResponse';
+import * as Context from 'effect/Context';
+import * as Duration from 'effect/Duration';
+import * as Effect from 'effect/Effect';
+import * as Layer from 'effect/Layer';
+import * as Schedule from 'effect/Schedule';
 
 import { log } from '@dxos/log';
 
@@ -28,7 +32,7 @@ export class HttpConfig extends Context.Tag('HttpConfig')<HttpConfig, RetryOptio
 
 // HOC pattern.
 export const withRetry = (
-  effect: Effect.Effect<HttpClientResponse, HttpClientError, HttpClient.HttpClient>,
+  effect: Effect.Effect<HttpClientResponse.HttpClientResponse, HttpClientError.HttpClientError, HttpClient.HttpClient>,
   {
     timeout = Duration.millis(1_000),
     retryBaseDelay = Duration.millis(1_000),
@@ -48,14 +52,20 @@ export const withRetry = (
   );
 };
 
-export const withRetryConfig = (effect: Effect.Effect<HttpClientResponse, HttpClientError, HttpClient.HttpClient>) =>
+export const withRetryConfig = (
+  effect: Effect.Effect<HttpClientResponse.HttpClientResponse, HttpClientError.HttpClientError, HttpClient.HttpClient>,
+) =>
   Effect.gen(function* () {
     const config = yield* HttpConfig;
     return yield* withRetry(effect, config);
   });
 
-export const withLogging = <A extends HttpClientResponse, E, R>(effect: Effect.Effect<A, E, R>) =>
-  effect.pipe(Effect.tap((res) => log.info('response', { status: res.status })));
+export const withLogging = <A extends HttpClientResponse.HttpClientResponse, E, R>(effect: Effect.Effect<A, E, R>) =>
+  effect.pipe(
+    Effect.tap((res) => {
+      log.info('response', { status: res.status });
+    }),
+  );
 
 /**
  *

package/src/index.ts

@@ -4,11 +4,12 @@
 
 export * from '@dxos/protocols/buf/dxos/edge/messenger_pb';
 
-export * from './edge-client';
+export * from './auth';
 export * from './defs';
-export * from './protocol';
+export * from './edge-client';
 export * from './errors';
-export * from './auth';
+export * from './protocol';
 export * from './edge-http-client';
 export * from './edge-identity';
 export * from './edge-ws-muxer';
+export * from './http-client';

package/src/testing/test-utils.ts

@@ -36,11 +36,11 @@ export const createTestEdgeWsServer = async (port = DEFAULT_PORT, params?: TestE
   const closeTrigger = new Trigger();
   const sendResponseMessage = createResponseSender(() => connection!.muxer);
 
-  wsServer.on('connection', (ws) => {
+  wsServer.on('connection', (ws: WebSocket) => {
     const muxer = new WebSocketMuxer(ws);
     connection = { ws, muxer };
-    ws.on('error', (err) => log.catch(err));
-    ws.on('message', async (data) => {
+    ws.on('error', (err: Error) => log.catch(err));
+    ws.on('message', async (data: any) => {
       if (String(data) === '__ping__') {
         ws.send('__pong__');
         return;