appium-webdriveragent 5.3.1 → 5.4.0

package/CHANGELOG.md

@@ -1,3 +1,29 @@
+## [5.4.0](https://github.com/appium/WebDriverAgent/compare/v5.3.3...v5.4.0) (2023-06-09)
+
+
+### Features
+
+* Drop older screenshoting APIs ([#721](https://github.com/appium/WebDriverAgent/issues/721)) ([4a08d7a](https://github.com/appium/WebDriverAgent/commit/4a08d7a843af6b93b378b4e3dc10f123d2e56359))
+
+
+### Bug Fixes
+
+* Streamline errors handling for async block calls ([#725](https://github.com/appium/WebDriverAgent/issues/725)) ([364b779](https://github.com/appium/WebDriverAgent/commit/364b7791393ffae9c048c5cac023e3e7d1813a14))
+
+## [5.3.3](https://github.com/appium/WebDriverAgent/compare/v5.3.2...v5.3.3) (2023-06-08)
+
+
+### Miscellaneous Chores
+
+* Disable automatic screen recording by default ([#726](https://github.com/appium/WebDriverAgent/issues/726)) ([a070223](https://github.com/appium/WebDriverAgent/commit/a070223e0ef43be8dd54d16ee3e3b96603ad5f3a))
+
+## [5.3.2](https://github.com/appium/WebDriverAgent/compare/v5.3.1...v5.3.2) (2023-06-07)
+
+
+### Miscellaneous Chores
+
+* **deps-dev:** bump conventional-changelog-conventionalcommits ([#723](https://github.com/appium/WebDriverAgent/issues/723)) ([b22f61e](https://github.com/appium/WebDriverAgent/commit/b22f61eda142ee6ec1db8c74a4788e0270ac7740))
+
 ## [5.3.1](https://github.com/appium/WebDriverAgent/compare/v5.3.0...v5.3.1) (2023-06-06)
 
 

package/WebDriverAgentLib/Utilities/FBConfiguration.h

@@ -49,10 +49,14 @@ extern NSString *const FBSnapshotMaxDepthKey;
 
 /*! Disables XCTest automated screenshots taking */
 + (void)disableScreenshots;
-
 /*! Enables XCTest automated screenshots taking */
 + (void)enableScreenshots;
 
+/*! Disables XCTest automated videos taking (iOS 17+) */
++ (void)disableScreenRecordings;
+/*! Enables XCTest automated videos taking  (iOS 17+) */
++ (void)enableScreenRecordings;
+
 /* The maximum typing frequency for all typing activities */
 + (void)setMaxTypingFrequency:(NSUInteger)value;
 + (NSUInteger)maxTypingFrequency;
@@ -89,9 +93,9 @@ extern NSString *const FBSnapshotMaxDepthKey;
 + (void)setMjpegServerFramerate:(NSUInteger)framerate;
 
 /**
- The quality of phone display screenshots. The higher quality you set is the bigger screenshot size is.
- The highest quality value is 0 (lossless PNG). The lowest quality is 2 (highly compressed JPEG).
- The default quality value is 1 (high quality JPEG).
+ The quality of  display screenshots. The higher quality you set is the bigger screenshot size is.
+ The highest quality value is 0 (lossless PNG) or 3 (lossless HEIC). The lowest quality is 2 (highly compressed JPEG).
+ The default quality value is 3 (lossless HEIC).
  See https://developer.apple.com/documentation/xctest/xctimagequality?language=objc
  */
 + (NSUInteger)screenshotQuality;

package/WebDriverAgentLib/Utilities/FBConfiguration.m

@@ -94,6 +94,16 @@ static UIInterfaceOrientation FBScreenshotOrientation;
   [[NSUserDefaults standardUserDefaults] setBool:NO forKey:@"DisableScreenshots"];
 }
 
++ (void)disableScreenRecordings
+{
+  [[NSUserDefaults standardUserDefaults] setBool:YES forKey:@"DisableDiagnosticScreenRecordings"];
+}
+
++ (void)enableScreenRecordings
+{
+  [[NSUserDefaults standardUserDefaults] setBool:NO forKey:@"DisableDiagnosticScreenRecordings"];
+}
+
 + (NSRange)bindingPortRange
 {
   // 'WebDriverAgent --port 8080' can be passed via the arguments to the process
@@ -443,7 +453,7 @@ static UIInterfaceOrientation FBScreenshotOrientation;
   FBShouldUseCompactResponses = YES;
   FBElementResponseAttributes = @"type,label";
   FBMaxTypingFrequency = 60;
-  FBScreenshotQuality = 1;
+  FBScreenshotQuality = 3;
   FBCustomSnapshotTimeout = 15.;
   FBShouldUseFirstMatch = NO;
   FBShouldBoundElementsByIndex = NO;

package/WebDriverAgentLib/Utilities/FBImageIOScaler.h

@@ -10,6 +10,8 @@
 #import <Foundation/Foundation.h>
 #import <CoreGraphics/CoreGraphics.h>
 
+@class UTType;
+
 NS_ASSUME_NONNULL_BEGIN
 
 // Those values define the allowed ranges for the scaling factor and compression quality settings
@@ -25,14 +27,12 @@ extern const CGFloat FBMaxCompressionQuality;
  queue it will be replaced with the new one
 
  @param image The image to scale down
- @param uti Either kUTTypePNG or kUTTypeJPEG
  @param completionHandler called after successfully scaling down an image
  @param scalingFactor the scaling factor in range 0.01..1.0. A value of 1.0 won't perform scaling at all
  @param compressionQuality the compression quality in range 0.0..1.0 (0.0 for max. compression and 1.0 for lossless compression)
- Only applicable for kUTTypeJPEG
+ Only applicable for UTTypeJPEG
  */
 - (void)submitImage:(NSData *)image
-                uti:(NSString *)uti
       scalingFactor:(CGFloat)scalingFactor
  compressionQuality:(CGFloat)compressionQuality
   completionHandler:(void (^)(NSData *))completionHandler;
@@ -41,7 +41,7 @@ extern const CGFloat FBMaxCompressionQuality;
  Scales and crops the source image
 
  @param image The source image data
- @param uti Either kUTTypePNG or kUTTypeJPEG
+ @param uti Either UTTypePNG or UTTypeJPEG
  @param rect The cropping rectange for the screenshot. The value is expected to be non-scaled one
             since it happens after scaling/orientation change.
             CGRectNull could be used to take a screenshot of the full screen.
@@ -52,7 +52,7 @@ extern const CGFloat FBMaxCompressionQuality;
  @returns Processed image data compressed according to the given UTI or nil in case of a failure
  */
 - (nullable NSData *)scaledImageWithImage:(NSData *)image
-                                      uti:(NSString *)uti
+                                      uti:(UTType *)uti
                                      rect:(CGRect)rect
                             scalingFactor:(CGFloat)scalingFactor
                        compressionQuality:(CGFloat)compressionQuality

package/WebDriverAgentLib/Utilities/FBImageIOScaler.m

@@ -11,7 +11,7 @@
 
 #import <ImageIO/ImageIO.h>
 #import <UIKit/UIKit.h>
-#import <MobileCoreServices/MobileCoreServices.h>
+@import UniformTypeIdentifiers;
 
 #import "FBConfiguration.h"
 #import "FBErrorBuilder.h"
@@ -43,7 +43,6 @@ const CGFloat FBMaxCompressionQuality = 1.0f;
 }
 
 - (void)submitImage:(NSData *)image
-                uti:(NSString *)uti
       scalingFactor:(CGFloat)scalingFactor
  compressionQuality:(CGFloat)compressionQuality
   completionHandler:(void (^)(NSData *))completionHandler
@@ -118,7 +117,7 @@ const CGFloat FBMaxCompressionQuality = 1.0f;
 }
 
 - (nullable NSData *)scaledImageWithImage:(NSData *)image
-                                      uti:(NSString *)uti
+                                      uti:(UTType *)uti
                                      rect:(CGRect)rect
                             scalingFactor:(CGFloat)scalingFactor
                        compressionQuality:(CGFloat)compressionQuality
@@ -154,7 +153,7 @@ const CGFloat FBMaxCompressionQuality = 1.0f;
     UIGraphicsEndImageContext();
   }
 
-  return [uti isEqualToString:(__bridge id)kUTTypePNG]
+  return [uti conformsToType:UTTypePNG]
     ? UIImagePNGRepresentation(resultImage)
     : UIImageJPEGRepresentation(resultImage, compressionQuality);
 }
@@ -163,7 +162,11 @@ const CGFloat FBMaxCompressionQuality = 1.0f;
                     compressionQuality:(CGFloat)compressionQuality
 {
   NSMutableData *newImageData = [NSMutableData data];
-  CGImageDestinationRef imageDestination = CGImageDestinationCreateWithData((CFMutableDataRef)newImageData, kUTTypeJPEG, 1, NULL);
+  CGImageDestinationRef imageDestination = CGImageDestinationCreateWithData(
+                                                                            (__bridge CFMutableDataRef) newImageData,
+                                                                            (__bridge CFStringRef) UTTypeJPEG.identifier,
+                                                                            1,
+                                                                            NULL);
   CFDictionaryRef compressionOptions = (__bridge CFDictionaryRef)@{
     (const NSString *)kCGImageDestinationLossyCompressionQuality: @(compressionQuality)
   };

package/WebDriverAgentLib/Utilities/FBMjpegServer.m

@@ -10,7 +10,7 @@
 #import "FBMjpegServer.h"
 
 #import <mach/mach_time.h>
-#import <MobileCoreServices/MobileCoreServices.h>
+@import UniformTypeIdentifiers;
 
 #import "GCDAsyncSocket.h"
 #import "FBApplication.h"
@@ -72,11 +72,6 @@ static const char *QUEUE_NAME = "JPEG Screenshots Provider Queue";
 
 - (void)streamScreenshot
 {
-  if (![self.class canStreamScreenshots]) {
-    [FBLogger log:@"MJPEG server cannot start because the current iOS version is not supported"];
-    return;
-  }
-
   NSUInteger framerate = FBConfiguration.mjpegServerFramerate;
   uint64_t timerInterval = (uint64_t)(1.0 / ((0 == framerate || framerate > MAX_FPS) ? MAX_FPS : framerate) * NSEC_PER_SEC);
   uint64_t timeStarted = clock_gettime_nsec_np(CLOCK_MONOTONIC_RAW);
@@ -96,7 +91,7 @@ static const char *QUEUE_NAME = "JPEG Screenshots Provider Queue";
   NSError *error;
   NSData *screenshotData = [FBScreenshot takeInOriginalResolutionWithScreenID:self.mainScreenID
                                                            compressionQuality:screenshotCompressionQuality
-                                                                          uti:(__bridge id)kUTTypeJPEG
+                                                                          uti:UTTypeJPEG
                                                                       timeout:FRAME_TIMEOUT
                                                                         error:&error];
   if (nil == screenshotData) {
@@ -107,7 +102,6 @@ static const char *QUEUE_NAME = "JPEG Screenshots Provider Queue";
 
   if (usesScaling) {
     [self.imageScaler submitImage:screenshotData
-                              uti:(__bridge id)kUTTypeJPEG
                     scalingFactor:scalingFactor
                compressionQuality:compressionQuality
                 completionHandler:^(NSData * _Nonnull scaled) {
@@ -132,11 +126,6 @@ static const char *QUEUE_NAME = "JPEG Screenshots Provider Queue";
   }
 }
 
-+ (BOOL)canStreamScreenshots
-{
-  return [FBScreenshot isNewScreenshotAPISupported];
-}
-
 - (void)didClientConnect:(GCDAsyncSocket *)newClient
 {
   [FBLogger logFmt:@"Got screenshots broadcast client connection at %@:%d", newClient.connectedHost, newClient.connectedPort];

package/WebDriverAgentLib/Utilities/FBScreenshot.h

@@ -8,22 +8,18 @@
  */
 
 #import <XCTest/XCTest.h>
+@class UTType;
 
 NS_ASSUME_NONNULL_BEGIN
 
 @interface FBScreenshot : NSObject
 
-/**
- Returns YES if the current OS SDK supports advanced screenshoting APIs (added since Xcode SDK 10)
- */
-+ (BOOL)isNewScreenshotAPISupported;
-
 /**
  Retrieves non-scaled screenshot of the whole screen
 
- @param quality The number in range 0-2, where 2 (JPG) is the lowest and 0 (PNG) is the highest quality.
+ @param quality The number in range 0-3, where 0 is PNG (lossless), 3 is HEIC (lossless), 1- low quality JPEG and 2 - high quality JPEG
  @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
+ @return Device screenshot as PNG-encoded data or nil in case of failure
  */
 + (nullable NSData *)takeInOriginalResolutionWithQuality:(NSUInteger)quality
                                                    error:(NSError **)error;
@@ -31,11 +27,11 @@ NS_ASSUME_NONNULL_BEGIN
 /**
  Retrieves non-scaled screenshot of the particular screen rectangle
 
- @param quality The number in range 0-2, where 2 (JPG) is the lowest and 0 (PNG) is the highest quality.
+ @param quality The number in range 0-3, where 0 is PNG (lossless), 3 is HEIC (lossless), 1- low quality JPEG and 2 - high quality JPEG
  @param rect The bounding rectange for the screenshot. The value is expected be non-scaled one.
              CGRectNull could be used to take a screenshot of the full screen.
  @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
+ @return Device screenshot as PNG-encoded data or nil in case of failure
  */
 + (nullable NSData *)takeInOriginalResolutionWithQuality:(NSUInteger)quality
                                                     rect:(CGRect)rect
@@ -46,14 +42,14 @@ NS_ASSUME_NONNULL_BEGIN
 
  @param screenID The screen identifier to take the screenshot from
  @param compressionQuality Normalized screenshot quality value in range 0..1, where 1 is the best quality
- @param uti kUTType... constant, which defines the type of the returned screenshot image
+ @param uti UTType... constant, which defines the type of the returned screenshot image
  @param timeout how much time to allow for the screenshot to be taken
  @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
+ @return Device screenshot as PNG-, HEIC- or JPG-encoded data or nil in case of failure
  */
 + (nullable NSData *)takeInOriginalResolutionWithScreenID:(long long)screenID
                                        compressionQuality:(CGFloat)compressionQuality
-                                                      uti:(NSString *)uti
+                                                      uti:(UTType *)uti
                                                   timeout:(NSTimeInterval)timeout
                                                     error:(NSError **)error;
 

package/WebDriverAgentLib/Utilities/FBScreenshot.m

@@ -9,7 +9,7 @@
 
 #import "FBScreenshot.h"
 
-#import <MobileCoreServices/MobileCoreServices.h>
+@import UniformTypeIdentifiers;
 
 #import "FBConfiguration.h"
 #import "FBErrorBuilder.h"
@@ -33,16 +33,6 @@ NSString *formatTimeInterval(NSTimeInterval interval) {
 
 @implementation FBScreenshot
 
-+ (BOOL)isNewScreenshotAPISupported
-{
-  static dispatch_once_t newScreenshotAPISupported;
-  static BOOL result;
-  dispatch_once(&newScreenshotAPISupported, ^{
-    result = [(NSObject *)[FBXCTestDaemonsProxy testRunnerProxy] respondsToSelector:@selector(_XCT_requestScreenshotOfScreenWithID:withRect:uti:compressionQuality:withReply:)];
-  });
-  return result;
-}
-
 + (CGFloat)compressionQualityWithQuality:(NSUInteger)quality
 {
   switch (quality) {
@@ -55,14 +45,16 @@ NSString *formatTimeInterval(NSTimeInterval interval) {
   }
 }
 
-+ (NSString *)imageUtiWithQuality:(NSUInteger)quality
++ (UTType *)imageUtiWithQuality:(NSUInteger)quality
 {
   switch (quality) {
     case 1:
     case 2:
-      return (__bridge id)kUTTypeJPEG;
+      return UTTypeJPEG;
+    case 3:
+      return UTTypeHEIC;
     default:
-      return (__bridge id)kUTTypePNG;
+      return UTTypePNG;
   }
 }
 
@@ -70,64 +62,28 @@ NSString *formatTimeInterval(NSTimeInterval interval) {
                                            rect:(CGRect)rect
                                           error:(NSError **)error
 {
-  if ([self.class isNewScreenshotAPISupported]) {
-    XCUIScreen *mainScreen = XCUIScreen.mainScreen;
-    return [self.class takeWithScreenID:mainScreen.displayID
-                                  scale:SCREENSHOT_SCALE
-                     compressionQuality:[self.class compressionQualityWithQuality:FBConfiguration.screenshotQuality]
-                                   rect:rect
-                              sourceUTI:[self.class imageUtiWithQuality:FBConfiguration.screenshotQuality]
-                                  error:error];
-  }
-
-  [[[FBErrorBuilder builder]
-         withDescription:@"Screenshots of limited areas are only available for newer OS versions"]
-        buildError:error];
-  return nil;
+  XCUIScreen *mainScreen = XCUIScreen.mainScreen;
+  return [self.class takeWithScreenID:mainScreen.displayID
+                                scale:SCREENSHOT_SCALE
+                   compressionQuality:[self.class compressionQualityWithQuality:quality]
+                                 rect:rect
+                            sourceUTI:[self.class imageUtiWithQuality:quality]
+                                error:error];
 }
 
 + (NSData *)takeInOriginalResolutionWithQuality:(NSUInteger)quality
                                           error:(NSError **)error
 {
-  if ([self.class isNewScreenshotAPISupported]) {
-    XCUIScreen *mainScreen = XCUIScreen.mainScreen;
-    return [self.class takeWithScreenID:mainScreen.displayID
-                                  scale:SCREENSHOT_SCALE
-                     compressionQuality:[self.class compressionQualityWithQuality:FBConfiguration.screenshotQuality]
-                                   rect:CGRectNull
-                              sourceUTI:[self.class imageUtiWithQuality:FBConfiguration.screenshotQuality]
-                                  error:error];
-  }
-
-  id<XCTestManager_ManagerInterface> proxy = [FBXCTestDaemonsProxy testRunnerProxy];
-  __block NSData *screenshotData = nil;
-  __block NSError *innerError = nil;
-  dispatch_semaphore_t sem = dispatch_semaphore_create(0);
-  [proxy _XCT_requestScreenshotWithReply:^(NSData *data, NSError *screenshotError) {
-    if (nil == screenshotError) {
-      screenshotData = data;
-    } else {
-      innerError = screenshotError;
-    }
-    dispatch_semaphore_signal(sem);
-  }];
-  if (nil != innerError && error) {
-    *error = innerError;
-  }
-  int64_t timeoutNs = (int64_t)(SCREENSHOT_TIMEOUT * NSEC_PER_SEC);
-  if (0 != dispatch_semaphore_wait(sem, dispatch_time(DISPATCH_TIME_NOW, timeoutNs))) {
-    [[[FBErrorBuilder builder]
-      withDescription:[NSString stringWithFormat:@"Cannot take a screenshot within %@ timeout", formatTimeInterval(SCREENSHOT_TIMEOUT)]]
-     buildError:error];
-  };
-  return screenshotData;
+  return [self.class takeInOriginalResolutionWithQuality:quality
+                                                    rect:CGRectNull
+                                                   error:error];
 }
 
 + (NSData *)takeWithScreenID:(long long)screenID
                        scale:(CGFloat)scale
           compressionQuality:(CGFloat)compressionQuality
                         rect:(CGRect)rect
-                   sourceUTI:(NSString *)uti
+                   sourceUTI:(UTType *)uti
                        error:(NSError **)error
 {
   NSData *screenshotData = [self.class takeInOriginalResolutionWithScreenID:screenID
@@ -139,7 +95,7 @@ NSString *formatTimeInterval(NSTimeInterval interval) {
     return nil;
   }
   return [[[FBImageIOScaler alloc] init] scaledImageWithImage:screenshotData
-                                                          uti:(__bridge id)kUTTypePNG
+                                                          uti:UTTypePNG
                                                          rect:rect
                                                 scalingFactor:1.0 / scale
                                            compressionQuality:FBMaxCompressionQuality
@@ -148,7 +104,7 @@ NSString *formatTimeInterval(NSTimeInterval interval) {
 
 + (NSData *)takeInOriginalResolutionWithScreenID:(long long)screenID
                               compressionQuality:(CGFloat)compressionQuality
-                                             uti:(NSString *)uti
+                                             uti:(UTType *)uti
                                          timeout:(NSTimeInterval)timeout
                                            error:(NSError **)error
 {
@@ -156,38 +112,23 @@ NSString *formatTimeInterval(NSTimeInterval interval) {
   __block NSData *screenshotData = nil;
   __block NSError *innerError = nil;
   dispatch_semaphore_t sem = dispatch_semaphore_create(0);
-  if ([self.class shouldUseScreenshotRequestApiForProxy:(NSObject *)proxy]) {
-    id screnshotRequest = [self.class screenshotRequestWithScreenID:screenID
-                                                               rect:CGRectNull
-                                                                uti:uti
-                                                 compressionQuality:compressionQuality
-                                                              error:error];
-    if (nil == screnshotRequest) {
-      return nil;
-    }
-    [proxy _XCT_requestScreenshot:screnshotRequest
-                        withReply:^(id image, NSError *err) {
-      if (nil != err) {
-        innerError = err;
-      } else {
-        screenshotData = [image data];
-      }
-      dispatch_semaphore_signal(sem);
-    }];
-  } else {
-    [proxy _XCT_requestScreenshotOfScreenWithID:screenID
-                                       withRect:CGRectNull
-                                            uti:uti
-                             compressionQuality:compressionQuality
-                                      withReply:^(NSData *data, NSError *err) {
-      if (nil != err) {
-        innerError = err;
-      } else {
-        screenshotData = data;
-      }
-      dispatch_semaphore_signal(sem);
-    }];
+  id screnshotRequest = [self.class screenshotRequestWithScreenID:screenID
+                                                             rect:CGRectNull
+                                                              uti:uti
+                                               compressionQuality:compressionQuality
+                                                            error:error];
+  if (nil == screnshotRequest) {
+    return nil;
   }
+  [proxy _XCT_requestScreenshot:screnshotRequest
+                      withReply:^(id image, NSError *err) {
+    if (nil != err) {
+      innerError = err;
+    } else {
+      screenshotData = [image data];
+    }
+    dispatch_semaphore_signal(sem);
+  }];
   int64_t timeoutNs = (int64_t)(timeout * NSEC_PER_SEC);
   if (0 != dispatch_semaphore_wait(sem, dispatch_time(DISPATCH_TIME_NOW, timeoutNs))) {
     NSString *timeoutMsg = [NSString stringWithFormat:@"Cannot take a screenshot within %@ timeout", formatTimeInterval(SCREENSHOT_TIMEOUT)];
@@ -205,26 +146,7 @@ NSString *formatTimeInterval(NSTimeInterval interval) {
   return screenshotData;
 }
 
-+ (BOOL)shouldUseScreenshotRequestApiForProxy:(NSObject *)proxy
-{
-  static dispatch_once_t shouldUseSRApi;
-  static BOOL result;
-  dispatch_once(&shouldUseSRApi, ^{
-    if ([proxy respondsToSelector:@selector(_XCT_requestScreenshot:withReply:)]) {
-#if TARGET_OS_SIMULATOR
-      // 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
-    } else {
-      result = NO;
-    }
-  });
-  return result;
-}
-
-+ (nullable id)imageEncodingWithUniformTypeIdentifier:(NSString *)uti
++ (nullable id)imageEncodingWithUniformTypeIdentifier:(UTType *)uti
                                    compressionQuality:(CGFloat)compressionQuality
                                                 error:(NSError **)error
 {
@@ -235,6 +157,26 @@ NSString *formatTimeInterval(NSTimeInterval interval) {
      buildError:error];
     return nil;
   }
+
+  if ([uti conformsToType:UTTypeHEIC]) {
+    static BOOL isHeicSuppported = NO;
+    static dispatch_once_t onceToken;
+    dispatch_once(&onceToken, ^{
+      SEL selector = NSSelectorFromString(@"supportsHEICImageEncoding");
+      NSMethodSignature *signature = [imageEncodingClass methodSignatureForSelector:selector];
+      if (nil != signature) {
+        NSInvocation *invocation = [NSInvocation invocationWithMethodSignature:signature];
+        [invocation setSelector:selector];
+        [invocation invokeWithTarget:imageEncodingClass];
+        [invocation getReturnValue:&isHeicSuppported];
+      }
+    });
+    if (!isHeicSuppported) {
+      [FBLogger logFmt:@"The device under test does not support HEIC image encoding. Falling back to PNG"];
+      uti = UTTypePNG;
+    }
+  }
+
   id imageEncodingAllocated = [imageEncodingClass alloc];
   SEL imageEncodingConstructorSelector = NSSelectorFromString(@"initWithUniformTypeIdentifier:compressionQuality:");
   if (![imageEncodingAllocated respondsToSelector:imageEncodingConstructorSelector]) {
@@ -246,7 +188,8 @@ NSString *formatTimeInterval(NSTimeInterval interval) {
   NSMethodSignature *imageEncodingContructorSignature = [imageEncodingAllocated methodSignatureForSelector:imageEncodingConstructorSelector];
   NSInvocation *imageEncodingInitInvocation = [NSInvocation invocationWithMethodSignature:imageEncodingContructorSignature];
   [imageEncodingInitInvocation setSelector:imageEncodingConstructorSelector];
-  [imageEncodingInitInvocation setArgument:&uti atIndex:2];
+  NSString *utiIdentifier = uti.identifier;
+  [imageEncodingInitInvocation setArgument:&utiIdentifier atIndex:2];
   [imageEncodingInitInvocation setArgument:&compressionQuality atIndex:3];
   [imageEncodingInitInvocation invokeWithTarget:imageEncodingAllocated];
   id __unsafe_unretained imageEncoding;
@@ -256,11 +199,10 @@ NSString *formatTimeInterval(NSTimeInterval interval) {
 
 + (nullable id)screenshotRequestWithScreenID:(long long)screenID
                                         rect:(struct CGRect)rect
-                                         uti:(NSString *)uti
+                                         uti:(UTType *)uti
                           compressionQuality:(CGFloat)compressionQuality
                                        error:(NSError **)error
 {
-  // TODO: Use native accessors after we drop the support of Xcode 12.4 and below
   id imageEncoding = [self.class imageEncodingWithUniformTypeIdentifier:uti
                                                      compressionQuality:compressionQuality
                                                                   error:error];

package/WebDriverAgentLib/Utilities/FBUnattachedAppLauncher.m

@@ -8,6 +8,9 @@
  */
 
 #import "FBUnattachedAppLauncher.h"
+
+#import <MobileCoreServices/MobileCoreServices.h>
+
 #import "LSApplicationWorkspace.h"
 
 @implementation FBUnattachedAppLauncher

package/WebDriverAgentLib/Utilities/FBXCTestDaemonsProxy.m

@@ -100,13 +100,12 @@ static void swizzledLaunchApp(id self, SEL _cmd, NSString *path, NSString *bundl
 
 + (BOOL)synthesizeEventWithRecord:(XCSynthesizedEventRecord *)record error:(NSError *__autoreleasing*)error
 {
-  __block BOOL didSucceed = NO;
+  __block NSError *innerError = nil;
   [FBRunLoopSpinner spinUntilCompletion:^(void(^completion)(void)){
     void (^errorHandler)(NSError *) = ^(NSError *invokeError) {
-      if (error) {
-        *error = invokeError;
+      if (nil != invokeError) {
+        innerError = invokeError;
       }
-      didSucceed = (invokeError == nil);
       completion();
     };
 
@@ -117,31 +116,40 @@ static void swizzledLaunchApp(id self, SEL _cmd, NSString *path, NSString *bundl
       handlerBlock(record, invokeError);
     }];
   }];
-  return didSucceed;
+  if (nil != innerError) {
+    if (error) {
+      *error = innerError;
+    }
+    return NO;
+  }
+  return YES;
 }
 
 + (BOOL)openURL:(NSURL *)url usingApplication:(NSString *)bundleId error:(NSError *__autoreleasing*)error
 {
   XCTRunnerDaemonSession *session = [XCTRunnerDaemonSession sharedSession];
   if (![session respondsToSelector:@selector(openURL:usingApplication:completion:)]) {
-    if (error) {
-      [[[FBErrorBuilder builder]
-        withDescriptionFormat:@"The current Xcode SDK does not support opening of URLs with given application"]
-       buildError:error];
-    }
+    [[[FBErrorBuilder builder]
+      withDescriptionFormat:@"The current Xcode SDK does not support opening of URLs with given application"]
+     buildError:error];
     return NO;
   }
 
+  __block NSError *innerError = nil;
   __block BOOL didSucceed = NO;
   [FBRunLoopSpinner spinUntilCompletion:^(void(^completion)(void)){
     [session openURL:url usingApplication:bundleId completion:^(bool result, NSError *invokeError) {
-      if (error) {
-        *error = invokeError;
+      if (nil != invokeError) {
+        innerError = invokeError;
+      } else {
+        didSucceed = result;
       }
-      didSucceed = invokeError == nil && result;
       completion();
     }];
   }];
+  if (nil != innerError && error) {
+    *error = innerError;
+  }
   return didSucceed;
 }
 
@@ -149,24 +157,27 @@ static void swizzledLaunchApp(id self, SEL _cmd, NSString *path, NSString *bundl
 {
   XCTRunnerDaemonSession *session = [XCTRunnerDaemonSession sharedSession];
   if (![session respondsToSelector:@selector(openDefaultApplicationForURL:completion:)]) {
-    if (error) {
-      [[[FBErrorBuilder builder]
-        withDescriptionFormat:@"The current Xcode SDK does not support opening of URLs. Consider upgrading to Xcode 14.3+/iOS 16.4+"]
-       buildError:error];
-    }
+    [[[FBErrorBuilder builder]
+      withDescriptionFormat:@"The current Xcode SDK does not support opening of URLs. Consider upgrading to Xcode 14.3+/iOS 16.4+"]
+     buildError:error];
     return NO;
   }
 
+  __block NSError *innerError = nil;
   __block BOOL didSucceed = NO;
   [FBRunLoopSpinner spinUntilCompletion:^(void(^completion)(void)){
     [session openDefaultApplicationForURL:url completion:^(bool result, NSError *invokeError) {
-      if (error) {
-        *error = invokeError;
+      if (nil != invokeError) {
+        innerError = invokeError;
+      } else {
+        didSucceed = result;
       }
-      didSucceed = invokeError == nil && result;
       completion();
     }];
   }];
+  if (nil != innerError && error) {
+    *error = innerError;
+  }
   return didSucceed;
 }
 
@@ -175,32 +186,33 @@ static void swizzledLaunchApp(id self, SEL _cmd, NSString *path, NSString *bundl
 {
   XCTRunnerDaemonSession *session = [XCTRunnerDaemonSession sharedSession];
   if (![session respondsToSelector:@selector(setSimulatedLocation:completion:)]) {
-    if (error) {
-      [[[FBErrorBuilder builder]
-        withDescriptionFormat:@"The current Xcode SDK does not support location simulation. Consider upgrading to Xcode 14.3+/iOS 16.4+"]
-       buildError:error];
-    }
+    [[[FBErrorBuilder builder]
+      withDescriptionFormat:@"The current Xcode SDK does not support location simulation. Consider upgrading to Xcode 14.3+/iOS 16.4+"]
+     buildError:error];
     return NO;
   }
   if (![session supportsLocationSimulation]) {
-    if (error) {
-      [[[FBErrorBuilder builder]
-        withDescriptionFormat:@"Your device does not support location simulation"]
-       buildError:error];
-    }
+    [[[FBErrorBuilder builder]
+      withDescriptionFormat:@"Your device does not support location simulation"]
+     buildError:error];
     return NO;
   }
 
+  __block NSError *innerError = nil;
   __block BOOL didSucceed = NO;
   [FBRunLoopSpinner spinUntilCompletion:^(void(^completion)(void)){
     [session setSimulatedLocation:location completion:^(bool result, NSError *invokeError) {
-      if (error) {
-        *error = invokeError;
+      if (nil != invokeError) {
+        innerError = invokeError;
+      } else {
+        didSucceed = result;
       }
-      didSucceed = invokeError == nil && result;
       completion();
     }];
   }];
+  if (nil != innerError && error) {
+    *error = innerError;
+  }
   return didSucceed;
 }
 
@@ -208,34 +220,33 @@ static void swizzledLaunchApp(id self, SEL _cmd, NSString *path, NSString *bundl
 {
   XCTRunnerDaemonSession *session = [XCTRunnerDaemonSession sharedSession];
   if (![session respondsToSelector:@selector(getSimulatedLocationWithReply:)]) {
-    if (error) {
-      [[[FBErrorBuilder builder]
-        withDescriptionFormat:@"The current Xcode SDK does not support location simulation. Consider upgrading to Xcode 14.3+/iOS 16.4+"]
-       buildError:error];
-    }
+    [[[FBErrorBuilder builder]
+      withDescriptionFormat:@"The current Xcode SDK does not support location simulation. Consider upgrading to Xcode 14.3+/iOS 16.4+"]
+     buildError:error];
     return nil;
   }
   if (![session supportsLocationSimulation]) {
-    if (error) {
-      [[[FBErrorBuilder builder]
-        withDescriptionFormat:@"Your device does not support location simulation"]
-       buildError:error];
-    }
+    [[[FBErrorBuilder builder]
+      withDescriptionFormat:@"Your device does not support location simulation"]
+     buildError:error];
     return nil;
   }
 
+  __block NSError *innerError = nil;
   __block CLLocation *location = nil;
   [FBRunLoopSpinner spinUntilCompletion:^(void(^completion)(void)){
     [session getSimulatedLocationWithReply:^(CLLocation *reply, NSError *invokeError) {
-      if (error) {
-        *error = invokeError;
-      }
-      if (nil == invokeError) {
+      if (nil != invokeError) {
+        innerError = invokeError;
+      } else {
         location = reply;
       }
       completion();
     }];
   }];
+  if (nil != innerError && error) {
+    *error = innerError;
+  }
   return location;
 }
 
@@ -259,16 +270,21 @@ static void swizzledLaunchApp(id self, SEL _cmd, NSString *path, NSString *bundl
     return NO;
   }
 
+  __block NSError *innerError = nil;
   __block BOOL didSucceed = NO;
   [FBRunLoopSpinner spinUntilCompletion:^(void(^completion)(void)){
     [session clearSimulatedLocationWithReply:^(bool result, NSError *invokeError) {
-      if (error) {
-        *error = invokeError;
+      if (nil != invokeError) {
+        innerError = invokeError;
+      } else {
+        didSucceed = result;
       }
-      didSucceed = invokeError == nil && result;
       completion();
     }];
   }];
+  if (nil != innerError && error) {
+    *error = innerError;
+  }
   return didSucceed;
 }
 #endif

package/WebDriverAgentRunner/UITestingUITests.m

@@ -26,6 +26,11 @@
   [FBConfiguration disableRemoteQueryEvaluation];
   [FBConfiguration configureDefaultKeyboardPreferences];
   [FBConfiguration disableApplicationUIInterruptionsHandling];
+  if (NSProcessInfo.processInfo.environment[@"ENABLE_AUTOMATIC_SCREEN_RECORDINGS"]) {
+    [FBConfiguration enableScreenRecordings];
+  } else {
+    [FBConfiguration disableScreenRecordings];
+  }
   if (NSProcessInfo.processInfo.environment[@"ENABLE_AUTOMATIC_SCREENSHOTS"]) {
     [FBConfiguration enableScreenshots];
   } else {

package/WebDriverAgentTests/IntegrationTests/FBImageIOScalerTests.m

@@ -8,7 +8,6 @@
  */
 
 #import <XCTest/XCTest.h>
-#import <MobileCoreServices/MobileCoreServices.h>
 
 #import "FBImageIOScaler.h"
 #import "FBIntegrationTestCase.h"
@@ -55,7 +54,6 @@
   id expScaled = [self expectationWithDescription:@"Receive scaled image"];
 
   [scaler submitImage:self.originalImage
-                  uti:(__bridge id)kUTTypeJPEG
         scalingFactor:scalingFactor
    compressionQuality:1.0
     completionHandler:^(NSData *scaled) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "appium-webdriveragent",
-  "version": "5.3.1",
+  "version": "5.4.0",
   "description": "Package bundling WebDriverAgent",
   "main": "./build/index.js",
   "scripts": {
@@ -68,7 +68,7 @@
     "appium-xcode": "^5.0.0",
     "chai": "^4.2.0",
     "chai-as-promised": "^7.1.1",
-    "conventional-changelog-conventionalcommits": "^5.0.0",
+    "conventional-changelog-conventionalcommits": "^6.0.0",
     "eslint": "^7.32.0",
     "eslint-config-prettier": "^8.5.0",
     "glob": "^8.0.1",