feat(electron): support object-based electronSwitches

js/electron.js

@@ -3,6 +3,7 @@
 const electron = require("electron");
 const core = require("./app");
 const Log = require("./logger");
+const { applyElectronSwitches } = require("./electron_helper");
 
 // Config
 let config = process.env.config ? JSON.parse(process.env.config) : {};
@@ -43,10 +44,7 @@ function createWindow () {
 		Log.warn("Could not get display size, using defaults ...");
 	}
 
-	app.commandLine.appendSwitch("autoplay-policy", "no-user-gesture-required");
-	for (const electronSwitch of (config.electronSwitches || [])) {
-		app.commandLine.appendSwitch(electronSwitch);
-	}
+	applyElectronSwitches(app.commandLine, config.electronSwitches);
 	let electronOptionsDefaults = {
 		width: electronSize.width,
 		height: electronSize.height,

js/electron_helper.js

@@ -0,0 +1,33 @@
+const Log = require("./logger");
+
+/**
+ * Applies Electron command-line switches (defaults + from config).
+ * @param {object} commandLine Electron commandLine API
+ * @param {Array<string|object>} [electronSwitches] User-configured switches
+ */
+function applyElectronSwitches (commandLine, electronSwitches) {
+	commandLine.appendSwitch("autoplay-policy", "no-user-gesture-required");
+	Log.debug("Activated default switch: autoplay-policy=no-user-gesture-required");
+
+	if (electronSwitches === undefined) return;
+	if (!Array.isArray(electronSwitches)) {
+		Log.error(`electronSwitches must be an array of strings or objects, got: ${JSON.stringify(electronSwitches)}`);
+		return;
+	}
+
+	for (const sw of electronSwitches) {
+		if (typeof sw === "string") {
+			commandLine.appendSwitch(sw);
+			Log.debug(`Activated switch: ${sw}`);
+		} else if (sw && typeof sw === "object" && !Array.isArray(sw)) {
+			for (const [name, value] of Object.entries(sw)) {
+				commandLine.appendSwitch(name, String(value));
+				Log.debug(`Activated switch: ${name}=${value}`);
+			}
+		} else {
+			Log.error(`Invalid electronSwitches entry: ${JSON.stringify(sw)}`);
+		}
+	}
+}
+
+module.exports = { applyElectronSwitches };

tests/unit/functions/electron_helper_spec.js

@@ -0,0 +1,78 @@
+const Log = require("logger");
+const { applyElectronSwitches } = require("../../../js/electron_helper");
+
+describe("electron switches", () => {
+	let commandLine;
+
+	beforeEach(() => {
+		commandLine = {
+			appendSwitch: vi.fn()
+		};
+		vi.spyOn(Log, "error").mockImplementation(() => {});
+	});
+
+	it("always applies the autoplay-policy default switch", () => {
+		applyElectronSwitches(commandLine, undefined);
+
+		expect(commandLine.appendSwitch).toHaveBeenCalledTimes(1);
+		expect(commandLine.appendSwitch).toHaveBeenCalledWith("autoplay-policy", "no-user-gesture-required");
+		expect(Log.error).not.toHaveBeenCalled();
+	});
+
+	it("applies string entries as switches without values", () => {
+		applyElectronSwitches(commandLine, ["no-sandbox", "disable-http-cache"]);
+
+		expect(commandLine.appendSwitch).toHaveBeenCalledTimes(3);
+		expect(commandLine.appendSwitch).toHaveBeenNthCalledWith(1, "autoplay-policy", "no-user-gesture-required");
+		expect(commandLine.appendSwitch).toHaveBeenNthCalledWith(2, "no-sandbox");
+		expect(commandLine.appendSwitch).toHaveBeenNthCalledWith(3, "disable-http-cache");
+		expect(Log.error).not.toHaveBeenCalled();
+	});
+
+	it("applies object entries as switches with values", () => {
+		applyElectronSwitches(commandLine, [
+			{ "js-flags": "--max-old-space-size=8192" },
+			{ "password-store": "basic" }
+		]);
+
+		expect(commandLine.appendSwitch).toHaveBeenCalledTimes(3);
+		expect(commandLine.appendSwitch).toHaveBeenNthCalledWith(1, "autoplay-policy", "no-user-gesture-required");
+		expect(commandLine.appendSwitch).toHaveBeenNthCalledWith(2, "js-flags", "--max-old-space-size=8192");
+		expect(commandLine.appendSwitch).toHaveBeenNthCalledWith(3, "password-store", "basic");
+		expect(Log.error).not.toHaveBeenCalled();
+	});
+
+	it("allows one object entry to define multiple switches with values", () => {
+		applyElectronSwitches(commandLine, [
+			"no-sandbox",
+			{
+				"js-flags": "--max-old-space-size=8192",
+				"password-store": "basic"
+			}
+		]);
+
+		expect(commandLine.appendSwitch).toHaveBeenCalledTimes(4);
+		expect(commandLine.appendSwitch).toHaveBeenNthCalledWith(1, "autoplay-policy", "no-user-gesture-required");
+		expect(commandLine.appendSwitch).toHaveBeenNthCalledWith(2, "no-sandbox");
+		expect(commandLine.appendSwitch).toHaveBeenNthCalledWith(3, "js-flags", "--max-old-space-size=8192");
+		expect(commandLine.appendSwitch).toHaveBeenNthCalledWith(4, "password-store", "basic");
+		expect(Log.error).not.toHaveBeenCalled();
+	});
+
+	it("logs an error for invalid entries", () => {
+		applyElectronSwitches(commandLine, ["no-sandbox", ["js-flags", "--max-old-space-size=8192"], null]);
+
+		expect(commandLine.appendSwitch).toHaveBeenCalledTimes(2);
+		expect(commandLine.appendSwitch).toHaveBeenNthCalledWith(1, "autoplay-policy", "no-user-gesture-required");
+		expect(commandLine.appendSwitch).toHaveBeenNthCalledWith(2, "no-sandbox");
+		expect(Log.error).toHaveBeenCalledTimes(2);
+	});
+
+	it("logs an error when electronSwitches is not an array", () => {
+		applyElectronSwitches(commandLine, { "js-flags": "--max-old-space-size=8192" });
+
+		expect(commandLine.appendSwitch).toHaveBeenCalledTimes(1);
+		expect(commandLine.appendSwitch).toHaveBeenCalledWith("autoplay-policy", "no-user-gesture-required");
+		expect(Log.error).toHaveBeenCalledWith(expect.stringContaining("electronSwitches must be an array of strings or objects"));
+	});
+});