appium-webdriveragent 4.1.5 → 4.2.0

package/PrivateHeaders/XCTest/XCTestManager_ManagerInterface-Protocol.h

@@ -42,8 +42,10 @@
 - (void)_XCT_exchangeProtocolVersion:(unsigned long long)arg1 reply:(void (^)(unsigned long long))arg2;
 
 // Available since Xcode9
-- (void)_XCT_requestScreenshotOfScreenWithID:(unsigned int)arg1 withRect:(struct CGRect)arg2 uti:(NSString *)arg3 compressionQuality:(double)arg4 withReply:(void (^)(NSData *, NSError *))arg5;
-- (void)_XCT_requestScreenshotOfScreenWithID:(unsigned int)arg1 withRect:(struct CGRect)arg2 withReply:(void (^)(NSData *, NSError *))arg3;
+// The first screenID type changed from "unsigned int" to "long long" since Xcode 13.3 in XCTAutomationSupport.framework/XCTScreenshotRequest.h
+// but this place is still "unsigned int" in the header. Appium/WDA changes to "long long" for Xcode 13.3 x iOS 15.4 environment.
+- (void)_XCT_requestScreenshotOfScreenWithID:(long long)arg1 withRect:(struct CGRect)arg2 uti:(NSString *)arg3 compressionQuality:(double)arg4 withReply:(void (^)(NSData *, NSError *))arg5;
+- (void)_XCT_requestScreenshotOfScreenWithID:(long long)arg1 withRect:(struct CGRect)arg2 withReply:(void (^)(NSData *, NSError *))arg3;
 - (void)_XCT_requestSnapshotForElement:(XCAccessibilityElement *)arg1 attributes:(NSArray *)arg2 parameters:(NSDictionary *)arg3 reply:(void (^)(XCElementSnapshot *, NSError *))arg4;
 
 // Available since Xcode 12.5. Required (!!!) to use since Xcode 13

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/PrivateHeaders/XCTest/XCUIScreen.h

@@ -7,10 +7,10 @@
 @interface XCUIScreen()
 {
   _Bool _isMainScreen;
-  int _displayID;
+  long long _displayID;
 }
 @property(readonly) _Bool isMainScreen; // @synthesize isMainScreen=_isMainScreen;
-@property(readonly) int displayID; // @synthesize displayID=_displayID;
+@property(readonly) long long displayID; // @synthesize displayID=_displayID;
 
 - (id)_clippedScreenshotData:(id)arg1 quality:(long long)arg2 rect:(struct CGRect)arg3 scale:(double)arg4;
 - (id)_screenshotDataForQuality:(long long)arg1 rect:(struct CGRect)arg2 error:(id *)arg3;
@@ -20,7 +20,8 @@
 - (id)screenshot;
 - (id)_imageFromData:(id)arg1;
 - (double)scale;
-- (id)initWithDisplayID:(int)arg1 isMainScreen:(_Bool)arg2;
+
+- (id)initWithDisplayID:(long long)arg1 isMainScreen:(_Bool)arg2 device:(id)arg3 screenDataSource:(id)arg4;
 
 @end
 

package/README.md

@@ -51,4 +51,3 @@ projects has been integrated directly in the WebDriverAgent source tree.
 You can find the source files and their licenses in the `WebDriverAgentLib/Vendor` directory.
 
 Have fun!
-

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,15 @@ 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;
+
 @end
 
 NS_ASSUME_NONNULL_END

package/WebDriverAgentLib/Categories/XCUIDevice+FBHelpers.m

@@ -309,4 +309,21 @@ 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];
+}
+
 @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

package/WebDriverAgentLib/Utilities/FBMjpegServer.m

@@ -33,7 +33,7 @@ static const char *QUEUE_NAME = "JPEG Screenshots Provider Queue";
 @property (nonatomic, readonly) NSMutableArray<GCDAsyncSocket *> *listeningClients;
 @property (nonatomic, readonly) mach_timebase_info_data_t timebaseInfo;
 @property (nonatomic, readonly) FBImageIOScaler *imageScaler;
-@property (nonatomic, readonly) unsigned int mainScreenID;
+@property (nonatomic, readonly) long long mainScreenID;
 
 @end
 

package/WebDriverAgentLib/Utilities/FBScreenshot.h

@@ -51,7 +51,7 @@ NS_ASSUME_NONNULL_BEGIN
  @param error If there is an error, upon return contains an NSError object that describes the problem.
  @return Device screenshot as PNG- or JPG-encoded data or nil in case of failure
  */
-+ (nullable NSData *)takeInOriginalResolutionWithScreenID:(unsigned int)screenID
++ (nullable NSData *)takeInOriginalResolutionWithScreenID:(long long)screenID
                                        compressionQuality:(CGFloat)compressionQuality
                                                       uti:(NSString *)uti
                                                   timeout:(NSTimeInterval)timeout

package/WebDriverAgentLib/Utilities/FBScreenshot.m

@@ -123,7 +123,7 @@ NSString *formatTimeInterval(NSTimeInterval interval) {
   return screenshotData;
 }
 
-+ (NSData *)takeWithScreenID:(unsigned int)screenID
++ (NSData *)takeWithScreenID:(long long)screenID
                        scale:(CGFloat)scale
           compressionQuality:(CGFloat)compressionQuality
                         rect:(CGRect)rect
@@ -146,7 +146,7 @@ NSString *formatTimeInterval(NSTimeInterval interval) {
                                                         error:error];
 }
 
-+ (NSData *)takeInOriginalResolutionWithScreenID:(unsigned int)screenID
++ (NSData *)takeInOriginalResolutionWithScreenID:(long long)screenID
                               compressionQuality:(CGFloat)compressionQuality
                                              uti:(NSString *)uti
                                          timeout:(NSTimeInterval)timeout
@@ -254,7 +254,7 @@ NSString *formatTimeInterval(NSTimeInterval interval) {
   return imageEncoding;
 }
 
-+ (nullable id)screenshotRequestWithScreenID:(unsigned int)screenID
++ (nullable id)screenshotRequestWithScreenID:(long long)screenID
                                         rect:(struct CGRect)rect
                                          uti:(NSString *)uti
                           compressionQuality:(CGFloat)compressionQuality

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.5",
+  "version": "4.2.0",
   "description": "Package bundling WebDriverAgent",
   "main": "build/index.js",
   "scripts": {