-
-
Notifications
You must be signed in to change notification settings - Fork 750
fix:[iOS 17+] Appium should not overrride sauce:options cap with prefix #5202
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
fix:[iOS 17+] Appium should not overrride sauce:options cap with prefix #5202
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
Fixes an issue where the Appium helper was incorrectly prefixing the sauce:options capability with appium:, causing test failures on iOS 17+ devices using SauceLabs cloud provider. The fix prevents the automatic prefixing of cloud provider-specific capabilities that should remain in their original format.
- Added exception for
sauce:optionscapability to prevent automaticappium:prefixing - Ensures cloud provider capabilities maintain their required format for proper communication
- Fixes compatibility issue with WDIO v9 upgrade affecting iOS 17+ test execution
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
37cd6cb
into
codeceptjs:3.x
Motivation/Description of the PR
- [iOS 17+] Override of 'sauce:options' cap into 'appium:sauce:options' lead to error on start and does not allow to run tests on cloud provider: iOS 17 and above must be used with the W3C protocol and Appium 2. Visit https://docs.saucelabs.com/mobile-apps/automated-testing/appium/appium-2-migration/ to learn how to migrate to Appium 2.
- Preconditions: "codeceptjs": "^3.7.4", "webdriverio": "^9.19.2", cloud provider: SauceLabs
- Used settings
Screenshot 2025年09月22日 at 14 57 48Appium: {
"appiumV2": true,
"protocol": "https",
"host": "ondemand.eu-central-1.saucelabs.com",
"region": "eu",
"port": 443,
"path": "/wd/hub",
"user": "mikhail.yesipchuk",
"key": "...",
"waitForTimeout": 5000,
"smartWait": 3000,
"app": "storage:filename=.ipa",
"platform": "iOS",
"restart": false,
"reuseSession": false,
"desiredCapabilities": {
"platformName": "iOS",
"appium:app": "storage:filename=.ipa",
"appium:automationName": "XCUITest",
"appium:platformVersion": "18",
"appium:deviceName": "iPhone 1.*",
"appium:language": "en",
"appium:locale": "en_GB",
"sauce:options": {
"name": "Mobile Automation Test - iOS",
"appiumVersion": "latest",
"phoneOnly": true,
"networkCapture": false,
},
"appium:noReset": true,
"appium:fullReset": false,
"appium:waitForIdleTimeout": 0,
"appium:newCommandTimeout": 90,
"appium:autoAcceptAlerts": true,
"appium:useNewWDA": false
}
}
Note: issue happens after update wdio from v8 to v9
Applicable helpers:
Type of change
Checklist:
npm run docs)npm run lint)npm test)Test run:
220 passing (4m)
1 pending
1 failing
should run tests with pool mode:
Uncaught Error: expect(received).toContain(expected) // indexOf
Expected substring: "Scenario Steps:"
Received string: "CodeceptJS v3.7.5 #StandWithUkraine