appium-webdriveragent 4.10.8 → 4.10.9

package/CHANGELOG.md

@@ -1,3 +1,5 @@
+## [4.10.9](https://github.com/appium/WebDriverAgent/compare/v4.10.8...v4.10.9) (2022-11-25)
+
 ## [4.10.8](https://github.com/appium/WebDriverAgent/compare/v4.10.7...v4.10.8) (2022-11-24)
 
 ## [4.10.7](https://github.com/appium/WebDriverAgent/compare/v4.10.6...v4.10.7) (2022-11-24)

package/WebDriverAgentLib/Categories/XCUIElement+FBResolve.m

@@ -50,7 +50,7 @@ static char XCUIELEMENT_IS_RESOLVED_NATIVELY_KEY;
   NSPredicate *predicate = [NSPredicate predicateWithBlock:^BOOL(id<FBXCElementSnapshot> snapshot, NSDictionary *bindings) {
     return [[FBXCElementSnapshotWrapper wdUIDWithSnapshot:snapshot] isEqualToString:uid];
   }];
-  return (XCUIElement *)[query matchingPredicate:predicate].fb_firstMatch;
+  return [query matchingPredicate:predicate].fb_firstMatch ?: self;
 }
 
 @end

package/WebDriverAgentLib/Routing/FBElementCache.m

@@ -38,7 +38,7 @@ const int ELEMENT_CACHE_SIZE = 1024;
     return nil;
   }
   _elementCache = [[LRUCache alloc] initWithCapacity:ELEMENT_CACHE_SIZE];
-  _elementsNeedReset = YES;
+  _elementsNeedReset = NO;
   return self;
 }
 
@@ -50,8 +50,8 @@ const int ELEMENT_CACHE_SIZE = 1024;
   }
   @synchronized (self.elementCache) {
     [self.elementCache setObject:element forKey:uuid];
+    self.elementsNeedReset = YES;
   }
-  self.elementsNeedReset = YES;
   return uuid;
 }
 

package/WebDriverAgentLib/Routing/FBResponsePayload.m

@@ -18,6 +18,7 @@
 #import "FBProtocolHelpers.h"
 #import "XCUIElementQuery.h"
 #import "XCUIElement+FBResolve.h"
+#import "XCUIElement+FBUID.h"
 #import "XCUIElement+FBUtilities.h"
 #import "XCUIElement+FBWebDriverAttributes.h"
 
@@ -39,7 +40,7 @@ id<FBResponsePayload> FBResponseWithCachedElement(XCUIElement *element, FBElemen
     ? YES
     : FBSession.activeSession.useNativeCachingStrategy;
   [elementCache storeElement:(useNativeCachingStrategy ? element : element.fb_stableInstance)];
-  return FBResponseWithStatus([FBCommandStatus okWithValue: FBDictionaryResponseWithElement(element, compact)]);
+  return FBResponseWithStatus([FBCommandStatus okWithValue:FBDictionaryResponseWithElement(element, compact)]);
 }
 
 id<FBResponsePayload> FBResponseWithCachedElements(NSArray<XCUIElement *> *elements, FBElementCache *elementCache, BOOL compact)
@@ -65,7 +66,8 @@ id<FBResponsePayload> FBResponseWithUnknownErrorFormat(NSString *format, ...)
   va_list argList;
   va_start(argList, format);
   NSString *errorMessage = [[NSString alloc] initWithFormat:format arguments:argList];
-  id<FBResponsePayload> payload = FBResponseWithStatus([FBCommandStatus unknownErrorWithMessage:errorMessage traceback:nil]);
+  id<FBResponsePayload> payload = FBResponseWithStatus([FBCommandStatus unknownErrorWithMessage:errorMessage
+                                                                                      traceback:nil]);
   va_end(argList);
   return payload;
 }
@@ -77,13 +79,12 @@ id<FBResponsePayload> FBResponseWithStatus(FBCommandStatus *status)
   if (nil == status.error) {
     response[@"value"] = status.value ?: NSNull.null;
   } else {
-    NSMutableDictionary* value = [NSMutableDictionary dictionary];
-    value[@"error"] = status.error;
-    value[@"message"] = status.message ?: @"";
-    value[@"traceback"] = status.traceback ?: @"";
-    response[@"value"] = value.copy;
+    response[@"value"] = @{
+      @"error": (id)status.error,
+      @"message": status.message ?: @"",
+      @"traceback": status.traceback ?: @""
+    };
   }
-
   return [[FBResponseJSONPayload alloc] initWithDictionary:response.copy
                                             httpStatusCode:status.statusCode];
 }
@@ -97,31 +98,34 @@ inline NSDictionary *FBDictionaryResponseWithElement(XCUIElement *element, BOOL
   if (nil == snapshot) {
     snapshot = element.lastSnapshot ?: element.fb_takeSnapshot;
   }
+  NSDictionary *compactResult = FBToElementDict((NSString *)[FBXCElementSnapshotWrapper wdUIDWithSnapshot:snapshot]);
+  if (compact) {
+    return compactResult;
+  }
+
+  NSMutableDictionary *result = compactResult.mutableCopy;
   FBXCElementSnapshotWrapper *wrappedSnapshot = [FBXCElementSnapshotWrapper ensureWrapped:snapshot];
-  NSMutableDictionary *dictionary = FBInsertElement(@{}, (NSString *)wrappedSnapshot.wdUID).mutableCopy;
-  if (!compact) {
-    NSArray *fields = [FBConfiguration.elementResponseAttributes componentsSeparatedByString:@","];
-    for (NSString *field in fields) {
-      // 'name' here is the w3c-approved identifier for what we mean by 'type'
-      if ([field isEqualToString:@"name"] || [field isEqualToString:@"type"]) {
-        dictionary[field] = wrappedSnapshot.wdType;
-      } else if ([field isEqualToString:@"text"]) {
-        dictionary[field] = FBFirstNonEmptyValue(wrappedSnapshot.wdValue, wrappedSnapshot.wdLabel) ?: [NSNull null];
-      } else if ([field isEqualToString:@"rect"]) {
-        dictionary[field] = wrappedSnapshot.wdRect;
-      } else if ([field isEqualToString:@"enabled"]) {
-        dictionary[field] = @(wrappedSnapshot.wdEnabled);
-      } else if ([field isEqualToString:@"displayed"]) {
-        dictionary[field] = @(wrappedSnapshot.wdVisible);
-      } else if ([field isEqualToString:@"selected"]) {
-        dictionary[field] = @(wrappedSnapshot.wdSelected);
-      } else if ([field isEqualToString:@"label"]) {
-        dictionary[field] = wrappedSnapshot.wdLabel ?: [NSNull null];
-      } else if ([field hasPrefix:arbitraryAttrPrefix]) {
-        NSString *attributeName = [field substringFromIndex:[arbitraryAttrPrefix length]];
-        dictionary[field] = [wrappedSnapshot fb_valueForWDAttributeName:attributeName] ?: [NSNull null];
-      }
+  NSArray *fields = [FBConfiguration.elementResponseAttributes componentsSeparatedByString:@","];
+  for (NSString *field in fields) {
+    // 'name' here is the w3c-approved identifier for what we mean by 'type'
+    if ([field isEqualToString:@"name"] || [field isEqualToString:@"type"]) {
+      result[field] = wrappedSnapshot.wdType;
+    } else if ([field isEqualToString:@"text"]) {
+      result[field] = FBFirstNonEmptyValue(wrappedSnapshot.wdValue, wrappedSnapshot.wdLabel) ?: [NSNull null];
+    } else if ([field isEqualToString:@"rect"]) {
+      result[field] = wrappedSnapshot.wdRect;
+    } else if ([field isEqualToString:@"enabled"]) {
+      result[field] = @(wrappedSnapshot.wdEnabled);
+    } else if ([field isEqualToString:@"displayed"]) {
+      result[field] = @(wrappedSnapshot.wdVisible);
+    } else if ([field isEqualToString:@"selected"]) {
+      result[field] = @(wrappedSnapshot.wdSelected);
+    } else if ([field isEqualToString:@"label"]) {
+      result[field] = wrappedSnapshot.wdLabel ?: [NSNull null];
+    } else if ([field hasPrefix:arbitraryAttrPrefix]) {
+      NSString *attributeName = [field substringFromIndex:[arbitraryAttrPrefix length]];
+      result[field] = [wrappedSnapshot fb_valueForWDAttributeName:attributeName] ?: [NSNull null];
     }
   }
-  return dictionary.copy;
+  return result.copy;
 }

package/WebDriverAgentLib/Utilities/FBAppiumActionsSynthesizer.m

@@ -448,9 +448,10 @@ static const double FB_LONG_TAP_DURATION_MS = 600.0;
       [result addObject:touchItem];
       continue;
     }
+    NSMutableDictionary *elementDict = FBCleanupElements(options).mutableCopy;
+    [elementDict addEntriesFromDictionary:FBToElementDict(element)];
     NSMutableDictionary<NSString *, id> *processedItem = touchItem.mutableCopy;
-    [processedItem setObject:FBInsertElement(FBCleanupElements(options), element)
-                      forKey:FB_OPTIONS_KEY];
+    processedItem[FB_OPTIONS_KEY] = elementDict.copy;
     [result addObject:processedItem.copy];
   }
   return [[result reverseObjectEnumerator] allObjects];

package/WebDriverAgentLib/Utilities/FBProtocolHelpers.h

@@ -12,13 +12,12 @@
 NS_ASSUME_NONNULL_BEGIN
 
 /**
- Inserts element uuid into the response dictionary
+ Prepares an element dictionary, which could be then used in hybrid W3C/JWP responses
 
- @param dst The target dictionary. It is NOT mutated
  @param element Either element identifier or element object itself
- @returns The changed dictionary
+ @returns The resulting dictionary
  */
-NSDictionary *FBInsertElement(NSDictionary *dst, id element);
+NSDictionary<NSString *, id> *FBToElementDict(id element);
 
 /**
  Extracts element uuid from dictionary

package/WebDriverAgentLib/Utilities/FBProtocolHelpers.m

@@ -20,12 +20,12 @@ static NSString *const ALWAYS_MATCH_KEY = @"alwaysMatch";
 static NSString *const FIRST_MATCH_KEY = @"firstMatch";
 
 
-NSDictionary *FBInsertElement(NSDictionary *dst, id element)
+NSDictionary<NSString *, id> *FBToElementDict(id element)
 {
-  NSMutableDictionary *result = dst.mutableCopy;
-  result[W3C_ELEMENT_KEY] = element;
-  result[JSONWP_ELEMENT_KEY] = element;
-  return result.copy;
+  return @{
+    W3C_ELEMENT_KEY: element,
+    JSONWP_ELEMENT_KEY: element
+  };
 }
 
 id FBExtractElement(NSDictionary *src)

package/package.json

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