@aicore/cocodb-ws-client 1.0.9 → 1.0.11

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aicore/cocodb-ws-client",
-  "version": "1.0.9",
+  "version": "1.0.11",
   "description": "Websocket client for cocoDb",
   "main": "src/index.js",
   "type": "module",
@@ -47,23 +47,23 @@
   },
   "homepage": "https://github.com/aicore/cocoDbWsClient#readme",
   "devDependencies": {
-    "@commitlint/cli": "17.4.1",
-    "@commitlint/config-conventional": "17.4.0",
-    "c8": "7.12.0",
+    "@commitlint/cli": "17.4.3",
+    "@commitlint/config-conventional": "17.4.3",
+    "c8": "7.13.0",
     "chai": "4.3.7",
     "cli-color": "2.0.3",
     "documentation": "14.0.1",
-    "eslint": "8.31.0",
-    "glob": "8.0.3",
+    "eslint": "8.34.0",
+    "glob": "8.1.0",
     "husky": "8.0.3",
     "mocha": "10.2.0"
   },
   "dependencies": {
     "@aicore/libcommonutils": "1.0.19",
-    "ws": "8.12.0"
+    "ws": "8.12.1"
   },
   "optionalDependencies": {
     "bufferutil": "4.0.7",
-    "utf-8-validate": "5.0.10"
+    "utf-8-validate": "6.0.2"
   }
 }

package/src/utils/client.js

@@ -3,11 +3,16 @@ import {isString, isObject, isStringEmpty, COCO_DB_FUNCTIONS} from "@aicore/libc
 
 let client = null,
     cocoDBEndPointURL = null,
-    cocoAuthKey = null;
+    cocoAuthKey = null,
+    hibernateTimer = null,
+    bufferRequests = false,
+    pendingSendMessages = [];
+const MAX_PENDING_SEND_BUFFER_SIZE = 2000;
 const WEBSOCKET_ENDPOINT_COCO_DB = '/ws/';
-const ID_TO_RESOLVE_REJECT_MAP = {};
+const ID_TO_RESOLVE_REJECT_MAP = new Map();
 const CONNECT_BACKOFF_TIME_MS = [1, 500, 1000, 3000, 5000, 10000, 20000];
-let id = 0;
+const INACTIVITY_TIME_FOR_HIBERNATE = 8000;
+let id = 0, activityInHibernateInterval = 0;
 
 let currentBackoffIndex = 0;
 function _resetBackoffTime() {
@@ -23,6 +28,42 @@ function _getBackoffTime() {
 // @INCLUDE_IN_API_DOCS
 
 
+function _checkActivityForHibernation() {
+    if(activityInHibernateInterval > 0){
+        activityInHibernateInterval = 0;
+        return;
+    }
+    if(!client || client.hibernating
+        || !client.connectionEstablished // cant hibernate if connection isnt already established/ is being establised
+        || ID_TO_RESOLVE_REJECT_MAP.size > 0){ // if there are any pending responses, we cant hibernate
+        return;
+    }
+    // hibernate
+    client.hibernating = true;
+    client.hibernatingPromise = new Promise((resolve=>{
+        client.hibernatingPromiseResolve = resolve;
+    }));
+    bufferRequests = true;
+    client.terminate();
+}
+
+/**
+ * returns a promise that resolves when hibernation ends.
+ * @return {Promise<unknown>}
+ * @private
+ */
+function _toAwakeFromHibernate() {
+    return client.hibernatingPromise;
+}
+
+function _wakeupHibernatingClient() {
+    if(client.hibernatingPromiseResolved) {
+        return;
+    }
+    client.hibernatingPromiseResolve();
+    client.hibernatingPromiseResolved = true;
+}
+
 /**
  * Sets up the websocket client and returns a promise that will be resolved when the connection is closed or broken.
  *
@@ -41,7 +82,9 @@ function _setupClientAndWaitForClose(connectedCb) {
         client.on('open', function open() {
             console.log('connected to server');
             client.connectionEstablished = true;
+            bufferRequests = false;
             connectedCb && connectedCb();
+            _sendPendingMessages();
         });
 
         client.on('message', function message(data) {
@@ -51,10 +94,9 @@ function _setupClientAndWaitForClose(connectedCb) {
         function _connectionTerminated(reason) {
             console.log(reason);
             client.connectionEstablished = false;
-            for (let sequenceNumber in ID_TO_RESOLVE_REJECT_MAP) {
-                let rejectHandler = ID_TO_RESOLVE_REJECT_MAP[sequenceNumber].reject;
-                rejectHandler(reason);
-                delete ID_TO_RESOLVE_REJECT_MAP[sequenceNumber];
+            for (let [sequenceNumber, handler] of ID_TO_RESOLVE_REJECT_MAP) {
+                handler.reject(reason);
+                ID_TO_RESOLVE_REJECT_MAP.delete(sequenceNumber);
             }
             resolve();
         }
@@ -96,15 +138,26 @@ async function _setupAndMaintainConnection(firstConnectionCb, neverConnectedCB)
         if(firstConnectionCb){
             firstConnectionCb("connected");
             firstConnectionCb = null;
+            // setup hibernate timer on first connection
+            activityInHibernateInterval = 1;
+            hibernateTimer = setInterval(_checkActivityForHibernation, INACTIVITY_TIME_FOR_HIBERNATE);
         }
     }
     while(!client || !client.userClosedConnection){
         await _setupClientAndWaitForClose(connected);
+        if(client && client.hibernating && !client.userClosedConnection){
+            await _toAwakeFromHibernate();
+            continue;
+        }
         if(!client || !client.userClosedConnection){
             await _backoffTimer(_getBackoffTime());
         }
     }
-    client.userClosedConnectionCB && client.userClosedConnectionCB();
+    if(hibernateTimer){
+        clearInterval(hibernateTimer);
+        hibernateTimer = null;
+    }
+    client && client.userClosedConnectionCB && client.userClosedConnectionCB();
     client = cocoDBEndPointURL = cocoAuthKey = null;
     id = 0;
     if(neverConnectedCB){
@@ -114,10 +167,16 @@ async function _setupAndMaintainConnection(firstConnectionCb, neverConnectedCB)
 
 /**
  * Create a connection to the cocoDbServiceEndPoint and listens for messages. The connection will
- * be maintained and it will try to automatically re-establish broken connections if there are network issues.
+ * be maintained and, it will try to automatically re-establish broken connections if there are network issues.
  * You need to await on this function before staring to use any db APIs. Any APIs called while the connection is
  * not fully setup will throw an error.
  *
+ * ## Hibernation after inactivity
+ * After around 10 seconds of no send activity and if there are no outstanding requests, the db connection will be
+ * dropped and the client move into a hibernation state. The connection will be immediately re-established on any
+ * db activity transparently, though a slight jitter may be observed during the connection establishment time. This
+ * auto start-stop will save database resources as servers can be on for months on end.
+ *
  * @param {string} cocoDbServiceEndPoint - The URL of the coco-db service.
  * @param {string} authKey - The authKey is a base64 encoded string of the username and password.
  * @return {Promise<null>} Resolves when the cocodb client is ready to send/receive requests for the first time.
@@ -159,10 +218,18 @@ export function close() {
     currentClient.closePromise = new Promise((resolve)=>{
         currentClient.userClosedConnection = true;
         currentClient.userClosedConnectionCB = function () {
+            for(let entry of pendingSendMessages){
+                entry.reject();
+            }
+            pendingSendMessages = [];
             resolve();
         };
         _cancelBackoffTimer(); // this is for if the connection is broken and, we are retrying the connection
-        currentClient.terminate();
+        if(currentClient.hibernating){
+            _wakeupHibernatingClient();
+        } else {
+            currentClient.terminate();
+        }
     });
     return currentClient.closePromise;
 }
@@ -176,6 +243,39 @@ function getId() {
     return id.toString(16);
 }
 
+function _sendMessage(message, resolve, reject) {
+    if (!client) {
+        reject('Please call init before sending message');
+        return;
+    }
+    if (!client.connectionEstablished) {
+        reject('Db connection is not ready, please retry in some time');
+        return;
+    }
+    if (!isObject(message)) {
+        reject('Please provide valid Object');
+        return;
+    }
+    if (!isString(message.fn) || !(message.fn in COCO_DB_FUNCTIONS)) {
+        reject('please provide valid function name');
+        return;
+    }
+    const sequenceNumber = getId();
+    message.id = sequenceNumber;
+    ID_TO_RESOLVE_REJECT_MAP.set(sequenceNumber, {
+        resolve: resolve,
+        reject: reject
+    });
+    activityInHibernateInterval++;
+    client.send(JSON.stringify(message));
+}
+
+function _sendPendingMessages() {
+    for(let entry of pendingSendMessages){
+        _sendMessage(entry.message, entry.resolve, entry.reject);
+    }
+    pendingSendMessages = [];
+}
 
 /**
  * It takes a message object, sends it to the server, and returns a promise that resolves when the server responds
@@ -183,30 +283,21 @@ function getId() {
  * @returns {Promise} A function that returns a promise.
  */
 export function sendMessage(message) {
+    // make a copy as the user may start modifying the object while we are sending it.
+    message = structuredClone(message);
     return new Promise(function (resolve, reject) {
-        if (!client) {
-            reject('Please call init before sending message');
-            return;
-        }
-        if (!client.connectionEstablished) {
-            reject('Db connection is not ready, please retry in some time');
-            return;
-        }
-        if (!isObject(message)) {
-            reject('Please provide valid Object');
-            return;
-        }
-        if (!isString(message.fn) || !(message.fn in COCO_DB_FUNCTIONS)) {
-            reject('please provide valid function name');
-            return;
+        if(bufferRequests){
+            if(pendingSendMessages.length > MAX_PENDING_SEND_BUFFER_SIZE){
+                reject('Too many requests sent while waking up from hibernation');
+                return;
+            }
+            pendingSendMessages.push({message, resolve, reject});
+            if(client&& client.hibernating){
+                _wakeupHibernatingClient();
+            }
+        } else {
+            _sendMessage(message, resolve, reject);
         }
-        const sequenceNumber = getId();
-        message.id = sequenceNumber;
-        ID_TO_RESOLVE_REJECT_MAP[sequenceNumber] = {
-            resolve: resolve,
-            reject: reject
-        };
-        client.send(JSON.stringify(message));
     });
 }
 
@@ -225,15 +316,14 @@ export function __receiveMessage(rawData) {
         console.error('Server message does not have an Id');
         return false;
     }
-    const requestResolve = ID_TO_RESOLVE_REJECT_MAP[message.id];
-    if (!isObject(requestResolve)) {
+    const requestHandler = ID_TO_RESOLVE_REJECT_MAP.get(message.id);
+    if (!isObject(requestHandler)) {
         //TODO: Emit metrics
 
         console.error(`Client did not send message with Id ${message.id} to server`);
         return false;
     }
-    const response = message.response;
-    requestResolve.resolve(response);
-    delete ID_TO_RESOLVE_REJECT_MAP[message.id];
+    requestHandler.resolve(message.response);
+    ID_TO_RESOLVE_REJECT_MAP.delete(message.id);
     return true;
 }