@dxos/edge-client 0.6.9 → 0.6.10-main.48c066e

package/dist/lib/node/meta.json

@@ -1 +1 @@
-{"inputs":{"packages/core/mesh/edge-client/src/protocol.ts":{"bytes":10314,"imports":[{"path":"@dxos/invariant","kind":"import-statement","external":true},{"path":"@dxos/protocols/buf","kind":"import-statement","external":true},{"path":"@dxos/protocols/buf/dxos/edge/messenger_pb","kind":"import-statement","external":true},{"path":"@dxos/util","kind":"import-statement","external":true}],"format":"esm"},"packages/core/mesh/edge-client/src/defs.ts":{"bytes":1578,"imports":[{"path":"@bufbuild/protobuf/wkt","kind":"import-statement","external":true},{"path":"@dxos/protocols/buf/dxos/edge/messenger_pb","kind":"import-statement","external":true},{"path":"packages/core/mesh/edge-client/src/protocol.ts","kind":"import-statement","original":"./protocol"}],"format":"esm"},"packages/core/mesh/edge-client/src/client.ts":{"bytes":20675,"imports":[{"path":"isomorphic-ws","kind":"import-statement","external":true},{"path":"@dxos/async","kind":"import-statement","external":true},{"path":"@dxos/context","kind":"import-statement","external":true},{"path":"@dxos/invariant","kind":"import-statement","external":true},{"path":"@dxos/log","kind":"import-statement","external":true},{"path":"@dxos/protocols/buf","kind":"import-statement","external":true},{"path":"@dxos/protocols/buf/dxos/edge/messenger_pb","kind":"import-statement","external":true},{"path":"packages/core/mesh/edge-client/src/defs.ts","kind":"import-statement","original":"./defs"},{"path":"packages/core/mesh/edge-client/src/protocol.ts","kind":"import-statement","original":"./protocol"}],"format":"esm"},"packages/core/mesh/edge-client/src/index.ts":{"bytes":836,"imports":[{"path":"@dxos/protocols/buf/dxos/edge/messenger_pb","kind":"import-statement","external":true},{"path":"packages/core/mesh/edge-client/src/client.ts","kind":"import-statement","original":"./client"},{"path":"packages/core/mesh/edge-client/src/defs.ts","kind":"import-statement","original":"./defs"},{"path":"packages/core/mesh/edge-client/src/protocol.ts","kind":"import-statement","original":"./protocol"}],"format":"esm"}},"outputs":{"packages/core/mesh/edge-client/dist/lib/node/index.cjs.map":{"imports":[],"exports":[],"inputs":{},"bytes":14946},"packages/core/mesh/edge-client/dist/lib/node/index.cjs":{"imports":[{"path":"@dxos/protocols/buf/dxos/edge/messenger_pb","kind":"import-statement","external":true},{"path":"isomorphic-ws","kind":"import-statement","external":true},{"path":"@dxos/async","kind":"import-statement","external":true},{"path":"@dxos/context","kind":"import-statement","external":true},{"path":"@dxos/invariant","kind":"import-statement","external":true},{"path":"@dxos/log","kind":"import-statement","external":true},{"path":"@dxos/protocols/buf","kind":"import-statement","external":true},{"path":"@dxos/protocols/buf/dxos/edge/messenger_pb","kind":"import-statement","external":true},{"path":"@bufbuild/protobuf/wkt","kind":"import-statement","external":true},{"path":"@dxos/protocols/buf/dxos/edge/messenger_pb","kind":"import-statement","external":true},{"path":"@dxos/invariant","kind":"import-statement","external":true},{"path":"@dxos/protocols/buf","kind":"import-statement","external":true},{"path":"@dxos/protocols/buf/dxos/edge/messenger_pb","kind":"import-statement","external":true},{"path":"@dxos/util","kind":"import-statement","external":true}],"exports":["EdgeClient","Protocol","getTypename","protocol","toUint8Array"],"entryPoint":"packages/core/mesh/edge-client/src/index.ts","inputs":{"packages/core/mesh/edge-client/src/index.ts":{"bytesInOutput":60},"packages/core/mesh/edge-client/src/client.ts":{"bytesInOutput":5789},"packages/core/mesh/edge-client/src/defs.ts":{"bytesInOutput":285},"packages/core/mesh/edge-client/src/protocol.ts":{"bytesInOutput":2600}},"bytes":9139}}}
+{"inputs":{"packages/core/mesh/edge-client/src/protocol.ts":{"bytes":10314,"imports":[{"path":"@dxos/invariant","kind":"import-statement","external":true},{"path":"@dxos/protocols/buf","kind":"import-statement","external":true},{"path":"@dxos/protocols/buf/dxos/edge/messenger_pb","kind":"import-statement","external":true},{"path":"@dxos/util","kind":"import-statement","external":true}],"format":"esm"},"packages/core/mesh/edge-client/src/defs.ts":{"bytes":1578,"imports":[{"path":"@bufbuild/protobuf/wkt","kind":"import-statement","external":true},{"path":"@dxos/protocols/buf/dxos/edge/messenger_pb","kind":"import-statement","external":true},{"path":"packages/core/mesh/edge-client/src/protocol.ts","kind":"import-statement","original":"./protocol"}],"format":"esm"},"packages/core/mesh/edge-client/src/errors.ts":{"bytes":846,"imports":[],"format":"esm"},"packages/core/mesh/edge-client/src/persistent-lifecycle.ts":{"bytes":10868,"imports":[{"path":"@dxos/async","kind":"import-statement","external":true},{"path":"@dxos/context","kind":"import-statement","external":true},{"path":"@dxos/debug","kind":"import-statement","external":true},{"path":"@dxos/log","kind":"import-statement","external":true}],"format":"esm"},"packages/core/mesh/edge-client/src/edge-client.ts":{"bytes":26825,"imports":[{"path":"isomorphic-ws","kind":"import-statement","external":true},{"path":"@dxos/async","kind":"import-statement","external":true},{"path":"@dxos/context","kind":"import-statement","external":true},{"path":"@dxos/invariant","kind":"import-statement","external":true},{"path":"@dxos/log","kind":"import-statement","external":true},{"path":"@dxos/protocols/buf","kind":"import-statement","external":true},{"path":"@dxos/protocols/buf/dxos/edge/messenger_pb","kind":"import-statement","external":true},{"path":"packages/core/mesh/edge-client/src/defs.ts","kind":"import-statement","original":"./defs"},{"path":"packages/core/mesh/edge-client/src/errors.ts","kind":"import-statement","original":"./errors"},{"path":"packages/core/mesh/edge-client/src/persistent-lifecycle.ts","kind":"import-statement","original":"./persistent-lifecycle"},{"path":"packages/core/mesh/edge-client/src/protocol.ts","kind":"import-statement","original":"./protocol"}],"format":"esm"},"packages/core/mesh/edge-client/src/index.ts":{"bytes":849,"imports":[{"path":"@dxos/protocols/buf/dxos/edge/messenger_pb","kind":"import-statement","external":true},{"path":"packages/core/mesh/edge-client/src/edge-client.ts","kind":"import-statement","original":"./edge-client"},{"path":"packages/core/mesh/edge-client/src/defs.ts","kind":"import-statement","original":"./defs"},{"path":"packages/core/mesh/edge-client/src/protocol.ts","kind":"import-statement","original":"./protocol"}],"format":"esm"}},"outputs":{"packages/core/mesh/edge-client/dist/lib/node/index.cjs.map":{"imports":[],"exports":[],"inputs":{},"bytes":23321},"packages/core/mesh/edge-client/dist/lib/node/index.cjs":{"imports":[{"path":"@dxos/protocols/buf/dxos/edge/messenger_pb","kind":"import-statement","external":true},{"path":"isomorphic-ws","kind":"import-statement","external":true},{"path":"@dxos/async","kind":"import-statement","external":true},{"path":"@dxos/context","kind":"import-statement","external":true},{"path":"@dxos/invariant","kind":"import-statement","external":true},{"path":"@dxos/log","kind":"import-statement","external":true},{"path":"@dxos/protocols/buf","kind":"import-statement","external":true},{"path":"@dxos/protocols/buf/dxos/edge/messenger_pb","kind":"import-statement","external":true},{"path":"@bufbuild/protobuf/wkt","kind":"import-statement","external":true},{"path":"@dxos/protocols/buf/dxos/edge/messenger_pb","kind":"import-statement","external":true},{"path":"@dxos/invariant","kind":"import-statement","external":true},{"path":"@dxos/protocols/buf","kind":"import-statement","external":true},{"path":"@dxos/protocols/buf/dxos/edge/messenger_pb","kind":"import-statement","external":true},{"path":"@dxos/util","kind":"import-statement","external":true},{"path":"@dxos/async","kind":"import-statement","external":true},{"path":"@dxos/context","kind":"import-statement","external":true},{"path":"@dxos/debug","kind":"import-statement","external":true},{"path":"@dxos/log","kind":"import-statement","external":true}],"exports":["EdgeClient","Protocol","getTypename","protocol","toUint8Array"],"entryPoint":"packages/core/mesh/edge-client/src/index.ts","inputs":{"packages/core/mesh/edge-client/src/index.ts":{"bytesInOutput":60},"packages/core/mesh/edge-client/src/edge-client.ts":{"bytesInOutput":7041},"packages/core/mesh/edge-client/src/defs.ts":{"bytesInOutput":285},"packages/core/mesh/edge-client/src/protocol.ts":{"bytesInOutput":2600},"packages/core/mesh/edge-client/src/errors.ts":{"bytesInOutput":116},"packages/core/mesh/edge-client/src/persistent-lifecycle.ts":{"bytesInOutput":3041}},"bytes":13670}}}

package/dist/types/src/{client.d.ts → edge-client.d.ts}

@@ -1,16 +1,17 @@
+import { Event } from '@dxos/async';
 import { Resource, type Lifecycle } from '@dxos/context';
-import { type PublicKey } from '@dxos/keys';
 import { type Message } from '@dxos/protocols/buf/dxos/edge/messenger_pb';
 import { type Protocol } from './protocol';
 export type MessageListener = (message: Message) => void | Promise<void>;
 export interface EdgeConnection extends Required<Lifecycle> {
+    reconnect: Event;
     get info(): any;
-    get identityKey(): PublicKey;
-    get deviceKey(): PublicKey;
+    get identityKey(): string;
+    get peerKey(): string;
     get isOpen(): boolean;
     setIdentity(params: {
-        deviceKey: PublicKey;
-        identityKey: PublicKey;
+        peerKey: string;
+        identityKey: string;
     }): void;
     addListener(listener: MessageListener): () => void;
     send(message: Message): Promise<void>;
@@ -25,25 +26,28 @@ export type MessengerConfig = {
  */
 export declare class EdgeClient extends Resource implements EdgeConnection {
     private _identityKey;
-    private _deviceKey;
+    private _peerKey;
     private readonly _config;
+    reconnect: Event<void>;
+    private readonly _persistentLifecycle;
     private readonly _listeners;
-    private _reconnect?;
     private readonly _protocol;
     private _ready;
     private _ws?;
-    constructor(_identityKey: PublicKey, _deviceKey: PublicKey, _config: MessengerConfig);
+    private _keepaliveCtx?;
+    private _heartBeatContext?;
+    constructor(_identityKey: string, _peerKey: string, _config: MessengerConfig);
     get info(): {
         open: boolean;
-        identity: PublicKey;
-        device: PublicKey;
+        identity: string;
+        device: string;
     };
-    get identityKey(): PublicKey;
-    get deviceKey(): PublicKey;
+    get identityKey(): string;
+    get peerKey(): string;
     get isOpen(): boolean;
-    setIdentity({ deviceKey, identityKey }: {
-        deviceKey: PublicKey;
-        identityKey: PublicKey;
+    setIdentity({ peerKey, identityKey }: {
+        peerKey: string;
+        identityKey: string;
     }): void;
     addListener(listener: MessageListener): () => void;
     /**
@@ -61,5 +65,6 @@ export declare class EdgeClient extends Resource implements EdgeConnection {
      * NOTE: The message is guaranteed to be delivered but the service must respond with a message to confirm processing.
      */
     send(message: Message): Promise<void>;
+    private _onHeartbeat;
 }
-//# sourceMappingURL=client.d.ts.map
+//# sourceMappingURL=edge-client.d.ts.map

package/dist/types/src/edge-client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"edge-client.d.ts","sourceRoot":"","sources":["../../../src/edge-client.ts"],"names":[],"mappings":"AAMA,OAAO,EAAW,KAAK,EAAoD,MAAM,aAAa,CAAC;AAC/F,OAAO,EAA2B,QAAQ,EAAE,KAAK,SAAS,EAAE,MAAM,eAAe,CAAC;AAIlF,OAAO,EAAE,KAAK,OAAO,EAAiB,MAAM,4CAA4C,CAAC;AAKzF,OAAO,EAAE,KAAK,QAAQ,EAAgB,MAAM,YAAY,CAAC;AAKzD,MAAM,MAAM,eAAe,GAAG,CAAC,OAAO,EAAE,OAAO,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;AAEzE,MAAM,WAAW,cAAe,SAAQ,QAAQ,CAAC,SAAS,CAAC;IACzD,SAAS,EAAE,KAAK,CAAC;IAEjB,IAAI,IAAI,IAAI,GAAG,CAAC;IAChB,IAAI,WAAW,IAAI,MAAM,CAAC;IAC1B,IAAI,OAAO,IAAI,MAAM,CAAC;IACtB,IAAI,MAAM,IAAI,OAAO,CAAC;IACtB,WAAW,CAAC,MAAM,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,WAAW,EAAE,MAAM,CAAA;KAAE,GAAG,IAAI,CAAC;IACpE,WAAW,CAAC,QAAQ,EAAE,eAAe,GAAG,MAAM,IAAI,CAAC;IACnD,IAAI,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACvC;AAED,MAAM,MAAM,eAAe,GAAG;IAC5B,cAAc,EAAE,MAAM,CAAC;IACvB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACrB,CAAC;AAEF;;GAEG;AACH,qBAAa,UAAW,SAAQ,QAAS,YAAW,cAAc;IAgB9D,OAAO,CAAC,YAAY;IACpB,OAAO,CAAC,QAAQ;IAChB,OAAO,CAAC,QAAQ,CAAC,OAAO;IAjBnB,SAAS,cAAe;IAC/B,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAIlC;IAEH,OAAO,CAAC,QAAQ,CAAC,UAAU,CAA8B;IACzD,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAW;IACrC,OAAO,CAAC,MAAM,CAAiB;IAC/B,OAAO,CAAC,GAAG,CAAC,CAAwB;IACpC,OAAO,CAAC,aAAa,CAAC,CAAsB;IAC5C,OAAO,CAAC,iBAAiB,CAAC,CAAsB;gBAGtC,YAAY,EAAE,MAAM,EACpB,QAAQ,EAAE,MAAM,EACP,OAAO,EAAE,eAAe;IAO3C,IAAW,IAAI;;;;MAMd;IAED,IAAI,WAAW,WAEd;IAED,IAAI,OAAO,WAEV;IAED,IAAW,MAAM,YAEhB;IAED,WAAW,CAAC,EAAE,OAAO,EAAE,WAAW,EAAE,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,WAAW,EAAE,MAAM,CAAA;KAAE;IAMvE,WAAW,CAAC,QAAQ,EAAE,eAAe,GAAG,MAAM,IAAI;IAKzD;;OAEG;cACsB,KAAK;IAO9B;;OAEG;cACsB,MAAM;YAKjB,cAAc;YAqDd,eAAe;IA0B7B;;;OAGG;IACU,IAAI,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAUlD,OAAO,CAAC,YAAY;CAcrB"}

package/dist/types/src/edge-client.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=edge-client.test.d.ts.map

package/dist/types/src/edge-client.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"edge-client.test.d.ts","sourceRoot":"","sources":["../../../src/edge-client.test.ts"],"names":[],"mappings":""}

package/dist/types/src/errors.d.ts

@@ -0,0 +1,4 @@
+export declare class WebsocketClosedError extends Error {
+    constructor();
+}
+//# sourceMappingURL=errors.d.ts.map

package/dist/types/src/errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../../src/errors.ts"],"names":[],"mappings":"AAIA,qBAAa,oBAAqB,SAAQ,KAAK;;CAI9C"}

package/dist/types/src/index.d.ts

@@ -1,5 +1,5 @@
 export * from '@dxos/protocols/buf/dxos/edge/messenger_pb';
-export * from './client';
+export * from './edge-client';
 export * from './defs';
 export * from './protocol';
 //# sourceMappingURL=index.d.ts.map

package/dist/types/src/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/index.ts"],"names":[],"mappings":"AAIA,cAAc,4CAA4C,CAAC;AAE3D,cAAc,UAAU,CAAC;AACzB,cAAc,QAAQ,CAAC;AACvB,cAAc,YAAY,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/index.ts"],"names":[],"mappings":"AAIA,cAAc,4CAA4C,CAAC;AAE3D,cAAc,eAAe,CAAC;AAC9B,cAAc,QAAQ,CAAC;AACvB,cAAc,YAAY,CAAC"}

package/dist/types/src/persistent-lifecycle.d.ts

@@ -0,0 +1,42 @@
+import { Resource } from '@dxos/context';
+export type PersistentLifecycleParams = {
+    /**
+     * Create connection.
+     * If promise resolves successfully, connection is considered established.
+     */
+    start: () => Promise<void>;
+    /**
+     * Reset connection to initial state.
+     */
+    stop: () => Promise<void>;
+    /**
+     * Called after successful start.
+     */
+    onRestart?: () => Promise<void>;
+    /**
+     * Maximum delay between restartion attempts.
+     * Default: 5000ms
+     */
+    maxRestartDelay?: number;
+};
+/**
+ * Handles restarts (e.g. persists connection).
+ * Restarts are scheduled with exponential backoff.
+ */
+export declare class PersistentLifecycle extends Resource {
+    private readonly _start;
+    private readonly _stop;
+    private readonly _onRestart?;
+    private readonly _maxRestartDelay;
+    private _restartTask?;
+    private _restartAfter;
+    constructor({ start, stop, onRestart, maxRestartDelay }: PersistentLifecycleParams);
+    protected _open(): Promise<void>;
+    protected _close(): Promise<void>;
+    private _restart;
+    /**
+     * Scheduling restart should be done from outside.
+     */
+    scheduleRestart(): void;
+}
+//# sourceMappingURL=persistent-lifecycle.d.ts.map

package/dist/types/src/persistent-lifecycle.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"persistent-lifecycle.d.ts","sourceRoot":"","sources":["../../../src/persistent-lifecycle.ts"],"names":[],"mappings":"AAKA,OAAO,EAAqC,QAAQ,EAAE,MAAM,eAAe,CAAC;AAO5E,MAAM,MAAM,yBAAyB,GAAG;IACtC;;;OAGG;IACH,KAAK,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IAE3B;;OAEG;IACH,IAAI,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IAE1B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IAEhC;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B,CAAC;AAEF;;;GAGG;AACH,qBAAa,mBAAoB,SAAQ,QAAQ;IAC/C,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAsB;IAC7C,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAsB;IAC5C,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAsB;IAClD,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAS;IAE1C,OAAO,CAAC,YAAY,CAAC,CAA2B;IAChD,OAAO,CAAC,aAAa,CAAK;gBAEd,EAAE,KAAK,EAAE,IAAI,EAAE,SAAS,EAAE,eAA2C,EAAE,EAAE,yBAAyB;cASrF,KAAK;cAeL,MAAM;YAMjB,QAAQ;IAgBtB;;OAEG;IAEH,eAAe;CAMhB"}

package/dist/types/src/persistent-lifecycle.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=persistent-lifecycle.test.d.ts.map

package/dist/types/src/persistent-lifecycle.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"persistent-lifecycle.test.d.ts","sourceRoot":"","sources":["../../../src/persistent-lifecycle.test.ts"],"names":[],"mappings":""}

package/dist/types/src/test-utils.d.ts

@@ -0,0 +1,11 @@
+import WebSocket from 'isomorphic-ws';
+export declare const DEFAULT_PORT = 8080;
+export declare const createTestWsServer: (port?: number) => Promise<{
+    server: WebSocket.Server;
+    /**
+     * Close the server connection.
+     */
+    error: () => Promise<void>;
+    endpoint: string;
+}>;
+//# sourceMappingURL=test-utils.d.ts.map

package/dist/types/src/test-utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"test-utils.d.ts","sourceRoot":"","sources":["../../../src/test-utils.ts"],"names":[],"mappings":"AAIA,OAAO,SAAS,MAAM,eAAe,CAAC;AAWtC,eAAO,MAAM,YAAY,OAAO,CAAC;AAEjC,eAAO,MAAM,kBAAkB;;IAsB3B;;OAEG;;;EAON,CAAC"}

package/dist/types/src/websocket.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=websocket.test.d.ts.map

package/dist/types/src/websocket.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"websocket.test.d.ts","sourceRoot":"","sources":["../../../src/websocket.test.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dxos/edge-client",
-  "version": "0.6.9",
+  "version": "0.6.10-main.48c066e",
   "description": "EDGE Client",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
@@ -28,15 +28,19 @@
     "@bufbuild/protobuf": "^2.0.0",
     "isomorphic-ws": "^5.0.0",
     "ws": "^8.14.2",
-    "@dxos/async": "0.6.9",
-    "@dxos/context": "0.6.9",
-    "@dxos/invariant": "0.6.9",
-    "@dxos/node-std": "0.6.9",
-    "@dxos/log": "0.6.9",
-    "@dxos/protocols": "0.6.9",
-    "@dxos/util": "0.6.9"
+    "@dxos/async": "0.6.10-main.48c066e",
+    "@dxos/context": "0.6.10-main.48c066e",
+    "@dxos/debug": "0.6.10-main.48c066e",
+    "@dxos/invariant": "0.6.10-main.48c066e",
+    "@dxos/log": "0.6.10-main.48c066e",
+    "@dxos/protocols": "0.6.10-main.48c066e",
+    "@dxos/util": "0.6.10-main.48c066e",
+    "@dxos/node-std": "0.6.10-main.48c066e"
+  },
+  "devDependencies": {
+    "jest-websocket-mock": "^2.5.0",
+    "@dxos/keys": "0.6.10-main.48c066e"
   },
-  "devDependencies": {},
   "publishConfig": {
     "access": "public"
   }

package/src/edge-client.test.ts

@@ -0,0 +1,50 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import chai, { expect } from 'chai';
+import chaiAsPromised from 'chai-as-promised';
+
+import { PublicKey } from '@dxos/keys';
+import { TextMessageSchema } from '@dxos/protocols/buf/dxos/edge/messenger_pb';
+import { test, describe, openAndClose } from '@dxos/test';
+
+import { protocol } from './defs';
+import { EdgeClient } from './edge-client';
+import { createTestWsServer } from './test-utils';
+
+chai.use(chaiAsPromised);
+
+describe('EdgeClient', () => {
+  const textMessage = (message: string) => protocol.createMessage(TextMessageSchema, { payload: { message } });
+
+  test('reconnects on error', async () => {
+    const { error: serverError, endpoint } = await createTestWsServer();
+    const id = PublicKey.random().toHex();
+    const client = new EdgeClient(id, id, { socketEndpoint: endpoint });
+    await openAndClose(client);
+    await client.send(textMessage('Hello world 1'));
+    expect(client.isOpen).is.true;
+
+    const reconnected = client.reconnect.waitForCount(1);
+    await serverError();
+    await reconnected;
+    await expect(client.send(textMessage('Hello world 2'))).to.be.fulfilled;
+  });
+
+  test('set identity reconnects', async () => {
+    const { endpoint } = await createTestWsServer();
+
+    const id = PublicKey.random().toHex();
+    const client = new EdgeClient(id, id, { socketEndpoint: endpoint });
+    await openAndClose(client);
+    await client.send(textMessage('Hello world 1'));
+    expect(client.isOpen).is.true;
+
+    const newId = PublicKey.random().toHex();
+    const reconnected = client.reconnect.waitForCount(1);
+    client.setIdentity({ peerKey: newId, identityKey: newId });
+    await reconnected;
+    await expect(client.send(textMessage('Hello world 2'))).to.be.fulfilled;
+  });
+});

package/src/edge-client.ts

@@ -0,0 +1,226 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import WebSocket from 'isomorphic-ws';
+
+import { Trigger, Event, scheduleTaskInterval, scheduleTask, TriggerState } from '@dxos/async';
+import { Context, LifecycleState, Resource, type Lifecycle } from '@dxos/context';
+import { invariant } from '@dxos/invariant';
+import { log } from '@dxos/log';
+import { buf } from '@dxos/protocols/buf';
+import { type Message, MessageSchema } from '@dxos/protocols/buf/dxos/edge/messenger_pb';
+
+import { protocol } from './defs';
+import { WebsocketClosedError } from './errors';
+import { PersistentLifecycle } from './persistent-lifecycle';
+import { type Protocol, toUint8Array } from './protocol';
+
+const DEFAULT_TIMEOUT = 10_000;
+const SIGNAL_KEEPALIVE_INTERVAL = 5_000;
+
+export type MessageListener = (message: Message) => void | Promise<void>;
+
+export interface EdgeConnection extends Required<Lifecycle> {
+  reconnect: Event;
+
+  get info(): any;
+  get identityKey(): string;
+  get peerKey(): string;
+  get isOpen(): boolean;
+  setIdentity(params: { peerKey: string; identityKey: string }): void;
+  addListener(listener: MessageListener): () => void;
+  send(message: Message): Promise<void>;
+}
+
+export type MessengerConfig = {
+  socketEndpoint: string;
+  timeout?: number;
+  protocol?: Protocol;
+};
+
+/**
+ * Messenger client.
+ */
+export class EdgeClient extends Resource implements EdgeConnection {
+  public reconnect = new Event();
+  private readonly _persistentLifecycle = new PersistentLifecycle({
+    start: async () => this._openWebSocket(),
+    stop: async () => this._closeWebSocket(),
+    onRestart: async () => this.reconnect.emit(),
+  });
+
+  private readonly _listeners = new Set<MessageListener>();
+  private readonly _protocol: Protocol;
+  private _ready = new Trigger();
+  private _ws?: WebSocket = undefined;
+  private _keepaliveCtx?: Context = undefined;
+  private _heartBeatContext?: Context = undefined;
+
+  constructor(
+    private _identityKey: string,
+    private _peerKey: string,
+    private readonly _config: MessengerConfig,
+  ) {
+    super();
+    this._protocol = this._config.protocol ?? protocol;
+  }
+
+  // TODO(burdon): Attach logging.
+  public get info() {
+    return {
+      open: this.isOpen,
+      identity: this._identityKey,
+      device: this._peerKey,
+    };
+  }
+
+  get identityKey() {
+    return this._identityKey;
+  }
+
+  get peerKey() {
+    return this._peerKey;
+  }
+
+  public get isOpen() {
+    return this._lifecycleState === LifecycleState.OPEN;
+  }
+
+  setIdentity({ peerKey, identityKey }: { peerKey: string; identityKey: string }) {
+    this._peerKey = peerKey;
+    this._identityKey = identityKey;
+    this._persistentLifecycle.scheduleRestart();
+  }
+
+  public addListener(listener: MessageListener): () => void {
+    this._listeners.add(listener);
+    return () => this._listeners.delete(listener);
+  }
+
+  /**
+   * Open connection to messaging service.
+   */
+  protected override async _open() {
+    log('opening...', { info: this.info });
+    this._persistentLifecycle.open().catch((err) => {
+      log.warn('Error while opening connection', { err });
+    });
+  }
+
+  /**
+   * Close connection and free resources.
+   */
+  protected override async _close() {
+    log('closing...', { peerKey: this._peerKey });
+    await this._persistentLifecycle.close();
+  }
+
+  private async _openWebSocket() {
+    const url = new URL(`/ws/${this._identityKey}/${this._peerKey}`, this._config.socketEndpoint);
+    this._ws = new WebSocket(url);
+
+    this._ws.onopen = () => {
+      log('opened', this.info);
+      this._ready.wake();
+    };
+    this._ws.onclose = () => {
+      log('closed', this.info);
+      this._persistentLifecycle.scheduleRestart();
+    };
+    this._ws.onerror = (event) => {
+      log.warn('EdgeClient socket error', { error: event.error, info: event.message });
+      this._persistentLifecycle.scheduleRestart();
+    };
+    /**
+     * https://developer.mozilla.org/en-US/docs/Web/API/MessageEvent/data
+     */
+    this._ws.onmessage = async (event) => {
+      if (event.data === '__pong__') {
+        this._onHeartbeat();
+        return;
+      }
+      const data = await toUint8Array(event.data);
+      const message = buf.fromBinary(MessageSchema, data);
+      log('received', { peerKey: this._peerKey, payload: protocol.getPayloadType(message) });
+      if (message) {
+        for (const listener of this._listeners) {
+          try {
+            await listener(message);
+          } catch (err) {
+            log.error('processing', { err, payload: protocol.getPayloadType(message) });
+          }
+        }
+      }
+    };
+
+    await this._ready.wait({ timeout: this._config.timeout ?? DEFAULT_TIMEOUT });
+    this._keepaliveCtx = new Context();
+    scheduleTaskInterval(
+      this._keepaliveCtx,
+      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._ws?.send('__ping__');
+      },
+      SIGNAL_KEEPALIVE_INTERVAL,
+    );
+    this._ws.send('__ping__');
+    this._onHeartbeat();
+  }
+
+  private async _closeWebSocket() {
+    if (!this._ws) {
+      return;
+    }
+    try {
+      this._ready.throw(new WebsocketClosedError());
+      this._ready.reset();
+      void this._keepaliveCtx?.dispose();
+      this._keepaliveCtx = undefined;
+      void this._heartBeatContext?.dispose();
+      this._heartBeatContext = undefined;
+
+      // NOTE: Remove event handlers to avoid scheduling restart.
+      this._ws.onopen = () => {};
+      this._ws.onclose = () => {};
+      this._ws.onerror = () => {};
+      this._ws.close();
+      this._ws = undefined;
+    } catch (err) {
+      if (err instanceof Error && err.message.includes('WebSocket is closed before the connection is established.')) {
+        return;
+      }
+      log.warn('Error closing websocket', { err });
+    }
+  }
+
+  /**
+   * 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) {
+      await this._ready.wait({ timeout: this._config.timeout ?? DEFAULT_TIMEOUT });
+    }
+    invariant(this._ws);
+    invariant(!message.source || message.source.peerKey === this._peerKey);
+    log('sending...', { peerKey: this._peerKey, payload: protocol.getPayloadType(message) });
+    this._ws.send(buf.toBinary(MessageSchema, message));
+  }
+
+  private _onHeartbeat() {
+    if (this._lifecycleState !== LifecycleState.OPEN) {
+      return;
+    }
+    void this._heartBeatContext?.dispose();
+    this._heartBeatContext = new Context();
+    scheduleTask(
+      this._heartBeatContext,
+      () => {
+        this._persistentLifecycle.scheduleRestart();
+      },
+      2 * SIGNAL_KEEPALIVE_INTERVAL,
+    );
+  }
+}

package/src/errors.ts

@@ -0,0 +1,9 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+export class WebsocketClosedError extends Error {
+  constructor() {
+    super('WebSocket connection closed');
+  }
+}

package/src/index.ts

@@ -4,6 +4,6 @@
 
 export * from '@dxos/protocols/buf/dxos/edge/messenger_pb';
 
-export * from './client';
+export * from './edge-client';
 export * from './defs';
 export * from './protocol';

package/src/persistent-lifecycle.test.ts

@@ -0,0 +1,71 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import { expect } from 'chai';
+
+import { sleep, Trigger } from '@dxos/async';
+import { log } from '@dxos/log';
+import { describe, openAndClose, test } from '@dxos/test';
+
+import { PersistentLifecycle } from './persistent-lifecycle';
+
+describe('ConnectionState', () => {
+  test('first reconnect fires immediately', async () => {
+    const triggerCall = new Trigger<number>();
+    const persistentLifecycle = new PersistentLifecycle({
+      start: async () => {
+        triggerCall.wake(Date.now());
+      },
+      stop: async () => {},
+    });
+    await openAndClose(persistentLifecycle);
+
+    const triggerTimestamp = Date.now();
+    persistentLifecycle.scheduleRestart();
+    const timeToTrigger = (await triggerCall.wait({ timeout: 1000 })) - triggerTimestamp;
+    expect(timeToTrigger).to.be.lessThan(50);
+  });
+
+  test('second reconnect fires after 100ms', async () => {
+    let called = 0;
+    const triggerCall = new Trigger<number>();
+
+    const persistentLifecycle = new PersistentLifecycle({
+      start: async () => {
+        called += 1;
+        log.info('called', { called });
+        if (called < 3) {
+          throw new Error('TEST ERROR');
+        }
+        triggerCall.wake(Date.now());
+      },
+      stop: async () => {},
+    });
+
+    await openAndClose(persistentLifecycle);
+
+    const triggerTimestamp = Date.now();
+    await sleep(10);
+    const timeToTrigger = (await triggerCall.wait({ timeout: 1000 })) - triggerTimestamp;
+    expect(timeToTrigger).to.be.greaterThanOrEqual(100);
+  });
+
+  test('finish `restart` before close', async () => {
+    let restarted = false;
+    const persistentLifecycle = new PersistentLifecycle({
+      start: async () => await sleep(100),
+      stop: async () => {},
+      onRestart: async () => {
+        restarted = true;
+      },
+    });
+
+    await persistentLifecycle.open();
+
+    persistentLifecycle.scheduleRestart();
+    await sleep(10);
+    await persistentLifecycle.close();
+    expect(restarted).to.be.true;
+  });
+});