@automerge/automerge-repo-network-websocket 1.0.0-alpha.3 → 1.0.0-alpha.5

package/dist/BrowserWebSocketClientAdapter.d.ts

@@ -6,12 +6,13 @@ declare abstract class WebSocketNetworkAdapter extends NetworkAdapter {
     socket?: WebSocket;
 }
 export declare class BrowserWebSocketClientAdapter extends WebSocketNetworkAdapter {
+    #private;
     timerId?: ReturnType<typeof setTimeout>;
     url: string;
     constructor(url: string);
     connect(peerId: PeerId): void;
     join(): void;
-    leave(): void;
+    disconnect(): void;
     send(message: FromClientMessage): void;
     announceConnection(peerId: PeerId): void;
     receiveMessage(message: Uint8Array): void;

package/dist/BrowserWebSocketClientAdapter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"BrowserWebSocketClientAdapter.d.ts","sourceRoot":"","sources":["../src/BrowserWebSocketClientAdapter.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,EAAE,MAAM,2BAA2B,CAAA;AAElE,OAAO,SAAS,MAAM,eAAe,CAAA;AAIrC,OAAO,EACL,iBAAiB,EAGlB,MAAM,eAAe,CAAA;AAMtB,uBAAe,uBAAwB,SAAQ,cAAc;IAC3D,MAAM,CAAC,EAAE,SAAS,CAAA;CACnB;AAED,qBAAa,6BAA8B,SAAQ,uBAAuB;IAGxE,OAAO,CAAC,EAAE,UAAU,CAAC,OAAO,UAAU,CAAC,CAAA;IAEvC,GAAG,EAAE,MAAM,CAAA;gBAEC,GAAG,EAAE,MAAM;IAKvB,OAAO,CAAC,MAAM,EAAE,MAAM;IA8BtB,IAAI;IAoBJ,KAAK;IAOL,IAAI,CAAC,OAAO,EAAE,iBAAiB;IAwB/B,kBAAkB,CAAC,MAAM,EAAE,MAAM;IAUjC,cAAc,CAAC,OAAO,EAAE,UAAU;CA6BnC"}
+{"version":3,"file":"BrowserWebSocketClientAdapter.d.ts","sourceRoot":"","sources":["../src/BrowserWebSocketClientAdapter.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,EAAQ,MAAM,2BAA2B,CAAA;AACxE,OAAO,SAAS,MAAM,eAAe,CAAA;AAIrC,OAAO,EACL,iBAAiB,EAGlB,MAAM,eAAe,CAAA;AAMtB,uBAAe,uBAAwB,SAAQ,cAAc;IAC3D,MAAM,CAAC,EAAE,SAAS,CAAA;CACnB;AAED,qBAAa,6BAA8B,SAAQ,uBAAuB;;IAGxE,OAAO,CAAC,EAAE,UAAU,CAAC,OAAO,UAAU,CAAC,CAAA;IAGvC,GAAG,EAAE,MAAM,CAAA;gBAEC,GAAG,EAAE,MAAM;IAKvB,OAAO,CAAC,MAAM,EAAE,MAAM;IA0CtB,IAAI;IAoBJ,UAAU;IAOV,IAAI,CAAC,OAAO,EAAE,iBAAiB;IAwB/B,kBAAkB,CAAC,MAAM,EAAE,MAAM;IAajC,cAAc,CAAC,OAAO,EAAE,UAAU;CA6BnC"}

package/dist/BrowserWebSocketClientAdapter.js

@@ -1,5 +1,4 @@
-import { NetworkAdapter } from "@automerge/automerge-repo";
-import * as CBOR from "cbor-x";
+import { NetworkAdapter, cbor } from "@automerge/automerge-repo";
 import WebSocket from "isomorphic-ws";
 import debug from "debug";
 import { ProtocolV1 } from "./protocolVersion.js";
@@ -12,6 +11,7 @@ export class BrowserWebSocketClientAdapter extends WebSocketNetworkAdapter {
     // Type trickery required for platform independence,
     // see https://stackoverflow.com/questions/45802988/typescript-use-correct-version-of-settimeout-node-vs-window
     timerId;
+    #startupComplete = false;
     url;
     constructor(url) {
         super();
@@ -39,6 +39,16 @@ export class BrowserWebSocketClientAdapter extends WebSocketNetworkAdapter {
             // log("Disconnected from server")
         });
         this.socket.addEventListener("message", (event) => this.receiveMessage(event.data));
+        // mark this adapter as ready if we haven't received an ack in 1 second.
+        // We might hear back from the other end at some point but we shouldn't
+        // hold up marking things as unavailable for any longer
+        setTimeout(() => {
+            if (!this.#startupComplete) {
+                this.#startupComplete = true;
+                this.emit("ready", { network: this });
+            }
+        }, 1000);
+        this.join();
     }
     join() {
         if (!this.socket) {
@@ -56,7 +66,7 @@ export class BrowserWebSocketClientAdapter extends WebSocketNetworkAdapter {
             }, { once: true });
         }
     }
-    leave() {
+    disconnect() {
         if (!this.socket) {
             throw new Error("WTF, get a socket");
         }
@@ -72,7 +82,7 @@ export class BrowserWebSocketClientAdapter extends WebSocketNetworkAdapter {
         if (!this.socket || this.socket.readyState !== WebSocket.OPEN) {
             throw new Error("Websocket Socket not ready!");
         }
-        const encoded = CBOR.encode(message);
+        const encoded = cbor.encode(message);
         // This incantation deals with websocket sending the whole
         // underlying buffer even if we just have a uint8array view on it
         const arrayBuf = encoded.buffer.slice(encoded.byteOffset, encoded.byteOffset + encoded.byteLength);
@@ -84,10 +94,14 @@ export class BrowserWebSocketClientAdapter extends WebSocketNetworkAdapter {
         if (!myPeerId) {
             throw new Error("we should have a peer ID by now");
         }
+        if (!this.#startupComplete) {
+            this.#startupComplete = true;
+            this.emit("ready", { network: this });
+        }
         this.emit("peer-candidate", { peerId });
     }
     receiveMessage(message) {
-        const decoded = CBOR.decode(new Uint8Array(message));
+        const decoded = cbor.decode(new Uint8Array(message));
         const { type, senderId } = decoded;
         const socket = this.socket;
         if (!socket) {

package/dist/NodeWSServerAdapter.d.ts

@@ -9,8 +9,7 @@ export declare class NodeWSServerAdapter extends NetworkAdapter {
     };
     constructor(server: WebSocketServer);
     connect(peerId: PeerId): void;
-    join(): void;
-    leave(): void;
+    disconnect(): void;
     send(message: FromServerMessage): void;
     receiveMessage(message: Uint8Array, socket: WebSocket): void;
 }

package/dist/NodeWSServerAdapter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"NodeWSServerAdapter.d.ts","sourceRoot":"","sources":["../src/NodeWSServerAdapter.ts"],"names":[],"mappings":";AACA,OAAO,EAAE,SAAS,EAAE,KAAK,eAAe,EAAE,MAAM,eAAe,CAAA;AAM/D,OAAO,EACL,cAAc,EAEd,KAAK,MAAM,EACZ,MAAM,2BAA2B,CAAA;AAClC,OAAO,EAAqB,iBAAiB,EAAE,MAAM,eAAe,CAAA;AAEpE,qBAAa,mBAAoB,SAAQ,cAAc;IACrD,MAAM,EAAE,eAAe,CAAA;IACvB,OAAO,EAAE;QAAE,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAA;KAAE,CAAK;gBAEjC,MAAM,EAAE,eAAe;IAKnC,OAAO,CAAC,MAAM,EAAE,MAAM;IAmBtB,IAAI;IAIJ,KAAK;IAIL,IAAI,CAAC,OAAO,EAAE,iBAAiB;IAyB/B,cAAc,CAAC,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,SAAS;CAuDtD"}
+{"version":3,"file":"NodeWSServerAdapter.d.ts","sourceRoot":"","sources":["../src/NodeWSServerAdapter.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,SAAS,EAAE,KAAK,eAAe,EAAE,MAAM,eAAe,CAAA;AAK/D,OAAO,EAEL,cAAc,EACd,KAAK,MAAM,EACZ,MAAM,2BAA2B,CAAA;AAClC,OAAO,EAAqB,iBAAiB,EAAE,MAAM,eAAe,CAAA;AAKpE,qBAAa,mBAAoB,SAAQ,cAAc;IACrD,MAAM,EAAE,eAAe,CAAA;IACvB,OAAO,EAAE;QAAE,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAA;KAAE,CAAK;gBAEjC,MAAM,EAAE,eAAe;IAKnC,OAAO,CAAC,MAAM,EAAE,MAAM;IAoBtB,UAAU;IAIV,IAAI,CAAC,OAAO,EAAE,iBAAiB;IAyB/B,cAAc,CAAC,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,SAAS;CAuDtD"}

package/dist/NodeWSServerAdapter.js

@@ -1,8 +1,8 @@
-import * as CBOR from "cbor-x";
 import debug from "debug";
 const log = debug("WebsocketServer");
+import { cbor as cborHelpers, NetworkAdapter, } from "@automerge/automerge-repo";
 import { ProtocolV1 } from "./protocolVersion.js";
-import { NetworkAdapter, } from "@automerge/automerge-repo";
+const { encode, decode } = cborHelpers;
 export class NodeWSServerAdapter extends NetworkAdapter {
     server;
     sockets = {};
@@ -23,12 +23,10 @@ export class NodeWSServerAdapter extends NetworkAdapter {
                 }
             });
             socket.on("message", message => this.receiveMessage(message, socket));
+            this.emit("ready", { network: this });
         });
     }
-    join() {
-        // throw new Error("The server doesn't join channels.")
-    }
-    leave() {
+    disconnect() {
         // throw new Error("The server doesn't join channels.")
     }
     send(message) {
@@ -43,14 +41,14 @@ export class NodeWSServerAdapter extends NetworkAdapter {
             log(`Tried to send message to disconnected peer: ${message.targetId}`);
             return;
         }
-        const encoded = CBOR.encode(message);
+        const encoded = encode(message);
         // This incantation deals with websocket sending the whole
         // underlying buffer even if we just have a uint8array view on it
         const arrayBuf = encoded.buffer.slice(encoded.byteOffset, encoded.byteOffset + encoded.byteLength);
         this.sockets[message.targetId]?.send(arrayBuf);
     }
     receiveMessage(message, socket) {
-        const cbor = CBOR.decode(message);
+        const cbor = decode(message);
         const { type, senderId } = cbor;
         const myPeerId = this.peerId;
         if (!myPeerId) {

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@automerge/automerge-repo-network-websocket",
-  "version": "1.0.0-alpha.3",
+  "version": "1.0.0-alpha.5",
   "description": "isomorphic node/browser Websocket network adapter for Automerge Repo",
   "peerDependencies": {
-    "@automerge/automerge": "^2.1.0-alpha.10"
+    "@automerge/automerge": "^2.1.0-alpha.13"
   },
   "repository": "https://github.com/automerge/automerge-repo",
   "author": "Peter van Hardenberg <pvh@pvh.ca>",
@@ -17,7 +17,7 @@
     "test": "mocha --no-warnings --experimental-specifier-resolution=node --exit"
   },
   "dependencies": {
-    "@automerge/automerge-repo": "^1.0.0-alpha.3",
+    "@automerge/automerge-repo": "^1.0.0-alpha.5",
     "cbor-x": "^1.3.0",
     "eventemitter3": "^4.0.7",
     "isomorphic-ws": "^5.0.0",
@@ -34,5 +34,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "0ed108273084319aeea64ceccb49c3d58709f107"
+  "gitHead": "9cd9be160ebda37c8f0d70f2d5cadea5b951a3c3"
 }

package/src/BrowserWebSocketClientAdapter.ts

@@ -1,5 +1,4 @@
-import { NetworkAdapter, PeerId } from "@automerge/automerge-repo"
-import * as CBOR from "cbor-x"
+import { NetworkAdapter, PeerId, cbor } from "@automerge/automerge-repo"
 import WebSocket from "isomorphic-ws"
 
 import debug from "debug"
@@ -22,6 +21,7 @@ export class BrowserWebSocketClientAdapter extends WebSocketNetworkAdapter {
   // Type trickery required for platform independence,
   // see https://stackoverflow.com/questions/45802988/typescript-use-correct-version-of-settimeout-node-vs-window
   timerId?: ReturnType<typeof setTimeout>
+  #startupComplete: boolean = false
 
   url: string
 
@@ -58,6 +58,18 @@ export class BrowserWebSocketClientAdapter extends WebSocketNetworkAdapter {
     this.socket.addEventListener("message", (event: WebSocket.MessageEvent) =>
       this.receiveMessage(event.data as Uint8Array)
     )
+
+    // mark this adapter as ready if we haven't received an ack in 1 second.
+    // We might hear back from the other end at some point but we shouldn't
+    // hold up marking things as unavailable for any longer
+    setTimeout(() => {
+      if (!this.#startupComplete) {
+        this.#startupComplete = true
+        this.emit("ready", { network: this })
+      }
+    }, 1000)
+
+    this.join()
   }
 
   join() {
@@ -80,7 +92,7 @@ export class BrowserWebSocketClientAdapter extends WebSocketNetworkAdapter {
     }
   }
 
-  leave() {
+  disconnect() {
     if (!this.socket) {
       throw new Error("WTF, get a socket")
     }
@@ -100,7 +112,7 @@ export class BrowserWebSocketClientAdapter extends WebSocketNetworkAdapter {
       throw new Error("Websocket Socket not ready!")
     }
 
-    const encoded = CBOR.encode(message)
+    const encoded = cbor.encode(message)
     // This incantation deals with websocket sending the whole
     // underlying buffer even if we just have a uint8array view on it
     const arrayBuf = encoded.buffer.slice(
@@ -117,12 +129,15 @@ export class BrowserWebSocketClientAdapter extends WebSocketNetworkAdapter {
     if (!myPeerId) {
       throw new Error("we should have a peer ID by now")
     }
-
+    if (!this.#startupComplete) {
+      this.#startupComplete = true
+      this.emit("ready", { network: this })
+    }
     this.emit("peer-candidate", { peerId })
   }
 
   receiveMessage(message: Uint8Array) {
-    const decoded: FromServerMessage = CBOR.decode(new Uint8Array(message))
+    const decoded: FromServerMessage = cbor.decode(new Uint8Array(message))
 
     const { type, senderId } = decoded
 

package/src/NodeWSServerAdapter.ts

@@ -1,16 +1,17 @@
-import * as CBOR from "cbor-x"
 import { WebSocket, type WebSocketServer } from "isomorphic-ws"
 
 import debug from "debug"
 const log = debug("WebsocketServer")
 
-import { ProtocolV1, ProtocolVersion } from "./protocolVersion.js"
 import {
+  cbor as cborHelpers,
   NetworkAdapter,
-  type NetworkAdapterMessage,
   type PeerId,
 } from "@automerge/automerge-repo"
 import { FromClientMessage, FromServerMessage } from "./messages.js"
+import { ProtocolV1, ProtocolVersion } from "./protocolVersion.js"
+
+const { encode, decode } = cborHelpers
 
 export class NodeWSServerAdapter extends NetworkAdapter {
   server: WebSocketServer
@@ -37,14 +38,11 @@ export class NodeWSServerAdapter extends NetworkAdapter {
       socket.on("message", message =>
         this.receiveMessage(message as Uint8Array, socket)
       )
+      this.emit("ready", { network: this })
     })
   }
 
-  join() {
-    // throw new Error("The server doesn't join channels.")
-  }
-
-  leave() {
+  disconnect() {
     // throw new Error("The server doesn't join channels.")
   }
 
@@ -62,7 +60,7 @@ export class NodeWSServerAdapter extends NetworkAdapter {
       return
     }
 
-    const encoded = CBOR.encode(message)
+    const encoded = encode(message)
     // This incantation deals with websocket sending the whole
     // underlying buffer even if we just have a uint8array view on it
     const arrayBuf = encoded.buffer.slice(
@@ -74,7 +72,7 @@ export class NodeWSServerAdapter extends NetworkAdapter {
   }
 
   receiveMessage(message: Uint8Array, socket: WebSocket) {
-    const cbor: FromClientMessage = CBOR.decode(message)
+    const cbor: FromClientMessage = decode(message)
 
     const { type, senderId } = cbor
 

package/test/Websocket.test.ts

@@ -1,7 +1,7 @@
-import { runAdapterTests } from "../../automerge-repo/src/helpers/tests/network-adapter-tests"
-import { BrowserWebSocketClientAdapter } from "../src/BrowserWebSocketClientAdapter"
-import { NodeWSServerAdapter } from "../src/NodeWSServerAdapter"
-import { startServer } from "./utilities/WebSockets"
+import { runAdapterTests } from "../../automerge-repo/src/helpers/tests/network-adapter-tests.js"
+import { BrowserWebSocketClientAdapter } from "../src/BrowserWebSocketClientAdapter.js"
+import { NodeWSServerAdapter } from "../src/NodeWSServerAdapter.js"
+import { startServer } from "./utilities/WebSockets.js"
 import * as CBOR from "cbor-x"
 import WebSocket, { AddressInfo } from "ws"
 import { assert } from "chai"

package/test/utilities/WebSockets.ts

@@ -1,5 +1,5 @@
 import http from "http"
-import { createWebSocketServer } from "./CreateWebSocketServer"
+import { createWebSocketServer } from "./CreateWebSocketServer.js"
 import WebSocket from "ws"
 
 function startServer(port: number) {

package/tsconfig.json

@@ -2,8 +2,8 @@
   "compilerOptions": {
     "target": "ESNext",
     "jsx": "react",
-    "module": "ESNext",
-    "moduleResolution": "node",
+    "module": "NodeNext",
+    "moduleResolution": "Node16",
     "declaration": true,
     "declarationMap": true,
     "outDir": "./dist",