@automerge/automerge-repo-network-websocket 1.0.7 → 1.0.9

package/dist/BrowserWebSocketClientAdapter.d.ts

@@ -11,6 +11,9 @@ export declare class BrowserWebSocketClientAdapter extends WebSocketNetworkAdapt
     url: string;
     constructor(url: string);
     connect(peerId: PeerId): void;
+    onOpen: () => void;
+    onClose: () => void;
+    onMessage: (event: WebSocket.MessageEvent) => void;
     join(): void;
     disconnect(): void;
     send(message: FromClientMessage): void;

package/dist/BrowserWebSocketClientAdapter.d.ts.map

@@ -1 +1 @@
-{"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;IA0CtB,IAAI;IAoBJ,UAAU;IAOV,IAAI,CAAC,OAAO,EAAE,iBAAiB;IAwB/B,kBAAkB,CAAC,MAAM,EAAE,MAAM;IAajC,cAAc,CAAC,OAAO,EAAE,UAAU;CA6BnC"}
+{"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;IAkCtB,MAAM,aAKL;IAGD,OAAO,aAON;IAED,SAAS,UAAW,sBAAsB,UAEzC;IAED,IAAI;IAWJ,UAAU;IAOV,IAAI,CAAC,OAAO,EAAE,iBAAiB;IAwB/B,kBAAkB,CAAC,MAAM,EAAE,MAAM;IAajC,cAAc,CAAC,OAAO,EAAE,UAAU;CA6BnC"}

package/dist/BrowserWebSocketClientAdapter.js

@@ -18,27 +18,22 @@ export class BrowserWebSocketClientAdapter extends WebSocketNetworkAdapter {
         this.url = url;
     }
     connect(peerId) {
-        this.socket?.removeAllListeners();
+        // If we're reconnecting  make sure we remove the old event listeners
+        // before creating a new connection.
+        if (this.socket) {
+            this.socket.removeEventListener("open", this.onOpen);
+            this.socket.removeEventListener("close", this.onClose);
+            this.socket.removeEventListener("message", this.onMessage);
+        }
         if (!this.timerId) {
             this.timerId = setInterval(() => this.connect(peerId), 5000);
         }
         this.peerId = peerId;
         this.socket = new WebSocket(this.url);
         this.socket.binaryType = "arraybuffer";
-        this.socket.addEventListener("open", () => {
-            log(`@ ${this.url}: open`);
-            clearInterval(this.timerId);
-            this.timerId = undefined;
-        });
-        // When a socket closes, or disconnects, remove it from the array.
-        this.socket.addEventListener("close", () => {
-            log(`${this.url}: close`);
-            if (!this.timerId) {
-                this.connect(peerId);
-            }
-            // log("Disconnected from server")
-        });
-        this.socket.addEventListener("message", (event) => this.receiveMessage(event.data));
+        this.socket.addEventListener("open", this.onOpen);
+        this.socket.addEventListener("close", this.onClose);
+        this.socket.addEventListener("message", this.onMessage);
         // 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
@@ -50,6 +45,24 @@ export class BrowserWebSocketClientAdapter extends WebSocketNetworkAdapter {
         }, 1000);
         this.join();
     }
+    onOpen = () => {
+        log(`@ ${this.url}: open`);
+        clearInterval(this.timerId);
+        this.timerId = undefined;
+        this.send(joinMessage(this.peerId));
+    };
+    // When a socket closes, or disconnects, remove it from the array.
+    onClose = () => {
+        log(`${this.url}: close`);
+        if (!this.timerId) {
+            if (this.peerId) {
+                this.connect(this.peerId);
+            }
+        }
+    };
+    onMessage = (event) => {
+        this.receiveMessage(event.data);
+    };
     join() {
         if (!this.socket) {
             throw new Error("WTF, get a socket");
@@ -58,12 +71,7 @@ export class BrowserWebSocketClientAdapter extends WebSocketNetworkAdapter {
             this.send(joinMessage(this.peerId));
         }
         else {
-            this.socket.addEventListener("open", () => {
-                if (!this.socket) {
-                    throw new Error("WTF, get a socket");
-                }
-                this.send(joinMessage(this.peerId));
-            }, { once: true });
+            // The onOpen handler automatically sends a join message
         }
     }
     disconnect() {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@automerge/automerge-repo-network-websocket",
-  "version": "1.0.7",
+  "version": "1.0.9",
   "description": "isomorphic node/browser Websocket network adapter for Automerge Repo",
   "peerDependencies": {
     "@automerge/automerge": "^2.1.0"
@@ -16,7 +16,7 @@
     "test": "vitest"
   },
   "dependencies": {
-    "@automerge/automerge-repo": "^1.0.7",
+    "@automerge/automerge-repo": "^1.0.9",
     "cbor-x": "^1.3.0",
     "eventemitter3": "^5.0.1",
     "isomorphic-ws": "^5.0.0",
@@ -33,5 +33,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "71060981f168e511a99ab85b155a54a13fd04bcc"
+  "gitHead": "c277a6e8546cdd14236070d033ca62db68dfdeb3"
 }

package/src/BrowserWebSocketClientAdapter.ts

@@ -31,7 +31,14 @@ export class BrowserWebSocketClientAdapter extends WebSocketNetworkAdapter {
   }
 
   connect(peerId: PeerId) {
-    this.socket?.removeAllListeners()
+    // If we're reconnecting  make sure we remove the old event listeners
+    // before creating a new connection.
+    if (this.socket) {
+      this.socket.removeEventListener("open", this.onOpen)
+      this.socket.removeEventListener("close", this.onClose)
+      this.socket.removeEventListener("message", this.onMessage)
+    }
+
     if (!this.timerId) {
       this.timerId = setInterval(() => this.connect(peerId), 5000)
     }
@@ -40,24 +47,9 @@ export class BrowserWebSocketClientAdapter extends WebSocketNetworkAdapter {
     this.socket = new WebSocket(this.url)
     this.socket.binaryType = "arraybuffer"
 
-    this.socket.addEventListener("open", () => {
-      log(`@ ${this.url}: open`)
-      clearInterval(this.timerId)
-      this.timerId = undefined
-    })
-
-    // When a socket closes, or disconnects, remove it from the array.
-    this.socket.addEventListener("close", () => {
-      log(`${this.url}: close`)
-      if (!this.timerId) {
-        this.connect(peerId)
-      }
-      // log("Disconnected from server")
-    })
-
-    this.socket.addEventListener("message", (event: WebSocket.MessageEvent) =>
-      this.receiveMessage(event.data as Uint8Array)
-    )
+    this.socket.addEventListener("open", this.onOpen)
+    this.socket.addEventListener("close", this.onClose)
+    this.socket.addEventListener("message", this.onMessage)
 
     // 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
@@ -72,6 +64,27 @@ export class BrowserWebSocketClientAdapter extends WebSocketNetworkAdapter {
     this.join()
   }
 
+  onOpen = () => {
+    log(`@ ${this.url}: open`)
+    clearInterval(this.timerId)
+    this.timerId = undefined
+    this.send(joinMessage(this.peerId!))
+  }
+
+  // When a socket closes, or disconnects, remove it from the array.
+  onClose = () => {
+    log(`${this.url}: close`)
+    if (!this.timerId) {
+      if (this.peerId) {
+        this.connect(this.peerId)
+      }
+    }
+  }
+
+  onMessage = (event: WebSocket.MessageEvent) => {
+    this.receiveMessage(event.data as Uint8Array)
+  }
+
   join() {
     if (!this.socket) {
       throw new Error("WTF, get a socket")
@@ -79,16 +92,7 @@ export class BrowserWebSocketClientAdapter extends WebSocketNetworkAdapter {
     if (this.socket.readyState === WebSocket.OPEN) {
       this.send(joinMessage(this.peerId!))
     } else {
-      this.socket.addEventListener(
-        "open",
-        () => {
-          if (!this.socket) {
-            throw new Error("WTF, get a socket")
-          }
-          this.send(joinMessage(this.peerId!))
-        },
-        { once: true }
-      )
+      // The onOpen handler automatically sends a join message
     }
   }
 

package/test/Websocket.test.ts

@@ -105,6 +105,37 @@ describe("The NodeWSServerAdapter", () => {
       selectedProtocolVersion: "1",
     })
   })
+  
+  it("should correctly clear event handlers on reconnect", async () => {
+    // This reproduces an issue where the BrowserWebSocketClientAdapter.connect
+    // call registered event handlers on the websocket but didn't clear them
+    // up again on a second call to connect. This combined with the reconnect
+    // timer to produce the following sequence of events:
+    //
+    // * first call to connect creates a socket and registers an "open"
+    //   handler. The "open" handler will attempt to send a join message
+    // * The connection is slow, so the reconnect timer fires before "open",
+    //   the reconnect timer calls connect again. this.socket is now a new socket
+    // * The other end replies to the first socket, "open"
+    // * The original "open" handler attempts to send a message, but on the new
+    //   socket (because it uses this.socket), which isn't open yet, so we get an
+    //   error that the socket is not ready
+    const { socket, server } = await startServer(0)
+    let port = (server.address()!! as AddressInfo).port
+    const serverUrl = `ws://localhost:${port}`
+    const serverAdapter = new NodeWSServerAdapter(socket)
+    const browserAdapter = new BrowserWebSocketClientAdapter(serverUrl)
+
+    const peerId = "testclient" as PeerId
+    browserAdapter.connect(peerId)
+    // simulate the reconnect timer firing before the other end has responded
+    // (which works here because we haven't yielded to the event loop yet so
+    // the server, which is on the same event loop as us, can't respond)
+    browserAdapter.connect(peerId)
+    // Now await, so the server responds on the first socket, if the listeners
+    // are cleaned up correctly we shouldn't throw
+    await pause(1)
+  })
 })
 
 async function serverHelloGivenClientHello(
@@ -144,3 +175,6 @@ async function firstMessage(
     })
   })
 }
+
+export const pause = (t = 0) =>
+  new Promise<void>(resolve => setTimeout(() => resolve(), t))