Sauce: Implement CopyDeviceItem, log file parameter for RunApplication & fix issues #32

limbonaut · 2025-12-10T09:43:11Z

I tested it on iOS in Sauce Labs, and it should work on Android too. This PR also fixes some issues specific to iOS in Sauce Labs runner: splitting CLI arguments correctly and using correct Appium parameter for iOS.

These changes are sufficient to get E2E tests green on iOS in the Godot SDK.

app-runner/Private/DeviceProviders/SauceLabsProvider.ps1

- Add optional LogFilePath parameter to Invoke-DeviceApp and RunApplication - Implement log file retrieval with fallback to system logs in SauceLabsProvider - Add method overloads to AdbProvider and XboxProvider for compatibility - Reduce code footprint by consolidating log retrieval logic - Maintain backward compatibility with existing provider implementations Co-authored-by: Claude Sonnet <claude@anthropic.com>

app-runner/Private/DeviceProviders/AdbProvider.ps1

app-runner/Public/Invoke-DeviceApp.ps1

- Replace method overloads with single method using optional LogFilePath parameter - Update base DeviceProvider class to include optional parameter - Simplify all provider implementations (SauceLabs, Adb, Xbox) - Remove conditional logic from Invoke-DeviceApp - single method call - Clean up code by eliminating method overload complexity Co-authored-by: Claude Sonnet <claude@anthropic.com>

- Add optional LogFilePath parameter to match other providers - Ensures consistent method signature across all provider implementations - Completes the refactoring to use optional parameters instead of overloads Co-authored-by: Claude Sonnet <claude@anthropic.com>

limbonaut · 2025-12-11T14:05:02Z

Test run example: test: Adjustments for iOS end-to-end testing sentry-godot#461 (comment)

vaind · 2025-12-12T15:18:04Z

On it! We are reviewing the PR and will provide feedback shortly.
_{Reference ID: 1}

vaind · 2025-12-12T19:29:35Z

app-runner/Private/DeviceProviders/SauceLabsProvider.ps1

+
+                # Split the arguments string by spaces, but handle quoted strings (both single and double quotes)
+                $argTokens = [regex]::Matches($Arguments, '(\"[^\"]*\"|''[^'']*''|\S+)') | ForEach-Object { $_.Value.Trim('"', "'") }
+
+                foreach ($token in $argTokens) {
+                    $argumentsArray += $token
+                }
+
+                $launchBody['arguments'] = $argumentsArray


Even better, how about we change $arguments param to [object] and let users pass string or array?

Actually, [string[]] actually accepts both a string and an array of strings

We have multiple places where we represent arguments as a single string. I suppose I can refactor all of that in this PR.

you shouldn't really need to change that. a single string works the same as an array of a a single string

I mean that we accept a string as arguments in various API calls. Now if we change policy to accept arguments as an array, we still need arguments as a single string in some places. Converting from array of strings to a single string is not straightforward - requires proper escaping. One way or the other we'll have to deal with conversion.

app-runner/Private/DeviceProviders/SauceLabsProvider.ps1

vaind · 2025-12-12T15:19:36Z

app-runner/Private/DeviceProviders/SauceLabsProvider.ps1

+        if ($Error.Exception.Message -match "500|Internal Server Error") {
+            $errorMsg += "`n`nTroubleshooting $($this.MobilePlatform) file access:"
+            $errorMsg += "`n- App Package/Bundle ID: '$($this.CurrentPackageName)'"
+            $errorMsg += "`n- Requested path: '$DevicePath'"
+
+            if ($this.MobilePlatform -eq 'iOS') {
+                try {
+                    $appInfo = $this.CheckAppFileSharingCapability()
+                    if ($appInfo.AllApps -and $appInfo.AllApps.Count -gt 0) {
+                        $errorMsg += "`n- Available apps: $($appInfo.AllApps -join ', ')"
+                        if ($appInfo.Found -and -not $appInfo.FileSharingEnabled) {
+                            $errorMsg += "`n- App found but UIFileSharingEnabled=false"
+                        }
+                    }
+                } catch {
+                    $errorMsg += "`n- Could not check app capabilities: $($_.Exception.Message)"
+                }
+


In the HandleCopyDeviceItemError method, the error handling tries to call CheckAppFileSharingCapability() to provide diagnostic information. However, if this method itself throws an exception (which it can on line 629 with 'No active SauceLabs session'), the exception is caught but the session existence should have been verified before attempting the CopyDeviceItem operation. Consider moving the session check to the beginning of CopyDeviceItem instead of relying on nested error handling.
_{Severity: MEDIUM}

🤖 Prompt for AI Agent

Review the code at the location below. A potential bug has been identified by an AI agent. Verify if this is a real issue. If it is, propose a fix; if not, explain why it's not valid. Location: app-runner/Private/DeviceProviders/SauceLabsProvider.ps1#L738-L755 Potential issue: In the `HandleCopyDeviceItemError` method, the error handling tries to call `CheckAppFileSharingCapability()` to provide diagnostic information. However, if this method itself throws an exception (which it can on line 629 with 'No active SauceLabs session'), the exception is caught but the session existence should have been verified before attempting the CopyDeviceItem operation. Consider moving the session check to the beginning of `CopyDeviceItem` instead of relying on nested error handling.

_{Did we get this right? 👍 / 👎 to inform future reviews.}
_{Reference ID: 1}

vaind · 2025-12-12T15:19:39Z

app-runner/Public/Invoke-DeviceApp.ps1


+    .PARAMETER LogFilePath
+    Optional path to a log file on the device to retrieve instead of using system logs (syslog/logcat).
+    Path format is platform-specific:
+    - iOS: Use bundle format like "@com.example.app:documents/logs/app.log"
+    - Android: Use absolute path like "/data/data/com.example.app/files/logs/app.log"
+
    .EXAMPLE
    Invoke-DeviceApp -ExecutablePath "MyGame.exe" -Arguments "--debug --level=1"
+
+    .EXAMPLE


The new LogFilePath parameter documentation provides good examples for iOS and Android, but doesn't mention platform limitations. Since only SauceLabsProvider currently implements log file retrieval, calling Invoke-DeviceApp with LogFilePath on other platforms will silently ignore the parameter (due to the default null value). Consider adding a note in the documentation that this parameter is platform-specific, or consider warning the user if the parameter is provided but not supported by the current provider.
_{Severity: MEDIUM}

🤖 Prompt for AI Agent

Review the code at the location below. A potential bug has been identified by an AI agent. Verify if this is a real issue. If it is, propose a fix; if not, explain why it's not valid. Location: app-runner/Public/Invoke-DeviceApp.ps1#L15-L25 Potential issue: The new `LogFilePath` parameter documentation provides good examples for iOS and Android, but doesn't mention platform limitations. Since only SauceLabsProvider currently implements log file retrieval, calling `Invoke-DeviceApp` with `LogFilePath` on other platforms will silently ignore the parameter (due to the default null value). Consider adding a note in the documentation that this parameter is platform-specific, or consider warning the user if the parameter is provided but not supported by the current provider.

_{Did we get this right? 👍 / 👎 to inform future reviews.}
_{Reference ID: 1}

vaind · 2025-12-12T19:39:49Z

app-runner/Private/DeviceProviders/SauceLabsProvider.ps1

+                        Found = $true
+                        BundleId = $this.CurrentPackageName
+                        FileSharingEnabled = [bool]$targetApp.UIFileSharingEnabled
+                        Name = $targetApp.CFBundleDisplayName -or $targetApp.CFBundleName -or "Unknown"


Or doesn't work like a null-coallescing operator in Powershell so the current code returns $true instead of a name. Instead, you can do this:

Suggested change

Name = $targetApp.CFBundleDisplayName -or $targetApp.CFBundleName -or "Unknown"

Name = $targetApp.CFBundleDisplayName ?? $targetApp.CFBundleName ?? "Unknown"

but that could still return an empty string - "??" only works with nulls.
If it's possible these would be empty strings, you need to expand to if-else loop, for example like this:

Suggested change

Name = $targetApp.CFBundleDisplayName -or $targetApp.CFBundleName -or "Unknown"

Name = $(

if ($targetApp.CFBundleDisplayName) { $targetApp.CFBundleDisplayName }

elseif ($targetApp.CFBundleName) { $targetApp.CFBundleName }

else { "Unknown" }

)

vaind · 2025-12-12T19:45:12Z

app-runner/Private/DeviceProviders/SauceLabsProvider.ps1

+        Write-Error $errorMsg
+        throw


Write-error doesn't just log. with our ErrorActionPreference, it's functionally equivalent to throwing. so the next line is never reached. You can use Write-Warning instead

vaind

I've found a couple of bugs and a few improvement ideas

Updated device provider APIs to consistently accept arguments as string arrays rather than pre-formatted strings, improving type safety and eliminating argument parsing ambiguities. Added ConvertArgumentsToString method to DeviceProvider base class for consistent string conversion when needed by underlying tools. Co-authored-by: Claude <claude@anthropic.com>

sentry · 2025-12-13T16:30:09Z

app-runner/Private/DeviceProviders/SauceLabsProvider.ps1

            if ($Arguments) {
-                # Appium 'mobile: launchApp' supports arguments? 
-                # Or use 'appium:processArguments' capability during session creation?
-                # For now, we'll try to pass them if supported by the endpoint or warn.
-                $launchBody['arguments'] = $Arguments -split ' ' # Simple split, might need better parsing
+                # Parse arguments string into array, handling quoted strings and standalone "--" separator
+                $argumentsArray = @()
+
+                # Split the arguments string by spaces, but handle quoted strings (both single and double quotes)
+                $argTokens = [regex]::Matches($Arguments, '(\"[^\"]*\"|''[^'']*''|\S+)') | ForEach-Object { $_.Value.Trim('"', "'") }


Bug: The iOS implementation in RunApplication passes the $Arguments array directly to [regex]::Matches without first converting it to a string, unlike the Android path. This will cause incorrect argument parsing.
_{Severity: CRITICAL | Confidence: High}

🔍 Detailed Analysis

In the RunApplication function, the iOS implementation incorrectly handles the $Arguments parameter, which is an array ([string[]]). Unlike the Android implementation which correctly converts the array to a string, the iOS code passes the array directly to [regex]::Matches on line 379. This function expects a string, and relying on PowerShell's implicit array-to-string conversion is fragile and will likely lead to incorrect argument parsing. This will cause iOS apps launched via SauceLabs to receive malformed arguments, potentially leading to launch failures or incorrect application behavior. Additionally, logging on line 363 will be improperly formatted.

💡 Suggested Fix

Before the iOS implementation logic (line 362), convert the $Arguments array to a string using $argumentsString = $this.ConvertArgumentsToString($Arguments). Subsequently, use this new $argumentsString variable for logging (line 363) and in the regex parsing logic (line 379) to ensure arguments are handled correctly.

🤖 Prompt for AI Agent

Review the code at the location below. A potential bug has been identified by an AI agent. Verify if this is a real issue. If it is, propose a fix; if not, explain why it's not valid. Location: app-runner/Private/DeviceProviders/SauceLabsProvider.ps1#L374-L379 Potential issue: In the `RunApplication` function, the iOS implementation incorrectly handles the `$Arguments` parameter, which is an array (`[string[]]`). Unlike the Android implementation which correctly converts the array to a string, the iOS code passes the array directly to `[regex]::Matches` on line 379. This function expects a string, and relying on PowerShell's implicit array-to-string conversion is fragile and will likely lead to incorrect argument parsing. This will cause iOS apps launched via SauceLabs to receive malformed arguments, potentially leading to launch failures or incorrect application behavior. Additionally, logging on line 363 will be improperly formatted.

_{Did we get this right? 👍 / 👎 to inform future reviews.}
_{Reference ID: 7483056}

limbonaut added 4 commits December 8, 2025 21:39

Fix argument splitting

3e5924a

Use proper parameter on iOS vs Android

663dac8

Implement CopyDeviceItem (iOS tested)

7dd6fe1

Add Android-specific diagnostics

a748051

limbonaut changed the title ~~feat: Implement CopyDeviceitem for Sauce Labs~~ feat: Implement CopyDeviceitem for Sauce Labs & fix issues Dec 10, 2025

limbonaut changed the title ~~feat: Implement CopyDeviceitem for Sauce Labs & fix issues~~ feat: Implement CopyDeviceItem for Sauce Labs & fix issues Dec 10, 2025

limbonaut marked this pull request as ready for review December 10, 2025 11:00

sentry bot reviewed Dec 10, 2025

View reviewed changes

app-runner/Private/DeviceProviders/SauceLabsProvider.ps1 Show resolved Hide resolved

sentry bot reviewed Dec 10, 2025

View reviewed changes

app-runner/Private/DeviceProviders/AdbProvider.ps1 Outdated Show resolved Hide resolved

limbonaut changed the title ~~feat: Implement CopyDeviceItem for Sauce Labs & fix issues~~ Sauce: Implement CopyDeviceItem, log file parameter for RunApplication & fix issues Dec 10, 2025

limbonaut added 3 commits December 10, 2025 12:28

Undo changes in AdbProvider

4aee5ae

Restore comment

04087e8

Restore another comment

72f28c0

sentry bot reviewed Dec 10, 2025

View reviewed changes

app-runner/Public/Invoke-DeviceApp.ps1 Outdated Show resolved Hide resolved

limbonaut and others added 2 commits December 10, 2025 12:48

limbonaut requested review from tustanivsky and vaind December 10, 2025 12:06

Remove outdated warning - args are supported on iOS

c88f48c

limbonaut mentioned this pull request Dec 10, 2025

test: Adjustments for iOS end-to-end testing getsentry/sentry-godot#461

Open

vaind reviewed Dec 12, 2025

View reviewed changes

app-runner/Private/DeviceProviders/SauceLabsProvider.ps1 Show resolved Hide resolved

vaind reviewed Dec 12, 2025

View reviewed changes

vaind requested changes Dec 12, 2025

View reviewed changes

sentry bot reviewed Dec 13, 2025

View reviewed changes

	Name = $targetApp.CFBundleDisplayName -or $targetApp.CFBundleName -or "Unknown"
	Name = $targetApp.CFBundleDisplayName ?? $targetApp.CFBundleName ?? "Unknown"

-                        Name = $targetApp.CFBundleDisplayName -or $targetApp.CFBundleName -or "Unknown"
+                        Name = $(
+    if ($targetApp.CFBundleDisplayName) { $targetApp.CFBundleDisplayName }
+    elseif ($targetApp.CFBundleName) { $targetApp.CFBundleName }
+    else { "Unknown" }
+)

Uh oh!

Sauce: Implement CopyDeviceItem, log file parameter for RunApplication & fix issues #32

Are you sure you want to change the base?

Sauce: Implement CopyDeviceItem, log file parameter for RunApplication & fix issues #32

Uh oh!

Conversation

limbonaut commented Dec 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

limbonaut commented Dec 11, 2025

Uh oh!

vaind commented Dec 12, 2025

Uh oh!

This comment was marked as outdated.

Uh oh!

vaind Dec 12, 2025

Choose a reason for hiding this comment

Uh oh!

vaind Dec 12, 2025

Choose a reason for hiding this comment

Uh oh!

limbonaut Dec 13, 2025

Choose a reason for hiding this comment

Uh oh!

vaind Dec 13, 2025

Choose a reason for hiding this comment

Uh oh!

limbonaut Dec 13, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

vaind Dec 12, 2025

Choose a reason for hiding this comment

Uh oh!

vaind Dec 12, 2025

Choose a reason for hiding this comment

Uh oh!

vaind Dec 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

vaind Dec 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

vaind left a comment

Choose a reason for hiding this comment

Uh oh!

sentry bot Dec 13, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

limbonaut commented Dec 10, 2025 •

edited

Loading

vaind Dec 12, 2025 •

edited

Loading

vaind Dec 12, 2025 •

edited

Loading