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

package/dist/BrowserWebSocketClientAdapter.js

@@ -2,7 +2,7 @@ import { NetworkAdapter, cbor } from "@automerge/automerge-repo";
 import WebSocket from "isomorphic-ws";
 import debug from "debug";
 import { ProtocolV1 } from "./protocolVersion.js";
-import { isValidMessage } from "@automerge/automerge-repo";
+import { isValidRepoMessage } from "@automerge/automerge-repo";
 const log = debug("WebsocketClient");
 class WebSocketNetworkAdapter extends NetworkAdapter {
     socket;
@@ -18,6 +18,7 @@ export class BrowserWebSocketClientAdapter extends WebSocketNetworkAdapter {
         this.url = url;
     }
     connect(peerId) {
+        this.socket?.removeAllListeners();
         if (!this.timerId) {
             this.timerId = setInterval(() => this.connect(peerId), 5000);
         }
@@ -28,7 +29,6 @@ export class BrowserWebSocketClientAdapter extends WebSocketNetworkAdapter {
             log(`@ ${this.url}: open`);
             clearInterval(this.timerId);
             this.timerId = undefined;
-            this.join();
         });
         // When a socket closes, or disconnects, remove it from the array.
         this.socket.addEventListener("close", () => {
@@ -119,7 +119,7 @@ export class BrowserWebSocketClientAdapter extends WebSocketNetworkAdapter {
                 log(`error: ${decoded.message}`);
                 break;
             default:
-                if (!isValidMessage(decoded)) {
+                if (!isValidRepoMessage(decoded)) {
                     throw new Error("Invalid message received");
                 }
                 this.emit("message", decoded);

package/dist/NodeWSServerAdapter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"NodeWSServerAdapter.d.ts","sourceRoot":"","sources":["../src/NodeWSServerAdapter.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,SAAS,EAAE,KAAK,eAAe,EAAE,MAAM,eAAe,CAAA;AAK/D,OAAO,EAEL,cAAc,EACd,KAAK,MAAM,EACZ,MAAM,2BAA2B,CAAA;AAClC,OAAO,EAAqB,iBAAiB,EAAE,MAAM,eAAe,CAAA;AAKpE,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;IAoBtB,UAAU;IAIV,IAAI,CAAC,OAAO,EAAE,iBAAiB;IAyB/B,cAAc,CAAC,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,SAAS;CAuDtD"}
+{"version":3,"file":"NodeWSServerAdapter.d.ts","sourceRoot":"","sources":["../src/NodeWSServerAdapter.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,SAAS,EAAE,KAAK,eAAe,EAAE,MAAM,eAAe,CAAA;AAK/D,OAAO,EAEL,cAAc,EACd,KAAK,MAAM,EACZ,MAAM,2BAA2B,CAAA;AAClC,OAAO,EAAqB,iBAAiB,EAAE,MAAM,eAAe,CAAA;AASpE,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;IAoDtB,UAAU;IAIV,IAAI,CAAC,OAAO,EAAE,iBAAiB;IAyB/B,cAAc,CAAC,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,SAAS;CAuDtD"}

package/dist/NodeWSServerAdapter.js

@@ -12,7 +12,10 @@ export class NodeWSServerAdapter extends NetworkAdapter {
     }
     connect(peerId) {
         this.peerId = peerId;
-        this.server.on("connection", socket => {
+        this.server.on("close", function close() {
+            clearInterval(interval);
+        });
+        this.server.on("connection", (socket) => {
             // When a socket closes, or disconnects, remove it from our list
             socket.on("close", () => {
                 for (const [otherPeerId, otherSocket] of Object.entries(this.sockets)) {
@@ -23,8 +26,31 @@ export class NodeWSServerAdapter extends NetworkAdapter {
                 }
             });
             socket.on("message", message => this.receiveMessage(message, socket));
+            // Start out "alive", and every time we get a pong, reset that state.
+            socket.isAlive = true;
+            socket.on("pong", () => (socket.isAlive = true));
             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.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 });
+                            delete this.sockets[otherPeerId];
+                        }
+                    }
+                    return socket.terminate();
+                }
+                socket.isAlive = false;
+                socket.ping();
+            });
+        }, 30000);
     }
     disconnect() {
         // throw new Error("The server doesn't join channels.")

package/dist/messages.d.ts

@@ -1,4 +1,4 @@
-import { type Message, type PeerId } from "@automerge/automerge-repo";
+import { type RepoMessage, type PeerId } from "@automerge/automerge-repo";
 import { ProtocolVersion } from "./protocolVersion.js";
 /** The sender is disconnecting */
 export type LeaveMessage = {
@@ -34,7 +34,7 @@ export type ErrorMessage = {
     targetId: PeerId;
 };
 /** A message from the client to the server */
-export type FromClientMessage = JoinMessage | LeaveMessage | Message;
+export type FromClientMessage = JoinMessage | LeaveMessage | RepoMessage;
 /** A message from the server to the client */
-export type FromServerMessage = PeerMessage | ErrorMessage | Message;
+export type FromServerMessage = PeerMessage | ErrorMessage | RepoMessage;
 //# sourceMappingURL=messages.d.ts.map

package/dist/messages.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"messages.d.ts","sourceRoot":"","sources":["../src/messages.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,2BAA2B,CAAA;AACrE,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AAEtD,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;IAChB,+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;IAChB,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;AAGD,8CAA8C;AAC9C,MAAM,MAAM,iBAAiB,GAAG,WAAW,GAAG,YAAY,GAAG,OAAO,CAAA;AACpE,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,EAAE,KAAK,WAAW,EAAE,KAAK,MAAM,EAAE,MAAM,2BAA2B,CAAA;AACzE,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AAEtD,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;IAChB,+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;IAChB,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,WAAW,CAAA;AAExE,8CAA8C;AAC9C,MAAM,MAAM,iBAAiB,GAAG,WAAW,GAAG,YAAY,GAAG,WAAW,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@automerge/automerge-repo-network-websocket",
-  "version": "1.0.5",
+  "version": "1.0.7",
   "description": "isomorphic node/browser Websocket network adapter for Automerge Repo",
   "peerDependencies": {
     "@automerge/automerge": "^2.1.0"
@@ -13,10 +13,10 @@
   "scripts": {
     "build": "tsc",
     "watch": "npm-watch",
-    "test": "mocha --no-warnings --experimental-specifier-resolution=node --exit"
+    "test": "vitest"
   },
   "dependencies": {
-    "@automerge/automerge-repo": "^1.0.5",
+    "@automerge/automerge-repo": "^1.0.7",
     "cbor-x": "^1.3.0",
     "eventemitter3": "^5.0.1",
     "isomorphic-ws": "^5.0.0",
@@ -33,8 +33,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "devDependencies": {
-    "@automerge/automerge": "^2.1.0"
-  },
-  "gitHead": "09256d61e0e4e0afd5d8deb1e187b57cb2413e1e"
+  "gitHead": "71060981f168e511a99ab85b155a54a13fd04bcc"
 }

package/src/BrowserWebSocketClientAdapter.ts

@@ -9,7 +9,7 @@ import {
   JoinMessage,
 } from "./messages.js"
 import { ProtocolV1 } from "./protocolVersion.js"
-import { isValidMessage } from "@automerge/automerge-repo"
+import { isValidRepoMessage } from "@automerge/automerge-repo"
 
 const log = debug("WebsocketClient")
 
@@ -31,6 +31,7 @@ export class BrowserWebSocketClientAdapter extends WebSocketNetworkAdapter {
   }
 
   connect(peerId: PeerId) {
+    this.socket?.removeAllListeners()
     if (!this.timerId) {
       this.timerId = setInterval(() => this.connect(peerId), 5000)
     }
@@ -43,7 +44,6 @@ export class BrowserWebSocketClientAdapter extends WebSocketNetworkAdapter {
       log(`@ ${this.url}: open`)
       clearInterval(this.timerId)
       this.timerId = undefined
-      this.join()
     })
 
     // When a socket closes, or disconnects, remove it from the array.
@@ -159,7 +159,7 @@ export class BrowserWebSocketClientAdapter extends WebSocketNetworkAdapter {
         log(`error: ${decoded.message}`)
         break
       default:
-        if (!isValidMessage(decoded)) {
+        if (!isValidRepoMessage(decoded)) {
           throw new Error("Invalid message received")
         }
         this.emit("message", decoded)

package/src/NodeWSServerAdapter.ts

@@ -13,6 +13,10 @@ import { ProtocolV1, ProtocolVersion } from "./protocolVersion.js"
 
 const { encode, decode } = cborHelpers
 
+interface WebSocketWithIsAlive extends WebSocket {
+  isAlive: boolean
+}
+
 export class NodeWSServerAdapter extends NetworkAdapter {
   server: WebSocketServer
   sockets: { [peerId: PeerId]: WebSocket } = {}
@@ -24,7 +28,12 @@ export class NodeWSServerAdapter extends NetworkAdapter {
 
   connect(peerId: PeerId) {
     this.peerId = peerId
-    this.server.on("connection", socket => {
+
+    this.server.on("close", function close() {
+      clearInterval(interval)
+    })
+
+    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)) {
@@ -38,8 +47,35 @@ export class NodeWSServerAdapter extends NetworkAdapter {
       socket.on("message", message =>
         this.receiveMessage(message as Uint8Array, socket)
       )
+
+      // Start out "alive", and every time we get a pong, reset that state.
+      socket.isAlive = true
+      socket.on("pong", () => (socket.isAlive = true))
+
       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()
+        }
+        socket.isAlive = false
+        socket.ping()
+      })
+    }, 30000)
   }
 
   disconnect() {

package/src/messages.ts

@@ -1,4 +1,4 @@
-import { type Message, type PeerId } from "@automerge/automerge-repo"
+import { type RepoMessage, type PeerId } from "@automerge/automerge-repo"
 import { ProtocolVersion } from "./protocolVersion.js"
 
 /** The sender is disconnecting */
@@ -38,8 +38,11 @@ export type ErrorMessage = {
   targetId: PeerId
 }
 
-// This adapter doesn't use NetworkAdapterMessage, it has its own idea of how to handle join/leave
+// 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
+export type FromClientMessage = JoinMessage | LeaveMessage | RepoMessage
+
 /** A message from the server to the client */
-export type FromServerMessage = PeerMessage | ErrorMessage | Message
+export type FromServerMessage = PeerMessage | ErrorMessage | RepoMessage

package/test/Websocket.test.ts

@@ -4,9 +4,10 @@ import { NodeWSServerAdapter } from "../src/NodeWSServerAdapter.js"
 import { startServer } from "./utilities/WebSockets.js"
 import * as CBOR from "cbor-x"
 import WebSocket, { AddressInfo } from "ws"
-import { assert } from "chai"
+import assert from "assert"
 import { PeerId, Repo } from "@automerge/automerge-repo"
 import { once } from "events"
+import { describe, it } from "vitest"
 
 describe("Websocket adapters", async () => {
   let port = 8080
@@ -17,7 +18,7 @@ describe("Websocket adapters", async () => {
 
     while (socket === undefined) {
       try {
-        ; ({ socket, server } = await startServer(port))
+        ;({ socket, server } = await startServer(port))
       } catch (e: any) {
         if (e.code === "EADDRINUSE") {
           port++

package/typedoc.json

@@ -1,5 +1,5 @@
 {
-    "extends": "../../typedoc.base.json",
-    "entryPoints": ["src/index.ts"],
-    "readme": "none"
+  "extends": ["../../typedoc.base.json"],
+  "entryPoints": ["src/index.ts"],
+  "readme": "none"
 }

package/.mocharc.json

@@ -1,5 +0,0 @@
-{
-  "extension": ["ts"],
-  "spec": "test/*.test.ts",
-  "loader": "ts-node/esm"
-}