appium-novawindows2-driver 0.1.3 → 0.1.5

package/lib/commands/functions.ts

@@ -1,192 +0,0 @@
-import { pwsh } from '../powershell';
-
-export const FIND_CHILDREN_RECURSIVELY = pwsh /* ps1 */ `
-    function Find-ChildrenRecursively {
-        param (
-            [Parameter(Mandatory=$true)]
-            [AutomationElement]$element,
-            [Parameter(Mandatory=$true)]
-            [Condition]$condition,
-            [Parameter(Mandatory=$false)]
-            [bool]$includeSelf = $false
-        )
-
-        $scope = if ($includeSelf) {
-            [TreeScope]::Element -bor [TreeScope]::Children
-        } else {
-            [TreeScope]::Children
-        }
-
-        $validChild = $element.FindFirst($scope, $condition)
-
-        if ($validChild -ne $null) {
-            return $validChild
-        }
-
-        $children = $element.FindAll([TreeScope]::Children, [Condition]::TrueCondition)
-        foreach ($child in $children) {
-            $result = Find-AllChildrenRecursively -element $child -condition $condition -returnFirstResult $true
-            if ($result -ne $null) {
-                return $result[0]
-            }
-        }
-
-        return $null
-    }
-
-    function Find-AllChildrenRecursively {
-        param (
-            [Parameter(Mandatory=$true)]
-            [AutomationElement]$element,
-            [Parameter(Mandatory=$true)]
-            [Condition]$condition,
-            [bool]$returnFirstResult = $false,
-            [Parameter(Mandatory=$false)]
-            [bool]$includeSelf = $false
-        )
-
-        $children = $element.FindAll([TreeScope]::Children, [Condition]::TrueCondition)
-        $validChildren = @($children | Where-Object { $_.FindFirst([TreeScope]::Element, $condition) -ne $null })
-
-        if ($includeSelf) {
-            $self = $element.FindFirst([TreeScope]::Element, $condition)
-        }
-
-        if ($null -ne $self) {
-            $validChildren += $self
-        }
-
-        foreach ($child in $children) {
-            $Allresults = Find-AllChildrenRecursively -element $child -condition $condition
-            if ($returnFirstResult -and $Allresults.Count -gt 0) {
-                return $Allresults
-            }
-
-            foreach ($result in $Allresults) {
-                $validChildren += ($result | Where-Object { $_.FindFirst([TreeScope]::Element, $condition) -ne $null })
-            }
-        }
-
-        return $validChildren
-    }
-`;
-
-export const PAGE_SOURCE = pwsh /* ps1 */ `
-    function Get-PageSource {
-        param (
-            [Parameter(Mandatory = $true)]
-            [AutomationElement]$element,
-            [Xml.XmlDocument]$xmlDoc,
-            [Xml.XmlElement]$xmlElement
-        )
-
-        try {
-            $localizedControlType = $element.GetCurrentPropertyValue([AutomationElement]::LocalizedControlTypeProperty)
-            $controlType = $element.GetCurrentPropertyValue([AutomationElement]::ControlTypeProperty)
-
-            $tagName = ''
-            try {
-                $tagName = $controlType.ProgrammaticName.Split('.')[-1]
-            } catch {
-                # fallback to LocalizedControlType ControlType is empty
-                $tagName = -join ($localizedControlType -split ' ' | ForEach-Object {
-                    $_.Substring(0, 1).ToUpper() + $_.Substring(1).ToLower()
-                })
-            }
-
-            $acceleratorKey = $element.GetCurrentPropertyValue([AutomationElement]::AcceleratorKeyProperty)
-            $accessKey = $element.GetCurrentPropertyValue([AutomationElement]::AccessKeyProperty)
-            $automationId = $element.GetCurrentPropertyValue([AutomationElement]::AutomationIdProperty)
-            $className = $element.GetCurrentPropertyValue([AutomationElement]::ClassNameProperty)
-            $frameworkId = $element.GetCurrentPropertyValue([AutomationElement]::FrameworkIdProperty)
-            $hasKeyboardfocus = $element.GetCurrentPropertyValue([AutomationElement]::HasKeyboardfocusProperty)
-            $helpText = $element.GetCurrentPropertyValue([AutomationElement]::HelpTextProperty)
-            $isContentelement = $element.GetCurrentPropertyValue([AutomationElement]::IsContentelementProperty)
-            $isControlelement = $element.GetCurrentPropertyValue([AutomationElement]::IsControlelementProperty)
-            $isEnabled = $element.GetCurrentPropertyValue([AutomationElement]::IsEnabledProperty)
-            $isKeyboardfocusable = $element.GetCurrentPropertyValue([AutomationElement]::IsKeyboardfocusableProperty)
-            $isOffscreen = $element.GetCurrentPropertyValue([AutomationElement]::IsOffscreenProperty)
-            $isPassword = $element.GetCurrentPropertyValue([AutomationElement]::IsPasswordProperty)
-            $isRequiredforform = $element.GetCurrentPropertyValue([AutomationElement]::IsRequiredforformProperty)
-            $itemStatus = $element.GetCurrentPropertyValue([AutomationElement]::ItemStatusProperty)
-            $itemType = $element.GetCurrentPropertyValue([AutomationElement]::ItemTypeProperty)
-            $name = $element.GetCurrentPropertyValue([AutomationElement]::NameProperty)
-            $orientation = $element.GetCurrentPropertyValue([AutomationElement]::OrientationProperty)
-            $processId = $element.GetCurrentPropertyValue([AutomationElement]::ProcessIdProperty)
-            $runtimeId = $element.GetCurrentPropertyValue([AutomationElement]::RuntimeIdProperty) -join '.'
-            $boundingRectangle = $element.Current.BoundingRectangle
-            $x = $boundingRectangle.X - $rootElement.Current.BoundingRectangle.X
-            $y = $boundingRectangle.Y - $rootElement.Current.BoundingRectangle.Y
-            $width = $boundingRectangle.Width
-            $height = $boundingRectangle.Height
-
-            if ($null -eq $xmlDoc) { $xmlDoc = [Xml.XmlDocument]::new() }
-
-            $newXmlElement = $xmlDoc.CreateElement($tagName)
-            $newXmlElement.SetAttribute("AcceleratorKey", $acceleratorKey)
-            $newXmlElement.SetAttribute("AccessKey", $accessKey)
-            $newXmlElement.SetAttribute("AutomationId", $automationId)
-            $newXmlElement.SetAttribute("ClassName", $className)
-            $newXmlElement.SetAttribute("FrameworkId", $frameworkId)
-            $newXmlElement.SetAttribute("HasKeyboardfocus", $hasKeyboardfocus)
-            $newXmlElement.SetAttribute("HelpText", $helpText)
-            $newXmlElement.SetAttribute("IsContentelement", $isContentelement)
-            $newXmlElement.SetAttribute("IsControlelement", $isControlelement)
-            $newXmlElement.SetAttribute("IsEnabled", $isEnabled)
-            $newXmlElement.SetAttribute("IsKeyboardfocusable", $isKeyboardfocusable)
-            $newXmlElement.SetAttribute("IsOffscreen", $isOffscreen)
-            $newXmlElement.SetAttribute("IsPassword", $isPassword)
-            $newXmlElement.SetAttribute("IsRequiredforform", $isRequiredforform)
-            $newXmlElement.SetAttribute("ItemStatus", $itemStatus)
-            $newXmlElement.SetAttribute("ItemType", $itemType)
-            $newXmlElement.SetAttribute("LocalizedControlType", $localizedControlType)
-            $newXmlElement.SetAttribute("Name", $name)
-            $newXmlElement.SetAttribute("Orientation", $orientation)
-            $newXmlElement.SetAttribute("ProcessId", $processId)
-            $newXmlElement.SetAttribute("RuntimeId", $runtimeId)
-            $newXmlElement.SetAttribute("x", $x)
-            $newXmlElement.SetAttribute("y", $y)
-            $newXmlElement.SetAttribute("width", $width)
-            $newXmlElement.SetAttribute("height", $height)
-
-            $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)
-            }
-
-            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)
-            }
-
-            # TODO: more to be added depending on the available patterns
-
-            if ($null -eq $xmlElement) {
-                $xmlElement = $xmlDoc.AppendChild($newXmlElement)
-            } else {
-                $xmlElement = $xmlElement.AppendChild($newXmlElement)
-            }
-
-            $elementsToProcess = New-Object System.Collections.Queue
-            $element.FindAll([TreeScope]::Children, $cacheRequest.TreeFilter) | ForEach-Object {
-                $elementsToProcess.Enqueue($_)
-            }
-
-            while ($elementsToProcess.Count -gt 0) {
-                $currentElement = $elementsToProcess.Dequeue()
-                Get-PageSource $currentElement $xmlDoc $xmlElement | Out-Null
-            }
-        } catch {
-            # noop
-        }
-
-        return $xmlElement
-    }
-`;

package/lib/commands/index.ts

@@ -1,28 +0,0 @@
-import * as actions from './actions';
-import * as powershell from './powershell';
-import * as element from './element';
-import * as extension from './extension';
-import * as device from './device';
-import * as system from './system';
-import * as app from './app';
-
-const commands = {
-    ...actions,
-    ...powershell,
-    ...element,
-    ...extension,
-    ...system,
-    ...device,
-    ...app,
-    // add the rest of the commands here
-};
-
-type Commands = {
-    [key in keyof typeof commands]: typeof commands[key];
-};
-
-declare module '../driver' {
-    interface NovaWindows2Driver extends Commands { }
-}
-
-export default commands;

package/lib/commands/powershell.ts

@@ -1,256 +0,0 @@
-import { spawn } from 'node:child_process';
-import { NovaWindows2Driver } from '../driver';
-import { errors } from '@appium/base-driver';
-import { FIND_CHILDREN_RECURSIVELY, PAGE_SOURCE } from './functions';
-
-const SET_UTF8_ENCODING = /* ps1 */ `$OutputEncoding = [Console]::OutputEncoding = [Text.Encoding]::UTF8`;
-const ADD_NECESSARY_ASSEMBLIES = /* ps1 */ `Add-Type -AssemblyName UIAutomationClient; Add-Type -AssemblyName System.Drawing; Add-Type -AssemblyName PresentationCore; Add-Type -AssemblyName System.Windows.Forms`;
-const USE_UI_AUTOMATION_CLIENT = /* ps1 */ `using namespace System.Windows.Automation`;
-const INIT_CACHE_REQUEST = /* ps1 */ `($cacheRequest = New-Object System.Windows.Automation.CacheRequest).TreeFilter = [AndCondition]::new([Automation]::ControlViewCondition, [NotCondition]::new([PropertyCondition]::new([AutomationElement]::FrameworkIdProperty, 'Chrome'))); $cacheRequest.Push()`;
-const INIT_ROOT_ELEMENT = /* ps1 */ `$rootElement = [AutomationElement]::RootElement`;
-const NULL_ROOT_ELEMENT = /* ps1 */ `$rootElement = $null`;
-const INIT_ELEMENT_TABLE = /* ps1 */ `$elementTable = New-Object System.Collections.Generic.Dictionary[[string]\`,[AutomationElement]]`;
-
-async function executeRawCommand(driver: NovaWindows2Driver, command: string): Promise<string> {
-    const magicNumber = 0xF2EE;
-    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-    const powerShell = driver.powerShell!;
-
-    driver.powerShellStdOut = '';
-    driver.powerShellStdErr = '';
-
-    powerShell.stdin.write(`${command}\n`);
-    powerShell.stdin.write(/* ps1 */ `Write-Output $([char]0x${magicNumber.toString(16)})\n`);
-
-    return await new Promise<string>((resolve, reject) => {
-        const onClose = (code: number) => {
-            reject(new errors.UnknownError(`PowerShell process exited unexpectedly with code ${code}`));
-            driver.powerShell = undefined; // Clear the reference as the process is dead
-        };
-        powerShell.on('close', onClose);
-
-        const onData: Parameters<typeof powerShell.stdout.on>[1] = ((chunk: any) => {
-            const magicChar = String.fromCharCode(magicNumber);
-            if (chunk.toString().includes(magicChar)) {
-                powerShell.stdout.off('data', onData);
-                powerShell.off('close', onClose);
-                if (driver.powerShellStdErr) {
-                    reject(new errors.UnknownError(driver.powerShellStdErr));
-                } else {
-                    resolve(driver.powerShellStdOut.replace(`${magicChar}`, '').trim());
-                }
-            }
-        }).bind(driver);
-
-        powerShell.stdout.on('data', onData);
-    });
-}
-
-export async function startPowerShellSession(this: NovaWindows2Driver): Promise<void> {
-    this.log.debug('Starting new PowerShell session...');
-    const powerShell = spawn('powershell.exe', ['-NoExit', '-Command', '-']);
-    powerShell.stdout.setEncoding('utf8');
-    powerShell.stderr.setEncoding('utf8');
-
-    powerShell.stdout.on('data', (chunk: any) => {
-        this.powerShellStdOut += chunk.toString();
-    });
-
-    powerShell.stderr.on('data', (chunk: any) => {
-        this.powerShellStdErr += chunk.toString();
-    });
-
-    this.powerShell = powerShell;
-
-    if (this.caps.appWorkingDir) {
-        const envVarsSet: Set<string> = new Set();
-        const matches = this.caps.appWorkingDir.matchAll(/%([^%]+)%/g);
-
-        for (const match of matches) {
-            envVarsSet.add(match[1]);
-        }
-        const envVars = Array.from(envVarsSet);
-        for (const envVar of envVars) {
-            this.caps.appWorkingDir = this.caps.appWorkingDir.replaceAll(`%${envVar}%`, process.env[envVar.toUpperCase()] ?? '');
-        }
-        // Use raw execution to bypass queue
-        await executeRawCommand(this, `Set-Location -Path '${this.caps.appWorkingDir}'`);
-    }
-
-    // Use raw execution to bypass queue
-    await executeRawCommand(this, SET_UTF8_ENCODING);
-    await executeRawCommand(this, ADD_NECESSARY_ASSEMBLIES);
-    await executeRawCommand(this, USE_UI_AUTOMATION_CLIENT);
-    await executeRawCommand(this, INIT_CACHE_REQUEST);
-    await executeRawCommand(this, INIT_ELEMENT_TABLE);
-
-    // initialize functions
-    await executeRawCommand(this, PAGE_SOURCE);
-    await executeRawCommand(this, FIND_CHILDREN_RECURSIVELY);
-
-    if ((!this.caps.app && !this.caps.appTopLevelWindow) || (!this.caps.app || this.caps.app.toLowerCase() === 'none')) {
-        this.log.info(`No app or top-level window specified in capabilities. Setting root element to null.`);
-        await executeRawCommand(this, NULL_ROOT_ELEMENT);
-    }
-
-    if (this.caps.app && this.caps.app.toLowerCase() === 'root') {
-        this.log.info(`'root' specified as app in capabilities. Setting root element to desktop root.`);
-        await executeRawCommand(this, INIT_ROOT_ELEMENT);
-    }
-
-    if (this.caps.app && this.caps.app.toLowerCase() !== 'none' && this.caps.app.toLowerCase() !== 'root') {
-        this.log.info(`Application path specified in capabilities: ${this.caps.app}`);
-        const envVarsSet: Set<string> = new Set();
-        const matches = this.caps.app.matchAll(/%([^%]+)%/g);
-
-        for (const match of matches) {
-            envVarsSet.add(match[1]);
-        }
-
-        const envVars = Array.from(envVarsSet);
-        this.log.info(`Detected the following environment variables in app path: ${envVars.map((envVar) => `%${envVar}%`).join(', ')}`);
-
-        for (const envVar of envVars) {
-            this.caps.app = this.caps.app.replaceAll(`%${envVar}%`, process.env[envVar.toUpperCase()] ?? '');
-        }
-
-        await this.changeRootElement(this.caps.app);
-    }
-
-    if (this.caps.appTopLevelWindow) {
-        const nativeWindowHandle = Number(this.caps.appTopLevelWindow);
-
-        if (isNaN(nativeWindowHandle)) {
-            throw new errors.InvalidArgumentError(`Invalid capabilities. Capability 'appTopLevelWindow' is not a valid native window handle.`);
-        }
-
-        await this.changeRootElement(nativeWindowHandle);
-    }
-}
-
-export async function sendIsolatedPowerShellCommand(this: NovaWindows2Driver, command: string): Promise<string> {
-    const magicNumber = 0xF2EE;
-
-    const powerShell = spawn('powershell.exe', ['-NoExit', '-Command', '-']);
-    try {
-        powerShell.stdout.setEncoding('utf8');
-        powerShell.stdout.setEncoding('utf8');
-
-        powerShell.stdout.on('data', (chunk: any) => {
-            this.powerShellStdOut += chunk.toString();
-        });
-
-        powerShell.stderr.on('data', (chunk: any) => {
-            this.powerShellStdErr += chunk.toString();
-        });
-
-        const result = await new Promise<string>((resolve, reject) => {
-            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-            const powerShell = this.powerShell!;
-
-            this.powerShellStdOut = '';
-            this.powerShellStdErr = '';
-
-            powerShell.stdin.write(`${SET_UTF8_ENCODING}\n`);
-            if (this.caps.appWorkingDir) {
-                const envVarsSet: Set<string> = new Set();
-                const matches = this.caps.appWorkingDir.matchAll(/%([^%]+)%/g);
-
-                for (const match of matches) {
-                    envVarsSet.add(match[1]);
-                }
-                const envVars = Array.from(envVarsSet);
-                for (const envVar of envVars) {
-                    this.caps.appWorkingDir = this.caps.appWorkingDir.replaceAll(`%${envVar}%`, process.env[envVar.toUpperCase()] ?? '');
-                }
-                powerShell.stdin.write(`Set-Location -Path '${this.caps.appWorkingDir}'\n`);
-            }
-            powerShell.stdin.write(`${command}\n`);
-            powerShell.stdin.write(/* ps1 */ `Write-Output $([char]0x${magicNumber.toString(16)})\n`);
-
-            const onClose = (code: number) => {
-                reject(new errors.UnknownError(`PowerShell process exited unexpectedly with code ${code}`));
-            };
-            powerShell.on('close', onClose);
-
-            const onData: Parameters<typeof powerShell.stdout.on>[1] = ((chunk: any) => {
-                const magicChar = String.fromCharCode(magicNumber);
-                if (chunk.toString().includes(magicChar)) {
-                    powerShell.stdout.off('data', onData);
-                    powerShell.off('close', onClose);
-                    if (this.powerShellStdErr) {
-                        reject(new errors.UnknownError(this.powerShellStdErr));
-                    } else {
-                        resolve(this.powerShellStdOut.replace(`${magicChar}`, '').trim());
-                    }
-                }
-            }).bind(this);
-
-            powerShell.stdout.on('data', onData);
-        });
-
-        // commented out for now to avoid cluttering the logs with long command outputs
-        // this.log.debug(`PowerShell command executed:\n${command}\n\nCommand output below:\n${result}\n   --------`);
-
-        return result;
-    } finally {
-        // Ensure the isolated PowerShell process is terminated
-        try {
-            powerShell.kill();
-        } catch (e) {
-            this.log.warn(`Failed to terminate isolated PowerShell process: ${e}`);
-        }
-    }
-}
-
-export async function sendPowerShellCommand(this: NovaWindows2Driver, command: string): Promise<string> {
-    const nextCommand = async () => {
-        if (!this.powerShell) {
-            this.log.warn('PowerShell session not running. It was either closed or has crashed. Attempting to start a new session...');
-            await this.startPowerShellSession();
-        }
-
-        // Use the extracted raw command function
-        return await executeRawCommand(this, command);
-    };
-
-    // Chain the command to the queue
-    // Use .catch to ignore previous failures, then .then to queue this command.
-    // This prevents re-running this command if it fails (no infinite loop).
-    this.commandQueue = this.commandQueue
-        .catch(() => { /* ignore previous error */ })
-        .then(nextCommand);
-
-    return this.commandQueue;
-}
-
-export async function terminatePowerShellSession(this: NovaWindows2Driver): Promise<void> {
-    if (!this.powerShell) {
-        return;
-    }
-
-    if (this.powerShell.exitCode !== null) {
-        this.log.debug(`PowerShell session already terminated.`);
-        return;
-    }
-
-    this.log.debug(`Terminating PowerShell session...`);
-    const waitForClose = new Promise<void>((resolve, reject) => {
-        if (!this.powerShell) {
-            resolve();
-        }
-
-        this.powerShell?.once('close', () => {
-            resolve();
-        });
-
-        this.powerShell?.once('error', (err: Error) => {
-            reject(err);
-        });
-    });
-
-
-    this.powerShell.kill();
-    await waitForClose;
-    this.log.debug(`PowerShell session terminated successfully.`);
-}

package/lib/commands/system.ts

@@ -1,7 +0,0 @@
-import { Orientation } from '@appium/types';
-import { NovaWindows2Driver } from '../driver';
-import { getDisplayOrientation } from '../winapi/user32';
-
-export function getOrientation(this: NovaWindows2Driver): Orientation {
-    return getDisplayOrientation();
-}

package/lib/constants.ts

@@ -1 +0,0 @@
-export const POWER_SHELL_FEATURE = 'power_shell';

package/lib/constraints.ts

@@ -1,43 +0,0 @@
-import type { Constraints } from '@appium/types';
-
-export const UI_AUTOMATION_DRIVER_CONSTRAINTS = {
-    platformName: {
-        isString: true,
-        inclusionCaseInsensitive: ['Windows'],
-        presence: true,
-    },
-    smoothPointerMove: {
-        isString: true,
-    },
-    delayBeforeClick: {
-        isNumber: true,
-    },
-    delayAfterClick: {
-        isNumber: true,
-    },
-    appTopLevelWindow: {
-        isString: true,
-    },
-    shouldCloseApp: {
-        isBoolean: true,
-    },
-    appArguments: {
-        isString: true,
-    },
-    appWorkingDir: {
-        isString: true,
-    },
-    prerun: {
-        isObject: true,
-    },
-    postrun: {
-        isObject: true,
-    },
-    isolatedScriptExecution: {
-        isBoolean: true,
-    }
-} as const satisfies Constraints;
-
-export default UI_AUTOMATION_DRIVER_CONSTRAINTS;
-
-export type NovaWindowsDriverConstraints = typeof UI_AUTOMATION_DRIVER_CONSTRAINTS;