feat: add `action` and `camera` values for `mobile: pressButton` by eglitise · Pull Request #1115 · appium/WebDriverAgent

eglitise · 2026-03-03T17:09:43Z

Currently WDA only supports the home, volumeUp and volumeDown buttons for iOS, but Apple's documentation also lists action and camera. This PR adds support for them.
Since not all devices have these buttons, their use is guarded behind the hasHardwareButton: check, which itself requires iOS 16, so a second guard was also added.

(I don't actually have a way to test this, so any validation would be appreciated)

Reference: https://developer.apple.com/documentation/xcuiautomation/xcuidevice/button?language=objc

…Button`

Copilot

Pull request overview

Adds support for additional iOS hardware button names (action, camera) to mobile: pressButton in WebDriverAgent by mapping them to the corresponding XCUIDeviceButton values when available on-device.

Changes:

Extend XCUIDevice (FBHelpers) button name mapping to include action (iOS 16+) and camera (iOS 16+) gated by hasHardwareButton:.
Update the public header docstring to list the newly supported button names.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 5 comments.

File	Description
WebDriverAgentLib/Categories/XCUIDevice+FBHelpers.m	Adds runtime-gated mapping for `action`/`camera` buttons and updates supported button list construction.
WebDriverAgentLib/Categories/XCUIDevice+FBHelpers.h	Updates API documentation to include `action` and `camera` button names.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

WebDriverAgentLib/Categories/XCUIDevice+FBHelpers.m

WebDriverAgentLib/Categories/XCUIDevice+FBHelpers.h

WebDriverAgentLib/Categories/XCUIDevice+FBHelpers.m

mykola-mokhnach · 2026-03-03T18:04:47Z

WebDriverAgentLib/Categories/XCUIDevice+FBHelpers.m

    dstButton = XCUIDeviceButtonHome;
  }
  [supportedButtonNames addObject:@"home"];
+


would it make sense to extract this logic into a separate private method to simplify this one?

It could certainly be made to look nicer, but I'm not really sure of the best approach when using these compiler-level guards

it doesn't change anything, just refactor conditions to a separate method to reduce the cyclomatic complexity of the fb_pressButton one, (e.g. fb_addButtonsIfAvailable)

Added two helper methods, one for checking if a button is available, and another for adding supported buttons to the list. The latter method is separated, as I would like to reuse both in the other tvOS PR.

mykola-mokhnach · 2026-03-03T18:04:58Z

WebDriverAgentTests/IntegrationTests/XCUIDeviceHelperTests.m

+{
+  NSError *error;
+  BOOL hasActionButton = SYSTEM_VERSION_GREATER_THAN_OR_EQUAL_TO(@"16.0")
+    && [XCUIDevice.sharedDevice hasHardwareButton:XCUIDeviceButtonAction];


same as above

KazuCocoa · 2026-03-04T05:23:49Z

WebDriverAgentLib/Categories/XCUIDevice+FBHelpers.m

  [supportedButtonNames addObject:@"home"];
+
+  #if __clang_major__ >= 17 || (__clang_major__ == 16 && __clang_minor__ >= 3)
+  if (@available(iOS 16.0, *) && [self hasHardwareButton:XCUIDeviceButtonAction]) {


I see headers below in Xcode 15.0 so I guess XCUIDeviceButtonAction exists in Xcode 15 as well.

typedef NS_ENUM(NSInteger, XCUIDeviceButton) { XCUIDeviceButtonHome = 1, XCUIDeviceButtonVolumeUp XCTEST_SIMULATOR_UNAVAILABLE("This API is not available in the Simulator, see the XCUIDeviceButton documentation for details.") = 2, XCUIDeviceButtonVolumeDown XCTEST_SIMULATOR_UNAVAILABLE("This API is not available in the Simulator, see the XCUIDeviceButton documentation for details.") = 3, #if TARGET_OS_WATCH || TARGET_OS_IOS XCUIDeviceButtonAction = 4,

I assume why Apple docs address they are available since Xcode 16.3 is they moved XCUIAutomation framework from private to public since the version

#1115 (comment)
Hm, maybe it had a case that references didn't work properly(?)
Looks reasonable to requirethe newer versions like current implementation by following Apple's public doc

The CI error seems to have been specifically due to XCUIDeviceButtonCamera, so it is likely it was added later than Xcode 15.
My guess is that the target for XCUIDeviceButtonAction is Xcode 15 (coincides with the release of iPhone 15 Pro (Max) which added it), while XCUIDeviceButtonCamera would be Xcode 16 (coincides with the release of the iPhone 16 lineup)

Changed the guards to actually check if the constant is defined, rather than the Clang version

Copilot

Pull request overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

You can also share your feedback on Copilot code review. Take the survey.

Copilot · 2026-03-04T15:16:00Z

WebDriverAgentTests/IntegrationTests/XCUIDeviceHelperTests.m

+  NSError *error;
+  BOOL hasActionButton = [XCUIDevice.sharedDevice fb_hasButton:@"action"];
+  BOOL didPressButton = [XCUIDevice.sharedDevice fb_pressButton:@"action"
+                                                     forDuration:nil
+                                                           error:&error];
+  if (hasActionButton) {
+    XCTAssertTrue(didPressButton);
+    XCTAssertNil(error);
+  } else {


NSError *error; is left uninitialized before being passed to fb_pressButton:... error:&error. Since fb_pressButton: does not set *error = nil on success, the subsequent XCTAssertNil(error) can be nondeterministic when the Action button exists and the press succeeds. Initialize error to nil before the call (and consider applying the same pattern in similar tests).

KazuCocoa · 2026-03-04T16:02:21Z

WebDriverAgentLib/Categories/XCUIDevice+FBHelpers.m

  }
 }

+- (BOOL)fb_hasButton:(NSString *)buttonName


I assume this is expected to be called only for non-tvOS, then wrapping the entire method with #if !TARGET_OS_TV and reduce it inside this method would simplify the context switching when we read the code. Then, we can assume this button is dedicated for non-tvOS env.

I would like to extend it in the other tvOS PR, which is why I haven't added the target compiler guard for the whole method. Or would it be better to make two separate fb_hasButton methods?

KazuCocoa · 2026-03-04T16:05:23Z

WebDriverAgentLib/Categories/XCUIDevice+FBHelpers.h

+ @param buttonName The name of the button to check (e.g., "home", "volumeUp", "volumeDown", "action", "camera")
+ @return YES if the button is available on the device, otherwise NO
+ */
+- (BOOL)fb_hasButton:(NSString *)buttonName;


Do you want to make this as a public method? Current usage is only in this WebDriverAgentLib/Categories/XCUIDevice+FBHelpers.m helper, so I assume we don't need to make this public til we need this from public space

mykola-mokhnach · 2026-03-04T17:29:56Z

WebDriverAgentLib/Categories/XCUIDevice+FBHelpers.m

+      [supportedButtonNames addObject:buttonName];
+    }
+  }
+}


consider moving private methods to the tail of the class definition

mykola-mokhnach · 2026-03-04T17:31:42Z

WebDriverAgentLib/Categories/XCUIDevice+FBHelpers.m

-  [supportedButtonNames addObject:@"volumeUp"];
-  [supportedButtonNames addObject:@"volumeDown"];
+#if defined(XCUIDeviceButtonCamera)
+  if ([buttonNameLC isEqualToString:@"camera"] && [self fb_hasButton:@"camera"]) {


are these conditions the same as inside fb_addButtonsIfAvailable ?

feat: add support for action and camera values for `mobile: press…

88de359

…Button`

eglitise requested review from KazuCocoa, Copilot and mykola-mokhnach March 3, 2026 17:09

Copilot started reviewing on behalf of eglitise March 3, 2026 17:10 View session

Copilot AI reviewed Mar 3, 2026

View reviewed changes

test: add scenario for pressing action button

9567bbb

mykola-mokhnach reviewed Mar 3, 2026

View reviewed changes

WebDriverAgentLib/Categories/XCUIDevice+FBHelpers.m Outdated Show resolved Hide resolved

mykola-mokhnach reviewed Mar 3, 2026

View reviewed changes

use compiler guards for older Xcodes

77352bd

eglitise mentioned this pull request Mar 3, 2026

feat: add 6 tvOS button values for mobile: pressButton #1116

Open

KazuCocoa reviewed Mar 4, 2026

View reviewed changes

KazuCocoa approved these changes Mar 4, 2026

View reviewed changes

eglitise added 2 commits March 4, 2026 16:39

add two helper methods to improve clarity

818d8d6

use compiler guards that depend on the actual constant definition

2098b98

eglitise requested a review from Copilot March 4, 2026 15:12

Copilot started reviewing on behalf of eglitise March 4, 2026 15:12 View session

Copilot AI reviewed Mar 4, 2026

View reviewed changes

KazuCocoa reviewed Mar 4, 2026

View reviewed changes

remove fb_hasButton from public headers

8f4c7bd

mykola-mokhnach reviewed Mar 4, 2026

View reviewed changes

Conversation

eglitise commented Mar 3, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

eglitise Mar 4, 2026 • 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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

KazuCocoa Mar 4, 2026 • 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!

eglitise Mar 4, 2026 • 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!

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Mar 4, 2026

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

eglitise Mar 4, 2026 • 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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

eglitise Mar 4, 2026 •

edited

Loading

KazuCocoa Mar 4, 2026 •

edited

Loading

eglitise Mar 4, 2026 •

edited

Loading

eglitise Mar 4, 2026 •

edited

Loading