@automerge/automerge-repo-network-websocket 2.0.0-alpha.7 → 2.0.0-collectionsync-alpha.1

package/README.md

@@ -27,12 +27,12 @@ Handshake is the following steps:
 
 - Once a connection is established the initiating peer sends a
   [join](#join) message with the `senderId` set to the initiating peers ID and
-  the `protocolVersion` set to "1"
+  a `supportedProtocolVersions` array containing "1"
 - The receiving peer waits until it receives a message from the initiating
   peer, if the initiating peer receives a message before sending the join message
   the initiating peer SHOULD terminate the connection.
 - When the receiving peer receives the join message
-  - if the `protocolVersion` is not "1" the receiving peer sends an
+  - if the `supportedProtocolVersions` does not contain "1" the receiving peer sends an
     [error](#error) message and terminates the connection
   - otherwise
     - store the `senderId` as the peer ID of the initiating peer
@@ -119,7 +119,7 @@ Sent by the initiating peer in the [handshake](#handshake) phase.
 {
     type: "join",
     senderId: peer_id,
-    supportedProtocolVersions: protocol_version
+    supportedProtocolVersions: [protocol_version]
     ? metadata: peer_metadata,
 }
 ```

package/dist/NodeWSServerAdapter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"NodeWSServerAdapter.d.ts","sourceRoot":"","sources":["../src/NodeWSServerAdapter.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,eAAe,CAAA;AACrC,OAAO,EAAE,KAAK,eAAe,EAAE,MAAM,eAAe,CAAA;AAKpD,OAAO,EAEL,cAAc,EACd,KAAK,YAAY,EACjB,KAAK,MAAM,EACZ,MAAM,gCAAgC,CAAA;AACvC,OAAO,EAEL,iBAAiB,EAElB,MAAM,eAAe,CAAA;AAOtB,qBAAa,mBAAoB,SAAQ,cAAc;;IAyBnD,OAAO,CAAC,MAAM;IACd,OAAO,CAAC,iBAAiB;IAzB3B,OAAO,EAAE;QAAE,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAA;KAAE,CAAK;IAQ7C,OAAO;IAIP,SAAS;gBAYC,MAAM,EAAE,eAAe,EACvB,iBAAiB,SAAO;IAKlC,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,YAAY;IAyCnD,UAAU;IAQV,IAAI,CAAC,OAAO,EAAE,iBAAiB;IAqB/B,cAAc,CAAC,YAAY,EAAE,UAAU,EAAE,MAAM,EAAE,SAAS;CAoE3D"}
+{"version":3,"file":"NodeWSServerAdapter.d.ts","sourceRoot":"","sources":["../src/NodeWSServerAdapter.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,eAAe,CAAA;AACrC,OAAO,EAAE,KAAK,eAAe,EAAE,MAAM,eAAe,CAAA;AAKpD,OAAO,EAEL,cAAc,EACd,KAAK,YAAY,EACjB,KAAK,MAAM,EACZ,MAAM,gCAAgC,CAAA;AACvC,OAAO,EAEL,iBAAiB,EAElB,MAAM,eAAe,CAAA;AAOtB,qBAAa,mBAAoB,SAAQ,cAAc;;IAyBnD,OAAO,CAAC,MAAM;IACd,OAAO,CAAC,iBAAiB;IAzB3B,OAAO,EAAE;QAAE,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAA;KAAE,CAAK;IAQ7C,OAAO;IAIP,SAAS;gBAYC,MAAM,EAAE,eAAe,EACvB,iBAAiB,SAAO;IAKlC,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,YAAY;IAyCnD,UAAU;IAQV,IAAI,CAAC,OAAO,EAAE,iBAAiB;IAqB/B,cAAc,CAAC,YAAY,EAAE,UAAU,EAAE,MAAM,EAAE,SAAS;CA2E3D"}

package/dist/NodeWSServerAdapter.js

@@ -89,7 +89,15 @@ export class NodeWSServerAdapter extends NetworkAdapter {
         socket.send(arrayBuf);
     }
     receiveMessage(messageBytes, socket) {
-        const message = decode(messageBytes);
+        let message;
+        try {
+            message = decode(messageBytes);
+        }
+        catch (e) {
+            log("invalid message received, closing connection");
+            socket.close();
+            return;
+        }
         const { type, senderId } = message;
         const myPeerId = this.peerId;
         assert(myPeerId);

package/dist/WSShared.d.ts

@@ -0,0 +1,22 @@
+/// <reference types="ws" />
+import { NetworkAdapter } from "automerge-repo"
+import WebSocket from "isomorphic-ws"
+export interface WebSocketNetworkAdapter extends NetworkAdapter {
+  client?: WebSocket
+}
+export declare function sendMessage(
+  socket: WebSocket,
+  channelId: string,
+  senderId: string,
+  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

@@ -0,0 +1 @@
+{"version":3,"file":"WSShared.d.ts","sourceRoot":"","sources":["../src/WSShared.ts"],"names":[],"mappings":";AACA,OAAO,EAEL,cAAc,EAEf,MAAM,gBAAgB,CAAA;AACvB,OAAO,SAAS,MAAM,eAAe,CAAA;AAErC,MAAM,WAAW,uBAAwB,SAAQ,cAAc;IAC7D,MAAM,CAAC,EAAE,SAAS,CAAA;CACnB;AAED,wBAAgB,WAAW,CACzB,MAAM,EAAE,SAAS,EACjB,SAAS,EAAE,MAAM,EACjB,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,UAAU,QAoBpB;AAsBD,wBAAgB,oBAAoB,CAClC,OAAO,EAAE,UAAU,EACnB,IAAI,EAAE,uBAAuB,QA0B9B;AAED,wBAAgB,oBAAoB,CAClC,OAAO,EAAE,UAAU,EACnB,MAAM,EAAE,SAAS,EACjB,IAAI,EAAE,uBAAuB,QA0B9B"}

package/dist/WSShared.js

@@ -0,0 +1,83 @@
+import * as CBOR from "cbor-x"
+import WebSocket from "isomorphic-ws"
+export function sendMessage(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
+  )
+  socket.send(arrayBuf)
+}
+function announceConnection(channelId, peerId, socket, self) {
+  // return a peer object
+  const myPeerId = self.peerId
+  if (!myPeerId) {
+    throw new Error("we should have a peer ID by now")
+  }
+  const connection = {
+    close: () => socket.close(),
+    isOpen: () => socket.readyState === WebSocket.OPEN,
+    send: message => sendMessage(socket, channelId, myPeerId, message),
+  }
+  self.emit("peer-candidate", { peerId, channelId, connection })
+}
+export function receiveMessageClient(message, self) {
+  const decoded = CBOR.decode(new Uint8Array(message))
+  const { type, senderId, channelId, data } = decoded
+  const client = self.client
+  if (!client) {
+    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}`)
+      announceConnection(channelId, senderId, client, self)
+      break
+    default:
+      self.emit("message", {
+        channelId,
+        senderId,
+        message: new Uint8Array(data),
+      })
+  }
+}
+export function receiveMessageServer(message, socket, self) {
+  const cbor = CBOR.decode(message)
+  console.log("received: ", cbor)
+  const { type, channelId, senderId, data } = cbor
+  switch (type) {
+    case "join":
+      announceConnection(channelId, senderId, socket, self)
+      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
+  }
+}

package/dist/encoder.d.ts

@@ -0,0 +1,4 @@
+import * as CBOR from "cbor-x"
+declare const _default: CBOR.Encoder
+export default _default
+//# sourceMappingURL=encoder.d.ts.map

package/dist/encoder.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"encoder.d.ts","sourceRoot":"","sources":["../src/encoder.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,IAAI,MAAM,QAAQ,CAAA;;AAE9B,wBAAuD"}

package/dist/encoder.js

@@ -0,0 +1,2 @@
+import * as CBOR from "cbor-x"
+export default new CBOR.Encoder({ tagUint8Array: false })

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@automerge/automerge-repo-network-websocket",
-  "version": "2.0.0-alpha.7",
+  "version": "2.0.0-collectionsync-alpha.1",
   "description": "isomorphic node/browser Websocket network adapter for Automerge Repo",
   "repository": "https://github.com/automerge/automerge-repo/tree/master/packages/automerge-repo-network-websocket",
   "author": "Peter van Hardenberg <pvh@pvh.ca>",
@@ -13,7 +13,7 @@
     "test": "vitest"
   },
   "dependencies": {
-    "@automerge/automerge-repo": "2.0.0-alpha.7",
+    "@automerge/automerge-repo": "2.0.0-collectionsync-alpha.1",
     "cbor-x": "^1.3.0",
     "debug": "^4.3.4",
     "eventemitter3": "^5.0.1",
@@ -31,5 +31,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "4279df7dad7ef5f33b1544e3945dab3839fa5ef6"
+  "gitHead": "0a639a7d57bcee4e0a87890e6592b9582c2a5d6f"
 }

package/src/NodeWSServerAdapter.ts

@@ -123,7 +123,14 @@ export class NodeWSServerAdapter extends NetworkAdapter {
   }
 
   receiveMessage(messageBytes: Uint8Array, socket: WebSocket) {
-    const message: FromClientMessage = decode(messageBytes)
+    let message: FromClientMessage
+    try {
+      message = decode(messageBytes)
+    } catch (e) {
+      log("invalid message received, closing connection")
+      socket.close()
+      return
+    }
 
     const { type, senderId } = message
 

package/test/Websocket.test.ts

@@ -338,6 +338,43 @@ describe("Websocket adapters", () => {
       await eventPromise(serverAdapter, "peer-disconnected")
     })
 
+    it("should disconnect from a client that sends an invalid CBOR message", async () => {
+      // Set up a server and wait for it to be ready
+      const port = await getPort()
+      const serverUrl = `ws://localhost:${port}`
+      const server = http.createServer()
+      const serverSocket = new WebSocket.Server({ server })
+      await new Promise<void>(resolve => server.listen(port, resolve))
+
+      // Create a repo listening on the socket
+      const serverAdapter = new NodeWSServerAdapter(serverSocket)
+      const serverRepo = new Repo({
+        network: [serverAdapter],
+        peerId: serverPeerId,
+      })
+
+      // Create a new socket connected to the repo
+      const browserSocket = new WebSocket(serverUrl)
+      await new Promise(resolve => browserSocket.on("open", resolve))
+      const disconnected = new Promise(resolve =>
+        browserSocket.on("close", resolve)
+      )
+
+      // Send an invalid CBOR message, in this case we use a definite length
+      // array with too many elements. This test should actually work for any
+      // invalid message but this reproduces a specific issue we were seeing on
+      // the sycn server
+      //
+      // 0x9 (1001) is major type 4, for an array
+      // 0xB (1011) indicates that the length will be encoded in the next 8 bytes
+      // 0x00, 0x00, 0x00, 0x01, 0x00, 0x00, 0x00, 0x00 is 2**32, which is longer than allowed
+      const invalidLargeArray = new Uint8Array([
+        0x9b, 0x00, 0x00, 0x00, 0x01, 0x00, 0x00, 0x00, 0x00,
+      ])
+      browserSocket.send(invalidLargeArray)
+      await disconnected
+    })
+
     it("should send the negotiated protocol version in its hello message", async () => {
       const response = await serverResponse({
         type: "join",