use variable defaultModulesDir

khassel · khassel · commit 49e814b24d78 · 2026-01-24T22:59:41.000+01:00
diff --git a/defaultmodules/updatenotification/node_helper.js b/defaultmodules/updatenotification/node_helper.js
@@ -2,7 +2,7 @@ const fs = require("node:fs");
 const path = require("node:path");
 const NodeHelper = require("node_helper");
 
-const defaultModules = require(`${global.root_path}/defaultmodules/defaultmodules`);
+const defaultModules = require(`${global.root_path}/${global.defaultModulesDir}/defaultmodules`);
 const GitHelper = require("./git_helper");
 const UpdateHelper = require("./update_helper");
 
diff --git a/js/app.js b/js/app.js
@@ -13,7 +13,6 @@ global.root_path = path.resolve(`${__dirname}/../`);
 const Server = require(`${__dirname}/server`);
 const Utils = require(`${__dirname}/utils`);
 
-const defaultModules = require(`${global.root_path}/defaultmodules/defaultmodules`);
 // used to control fetch timeout for node_helpers
 const { setGlobalDispatcher, Agent } = require("undici");
 const { getEnvVarsAsObj, getConfigFilePath } = require("#server_functions");
@@ -57,6 +56,7 @@ process.on("uncaughtException", function (err) {
 function App () {
 	let nodeHelpers = [];
 	let httpServer;
+	let defaultModules;
 
 	/**
 	 * Loads the config file. Combines it with the defaults and returns the config
@@ -185,7 +185,7 @@ function App () {
 		let moduleFolder = path.resolve(`${global.root_path}/${env.modulesDir}`, module);
 
 		if (defaultModules.includes(moduleName)) {
-			const defaultModuleFolder = path.resolve(`${global.root_path}/defaultmodules/`, module);
+			const defaultModuleFolder = path.resolve(`${global.root_path}/${global.defaultModulesDir}/`, module);
 			if (!global.mmTestMode) {
 				moduleFolder = defaultModuleFolder;
 			} else {
@@ -291,6 +291,9 @@ function App () {
 	this.start = async function () {
 		config = await loadConfig();
 
+		global.defaultModulesDir = config.defaultModulesDir;
+		defaultModules = require(`${global.root_path}/${global.defaultModulesDir}/defaultmodules`);
+
 		Log.setLogLevel(config.logLevel);
 
 		// get the used module positions
diff --git a/js/defaults.js b/js/defaults.js
@@ -20,6 +20,7 @@ const defaults = {
 	zoom: 1,
 	customCss: "css/custom.css",
 	foreignModulesDir: "modules",
+	defaultModulesDir: "defaultmodules",
 	// httpHeaders used by helmet, see https://helmetjs.github.io/. You can add other/more object values by overriding this in config.js,
 	// e.g. you need to add `frameguard: false` for embedding MagicMirror in another website, see https://github.com/MagicMirrorOrg/MagicMirror/issues/2847
 	httpHeaders: { contentSecurityPolicy: false, crossOriginOpenerPolicy: false, crossOriginEmbedderPolicy: false, crossOriginResourcePolicy: false, originAgentCluster: false },
diff --git a/js/loader.js b/js/loader.js
@@ -17,6 +17,7 @@ const Loader = (function () {
 	const getEnvVarsFromConfig = function () {
 		return {
 			modulesDir: config.foreignModulesDir || "modules",
+			defaultModulesDir: config.defaultModulesDir || "defaultmodules",
 			customCss: config.customCss || "css/custom.css"
 		};
 	};
@@ -103,7 +104,7 @@ const Loader = (function () {
 			let moduleFolder = `${envVars.modulesDir}/${module}`;
 
 			if (defaultModules.indexOf(moduleName) !== -1) {
-				const defaultModuleFolder = `defaultmodules/${module}`;
+				const defaultModuleFolder = `${envVars.defaultModulesDir}/${module}`;
 				if (window.name !== "jsdom") {
 					moduleFolder = defaultModuleFolder;
 				} else {
diff --git a/js/server_functions.js b/js/server_functions.js
@@ -162,7 +162,7 @@ function getUserAgent () {
  * @returns {object} environment variables key: values
  */
 function getEnvVarsAsObj () {
-	const obj = { modulesDir: `${config.foreignModulesDir}`, customCss: `${config.customCss}` };
+	const obj = { modulesDir: `${config.foreignModulesDir}`, defaultModulesDir: `${config.defaultModulesDir}`, customCss: `${config.customCss}` };
 	if (process.env.MM_MODULES_DIR) {
 		obj.modulesDir = process.env.MM_MODULES_DIR.replace(`${global.root_path}/`, "");
 	}
diff --git a/tests/e2e/modules/newsfeed_spec.js b/tests/e2e/modules/newsfeed_spec.js
@@ -80,7 +80,7 @@ describe("Newsfeed module", () => {
 
 describe("Newsfeed module located in config directory", () => {
 	beforeAll(() => {
-		fs.cpSync(`${global.root_path}/defaultmodules/newsfeed`, `${global.root_path}/config/newsfeed`, { recursive: true });
+		fs.cpSync(`${global.root_path}/${global.defaultModulesDir}/newsfeed`, `${global.root_path}/config/newsfeed`, { recursive: true });
 		process.env.MM_MODULES_DIR = "config";
 	});
 
diff --git a/tests/unit/functions/updatenotification_spec.js b/tests/unit/functions/updatenotification_spec.js
@@ -19,7 +19,8 @@ async function createGitHelper (fsStatSyncMockRef, loggerMockRef, execShellSpyRe
 
 	vi.doMock("logger", () => loggerMockRef.current);
 
-	const gitHelperModule = await import("../../../defaultmodules/updatenotification/git_helper");
+	const defaults = await import("../../../js/defaults");
+	const gitHelperModule = await import(`../../../${defaults.defaultModulesDir}/updatenotification/git_helper`);
 	const GitHelper = gitHelperModule.default || gitHelperModule;
 	const instance = new GitHelper();
 	execShellSpyRef.current = vi.spyOn(instance, "execShell");
diff --git a/tests/unit/global_vars/defaults_modules_spec.js b/tests/unit/global_vars/defaults_modules_spec.js
@@ -1,10 +1,11 @@
 const fs = require("node:fs");
 const path = require("node:path");
+const defaults = require("../../../js/defaults");
 
 const root_path = path.join(__dirname, "../../..");
 
 describe("Default modules set in defaultmodules/defaultmodules.js", () => {
-	const expectedDefaultModules = require(`${root_path}/defaultmodules/defaultmodules`);
+	const expectedDefaultModules = require(`${root_path}/${defaults.defaultModulesDir}/defaultmodules`);
 
 	for (const defaultModule of expectedDefaultModules) {
 		it(`contains a folder for defaultmodules/${defaultModule}"`, () => {
diff --git a/tests/unit/modules/default/calendar/calendar_fetcher_utils_bad_rrule.js b/tests/unit/modules/default/calendar/calendar_fetcher_utils_bad_rrule.js
@@ -1,6 +1,8 @@
 global.moment = require("moment-timezone");
 
-const CalendarFetcherUtils = require("../../../../../defaultmodules/calendar/calendarfetcherutils");
+const defaults = require("../../../js/defaults");
+
+const CalendarFetcherUtils = require(`../../../../../${defaults.defaultModulesDir}/calendar/calendarfetcherutils`);
 
 describe("Calendar fetcher utils test", () => {
 	const defaultConfig = {
diff --git a/tests/unit/modules/default/calendar/calendar_fetcher_utils_spec.js b/tests/unit/modules/default/calendar/calendar_fetcher_utils_spec.js
@@ -2,7 +2,9 @@ global.moment = require("moment-timezone");
 
 const ical = require("node-ical");
 const moment = require("moment-timezone");
-const CalendarFetcherUtils = require("../../../../../defaultmodules/calendar/calendarfetcherutils");
+const defaults = require("../../../../../js/defaults");
+
+const CalendarFetcherUtils = require(`../../../../../${defaults.defaultModulesDir}/calendar/calendarfetcherutils`);
 
 describe("Calendar fetcher utils test", () => {
 	const defaultConfig = {
diff --git a/tests/unit/modules/default/calendar/calendar_utils_spec.js b/tests/unit/modules/default/calendar/calendar_utils_spec.js
@@ -1,6 +1,8 @@
 global.moment = require("moment");
 
-const CalendarUtils = require("../../../../../defaultmodules/calendar/calendarutils");
+const defaults = require("../../../../../js/defaults");
+
+const CalendarUtils = require(`../../../../../${defaults.defaultModulesDir}/calendar/calendarutils`);
 
 describe("Calendar utils tests", () => {
 	describe("capFirst", () => {
diff --git a/tests/unit/modules/default/compliments/compliments_spec.js b/tests/unit/modules/default/compliments/compliments_spec.js
@@ -16,12 +16,13 @@ describe("Compliments module", () => {
 		global.Cron = vi.fn();
 
 		// Load the module
-		require("../../../../../defaultmodules/compliments/compliments");
+		const defaults = require("../../../../../js/defaults");
+		require(`../../../../../${defaults.defaultModulesDir}/compliments/compliments`);
 
 		// Setup module instance
 		complimentsModule.config = { ...complimentsModule.defaults };
 		complimentsModule.name = "compliments";
-		complimentsModule.file = vi.fn((path) => `http://localhost:8080/defaultmodules/compliments/${path}`);
+		complimentsModule.file = vi.fn((path) => `http://localhost:8080/${defaults.defaultModulesDir}/compliments/${path}`);
 	});
 
 	afterEach(() => {
diff --git a/tests/unit/modules/default/utils_spec.js b/tests/unit/modules/default/utils_spec.js
@@ -1,5 +1,7 @@
 global.moment = require("moment-timezone");
-const { performWebRequest, formatTime } = require("../../../../defaultmodules/utils");
+const defaults = require("../../../../js/defaults");
+
+const { performWebRequest, formatTime } = require(`../../../../${defaults.defaultModulesDir}/utils`);
 
 describe("Default modules utils tests", () => {
 	describe("performWebRequest", () => {
diff --git a/tests/unit/modules/default/weather/weather_object_spec.js b/tests/unit/modules/default/weather/weather_object_spec.js
@@ -1,4 +1,6 @@
-const WeatherObject = require("../../../../../defaultmodules/weather/weatherobject");
+const defaults = require("../../../../../js/defaults");
+
+const WeatherObject = require(`../../../../../${defaults.defaultModulesDir}/weather/weatherobject`);
 
 global.moment = require("moment-timezone");
 global.SunCalc = require("suncalc");
diff --git a/tests/unit/modules/default/weather/weather_utils_spec.js b/tests/unit/modules/default/weather/weather_utils_spec.js
@@ -1,5 +1,7 @@
-const weather = require("../../../../../defaultmodules/weather/weatherutils");
-const WeatherUtils = require("../../../../../defaultmodules/weather/weatherutils");
+const defaults = require("../../../../../js/defaults");
+
+const weather = require(`../../../../../${defaults.defaultModulesDir}/weather/weatherutils`);
+const WeatherUtils = require(`../../../../../${defaults.defaultModulesDir}/weather/weatherutils`);
 
 describe("Weather utils tests", () => {
 	describe("temperature conversion to imperial", () => {

Original file line number	Diff line number	Diff line change
`@@ -162,7 +162,7 @@ function getUserAgent () {`
`162`	`162`	`* @returns {object} environment variables key: values`
`163`	`163`	`*/`
`164`	`164`	`function getEnvVarsAsObj () {`
`165`		- const obj = { modulesDir: `${config.foreignModulesDir}`, customCss: `${config.customCss}` };
	`165`	+ const obj = { modulesDir: `${config.foreignModulesDir}`, defaultModulesDir: `${config.defaultModulesDir}`, customCss: `${config.customCss}` };
`166`	`166`	`if (process.env.MM_MODULES_DIR) {`
`167`	`167`	obj.modulesDir = process.env.MM_MODULES_DIR.replace(`${global.root_path}/`, "");
`168`	`168`	`}`