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

package/dist/messages.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"messages.d.ts","sourceRoot":"","sources":["../src/messages.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAA;AAC3E,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AAE3D,kCAAkC;AAClC,MAAM,MAAM,YAAY,GAAG;IACzB,IAAI,EAAE,OAAO,CAAA;IACb,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,6EAA6E;AAC7E,MAAM,MAAM,WAAW,GAAG;IACxB,IAAI,EAAE,MAAM,CAAA;IACZ,+BAA+B;IAC/B,QAAQ,EAAE,MAAM,CAAA;IAEhB,4FAA4F;IAC5F,SAAS,CAAC,EAAE,SAAS,CAAA;IAErB;8DAC0D;IAC1D,WAAW,EAAE,OAAO,CAAA;IAEpB,+CAA+C;IAC/C,yBAAyB,EAAE,eAAe,EAAE,CAAA;CAC7C,CAAA;AAED,yFAAyF;AACzF,MAAM,MAAM,WAAW,GAAG;IACxB,IAAI,EAAE,MAAM,CAAA;IACZ,+BAA+B;IAC/B,QAAQ,EAAE,MAAM,CAAA;IAEhB,4FAA4F;IAC5F,SAAS,CAAC,EAAE,SAAS,CAAA;IAErB;8DAC0D;IAC1D,WAAW,EAAE,OAAO,CAAA;IAEpB,mEAAmE;IACnE,uBAAuB,EAAE,eAAe,CAAA;IACxC,+BAA+B;IAC/B,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,gGAAgG;AAChG,MAAM,MAAM,YAAY,GAAG;IACzB,IAAI,EAAE,OAAO,CAAA;IACb,mCAAmC;IACnC,QAAQ,EAAE,MAAM,CAAA;IAChB,gCAAgC;IAChC,OAAO,EAAE,MAAM,CAAA;IACf,+BAA+B;IAC/B,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AAKD,8CAA8C;AAC9C,MAAM,MAAM,iBAAiB,GAAG,WAAW,GAAG,YAAY,GAAG,OAAO,CAAA;AAEpE,8CAA8C;AAC9C,MAAM,MAAM,iBAAiB,GAAG,WAAW,GAAG,YAAY,GAAG,OAAO,CAAA"}
+{"version":3,"file":"messages.d.ts","sourceRoot":"","sources":["../src/messages.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAA;AAC9E,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AAE3D,kCAAkC;AAClC,MAAM,MAAM,YAAY,GAAG;IACzB,IAAI,EAAE,OAAO,CAAA;IACb,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,6EAA6E;AAC7E,MAAM,MAAM,WAAW,GAAG;IACxB,IAAI,EAAE,MAAM,CAAA;IACZ,+BAA+B;IAC/B,QAAQ,EAAE,MAAM,CAAA;IAEhB,sCAAsC;IACtC,YAAY,EAAE,YAAY,CAAA;IAE1B,+CAA+C;IAC/C,yBAAyB,EAAE,eAAe,EAAE,CAAA;CAC7C,CAAA;AAED,yFAAyF;AACzF,MAAM,MAAM,WAAW,GAAG;IACxB,IAAI,EAAE,MAAM,CAAA;IACZ,+BAA+B;IAC/B,QAAQ,EAAE,MAAM,CAAA;IAEhB,sCAAsC;IACtC,YAAY,EAAE,YAAY,CAAA;IAE1B,mEAAmE;IACnE,uBAAuB,EAAE,eAAe,CAAA;IACxC,+BAA+B;IAC/B,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,gGAAgG;AAChG,MAAM,MAAM,YAAY,GAAG;IACzB,IAAI,EAAE,OAAO,CAAA;IACb,mCAAmC;IACnC,QAAQ,EAAE,MAAM,CAAA;IAChB,gCAAgC;IAChC,OAAO,EAAE,MAAM,CAAA;IACf,+BAA+B;IAC/B,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,8CAA8C;AAC9C,MAAM,MAAM,iBAAiB,GAAG,WAAW,GAAG,YAAY,GAAG,OAAO,CAAA;AAEpE,8CAA8C;AAC9C,MAAM,MAAM,iBAAiB,GAAG,WAAW,GAAG,YAAY,GAAG,OAAO,CAAA;AAIpE,eAAO,MAAM,aAAa,YACf,iBAAiB,2BACwB,CAAA;AAEpD,eAAO,MAAM,cAAc,YAChB,iBAAiB,4BAC0B,CAAA;AAEtD,eAAO,MAAM,aAAa,YACf,iBAAiB,2BACwB,CAAA;AAEpD,eAAO,MAAM,cAAc,YAChB,iBAAiB,4BAC0B,CAAA"}

package/dist/messages.js

@@ -1 +1,5 @@
-export {};
+// TYPE GUARDS
+export const isJoinMessage = (message) => message.type === "join";
+export const isLeaveMessage = (message) => message.type === "leave";
+export const isPeerMessage = (message) => message.type === "peer";
+export const isErrorMessage = (message) => message.type === "error";

package/dist/toArrayBuffer.d.ts

@@ -0,0 +1,6 @@
+/**
+ * This incantation deals with websocket sending the whole underlying buffer even if we just have a
+ * uint8array view on it
+ */
+export declare const toArrayBuffer: (bytes: Uint8Array) => ArrayBuffer;
+//# sourceMappingURL=toArrayBuffer.d.ts.map

package/dist/toArrayBuffer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"toArrayBuffer.d.ts","sourceRoot":"","sources":["../src/toArrayBuffer.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,eAAO,MAAM,aAAa,UAAW,UAAU,gBAG9C,CAAA"}

package/dist/toArrayBuffer.js

@@ -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) => {
+    const { buffer, byteOffset, byteLength } = bytes;
+    return buffer.slice(byteOffset, byteOffset + byteLength);
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@automerge/automerge-repo-network-websocket",
-  "version": "1.1.0-alpha.1",
+  "version": "1.1.0-alpha.13",
   "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,8 +13,9 @@
     "test": "vitest"
   },
   "dependencies": {
-    "@automerge/automerge-repo": "^1.1.0-alpha.1",
+    "@automerge/automerge-repo": "1.1.0-alpha.13",
     "cbor-x": "^1.3.0",
+    "debug": "^4.3.4",
     "eventemitter3": "^5.0.1",
     "isomorphic-ws": "^5.0.0",
     "ws": "^8.7.0"
@@ -30,5 +31,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "11805d698f860bd6ffb3ca028d3b57e718690b5a"
+  "gitHead": "f4ce1376d900ad98f00a638626be9611077460b5"
 }

package/src/BrowserWebSocketClientAdapter.ts

@@ -1,8 +1,8 @@
 import {
   NetworkAdapter,
-  type PeerId,
+  PeerId,
+  PeerMetadata,
   cbor,
-  type StorageId,
 } from "@automerge/automerge-repo"
 import WebSocket from "isomorphic-ws"
 
@@ -12,199 +12,177 @@ import {
   FromClientMessage,
   FromServerMessage,
   JoinMessage,
-  PeerMessage,
+  isErrorMessage,
+  isPeerMessage,
 } from "./messages.js"
 import { ProtocolV1 } from "./protocolVersion.js"
-
-const log = debug("WebsocketClient")
+import { assert } from "./assert.js"
+import { toArrayBuffer } from "./toArrayBuffer.js"
 
 abstract class WebSocketNetworkAdapter extends NetworkAdapter {
   socket?: WebSocket
 }
 
 export class BrowserWebSocketClientAdapter extends WebSocketNetworkAdapter {
-  // Type trickery required for platform independence,
-  // see https://stackoverflow.com/questions/45802988/typescript-use-correct-version-of-settimeout-node-vs-window
-  timerId?: ReturnType<typeof setTimeout>
-  remotePeerId?: PeerId // this adapter only connects to one remote client at a time
-  #startupComplete: boolean = false
+  #isReady: boolean = false
+  #retryIntervalId?: TimeoutId
+  #log = debug("automerge-repo:websocket:browser")
 
-  url: string
+  remotePeerId?: PeerId // this adapter only connects to one remote client at a time
 
-  constructor(url: string) {
+  constructor(
+    public readonly url: string,
+    public readonly retryInterval = 5000
+  ) {
     super()
-    this.url = url
+    this.#log = this.#log.extend(url)
   }
 
-  connect(
-    peerId: PeerId,
-    storageId: StorageId | undefined,
-    isEphemeral: boolean
-  ) {
-    // If we're reconnecting  make sure we remove the old event listeners
-    // before creating a new connection.
-    if (this.socket) {
+  connect(peerId: PeerId, peerMetadata?: PeerMetadata) {
+    if (!this.socket || !this.peerId) {
+      // first time connecting
+      this.#log("connecting")
+      this.peerId = peerId
+      this.peerMetadata = peerMetadata ?? {}
+    } else {
+      this.#log("reconnecting")
+      assert(peerId === this.peerId)
+      // Remove the old event listeners before creating a new connection.
       this.socket.removeEventListener("open", this.onOpen)
       this.socket.removeEventListener("close", this.onClose)
       this.socket.removeEventListener("message", this.onMessage)
+      this.socket.removeEventListener("error", this.onError)
     }
+    // Wire up retries
+    if (!this.#retryIntervalId)
+      this.#retryIntervalId = setInterval(() => {
+        this.connect(peerId, peerMetadata)
+      }, this.retryInterval)
 
-    if (!this.timerId) {
-      this.timerId = setInterval(
-        () => this.connect(peerId, storageId, isEphemeral),
-        5000
-      )
-    }
-
-    this.peerId = peerId
-    this.storageId = storageId
-    this.isEphemeral = isEphemeral
     this.socket = new WebSocket(this.url)
+
     this.socket.binaryType = "arraybuffer"
 
     this.socket.addEventListener("open", this.onOpen)
     this.socket.addEventListener("close", this.onClose)
     this.socket.addEventListener("message", this.onMessage)
+    this.socket.addEventListener("error", this.onError)
 
-    // mark this adapter as ready if we haven't received an ack in 1 second.
+    // 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)
-
+    setTimeout(() => this.#ready(), 1000)
     this.join()
   }
 
   onOpen = () => {
-    log(`@ ${this.url}: open`)
-    clearInterval(this.timerId)
-    this.timerId = undefined
-    this.send(joinMessage(this.peerId!, this.storageId, this.isEphemeral))
+    this.#log("open")
+    clearInterval(this.#retryIntervalId)
+    this.#retryIntervalId = undefined
+    this.join()
   }
 
   // When a socket closes, or disconnects, remove it from the array.
   onClose = () => {
-    log(`${this.url}: close`)
-
-    if (this.remotePeerId) {
+    this.#log("close")
+    if (this.remotePeerId)
       this.emit("peer-disconnected", { peerId: this.remotePeerId })
-    }
 
-    if (!this.timerId) {
-      if (this.peerId) {
-        this.connect(this.peerId, this.storageId, this.isEphemeral)
-      }
-    }
+    if (this.retryInterval > 0 && !this.#retryIntervalId)
+      // try to reconnect
+      setTimeout(() => {
+        assert(this.peerId)
+        return this.connect(this.peerId, this.peerMetadata)
+      }, this.retryInterval)
   }
 
   onMessage = (event: WebSocket.MessageEvent) => {
     this.receiveMessage(event.data as Uint8Array)
   }
 
-  join() {
-    if (!this.socket) {
-      throw new Error("WTF, get a socket")
+  onError = (event: WebSocket.ErrorEvent) => {
+    const { code } = event.error
+    if (code === "ECONNREFUSED") {
+      this.#log("Connection refused, retrying...")
+    } else {
+      /* c8 ignore next */
+      throw event.error
     }
+  }
+
+  #ready() {
+    if (this.#isReady) return
+    this.#isReady = true
+    this.emit("ready", { network: this })
+  }
+
+  join() {
+    assert(this.peerId)
+    assert(this.socket)
     if (this.socket.readyState === WebSocket.OPEN) {
-      this.send(joinMessage(this.peerId!, this.storageId, this.isEphemeral))
+      this.send(joinMessage(this.peerId!, this.peerMetadata!))
     } else {
-      // The onOpen handler automatically sends a join message
+      // We'll try again in the `onOpen` handler
     }
   }
 
   disconnect() {
-    if (!this.socket) {
-      throw new Error("WTF, get a socket")
-    }
-    this.send({ type: "leave", senderId: this.peerId! })
+    assert(this.peerId)
+    assert(this.socket)
+    this.send({ type: "leave", senderId: this.peerId })
   }
 
   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?")
-    }
-
-    if (!this.socket || this.socket.readyState !== WebSocket.OPEN) {
-      throw new Error("Websocket Socket not ready!")
-    }
+    if ("data" in message && message.data?.byteLength === 0)
+      throw new Error("Tried to send a zero-length message")
+    assert(this.peerId)
+    assert(this.socket)
+    if (this.socket.readyState !== WebSocket.OPEN)
+      throw new Error(`Websocket not ready (${this.socket.readyState})`)
 
     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)
+    this.socket.send(toArrayBuffer(encoded))
   }
 
-  announceConnection(
-    peerId: PeerId,
-    storageId: StorageId | undefined,
-    isEphemeral: boolean
-  ) {
-    // return a peer object
-    const myPeerId = this.peerId
-    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.remotePeerId = peerId
-    this.emit("peer-candidate", { peerId, storageId, isEphemeral })
+  peerCandidate(remotePeerId: PeerId, peerMetadata: PeerMetadata) {
+    assert(this.socket)
+    this.#ready()
+    this.remotePeerId = remotePeerId
+    this.emit("peer-candidate", {
+      peerId: remotePeerId,
+      peerMetadata,
+    })
   }
 
-  receiveMessage(message: Uint8Array) {
-    const decoded: FromServerMessage = cbor.decode(new Uint8Array(message))
+  receiveMessage(messageBytes: Uint8Array) {
+    const message: FromServerMessage = cbor.decode(new Uint8Array(messageBytes))
 
-    const { type, senderId } = decoded
-
-    const socket = this.socket
-    if (!socket) {
-      throw new Error("Missing socket at receiveMessage")
-    }
-
-    if (message.byteLength === 0) {
+    assert(this.socket)
+    if (messageBytes.byteLength === 0)
       throw new Error("received a zero-length message")
-    }
 
-    switch (type) {
-      case "peer": {
-        const { storageId, isEphemeral } = decoded
-        log(`peer: ${senderId}`)
-        this.announceConnection(senderId, storageId, isEphemeral)
-        break
-      }
-      case "error":
-        log(`error: ${decoded.message}`)
-        break
-      default:
-        this.emit("message", decoded)
+    if (isPeerMessage(message)) {
+      const { peerMetadata } = message
+      this.#log(`peer: ${message.senderId}`)
+      this.peerCandidate(message.senderId, peerMetadata)
+    } else if (isErrorMessage(message)) {
+      this.#log(`error: ${message.message}`)
+    } else {
+      this.emit("message", message)
     }
   }
 }
 
 function joinMessage(
   senderId: PeerId,
-  storageId: StorageId | undefined,
-  isEphemeral: boolean
+  peerMetadata: PeerMetadata
 ): JoinMessage {
   return {
     type: "join",
     senderId,
-    storageId,
-    isEphemeral,
+    peerMetadata,
     supportedProtocolVersions: [ProtocolV1],
   }
 }
+
+type TimeoutId = ReturnType<typeof setTimeout> //  https://stackoverflow.com/questions/45802988