add ConfigError

Author: khassel

js/app.js

@@ -14,6 +14,7 @@ const { setGlobalDispatcher, Agent } = require("undici");
 
 const Server = require("./server");
 const Utils = require("./utils");
+const { ConfigError } = require("./utils");
 
 const { getEnvVarsAsObj } = require("#server_functions");
 // common timeout value, provide environment override in case
@@ -258,7 +259,12 @@ function App () {
 			Log.log("Sockets connected & modules started ...");
 
 			return global.config;
-		} catch {
+		} catch (err) {
+			// planned ConfigErrors already logged their message before throwing
+			if (!(err instanceof ConfigError)) {
+				Log.error("Unexpected error during startup:", err);
+			}
+
 			const int32 = new Int32Array(new SharedArrayBuffer(4));
 			// wait 1000ms before exiting so that child processes (e.g. systeminformation) have some additional time
 			Atomics.wait(int32, 0, 0, 1000);

js/utils.js

@@ -14,6 +14,13 @@ const { getConfigFilePath } = require("#server_functions");
 
 const linter = new Linter({ configType: "flat" });
 
+class ConfigError extends Error {
+	constructor (message) {
+		super(message);
+		this.name = "ConfigError";
+	}
+}
+
 const requireFromString = (src) => {
 	const m = new module.constructor();
 	m._compile(src, "");
@@ -172,7 +179,7 @@ const loadConfig = () => {
 		} else {
 			Log.error(`Cannot access config file: ${configFilename}\n${error.message}`);
 		}
-		throw new Error("process.exit:1", { cause: error });
+		throw new ConfigError("");
 	}
 };
 
@@ -219,7 +226,7 @@ const checkConfigFile = (configObject) => {
 			errorMessage += `\nLine ${error.line} column ${error.column}: ${error.message}`;
 		}
 		Log.error(errorMessage);
-		throw new Error("process.exit:1");
+		throw new ConfigError("");
 	}
 };
 
@@ -241,27 +248,27 @@ const validateModulePositions = (data) => {
 	// `modules` always exists (defaults.js provides a default array), but guard against it being overridden with a non-array value
 	if (data.modules !== undefined && !Array.isArray(data.modules)) {
 		Log.error("This module configuration contains errors:\nmodules must be an array");
-		throw new Error("process.exit:1");
+		throw new ConfigError("");
 	}
 
 	// Validate each module entry
 	for (const [index, mod] of (data.modules ?? []).entries()) {
 		// Each module entry must be an object so we can safely inspect its fields
 		if (mod === null || typeof mod !== "object" || Array.isArray(mod)) {
 			Log.error(`This module configuration contains errors:\n${JSON.stringify(mod, null, 2)}\nmodule entry must be an object`);
-			throw new Error("process.exit:1");
+			throw new ConfigError("");
 		}
 
 		// `module` (the module name) is required and must be a string
 		if (typeof mod.module !== "string") {
 			Log.error(`This module configuration contains errors:\n${JSON.stringify(mod, null, 2)}\nmodule: must be a string`);
-			throw new Error("process.exit:1");
+			throw new ConfigError("");
 		}
 
 		// `position` is optional, but must be a string when provided
 		if (mod.position !== undefined && typeof mod.position !== "string") {
 			Log.error(`This module configuration contains errors:\n${JSON.stringify(mod, null, 2)}\nposition: must be a string`);
-			throw new Error("process.exit:1");
+			throw new ConfigError("");
 		}
 
 		// `position` is optional, but when set it must match a known region
@@ -274,4 +281,4 @@ const validateModulePositions = (data) => {
 	Log.info(styleText("green", "Your modules structure configuration doesn't contain errors :)"));
 };
 
-module.exports = { loadConfig, getModulePositions, moduleHasValidPosition, getAvailableModulePositions, checkConfigFile };
+module.exports = { loadConfig, getModulePositions, moduleHasValidPosition, getAvailableModulePositions, checkConfigFile, ConfigError };

tests/unit/classes/utils_spec.js

@@ -1,7 +1,7 @@
 const fs = require("node:fs");
 
 const Log = require("../../../js/logger");
-const { checkConfigFile } = require("../../../js/utils");
+const { checkConfigFile, ConfigError } = require("../../../js/utils");
 
 const createConfigObject = (modules) => ({
 	configFilename: "config.js",
@@ -14,13 +14,13 @@ const runCheck = (modules) => {
 };
 
 const expectExitForModules = (modules) => {
-	vi.spyOn(process, "exit").mockImplementation((code) => {
-		throw new Error(`process.exit:${code}`);
+	vi.spyOn(process, "exit").mockImplementation(() => {
+		throw new ConfigError("");
 	});
 
 	expect(() => {
 		runCheck(modules);
-	}).toThrow("process.exit:1");
+	}).toThrow(ConfigError);
 };
 
 describe("utils", () => {
@@ -69,8 +69,8 @@ describe("utils", () => {
 	});
 
 	it("warns for unknown positions without exiting", () => {
-		const exitSpy = vi.spyOn(process, "exit").mockImplementation((code) => {
-			throw new Error(`process.exit:${code}`);
+		const exitSpy = vi.spyOn(process, "exit").mockImplementation(() => {
+			throw new ConfigError("");
 		});
 
 		expect(() => {