Merge pull request #4095 from louislam/update-3

Rewrite Tailscale ping using spawnSync
This commit is contained in:
Louis Lam 2023-11-24 17:44:24 +08:00 committed by GitHub
commit 711380bbbe
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 53 additions and 35 deletions

View file

@ -1,6 +1,6 @@
const { MonitorType } = require("./monitor-type"); const { MonitorType } = require("./monitor-type");
const { UP, log } = require("../../src/util"); const { UP } = require("../../src/util");
const exec = require("child_process").exec; const childProcess = require("child_process");
/** /**
* A TailscalePing class extends the MonitorType. * A TailscalePing class extends the MonitorType.
@ -23,7 +23,6 @@ class TailscalePing extends MonitorType {
let tailscaleOutput = await this.runTailscalePing(monitor.hostname, monitor.interval); let tailscaleOutput = await this.runTailscalePing(monitor.hostname, monitor.interval);
this.parseTailscaleOutput(tailscaleOutput, heartbeat); this.parseTailscaleOutput(tailscaleOutput, heartbeat);
} catch (err) { } catch (err) {
log.debug("Tailscale", err);
// trigger log function somewhere to display a notification or alert to the user (but how?) // trigger log function somewhere to display a notification or alert to the user (but how?)
throw new Error(`Error checking Tailscale ping: ${err}`); 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. * Runs the Tailscale ping command to the given URL.
* *
* @param {string} hostname - The hostname to ping. * @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 * @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. * @throws Will throw an error if the command execution encounters any error.
*/ */
async runTailscalePing(hostname, interval) { async runTailscalePing(hostname, interval) {
let cmd = `tailscale ping ${hostname}`;
log.debug("Tailscale", cmd);
return new Promise((resolve, reject) => {
let timeout = interval * 1000 * 0.8; let timeout = interval * 1000 * 0.8;
exec(cmd, { timeout: timeout }, (error, stdout, stderr) => { let res = childProcess.spawnSync("tailscale", [ "ping", hostname ], {
// 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) timeout: timeout
if (error) {
reject(`Execution error: ${error.message}`);
return;
}
if (stderr) {
reject(`Error in output: ${stderr}`);
return;
}
resolve(stdout);
});
}); });
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; heartbeat.status = UP;
let time = line.split(" in ")[1].split(" ")[0]; let time = line.split(" in ")[1].split(" ")[0];
heartbeat.ping = parseInt(time); heartbeat.ping = parseInt(time);
heartbeat.msg = line; heartbeat.msg = "OK";
break; break;
} else if (line.includes("timed out")) { } else if (line.includes("timed out")) {
throw new Error(`Ping timed out: "${line}"`); throw new Error(`Ping timed out: "${line}"`);

View file

@ -42,13 +42,23 @@ module.exports.generalSocketHandler = (socket, server) => {
}); });
socket.on("getGameList", async (callback) => { socket.on("getGameList", async (callback) => {
try {
checkLogin(socket);
callback({ callback({
ok: true, ok: true,
gameList: getGameList(), gameList: getGameList(),
}); });
} catch (e) {
callback({
ok: false,
msg: e.message,
});
}
}); });
socket.on("testChrome", (executable, callback) => { socket.on("testChrome", (executable, callback) => {
try {
checkLogin(socket);
// Just noticed that await call could block the whole socket.io server!!! Use pure promise instead. // Just noticed that await call could block the whole socket.io server!!! Use pure promise instead.
testChrome(executable).then((version) => { testChrome(executable).then((version) => {
callback({ callback({
@ -61,5 +71,11 @@ module.exports.generalSocketHandler = (socket, server) => {
msg: e.message, msg: e.message,
}); });
}); });
} catch (e) {
callback({
ok: false,
msg: e.message,
});
}
}); });
}; };

View file

@ -101,6 +101,9 @@ class Logger {
* @param level Log level. One of INFO, WARN, ERROR, DEBUG or can be customized. * @param level Log level. One of INFO, WARN, ERROR, DEBUG or can be customized.
*/ */
log(module, msg, level) { log(module, msg, level) {
if (level === "DEBUG" && !exports.isDev) {
return;
}
if (this.hideLog[level] && this.hideLog[level].includes(module.toLowerCase())) { if (this.hideLog[level] && this.hideLog[level].includes(module.toLowerCase())) {
return; return;
} }

View file

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