appium-webdriveragent 5.1.6 → 5.2.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+## [5.2.0](https://github.com/appium/WebDriverAgent/compare/v5.1.6...v5.2.0) (2023-05-20)
+
+
+### Features
+
+* Replace non-encodable characters in the resulting JSON ([#713](https://github.com/appium/WebDriverAgent/issues/713)) ([cdfae40](https://github.com/appium/WebDriverAgent/commit/cdfae408be0bcf6607f0ca4462925eed2c300f5e))
+
 ## [5.1.6](https://github.com/appium/WebDriverAgent/compare/v5.1.5...v5.1.6) (2023-05-18)
 
 

package/WebDriverAgent.xcodeproj/project.pbxproj

@@ -399,6 +399,9 @@
 		716E0BCE1E917E810087A825 /* NSString+FBXMLSafeString.h in Headers */ = {isa = PBXBuildFile; fileRef = 716E0BCC1E917E810087A825 /* NSString+FBXMLSafeString.h */; };
 		716E0BCF1E917E810087A825 /* NSString+FBXMLSafeString.m in Sources */ = {isa = PBXBuildFile; fileRef = 716E0BCD1E917E810087A825 /* NSString+FBXMLSafeString.m */; };
 		716E0BD11E917F260087A825 /* FBXMLSafeStringTests.m in Sources */ = {isa = PBXBuildFile; fileRef = 716E0BD01E917F260087A825 /* FBXMLSafeStringTests.m */; };
+		716F0DA12A16CA1000CDD977 /* NSDictionary+FBUtf8SafeDictionary.h in Headers */ = {isa = PBXBuildFile; fileRef = 716F0D9F2A16CA1000CDD977 /* NSDictionary+FBUtf8SafeDictionary.h */; };
+		716F0DA32A16CA1000CDD977 /* NSDictionary+FBUtf8SafeDictionary.m in Sources */ = {isa = PBXBuildFile; fileRef = 716F0DA02A16CA1000CDD977 /* NSDictionary+FBUtf8SafeDictionary.m */; };
+		716F0DA62A17323300CDD977 /* NSDictionaryFBUtf8SafeTests.m in Sources */ = {isa = PBXBuildFile; fileRef = 716F0DA52A17323300CDD977 /* NSDictionaryFBUtf8SafeTests.m */; };
 		718226CA2587443700661B83 /* GCDAsyncUdpSocket.h in Headers */ = {isa = PBXBuildFile; fileRef = 718226C62587443600661B83 /* GCDAsyncUdpSocket.h */; };
 		718226CB2587443700661B83 /* GCDAsyncUdpSocket.h in Headers */ = {isa = PBXBuildFile; fileRef = 718226C62587443600661B83 /* GCDAsyncUdpSocket.h */; };
 		718226CC2587443700661B83 /* GCDAsyncSocket.h in Headers */ = {isa = PBXBuildFile; fileRef = 718226C72587443600661B83 /* GCDAsyncSocket.h */; };
@@ -1004,6 +1007,9 @@
 		716E0BCC1E917E810087A825 /* NSString+FBXMLSafeString.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = "NSString+FBXMLSafeString.h"; sourceTree = "<group>"; };
 		716E0BCD1E917E810087A825 /* NSString+FBXMLSafeString.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = "NSString+FBXMLSafeString.m"; sourceTree = "<group>"; };
 		716E0BD01E917F260087A825 /* FBXMLSafeStringTests.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = FBXMLSafeStringTests.m; sourceTree = "<group>"; };
+		716F0D9F2A16CA1000CDD977 /* NSDictionary+FBUtf8SafeDictionary.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = "NSDictionary+FBUtf8SafeDictionary.h"; sourceTree = "<group>"; };
+		716F0DA02A16CA1000CDD977 /* NSDictionary+FBUtf8SafeDictionary.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = "NSDictionary+FBUtf8SafeDictionary.m"; sourceTree = "<group>"; };
+		716F0DA52A17323300CDD977 /* NSDictionaryFBUtf8SafeTests.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = NSDictionaryFBUtf8SafeTests.m; sourceTree = "<group>"; };
 		717C0D702518ED2800CAA6EC /* TVOSSettings.xcconfig */ = {isa = PBXFileReference; lastKnownFileType = text.xcconfig; path = TVOSSettings.xcconfig; sourceTree = "<group>"; };
 		717C0D862518ED7000CAA6EC /* TVOSTestSettings.xcconfig */ = {isa = PBXFileReference; lastKnownFileType = text.xcconfig; path = TVOSTestSettings.xcconfig; sourceTree = "<group>"; };
 		718226C62587443600661B83 /* GCDAsyncUdpSocket.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = GCDAsyncUdpSocket.h; path = WebDriverAgentLib/Vendor/CocoaAsyncSocket/GCDAsyncUdpSocket.h; sourceTree = SOURCE_ROOT; };
@@ -1701,6 +1707,8 @@
 		EE9AB73E1CAEDF0C008C271F /* Categories */ = {
 			isa = PBXGroup;
 			children = (
+				716F0D9F2A16CA1000CDD977 /* NSDictionary+FBUtf8SafeDictionary.h */,
+				716F0DA02A16CA1000CDD977 /* NSDictionary+FBUtf8SafeDictionary.m */,
 				71555A3B1DEC460A007D4A8B /* NSExpression+FBFormat.h */,
 				71555A3C1DEC460A007D4A8B /* NSExpression+FBFormat.m */,
 				71A224E31DE2F56600844D55 /* NSPredicate+FBFormat.h */,
@@ -2022,6 +2030,7 @@
 				716E0BD01E917F260087A825 /* FBXMLSafeStringTests.m */,
 				712A0C841DA3E459007D02E5 /* FBXPathTests.m */,
 				EE9B76581CF7987300275851 /* Info.plist */,
+				716F0DA52A17323300CDD977 /* NSDictionaryFBUtf8SafeTests.m */,
 				7139145B1DF01A12005896C2 /* NSExpressionFBFormatTests.m */,
 				71A224E71DE326C500844D55 /* NSPredicateFBFormatTests.m */,
 				713914591DF01989005896C2 /* XCUIElementHelpersTests.m */,
@@ -2405,6 +2414,7 @@
 				641EE6C02240C5CA00173FCB /* XCUIApplication+FBHelpers.h in Headers */,
 				641EE6C12240C5CA00173FCB /* _XCTestObservationCenterImplementation.h in Headers */,
 				714EAA0E2673FDFE005C5B47 /* FBCapabilities.h in Headers */,
+				716F0DA22A16CA1000CDD977 /* NSDictionary+FBUtf8SafeDictionary.h in Headers */,
 				641EE6C22240C5CA00173FCB /* XCUIDevice+FBHelpers.h in Headers */,
 				71D3B3D6267FC7260076473D /* XCUIElement+FBResolve.h in Headers */,
 				641EE6C32240C5CA00173FCB /* FBClassChainQueryParser.h in Headers */,
@@ -2594,6 +2604,7 @@
 				EE35AD271E3B77D600A02D78 /* XCApplicationMonitor.h in Headers */,
 				EE8DDD7F20C5733C004D4925 /* XCUIElement+FBForceTouch.h in Headers */,
 				71A5C67329A4F39600421C37 /* XCTIssue+FBPatcher.h in Headers */,
+				716F0DA12A16CA1000CDD977 /* NSDictionary+FBUtf8SafeDictionary.h in Headers */,
 				EE158AEA1CBD456F00A3E3F0 /* FBRuntimeUtils.h in Headers */,
 				7136A4791E8918E60024FC3D /* XCUIElement+FBPickerWheel.h in Headers */,
 				E444DCB324913C220060D7EB /* RoutingHTTPServer.h in Headers */,
@@ -3106,6 +3117,7 @@
 				641EE5FF2240C5CA00173FCB /* XCUIElement+FBForceTouch.m in Sources */,
 				716C9E0327315EFF005AD475 /* XCUIApplication+FBUIInterruptions.m in Sources */,
 				641EE6002240C5CA00173FCB /* FBTouchActionCommands.m in Sources */,
+				716F0DA42A16CA1000CDD977 /* NSDictionary+FBUtf8SafeDictionary.m in Sources */,
 				719DCF182601EAFB000E765F /* FBNotificationsHelper.m in Sources */,
 				714EAA102673FDFE005C5B47 /* FBCapabilities.m in Sources */,
 				641EE6012240C5CA00173FCB /* FBImageIOScaler.m in Sources */,
@@ -3160,6 +3172,7 @@
 			buildActionMask = 2147483647;
 			files = (
 				64B26508228C5514002A5025 /* XCUIElementDouble.m in Sources */,
+				716F0DA72A17323300CDD977 /* NSDictionaryFBUtf8SafeTests.m in Sources */,
 				64B26504228C5299002A5025 /* FBTVNavigationTrackerTests.m in Sources */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;
@@ -3229,6 +3242,7 @@
 				716E0BCF1E917E810087A825 /* NSString+FBXMLSafeString.m in Sources */,
 				EE158ACD1CBD456F00A3E3F0 /* FBUnknownCommands.m in Sources */,
 				EE158AC51CBD456F00A3E3F0 /* FBOrientationCommands.m in Sources */,
+				716F0DA32A16CA1000CDD977 /* NSDictionary+FBUtf8SafeDictionary.m in Sources */,
 				71D475C42538F5A8008D9401 /* XCUIApplicationProcess+FBQuiescence.m in Sources */,
 				641EE7082240CDEB00173FCB /* XCUIElement+FBTVFocuse.m in Sources */,
 				71E75E6F254824230099FC87 /* XCUIElementQuery+FBHelpers.m in Sources */,
@@ -3346,6 +3360,7 @@
 				7139145C1DF01A12005896C2 /* NSExpressionFBFormatTests.m in Sources */,
 				71A224E81DE326C500844D55 /* NSPredicateFBFormatTests.m in Sources */,
 				EE6A892B1D0B25820083E92B /* FBApplicationDouble.m in Sources */,
+				716F0DA62A17323300CDD977 /* NSDictionaryFBUtf8SafeTests.m in Sources */,
 				EE6A892D1D0B2AF40083E92B /* FBErrorBuilderTests.m in Sources */,
 				712A0C851DA3E459007D02E5 /* FBXPathTests.m in Sources */,
 				ADBC39981D07842800327304 /* XCUIElementDouble.m in Sources */,

package/WebDriverAgentLib/Categories/NSDictionary+FBUtf8SafeDictionary.h

@@ -0,0 +1,40 @@
+/**
+ * Copyright (c) 2015-present, Facebook, Inc.
+ * All rights reserved.
+ *
+ * This source code is licensed under the BSD-style license found in the
+ * LICENSE file in the root directory of this source tree. An additional grant
+ * of patent rights can be found in the PATENTS file in the same directory.
+ */
+
+#import <Foundation/Foundation.h>
+
+NS_ASSUME_NONNULL_BEGIN
+
+@interface NSString (FBUtf8SafeString)
+
+/**
+ Converts the string, so it could be properly represented in UTF-8 encoding. All non-encodable characters are replaced with
+ the given `replacement`
+
+ @param replacement The character to use a a replacement for the lossy encoding
+ @returns Either the same string or a string with non-encodable chars replaced
+ */
+- (instancetype)fb_utf8SafeStringWithReplacement:(unichar)replacement;
+
+@end
+
+@interface NSDictionary (FBUtf8SafeDictionary)
+
+/**
+ Converts the dictionary, so it could be properly represented in UTF-8 encoding. All non-encodable characters
+ in string values are replaced with the Unocde question mark characters. Nested dictionaries and arrays are
+ processed recursively.
+
+ @returns Either the same dictionary or a dictionary with non-encodable chars in string values replaced
+ */
+- (instancetype)fb_utf8SafeDictionary;
+
+@end
+
+NS_ASSUME_NONNULL_END

package/WebDriverAgentLib/Categories/NSDictionary+FBUtf8SafeDictionary.m

@@ -0,0 +1,88 @@
+/**
+ * Copyright (c) 2015-present, Facebook, Inc.
+ * All rights reserved.
+ *
+ * This source code is licensed under the BSD-style license found in the
+ * LICENSE file in the root directory of this source tree. An additional grant
+ * of patent rights can be found in the PATENTS file in the same directory.
+ */
+
+#import "NSDictionary+FBUtf8SafeDictionary.h"
+
+const unichar REPLACER = 0xfffd;
+
+@implementation NSString (FBUtf8SafeString)
+
+- (instancetype)fb_utf8SafeStringWithReplacement:(unichar)replacement
+{
+  if ([self canBeConvertedToEncoding:NSUTF8StringEncoding]) {
+    return self;
+  }
+
+  NSData *data = [self dataUsingEncoding:NSUTF8StringEncoding allowLossyConversion:YES];
+  NSString *convertedString = [[NSString alloc] initWithData:data encoding:NSUTF8StringEncoding];
+  NSMutableString *result = [NSMutableString string];
+  NSString *replacementStr = [NSString stringWithCharacters:&replacement length:1];
+  NSUInteger originalIdx = 0;
+  NSUInteger convertedIdx = 0;
+  while (originalIdx < [self length] && convertedIdx < [convertedString length]) {
+    unichar originalChar = [self characterAtIndex:originalIdx];
+    unichar convertedChar = [convertedString characterAtIndex:convertedIdx];
+
+    if (originalChar == convertedChar) {
+      [result appendString:[NSString stringWithCharacters:&originalChar length:1]];
+      originalIdx++;
+      convertedIdx++;
+      continue;
+    }
+
+    while (originalChar != convertedChar && originalIdx < [self length]) {
+      [result appendString:replacementStr];
+      originalChar = [self characterAtIndex:++originalIdx];
+    }
+  }
+  return result.copy;
+}
+
+@end
+
+@implementation NSArray (FBUtf8SafeArray)
+
+- (instancetype)fb_utf8SafeArray
+{
+  NSMutableArray *result = [NSMutableArray array];
+  for (id item in self) {
+    if ([item isKindOfClass:NSString.class]) {
+      [result addObject:[(NSString *)item fb_utf8SafeStringWithReplacement:REPLACER]];
+    } else if ([item isKindOfClass:NSDictionary.class]) {
+      [result addObject:[(NSDictionary *)item fb_utf8SafeDictionary]];
+    } else if ([item isKindOfClass:NSArray.class]) {
+      [result addObject:[(NSArray *)item fb_utf8SafeArray]];
+    } else {
+      [result addObject:item];
+    }
+  }
+  return result.copy;
+}
+
+@end
+
+@implementation NSDictionary (FBUtf8SafeDictionary)
+
+- (instancetype)fb_utf8SafeDictionary
+{
+  NSMutableDictionary *result = [self mutableCopy];
+  for (id key in self) {
+    id value = result[key];
+    if ([value isKindOfClass:NSString.class]) {
+      result[key] = [(NSString *)value fb_utf8SafeStringWithReplacement:REPLACER];
+    } else if ([value isKindOfClass:NSArray.class]) {
+      result[key] = [(NSArray *)value fb_utf8SafeArray];
+    } else if ([value isKindOfClass:NSDictionary.class]) {
+      result[key] = [(NSDictionary *)value fb_utf8SafeDictionary];
+    }
+  }
+  return result.copy;
+}
+
+@end

package/WebDriverAgentLib/Routing/FBResponseJSONPayload.m

@@ -9,6 +9,8 @@
 
 #import "FBResponseJSONPayload.h"
 
+#import "FBLogger.h"
+#import "NSDictionary+FBUtf8SafeDictionary.h"
 #import "RouteResponse.h"
 
 @interface FBResponseJSONPayload ()
@@ -43,6 +45,13 @@
                                                      options:NSJSONWritingPrettyPrinted
                                                        error:&error];
   NSCAssert(jsonData, @"Valid JSON must be responded, error of %@", error);
+  if (nil == [[NSString alloc] initWithData:jsonData encoding:NSUTF8StringEncoding]) {
+    [FBLogger log:@"The incoming data cannot be encoded to UTF-8 JSON. Applying lossy conversion as a workaround."];
+    jsonData = [NSJSONSerialization dataWithJSONObject:[self.dictionary fb_utf8SafeDictionary]
+                                               options:NSJSONWritingPrettyPrinted
+                                                 error:&error];
+  }
+  NSCAssert(jsonData, @"Valid JSON must be responded, error of %@", error);
   [response setHeader:@"Content-Type" value:@"application/json;charset=UTF-8"];
   [response setStatusCode:self.httpStatusCode];
   [response respondWithData:jsonData];

package/WebDriverAgentTests/IntegrationTests/FBScrollingTests.m

@@ -49,6 +49,11 @@
 
 - (void)testSimpleScroll
 {
+  if (SYSTEM_VERSION_LESS_THAN(@"16.0")) {
+    // This test is unstable in CI env
+    return;
+  }
+
   FBAssertVisibleCell(@"0");
   FBAssertVisibleCell(@"10");
   [self.scrollView fb_scrollDownByNormalizedDistance:1.0];
@@ -82,6 +87,11 @@
 
 - (void)testNativeFarScrollToVisible
 {
+  if (SYSTEM_VERSION_LESS_THAN(@"16.0")) {
+    // This test is unstable in CI env
+    return;
+  }
+
   NSString *cellName = @"80";
   NSError *error;
   FBAssertInvisibleCell(cellName);
@@ -100,6 +110,12 @@
   [element fb_scrollToVisibleWithError:&error];
   XCTAssertNil(error);
   XCTAssertTrue(element.fb_isVisible);
+  
+  if (SYSTEM_VERSION_LESS_THAN(@"16.0")) {
+    // This test is unstable in CI env
+    return;
+  }
+
   [element tap];
   XCTAssertTrue(element.wdSelected);
 }

package/WebDriverAgentTests/UnitTests/NSDictionaryFBUtf8SafeTests.m

@@ -0,0 +1,35 @@
+/**
+ * Copyright (c) 2015-present, Facebook, Inc.
+ * All rights reserved.
+ *
+ * This source code is licensed under the BSD-style license found in the
+ * LICENSE file in the root directory of this source tree. An additional grant
+ * of patent rights can be found in the PATENTS file in the same directory.
+ */
+
+#import <XCTest/XCTest.h>
+
+#import "NSDictionary+FBUtf8SafeDictionary.h"
+
+@interface NSDictionaryFBUtf8SafeTests : XCTestCase
+@end
+
+@implementation NSDictionaryFBUtf8SafeTests
+
+- (void)testEmptySafeDictConversion
+{
+  NSDictionary *d = @{};
+  XCTAssertEqualObjects(d, d.fb_utf8SafeDictionary);
+}
+
+- (void)testNonEmptySafeDictConversion
+{
+  NSDictionary *d = @{
+    @"1": @[@3, @4],
+    @"5": @{@"6": @7, @"8": @9},
+    @"10": @"11"
+  };
+  XCTAssertEqualObjects(d, d.fb_utf8SafeDictionary);
+}
+
+@end

package/package.json

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