@inditextech/weave-store-azure-web-pubsub 2.0.3 → 2.1.1

package/dist/client.d.ts

@@ -1,5 +1,5 @@
 import { WeaveStore } from "@inditextech/weave-sdk";
-import { WeaveStoreOptions } from "@inditextech/weave-types";
+import { DeepPartial, WeaveStoreOptions } from "@inditextech/weave-types";
 import ReconnectingWebSocket from "reconnecting-websocket";
 import { Doc } from "yjs";
 import Emittery from "emittery";
@@ -100,13 +100,13 @@ declare const WEAVE_STORE_AZURE_WEB_PUBSUB_DEFAULT_CONFIG: {
 //#region src/types.d.ts
 type WeaveStoreAzureWebPubsubConfig = {
   endpoint: string;
+  persistIntervalMs?: number;
   hubName: string;
   auth?: {
     key?: string;
     custom?: TokenCredential;
   };
-  connectionHandlers?: Pick<WeaveAzureWebPubsubSyncHandlerOptions, "onConnect" | "onConnected" | "removeConnection" | "getConnectionRoom" | "getRoomConnections">;
-  persistIntervalMs?: number;
+  connectionHandlers?: DeepPartial<WeaveAzureWebPubsubSyncHandlerOptions>;
 };
 type WeaveAzureWebPubsubSyncHandlerOptions = {
   onConnect?: (connectionId: string, queries: Record<string, string[]> | undefined) => Promise<void>;

package/dist/server.d.ts

@@ -9,7 +9,7 @@ import ReconnectingWebSocket from "reconnecting-websocket";
 import * as awarenessProtocol$1 from "y-protocols/awareness";
 import * as awarenessProtocol from "y-protocols/awareness";
 import { WeaveStore } from "@inditextech/weave-sdk";
-import { WeaveStoreOptions } from "@inditextech/weave-types";
+import { DeepPartial, WeaveStoreOptions } from "@inditextech/weave-types";
 import { Encoder } from "lib0/encoding";
 import { Decoder } from "lib0/decoding";
 import express from "express-serve-static-core";
@@ -108,13 +108,13 @@ declare class WeaveStoreAzureWebPubSubSyncClient extends Emittery {
 //#region src/types.d.ts
 type WeaveStoreAzureWebPubsubConfig = {
   endpoint: string;
+  persistIntervalMs?: number;
   hubName: string;
   auth?: {
     key?: string;
     custom?: TokenCredential;
   };
-  connectionHandlers?: Pick<WeaveAzureWebPubsubSyncHandlerOptions, "onConnect" | "onConnected" | "removeConnection" | "getConnectionRoom" | "getRoomConnections">;
-  persistIntervalMs?: number;
+  connectionHandlers?: DeepPartial<WeaveAzureWebPubsubSyncHandlerOptions>;
 };
 type WeaveAzureWebPubsubSyncHandlerOptions = {
   onConnect?: (connectionId: string, queries: Record<string, string[]> | undefined) => Promise<void>;
@@ -1000,6 +1000,7 @@ declare class WebPubSubEventHandler {
 //#region src/server/azure-web-pubsub-host.d.ts
 declare class WeaveStoreAzureWebPubSubSyncHost {
   private readonly server;
+  private readonly syncHandler;
   doc: Y.Doc;
   topic: string;
   topicAwarenessChannel: string;
@@ -1010,7 +1011,7 @@ declare class WeaveStoreAzureWebPubSubSyncHost {
   private _awareness;
   private _updateHandler;
   private _awarenessUpdateHandler;
-  constructor(server: WeaveAzureWebPubsubServer, client: WebPubSubServiceClient, topic: string, doc: Y.Doc);
+  constructor(server: WeaveAzureWebPubsubServer, syncHandler: WeaveAzureWebPubsubSyncHandler, client: WebPubSubServiceClient, topic: string, doc: Y.Doc);
   get awareness(): awarenessProtocol.Awareness;
   sendInitAwarenessInfo(origin: string): void;
   createWebSocket(): Promise<void>;
@@ -1036,11 +1037,13 @@ declare class WeaveAzureWebPubsubSyncHandler extends WebPubSubEventHandler {
   private readonly syncOptions?;
   private initialState;
   private readonly server;
+  private readonly roomsLastState;
   constructor(hub: string, server: WeaveAzureWebPubsubServer, client: WebPubSubServiceClient, initialState: FetchInitialState, syncHandlerOptions?: WeaveAzureWebPubsubSyncHandlerOptions, eventHandlerOptions?: WebPubSubEventHandlerOptions);
   private getNewYDoc;
   private setupRoomInstance;
-  private persistRoomTask;
+  isPersistingOnInterval(): boolean;
   private setupRoomInstancePersistence;
+  persistRoomTask(roomId: string): Promise<void>;
   private handleConnectionDisconnection;
   destroyRoomInstance(roomId: string): Promise<void>;
   private getHostConnection;

package/dist/server.js

@@ -8,6 +8,7 @@ import { URL as URL$1 } from "node:url";
 import { EOL } from "node:os";
 import process$1 from "node:process";
 import { WebSocket } from "ws";
+import crypto from "node:crypto";
 import { defaultInitialState } from "@inditextech/weave-sdk/server";
 
 //#region rolldown:runtime
@@ -18609,6 +18610,12 @@ var require_response = __commonJS({ "../../node_modules/koa/lib/response.js"(exp
 		set body(val) {
 			const original = this._body;
 			this._body = val;
+			const cleanupPreviousStream = () => {
+				if (original && isStream$1(original)) {
+					original.once("error", () => {});
+					if (!isStream$1(val)) destroy$1(original);
+				}
+			};
 			if (val == null) {
 				if (!statuses$3.empty[this.status]) {
 					if (this.type === "application/json") {
@@ -18621,6 +18628,7 @@ var require_response = __commonJS({ "../../node_modules/koa/lib/response.js"(exp
 				this.remove("Content-Type");
 				this.remove("Content-Length");
 				this.remove("Transfer-Encoding");
+				cleanupPreviousStream();
 				return;
 			}
 			if (!this._explicitStatus) this.status = 200;
@@ -18628,29 +18636,33 @@ var require_response = __commonJS({ "../../node_modules/koa/lib/response.js"(exp
 			if (typeof val === "string") {
 				if (setType) this.type = /^\s*</.test(val) ? "html" : "text";
 				this.length = Buffer.byteLength(val);
+				cleanupPreviousStream();
 				return;
 			}
 			if (Buffer.isBuffer(val)) {
 				if (setType) this.type = "bin";
 				this.length = val.length;
+				cleanupPreviousStream();
 				return;
 			}
 			if (isStream$1(val)) {
 				onFinish(this.res, destroy$1.bind(null, val));
 				if (original !== val) {
-					val.once("error", (err) => this.ctx.onerror(err));
 					if (original != null) this.remove("Content-Length");
+					cleanupPreviousStream();
 				}
 				if (setType) this.type = "bin";
 				return;
 			}
 			if (val instanceof ReadableStream) {
 				if (setType) this.type = "bin";
+				cleanupPreviousStream();
 				return;
 			}
 			if (val instanceof Blob) {
 				if (setType) this.type = "bin";
 				this.length = val.size;
+				cleanupPreviousStream();
 				return;
 			}
 			if (val instanceof Response) {
@@ -18658,10 +18670,12 @@ var require_response = __commonJS({ "../../node_modules/koa/lib/response.js"(exp
 				if (setType) this.type = "bin";
 				const headers = val.headers;
 				for (const key of headers.keys()) this.set(key, headers.get(key));
+				cleanupPreviousStream();
 				return;
 			}
 			this.remove("Content-Length");
 			if (!this.type || !/\bjson\b/i.test(this.type)) this.type = "json";
+			cleanupPreviousStream();
 		},
 		set length(n) {
 			if (!this.has("Transfer-Encoding")) this.set("Content-Length", n);
@@ -19818,19 +19832,19 @@ var require_delegates = __commonJS({ "../../node_modules/delegates/index.js"(exp
 //#endregion
 //#region ../../node_modules/tsscmp/lib/index.js
 var require_lib = __commonJS({ "../../node_modules/tsscmp/lib/index.js"(exports, module) {
-	var crypto$1 = __require("crypto");
+	var crypto$2 = __require("crypto");
 	function bufferEqual(a, b) {
 		if (a.length !== b.length) return false;
-		if (crypto$1.timingSafeEqual) return crypto$1.timingSafeEqual(a, b);
+		if (crypto$2.timingSafeEqual) return crypto$2.timingSafeEqual(a, b);
 		for (var i = 0; i < a.length; i++) if (a[i] !== b[i]) return false;
 		return true;
 	}
 	function timeSafeCompare(a, b) {
 		var sa = String(a);
 		var sb = String(b);
-		var key = crypto$1.pseudoRandomBytes(32);
-		var ah = crypto$1.createHmac("sha256", key).update(sa).digest();
-		var bh = crypto$1.createHmac("sha256", key).update(sb).digest();
+		var key = crypto$2.pseudoRandomBytes(32);
+		var ah = crypto$2.createHmac("sha256", key).update(sa).digest();
+		var bh = crypto$2.createHmac("sha256", key).update(sb).digest();
 		return bufferEqual(ah, bh) && a === b;
 	}
 	module.exports = timeSafeCompare;
@@ -19840,14 +19854,14 @@ var require_lib = __commonJS({ "../../node_modules/tsscmp/lib/index.js"(exports,
 //#region ../../node_modules/keygrip/index.js
 var require_keygrip = __commonJS({ "../../node_modules/keygrip/index.js"(exports, module) {
 	var compare = require_lib();
-	var crypto = __require("crypto");
+	var crypto$1 = __require("crypto");
 	function Keygrip$1(keys$1, algorithm, encoding) {
 		if (!algorithm) algorithm = "sha1";
 		if (!encoding) encoding = "base64";
 		if (!(this instanceof Keygrip$1)) return new Keygrip$1(keys$1, algorithm, encoding);
 		if (!keys$1 || !(0 in keys$1)) throw new Error("Keys must be provided.");
 		function sign(data, key) {
-			return crypto.createHmac(algorithm, key).update(data).digest(encoding).replace(/\/|\+|=/g, function(x) {
+			return crypto$1.createHmac(algorithm, key).update(data).digest(encoding).replace(/\/|\+|=/g, function(x) {
 				return {
 					"/": "_",
 					"+": "-",
@@ -20389,10 +20403,14 @@ var require_application = __commonJS({ "../../node_modules/koa/lib/application.j
 		}
 		if (Buffer.isBuffer(body)) return res.end(body);
 		if (typeof body === "string") return res.end(body);
-		if (body instanceof Blob) return Stream.Readable.from(body.stream()).pipe(res);
-		if (body instanceof ReadableStream) return Stream.Readable.from(body).pipe(res);
-		if (body instanceof Response) return Stream.Readable.from(body?.body || "").pipe(res);
-		if (isStream(body)) return body.pipe(res);
+		let stream = null;
+		if (body instanceof Blob) stream = Stream.Readable.from(body.stream());
+		else if (body instanceof ReadableStream) stream = Stream.Readable.from(body);
+		else if (body instanceof Response) stream = Stream.Readable.from(body?.body || "");
+		else if (isStream(body)) stream = body;
+		if (stream) return Stream.pipeline(stream, res, (err) => {
+			if (err && ctx.app.listenerCount("error")) ctx.onerror(err);
+		});
 		body = JSON.stringify(body);
 		if (!res.headersSent) ctx.length = Buffer.byteLength(body);
 		res.end(body);
@@ -22840,8 +22858,9 @@ const HostUserId = "host";
 var WeaveStoreAzureWebPubSubSyncHost = class {
 	_reconnectAttempts = 0;
 	_forceClose = false;
-	constructor(server, client, topic, doc) {
+	constructor(server, syncHandler, client, topic, doc) {
 		this.server = server;
+		this.syncHandler = syncHandler;
 		this.doc = doc;
 		this.topic = topic;
 		this.topicAwarenessChannel = `${topic}-awareness`;
@@ -22869,6 +22888,7 @@ var WeaveStoreAzureWebPubSubSyncHost = class {
 				writeUpdate(encoder, update);
 				const u8 = toUint8Array(encoder);
 				this.broadcast(this.topic, origin, u8);
+				if (!this.syncHandler.isPersistingOnInterval()) this.syncHandler.persistRoomTask(this.topic);
 			} catch (err) {
 				console.error("Error in document update handler:", err);
 			}
@@ -23061,12 +23081,27 @@ var WeaveStoreAzureWebPubSubSyncHost = class {
 	}
 };
 
+//#endregion
+//#region src/server/utils.ts
+function getStateAsJson(actualState) {
+	const document = new yjs_default.Doc();
+	yjs_default.applyUpdate(document, actualState);
+	const actualStateString = JSON.stringify(document.getMap("weave").toJSON());
+	const actualStateJson = JSON.parse(actualStateString);
+	return actualStateJson;
+}
+function hashJson(obj) {
+	const jsonString = JSON.stringify(obj);
+	return crypto.createHash("sha256").update(jsonString).digest("hex");
+}
+
 //#endregion
 //#region src/server/azure-web-pubsub-sync-handler.ts
 var WeaveAzureWebPubsubSyncHandler = class extends WebPubSubEventHandler {
 	_rooms = new Map();
 	_roomsSyncHost = new Map();
 	_store_persistence = new Map();
+	roomsLastState = new Map();
 	constructor(hub, server, client, initialState, syncHandlerOptions, eventHandlerOptions) {
 		super(hub, {
 			...eventHandlerOptions,
@@ -23091,6 +23126,7 @@ var WeaveAzureWebPubsubSyncHandler = class extends WebPubSubEventHandler {
 		this.server = server;
 		this.initialState = initialState;
 		this._client = client;
+		if (this.isPersistingOnInterval()) console.warn(`Room persistence defined via interval, be aware that this can lead to data loss. Consider persisting on document updates instead.`);
 	}
 	getNewYDoc() {
 		return new yjs_default.Doc();
@@ -23102,29 +23138,44 @@ var WeaveAzureWebPubsubSyncHandler = class extends WebPubSubEventHandler {
 		if (this.server?.fetchRoom) documentData = await this.server.fetchRoom(roomId);
 		if (documentData) yjs_default.applyUpdate(doc, documentData);
 		else this.initialState(doc);
-		this._roomsSyncHost.set(roomId, new WeaveStoreAzureWebPubSubSyncHost(this.server, this._client, roomId, doc));
+		this._roomsSyncHost.set(roomId, new WeaveStoreAzureWebPubSubSyncHost(this.server, this, this._client, roomId, doc));
 		const connection = this._roomsSyncHost.get(roomId);
 		await connection.start();
-		await this.setupRoomInstancePersistence(roomId);
+		if (this.isPersistingOnInterval()) this.setupRoomInstancePersistence(roomId);
+	}
+	isPersistingOnInterval() {
+		return this.syncOptions?.persistIntervalMs !== void 0;
+	}
+	async setupRoomInstancePersistence(roomId) {
+		if (!this._store_persistence.has(roomId)) {
+			const intervalId = setInterval(async () => {
+				await this.persistRoomTask(roomId);
+			}, this.syncOptions?.persistIntervalMs ?? 5e3);
+			this._store_persistence.set(roomId, intervalId);
+		}
 	}
 	async persistRoomTask(roomId) {
 		try {
 			const doc = this._rooms.get(roomId);
 			if (!doc) return;
 			const actualState = yjs_default.encodeStateAsUpdate(doc);
+			if (!this.isPersistingOnInterval()) {
+				const savedRoomData = this.roomsLastState.get(roomId);
+				if (savedRoomData) {
+					const savedStateJson = getStateAsJson(savedRoomData);
+					const savedHash = hashJson(savedStateJson);
+					const actualStateJson = getStateAsJson(actualState);
+					const actualHash = hashJson(actualStateJson);
+					const same = savedHash === actualHash;
+					if (same) return;
+					this.roomsLastState.set(roomId, actualState);
+				}
+			}
 			if (this.server?.persistRoom) await this.server.persistRoom(roomId, actualState);
 		} catch (ex) {
 			console.error(ex);
 		}
 	}
-	async setupRoomInstancePersistence(roomId) {
-		if (!this._store_persistence.has(roomId)) {
-			const intervalId = setInterval(async () => {
-				await this.persistRoomTask(roomId);
-			}, this.syncOptions?.persistIntervalMs ?? 5e3);
-			this._store_persistence.set(roomId, intervalId);
-		}
-	}
 	async handleConnectionDisconnection(connectionId) {
 		const connectionRoom = await this.syncOptions?.getConnectionRoom?.(connectionId);
 		if (connectionRoom) await this.syncOptions?.removeConnection?.(connectionId);
@@ -23132,10 +23183,13 @@ var WeaveAzureWebPubsubSyncHandler = class extends WebPubSubEventHandler {
 		if (connectionRoom && roomConnections?.length === 0) await this.destroyRoomInstance(connectionRoom);
 	}
 	async destroyRoomInstance(roomId) {
-		const intervalId = this._store_persistence.get(roomId);
-		if (intervalId) clearInterval(intervalId);
-		this._store_persistence.delete(roomId);
+		if (this.isPersistingOnInterval()) {
+			const intervalId = this._store_persistence.get(roomId);
+			if (intervalId) clearInterval(intervalId);
+			this._store_persistence.delete(roomId);
+		}
 		await this.persistRoomTask(roomId);
+		if (!this.isPersistingOnInterval()) this.roomsLastState.delete(roomId);
 		const syncHost = this._roomsSyncHost.get(roomId);
 		if (syncHost) {
 			await syncHost.stop();
@@ -23182,7 +23236,7 @@ var WeaveAzureWebPubsubServer = class extends Emittery {
 		credentials ??= new DefaultAzureCredential();
 		this.syncClient = new WebPubSubServiceClient(pubSubConfig.endpoint, credentials, pubSubConfig.hubName);
 		this.syncHandler = new WeaveAzureWebPubsubSyncHandler(pubSubConfig.hubName, this, this.syncClient, initialState, {
-			persistIntervalMs: pubSubConfig.persistIntervalMs,
+			...pubSubConfig.persistIntervalMs && { persistIntervalMs: pubSubConfig.persistIntervalMs },
 			...pubSubConfig.connectionHandlers
 		}, eventsHandlerConfig);
 	}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inditextech/weave-store-azure-web-pubsub",
-  "version": "2.0.3",
+  "version": "2.1.1",
   "type": "module",
   "license": "Apache-2.0",
   "author": "Jesus Manuel Piñeiro Cid <jesusmpc@inditex.com>",
@@ -57,8 +57,8 @@
   "dependencies": {
     "@azure/identity": "4.10.2",
     "@azure/web-pubsub": "1.2.0",
-    "@inditextech/weave-types": "2.0.3",
-    "@inditextech/weave-sdk": "2.0.3",
+    "@inditextech/weave-types": "2.1.1",
+    "@inditextech/weave-sdk": "2.1.1",
     "@syncedstore/core": "0.6.0",
     "buffer": "6.0.3",
     "reconnecting-websocket": "4.4.0",