refactor default modules: move scheduleTimer to one place (#3837)

see #3819

---------

Co-authored-by: Kristjan ESPERANTO <35647502+KristjanESPERANTO@users.noreply.github.com>
Co-authored-by: Veeck <github@veeck.de>

CHANGELOG.md

@@ -16,6 +16,8 @@ Thanks to: @dathbe.
 ### Changed
 
 - [clock] Add CSS to prevent line breaking of sunset/sunrise time display (#3816)
+- [core] Enhance system information logging format and include additional env and RAM details (#3839)
+- [refactor] Add new file `js/module_functions.js` to move code used in several modules to one place (#3837)
 
 ### Updated
 

js/module_functions.js

@@ -0,0 +1,18 @@
+/**
+ * Schedule the timer for the next update
+ * @param {object} timer The timer of the module
+ * @param {bigint} intervalMS interval in milliseconds
+ * @param {Function} callback function to call when the timer expires
+ */
+const scheduleTimer = function (timer, intervalMS, callback) {
+	if (process.env.JEST_WORKER_ID === undefined) {
+		// only set timer when not running in jest
+		let tmr = timer;
+		clearTimeout(tmr);
+		tmr = setTimeout(function () {
+			callback();
+		}, intervalMS);
+	}
+};
+
+module.exports = { scheduleTimer };

js/utils.js

@@ -23,12 +23,16 @@ module.exports = {
 				osInfo: "platform, distro, release, arch",
 				versions: "kernel, node, npm, pm2"
 			});
-			let systemDataString = `System information:
-					### SYSTEM:   manufacturer: ${staticData.system.manufacturer}; model: ${staticData.system.model}; virtual: ${staticData.system.virtual}
-					### OS:       platform: ${staticData.osInfo.platform}; distro: ${staticData.osInfo.distro}; release: ${staticData.osInfo.release}; arch: ${staticData.osInfo.arch}; kernel: ${staticData.versions.kernel}
-					### VERSIONS: electron: ${process.versions.electron}; used node: ${staticData.versions.node}; installed node: ${installedNodeVersion}; npm: ${staticData.versions.npm}; pm2: ${staticData.versions.pm2}
-					### OTHER:    timeZone: ${Intl.DateTimeFormat().resolvedOptions().timeZone}; ELECTRON_ENABLE_GPU: ${process.env.ELECTRON_ENABLE_GPU}`
-				.replace(/\t/g, "");
+			let systemDataString = [
+				"\n#####  System Information  #####",
+				`- SYSTEM:    manufacturer: ${staticData.system.manufacturer}; model: ${staticData.system.model}; virtual: ${staticData.system.virtual}; timeZone: ${Intl.DateTimeFormat().resolvedOptions().timeZone}`,
+				`- OS:        platform: ${staticData.osInfo.platform}; distro: ${staticData.osInfo.distro}; release: ${staticData.osInfo.release}; arch: ${staticData.osInfo.arch}; kernel: ${staticData.versions.kernel}`,
+				`- VERSIONS:  electron: ${process.versions.electron}; used node: ${staticData.versions.node}; installed node: ${installedNodeVersion}; npm: ${staticData.versions.npm}; pm2: ${staticData.versions.pm2}`,
+				`- ENV:       XDG_SESSION_TYPE: ${process.env.XDG_SESSION_TYPE}; MM_CONFIG_FILE: ${process.env.MM_CONFIG_FILE};`,
+				`             WAYLAND_DISPLAY:  ${process.env.WAYLAND_DISPLAY}; DISPLAY: ${process.env.DISPLAY}; ELECTRON_ENABLE_GPU: ${process.env.ELECTRON_ENABLE_GPU}`,
+				`- RAM:       total: ${(os.totalmem() / 1024 / 1024).toFixed(2)} MB; free: ${(os.freemem() / 1024 / 1024).toFixed(2)} MB; used: ${((os.totalmem() - os.freemem()) / 1024 / 1024).toFixed(2)} MB`,
+				`- UPTIME:    ${Math.floor(os.uptime() / 60)} minutes`
+			].join("\n");
 			Log.info(systemDataString);
 
 			// Return is currently only for jest

modules/default/calendar/calendarfetcher.js

@@ -3,6 +3,7 @@ const ical = require("node-ical");
 const Log = require("logger");
 const NodeHelper = require("node_helper");
 const CalendarFetcherUtils = require("./calendarfetcherutils");
+const { scheduleTimer } = require("#module_functions");
 
 /**
  *
@@ -65,31 +66,18 @@ const CalendarFetcher = function (url, reloadInterval, excludedEvents, maximumEn
 					});
 				} catch (error) {
 					fetchFailedCallback(this, error);
-					scheduleTimer();
+					scheduleTimer(reloadTimer, reloadInterval, fetchCalendar);
 					return;
 				}
 				this.broadcastEvents();
-				scheduleTimer();
+				scheduleTimer(reloadTimer, reloadInterval, fetchCalendar);
 			})
 			.catch((error) => {
 				fetchFailedCallback(this, error);
-				scheduleTimer();
+				scheduleTimer(reloadTimer, reloadInterval, fetchCalendar);
 			});
 	};
 
-	/**
-	 * Schedule the timer for the next update.
-	 */
-	const scheduleTimer = function () {
-		if (process.env.JEST_WORKER_ID === undefined) {
-			// only set timer when not running in jest
-			clearTimeout(reloadTimer);
-			reloadTimer = setTimeout(function () {
-				fetchCalendar();
-			}, reloadInterval);
-		}
-	};
-
 	/* public methods */
 
 	/**

modules/default/newsfeed/newsfeedfetcher.js

@@ -5,6 +5,7 @@ const iconv = require("iconv-lite");
 const { htmlToText } = require("html-to-text");
 const Log = require("logger");
 const NodeHelper = require("node_helper");
+const { scheduleTimer } = require("#module_functions");
 
 /**
  * Responsible for requesting an update on the set interval and broadcasting the data.
@@ -79,12 +80,12 @@ const NewsfeedFetcher = function (url, reloadInterval, encoding, logFeedWarnings
 
 		parser.on("error", (error) => {
 			fetchFailedCallback(this, error);
-			scheduleTimer();
+			scheduleTimer(reloadTimer, reloadIntervalMS, fetchNews);
 		});
 
 		//"end" event is not broadcast if the feed is empty but "finish" is used for both
 		parser.on("finish", () => {
-			scheduleTimer();
+			scheduleTimer(reloadTimer, reloadIntervalMS, fetchNews);
 		});
 
 		parser.on("ttl", (minutes) => {
@@ -120,23 +121,10 @@ const NewsfeedFetcher = function (url, reloadInterval, encoding, logFeedWarnings
 			})
 			.catch((error) => {
 				fetchFailedCallback(this, error);
-				scheduleTimer();
+				scheduleTimer(reloadTimer, reloadIntervalMS, fetchNews);
 			});
 	};
 
-	/**
-	 * Schedule the timer for the next update.
-	 */
-	const scheduleTimer = function () {
-		if (process.env.JEST_WORKER_ID === undefined) {
-			// only set timer when not running in jest
-			clearTimeout(reloadTimer);
-			reloadTimer = setTimeout(function () {
-				fetchNews();
-			}, reloadIntervalMS);
-		}
-	};
-
 	/* public methods */
 
 	/**

package.json

@@ -23,6 +23,11 @@
 		"https://github.com/MagicMirrorOrg/MagicMirror/graphs/contributors"
 	],
 	"type": "commonjs",
+	"imports": {
+		"#module_functions": {
+			"default": "./js/module_functions.js"
+		}
+	},
 	"main": "js/electron.js",
 	"scripts": {
 		"config:check": "node js/check_config.js",