@resolveio/server-lib 20.14.36 → 20.14.38

package/managers/subscription.manager.d.ts

@@ -36,6 +36,10 @@ export declare class SubscriptionManager {
     private _debugMongoQueueCollections;
     private _debugSendQueueHits;
     private _debugRemoveCacheHits;
+    private _subSendDebug;
+    private _subSendLogThresholdMs;
+    private _subSendLogBytes;
+    private _subSendLogSampleRate;
     private _oplogRetryCount;
     private _lastResumeToken;
     private _lastResumeTokenSaveMs;
@@ -96,8 +100,15 @@ export declare class SubscriptionManager {
     private resolveLocalOplogResyncIntervalMs;
     private resolveResumeTokenMaxAgeMs;
     private resolveConnectDebug;
+    private resolveSubSendDebug;
+    private resolveSubSendLogThresholdMs;
+    private resolveSubSendLogBytes;
+    private resolveSubSendLogSampleRate;
     private parseDebugFlag;
     private parsePositiveNumber;
+    private parseSampleRate;
+    private shouldLogSubSend;
+    private logSubSend;
     private connectDebug;
     private parsePositiveFloat;
     private isChangeStreamUnsupported;

package/managers/subscription.manager.js

@@ -75,6 +75,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.SubscriptionManager = void 0;
 var NodeCache = require("node-cache");
 var msgpackr_1 = require("msgpackr");
+var WebSocket = require("ws");
 var flag_collection_1 = require("../collections/flag.collection");
 var logged_in_users_collection_1 = require("../collections/logged-in-users.collection");
 var app_status_1 = require("../publications/app-status");
@@ -145,6 +146,10 @@ var SubscriptionManager = /** @class */ (function () {
         this._debugMongoQueueCollections = [];
         this._debugSendQueueHits = 0;
         this._debugRemoveCacheHits = 0;
+        this._subSendDebug = false;
+        this._subSendLogThresholdMs = 0;
+        this._subSendLogBytes = 0;
+        this._subSendLogSampleRate = 1;
         this._oplogRetryCount = 0;
         this._lastResumeToken = null;
         this._lastResumeTokenSaveMs = 0;
@@ -226,6 +231,10 @@ var SubscriptionManager = /** @class */ (function () {
                         this.serverConfig = serverConfig;
                         this._wss = wss;
                         this._connectDebug = this.resolveConnectDebug();
+                        this._subSendDebug = this.resolveSubSendDebug();
+                        this._subSendLogThresholdMs = this.resolveSubSendLogThresholdMs();
+                        this._subSendLogBytes = this.resolveSubSendLogBytes();
+                        this._subSendLogSampleRate = this.resolveSubSendLogSampleRate();
                         this._oplogMode = this.resolveOplogMode();
                         this._localOplogResyncIntervalMs = this.resolveLocalOplogResyncIntervalMs();
                         this.registerCorePublications();
@@ -530,7 +539,7 @@ var SubscriptionManager = /** @class */ (function () {
                         if (!!_b.done) return [3 /*break*/, 10];
                         client = _b.value;
                         ws = this._websocketManager.getWebSocket(client.id_socket);
-                        if (!((ws === null || ws === void 0 ? void 0 : ws.readyState) === ws.OPEN)) return [3 /*break*/, 9];
+                        if (!((ws === null || ws === void 0 ? void 0 : ws.readyState) === WebSocket.OPEN)) return [3 /*break*/, 9];
                         _f.label = 6;
                     case 6:
                         _f.trys.push([6, 8, , 9]);
@@ -1231,6 +1240,38 @@ var SubscriptionManager = /** @class */ (function () {
             || config['CONNECT_DEBUG'];
         return this.parseDebugFlag(raw);
     };
+    SubscriptionManager.prototype.resolveSubSendDebug = function () {
+        var config = this.serverConfig || resolveio_server_app_1.ResolveIOServer.getServerConfig() || {};
+        var raw = process.env.SUB_SEND_DEBUG
+            || process.env.SUBSCRIPTION_SEND_DEBUG
+            || config['SUB_SEND_DEBUG']
+            || config['SUBSCRIPTION_SEND_DEBUG'];
+        return this.parseDebugFlag(raw);
+    };
+    SubscriptionManager.prototype.resolveSubSendLogThresholdMs = function () {
+        var config = this.serverConfig || resolveio_server_app_1.ResolveIOServer.getServerConfig() || {};
+        var raw = process.env.SUB_SEND_LOG_THRESHOLD_MS
+            || process.env.SUBSCRIPTION_SEND_LOG_THRESHOLD_MS
+            || config['SUB_SEND_LOG_THRESHOLD_MS']
+            || config['SUBSCRIPTION_SEND_LOG_THRESHOLD_MS'];
+        return this.parsePositiveNumber(raw);
+    };
+    SubscriptionManager.prototype.resolveSubSendLogBytes = function () {
+        var config = this.serverConfig || resolveio_server_app_1.ResolveIOServer.getServerConfig() || {};
+        var raw = process.env.SUB_SEND_LOG_BYTES
+            || process.env.SUBSCRIPTION_SEND_LOG_BYTES
+            || config['SUB_SEND_LOG_BYTES']
+            || config['SUBSCRIPTION_SEND_LOG_BYTES'];
+        return this.parsePositiveNumber(raw);
+    };
+    SubscriptionManager.prototype.resolveSubSendLogSampleRate = function () {
+        var config = this.serverConfig || resolveio_server_app_1.ResolveIOServer.getServerConfig() || {};
+        var raw = process.env.SUB_SEND_LOG_SAMPLE_RATE
+            || process.env.SUBSCRIPTION_SEND_LOG_SAMPLE_RATE
+            || config['SUB_SEND_LOG_SAMPLE_RATE']
+            || config['SUBSCRIPTION_SEND_LOG_SAMPLE_RATE'];
+        return this.parseSampleRate(raw, this._subSendLogSampleRate);
+    };
     SubscriptionManager.prototype.parseDebugFlag = function (value) {
         if (value === true) {
             return true;
@@ -1259,6 +1300,45 @@ var SubscriptionManager = /** @class */ (function () {
         }
         return 0;
     };
+    SubscriptionManager.prototype.parseSampleRate = function (value, fallback) {
+        var parsed = parseFloat(value !== null && value !== void 0 ? value : '');
+        if (Number.isFinite(parsed) && parsed > 0 && parsed <= 1) {
+            return parsed;
+        }
+        return fallback;
+    };
+    SubscriptionManager.prototype.shouldLogSubSend = function (durationMs, payloadBytes) {
+        if (this._subSendLogSampleRate < 1 && Math.random() > this._subSendLogSampleRate) {
+            return false;
+        }
+        if (this._subSendDebug) {
+            return true;
+        }
+        if (this._subSendLogThresholdMs > 0 && durationMs >= this._subSendLogThresholdMs) {
+            return true;
+        }
+        if (payloadBytes !== null && this._subSendLogBytes > 0 && payloadBytes >= this._subSendLogBytes) {
+            return true;
+        }
+        return false;
+    };
+    SubscriptionManager.prototype.logSubSend = function (sub, details) {
+        if (!details.clients) {
+            return;
+        }
+        if (!this.shouldLogSubSend(details.durationMs, details.payloadBytes)) {
+            return;
+        }
+        console.log(new Date(), '[Sub Send]', JSON.stringify({
+            publication: sub.publication,
+            subscriptionKey: sub.subscriptionKey,
+            clients: details.clients,
+            durationMs: details.durationMs,
+            payloadBytes: details.payloadBytes,
+            collection: details.collection,
+            type: details.type
+        }));
+    };
     SubscriptionManager.prototype.connectDebug = function (message, details) {
         if (!this._connectDebug) {
             return;
@@ -1663,7 +1743,7 @@ var SubscriptionManager = /** @class */ (function () {
                         if (!!_b.done) return [3 /*break*/, 9];
                         client = _b.value;
                         ws = this._websocketManager.getWebSocket(client.id_socket);
-                        if (!((ws === null || ws === void 0 ? void 0 : ws.readyState) === ws.OPEN)) return [3 /*break*/, 8];
+                        if (!((ws === null || ws === void 0 ? void 0 : ws.readyState) === WebSocket.OPEN)) return [3 /*break*/, 8];
                         _l.label = 5;
                     case 5:
                         _l.trys.push([5, 7, , 8]);
@@ -2233,7 +2313,7 @@ var SubscriptionManager = /** @class */ (function () {
     // Fetch pub once, send to all clients linked to this pub
     SubscriptionManager.prototype.sendDataToAll = function (sub, collection, type) {
         return __awaiter(this, void 0, void 0, function () {
-            var subIndex, monitor, res, dependencySnapshot, execution, packedRes, shouldCache, cachedBuffer, isSame, _a, _b, client, ws, serverRes, _c, _d, client, ws, serverRes, nodeCacheSize, deleteCount, subArr, zz, err_2, _e, normalizedError, correlationId, _f, _g, client, ws, serverRes, errorPayload;
+            var subIndex, monitor, res, dependencySnapshot, execution, packedRes, payloadBytes, shouldCache, cachedBuffer, isSame, sendStartMs, sentClients, _a, _b, client, ws, serverRes, sendStartMs, sentClients, _c, _d, client, ws, serverRes, nodeCacheSize, deleteCount, subArr, zz, err_2, _e, normalizedError, correlationId, _f, _g, client, ws, serverRes, errorPayload;
             var e_6, _h, e_7, _j, e_8, _k;
             var _l, _m;
             return __generator(this, function (_o) {
@@ -2266,16 +2346,19 @@ var SubscriptionManager = /** @class */ (function () {
                         dependencySnapshot = execution.snapshot;
                         this.updateSubscriptionDependencies(sub, dependencySnapshot);
                         packedRes = (_l = execution.packedResult) !== null && _l !== void 0 ? _l : this.packCachePayload(res);
+                        payloadBytes = packedRes ? packedRes.byteLength : null;
                         shouldCache = this.shouldCachePayload(sub, packedRes);
                         if (sub.cacheId) {
                             cachedBuffer = this.getCacheBuffer(this._nodeCache.get(sub.cacheId));
                             isSame = this.buffersEqual(cachedBuffer, packedRes);
                             if (!isSame) {
+                                sendStartMs = Date.now();
+                                sentClients = 0;
                                 try {
                                     for (_a = __values(sub.clients), _b = _a.next(); !_b.done; _b = _a.next()) {
                                         client = _b.value;
                                         ws = this._websocketManager.getWebSocket(client.id_socket);
-                                        if (ws && ws.readyState === ws.OPEN) {
+                                        if (ws && ws.readyState === WebSocket.OPEN) {
                                             if (packedRes) {
                                                 this._websocketManager.sendPackedBuffer(ws, client.messageId, false, packedRes, execution.encoding || 'msgpack');
                                             }
@@ -2287,6 +2370,7 @@ var SubscriptionManager = /** @class */ (function () {
                                                 };
                                                 this.sendWS(ws, serverRes);
                                             }
+                                            sentClients += 1;
                                         }
                                     }
                                 }
@@ -2297,6 +2381,13 @@ var SubscriptionManager = /** @class */ (function () {
                                     }
                                     finally { if (e_6) throw e_6.error; }
                                 }
+                                this.logSubSend(sub, {
+                                    collection: collection,
+                                    type: type,
+                                    clients: sentClients,
+                                    durationMs: Date.now() - sendStartMs,
+                                    payloadBytes: payloadBytes
+                                });
                                 this._nodeCache.del(sub.cacheId);
                                 if (shouldCache) {
                                     this._nodeCache.set(sub.cacheId, packedRes);
@@ -2314,11 +2405,13 @@ var SubscriptionManager = /** @class */ (function () {
                             }
                         }
                         else {
+                            sendStartMs = Date.now();
+                            sentClients = 0;
                             try {
                                 for (_c = __values(sub.clients), _d = _c.next(); !_d.done; _d = _c.next()) {
                                     client = _d.value;
                                     ws = this._websocketManager.getWebSocket(client.id_socket);
-                                    if (ws && ws.readyState === ws.OPEN) {
+                                    if (ws && ws.readyState === WebSocket.OPEN) {
                                         if (packedRes) {
                                             this._websocketManager.sendPackedBuffer(ws, client.messageId, false, packedRes, execution.encoding || 'msgpack');
                                         }
@@ -2330,6 +2423,7 @@ var SubscriptionManager = /** @class */ (function () {
                                             };
                                             this.sendWS(ws, serverRes);
                                         }
+                                        sentClients += 1;
                                     }
                                 }
                             }
@@ -2340,6 +2434,13 @@ var SubscriptionManager = /** @class */ (function () {
                                 }
                                 finally { if (e_7) throw e_7.error; }
                             }
+                            this.logSubSend(sub, {
+                                collection: collection,
+                                type: type,
+                                clients: sentClients,
+                                durationMs: Date.now() - sendStartMs,
+                                payloadBytes: payloadBytes
+                            });
                             if (shouldCache) {
                                 sub.cacheId = this._cacheId++;
                                 this._nodeCache.set(sub.cacheId, packedRes);
@@ -2379,7 +2480,7 @@ var SubscriptionManager = /** @class */ (function () {
                             for (_f = __values(sub.clients), _g = _f.next(); !_g.done; _g = _f.next()) {
                                 client = _g.value;
                                 ws = this._websocketManager.getWebSocket(client.id_socket);
-                                if (ws && ws.readyState === ws.OPEN) {
+                                if (ws && ws.readyState === WebSocket.OPEN) {
                                     serverRes = {
                                         messageId: client.messageId,
                                         hasError: true,