Merge branch 'main' of github.com:Yuri-byte/appium-novawindows-driver into fix/windows-10-scaling

Author: y-schwab

CHANGELOG.md

@@ -1,3 +1,11 @@
+## [1.3.1](https://github.com/AutomateThePlanet/appium-novawindows-driver/compare/v1.3.0...v1.3.1) (2026-03-09)
+
+### Bug Fixes
+
+* add stderr encoding for PowerShell session ([a233063](https://github.com/AutomateThePlanet/appium-novawindows-driver/commit/a233063b4509e41c047fcc3603b29b944c5ac374))
+* fixed incorrect $pattern variable reference ([a0afceb](https://github.com/AutomateThePlanet/appium-novawindows-driver/commit/a0afceb7e682219b5e82759c52e20c59bff1225f))
+* fixed not being able to attach to slow-starting classic apps on session creation ([f25b000](https://github.com/AutomateThePlanet/appium-novawindows-driver/commit/f25b000533be1ef2a7c0bc350bf62a3cd1b60a45))
+
 ## [1.3.0](https://github.com/AutomateThePlanet/appium-novawindows-driver/compare/v1.2.0...v1.3.0) (2026-03-06)
 
 ### Features

lib/commands/app.ts

@@ -68,6 +68,8 @@ const GET_SCREENSHOT_COMMAND = pwsh /* ps1 */ `
     [Convert]::ToBase64String($stream.ToArray())
 `;
 
+const SLEEP_INTERVAL_MS = 500;
+
 export async function getPageSource(this: NovaWindowsDriver): Promise<string> {
     return await this.sendPowerShellCommand(GET_PAGE_SOURCE_COMMAND.format(AutomationElement.automationRoot));
 }
@@ -136,8 +138,8 @@ export async function setWindow(this: NovaWindowsDriver, nameOrHandle: string):
             return;
         }
 
-        this.log.info(`Failed to locate window with name '${name}'. Sleeping for 500 milliseconds and retrying... (${i}/20)`); // TODO: make a setting for the number of retries or timeout
-        await sleep(500); // TODO: make a setting for the sleep timeout
+        this.log.info(`Failed to locate window with name '${name}'. Sleeping for ${SLEEP_INTERVAL_MS} milliseconds and retrying... (${i}/20)`); // TODO: make a setting for the number of retries or timeout
+        await sleep(SLEEP_INTERVAL_MS); // TODO: make a setting for the sleep timeout
     }
 
     throw new errors.NoSuchWindowError(`No window was found with name or handle '${nameOrHandle}'.`);
@@ -182,7 +184,7 @@ export async function changeRootElement(this: NovaWindowsDriver, pathOrNativeWin
     if (path.includes('!') && path.includes('_') && !(path.includes('/') || path.includes('\\'))) {
         this.log.debug('Detected app path to be in the UWP format.');
         await this.sendPowerShellCommand(/* ps1 */ `Start-Process 'explorer.exe' 'shell:AppsFolder\\${path}'${this.caps.appArguments ? ` -ArgumentList '${this.caps.appArguments}'` : ''}`);
-        await sleep((this.caps['ms:waitForAppLaunch'] ?? 0) * 1000 || 500);
+        await sleep((this.caps['ms:waitForAppLaunch'] ?? 0) * 1000 || SLEEP_INTERVAL_MS);
         for (let i = 1; i <= 20; i++) {
             const result = await this.sendPowerShellCommand(/* ps1 */ `(Get-Process -Name 'ApplicationFrameHost').Id`);
             const processIds = result.split('\n').map((pid) => pid.trim()).filter(Boolean).map(Number);
@@ -195,8 +197,8 @@ export async function changeRootElement(this: NovaWindowsDriver, pathOrNativeWin
                 // noop
             }
 
-            this.log.info(`Failed to locate window of the app. Sleeping for 500 milliseconds and retrying... (${i}/20)`); // TODO: make a setting for the number of retries or timeout
-            await sleep(500); // TODO: make a setting for the sleep timeout
+            this.log.info(`Failed to locate window of the app. Sleeping for ${SLEEP_INTERVAL_MS} milliseconds and retrying... (${i}/20)`); // TODO: make a setting for the number of retries or timeout
+            await sleep(SLEEP_INTERVAL_MS); // TODO: make a setting for the sleep timeout
         }
     } else {
         this.log.debug('Detected app path to be in the classic format.');
@@ -220,8 +222,8 @@ export async function changeRootElement(this: NovaWindowsDriver, pathOrNativeWin
                 }
             }
 
-            this.log.info(`Failed to locate window of the app. Sleeping for 500 milliseconds and retrying... (${i}/20)`); // TODO: make a setting for the number of retries or timeout
-            await sleep(500); // TODO: make a setting for the sleep timeout
+            this.log.info(`Failed to locate window of the app. Sleeping for ${SLEEP_INTERVAL_MS} milliseconds and retrying... (${i}/20)`); // TODO: make a setting for the number of retries or timeout
+            await sleep(SLEEP_INTERVAL_MS); // TODO: make a setting for the sleep timeout
         }
     }
 
@@ -290,30 +292,45 @@ export async function setWindowRect(
     return await this.getWindowRect();
 }
 
-export async function attachToApplicationWindow(this: NovaWindowsDriver, processIds: number[]): Promise<void> {
-    const nativeWindowHandles = getWindowAllHandlesForProcessIds(processIds);
-    this.log.debug(`Detected the following native window handles for the given process IDs: ${nativeWindowHandles.map((handle) => `0x${handle.toString(16).padStart(8, '0')}`).join(', ')}`);
+export async function waitForNewWindow(this: NovaWindowsDriver, pid: number, timeout: number): Promise<number> {
+    const start = Date.now();
+    let attempts = 0;
 
-    if (nativeWindowHandles.length !== 0) {
-        let elementId = '';
-        for (let i = 1; i <= 20; i++) {
-            elementId = await this.sendPowerShellCommand(AutomationElement.rootElement.findFirst(TreeScope.CHILDREN, new PropertyCondition(Property.NATIVE_WINDOW_HANDLE, new PSInt32(nativeWindowHandles[0]))).buildCommand());
-            if (elementId) {
-                break;
-            }
-            this.log.info(`The window with handle 0x${nativeWindowHandles[0].toString(16).padStart(8, '0')} is not yet available in the UI Automation tree. Sleeping for 500 milliseconds and retrying... (${i}/20)`); // TODO: make a setting for the number of retries or timeout
-            await sleep(500); // TODO: make a setting for the sleep timeout
+    while (Date.now() - start < timeout) {
+        const handles = getWindowAllHandlesForProcessIds([pid]);
+
+        if (handles.length > 0) {
+            return handles[handles.length - 1];
         }
 
-        await this.sendPowerShellCommand(/* ps1 */ `$rootElement = ${new FoundAutomationElement(elementId).buildCommand()}`);
-        if ((await this.sendPowerShellCommand(/* ps1 */ `$null -ne $rootElement`)).toLowerCase() === 'true') {
-            const nativeWindowHandle = Number(await this.sendPowerShellCommand(AutomationElement.automationRoot.buildGetPropertyCommand(Property.NATIVE_WINDOW_HANDLE)));
-            if (!trySetForegroundWindow(nativeWindowHandle)) {
-                await this.focusElement({
-                    [W3C_ELEMENT_KEY]: elementId,
-                } satisfies Element);
-            };
-            return;
+        this.log.debug(`Waiting for the process window to appear... (${++attempts}/${Math.floor(timeout / SLEEP_INTERVAL_MS)})`);
+        await sleep(SLEEP_INTERVAL_MS);
+    }
+
+    throw new Error('Timed out waiting for window.');
+}
+
+export async function attachToApplicationWindow(this: NovaWindowsDriver, processIds: number[]): Promise<void> {
+    const nativeWindowHandle = await waitForNewWindow.call(this, processIds[0], this.caps['ms:waitForAppLaunch'] ?? SLEEP_INTERVAL_MS * 20);
+
+    let elementId = '';
+    for (let i = 1; i <= 20; i++) {
+        elementId = await this.sendPowerShellCommand(AutomationElement.rootElement.findFirst(TreeScope.CHILDREN, new PropertyCondition(Property.NATIVE_WINDOW_HANDLE, new PSInt32(nativeWindowHandle))).buildCommand());
+        if (elementId) {
+            break;
         }
+        this.log.info(`The window with handle 0x${nativeWindowHandle.toString(16).padStart(8, '0')} is not yet available in the UI Automation tree. Sleeping for ${SLEEP_INTERVAL_MS} milliseconds and retrying... (${i}/20)`); // TODO: make a setting for the number of retries or timeout
+        await sleep(SLEEP_INTERVAL_MS); // TODO: make a setting for the sleep timeout
+    }
+
+    await this.sendPowerShellCommand(/* ps1 */ `$rootElement = ${new FoundAutomationElement(elementId).buildCommand()}`);
+    if ((await this.sendPowerShellCommand(/* ps1 */ `$null -ne $rootElement`)).toLowerCase() === 'true') {
+        const nativeWindowHandle = Number(await this.sendPowerShellCommand(AutomationElement.automationRoot.buildGetPropertyCommand(Property.NATIVE_WINDOW_HANDLE)));
+        if (!trySetForegroundWindow(nativeWindowHandle)) {
+            await this.focusElement({
+                [W3C_ELEMENT_KEY]: elementId,
+            } satisfies Element);
+        };
+        return;
     }
 }

lib/commands/functions.ts

@@ -152,18 +152,18 @@ export const PAGE_SOURCE = pwsh /* ps1 */ `
             $pattern = $null
 
             if ($element.TryGetCurrentPattern([WindowPattern]::Pattern, [ref]$pattern)) {
-                $newXmlElement.SetAttribute("CanMaximize", $windowPattern.Current.CanMaximize)
-                $newXmlElement.SetAttribute("CanMinimize", $windowPattern.Current.CanMinimize)
-                $newXmlElement.SetAttribute("IsModal", $windowPattern.Current.IsModal)
-                $newXmlElement.SetAttribute("WindowVisualState", $windowPattern.Current.WindowVisualState)
-                $newXmlElement.SetAttribute("WindowInteractionState", $windowPattern.Current.WindowInteractionState)
-                $newXmlElement.SetAttribute("IsTopmost", $windowPattern.Current.IsTopmost)
+                $newXmlElement.SetAttribute("CanMaximize", $pattern.Current.CanMaximize)
+                $newXmlElement.SetAttribute("CanMinimize", $pattern.Current.CanMinimize)
+                $newXmlElement.SetAttribute("IsModal", $pattern.Current.IsModal)
+                $newXmlElement.SetAttribute("WindowVisualState", $pattern.Current.WindowVisualState)
+                $newXmlElement.SetAttribute("WindowInteractionState", $pattern.Current.WindowInteractionState)
+                $newXmlElement.SetAttribute("IsTopmost", $pattern.Current.IsTopmost)
             }
 
             if ($element.TryGetCurrentPattern([TransformPattern]::Pattern, [ref]$pattern)) {
-                $newXmlElement.SetAttribute("CanRotate", $windowPattern.Current.CanRotate)
-                $newXmlElement.SetAttribute("CanResize", $windowPattern.Current.CanResize)
-                $newXmlElement.SetAttribute("CanMove", $windowPattern.Current.CanMove)
+                $newXmlElement.SetAttribute("CanRotate", $pattern.Current.CanRotate)
+                $newXmlElement.SetAttribute("CanResize", $pattern.Current.CanResize)
+                $newXmlElement.SetAttribute("CanMove", $pattern.Current.CanMove)
             }
 
             # TODO: more to be added depending on the available patterns
@@ -189,4 +189,4 @@ export const PAGE_SOURCE = pwsh /* ps1 */ `
 
         return $xmlElement
     }
-`;
+`;

lib/commands/powershell.ts

@@ -14,7 +14,7 @@ const INIT_ELEMENT_TABLE = /* ps1 */ `$elementTable = New-Object System.Collecti
 export async function startPowerShellSession(this: NovaWindowsDriver): Promise<void> {
     const powerShell = spawn('powershell.exe', ['-NoExit', '-Command', '-']);
     powerShell.stdout.setEncoding('utf8');
-    powerShell.stdout.setEncoding('utf8');
+    powerShell.stderr.setEncoding('utf8');
 
     powerShell.stdout.on('data', (chunk: any) => {
         this.powerShellStdOut += chunk.toString();

package.json

@@ -1,6 +1,6 @@
 {
   "name": "appium-novawindows-driver",
-  "version": "1.3.0",
+  "version": "1.3.1",
   "description": "Appium driver for Windows",
   "keywords": [
     "appium",