appium-mac2-driver 4.1.1 → 4.3.0

package/WebDriverAgentMac/WebDriverAgentLib/Categories/XCUIElement+AMAttributes.m

@@ -25,6 +25,12 @@
 #import "FBMacros.h"
 #import "XCUIElementQuery+AMHelpers.h"
 
+NSString *const AM_IDENTIFIER_ATTRIBUTE_NAME = @"amIdentifier";
+NSString *const AM_RECT_ATTRIBUTE_NAME = @"amRect";
+NSString *const AM_TEXT_ATTRIBUTE_NAME = @"amText";
+NSString *const AM_TYPE_ATTRIBUTE_NAME = @"amType";
+NSString *const AM_HAS_KEYBOARD_INPUT_FOCUS_ATTRIBUTE_NAME = @"amHasKeyboardInputFocus";
+
 @implementation XCUIElement (AMAttributes)
 
 - (id)am_wdAttributeValueWithName:(NSString *)name
@@ -50,8 +56,17 @@
     return self.title;
   } else if ([wdAttributeName isEqualToString:FBStringify(XCUIElement, value)]) {
     return [FBElementUtils stringValueWithValue:self.value];
-  } else if ([wdAttributeName isEqualToString:FBStringify(XCUIElement, identifier)]) {
-    return self.am_wdIdentifier;
+  } else if ([wdAttributeName isEqualToString:FBStringify(XCUIElement, identifier)]
+             || [wdAttributeName isEqualToString:AM_IDENTIFIER_ATTRIBUTE_NAME]) {
+    return self.am_identifier;
+  } else if ([wdAttributeName isEqualToString:AM_RECT_ATTRIBUTE_NAME]) {
+    return self.am_rect;
+  } else if ([wdAttributeName isEqualToString:AM_TEXT_ATTRIBUTE_NAME]) {
+    return self.am_text;
+  } else if ([wdAttributeName isEqualToString:AM_TYPE_ATTRIBUTE_NAME]) {
+    return self.am_type;
+  } else if ([wdAttributeName isEqualToString:AM_HAS_KEYBOARD_INPUT_FOCUS_ATTRIBUTE_NAME]) {
+    return FBBoolToStr(self.am_hasKeyboardInputFocus);
   }
   // This should not happen
   NSString *description = [NSString stringWithFormat:@"The attribute '%@' is unknown", wdAttributeName];
@@ -60,32 +75,69 @@
                                userInfo:@{}];
 }
 
-- (NSString *)am_wdIdentifier
++ (NSArray<NSString *> *)am_predicateAttributeNames
+{
+  return @[
+    AM_IDENTIFIER_ATTRIBUTE_NAME,
+    AM_RECT_ATTRIBUTE_NAME,
+    AM_TEXT_ATTRIBUTE_NAME,
+    AM_TYPE_ATTRIBUTE_NAME,
+    AM_HAS_KEYBOARD_INPUT_FOCUS_ATTRIBUTE_NAME,
+  ];
+}
+
++ (nullable id)am_valueForPredicateAttributeName:(NSString *)name target:(id)target
 {
-  NSString *identifier = self.identifier;
-  // Snapshotting is not free, so only pay for it when the fallback can apply.
-  if (identifier.length > 0 || !FBConfiguration.sharedConfiguration.useDomIdAsAccessibilityId) {
-    return identifier;
+  if ([name isEqualToString:AM_IDENTIFIER_ATTRIBUTE_NAME]) {
+    NSString *identifier = [target valueForKey:@"identifier"];
+    // Snapshotting is not free, so only pay for it when the fallback can apply.
+    if (identifier.length > 0 || !FBConfiguration.sharedConfiguration.useDomIdAsAccessibilityId) {
+      return identifier;
+    }
+    // domIdentifierWithSnapshot: relies on snapshot-only key paths (_accessibilityElement._token),
+    // which a live XCUIElement does not have, so it must be snapshotted first.
+    id snapshotTarget = [target isKindOfClass:XCUIElement.class]
+      ? [(XCUIElement *)target snapshotWithError:nil]
+      : target;
+    return [AMSnapshotUtils domIdentifierWithSnapshot:snapshotTarget] ?: identifier;
   }
-  return [AMSnapshotUtils wdIdentifierWithSnapshot:[self snapshotWithError:nil]] ?: identifier;
+  if ([name isEqualToString:AM_RECT_ATTRIBUTE_NAME]) {
+    return AMCGRectToDict([[target valueForKey:@"frame"] rectValue]);
+  }
+  if ([name isEqualToString:AM_TEXT_ATTRIBUTE_NAME]) {
+    return [self am_textWithSource:target];
+  }
+  if ([name isEqualToString:AM_TYPE_ATTRIBUTE_NAME]) {
+    return [FBElementTypeTransformer stringWithElementType:[[target valueForKey:@"elementType"] unsignedLongLongValue]];
+  }
+  if ([name isEqualToString:AM_HAS_KEYBOARD_INPUT_FOCUS_ATTRIBUTE_NAME]) {
+    NSPredicate *predicate = [NSPredicate predicateWithFormat:@"hasKeyboardFocus == YES"];
+    return @([predicate evaluateWithObject:target]);
+  }
+  return nil;
+}
+
+- (NSString *)am_identifier
+{
+  return [self.class am_valueForPredicateAttributeName:AM_IDENTIFIER_ATTRIBUTE_NAME target:self];
 }
 
 - (NSDictionary<NSString *, NSNumber *> *)am_rect
 {
-  return AMCGRectToDict(self.frame);
+  return [self.class am_valueForPredicateAttributeName:AM_RECT_ATTRIBUTE_NAME target:self];
 }
 
 - (NSString *)am_text
 {
   if (!FBConfiguration.sharedConfiguration.fetchFullText) {
-    return [self am_textWithSource:self];
+    return [self.class am_valueForPredicateAttributeName:AM_TEXT_ATTRIBUTE_NAME target:self];
   }
 
   NSError *error;
   XCUIElementQuery *query = [self valueForKey:@"query"];
   id<XCUIElementAttributes> snapshot = [query am_uniqueSnapshotWithError:&error];
   if (nil != snapshot) {
-    return [self am_textWithSource:snapshot];
+    return [self.class am_valueForPredicateAttributeName:AM_TEXT_ATTRIBUTE_NAME target:snapshot];
   }
 
   NSString *reason = [NSString stringWithFormat:@"Cannot extract the full text of '%@' element. Original error: %@",
@@ -95,16 +147,15 @@
 
 - (NSString *)am_type
 {
-  return [FBElementTypeTransformer stringWithElementType:self.elementType];
+  return [self.class am_valueForPredicateAttributeName:AM_TYPE_ATTRIBUTE_NAME target:self];
 }
 
 - (BOOL)am_hasKeyboardInputFocus
 {
-  NSPredicate *predicate = [NSPredicate predicateWithFormat:@"hasKeyboardFocus == YES"];
-  return [predicate evaluateWithObject:self];
+  return [[self.class am_valueForPredicateAttributeName:AM_HAS_KEYBOARD_INPUT_FOCUS_ATTRIBUTE_NAME target:self] boolValue];
 }
 
-- (NSString *)am_textWithSource:(id<XCUIElementAttributes>)source
++ (NSString *)am_textWithSource:(id<XCUIElementAttributes>)source
 {
   NSArray<NSString *> *candidates = @[
     [FBElementUtils stringValueWithValue:source.value],

package/WebDriverAgentMac/WebDriverAgentLib/Routing/AMHTTPServer.h

@@ -0,0 +1,84 @@
+/*
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * See the NOTICE file distributed with this work for additional
+ * information regarding copyright ownership.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// A minimal HTTP/1.1 server on top of AMTCPSocket (Network.framework-backed).
+//
+// No chunked encoding, range requests, or pipelining - just request line + headers +
+// Content-Length body, and ":param" path matching.
+
+#import <Foundation/Foundation.h>
+
+#import "RouteRequest.h"
+#import "RouteResponse.h"
+
+NS_ASSUME_NONNULL_BEGIN
+
+@interface AMHTTPServer : NSObject
+
+/*! The port the server is (or will be) listening on */
+@property (nonatomic) uint16_t port;
+
+/*! Whether the server is currently listening for connections */
+@property (nonatomic, readonly) BOOL isRunning;
+
+/**
+ Sets the dispatch queue on which route blocks are invoked. Pass NULL to invoke them
+ synchronously on the socket's own queue.
+ */
+- (void)setRouteQueue:(nullable dispatch_queue_t)queue;
+
+/**
+ Sets a header which is added to every response, unless overridden by the route itself.
+ */
+- (void)setDefaultHeader:(NSString *)field value:(NSString *)value;
+
+/**
+ Sets the local IP address to bind the listener to. Must be called before -start:. Pass nil (the
+ default) to listen on all interfaces.
+ */
+- (void)setInterface:(nullable NSString *)interface;
+
+/**
+ Registers a route handler for the given HTTP method and path pattern (":param" segments are
+ captured into the request's `params`).
+ */
+- (void)handleMethod:(NSString *)method
+            withPath:(NSString *)path
+               block:(void (^)(RouteRequest *request, RouteResponse *response))block;
+
+/**
+ Convenience for -handleMethod:@"GET" withPath:path block:block.
+ */
+- (void)get:(NSString *)path withBlock:(void (^)(RouteRequest *request, RouteResponse *response))block;
+
+/**
+ Convenience for -handleMethod:@"DELETE" withPath:path block:block.
+ */
+- (void)delete:(NSString *)path withBlock:(void (^)(RouteRequest *request, RouteResponse *response))block;
+
+/**
+ Starts listening on `port`.
+ */
+- (BOOL)start:(NSError **)error;
+
+/**
+ Stops listening and disconnects all clients.
+ */
+- (void)stop:(BOOL)immediately;
+
+@end
+
+NS_ASSUME_NONNULL_END