Merge pull request #4095 from louislam/update-3

Rewrite Tailscale ping using spawnSync
louislam · Nov 24, 2023 · 711380b · 711380b
2 parents f28dccf + 9536c6a
commit 711380b
Show file tree

Hide file tree

Showing 4 changed files with 52 additions and 34 deletions.
diff --git a/server/monitor-types/tailscale-ping.js b/server/monitor-types/tailscale-ping.js
@@ -1,6 +1,6 @@
 const { MonitorType } = require("./monitor-type");
-const { UP, log } = require("../../src/util");
-const exec = require("child_process").exec;
+const { UP } = require("../../src/util");
+const childProcess = require("child_process");
 
 /**
  * A TailscalePing class extends the MonitorType.
@@ -23,7 +23,6 @@ class TailscalePing extends MonitorType {
             let tailscaleOutput = await this.runTailscalePing(monitor.hostname, monitor.interval);
             this.parseTailscaleOutput(tailscaleOutput, heartbeat);
         } catch (err) {
-            log.debug("Tailscale", err);
             // trigger log function somewhere to display a notification or alert to the user (but how?)
             throw new Error(`Error checking Tailscale ping: ${err}`);
         }
@@ -33,30 +32,26 @@ class TailscalePing extends MonitorType {
      * Runs the Tailscale ping command to the given URL.
      *
      * @param {string} hostname - The hostname to ping.
+     * @param {number} interval
      * @returns {Promise<string>} - A Promise that resolves to the output of the Tailscale ping command
      * @throws Will throw an error if the command execution encounters any error.
      */
     async runTailscalePing(hostname, interval) {
-        let cmd = `tailscale ping ${hostname}`;
-
-        log.debug("Tailscale", cmd);
-
-        return new Promise((resolve, reject) => {
-            let timeout = interval * 1000 * 0.8;
-            exec(cmd, { timeout: timeout }, (error, stdout, stderr) => {
-                // we may need to handle more cases if tailscale reports an error that isn't necessarily an error (such as not-logged in or DERP health-related issues)
-                if (error) {
-                    reject(`Execution error: ${error.message}`);
-                    return;
-                }
-                if (stderr) {
-                    reject(`Error in output: ${stderr}`);
-                    return;
-                }
-
-                resolve(stdout);
-            });
+        let timeout = interval * 1000 * 0.8;
+        let res = childProcess.spawnSync("tailscale", [ "ping", hostname ], {
+            timeout: timeout
         });
+        if (res.error) {
+            throw new Error(`Execution error: ${res.error.message}`);
+        }
+        if (res.stderr && res.stderr.toString()) {
+            throw new Error(`Error in output: ${res.stderr.toString()}`);
+        }
+        if (res.stdout && res.stdout.toString()) {
+            return res.stdout.toString();
+        } else {
+            throw new Error("No output from Tailscale ping");
+        }
     }
 
     /**
@@ -74,7 +69,7 @@ class TailscalePing extends MonitorType {
                 heartbeat.status = UP;
                 let time = line.split(" in ")[1].split(" ")[0];
                 heartbeat.ping = parseInt(time);
-                heartbeat.msg = line;
+                heartbeat.msg = "OK";
                 break;
             } else if (line.includes("timed out")) {
                 throw new Error(`Ping timed out: "${line}"`);

diff --git a/server/socket-handlers/general-socket-handler.js b/server/socket-handlers/general-socket-handler.js
@@ -42,24 +42,40 @@ module.exports.generalSocketHandler = (socket, server) => {
     });
 
     socket.on("getGameList", async (callback) => {
-        callback({
-            ok: true,
-            gameList: getGameList(),
-        });
+        try {
+            checkLogin(socket);
+            callback({
+                ok: true,
+                gameList: getGameList(),
+            });
+        } catch (e) {
+            callback({
+                ok: false,
+                msg: e.message,
+            });
+        }
     });
 
     socket.on("testChrome", (executable, callback) => {
-        // Just noticed that await call could block the whole socket.io server!!! Use pure promise instead.
-        testChrome(executable).then((version) => {
-            callback({
-                ok: true,
-                msg: "Found Chromium/Chrome. Version: " + version,
+        try {
+            checkLogin(socket);
+            // Just noticed that await call could block the whole socket.io server!!! Use pure promise instead.
+            testChrome(executable).then((version) => {
+                callback({
+                    ok: true,
+                    msg: "Found Chromium/Chrome. Version: " + version,
+                });
+            }).catch((e) => {
+                callback({
+                    ok: false,
+                    msg: e.message,
+                });
             });
-        }).catch((e) => {
+        } catch (e) {
             callback({
                 ok: false,
                 msg: e.message,
             });
-        });
+        }
     });
 };
diff --git a/src/util.js b/src/util.js
@@ -101,6 +101,9 @@ class Logger {
      * @param level Log level. One of INFO, WARN, ERROR, DEBUG or can be customized.
      */
     log(module, msg, level) {
+        if (level === "DEBUG" && !exports.isDev) {
+            return;
+        }
         if (this.hideLog[level] && this.hideLog[level].includes(module.toLowerCase())) {
             return;
         }

diff --git a/src/util.ts b/src/util.ts
@@ -115,6 +115,10 @@ class Logger {
      * @param level Log level. One of INFO, WARN, ERROR, DEBUG or can be customized.
      */
     log(module: string, msg: any, level: string) {
+        if (level === "DEBUG" && !isDev) {
+            return;
+        }
+
         if (this.hideLog[level] && this.hideLog[level].includes(module.toLowerCase())) {
             return;
         }