Streamlined window management

Author: benjaminbojko

.changeset/poor-islands-film.md

@@ -0,0 +1,5 @@
+---
+"@bluecadet/launchpad-monitor": minor
+---
+
+Swapped window management engine for fewer dependencies. Removed 'fake key' setting.

packages/monitor/lib/launchpad-monitor.js

@@ -38,11 +38,6 @@ export class LaunchpadMonitor {
 	 */
 	_pm2Bus = null;
 
-	/**
-	 * @type {Object}
-	 */
-	_windowsApi = null;
-	
 	/**
 	 * Creates a new instance, starts it with the
 	 * config and resolves with the monitor instance.
@@ -393,12 +388,6 @@ export class LaunchpadMonitor {
 	 * @returns {Promise}
 	 */
 	async _applyWindowSettings(appNames = null) {
-		
-		if (!this._isWindowsOS()) {
-			this._logger.warn(`Not applying windows settings since this is only supported on Windows OS.`);
-			return;
-		}
-		
 		const currVersion = process.version;
 		const requVersion = this._config.windowsApi.nodeVersion;
 
@@ -410,62 +399,58 @@ export class LaunchpadMonitor {
 		appNames = this._validateAppNames(appNames);
 
 		this._logger.info(`Applying window settings to ${appNames.length} ${appNames.length === 1 ? 'app' : 'apps'}`);
-		
-		let windowsApi = null;
-		try {
-			windowsApi = await this._getWindowsApi();
-		} catch (err) {
-			this._logger.error(`Could not retrieve Windows API libraries. Make sure optional deps are installed: 'npm i robotjs ffi-napi ref-napi'`, err);
-		}
+
 
 		const fgPids = new Set();
 		const minPids = new Set();
 		const hidePids = new Set();
 
 		windowManager.requestAccessibility();
 		const visibleWindows = windowManager.getWindows().filter(win => win.isVisible());
+		const visiblePids = new Set(visibleWindows.map(win => win.processId));
 
 		for (const appName of appNames) {
 			const appOptions = this.getAppOptions(appName);
 			const winOptions = appOptions.windows;
 			const appProcess = await this.getAppProcess(appName);
 
 			if (!appProcess || appProcess.pm2_env.status !== 'online') {
-				this._logger.warn(`Not applying window settings to ${appName} because it's not online.`);
-				return appProcess;
+				this._logger.warn(`Not applying window settings to ${chalk.blue(appName)} because it's not online.`);
+				continue;
 			}
 
-			const appLabel = `"${appName}" (pid: ${appProcess.pid})`;
+			if (!visiblePids.has(appProcess.pid)) {
+				this._logger.warn(`No window found for ${chalk.blue(appName)} with pid ${chalk.blue(appProcess.pid)}.`);
+				continue;
+			}
 
 			if (winOptions.hide) {
-				this._logger.debug(`Hiding ${appLabel}`);
 				hidePids.add(appProcess.pid);
 			}
 			if (winOptions.minimize) {
-				this._logger.debug(`Minimizing ${appLabel}`);
 				minPids.add(appProcess.pid);
 			}
 			if (winOptions.foreground) {
-				this._logger.debug(`Moving ${appLabel} to the foreground`);
 				fgPids.add(appProcess.pid);
 			}
 		}
 
-		visibleWindows.filter(win => hidePids.has(win.processId)).forEach(win => win.hide());
-		visibleWindows.filter(win => minPids.has(win.processId)).forEach(win => win.minimize());
-		visibleWindows.filter(win => fgPids.has(win.processId)).forEach(win => win.bringToTop());
+		visibleWindows.filter(win => hidePids.has(win.processId)).forEach(win => {
+			this._logger.info(`Hiding ${win.getTitle()} (pid: ${win.processId})`);
+			win.hide();
+		});
+		visibleWindows.filter(win => minPids.has(win.processId)).forEach(win => {
+			this._logger.info(`Minimizing ${win.getTitle()} (pid: ${win.processId})`);
+			win.minimize();
+		});
+		visibleWindows.filter(win => fgPids.has(win.processId)).forEach(win => {
+			this._logger.info(`Foregrounding ${win.getTitle()} (pid: ${win.processId})`);
+			win.bringToTop();
+		});
 
 		this._logger.debug(`✅ Done applying window settings.`);
 	}
 
-	async _getWindowsApi() {
-		if (!this._windowsApi) {
-			// Importing at runtime allows optional dependencies for non-Windows platforms
-			this._windowsApi = await import('./windows-api.js');
-		}
-		return this._windowsApi;
-	}
-	
 	_isWindowsOS() {
 		return process.platform === 'win32';
 	}

packages/monitor/lib/monitor-options.js

@@ -54,12 +54,14 @@ export class AppOptions {
 		 * @default null
 		 */
 		this.pm2 = pm2;
+		
 		/**
 		 * Optional settings for moving this app's main windows to the foreground, minimize or hide them.
 		 * @type {WindowOptions}
 		 * @default new WindowOptions()
 		 */
 		this.windows = windows;
+		
 		/**
 		 * Optional settings for how to log this app's output.
 		 * @type {AppLogOptions}
@@ -84,12 +86,14 @@ export class WindowOptions {
 		 * @default false
 		 */
 		this.foreground = foreground;
+		
 		/**
 		 * Minimize this app's windows once all apps have been launched.
 		 * @type {boolean}
 		 * @default false
 		 */
 		this.minimize = minimize;
+		
 		/**
 		 * Completely hide this app's windows once all apps have been launched. Helpful for headless apps, but note that this might cause issues with GUI-based apps.
 		 * 
@@ -111,6 +115,7 @@ export const LogModes = {
 	 * @type {string} 
 	 */
 	TailLogFile: 'file',
+	
 	/**
 	 * Logs directly from the app's stdout/stderr bus. Can result in interrupted logs if the buffer isn't consistently flushed by an app.
 	 * @type {string}
@@ -134,6 +139,7 @@ export class AppLogOptions {
 		 * @default true
 		 */
 		this.logToLaunchpadDir = logToLaunchpadDir;
+		
 		/**
 		 * How to grab the app's logs. Supported values:
 		 * - `'file'`: Logs by tailing the app's log files. Slight lag, but can result in better formatting than bus.
@@ -142,12 +148,14 @@ export class AppLogOptions {
 		 * @default 'file'
 		 */
 		this.mode = mode;
+		
 		/**
 		 * Whether or not to include output from `stdout`
 		 * @type {boolean}
 		 * @default true
 		 */
 		this.showStdout = showStdout;
+		
 		/**
 		 * Whether or not to include output from `stderr`
 		 * @type {boolean}
@@ -162,9 +170,8 @@ export class AppLogOptions {
  */
 export class WindowsApiOptions {
 	constructor({
-		nodeVersion = '>=17.4.0',
 		debounceDelay = 3000,
-		fakeKey = 'control',
+		nodeVersion = '>=17.4.0',
 		...rest
 	} = {}) {
 		/**
@@ -176,6 +183,7 @@ export class WindowsApiOptions {
 		 * @default '>=17.4.0'
 		 */
 		this.nodeVersion = nodeVersion;
+		
 		/**
 		 * The delay until windows are ordered after launch of in ms.
 		 * 
@@ -186,17 +194,6 @@ export class WindowsApiOptions {
 		 * @default 3000
 		 */
 		this.debounceDelay = debounceDelay;
-		/**
-		 * Windows OS is very strict with when and how apps can move windows to the foreground or backgruond. As a workaround, Launchpad emulates a keypress to make the current process active.
-		 * 
-		 * This setting configures which key is used to emulate in order to gain control over window foregrounding/backgrounding. This key gets emulated after an app launches or re-launches.
-		 * 
-		 * @see https://robotjs.io/docs/syntax#keys for available options
-		 * @see https://learn.microsoft.com/en-us/windows/win32/api/winuser/nf-winuser-allowsetforegroundwindow#remarks for window management requirements
-		 * @type {string}
-		 * @default 'control'
-		 */
-		this.fakeKey = fakeKey;
 
 		Object.assign(this, rest);
 	}