@automerge/automerge-repo-network-websocket 1.1.0-alpha.1 → 1.1.0-alpha.13

package/src/NodeWSServerAdapter.ts

@@ -7,49 +7,44 @@ const log = debug("WebsocketServer")
 import {
   cbor as cborHelpers,
   NetworkAdapter,
+  type PeerMetadata,
   type PeerId,
-  type StorageId,
 } from "@automerge/automerge-repo"
-import { FromClientMessage, FromServerMessage } from "./messages.js"
+import {
+  FromClientMessage,
+  FromServerMessage,
+  isJoinMessage,
+  isLeaveMessage,
+} from "./messages.js"
 import { ProtocolV1, ProtocolVersion } from "./protocolVersion.js"
+import assert from "assert"
+import { toArrayBuffer } from "./toArrayBuffer.js"
 
 const { encode, decode } = cborHelpers
 
-interface WebSocketWithIsAlive extends WebSocket {
-  isAlive: boolean
-}
-
 export class NodeWSServerAdapter extends NetworkAdapter {
-  server: WebSocketServer
   sockets: { [peerId: PeerId]: WebSocket } = {}
 
-  constructor(server: WebSocketServer) {
+  constructor(
+    private server: WebSocketServer,
+    private keepAliveInterval = 5000
+  ) {
     super()
-    this.server = server
   }
 
-  connect(
-    peerId: PeerId,
-    storageId: StorageId | undefined,
-    isEphemeral: boolean
-  ) {
+  connect(peerId: PeerId, peerMetadata: PeerMetadata) {
     this.peerId = peerId
-    this.storageId = storageId
-    this.isEphemeral = isEphemeral
+    this.peerMetadata = peerMetadata
 
-    this.server.on("close", function close() {
-      clearInterval(interval)
+    this.server.on("close", () => {
+      clearInterval(keepAliveId)
+      this.disconnect()
     })
 
     this.server.on("connection", (socket: WebSocketWithIsAlive) => {
       // When a socket closes, or disconnects, remove it from our list
       socket.on("close", () => {
-        for (const [otherPeerId, otherSocket] of Object.entries(this.sockets)) {
-          if (socket === otherSocket) {
-            this.emit("peer-disconnected", { peerId: otherPeerId as PeerId })
-            delete this.sockets[otherPeerId as PeerId]
-          }
-        }
+        this.#removeSocket(socket)
       })
 
       socket.on("message", message =>
@@ -63,138 +58,132 @@ export class NodeWSServerAdapter extends NetworkAdapter {
       this.emit("ready", { network: this })
     })
 
-    // Every interval, terminate connections to lost clients,
-    // then mark all clients as potentially dead and then ping them.
-    const interval = setInterval(() => {
-      ;(this.server.clients as Set<WebSocketWithIsAlive>).forEach(socket => {
-        if (socket.isAlive === false) {
-          // Make sure we clean up this socket even though we're terminating.
-          // This might be unnecessary but I have read reports of the close() not happening for 30s.
-          for (const [otherPeerId, otherSocket] of Object.entries(
-            this.sockets
-          )) {
-            if (socket === otherSocket) {
-              this.emit("peer-disconnected", { peerId: otherPeerId as PeerId })
-              delete this.sockets[otherPeerId as PeerId]
-            }
-          }
-          return socket.terminate()
+    const keepAliveId = setInterval(() => {
+      // Terminate connections to lost clients
+      const clients = this.server.clients as Set<WebSocketWithIsAlive>
+      clients.forEach(socket => {
+        if (socket.isAlive) {
+          // Mark all clients as potentially dead until we hear from them
+          socket.isAlive = false
+          socket.ping()
+        } else {
+          this.#terminate(socket)
         }
-        socket.isAlive = false
-        socket.ping()
       })
-    }, 5000)
+    }, this.keepAliveInterval)
   }
 
   disconnect() {
-    // throw new Error("The server doesn't join channels.")
+    const clients = this.server.clients as Set<WebSocketWithIsAlive>
+    clients.forEach(socket => {
+      this.#terminate(socket)
+      this.#removeSocket(socket)
+    })
   }
 
   send(message: FromServerMessage) {
-    if ("data" in message && message.data.byteLength === 0) {
-      throw new Error("tried to send a zero-length message")
-    }
+    assert("targetId" in message && message.targetId !== undefined)
+    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.")
-    }
+    assert(senderId, "No peerId set for the websocket server network adapter.")
+
+    const socket = this.sockets[message.targetId]
 
-    if (this.sockets[message.targetId] === undefined) {
-      log(`Tried to send message to disconnected peer: ${message.targetId}`)
+    if (!socket) {
+      log(`Tried to send to disconnected peer: ${message.targetId}`)
       return
     }
 
     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)
+    const arrayBuf = toArrayBuffer(encoded)
+
+    socket.send(arrayBuf)
   }
 
-  receiveMessage(message: Uint8Array, socket: WebSocket) {
-    const cbor: FromClientMessage = decode(message)
+  receiveMessage(messageBytes: Uint8Array, socket: WebSocket) {
+    const message: FromClientMessage = decode(messageBytes)
 
-    const { type, senderId } = cbor
+    const { type, senderId } = message
 
     const myPeerId = this.peerId
-    if (!myPeerId) {
-      throw new Error("Missing my peer ID.")
-    }
-    log(
-      `[${senderId}->${myPeerId}${
-        "documentId" in cbor ? "@" + cbor.documentId : ""
-      }] ${type} | ${message.byteLength} bytes`
-    )
-    switch (type) {
-      case "join":
-        {
-          const existingSocket = this.sockets[senderId]
-          if (existingSocket) {
-            if (existingSocket.readyState === WebSocket.OPEN) {
-              existingSocket.close()
-            }
-            this.emit("peer-disconnected", { peerId: senderId })
-          }
-
-          const { storageId, isEphemeral } = cbor
-          // Let the rest of the system know that we have a new connection.
-          this.emit("peer-candidate", {
-            peerId: senderId,
-            storageId,
-            isEphemeral,
-          })
-          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(
-            cbor.supportedProtocolVersions
-          )
-          if (selectedProtocolVersion === null) {
-            this.send({
-              type: "error",
-              senderId: this.peerId!,
-              message: "unsupported protocol version",
-              targetId: senderId,
-            })
-            this.sockets[senderId].close()
-            delete this.sockets[senderId]
-          } else {
-            this.send({
-              type: "peer",
-              senderId: this.peerId!,
-              storageId: this.storageId,
-              isEphemeral: this.isEphemeral,
-              selectedProtocolVersion: ProtocolV1,
-              targetId: senderId,
-            })
-          }
+    assert(myPeerId)
+
+    const documentId = "documentId" in message ? "@" + message.documentId : ""
+    const { byteLength } = messageBytes
+    log(`[${senderId}->${myPeerId}${documentId}] ${type} | ${byteLength} bytes`)
+
+    if (isJoinMessage(message)) {
+      const { peerMetadata, supportedProtocolVersions } = message
+      const existingSocket = this.sockets[senderId]
+      if (existingSocket) {
+        if (existingSocket.readyState === WebSocket.OPEN) {
+          existingSocket.close()
         }
-        break
-      case "leave":
-        // It doesn't seem like this gets called;
-        // we handle leaving in the socket close logic
-        // TODO: confirm this
-        // ?
-        break
-
-      default:
-        this.emit("message", cbor)
-        break
+        this.emit("peer-disconnected", { peerId: senderId })
+      }
+
+      // Let the repo know that we have a new connection.
+      this.emit("peer-candidate", { peerId: senderId, peerMetadata })
+      this.sockets[senderId] = socket
+
+      const selectedProtocolVersion = selectProtocol(supportedProtocolVersions)
+      if (selectedProtocolVersion === null) {
+        this.send({
+          type: "error",
+          senderId: this.peerId!,
+          message: "unsupported protocol version",
+          targetId: senderId,
+        })
+        this.sockets[senderId].close()
+        delete this.sockets[senderId]
+      } else {
+        this.send({
+          type: "peer",
+          senderId: this.peerId!,
+          peerMetadata: this.peerMetadata!,
+          selectedProtocolVersion: ProtocolV1,
+          targetId: senderId,
+        })
+      }
+    } else if (isLeaveMessage(message)) {
+      const { senderId } = message
+      const socket = this.sockets[senderId]
+      /* c8 ignore next */
+      if (!socket) return
+      this.#terminate(socket as WebSocketWithIsAlive)
+    } else {
+      this.emit("message", message)
     }
   }
-}
 
-function selectProtocol(versions?: ProtocolVersion[]): ProtocolVersion | null {
-  if (versions === undefined) {
-    return ProtocolV1
+  #terminate(socket: WebSocketWithIsAlive) {
+    this.#removeSocket(socket)
+    socket.terminate()
   }
-  if (versions.includes(ProtocolV1)) {
-    return ProtocolV1
+
+  #removeSocket(socket: WebSocketWithIsAlive) {
+    const peerId = this.#peerIdBySocket(socket)
+    if (!peerId) return
+    this.emit("peer-disconnected", { peerId })
+    delete this.sockets[peerId as PeerId]
+  }
+
+  #peerIdBySocket = (socket: WebSocket) => {
+    const isThisSocket = (peerId: string) =>
+      this.sockets[peerId as PeerId] === socket
+    const result = Object.keys(this.sockets).find(isThisSocket) as PeerId
+    return result ?? null
   }
+}
+
+const selectProtocol = (versions?: ProtocolVersion[]) => {
+  if (versions === undefined) return ProtocolV1
+  if (versions.includes(ProtocolV1)) return ProtocolV1
   return null
 }
+
+interface WebSocketWithIsAlive extends WebSocket {
+  isAlive: boolean
+}

package/src/assert.ts

@@ -0,0 +1,28 @@
+/* c8 ignore start */
+
+export function assert(value: boolean, message?: string): asserts value
+export function assert<T>(
+  value: T | undefined,
+  message?: string
+): asserts value is T
+export function assert(value: any, message = "Assertion failed") {
+  if (value === false || value === null || value === undefined) {
+    const error = new Error(trimLines(message))
+    error.stack = removeLine(error.stack, "assert.ts")
+    throw error
+  }
+}
+
+const trimLines = (s: string) =>
+  s
+    .split("\n")
+    .map(s => s.trim())
+    .join("\n")
+
+const removeLine = (s = "", targetText: string) =>
+  s
+    .split("\n")
+    .filter(line => !line.includes(targetText))
+    .join("\n")
+
+/* c8 ignore end */

package/src/messages.ts

@@ -1,4 +1,4 @@
-import type { Message, PeerId, StorageId } from "@automerge/automerge-repo"
+import type { Message, PeerId, PeerMetadata } from "@automerge/automerge-repo"
 import type { ProtocolVersion } from "./protocolVersion.js"
 
 /** The sender is disconnecting */
@@ -13,12 +13,8 @@ export type JoinMessage = {
   /** The PeerID of the client */
   senderId: PeerId
 
-  /** Unique ID of the storage that the sender peer is using, is persistent across sessions */
-  storageId?: StorageId
-
-  /** Indicates whether other peers should persist the sync state of the sender peer.
-   * Sync state is only persisted for non-ephemeral peers */
-  isEphemeral: boolean
+  /** Metadata presented by the peer  */
+  peerMetadata: PeerMetadata
 
   /** The protocol version the client supports */
   supportedProtocolVersions: ProtocolVersion[]
@@ -30,12 +26,8 @@ export type PeerMessage = {
   /** The PeerID of the server */
   senderId: PeerId
 
-  /** Unique ID of the storage that the sender peer is using, is persistent across sessions */
-  storageId?: StorageId
-
-  /** Indicates whether other peers should persist the sync state of the sender peer.
-   * Sync state is only persisted for non-ephemeral peers */
-  isEphemeral: boolean
+  /** Metadata presented by the peer  */
+  peerMetadata: PeerMetadata
 
   /** The protocol version the server selected for this connection */
   selectedProtocolVersion: ProtocolVersion
@@ -54,11 +46,26 @@ export type ErrorMessage = {
   targetId: PeerId
 }
 
-// This adapter doesn't use the network adapter Message types, it has its own idea of how to handle
-// join/leave
-
 /** A message from the client to the server */
 export type FromClientMessage = JoinMessage | LeaveMessage | Message
 
 /** A message from the server to the client */
 export type FromServerMessage = PeerMessage | ErrorMessage | Message
+
+// TYPE GUARDS
+
+export const isJoinMessage = (
+  message: FromClientMessage
+): message is JoinMessage => message.type === "join"
+
+export const isLeaveMessage = (
+  message: FromClientMessage
+): message is LeaveMessage => message.type === "leave"
+
+export const isPeerMessage = (
+  message: FromServerMessage
+): message is PeerMessage => message.type === "peer"
+
+export const isErrorMessage = (
+  message: FromServerMessage
+): message is ErrorMessage => message.type === "error"

package/src/toArrayBuffer.ts

@@ -0,0 +1,8 @@
+/**
+ * This incantation deals with websocket sending the whole underlying buffer even if we just have a
+ * uint8array view on it
+ */
+export const toArrayBuffer = (bytes: Uint8Array) => {
+  const { buffer, byteOffset, byteLength } = bytes
+  return buffer.slice(byteOffset, byteOffset + byteLength)
+}