appium-webdriveragent 4.10.2 → 4.10.3

package/CHANGELOG.md

@@ -1 +1,3 @@
+## [4.10.3](https://github.com/appium/WebDriverAgent/compare/v4.10.2...v4.10.3) (2022-11-22)
+
 ## [4.10.2](https://github.com/appium/WebDriverAgent/compare/v4.10.1...v4.10.2) (2022-11-06)

package/WebDriverAgentLib/Categories/XCUIElement+FBWebDriverAttributes.m

@@ -9,8 +9,6 @@
 
 #import "XCUIElement+FBWebDriverAttributes.h"
 
-#import <objc/runtime.h>
-
 #import "FBElementTypeTransformer.h"
 #import "FBLogger.h"
 #import "FBMacros.h"
@@ -58,11 +56,15 @@
 
 - (id)forwardingTargetForSelector:(SEL)aSelector
 {
-  struct objc_method_description descr = protocol_getMethodDescription(@protocol(FBElement), aSelector, YES, YES);
-  SEL webDriverAttributesSelector = descr.name;
-  return nil == webDriverAttributesSelector
-    ? nil
-    : [FBXCElementSnapshotWrapper ensureWrapped:[self fb_snapshotForAttributeName:NSStringFromSelector(webDriverAttributesSelector)]];
+  static dispatch_once_t onceToken;
+  static NSSet<NSString *> *fbElementAttributeNames;
+  dispatch_once(&onceToken, ^{
+    fbElementAttributeNames = [FBElementUtils selectorNamesWithProtocol:@protocol(FBElement)];
+  });
+  NSString* attributeName = NSStringFromSelector(aSelector);
+  return [fbElementAttributeNames containsObject:attributeName]
+    ? [FBXCElementSnapshotWrapper ensureWrapped:[self fb_snapshotForAttributeName:attributeName]]
+    : nil;
 }
 
 @end

package/WebDriverAgentLib/Commands/FBSessionCommands.m

@@ -88,6 +88,8 @@
   if (nil == (capabilities = FBParseCapabilities((NSDictionary *)request.arguments[@"capabilities"], &error))) {
     return FBResponseWithStatus([FBCommandStatus sessionNotCreatedError:error.description traceback:nil]);
   }
+
+  [FBConfiguration resetSessionSettings];
   [FBConfiguration setShouldUseTestManagerForVisibilityDetection:[capabilities[FB_CAP_USE_TEST_MANAGER_FOR_VISIBLITY_DETECTION] boolValue]];
   if (capabilities[FB_SETTING_USE_COMPACT_RESPONSES]) {
     [FBConfiguration setShouldUseCompactResponses:[capabilities[FB_SETTING_USE_COMPACT_RESPONSES] boolValue]];
@@ -96,8 +98,8 @@
   if (elementResponseAttributes) {
     [FBConfiguration setElementResponseAttributes:elementResponseAttributes];
   }
-  if (capabilities[FB_CAP_MAX_TYPING_FREQUNCY]) {
-    [FBConfiguration setMaxTypingFrequency:[capabilities[FB_CAP_MAX_TYPING_FREQUNCY] unsignedIntegerValue]];
+  if (capabilities[FB_CAP_MAX_TYPING_FREQUENCY]) {
+    [FBConfiguration setMaxTypingFrequency:[capabilities[FB_CAP_MAX_TYPING_FREQUENCY] unsignedIntegerValue]];
   }
   if (capabilities[FB_CAP_USE_SINGLETON_TEST_MANAGER]) {
     [FBConfiguration setShouldUseSingletonTestManager:[capabilities[FB_CAP_USE_SINGLETON_TEST_MANAGER] boolValue]];
@@ -380,10 +382,9 @@
     NSError *error;
     if (![FBConfiguration setScreenshotOrientation:(NSString *)[settings objectForKey:FB_SETTING_SCREENSHOT_ORIENTATION]
                                              error:&error]) {
-      return FBResponseWithStatus([FBCommandStatus invalidArgumentErrorWithMessage:error.description traceback:nil]);
+      return FBResponseWithStatus([FBCommandStatus invalidArgumentErrorWithMessage:error.description
+                                                                         traceback:nil]);
     }
-
-
   }
 #endif
 

package/WebDriverAgentLib/Routing/FBElementUtils.h

@@ -64,6 +64,14 @@ extern NSString *const FBUnknownAttributeException;
  */
 + (unsigned long long)idWithAccessibilityElement:(id<FBXCAccessibilityElement>)element;
 
+/**
+ Retrieves the list of required insatnce methods of the given protocol
+
+ @param protocol target protocol reference
+ @return set of selector names
+ */
++ (NSSet<NSString *> *)selectorNamesWithProtocol:(Protocol *)protocol;
+
 @end
 
 NS_ASSUME_NONNULL_END

package/WebDriverAgentLib/Routing/FBElementUtils.m

@@ -20,11 +20,26 @@ static NSString *const OBJC_PROP_ATTRIBS_SEPARATOR = @",";
 
 @implementation FBElementUtils
 
++ (NSSet<NSString *> *)selectorNamesWithProtocol:(Protocol *)protocol
+{
+  unsigned int count;
+  struct objc_method_description *methods = protocol_copyMethodDescriptionList(protocol, YES, YES, &count);
+  NSMutableSet<NSString *> *result = [NSMutableSet set];
+  for (unsigned int i = 0; i < count; i++) {
+    SEL sel = methods[i].name;
+    if (nil != sel) {
+      [result addObject:NSStringFromSelector(sel)];
+    }
+  }
+  free(methods);
+  return result.copy;
+}
+
 + (NSString *)wdAttributeNameForAttributeName:(NSString *)name
 {
   NSAssert(name.length > 0, @"Attribute name cannot be empty", nil);
   NSDictionary *attributeNamesMapping = [self.class wdAttributeNamesMapping];
-  NSString *result = [attributeNamesMapping valueForKey:name];
+  NSString *result = attributeNamesMapping[name];
   if (nil == result) {
     NSString *description = [NSString stringWithFormat:@"The attribute '%@' is unknown. Valid attribute names are: %@", name, [attributeNamesMapping.allKeys sortedArrayUsingSelector:@selector(compare:)]];
     @throw [NSException exceptionWithName:FBUnknownAttributeException reason:description userInfo:@{}];

package/WebDriverAgentLib/Routing/FBXCElementSnapshotWrapper.m

@@ -9,7 +9,7 @@
 
 #import "FBXCElementSnapshotWrapper.h"
 
-#import <objc/runtime.h>
+#import "FBElementUtils.h"
 
 #pragma clang diagnostic push
 #pragma clang diagnostic ignored "-Wobjc-protocol-property-synthesis"
@@ -35,9 +35,15 @@
 
 - (id)forwardingTargetForSelector:(SEL)aSelector
 {
-  struct objc_method_description descr = protocol_getMethodDescription(@protocol(FBXCElementSnapshot), aSelector, YES, YES);
-  SEL selector = descr.name;
-  return nil == selector ? nil : self.snapshot;
+  static dispatch_once_t onceToken;
+  static NSSet<NSString *> *allNames;
+  dispatch_once(&onceToken, ^{
+    NSMutableSet<NSString *> *names = [NSMutableSet set];
+    [names unionSet:[FBElementUtils selectorNamesWithProtocol:@protocol(FBXCElementSnapshot)]];
+    [names unionSet:[FBElementUtils selectorNamesWithProtocol:@protocol(XCUIElementAttributes)]];
+    allNames = [names copy];
+  });
+  return [allNames containsObject:NSStringFromSelector(aSelector)] ? self.snapshot : nil;
 }
 
 @end

package/WebDriverAgentLib/Utilities/FBCapabilities.h

@@ -10,7 +10,7 @@
 #import <Foundation/Foundation.h>
 
 extern NSString* const FB_CAP_USE_TEST_MANAGER_FOR_VISIBLITY_DETECTION;
-extern NSString* const FB_CAP_MAX_TYPING_FREQUNCY;
+extern NSString* const FB_CAP_MAX_TYPING_FREQUENCY;
 extern NSString* const FB_CAP_USE_SINGLETON_TEST_MANAGER;
 extern NSString* const FB_CAP_DISABLE_AUTOMATIC_SCREENSHOTS;
 extern NSString* const FB_CAP_SHOULD_TERMINATE_APP;

package/WebDriverAgentLib/Utilities/FBCapabilities.m

@@ -10,7 +10,7 @@
 #import "FBCapabilities.h"
 
 NSString* const FB_CAP_USE_TEST_MANAGER_FOR_VISIBLITY_DETECTION = @"shouldUseTestManagerForVisibilityDetection";
-NSString* const FB_CAP_MAX_TYPING_FREQUNCY = @"maxTypingFrequency";
+NSString* const FB_CAP_MAX_TYPING_FREQUENCY = @"maxTypingFrequency";
 NSString* const FB_CAP_USE_SINGLETON_TEST_MANAGER = @"shouldUseSingletonTestManager";
 NSString* const FB_CAP_DISABLE_AUTOMATIC_SCREENSHOTS = @"disableAutomaticScreenshots";
 NSString* const FB_CAP_SHOULD_TERMINATE_APP = @"shouldTerminateApp";

package/WebDriverAgentLib/Utilities/FBConfiguration.h

@@ -301,6 +301,11 @@ typedef NS_ENUM(NSInteger, FBConfigurationKeyboardPreference) {
 
 #endif
 
+/**
+ Resets all session-specific settings to their default values
+ */
++ (void)resetSessionSettings;
+
 @end
 
 NS_ASSUME_NONNULL_END

package/WebDriverAgentLib/Utilities/FBConfiguration.m

@@ -30,30 +30,30 @@ static NSString *const axSettingsClassName = @"AXSettings";
 
 static BOOL FBShouldUseTestManagerForVisibilityDetection = NO;
 static BOOL FBShouldUseSingletonTestManager = YES;
-static BOOL FBShouldUseCompactResponses = YES;
-static BOOL FBShouldTerminateApp = YES;
-static NSString *FBElementResponseAttributes = @"type,label";
-static NSUInteger FBMaxTypingFrequency = 60;
+NSString *const FBSnapshotMaxDepthKey = @"maxDepth";
+
+static NSUInteger FBMjpegScalingFactor = 100;
 static NSUInteger FBMjpegServerScreenshotQuality = 25;
 static NSUInteger FBMjpegServerFramerate = 10;
-static NSUInteger FBScreenshotQuality = 1;
-static NSUInteger FBMjpegScalingFactor = 100;
-static NSTimeInterval FBCustomSnapshotTimeout = 15.;
-static BOOL FBShouldUseFirstMatch = NO;
-static BOOL FBShouldBoundElementsByIndex = NO;
-// This is diabled by default because enabling it prevents the accessbility snapshot to be taken
-// (it always errors with kxIllegalArgument error)
-static BOOL FBIncludeNonModalElements = NO;
-static NSString *FBAcceptAlertButtonSelector = @"";
-static NSString *FBDismissAlertButtonSelector = @"";
-NSString *const FBSnapshotMaxDepthKey = @"maxDepth";
-static NSMutableDictionary *FBSnapshotRequestParameters;
-static NSTimeInterval FBWaitForIdleTimeout = 10.;
-static NSTimeInterval FBAnimationCoolOffTimeout = 2.;
 
+// Session-specific settings
+static BOOL FBShouldTerminateApp;
+static NSUInteger FBMaxTypingFrequency;
+static NSUInteger FBScreenshotQuality;
+static NSTimeInterval FBCustomSnapshotTimeout;
+static BOOL FBShouldUseFirstMatch;
+static BOOL FBShouldBoundElementsByIndex;
+static BOOL FBIncludeNonModalElements;
+static NSString *FBAcceptAlertButtonSelector;
+static NSString *FBDismissAlertButtonSelector;
+static NSTimeInterval FBWaitForIdleTimeout;
+static NSTimeInterval FBAnimationCoolOffTimeout;
+static BOOL FBShouldUseCompactResponses;
+static NSString *FBElementResponseAttributes;
 #if !TARGET_OS_TV
-static UIInterfaceOrientation FBScreenshotOrientation = UIInterfaceOrientationUnknown;
+static UIInterfaceOrientation FBScreenshotOrientation;
 #endif
+static NSMutableDictionary *FBSnapshotRequestParameters;
 
 @implementation FBConfiguration
 
@@ -62,9 +62,9 @@ static UIInterfaceOrientation FBScreenshotOrientation = UIInterfaceOrientationUn
   FBSnapshotRequestParameters = [NSMutableDictionary dictionaryWithDictionary:@{
     @"maxArrayCount": @INT_MAX,
     @"maxChildren": @INT_MAX,
-    FBSnapshotMaxDepthKey: @50, // 50 should be enough for the majority of the cases. The performance is acceptable for values up to 100.
     @"traverseFromParentsToChildren": @1
   }];
+  [FBConfiguration resetSessionSettings];
 }
 
 #pragma mark Public
@@ -450,6 +450,30 @@ static UIInterfaceOrientation FBScreenshotOrientation = UIInterfaceOrientationUn
 }
 #endif
 
++ (void)resetSessionSettings
+{
+  FBShouldTerminateApp = YES;
+  FBShouldUseCompactResponses = YES;
+  FBElementResponseAttributes = @"type,label";
+  FBMaxTypingFrequency = 60;
+  FBScreenshotQuality = 1;
+  FBCustomSnapshotTimeout = 15.;
+  FBShouldUseFirstMatch = NO;
+  FBShouldBoundElementsByIndex = NO;
+  // This is diabled by default because enabling it prevents the accessbility snapshot to be taken
+  // (it always errors with kxIllegalArgument error)
+  FBIncludeNonModalElements = NO;
+  FBAcceptAlertButtonSelector = @"";
+  FBDismissAlertButtonSelector = @"";
+  FBWaitForIdleTimeout = 10.;
+  FBAnimationCoolOffTimeout = 2.;
+  // 50 should be enough for the majority of the cases. The performance is acceptable for values up to 100.
+  FBSnapshotRequestParameters[FBSnapshotMaxDepthKey] = @50;
+#if !TARGET_OS_TV
+  FBScreenshotOrientation = UIInterfaceOrientationUnknown;
+#endif
+}
+
 #pragma mark Private
 
 + (FBConfigurationKeyboardPreference)keyboardsPreference:(nonnull NSString *)key

package/package.json

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