Web Worker takes care of setting intervals for heartbeat (#1956)

* Update WatchDog.js
* testing timer in Web Worker
* timer4Worker -> pacemaker
* changed heartbeat interval sent to client

Author: odeimaiz

services/web/client/Manifest.json

@@ -23,6 +23,7 @@
   "externalResources": {
     "script": [
       "socketio/socket.io.js",
+      "osparc/pacemaker.js",
       "svg/svg.js",
       "svg/svg.path.js",
       "jsondiffpatch/jsondiffpatch.min.js",

services/web/client/source/class/osparc/io/WatchDog.js

@@ -15,6 +15,11 @@
 
 ************************************************************************ */
 
+/**
+  * @asset(pacemaker.js)
+  * @ignore(Worker)
+  */
+
 /**
  * Singleton class that does some network connection checks.
  *
@@ -33,27 +38,21 @@
 
 qx.Class.define("osparc.io.WatchDog", {
   extend: qx.core.Object,
-
-  type : "singleton",
+  type: "singleton",
 
   construct: function() {
-    this.__clientHeartbeatPinger = new qx.event.Timer(this.heartbeatInterval);
-    this.__clientHeartbeatPinger.addListener("interval", function() {
-      const socket = osparc.wrapper.WebSocket.getInstance();
-      try {
-        socket.emit("client_heartbeat");
-      } catch (error) {
-        // no need to handle the error, nor does it need to cause further issues
-        // it is ok to eat it up
-      }
-    }, this);
+    this.__clientHeartbeatWWPinger = new Worker("resource/osparc/pacemaker.js");
+    this.__clientHeartbeatWWPinger.onmessage = () => {
+      this.__pingServer();
+    };
 
     // register for socket.io event to change the default heartbeat interval
     const socket = osparc.wrapper.WebSocket.getInstance();
     const socketIoEventName = "set_heartbeat_emit_interval";
     socket.removeSlot(socketIoEventName);
-    socket.on(socketIoEventName, function(emitIntervalSeconds) {
-      this.setHeartbeatInterval(parseInt(emitIntervalSeconds) * 1000);
+    socket.on(socketIoEventName, emitIntervalSeconds => {
+      const newInterval = parseInt(emitIntervalSeconds) * 1000;
+      this.setHeartbeatInterval(newInterval);
     }, this);
   },
 
@@ -74,18 +73,33 @@ qx.Class.define("osparc.io.WatchDog", {
   },
 
   members: {
-    __clientHeartbeatPinger: null,
+    __clientHeartbeatWWPinger: null,
 
     _applyOnLine: function(value) {
       let logo = osparc.component.widget.LogoOnOff.getInstance();
       if (logo) {
         logo.setOnLine(value);
       }
-      value ? this.__clientHeartbeatPinger.start() : this.__clientHeartbeatPinger.stop();
+
+      if (value) {
+        this.__clientHeartbeatWWPinger.postMessage(["start", this.getHeartbeatInterval()]);
+      } else {
+        this.__clientHeartbeatWWPinger.postMessage(["stop"]);
+      }
     },
 
     _applyHeartbeatInterval: function(value) {
-      this.__clientHeartbeatPinger.setInterval(value);
+      this.__clientHeartbeatWWPinger.postMessage(["start", value]);
+    },
+
+    __pingServer: function() {
+      const socket = osparc.wrapper.WebSocket.getInstance();
+      try {
+        socket.emit("client_heartbeat");
+      } catch (error) {
+        // no need to handle the error, nor does it need to cause further issues
+        // it is ok to eat it up
+      }
     }
-  } // members
+  }
 });

services/web/client/source/resource/osparc/pacemaker.js

@@ -0,0 +1,20 @@
+onmessage = e => {
+  const action = e.data[0];
+  switch (action) {
+    case "start": {
+      if (this.__timer) {
+        clearInterval(this.__timer);
+      }
+      const newInterval = e.data[1];
+      this.__timer = setInterval(() => {
+        postMessage("interval");
+      }, newInterval);
+      break;
+    }
+    case "stop":
+      if (this.__timer) {
+        clearInterval(this.__timer);
+      }
+      break;
+  }
+};

services/web/server/src/simcore_service_webserver/socketio/handlers.py

@@ -18,7 +18,6 @@
 
 from ..groups_api import list_user_groups
 from ..login.decorators import RQT_USERID_KEY, login_required
-from ..resource_manager.config import get_service_deletion_timeout
 from ..resource_manager.websocket_manager import managed_resource
 from .config import get_socket_server
 from .events import post_messages
@@ -53,9 +52,10 @@ async def connect(sid: str, environ: Dict, app: web.Application) -> bool:
         raise SocketIOConnectionError(f"Unexpected error: {exc}") from exc
 
     # Send service_deletion_timeout to client
-    # the interval should be < get_service_deletion_timeout(app) to avoid
-    # issues, assuming half of the interval and not less the 2 seconds
-    emit_interval: int = max(2, get_service_deletion_timeout(app) // 2)
+    # 2 seconds avoids GC from removing the services to early
+    # this has been tested and is working with good results
+    # the previous implementation was not working as expected
+    emit_interval: int = 2
     log.info("Sending set_heartbeat_emit_interval with %s", emit_interval)
 
     user_id = request.get(RQT_USERID_KEY, ANONYMOUS_USER_ID)