feat: Notify systemd for start, stop, watchdog

Author: chrthi

lib/controller.ts

@@ -8,6 +8,7 @@ import utils from './util/utils';
 import stringify from 'json-stable-stringify-without-jsonify';
 import assert from 'assert';
 import bind from 'bind-decorator';
+import { optionalRequire } from 'optional-require';
 
 // Extensions
 import ExtensionFrontend from './extension/frontend';
@@ -39,6 +40,8 @@ const AllExtensions = [
 type ExtensionArgs = [Zigbee, MQTT, State, PublishEntityState, EventBus,
     (enable: boolean, name: string) => Promise<void>, () => void, (extension: Extension) => Promise<void>];
 
+const sdNotify = process.env.NOTIFY_SOCKET ? optionalRequire('sd-notify') : null;
+
 export class Controller {
     private eventBus: EventBus;
     private zigbee: Zigbee;
@@ -165,6 +168,10 @@ export class Controller {
             (data) => utils.publishLastSeen(data, settings.get(), false, this.publishEntityState));
 
         logger.info(`Zigbee2MQTT started!`);
+
+        if ((sdNotify?.watchdogInterval() || 0) > 0)
+            sdNotify.startWatchdogMode(Math.floor(sdNotify.watchdogInterval() / 2));
+        sdNotify?.ready();
     }
 
     @bind async enableDisableExtension(enable: boolean, name: string): Promise<void> {
@@ -189,6 +196,8 @@ export class Controller {
     }
 
     async stop(restart = false): Promise<void> {
+        sdNotify?.stopping();
+
         // Call extensions
         await this.callExtensions('stop', this.extensions);
         this.eventBus.removeListeners(this);
@@ -205,6 +214,8 @@ export class Controller {
             logger.error('Failed to stop Zigbee2MQTT');
             await this.exit(1, restart);
         }
+
+        sdNotify?.stopWatchdogMode();
     }
 
     async exit(code: number, restart = false): Promise<void> {

package-lock.json

@@ -53,6 +53,7 @@
     "moment": "^2.30.1",
     "mqtt": "^5.3.4",
     "object-assign-deep": "^0.4.0",
+    "optional-require": "^1.1.8",
     "rimraf": "^5.0.5",
     "semver": "^7.5.4",
     "source-map-support": "^0.5.21",
@@ -111,5 +112,8 @@
   },
   "bin": {
     "zigbee2mqtt": "cli.js"
+  },
+  "optionalDependencies": {
+    "sd-notify": "^2.8.0"
   }
 }

package.json

@@ -36,7 +36,8 @@ Description=zigbee2mqtt
 After=network.target
 
 [Service]
-ExecStart=/usr/bin/npm start
+Type=notify
+ExecStart=/usr/bin/node index.js
 WorkingDirectory=/opt/zigbee2mqtt
 StandardOutput=inherit
 StandardError=inherit

scripts/install.sh

@@ -1,3 +1,4 @@
+process.env.NOTIFY_SOCKET = "mocked";
 const data = require('./stub/data');
 const logger = require('./stub/logger');
 const zigbeeHerdsman = require('./stub/zigbeeHerdsman');
@@ -16,6 +17,16 @@ const mocksClear = [
 
 const fs = require('fs');
 
+jest.mock('sd-notify', () => {
+    return {
+        watchdogInterval: () => {return 3000;},
+        startWatchdogMode: (interval) => {},
+        stopWatchdogMode: () => {},
+        ready: () => {},
+        stopping: () => {},
+    };
+}, {virtual: true});
+
 describe('Controller', () => {
     let controller;
     let mockExit;