feat(commands): implement waitForAppLaunch and forceQuit

Author: yuri-schwab

lib/commands/app.ts

@@ -152,7 +152,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(500); // TODO: make a setting for the initial wait time
+        await sleep((this.caps['ms:waitForAppLaunch'] ?? 0) * 1000 || 500);
         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);
@@ -172,7 +172,7 @@ export async function changeRootElement(this: NovaWindowsDriver, pathOrNativeWin
         this.log.debug('Detected app path to be in the classic format.');
         const normalizedPath = normalize(path);
         await this.sendPowerShellCommand(/* ps1 */ `Start-Process '${normalizedPath}'${this.caps.appArguments ? ` -ArgumentList '${this.caps.appArguments}'` : ''}`);
-        await sleep(500); // TODO: make a setting for the initial wait time
+        await sleep((this.caps['ms:waitForAppLaunch'] ?? 0) * 1000 || 500);
         for (let i = 1; i <= 20; i++) {
             try {
                 const breadcrumbs = normalizedPath.toLowerCase().split('\\').flatMap((x) => x.split('/'));

lib/constraints.ts

@@ -35,7 +35,13 @@ export const UI_AUTOMATION_DRIVER_CONSTRAINTS = {
     },
     isolatedScriptExecution: {
         isBoolean: true,
-    }
+    },
+    'ms:waitForAppLaunch': {
+        isNumber: true,
+    },
+    'ms:forcequit': {
+        isBoolean: true,
+    },
 } as const satisfies Constraints;
 
 export default UI_AUTOMATION_DRIVER_CONSTRAINTS;

lib/driver.ts

@@ -1,28 +1,29 @@
-import { ChildProcessWithoutNullStreams } from 'node:child_process';
 import { BaseDriver, W3C_ELEMENT_KEY, errors } from '@appium/base-driver';
 import { system } from 'appium/support';
+import { ChildProcessWithoutNullStreams } from 'node:child_process';
+import type { ScreenRecorder } from './commands/screen-recorder';
 import commands from './commands';
 import {
-    UI_AUTOMATION_DRIVER_CONSTRAINTS,
-    NovaWindowsDriverConstraints
+    NovaWindowsDriverConstraints,
+    UI_AUTOMATION_DRIVER_CONSTRAINTS
 } from './constraints';
 import {
-    assertSupportedEasingFunction
-} from './util';
-import {
-    Condition,
-    PropertyCondition,
     AutomationElement,
+    Condition,
     FoundAutomationElement,
-    TreeScope,
-    Property,
-    convertStringToCondition,
-    PSString,
     PSControlType,
     PSInt32Array,
+    PSString,
+    Property,
+    PropertyCondition,
+    TreeScope,
+    convertStringToCondition,
 } from './powershell';
-import { xpathToElIdOrIds } from './xpath';
+import {
+    assertSupportedEasingFunction
+} from './util';
 import { setDpiAwareness } from './winapi/user32';
+import { xpathToElIdOrIds } from './xpath';
 
 import type {
     DefaultCreateSessionResult,
@@ -66,8 +67,7 @@ export class NovaWindowsDriver extends BaseDriver<NovaWindowsDriverConstraints,
         meta: false,
         shift: false,
     };
-    recordingProcess?: ChildProcessWithoutNullStreams;
-    recordingOutputPath?: string;
+    _screenRecorder: ScreenRecorder | null = null;
 
     constructor(opts: InitialOpts = {} as InitialOpts, shouldValidateCaps = true) {
         super(opts, shouldValidateCaps);
@@ -199,15 +199,24 @@ export class NovaWindowsDriver extends BaseDriver<NovaWindowsDriverConstraints,
 
         if (this.caps.shouldCloseApp && this.caps.app && this.caps.app.toLowerCase() !== 'root') {
             try {
-                const result = await this.sendPowerShellCommand(AutomationElement.automationRoot.buildCommand());
-                const elementId = result.split('\n').map((id) => id.trim()).filter(Boolean)[0];
-                if (elementId) {
-                    await this.sendPowerShellCommand(new FoundAutomationElement(elementId).buildCloseCommand());
+                if (this.caps['ms:forcequit'] === true) {
+                    await this.sendPowerShellCommand(/* ps1 */ `
+                        if ($null -ne $rootElement) {
+                            $processId = $rootElement.Current.ProcessId
+                            Stop-Process -Id $processId -Force -ErrorAction SilentlyContinue
+                        }
+                    `);
+                } else {
+                    const result = await this.sendPowerShellCommand(AutomationElement.automationRoot.buildCommand());
+                    const elementId = result.split('\n').map((id) => id.trim()).filter(Boolean)[0];
+                    if (elementId) {
+                        await this.sendPowerShellCommand(new FoundAutomationElement(elementId).buildCloseCommand());
+                    }
                 }
             } catch {
                 // noop
             }
-        } // change to close the whole process, not only the window
+        }
         await this.terminatePowerShellSession();
 
         if (this.caps.postrun) {