appium-webdriveragent 4.1.7 → 4.3.1

package/PrivateHeaders/XCTest/XCUIDevice.h

@@ -11,9 +11,16 @@
 // Since Xcode 10.2
 @property (readonly) id accessibilityInterface; // implements XCUIAccessibilityInterface
 @property (readonly) id eventSynthesizer; // implements XCUIEventSynthesizing
-@property(readonly) id screenDataSource; // @synthesize screenDataSource=_screenDataSource;
+@property (readonly) id screenDataSource; // @synthesize screenDataSource=_screenDataSource;
+
 - (_Bool)performDeviceEvent:(id)arg1 error:(id *)arg2;
 
+// Since Xcode 13
+// 1 - Light
+// 2 - Dark
+- (void)setAppearanceMode:(long long)arg1;
+- (long long)appearanceMode;
+
 - (void)pressLockButton;
 - (void)holdHomeButtonForDuration:(double)arg1;
 - (void)_silentPressButton:(long long)arg1;

package/WebDriverAgentLib/Categories/XCUIDevice+FBHelpers.h

@@ -11,6 +11,12 @@
 
 NS_ASSUME_NONNULL_BEGIN
 
+typedef NS_ENUM(NSUInteger, FBUIInterfaceAppearance) {
+  FBUIInterfaceAppearanceUnspecified,
+  FBUIInterfaceAppearanceLight,
+  FBUIInterfaceAppearanceDark
+};
+
 @interface XCUIDevice (FBHelpers)
 
 /**
@@ -120,6 +126,22 @@ NS_ASSUME_NONNULL_BEGIN
                             duration:(NSTimeInterval)duration
                                error:(NSError **)error;
 
+/**
+ Allows to set device appearance
+
+ @param appearance The desired appearance value
+ @param error If there is an error, upon return contains an NSError object that describes the problem.
+ @return YES if the appearance has been successfully set
+ */
+- (BOOL)fb_setAppearance:(FBUIInterfaceAppearance)appearance error:(NSError **)error;
+
+/**
+ Get current appearance prefefence.
+
+ @return 0 (automatic), 1 (light) or 2 (dark), or nil
+ */
+- (nullable NSNumber *)fb_getAppearance;
+
 @end
 
 NS_ASSUME_NONNULL_END

package/WebDriverAgentLib/Categories/XCUIDevice+FBHelpers.m

@@ -309,4 +309,28 @@ static bool fb_isLocked;
   return [self performDeviceEvent:event error:error];
 }
 
+- (BOOL)fb_setAppearance:(FBUIInterfaceAppearance)appearance error:(NSError **)error
+{
+  SEL selector = NSSelectorFromString(@"setAppearanceMode:");
+  if (nil != selector && [self respondsToSelector:selector]) {
+    NSMethodSignature *signature = [self methodSignatureForSelector:selector];
+    NSInvocation *invocation = [NSInvocation invocationWithMethodSignature:signature];
+    [invocation setSelector:selector];
+    [invocation setTarget:self];
+    [invocation setArgument:&appearance atIndex:2];
+    [invocation invoke];
+    return YES;
+  }
+  return [[[FBErrorBuilder builder]
+           withDescriptionFormat:@"Current Xcode SDK does not support appearance changing"]
+          buildError:error];
+}
+
+- (NSNumber *)fb_getAppearance
+{
+  return [self respondsToSelector:@selector(appearanceMode)]
+  ? [NSNumber numberWithLongLong:[self appearanceMode]]
+  : nil;
+}
+
 @end

package/WebDriverAgentLib/Commands/FBCustomCommands.m

@@ -63,6 +63,7 @@
     [[FBRoute GET:@"/wda/device/info"] respondWithTarget:self action:@selector(handleGetDeviceInfo:)],
     [[FBRoute POST:@"/wda/resetAppAuth"] respondWithTarget:self action:@selector(handleResetAppAuth:)],
     [[FBRoute GET:@"/wda/device/info"].withoutSession respondWithTarget:self action:@selector(handleGetDeviceInfo:)],
+    [[FBRoute POST:@"/wda/device/appearance"].withoutSession respondWithTarget:self action:@selector(handleSetDeviceAppearance:)],
     [[FBRoute GET:@"/wda/device/location"] respondWithTarget:self action:@selector(handleGetLocation:)],
     [[FBRoute GET:@"/wda/device/location"].withoutSession respondWithTarget:self action:@selector(handleGetLocation:)],
     [[FBRoute OPTIONS:@"/*"].withoutSession respondWithTarget:self action:@selector(handlePingCommand:)],
@@ -369,6 +370,25 @@
   return FBResponseWithOK();
 }
 
++ (id<FBResponsePayload>)handleSetDeviceAppearance:(FBRouteRequest *)request
+{
+  NSString *name = [request.arguments[@"name"] lowercaseString];
+  if (nil == name || !([name isEqualToString:@"light"] || [name isEqualToString:@"dark"])) {
+    NSString *message = @"The appearance name must be either 'light' or 'dark'";
+    return FBResponseWithStatus([FBCommandStatus invalidArgumentErrorWithMessage:message traceback:nil]);
+  }
+
+  FBUIInterfaceAppearance appearance = [name isEqualToString:@"light"]
+    ? FBUIInterfaceAppearanceLight
+    : FBUIInterfaceAppearanceDark;
+  NSError *error;
+  if (![XCUIDevice.sharedDevice fb_setAppearance:appearance error:&error]) {
+    return FBResponseWithStatus([FBCommandStatus unknownErrorWithMessage:error.description
+                                                               traceback:nil]);
+  }
+  return FBResponseWithOK();
+}
+
 + (id<FBResponsePayload>)handleGetDeviceInfo:(FBRouteRequest *)request
 {
   // Returns locale like ja_EN and zh-Hant_US. The format depends on OS
@@ -406,6 +426,16 @@
  */
 + (NSString *)userInterfaceStyle
 {
+
+  if (SYSTEM_VERSION_GREATER_THAN_OR_EQUAL_TO(@"15.0")) {
+    // Only iOS 15+ simulators/devices return correct data while
+    // the api itself works in iOS 13 and 14 that has style preference.
+    NSNumber *appearance = [XCUIDevice.sharedDevice fb_getAppearance];
+    if (appearance != nil) {
+      return [self getAppearanceName:appearance];
+    }
+  }
+
   static id userInterfaceStyle = nil;
   static dispatch_once_t styleOnceToken;
   dispatch_once(&styleOnceToken, ^{
@@ -421,10 +451,17 @@
     return @"unsupported";
   }
 
-  switch ([userInterfaceStyle integerValue]) {
-    case 1: // UIUserInterfaceStyleLight
+  return [self getAppearanceName:userInterfaceStyle];
+}
+
++ (NSString *)getAppearanceName:(NSNumber *)appearance
+{
+  switch ([appearance longLongValue]) {
+    case FBUIInterfaceAppearanceUnspecified:
+      return @"automatic";
+    case FBUIInterfaceAppearanceLight:
       return @"light";
-    case 2: // UIUserInterfaceStyleDark
+    case FBUIInterfaceAppearanceDark:
       return @"dark";
     default:
       return @"unknown";

package/WebDriverAgentLib/Utilities/FBScreenshot.m

@@ -212,7 +212,8 @@ NSString *formatTimeInterval(NSTimeInterval interval) {
   dispatch_once(&shouldUseSRApi, ^{
     if ([proxy respondsToSelector:@selector(_XCT_requestScreenshot:withReply:)]) {
 #if TARGET_OS_SIMULATOR
-      result = YES;
+      // Required to support simulators running iOS 14.4 and below with Xcode 12.5 and above due to unsupported API on the simulator side.
+      result = SYSTEM_VERSION_GREATER_THAN_OR_EQUAL_TO(@"14.5");
 #else
       result = SYSTEM_VERSION_GREATER_THAN_OR_EQUAL_TO(@"15.0");
 #endif

package/WebDriverAgentTests/IntegrationTests/XCUIDeviceHelperTests.m

@@ -156,4 +156,14 @@
   XCTAssertNil(error);
 }
 
+- (void)testAppearance
+{
+  if (SYSTEM_VERSION_LESS_THAN(@"15.0")) {
+    return;
+  }
+  NSError *error;
+  XCTAssertTrue([XCUIDevice.sharedDevice fb_setAppearance:FBUIInterfaceAppearanceDark error:&error]);
+  XCTAssertNil(error);
+}
+
 @end

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "appium-webdriveragent",
-  "version": "4.1.7",
+  "version": "4.3.1",
   "description": "Package bundling WebDriverAgent",
   "main": "build/index.js",
   "scripts": {