appium-mac2-driver 1.18.0 → 1.18.2

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+## [1.18.2](https://github.com/appium/appium-mac2-driver/compare/v1.18.1...v1.18.2) (2024-07-21)
+
+
+### Bug Fixes
+
+* do nothing for an empty array in w3c actions ([#308](https://github.com/appium/appium-mac2-driver/issues/308)) ([a1aa636](https://github.com/appium/appium-mac2-driver/commit/a1aa636d8856c97b8edb1c091b3919a45a6d6716))
+
+## [1.18.1](https://github.com/appium/appium-mac2-driver/compare/v1.18.0...v1.18.1) (2024-07-20)
+
+
+### Bug Fixes
+
+* Add a test for the keyboard input and perform related fixes ([#311](https://github.com/appium/appium-mac2-driver/issues/311)) ([af826e8](https://github.com/appium/appium-mac2-driver/commit/af826e83f60dd278f44042e2ef36b81390f3ef19))
+
 ## [1.18.0](https://github.com/appium/appium-mac2-driver/compare/v1.17.5...v1.18.0) (2024-07-18)
 
 

package/WebDriverAgentMac/IntegrationTests/AMW3CActionsTests.m

@@ -261,6 +261,18 @@
     },
     ],
 
+    // Keys are not balanced
+    @[@{
+      @"type": @"key",
+      @"id": @"keyboard",
+      @"actions": @[
+        @{@"type": @"keyDown", @"value": @"n"},
+        @{@"type": @"keyUp", @"value": @"n"},
+        @{@"type": @"keyUp", @"value": @"b"},
+      ],
+    },
+    ],
+
   ];
 
   for (NSArray<NSDictionary<NSString *, id> *> *invalidGesture in invalidGestures) {
@@ -274,6 +286,7 @@
 
 - (void)testClick
 {
+  [self switchToButtonsTab];
   XCUIElement *checkbox = self.testedApplication.checkBoxes.firstMatch;
   NSNumber *value = checkbox.value;
 
@@ -300,6 +313,7 @@
 
 - (void)testRightClick
 {
+  [self switchToButtonsTab];
   XCUIElement *checkbox = self.testedApplication.checkBoxes.firstMatch;
   NSNumber *value = checkbox.value;
 
@@ -324,5 +338,57 @@
   XCTAssertTrue([checkbox.value boolValue] == [value boolValue]);
 }
 
+- (void)testKeys
+{
+  [self switchToEditsTab];
+  XCUIElement *edit = self.testedApplication.textFields.firstMatch;
+  [edit click];
+
+  NSArray<NSDictionary<NSString *, id> *> *gesture =
+  @[@{
+    @"type": @"key",
+    @"id": @"keyboard",
+    @"actions": @[
+      @{@"type": @"keyDown", @"value": @"\uE008"},
+      @{@"type": @"pause", @"duration": @500},
+      @{@"type": @"keyDown", @"value": @"n"},
+      @{@"type": @"keyUp", @"value": @"n"},
+      @{@"type": @"keyDown", @"value": @"b"},
+      @{@"type": @"keyUp", @"value": @"b"},
+      @{@"type": @"keyDown", @"value": @"a"},
+      @{@"type": @"keyUp", @"value": @"a"},
+      @{@"type": @"pause", @"duration": @500},
+      @{@"type": @"keyUp", @"value": @"\uE008"},
+    ],
+  },
+  ];
+  NSError *error;
+  XCTAssertTrue([self.testedApplication fb_performW3CActions:gesture
+                                                elementCache:nil
+                                                       error:&error]);
+  XCTAssertNil(error);
+  XCTAssertEqualObjects(edit.value, @"NBA");
+}
+
+- (void)testKeysWithEmptyActions
+{
+  [self switchToEditsTab];
+  XCUIElement *edit = self.testedApplication.textFields.firstMatch;
+  [edit click];
+
+  NSArray<NSDictionary<NSString *, id> *> *gesture =
+  @[@{
+    @"type": @"key",
+    @"id": @"keyboard",
+    @"actions": @[],
+  },
+  ];
+  NSError *error;
+  XCTAssertTrue([self.testedApplication fb_performW3CActions:gesture
+                                                elementCache:nil
+                                                       error:&error]);
+  XCTAssertNil(error);
+  XCTAssertEqualObjects(edit.value, @"");
+}
 
 @end

package/WebDriverAgentMac/WebDriverAgentLib/Utilities/FBW3CActionsSynthesizer.m

@@ -80,7 +80,7 @@ static NSString *const FB_KEY_ACTIONS = @"actions";
 
 @property (nullable, readonly, nonatomic) FBW3CKeyItem *previousItem;
 
-- (NSUInteger)calculateModifierForChain:(NSArray *)allItems
+- (NSUInteger)calculateModifiersForChain:(NSArray *)allItems
                           lastItemIndex:(NSUInteger)lastItemIndex;
 
 @end
@@ -260,7 +260,7 @@ static NSString *const FB_KEY_ACTIONS = @"actions";
     }
     return nil;
   }
-  
+
   XCUIElement *element = isOriginAnElement ? (XCUIElement *)origin : nil;
   NSNumber *x = [self.actionItem objectForKey:FB_ACTION_ITEM_KEY_X];
   NSNumber *y = [self.actionItem objectForKey:FB_ACTION_ITEM_KEY_Y];
@@ -272,7 +272,7 @@ static NSString *const FB_KEY_ACTIONS = @"actions";
     }
     return nil;
   }
-  
+
   if (nil != element) {
     if (nil == x && nil == y) {
       return [self hitpointWithElement:element
@@ -283,13 +283,13 @@ static NSString *const FB_KEY_ACTIONS = @"actions";
                       positionOffset:[NSValue am_valueWithCGPoint:CGPointMake(x.floatValue, y.floatValue)]
                                error:error];
   }
-  
+
   if ([origin isKindOfClass:NSString.class] && [origin isEqualToString:FB_ORIGIN_TYPE_VIEWPORT]) {
     return [self hitpointWithElement:nil
                       positionOffset:[NSValue am_valueWithCGPoint:CGPointMake(x.floatValue, y.floatValue)]
                                error:error];
   }
-  
+
   // origin == FB_ORIGIN_TYPE_POINTER
   if (nil == self.previousItem) {
     NSString *errorDescription = [NSString stringWithFormat:@"There is no previous item for '%@' action item, however %@ is set to '%@'", self.actionItem, FB_ACTION_ITEM_KEY_ORIGIN, FB_ORIGIN_TYPE_POINTER];
@@ -436,7 +436,7 @@ static NSString *const FB_KEY_ACTIONS = @"actions";
   return self;
 }
 
-- (NSUInteger)calculateModifierForChain:(NSArray *)allItems
+- (NSUInteger)calculateModifiersForChain:(NSArray *)allItems
                           lastItemIndex:(NSUInteger)lastItemIndex
 {
   NSUInteger result = 0;
@@ -501,7 +501,7 @@ static NSString *const FB_KEY_ACTIONS = @"actions";
     BOOL isKeyDown = [item isKindOfClass:FBKeyDownItem.class];
     BOOL isKeyUp = !isKeyDown && [item isKindOfClass:FBKeyUpItem.class];
     if (!isKeyUp && !isKeyDown) {
-      break;
+      continue;
     }
 
     NSString *value = [item performSelector:@selector(value)];
@@ -536,36 +536,46 @@ static NSString *const FB_KEY_ACTIONS = @"actions";
   }
 
   NSNumber *modifier = AMToMetaModifier(self.value);
-  NSTimeInterval offsetSeconds = FBMillisToSeconds(self.offset);
-  XCPointerEventPath *result = nil == eventPath ? [[XCPointerEventPath alloc] initForTextInput] : eventPath;
   if (nil != modifier) {
-    NSUInteger previousModifier = [self calculateModifierForChain:allItems lastItemIndex:currentItemIndex - 1];
-    [result setModifiers:previousModifier & ~[modifier unsignedIntValue]
-mergeWithCurrentModifierFlags:NO
-                atOffset:offsetSeconds];
-    return @[result];
+    return @[];
   }
 
+  NSTimeInterval offsetSeconds = FBMillisToSeconds(self.offset);
+  XCPointerEventPath *result = nil == eventPath ? [[XCPointerEventPath alloc] initForTextInput] : eventPath;
+
   NSString *specialKey = AMToSpecialKey(self.value);
+  NSUInteger modifiers = [self calculateModifiersForChain:allItems lastItemIndex:currentItemIndex];
   if (nil != specialKey) {
-    NSUInteger previousModifier = [self calculateModifierForChain:allItems lastItemIndex:currentItemIndex];
-    if ([specialKey isEqualToString:@""]) {
-      // NOOP
-      [result setModifiers:previousModifier
-mergeWithCurrentModifierFlags:NO
-                  atOffset:offsetSeconds];
-    } else {
+    if (specialKey.length > 0) {
       [result typeKey:specialKey
-            modifiers:previousModifier
+            modifiers:modifiers
              atOffset:offsetSeconds];
     }
     return @[result];
   }
 
-  [result typeText:self.value
-          atOffset:offsetSeconds
-       typingSpeed:[self.class defaultTypingFrequency]
-      shouldRedact:NO];
+  NSUInteger len = [self.value length];
+  unichar buffer[len + 1];
+  [self.value getCharacters:buffer range:NSMakeRange(0, len)];
+  for (int i = 0; i < 1; i++) {
+    unichar charCode = buffer[i];
+    NSString *oneChar = [NSString stringWithFormat:@"%C", charCode];
+    // 0x7F is the end of the first half of the ASCII table, where (almoust) all
+    // chars have their own key representations
+    if (charCode <= 0x7F) {
+      [result typeKey:oneChar
+            modifiers:modifiers
+             atOffset:offsetSeconds];
+    } else {
+      // The typeText API does not respect modifiers
+      // while the typeKey API can only enter keys
+      [result typeText:oneChar
+              atOffset:offsetSeconds
+           typingSpeed:[self.class defaultTypingFrequency]
+          shouldRedact:NO];
+    }
+  }
+
   return @[result];
 }
 
@@ -608,7 +618,7 @@ mergeWithCurrentModifierFlags:NO
     BOOL isKeyDown = [item isKindOfClass:FBKeyDownItem.class];
     BOOL isKeyUp = !isKeyDown && [item isKindOfClass:FBKeyUpItem.class];
     if (!isKeyUp && !isKeyDown) {
-      break;
+      continue;
     }
 
     NSString *value = [item performSelector:@selector(value)];
@@ -635,20 +645,7 @@ mergeWithCurrentModifierFlags:NO
     return nil;
   }
 
-  NSNumber *modifier = AMToMetaModifier(self.value);
-  if (nil == modifier) {
-    return @[];
-  }
-  NSUInteger previousModifier = [self calculateModifierForChain:allItems lastItemIndex:currentItemIndex - 1];
-  if ([modifier unsignedIntValue] == previousModifier) {
-    return @[];
-  }
-
-  XCPointerEventPath *result = nil == eventPath ? [[XCPointerEventPath alloc] initForTextInput] : eventPath;
-  [result setModifiers:previousModifier | [modifier unsignedIntValue]
-mergeWithCurrentModifierFlags:NO
-              atOffset:FBMillisToSeconds(self.offset)];
-  return @[result];
+  return @[];
 }
 
 @end
@@ -737,7 +734,7 @@ mergeWithCurrentModifierFlags:NO
       shouldCancelNextItem = YES;
       continue;
     }
-    
+
     if (nil == self.elementCache) {
       [result addObject:actionItem];
       continue;
@@ -877,7 +874,7 @@ mergeWithCurrentModifierFlags:NO
 
   NSArray<NSDictionary<NSString *, id> *> *actionItems = [actionDescription objectForKey:FB_KEY_ACTIONS];
   if (nil == actionItems || 0 == actionItems.count) {
-   NSString *description = [NSString stringWithFormat:@"It is mandatory to have at least one gesture item defined for each action. Action with id '%@' contains none", actionId];
+    NSString *description = [NSString stringWithFormat:@"It is mandatory to have at least one gesture item defined for each action. Action with id '%@' contains none", actionId];
     if (error) {
       *error = [[FBErrorBuilder.builder withDescription:description] build];
     }
@@ -962,6 +959,19 @@ mergeWithCurrentModifierFlags:NO
       }
       return nil;
     }
+    NSArray<NSDictionary<NSString *, id> *> *actionItems = [action objectForKey:FB_KEY_ACTIONS];
+    if (nil == actionItems) {
+     NSString *description = [NSString stringWithFormat:@"It is mandatory to have at least one item defined for each action. Action with id '%@' contains none", actionId];
+      if (error) {
+        *error = [[FBErrorBuilder.builder withDescription:description] build];
+      }
+      return nil;
+    }
+    if (0 == actionItems.count) {
+      [FBLogger logFmt:@"Action items in the action id '%@' had an empty array. Skipping the action.", actionId];
+      continue;
+    }
+
     [actionIds addObject:actionId];
     [actionsMapping setObject:action forKey:actionId];
   }

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "appium-mac2-driver",
-  "version": "1.18.0",
+  "version": "1.18.2",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "appium-mac2-driver",
-      "version": "1.18.0",
+      "version": "1.18.2",
       "license": "Apache-2.0",
       "dependencies": {
         "@appium/strongbox": "^0.x",

package/package.json

@@ -6,7 +6,7 @@
     "mac",
     "XCTest"
   ],
-  "version": "1.18.0",
+  "version": "1.18.2",
   "author": "Appium Contributors",
   "license": "Apache-2.0",
   "repository": {