@automerge/automerge-repo-network-websocket 1.0.0-alpha.2 → 1.0.0-alpha.4

package/dist/BrowserWebSocketClientAdapter.d.ts

@@ -1,17 +1,19 @@
 /// <reference types="ws" />
-import { ChannelId, NetworkAdapter, PeerId } from "@automerge/automerge-repo";
+import { NetworkAdapter, PeerId } from "@automerge/automerge-repo";
 import WebSocket from "isomorphic-ws";
+import { FromClientMessage } from "./messages.js";
 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;
-    sendMessage(targetId: PeerId, channelId: ChannelId, message: Uint8Array, broadcast: boolean): 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,EACL,SAAS,EAET,cAAc,EACd,MAAM,EACP,MAAM,2BAA2B,CAAA;AAElC,OAAO,SAAS,MAAM,eAAe,CAAA;AAOrC,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;IACvC,GAAG,EAAE,MAAM,CAAA;gBAEC,GAAG,EAAE,MAAM;IAKvB,OAAO,CAAC,MAAM,EAAE,MAAM;IA8BtB,IAAI;IAwBJ,KAAK;IAOL,WAAW,CACT,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,SAAS,EACpB,OAAO,EAAE,UAAU,EACnB,SAAS,EAAE,OAAO;IAgCpB,kBAAkB,CAAC,MAAM,EAAE,MAAM;IAUjC,cAAc,CAAC,OAAO,EAAE,UAAU;CAsCnC"}
+{"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;IAwCtB,IAAI;IAoBJ,KAAK;IAOL,IAAI,CAAC,OAAO,EAAE,iBAAiB;IAwB/B,kBAAkB,CAAC,MAAM,EAAE,MAAM;IAajC,cAAc,CAAC,OAAO,EAAE,UAAU;CA6BnC"}

package/dist/BrowserWebSocketClientAdapter.js

@@ -1,16 +1,17 @@
-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";
+import { isValidMessage } from "@automerge/automerge-repo/dist/network/messages.js";
 const log = debug("WebsocketClient");
 class WebSocketNetworkAdapter extends NetworkAdapter {
     socket;
 }
 export class BrowserWebSocketClientAdapter extends WebSocketNetworkAdapter {
-    // Type trickery required for platform independence, 
+    // 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();
@@ -38,20 +39,29 @@ 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);
     }
     join() {
         if (!this.socket) {
             throw new Error("WTF, get a socket");
         }
         if (this.socket.readyState === WebSocket.OPEN) {
-            this.socket.send(CBOR.encode(joinMessage(this.peerId)));
+            this.send(joinMessage(this.peerId));
         }
         else {
             this.socket.addEventListener("open", () => {
                 if (!this.socket) {
                     throw new Error("WTF, get a socket");
                 }
-                this.socket.send(CBOR.encode(joinMessage(this.peerId)));
+                this.send(joinMessage(this.peerId));
             }, { once: true });
         }
     }
@@ -59,31 +69,23 @@ export class BrowserWebSocketClientAdapter extends WebSocketNetworkAdapter {
         if (!this.socket) {
             throw new Error("WTF, get a socket");
         }
-        this.socket.send(CBOR.encode({ type: "leave", senderId: this.peerId }));
+        this.send({ type: "leave", senderId: this.peerId });
     }
-    sendMessage(targetId, channelId, message, broadcast) {
-        if (message.byteLength === 0) {
+    send(message) {
+        if ("data" in message && message.data.byteLength === 0) {
             throw new Error("tried to send a zero-length message");
         }
         if (!this.peerId) {
             throw new Error("Why don't we have a PeerID?");
         }
-        const decoded = {
-            senderId: this.peerId,
-            targetId,
-            channelId,
-            type: "sync",
-            message,
-            broadcast,
-        };
-        const encoded = CBOR.encode(decoded);
-        // 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);
         if (!this.socket || this.socket.readyState !== WebSocket.OPEN) {
             throw new Error("Websocket Socket not ready!");
         }
-        this.socket.send(arrayBuf);
+        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);
+        this.socket?.send(arrayBuf);
     }
     announceConnection(peerId) {
         // return a peer object
@@ -91,11 +93,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) {
-        const decoded = CBOR.decode(new Uint8Array(message));
-        const { type, senderId, targetId, channelId, message: messageData, broadcast, } = decoded;
+        const decoded = cbor.decode(new Uint8Array(message));
+        const { type, senderId } = decoded;
         const socket = this.socket;
         if (!socket) {
             throw new Error("Missing socket at receiveMessage");
@@ -105,19 +111,17 @@ export class BrowserWebSocketClientAdapter extends WebSocketNetworkAdapter {
         }
         switch (type) {
             case "peer":
-                log(`peer: ${senderId}, ${channelId}`);
+                log(`peer: ${senderId}`);
                 this.announceConnection(senderId);
                 break;
             case "error":
-                log(`error: ${decoded.errorMessage}`);
+                log(`error: ${decoded.message}`);
+                break;
             default:
-                this.emit("message", {
-                    channelId,
-                    senderId,
-                    targetId,
-                    message: new Uint8Array(messageData),
-                    broadcast,
-                });
+                if (!isValidMessage(decoded)) {
+                    throw new Error("Invalid message received");
+                }
+                this.emit("message", decoded);
         }
     }
 }

package/dist/NodeWSServerAdapter.d.ts

@@ -1,6 +1,7 @@
 /// <reference types="ws" />
 import { WebSocket, type WebSocketServer } from "isomorphic-ws";
-import { ChannelId, NetworkAdapter, PeerId } from "@automerge/automerge-repo";
+import { NetworkAdapter, type PeerId } from "@automerge/automerge-repo";
+import { FromServerMessage } from "./messages.js";
 export declare class NodeWSServerAdapter extends NetworkAdapter {
     server: WebSocketServer;
     sockets: {
@@ -10,7 +11,7 @@ export declare class NodeWSServerAdapter extends NetworkAdapter {
     connect(peerId: PeerId): void;
     join(): void;
     leave(): void;
-    sendMessage(targetId: PeerId, channelId: ChannelId, message: Uint8Array, broadcast: boolean): void;
+    send(message: FromServerMessage): void;
     receiveMessage(message: Uint8Array, socket: WebSocket): void;
 }
 //# sourceMappingURL=NodeWSServerAdapter.d.ts.map

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;AAK/D,OAAO,EACL,SAAS,EAET,cAAc,EACd,MAAM,EACP,MAAM,2BAA2B,CAAA;AAIlC,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,WAAW,CACT,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,SAAS,EACpB,OAAO,EAAE,UAAU,EACnB,SAAS,EAAE,OAAO;IAsCpB,cAAc,CAAC,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,SAAS;CA2EtD"}
+{"version":3,"file":"NodeWSServerAdapter.d.ts","sourceRoot":"","sources":["../src/NodeWSServerAdapter.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,SAAS,EAAE,KAAK,eAAe,EAAE,MAAM,eAAe,CAAA;AAM/D,OAAO,EACL,cAAc,EAGd,KAAK,MAAM,EACZ,MAAM,2BAA2B,CAAA;AAClC,OAAO,EAAqB,iBAAiB,EAAE,MAAM,eAAe,CAAA;AAIpE,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,IAAI;IAIJ,KAAK;IAIL,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 { NetworkAdapter, } from "@automerge/automerge-repo";
 import { ProtocolV1 } from "./protocolVersion.js";
+import { NetworkAdapter, cbor as cborHelpers, } from "@automerge/automerge-repo";
+const { encode, decode } = cborHelpers;
 export class NodeWSServerAdapter extends NetworkAdapter {
     server;
     sockets = {};
@@ -23,6 +23,7 @@ export class NodeWSServerAdapter extends NetworkAdapter {
                 }
             });
             socket.on("message", message => this.receiveMessage(message, socket));
+            this.emit("ready", { network: this });
         });
     }
     join() {
@@ -31,41 +32,32 @@ export class NodeWSServerAdapter extends NetworkAdapter {
     leave() {
         // throw new Error("The server doesn't join channels.")
     }
-    sendMessage(targetId, channelId, message, broadcast) {
-        if (message.byteLength === 0) {
+    send(message) {
+        if ("data" in message && message.data.byteLength === 0) {
             throw new Error("tried to send a zero-length message");
         }
         const senderId = this.peerId;
         if (!senderId) {
             throw new Error("No peerId set for the websocket server network adapter.");
         }
-        if (this.sockets[targetId] === undefined) {
-            log(`Tried to send message to disconnected peer: ${targetId}`);
+        if (this.sockets[message.targetId] === undefined) {
+            log(`Tried to send message to disconnected peer: ${message.targetId}`);
             return;
         }
-        const decoded = {
-            senderId,
-            targetId,
-            channelId,
-            type: "sync",
-            message,
-            broadcast,
-        };
-        const encoded = CBOR.encode(decoded);
+        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);
-        log(`[${senderId}->${targetId}@${channelId}] "sync" | ${arrayBuf.byteLength} bytes`);
-        this.sockets[targetId].send(arrayBuf);
+        this.sockets[message.targetId]?.send(arrayBuf);
     }
     receiveMessage(message, socket) {
-        const cbor = CBOR.decode(message);
-        const { type, channelId, senderId, targetId, message: data, broadcast, supportedProtocolVersions, } = cbor;
+        const cbor = decode(message);
+        const { type, senderId } = cbor;
         const myPeerId = this.peerId;
         if (!myPeerId) {
             throw new Error("Missing my peer ID.");
         }
-        log(`[${senderId}->${myPeerId}@${channelId}] ${type} | ${message.byteLength} bytes`);
+        log(`[${senderId}->${myPeerId}${"documentId" in cbor ? "@" + cbor.documentId : ""}] ${type} | ${message.byteLength} bytes`);
         switch (type) {
             case "join":
                 // Let the rest of the system know that we have a new connection.
@@ -73,21 +65,24 @@ export class NodeWSServerAdapter extends NetworkAdapter {
                 this.sockets[senderId] = socket;
                 // In this client-server connection, there's only ever one peer: us!
                 // (and we pretend to be joined to every channel)
-                const selectedProtocolVersion = selectProtocol(supportedProtocolVersions);
+                const selectedProtocolVersion = selectProtocol(cbor.supportedProtocolVersions);
                 if (selectedProtocolVersion === null) {
-                    socket.send(CBOR.encode({
+                    this.send({
                         type: "error",
-                        errorMessage: "unsupported protocol version",
-                    }));
+                        senderId: this.peerId,
+                        message: "unsupported protocol version",
+                        targetId: senderId,
+                    });
                     this.sockets[senderId].close();
                     delete this.sockets[senderId];
                 }
                 else {
-                    socket.send(CBOR.encode({
+                    this.send({
                         type: "peer",
                         senderId: this.peerId,
                         selectedProtocolVersion: ProtocolV1,
-                    }));
+                        targetId: senderId,
+                    });
                 }
                 break;
             case "leave":
@@ -96,21 +91,8 @@ export class NodeWSServerAdapter extends NetworkAdapter {
                 // TODO: confirm this
                 // ?
                 break;
-            // We accept both "message" and "sync" because a previous version of this
-            // codebase sent sync messages in the BrowserWebSocketClientAdapter as
-            // type "message" and we want to stay backwards compatible
-            case "message":
-            case "sync":
-                this.emit("message", {
-                    senderId,
-                    targetId,
-                    channelId,
-                    message: new Uint8Array(data),
-                    broadcast,
-                });
-                break;
             default:
-                log(`unrecognized message type ${type}`);
+                this.emit("message", cbor);
                 break;
         }
     }

package/dist/messages.d.ts

@@ -0,0 +1,26 @@
+import { type Message, type PeerId } from "@automerge/automerge-repo";
+import { ProtocolVersion } from "./protocolVersion.js";
+export type LeaveMessage = {
+    type: "leave";
+    senderId: PeerId;
+};
+export type JoinMessage = {
+    type: "join";
+    senderId: PeerId;
+    supportedProtocolVersions: ProtocolVersion[];
+};
+export type PeerMessage = {
+    type: "peer";
+    senderId: PeerId;
+    selectedProtocolVersion: ProtocolVersion;
+    targetId: PeerId;
+};
+export type ErrorMessage = {
+    type: "error";
+    senderId: PeerId;
+    message: string;
+    targetId: PeerId;
+};
+export type FromClientMessage = JoinMessage | LeaveMessage | Message;
+export type FromServerMessage = PeerMessage | ErrorMessage | Message;
+//# sourceMappingURL=messages.d.ts.map

package/dist/messages.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"messages.d.ts","sourceRoot":"","sources":["../src/messages.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,2BAA2B,CAAA;AACrE,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AAEtD,MAAM,MAAM,YAAY,GAAG;IACzB,IAAI,EAAE,OAAO,CAAA;IACb,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,WAAW,GAAG;IACxB,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,MAAM,CAAA;IAChB,yBAAyB,EAAE,eAAe,EAAE,CAAA;CAC7C,CAAA;AAED,MAAM,MAAM,WAAW,GAAG;IACxB,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,MAAM,CAAA;IAChB,uBAAuB,EAAE,eAAe,CAAA;IACxC,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,YAAY,GAAG;IACzB,IAAI,EAAE,OAAO,CAAA;IACb,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,MAAM,CAAA;IACf,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AAGD,MAAM,MAAM,iBAAiB,GAAG,WAAW,GAAG,YAAY,GAAG,OAAO,CAAA;AACpE,MAAM,MAAM,iBAAiB,GAAG,WAAW,GAAG,YAAY,GAAG,OAAO,CAAA"}

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@automerge/automerge-repo-network-websocket",
-  "version": "1.0.0-alpha.2",
+  "version": "1.0.0-alpha.4",
   "description": "isomorphic node/browser Websocket network adapter for Automerge Repo",
   "peerDependencies": {
-    "@automerge/automerge": "^2.1.0-alpha.10"
+    "@automerge/automerge": "^2.1.0-alpha.12"
   },
   "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.2",
+    "@automerge/automerge-repo": "^1.0.0-alpha.4",
     "cbor-x": "^1.3.0",
     "eventemitter3": "^4.0.7",
     "isomorphic-ws": "^5.0.0",
@@ -34,5 +34,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "b5830dde8f135b694809698aaad2a9fdc79a9898"
+  "gitHead": "fbf71f0c3aaa2786a4e279f336f01d665f53ce5b"
 }

package/src/BrowserWebSocketClientAdapter.ts

@@ -1,15 +1,16 @@
-import {
-  ChannelId,
-  InboundMessagePayload,
-  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"
-import {ProtocolV1} from "./protocolVersion.js"
-import {InboundWebSocketMessage, OutboundWebSocketMessage} from "./message.js"
+
+import {
+  FromClientMessage,
+  FromServerMessage,
+  JoinMessage,
+} from "./messages.js"
+import { ProtocolV1 } from "./protocolVersion.js"
+import { isValidMessage } from "@automerge/automerge-repo/dist/network/messages.js"
+
 const log = debug("WebsocketClient")
 
 abstract class WebSocketNetworkAdapter extends NetworkAdapter {
@@ -17,9 +18,11 @@ abstract class WebSocketNetworkAdapter extends NetworkAdapter {
 }
 
 export class BrowserWebSocketClientAdapter extends WebSocketNetworkAdapter {
-  // Type trickery required for platform independence, 
+  // 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
 
   constructor(url: string) {
@@ -55,6 +58,16 @@ 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)
   }
 
   join() {
@@ -62,9 +75,7 @@ export class BrowserWebSocketClientAdapter extends WebSocketNetworkAdapter {
       throw new Error("WTF, get a socket")
     }
     if (this.socket.readyState === WebSocket.OPEN) {
-      this.socket.send(
-        CBOR.encode(joinMessage(this.peerId))
-      )
+      this.send(joinMessage(this.peerId!))
     } else {
       this.socket.addEventListener(
         "open",
@@ -72,9 +83,7 @@ export class BrowserWebSocketClientAdapter extends WebSocketNetworkAdapter {
           if (!this.socket) {
             throw new Error("WTF, get a socket")
           }
-          this.socket.send(
-            CBOR.encode(joinMessage(this.peerId))
-          )
+          this.send(joinMessage(this.peerId!))
         },
         { once: true }
       )
@@ -85,43 +94,31 @@ export class BrowserWebSocketClientAdapter extends WebSocketNetworkAdapter {
     if (!this.socket) {
       throw new Error("WTF, get a socket")
     }
-    this.socket.send(CBOR.encode({ type: "leave", senderId: this.peerId }))
+    this.send({ type: "leave", senderId: this.peerId! })
   }
 
-  sendMessage(
-    targetId: PeerId,
-    channelId: ChannelId,
-    message: Uint8Array,
-    broadcast: boolean
-  ) {
-    if (message.byteLength === 0) {
+  send(message: FromClientMessage) {
+    if ("data" in message && message.data.byteLength === 0) {
       throw new Error("tried to send a zero-length message")
     }
+
     if (!this.peerId) {
       throw new Error("Why don't we have a PeerID?")
     }
 
-    const decoded: InboundMessagePayload = {
-      senderId: this.peerId,
-      targetId,
-      channelId,
-      type: "sync",
-      message,
-      broadcast,
+    if (!this.socket || this.socket.readyState !== WebSocket.OPEN) {
+      throw new Error("Websocket Socket not ready!")
     }
 
-    const encoded = CBOR.encode(decoded)
-
+    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
     )
-    if (!this.socket || this.socket.readyState !== WebSocket.OPEN) {
-      throw new Error("Websocket Socket not ready!")
-    }
-    this.socket.send(arrayBuf)
+
+    this.socket?.send(arrayBuf)
   }
 
   announceConnection(peerId: PeerId) {
@@ -130,21 +127,17 @@ 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: OutboundWebSocketMessage = CBOR.decode(new Uint8Array(message))
+    const decoded: FromServerMessage = cbor.decode(new Uint8Array(message))
 
-    const {
-      type,
-      senderId,
-      targetId,
-      channelId,
-      message: messageData,
-      broadcast,
-    } = decoded
+    const { type, senderId } = decoded
 
     const socket = this.socket
     if (!socket) {
@@ -157,24 +150,22 @@ export class BrowserWebSocketClientAdapter extends WebSocketNetworkAdapter {
 
     switch (type) {
       case "peer":
-        log(`peer: ${senderId}, ${channelId}`)
+        log(`peer: ${senderId}`)
         this.announceConnection(senderId)
         break
       case "error":
-        log(`error: ${decoded.errorMessage}`)
+        log(`error: ${decoded.message}`)
+        break
       default:
-        this.emit("message", {
-          channelId,
-          senderId,
-          targetId,
-          message: new Uint8Array(messageData),
-          broadcast,
-        })
+        if (!isValidMessage(decoded)) {
+          throw new Error("Invalid message received")
+        }
+        this.emit("message", decoded)
     }
   }
 }
 
-function joinMessage(senderId?: PeerId): Record<string, any> {
+function joinMessage(senderId: PeerId): JoinMessage {
   return {
     type: "join",
     senderId,

package/src/NodeWSServerAdapter.ts

@@ -1,17 +1,18 @@
-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 {
-  ChannelId,
-  InboundMessagePayload,
   NetworkAdapter,
-  PeerId,
+  cbor as cborHelpers,
+  type NetworkAdapterMessage,
+  type PeerId,
 } from "@automerge/automerge-repo"
-import { ProtocolV1, ProtocolVersion } from "./protocolVersion.js"
-import { InboundWebSocketMessage } from "./message.js"
+import { FromClientMessage, FromServerMessage } from "./messages.js"
+
+const { encode, decode } = cborHelpers
 
 export class NodeWSServerAdapter extends NetworkAdapter {
   server: WebSocketServer
@@ -38,6 +39,7 @@ export class NodeWSServerAdapter extends NetworkAdapter {
       socket.on("message", message =>
         this.receiveMessage(message as Uint8Array, socket)
       )
+      this.emit("ready", {network: this})
     })
   }
 
@@ -49,34 +51,21 @@ export class NodeWSServerAdapter extends NetworkAdapter {
     // throw new Error("The server doesn't join channels.")
   }
 
-  sendMessage(
-    targetId: PeerId,
-    channelId: ChannelId,
-    message: Uint8Array,
-    broadcast: boolean
-  ) {
-    if (message.byteLength === 0) {
+  send(message: FromServerMessage) {
+    if ("data" in message && message.data.byteLength === 0) {
       throw new Error("tried to send a zero-length message")
     }
     const senderId = this.peerId
     if (!senderId) {
       throw new Error("No peerId set for the websocket server network adapter.")
     }
-    if (this.sockets[targetId] === undefined) {
-      log(`Tried to send message to disconnected peer: ${targetId}`)
-      return
-    }
 
-    const decoded: InboundMessagePayload = {
-      senderId,
-      targetId,
-      channelId,
-      type: "sync",
-      message,
-      broadcast,
+    if (this.sockets[message.targetId] === undefined) {
+      log(`Tried to send message to disconnected peer: ${message.targetId}`)
+      return
     }
-    const encoded = CBOR.encode(decoded)
 
+    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(
@@ -84,32 +73,22 @@ export class NodeWSServerAdapter extends NetworkAdapter {
       encoded.byteOffset + encoded.byteLength
     )
 
-    log(
-      `[${senderId}->${targetId}@${channelId}] "sync" | ${arrayBuf.byteLength} bytes`
-    )
-
-    this.sockets[targetId].send(arrayBuf)
+    this.sockets[message.targetId]?.send(arrayBuf)
   }
 
   receiveMessage(message: Uint8Array, socket: WebSocket) {
-    const cbor: InboundWebSocketMessage = CBOR.decode(message)
-
-    const {
-      type,
-      channelId,
-      senderId,
-      targetId,
-      message: data,
-      broadcast,
-      supportedProtocolVersions,
-    } = cbor
+    const cbor: FromClientMessage = decode(message)
+
+    const { type, senderId } = cbor
 
     const myPeerId = this.peerId
     if (!myPeerId) {
       throw new Error("Missing my peer ID.")
     }
     log(
-      `[${senderId}->${myPeerId}@${channelId}] ${type} | ${message.byteLength} bytes`
+      `[${senderId}->${myPeerId}${
+        "documentId" in cbor ? "@" + cbor.documentId : ""
+      }] ${type} | ${message.byteLength} bytes`
     )
     switch (type) {
       case "join":
@@ -120,25 +99,24 @@ export class NodeWSServerAdapter extends NetworkAdapter {
         // In this client-server connection, there's only ever one peer: us!
         // (and we pretend to be joined to every channel)
         const selectedProtocolVersion = selectProtocol(
-          supportedProtocolVersions
+          cbor.supportedProtocolVersions
         )
         if (selectedProtocolVersion === null) {
-          socket.send(
-            CBOR.encode({
-              type: "error",
-              errorMessage: "unsupported protocol version",
-            })
-          )
+          this.send({
+            type: "error",
+            senderId: this.peerId!,
+            message: "unsupported protocol version",
+            targetId: senderId,
+          })
           this.sockets[senderId].close()
           delete this.sockets[senderId]
         } else {
-          socket.send(
-            CBOR.encode({
-              type: "peer",
-              senderId: this.peerId,
-              selectedProtocolVersion: ProtocolV1,
-            })
-          )
+          this.send({
+            type: "peer",
+            senderId: this.peerId!,
+            selectedProtocolVersion: ProtocolV1,
+            targetId: senderId,
+          })
         }
         break
       case "leave":
@@ -148,21 +126,8 @@ export class NodeWSServerAdapter extends NetworkAdapter {
         // ?
         break
 
-      // We accept both "message" and "sync" because a previous version of this
-      // codebase sent sync messages in the BrowserWebSocketClientAdapter as
-      // type "message" and we want to stay backwards compatible
-      case "message":
-      case "sync":
-        this.emit("message", {
-          senderId,
-          targetId,
-          channelId,
-          message: new Uint8Array(data),
-          broadcast,
-        })
-        break
       default:
-        log(`unrecognized message type ${type}`)
+        this.emit("message", cbor)
         break
     }
   }

package/src/messages.ts

@@ -0,0 +1,31 @@
+import { type Message, type PeerId } from "@automerge/automerge-repo"
+import { ProtocolVersion } from "./protocolVersion.js"
+
+export type LeaveMessage = {
+  type: "leave"
+  senderId: PeerId
+}
+
+export type JoinMessage = {
+  type: "join"
+  senderId: PeerId
+  supportedProtocolVersions: ProtocolVersion[]
+}
+
+export type PeerMessage = {
+  type: "peer"
+  senderId: PeerId
+  selectedProtocolVersion: ProtocolVersion
+  targetId: PeerId
+}
+
+export type ErrorMessage = {
+  type: "error"
+  senderId: PeerId
+  message: string
+  targetId: PeerId
+}
+
+// This adapter doesn't use NetworkAdapterMessage, it has its own idea of how to handle join/leave
+export type FromClientMessage = JoinMessage | LeaveMessage | Message
+export type FromServerMessage = PeerMessage | ErrorMessage | Message

package/test/Websocket.test.ts

@@ -1,19 +1,32 @@
-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 WebSocket, { AddressInfo } from "ws"
 import { assert } from "chai"
-import {ChannelId, PeerId, Repo} from "@automerge/automerge-repo"
+import { PeerId, Repo } from "@automerge/automerge-repo"
 import { once } from "events"
 
 describe("Websocket adapters", async () => {
   let port = 8080
 
   runAdapterTests(async () => {
-    port += 1 // Increment port to avoid conflicts
-    const { socket, server } = await startServer(port)
+    let socket: WebSocket.Server | undefined = undefined
+    let server: any
+
+    while (socket === undefined) {
+      try {
+        ; ({ socket, server } = await startServer(port))
+      } catch (e: any) {
+        if (e.code === "EADDRINUSE") {
+          port++
+        } else {
+          throw e
+        }
+      }
+    }
+
     const serverAdapter = new NodeWSServerAdapter(socket)
 
     const serverUrl = `ws://localhost:${port}`
@@ -25,19 +38,19 @@ describe("Websocket adapters", async () => {
       server.close()
     }
 
-    return { adapters: [serverAdapter, aliceAdapter, bobAdapter], teardown }
+    return { adapters: [aliceAdapter, serverAdapter, bobAdapter], teardown }
   })
 })
 
 describe("The BrowserWebSocketClientAdapter", () => {
   it("should advertise the protocol versions it supports in its join message", async () => {
-    const  { socket, server } = await startServer(0)
+    const { socket, server } = await startServer(0)
     let port = (server.address()!! as AddressInfo).port
     const serverUrl = `ws://localhost:${port}`
     const helloPromise = firstMessage(socket)
 
     const client = new BrowserWebSocketClientAdapter(serverUrl)
-    const repo = new Repo({network: [client], peerId: "browser" as PeerId})
+    const repo = new Repo({ network: [client], peerId: "browser" as PeerId })
 
     const hello = await helloPromise
 
@@ -45,8 +58,8 @@ describe("The BrowserWebSocketClientAdapter", () => {
     assert.deepEqual(message, {
       type: "join",
       senderId: "browser",
-      supportedProtocolVersions: ["1"]
-    }) 
+      supportedProtocolVersions: ["1"],
+    })
   })
 })
 
@@ -55,12 +68,13 @@ describe("The NodeWSServerAdapter", () => {
     const response = await serverHelloGivenClientHello({
       type: "join",
       senderId: "browser",
-      supportedProtocolVersions: ["1"]
+      supportedProtocolVersions: ["1"],
     })
     assert.deepEqual<any>(response, {
       type: "peer",
       senderId: "server",
-      selectedProtocolVersion: "1"
+      targetId: "browser",
+      selectedProtocolVersion: "1",
     })
   })
 
@@ -68,11 +82,13 @@ describe("The NodeWSServerAdapter", () => {
     const response = await serverHelloGivenClientHello({
       type: "join",
       senderId: "browser",
-      supportedProtocolVersions: ["fake"]
+      supportedProtocolVersions: ["fake"],
     })
     assert.deepEqual<any>(response, {
       type: "error",
-      errorMessage: "unsupported protocol version",
+      senderId: "server",
+      targetId: "browser",
+      message: "unsupported protocol version",
     })
   })
 
@@ -84,17 +100,20 @@ describe("The NodeWSServerAdapter", () => {
     assert.deepEqual<any>(response, {
       type: "peer",
       senderId: "server",
-      selectedProtocolVersion: "1"
+      targetId: "browser",
+      selectedProtocolVersion: "1",
     })
   })
 })
 
-async function serverHelloGivenClientHello(clientHello: Object): Promise<Object | null> {
-  const  { socket, server } = await startServer(0)
+async function serverHelloGivenClientHello(
+  clientHello: Object
+): Promise<Object | null> {
+  const { socket, server } = await startServer(0)
   let port = (server.address()!! as AddressInfo).port
   const serverUrl = `ws://localhost:${port}`
   const adapter = new NodeWSServerAdapter(socket)
-  const repo = new Repo({network: [adapter], peerId: "server" as PeerId})
+  const repo = new Repo({ network: [adapter], peerId: "server" as PeerId })
 
   const clientSocket = new WebSocket(serverUrl)
   await once(clientSocket, "open")
@@ -107,9 +126,11 @@ async function serverHelloGivenClientHello(clientHello: Object): Promise<Object
   return message
 }
 
-async function firstMessage(socket: WebSocket.Server<any>): Promise<Object | null> {
+async function firstMessage(
+  socket: WebSocket.Server<any>
+): Promise<Object | null> {
   return new Promise((resolve, reject) => {
-    socket.once("connection", (ws) => {
+    socket.once("connection", ws => {
       ws.once("message", (message: any) => {
         resolve(message)
       })
@@ -117,7 +138,7 @@ async function firstMessage(socket: WebSocket.Server<any>): Promise<Object | nul
         reject(error)
       })
     })
-    socket.once("error", (error) => {
+    socket.once("error", error => {
       reject(error)
     })
   })

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",

package/dist/message.d.ts

@@ -1,9 +0,0 @@
-import { type InboundMessagePayload } from "@automerge/automerge-repo";
-import { ProtocolVersion } from "./protocolVersion.js";
-export interface InboundWebSocketMessage extends InboundMessagePayload {
-    supportedProtocolVersions?: ProtocolVersion[];
-}
-export interface OutboundWebSocketMessage extends InboundMessagePayload {
-    errorMessage?: string;
-}
-//# sourceMappingURL=message.d.ts.map

package/dist/message.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"message.d.ts","sourceRoot":"","sources":["../src/message.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,qBAAqB,EAAE,MAAM,2BAA2B,CAAA;AACtE,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AAEtD,MAAM,WAAW,uBAAwB,SAAQ,qBAAqB;IACpE,yBAAyB,CAAC,EAAE,eAAe,EAAE,CAAA;CAC9C;AAED,MAAM,WAAW,wBAAyB,SAAQ,qBAAqB;IACrE,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB"}

package/src/message.ts

@@ -1,10 +0,0 @@
-import { type InboundMessagePayload } from "@automerge/automerge-repo"
-import { ProtocolVersion } from "./protocolVersion.js"
-
-export interface InboundWebSocketMessage extends InboundMessagePayload {
-  supportedProtocolVersions?: ProtocolVersion[]
-}
-
-export interface OutboundWebSocketMessage extends InboundMessagePayload {
-  errorMessage?: string
-}