From 2b36f7492bbc8cbf3648495c8b6fc08edfcc62a2 Mon Sep 17 00:00:00 2001
From: Nerivec <62446222+Nerivec@users.noreply.github.com>
Date: Wed, 19 Jun 2024 20:51:04 +0200
Subject: [PATCH] fix: Optional watchdog for "adapter disconnected"-type events
 (non-node-crash) (#23043)

* Watchdog for "adapter disconnected"-type events (non-node-crash)

* Reset watchdog count on successful start.

* Cleanup

* Switch from argv to env.
---
 index.js | 88 +++++++++++++++++++++++++++++++++++++++++++++++---------
 1 file changed, 74 insertions(+), 14 deletions(-)

diff --git a/index.js b/index.js
index 8dac64a0..bd400131 100644
--- a/index.js
+++ b/index.js
@@ -9,32 +9,65 @@ require('source-map-support').install();
 
 let controller;
 let stopping = false;
+let watchdog = process.env.Z2M_WATCHDOG != undefined;
+let watchdogCount = 0;
+let unsolicitedStop = false;
+// csv in minutes, default: 1min, 5min, 15min, 30min, 60min
+let watchdogDelays = [60000, 300000, 900000, 1800000, 3600000];
+
+if (watchdog && process.env.Z2M_WATCHDOG !== 'default') {
+    if (/^(?:(?:[0-9]*[.])?[0-9]+)+(?:,?(?:[0-9]*[.])?[0-9]+)*$/.test(process.env.Z2M_WATCHDOG)) {
+        watchdogDelays = process.env.Z2M_WATCHDOG.split(',').map((v) => parseFloat(v) * 60000);
+    } else {
+        console.log(`Invalid watchdog delays (must use number-only CSV format representing minutes, example: 'Z2M_WATCHDOG=1,5,15,30,60'.`);
+        process.exit(1);
+    }
+}
 
 const hashFile = path.join(__dirname, 'dist', '.hash');
 
+async function triggerWatchdog(code) {
+    const delay = watchdogDelays[watchdogCount];
+    watchdogCount += 1;
+
+    if (delay) {
+        // garbage collector
+        controller = undefined;
+
+        console.log(`WATCHDOG: Waiting ${delay/60000}min before next start try.`);
+        await new Promise((resolve) => setTimeout(resolve, delay));
+        await start();
+    } else {
+        process.exit(code);
+    }
+}
+
 async function restart() {
     await stop(true);
     await start();
 }
 
-async function exit(code, restart) {
+async function exit(code, restart = false) {
     if (!restart) {
-        process.exit(code);
+        if (watchdog && unsolicitedStop) {
+            await triggerWatchdog(code);
+        } else {
+            process.exit(code);
+        }
     }
 }
 
 async function currentHash() {
     const git = require('git-last-commit');
+
     return new Promise((resolve) => {
-        git.getLastCommit((err, commit) => {
-            if (err) resolve('unknown');
-            else resolve(commit.shortHash);
-        });
+        git.getLastCommit((err, commit) => err ? resolve('unknown') : resolve(commit.shortHash));
     });
 }
 
 async function writeHash() {
     const hash = await currentHash();
+
     fs.writeFileSync(hashFile, hash);
 }
 
@@ -42,8 +75,10 @@ async function build(reason) {
     return new Promise((resolve, reject) => {
         process.stdout.write(`Building Zigbee2MQTT... (${reason})`);
         rimrafSync('dist');
+
         const env = {...process.env};
         const _600mb = 629145600;
+
         if (_600mb > os.totalmem() && !env.NODE_OPTIONS) {
             // Prevent OOM on tsc compile for system with low memory
             // https://github.com/Koenkk/zigbee2mqtt/issues/12034
@@ -53,10 +88,11 @@ async function build(reason) {
         exec('npm run build', {env, cwd: __dirname}, async (err, stdout, stderr) => {
             if (err) {
                 process.stdout.write(', failed\n');
+
                 if (err.code === 134) {
-                    process.stderr.write(
-                        '\n\nBuild failed; ran out-of-memory, free some memory (RAM) and start again\n\n');
+                    process.stderr.write('\n\nBuild failed; ran out-of-memory, free some memory (RAM) and start again\n\n');
                 }
+
                 reject(err);
             } else {
                 process.stdout.write(', finished\n');
@@ -79,42 +115,65 @@ async function checkDist() {
 }
 
 async function start() {
+    console.log(`Starting Zigbee2MQTT ${watchdog ? `with watchdog (${watchdogDelays})` : `without watchdog`}.`);
     await checkDist();
 
     const version = engines.node;
+
     if (!semver.satisfies(process.version, version)) {
-        console.log(`\t\tZigbee2MQTT requires node version ${version}, you are running ${process.version}!\n`); // eslint-disable-line
+        console.log(`\t\tZigbee2MQTT requires node version ${version}, you are running ${process.version}!\n`);
     }
 
     // Validate settings
     const settings = require('./dist/util/settings');
+
     settings.reRead();
+
     const errors = settings.validate();
+
     if (errors.length > 0) {
+        unsolicitedStop = false;
+
         console.log(`\n\n!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!`);
         console.log('            READ THIS CAREFULLY\n');
         console.log(`Refusing to start because configuration is not valid, found the following errors:`);
+
         for (const error of errors) {
             console.log(`- ${error}`);
         }
-        console.log(`\nIf you don't know how to solve this, read https://www.zigbee2mqtt.io/guide/configuration`); // eslint-disable-line
+
+        console.log(`\nIf you don't know how to solve this, read https://www.zigbee2mqtt.io/guide/configuration`);
         console.log(`\n!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!\n\n`);
-        exit(1);
+
+        return exit(1);
     }
 
     const Controller = require('./dist/controller');
     controller = new Controller(restart, exit);
+
     await controller.start();
+
+    // consider next controller.stop() call as unsolicited, only after successful first start
+    unsolicitedStop = true;
+    watchdogCount = 0;// reset
 }
 
 async function stop(restart) {
+    // `handleQuit` or `restart` never unsolicited
+    unsolicitedStop = false;
+
     await controller.stop(restart);
 }
 
 async function handleQuit() {
-    if (!stopping && controller) {
-        stopping = true;
-        await stop(false);
+    if (!stopping) {
+        if (controller) {
+            stopping = true;
+
+            await stop(false);
+        } else {
+            process.exit(0);
+        }
     }
 }
 
@@ -129,5 +188,6 @@ if (require.main === module || require.main.filename.endsWith(path.sep + 'cli.js
 } else {
     process.on('SIGINT', handleQuit);
     process.on('SIGTERM', handleQuit);
+
     module.exports = {start};
 }