@automerge/automerge-repo-network-websocket 0.2.0 → 1.0.0-alpha.0

package/dist/BrowserWebSocketClientAdapter.d.ts

@@ -8,13 +8,12 @@ declare abstract class WebSocketNetworkAdapter extends NetworkAdapter {
 export declare class BrowserWebSocketClientAdapter extends WebSocketNetworkAdapter {
     timerId?: NodeJS.Timer;
     url: string;
-    channels: ChannelId[];
     constructor(url: string);
     connect(peerId: PeerId): void;
-    join(channelId: ChannelId): void;
-    leave(channelId: ChannelId): void;
+    join(): void;
+    leave(): void;
     sendMessage(targetId: PeerId, channelId: ChannelId, message: Uint8Array, broadcast: boolean): void;
-    announceConnection(channelId: ChannelId, peerId: PeerId): void;
+    announceConnection(peerId: PeerId): void;
     receiveMessage(message: Uint8Array): void;
 }
 export {};

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;AAKrC,uBAAe,uBAAwB,SAAQ,cAAc;IAC3D,MAAM,CAAC,EAAE,SAAS,CAAA;CACnB;AAED,qBAAa,6BAA8B,SAAQ,uBAAuB;IACxE,OAAO,CAAC,EAAE,MAAM,CAAC,KAAK,CAAA;IACtB,GAAG,EAAE,MAAM,CAAA;IACX,QAAQ,EAAE,SAAS,EAAE,CAAK;gBAEd,GAAG,EAAE,MAAM;IAKvB,OAAO,CAAC,MAAM,EAAE,MAAM;IA8BtB,IAAI,CAAC,SAAS,EAAE,SAAS;IA6BzB,KAAK,CAAC,SAAS,EAAE,SAAS;IAU1B,WAAW,CACT,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,SAAS,EACpB,OAAO,EAAE,UAAU,EACnB,SAAS,EAAE,OAAO;IAgCpB,kBAAkB,CAAC,SAAS,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM;IAUvD,cAAc,CAAC,OAAO,EAAE,UAAU;CAoCnC"}
+{"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;IACxE,OAAO,CAAC,EAAE,MAAM,CAAC,KAAK,CAAA;IACtB,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"}

package/dist/BrowserWebSocketClientAdapter.js

@@ -2,6 +2,7 @@ import { NetworkAdapter, } from "@automerge/automerge-repo";
 import * as CBOR from "cbor-x";
 import WebSocket from "isomorphic-ws";
 import debug from "debug";
+import { ProtocolV1 } from "./protocolVersion";
 const log = debug("WebsocketClient");
 class WebSocketNetworkAdapter extends NetworkAdapter {
     socket;
@@ -9,7 +10,6 @@ class WebSocketNetworkAdapter extends NetworkAdapter {
 export class BrowserWebSocketClientAdapter extends WebSocketNetworkAdapter {
     timerId;
     url;
-    channels = [];
     constructor(url) {
         super();
         this.url = url;
@@ -25,7 +25,7 @@ export class BrowserWebSocketClientAdapter extends WebSocketNetworkAdapter {
             log(`@ ${this.url}: open`);
             clearInterval(this.timerId);
             this.timerId = undefined;
-            this.channels.forEach(c => this.join(c));
+            this.join();
         });
         // When a socket closes, or disconnects, remove it from the array.
         this.socket.addEventListener("close", () => {
@@ -37,32 +37,27 @@ export class BrowserWebSocketClientAdapter extends WebSocketNetworkAdapter {
         });
         this.socket.addEventListener("message", (event) => this.receiveMessage(event.data));
     }
-    join(channelId) {
-        // TODO: the network subsystem should manage this
-        if (!this.channels.includes(channelId)) {
-            this.channels.push(channelId);
-        }
+    join() {
         if (!this.socket) {
             throw new Error("WTF, get a socket");
         }
         if (this.socket.readyState === WebSocket.OPEN) {
-            this.socket.send(CBOR.encode({ type: "join", channelId, senderId: this.peerId }));
+            this.socket.send(CBOR.encode(joinMessage(this.peerId)));
         }
         else {
             this.socket.addEventListener("open", () => {
                 if (!this.socket) {
                     throw new Error("WTF, get a socket");
                 }
-                this.socket.send(CBOR.encode({ type: "join", channelId, senderId: this.peerId }));
+                this.socket.send(CBOR.encode(joinMessage(this.peerId)));
             }, { once: true });
         }
     }
-    leave(channelId) {
-        this.channels = this.channels.filter(c => c !== channelId);
+    leave() {
         if (!this.socket) {
             throw new Error("WTF, get a socket");
         }
-        this.socket.send(CBOR.encode({ type: "leave", channelId, senderId: this.peerId }));
+        this.socket.send(CBOR.encode({ type: "leave", senderId: this.peerId }));
     }
     sendMessage(targetId, channelId, message, broadcast) {
         if (message.byteLength === 0) {
@@ -88,13 +83,13 @@ export class BrowserWebSocketClientAdapter extends WebSocketNetworkAdapter {
         }
         this.socket.send(arrayBuf);
     }
-    announceConnection(channelId, peerId) {
+    announceConnection(peerId) {
         // return a peer object
         const myPeerId = this.peerId;
         if (!myPeerId) {
             throw new Error("we should have a peer ID by now");
         }
-        this.emit("peer-candidate", { peerId, channelId });
+        this.emit("peer-candidate", { peerId });
     }
     receiveMessage(message) {
         const decoded = CBOR.decode(new Uint8Array(message));
@@ -109,8 +104,10 @@ export class BrowserWebSocketClientAdapter extends WebSocketNetworkAdapter {
         switch (type) {
             case "peer":
                 log(`peer: ${senderId}, ${channelId}`);
-                this.announceConnection(channelId, senderId);
+                this.announceConnection(senderId);
                 break;
+            case "error":
+                log(`error: ${decoded.errorMessage}`);
             default:
                 this.emit("message", {
                     channelId,
@@ -122,3 +119,10 @@ export class BrowserWebSocketClientAdapter extends WebSocketNetworkAdapter {
         }
     }
 }
+function joinMessage(senderId) {
+    return {
+        type: "join",
+        senderId,
+        supportedProtocolVersions: [ProtocolV1],
+    };
+}

package/dist/NodeWSServerAdapter.d.ts

@@ -8,8 +8,8 @@ export declare class NodeWSServerAdapter extends NetworkAdapter {
     };
     constructor(server: WebSocketServer);
     connect(peerId: PeerId): void;
-    join(docId: ChannelId): void;
-    leave(docId: ChannelId): void;
+    join(): void;
+    leave(): void;
     sendMessage(targetId: PeerId, channelId: ChannelId, message: Uint8Array, broadcast: boolean): 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;AAK/D,OAAO,EACL,SAAS,EAET,cAAc,EACd,MAAM,EACP,MAAM,2BAA2B,CAAA;AAElC,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,CAAC,KAAK,EAAE,SAAS;IAIrB,KAAK,CAAC,KAAK,EAAE,SAAS;IAItB,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;CAwDtD"}
+{"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;CAoEtD"}

package/dist/NodeWSServerAdapter.js

@@ -2,6 +2,7 @@ import * as CBOR from "cbor-x";
 import debug from "debug";
 const log = debug("WebsocketServer");
 import { NetworkAdapter, } from "@automerge/automerge-repo";
+import { ProtocolV1 } from "./protocolVersion";
 export class NodeWSServerAdapter extends NetworkAdapter {
     server;
     sockets = {};
@@ -24,10 +25,10 @@ export class NodeWSServerAdapter extends NetworkAdapter {
             socket.on("message", message => this.receiveMessage(message, socket));
         });
     }
-    join(docId) {
+    join() {
         // throw new Error("The server doesn't join channels.")
     }
-    leave(docId) {
+    leave() {
         // throw new Error("The server doesn't join channels.")
     }
     sendMessage(targetId, channelId, message, broadcast) {
@@ -59,7 +60,7 @@ export class NodeWSServerAdapter extends NetworkAdapter {
     }
     receiveMessage(message, socket) {
         const cbor = CBOR.decode(message);
-        const { type, channelId, senderId, targetId, message: data, broadcast, } = cbor;
+        const { type, channelId, senderId, targetId, message: data, broadcast, supportedProtocolVersions, } = cbor;
         const myPeerId = this.peerId;
         if (!myPeerId) {
             throw new Error("Missing my peer ID.");
@@ -68,11 +69,23 @@ export class NodeWSServerAdapter extends NetworkAdapter {
         switch (type) {
             case "join":
                 // Let the rest of the system know that we have a new connection.
-                this.emit("peer-candidate", { peerId: senderId, channelId });
+                this.emit("peer-candidate", { peerId: senderId });
                 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)
-                socket.send(CBOR.encode({ type: "peer", senderId: this.peerId, channelId }));
+                const selectedProtocolVersion = selectProtocol(supportedProtocolVersions);
+                if (selectedProtocolVersion === null) {
+                    socket.send(CBOR.encode({ type: "error", errorMessage: "unsupported protocol version" }));
+                    this.sockets[senderId].close();
+                    delete this.sockets[senderId];
+                }
+                else {
+                    socket.send(CBOR.encode({
+                        type: "peer",
+                        senderId: this.peerId,
+                        selectedProtocolVersion: ProtocolV1,
+                    }));
+                }
                 break;
             case "leave":
                 // It doesn't seem like this gets called;
@@ -99,3 +112,12 @@ export class NodeWSServerAdapter extends NetworkAdapter {
         }
     }
 }
+function selectProtocol(versions) {
+    if (versions === undefined) {
+        return ProtocolV1;
+    }
+    if (versions.includes(ProtocolV1)) {
+        return ProtocolV1;
+    }
+    return null;
+}

package/dist/message.d.ts

@@ -0,0 +1,9 @@
+import { type InboundMessagePayload } from "@automerge/automerge-repo";
+import { ProtocolVersion } from "./protocolVersion";
+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

@@ -0,0 +1 @@
+{"version":3,"file":"message.d.ts","sourceRoot":"","sources":["../src/message.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,KAAK,qBAAqB,EAAC,MAAM,2BAA2B,CAAA;AACpE,OAAO,EAAC,eAAe,EAAC,MAAM,mBAAmB,CAAA;AAEjD,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/dist/message.js

@@ -0,0 +1 @@
+export {};

package/dist/protocolVersion.d.ts

@@ -0,0 +1,3 @@
+export declare const ProtocolV1 = "1";
+export type ProtocolVersion = typeof ProtocolV1;
+//# sourceMappingURL=protocolVersion.d.ts.map

package/dist/protocolVersion.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"protocolVersion.d.ts","sourceRoot":"","sources":["../src/protocolVersion.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,UAAU,MAAM,CAAA;AAC7B,MAAM,MAAM,eAAe,GAAG,OAAO,UAAU,CAAA"}

package/dist/protocolVersion.js

@@ -0,0 +1 @@
+export const ProtocolV1 = "1";

package/package.json

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

package/src/BrowserWebSocketClientAdapter.ts

@@ -8,6 +8,8 @@ import * as CBOR from "cbor-x"
 import WebSocket from "isomorphic-ws"
 
 import debug from "debug"
+import {ProtocolV1} from "./protocolVersion"
+import {InboundWebSocketMessage, OutboundWebSocketMessage} from "./message"
 const log = debug("WebsocketClient")
 
 abstract class WebSocketNetworkAdapter extends NetworkAdapter {
@@ -17,7 +19,6 @@ abstract class WebSocketNetworkAdapter extends NetworkAdapter {
 export class BrowserWebSocketClientAdapter extends WebSocketNetworkAdapter {
   timerId?: NodeJS.Timer
   url: string
-  channels: ChannelId[] = []
 
   constructor(url: string) {
     super()
@@ -37,7 +38,7 @@ export class BrowserWebSocketClientAdapter extends WebSocketNetworkAdapter {
       log(`@ ${this.url}: open`)
       clearInterval(this.timerId)
       this.timerId = undefined
-      this.channels.forEach(c => this.join(c))
+      this.join()
     })
 
     // When a socket closes, or disconnects, remove it from the array.
@@ -54,18 +55,13 @@ export class BrowserWebSocketClientAdapter extends WebSocketNetworkAdapter {
     )
   }
 
-  join(channelId: ChannelId) {
-    // TODO: the network subsystem should manage this
-    if (!this.channels.includes(channelId)) {
-      this.channels.push(channelId)
-    }
-
+  join() {
     if (!this.socket) {
       throw new Error("WTF, get a socket")
     }
     if (this.socket.readyState === WebSocket.OPEN) {
       this.socket.send(
-        CBOR.encode({ type: "join", channelId, senderId: this.peerId })
+        CBOR.encode(joinMessage(this.peerId))
       )
     } else {
       this.socket.addEventListener(
@@ -75,7 +71,7 @@ export class BrowserWebSocketClientAdapter extends WebSocketNetworkAdapter {
             throw new Error("WTF, get a socket")
           }
           this.socket.send(
-            CBOR.encode({ type: "join", channelId, senderId: this.peerId })
+            CBOR.encode(joinMessage(this.peerId))
           )
         },
         { once: true }
@@ -83,14 +79,11 @@ export class BrowserWebSocketClientAdapter extends WebSocketNetworkAdapter {
     }
   }
 
-  leave(channelId: ChannelId) {
-    this.channels = this.channels.filter(c => c !== channelId)
+  leave() {
     if (!this.socket) {
       throw new Error("WTF, get a socket")
     }
-    this.socket.send(
-      CBOR.encode({ type: "leave", channelId, senderId: this.peerId })
-    )
+    this.socket.send(CBOR.encode({ type: "leave", senderId: this.peerId }))
   }
 
   sendMessage(
@@ -129,18 +122,18 @@ export class BrowserWebSocketClientAdapter extends WebSocketNetworkAdapter {
     this.socket.send(arrayBuf)
   }
 
-  announceConnection(channelId: ChannelId, peerId: PeerId) {
+  announceConnection(peerId: PeerId) {
     // return a peer object
     const myPeerId = this.peerId
     if (!myPeerId) {
       throw new Error("we should have a peer ID by now")
     }
 
-    this.emit("peer-candidate", { peerId, channelId })
+    this.emit("peer-candidate", { peerId })
   }
 
   receiveMessage(message: Uint8Array) {
-    const decoded: InboundMessagePayload = CBOR.decode(new Uint8Array(message))
+    const decoded: OutboundWebSocketMessage = CBOR.decode(new Uint8Array(message))
 
     const {
       type,
@@ -163,8 +156,10 @@ export class BrowserWebSocketClientAdapter extends WebSocketNetworkAdapter {
     switch (type) {
       case "peer":
         log(`peer: ${senderId}, ${channelId}`)
-        this.announceConnection(channelId, senderId)
+        this.announceConnection(senderId)
         break
+      case "error":
+        log(`error: ${decoded.errorMessage}`)
       default:
         this.emit("message", {
           channelId,
@@ -176,3 +171,11 @@ export class BrowserWebSocketClientAdapter extends WebSocketNetworkAdapter {
     }
   }
 }
+
+function joinMessage(senderId?: PeerId): Record<string, any> {
+  return {
+    type: "join",
+    senderId,
+    supportedProtocolVersions: [ProtocolV1],
+  }
+}

package/src/NodeWSServerAdapter.ts

@@ -10,6 +10,8 @@ import {
   NetworkAdapter,
   PeerId,
 } from "@automerge/automerge-repo"
+import {ProtocolV1, ProtocolVersion} from "./protocolVersion"
+import {InboundWebSocketMessage} from "./message"
 
 export class NodeWSServerAdapter extends NetworkAdapter {
   server: WebSocketServer
@@ -39,11 +41,11 @@ export class NodeWSServerAdapter extends NetworkAdapter {
     })
   }
 
-  join(docId: ChannelId) {
+  join() {
     // throw new Error("The server doesn't join channels.")
   }
 
-  leave(docId: ChannelId) {
+  leave() {
     // throw new Error("The server doesn't join channels.")
   }
 
@@ -90,7 +92,7 @@ export class NodeWSServerAdapter extends NetworkAdapter {
   }
 
   receiveMessage(message: Uint8Array, socket: WebSocket) {
-    const cbor: InboundMessagePayload = CBOR.decode(message)
+    const cbor: InboundWebSocketMessage = CBOR.decode(message)
 
     const {
       type,
@@ -99,6 +101,7 @@ export class NodeWSServerAdapter extends NetworkAdapter {
       targetId,
       message: data,
       broadcast,
+      supportedProtocolVersions,
     } = cbor
 
     const myPeerId = this.peerId
@@ -111,14 +114,25 @@ export class NodeWSServerAdapter extends NetworkAdapter {
     switch (type) {
       case "join":
         // Let the rest of the system know that we have a new connection.
-        this.emit("peer-candidate", { peerId: senderId, channelId })
+        this.emit("peer-candidate", { peerId: senderId })
         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)
-        socket.send(
-          CBOR.encode({ type: "peer", senderId: this.peerId, channelId })
-        )
+        const selectedProtocolVersion = selectProtocol(supportedProtocolVersions)
+        if (selectedProtocolVersion === null) {
+          socket.send(CBOR.encode({ type: "error", errorMessage: "unsupported protocol version"}))
+          this.sockets[senderId].close()
+          delete this.sockets[senderId]
+        } else {
+          socket.send(
+            CBOR.encode({
+              type: "peer",
+              senderId: this.peerId,
+              selectedProtocolVersion: ProtocolV1,
+            })
+          )
+        }
         break
       case "leave":
         // It doesn't seem like this gets called;
@@ -146,3 +160,13 @@ export class NodeWSServerAdapter extends NetworkAdapter {
     }
   }
 }
+
+function selectProtocol(versions?: ProtocolVersion[]): ProtocolVersion | null {
+  if (versions === undefined) {
+    return ProtocolV1
+  }
+  if (versions.includes(ProtocolV1)) {
+    return ProtocolV1
+  }
+  return null
+}

package/src/message.ts

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

package/src/protocolVersion.ts

@@ -0,0 +1,2 @@
+export const ProtocolV1 = "1"
+export type ProtocolVersion = typeof ProtocolV1

package/test/Websocket.test.ts

@@ -2,6 +2,11 @@ import { runAdapterTests } from "../../automerge-repo/src/helpers/tests/network-
 import { BrowserWebSocketClientAdapter } from "../src/BrowserWebSocketClientAdapter"
 import { NodeWSServerAdapter } from "../src/NodeWSServerAdapter"
 import { startServer } from "./utilities/WebSockets"
+import * as CBOR from "cbor-x"
+import WebSocket, {AddressInfo}  from "ws"
+import { assert } from "chai"
+import {ChannelId, PeerId, Repo} from "@automerge/automerge-repo"
+import { once } from "events"
 
 describe("Websocket adapters", async () => {
   let port = 8080
@@ -23,3 +28,97 @@ describe("Websocket adapters", async () => {
     return { adapters: [serverAdapter, aliceAdapter, bobAdapter], teardown }
   })
 })
+
+describe("The BrowserWebSocketClientAdapter", () => {
+  it("should advertise the protocol versions it supports in its join message", async () => {
+    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 hello = await helloPromise
+
+    const message = CBOR.decode(hello as Uint8Array)
+    assert.deepEqual(message, {
+      type: "join",
+      senderId: "browser",
+      supportedProtocolVersions: ["1"]
+    }) 
+  })
+})
+
+describe("The NodeWSServerAdapter", () => {
+  it("should send the negotiated protocol version in its hello message", async () => {
+    const response = await serverHelloGivenClientHello({
+      type: "join",
+      senderId: "browser",
+      supportedProtocolVersions: ["1"]
+    })
+    assert.deepEqual<any>(response, {
+      type: "peer",
+      senderId: "server",
+      selectedProtocolVersion: "1"
+    })
+  })
+
+  it("should return an error message if the protocol version is not supported", async () => {
+    const response = await serverHelloGivenClientHello({
+      type: "join",
+      senderId: "browser",
+      supportedProtocolVersions: ["fake"]
+    })
+    assert.deepEqual<any>(response, {
+      type: "error",
+      errorMessage: "unsupported protocol version",
+    })
+  })
+
+  it("should respond with protocol v1 if no protocol version is specified", async () => {
+    const response = await serverHelloGivenClientHello({
+      type: "join",
+      senderId: "browser",
+    })
+    assert.deepEqual<any>(response, {
+      type: "peer",
+      senderId: "server",
+      selectedProtocolVersion: "1"
+    })
+  })
+})
+
+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 clientSocket = new WebSocket(serverUrl)
+  await once(clientSocket, "open")
+  const serverHelloPromise = once(clientSocket, "message")
+
+  clientSocket.send(CBOR.encode(clientHello))
+
+  const serverHello = await serverHelloPromise
+  const message = CBOR.decode(serverHello[0] as Uint8Array)
+  return message
+}
+
+async function firstMessage(socket: WebSocket.Server<any>): Promise<Object | null> {
+  return new Promise((resolve, reject) => {
+    socket.once("connection", (ws) => {
+      ws.once("message", (message: any) => {
+        resolve(message)
+      })
+      ws.once("error", (error: any) => {
+        reject(error)
+      })
+    })
+    socket.once("error", (error) => {
+      reject(error)
+    })
+  })
+}

package/dist/WSShared.d.ts

@@ -1,10 +0,0 @@
-/// <reference types="ws" />
-import { ChannelId, NetworkAdapter, PeerId } from "automerge-repo";
-import WebSocket from "isomorphic-ws";
-export interface WebSocketNetworkAdapter extends NetworkAdapter {
-    client?: WebSocket;
-}
-export declare function sendMessage(destinationId: PeerId, socket: WebSocket, channelId: ChannelId, senderId: PeerId, message: Uint8Array): void;
-export declare function receiveMessageClient(message: Uint8Array, self: WebSocketNetworkAdapter): void;
-export declare function receiveMessageServer(message: Uint8Array, socket: WebSocket, self: WebSocketNetworkAdapter): void;
-//# sourceMappingURL=WSShared.d.ts.map

package/dist/WSShared.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"WSShared.d.ts","sourceRoot":"","sources":["../src/WSShared.ts"],"names":[],"mappings":";AACA,OAAO,EACL,SAAS,EAET,cAAc,EAEd,MAAM,EACP,MAAM,gBAAgB,CAAA;AAEvB,OAAO,SAAS,MAAM,eAAe,CAAA;AAErC,MAAM,WAAW,uBAAwB,SAAQ,cAAc;IAC7D,MAAM,CAAC,EAAE,SAAS,CAAA;CACnB;AAED,wBAAgB,WAAW,CACzB,aAAa,EAAE,MAAM,EACrB,MAAM,EAAE,SAAS,EACjB,SAAS,EAAE,SAAS,EACpB,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,UAAU,QAwBpB;AAiBD,wBAAgB,oBAAoB,CAClC,OAAO,EAAE,UAAU,EACnB,IAAI,EAAE,uBAAuB,QAqC9B;AAED,wBAAgB,oBAAoB,CAClC,OAAO,EAAE,UAAU,EACnB,MAAM,EAAE,SAAS,EACjB,IAAI,EAAE,uBAAuB,QAwC9B"}

package/dist/WSShared.js

@@ -1,86 +0,0 @@
-import * as CBOR from "cbor-x";
-import WebSocket from "isomorphic-ws";
-export function sendMessage(destinationId, socket, channelId, senderId, message) {
-    if (message.byteLength === 0) {
-        throw new Error("tried to send a zero-length message");
-    }
-    const decoded = {
-        senderId,
-        channelId,
-        type: "sync",
-        data: message,
-    };
-    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);
-    console.log(`[${senderId}->${destinationId}@${channelId}] "sync" | ${arrayBuf.byteLength} bytes`);
-    socket.send(arrayBuf);
-}
-function prepareConnection(channelId, destinationId, socket, sourceId) {
-    const connection = {
-        close: () => socket.close(),
-        isOpen: () => socket.readyState === WebSocket.OPEN,
-        send: (message) => sendMessage(destinationId, socket, channelId, sourceId, message),
-    };
-    return connection;
-}
-export function receiveMessageClient(message, self) {
-    const decoded = CBOR.decode(new Uint8Array(message));
-    const { type, senderId, channelId, data } = decoded;
-    const socket = self.client;
-    if (!socket) {
-        throw new Error("Missing client at receiveMessage");
-    }
-    if (message.byteLength === 0) {
-        throw new Error("received a zero-length message");
-    }
-    switch (type) {
-        case "peer":
-            // console.log(`peer: ${senderId}, ${channelId}`)
-            const myPeerId = self.peerId;
-            if (!myPeerId) {
-                throw new Error("Local peer ID not set!");
-            }
-            const connection = prepareConnection(channelId, senderId, socket, myPeerId);
-            self.emit("peer-candidate", { peerId: senderId, channelId, connection });
-            break;
-        default:
-            self.emit("message", {
-                channelId,
-                senderId,
-                message: new Uint8Array(data),
-            });
-    }
-}
-export function receiveMessageServer(message, socket, self) {
-    const cbor = CBOR.decode(message);
-    const { type, channelId, senderId, data } = cbor;
-    const myPeerId = self.peerId;
-    if (!myPeerId) {
-        throw new Error("Missing my peer ID.");
-    }
-    console.log(`[${senderId}->${myPeerId}@${channelId}] ${type} | ${message.byteLength} bytes`);
-    switch (type) {
-        case "join":
-            // Let the rest of the system know that we have a new connection.
-            const connection = prepareConnection(channelId, senderId, socket, myPeerId);
-            self.emit("peer-candidate", { peerId: senderId, channelId, connection });
-            // In this client-server connection, there's only ever one peer: us!
-            socket.send(CBOR.encode({ type: "peer", senderId: self.peerId, channelId }));
-            break;
-        case "leave":
-            // ?
-            break;
-        case "sync":
-            self.emit("message", {
-                senderId,
-                channelId,
-                message: new Uint8Array(data),
-            });
-            break;
-        default:
-            // console.log("unrecognized message type")
-            break;
-    }
-}