Merge pull request #82 from bluecadet/feature/window-management

Feature/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.

package-lock.json

@@ -133,7 +133,6 @@ Global options for how window order should be managed.
 | - | - | - | - |
 | <a name="module_monitor-options.WindowsApiOptions+nodeVersion">`nodeVersion`</a> |  <code>string</code>|  <code>'>=17.4.0'</code>  | The minimum major node version to support window ordering.<br>Node versions < 17 seem to have a fatal bug with the native<br>API, which will intermittently cause V8 to crash hard.<br><br>See: https://github.com/node-ffi-napi/ref-napi/issues/54#issuecomment-1029639256 |
 | <a name="module_monitor-options.WindowsApiOptions+debounceDelay">`debounceDelay`</a> |  <code>number</code>|  <code>3000</code>  | The delay until windows are ordered after launch of in ms.<br><br>If your app takes a long time to open all of its windows, set this number to a higher value to ensure it can be on top of the launchpad terminal window.<br><br>Keeping this high also reduces the CPU load if apps relaunch often. |
-| <a name="module_monitor-options.WindowsApiOptions+fakeKey">`fakeKey`</a> |  <code>string</code>|  <code>'control'</code>  | 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.<br><br>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.<br><br>See:  https://robotjs.io/docs/syntax#keys for available options, https://learn.microsoft.com/en-us/windows/win32/api/winuser/nf-winuser-allowsetforegroundwindow#remarks for window management requirements. |
 
 
 ###  AppLogOptions

packages/monitor/README.md

@@ -6,13 +6,13 @@ import chalk from 'chalk';
 import autoBind from 'auto-bind';
 import pDebounce from 'p-debounce';
 import pm2 from 'pm2';
-import semver from 'semver';
 import { spawn } from 'cross-spawn';
 import { SubEmitterSocket } from 'axon'; // used by PM2
 
 import { LogManager, Logger } from '@bluecadet/launchpad-utils';
 import AppLogRouter from './app-log-router.js';
 import { AppLogOptions, MonitorOptions, WindowOptions } from './monitor-options.js';
+import sortWindows, { SortApp } from './utils/sort-windows.js';
 
 export class LaunchpadMonitor {
 	/** @type {MonitorOptions} */
@@ -37,11 +37,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.
@@ -392,76 +387,25 @@ 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;
-		
-		if (!semver.satisfies(currVersion, requVersion)) {
-			this._logger.warn(`Not applying window settings since your node version '${currVersion}' doesn't satisfy the required version '${requVersion}'. Please upgrade node to apply window settings like foreground/minimize/hide.`);
-			return;
-		}
-		
 		appNames = this._validateAppNames(appNames);
-		
-		this._logger.info(`Applying window settings to apps: ${appNames}...`);
-		
-		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 = [];
-		const minPids = [];
-		const hidePids = [];
+		const apps = [];
 
 		for (const appName of appNames) {
-			const appOptions = this.getAppOptions(appName);
-			const winOptions = appOptions.windows;
-			const appProcess = await this.getAppProcess(appName);
+			const sortApp = new SortApp();
+			sortApp.options = this.getAppOptions(appName);
 
-			if (!appProcess || appProcess.pm2_env.status !== 'online') {
-				this._logger.warn(`Not applying window settings to ${appName} because it's not online.`);
-				return appProcess;
+			try {
+				const process = await this.getAppProcess(appName);
+				sortApp.pid = process.pid;
+			} catch (error) {
+				this._logger.error(`Could not get process for app ${appName}`);
+				continue;
 			}
 
-			const appLabel = `${appName} (pid: ${appProcess.pid})`;
-			
-			if (winOptions.foreground) {
-				this._logger.debug(`...foregrounding ${appLabel}`);
-				fgPids.push(appProcess.pid);
-			}
-			if (winOptions.minimize) {
-				this._logger.debug(`...minimizing ${appLabel}`);
-				minPids.push(appProcess.pid);
-			}
-			if (winOptions.hide) {
-				this._logger.debug(`...hiding ${appLabel}`);
-				hidePids.push(appProcess.pid);
-			}
+			apps.push(sortApp);
 		}
 
-		windowsApi.sortWindows(fgPids, minPids, hidePids);
-		
-		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';
+		return sortWindows(apps, this._logger, this._config.windowsApi.nodeVersion);
 	}
 
 	async _connectPm2Bus() {

packages/monitor/lib/launchpad-monitor.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);
 	}

packages/monitor/lib/monitor-options.js

@@ -0,0 +1,74 @@
+import semver from 'semver';
+import chalk from 'chalk';
+import { windowManager } from 'node-window-manager';
+import { Logger } from '@bluecadet/launchpad-utils';
+import { AppOptions } from '../monitor-options.js';
+
+export class SortApp {
+	/**
+	 * @type {AppOptions}
+	 */
+	options = null;
+	/**
+	 * @type {number}
+	 */
+	pid = null;
+}
+
+/**
+ * 
+ * @param {Array.<SortApp>} apps 
+ * @param {Logger} logger
+ * @param {string} minNodeVersion
+ * @returns {Promise}
+ */
+const sortWindows = async (apps, logger = console, minNodeVersion = undefined) => {
+	const currNodeVersion = process.version;
+	if (!semver.satisfies(currNodeVersion, minNodeVersion)) {
+		return Promise.reject(`Can't sort windows because the current node version '${currNodeVersion}' doesn't satisfy the required version '${minNodeVersion}'. Please upgrade node to apply window settings like foreground/minimize/hide.`);
+	}
+	
+	logger.debug(`Applying window settings to ${apps.length} ${apps.length === 1 ? 'app' : 'apps'}`);
+
+	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 app of apps) {
+		if (!visiblePids.has(app.pid)) {
+			logger.warn(`No window found for ${chalk.blue(app.options.pm2.name)} with pid ${chalk.blue(app.pid)}.`);
+			continue;
+		}
+		
+		if (app.options.windows.hide) {
+			hidePids.add(app.pid);
+		}
+		if (app.options.windows.minimize) {
+			minPids.add(app.pid);
+		}
+		if (app.options.windows.foreground) {
+			fgPids.add(app.pid);
+		}
+	}
+	
+	visibleWindows.filter(win => hidePids.has(win.processId)).forEach(win => {
+		logger.info(`Hiding ${chalk.blue(win.getTitle())} (pid: ${chalk.blue(win.processId)})`);
+		win.hide();
+	});
+	visibleWindows.filter(win => minPids.has(win.processId)).forEach(win => {
+		logger.info(`Minimizing ${chalk.blue(win.getTitle())} (pid: ${chalk.blue(win.processId)})`);
+		win.minimize();
+	});
+	visibleWindows.filter(win => fgPids.has(win.processId)).forEach(win => {
+		logger.info(`Foregrounding ${chalk.blue(win.getTitle())} (pid: ${chalk.blue(win.processId)})`);
+		win.bringToTop();
+	});
+	
+	logger.debug(`Done applying window settings.`);
+};
+
+export default sortWindows;