appium-webdriveragent 4.10.24 → 4.11.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+## [4.11.0](https://github.com/appium/WebDriverAgent/compare/v4.10.24...v4.11.0) (2023-02-19)
+
+
+### Features
+
+* Add openUrl handler available since Xcode 14.3 ([#661](https://github.com/appium/WebDriverAgent/issues/661)) ([bee564e](https://github.com/appium/WebDriverAgent/commit/bee564e8c6b975aff07fd1244583f0727a0f5470))
+
 ## [4.10.24](https://github.com/appium/WebDriverAgent/compare/v4.10.23...v4.10.24) (2023-02-17)
 
 

package/PrivateHeaders/XCTest/XCTRunnerDaemonSession.h

@@ -67,4 +67,8 @@
 - (void)_reportInvalidation;
 - (id)initWithConnection:(id)arg1;
 
+// Since Xcode 14.3
+- (void)openURL:(NSURL *)arg1 usingApplication:(NSString *)arg2 completion:(void (^)(_Bool, NSError *))arg3;
+- (void)openDefaultApplicationForURL:(NSURL *)arg1 completion:(void (^)(_Bool, NSError *))arg2;
+
 @end

package/WebDriverAgent.xcodeproj/project.pbxproj

@@ -3666,6 +3666,7 @@
 					"-Wno-objc-messaging-id",
 					"-Wno-direct-ivar-access",
 					"-Wno-cast-qual",
+					"-Wno-declaration-after-statement",
 				);
 			};
 			name = Debug;
@@ -3728,6 +3729,7 @@
 					"-Wno-objc-messaging-id",
 					"-Wno-direct-ivar-access",
 					"-Wno-cast-qual",
+					"-Wno-declaration-after-statement",
 				);
 			};
 			name = Release;
@@ -3974,6 +3976,7 @@
 					"-Wno-objc-messaging-id",
 					"-Wno-direct-ivar-access",
 					"-Wno-cast-qual",
+					"-Wno-declaration-after-statement",
 				);
 			};
 			name = Debug;
@@ -4033,6 +4036,7 @@
 					"-Wno-objc-messaging-id",
 					"-Wno-direct-ivar-access",
 					"-Wno-cast-qual",
+					"-Wno-declaration-after-statement",
 				);
 			};
 			name = Release;

package/WebDriverAgentLib/Categories/XCUIDevice+FBHelpers.h

@@ -71,8 +71,9 @@ typedef NS_ENUM(NSUInteger, FBUIInterfaceAppearance) {
 - (nullable NSString *)fb_wifiIPAddress;
 
 /**
- Opens the particular url scheme using Siri voice recognition helpers.
- This will only work since XCode 8.3/iOS 10.3
+ Opens the particular url scheme using the default application assigned to it.
+ This API only works since XCode 14.3/iOS 16.4
+ Older Xcode/iOS version try to use Siri fallback.
  
  @param url The url scheme represented as a string, for example https://apple.com
  @param error If there is an error, upon return contains an NSError object that describes the problem.
@@ -80,6 +81,17 @@ typedef NS_ENUM(NSUInteger, FBUIInterfaceAppearance) {
  */
 - (BOOL)fb_openUrl:(NSString *)url error:(NSError **)error;
 
+/**
+ Opens the particular url scheme using the given application
+ This API only works since XCode 14.3/iOS 16.4
+
+ @param url The url scheme represented as a string, for example https://apple.com
+ @param bundleId The bundle identifier of an application to use in order to open the given URL
+ @param error If there is an error, upon return contains an NSError object that describes the problem.
+ @return YES if the operation was successful
+ */
+- (BOOL)fb_openUrl:(NSString *)url withApplication:(NSString *)bundleId error:(NSError **)error;
+
 /**
  Presses the corresponding hardware button on the device with duration.
 

package/WebDriverAgentLib/Categories/XCUIDevice+FBHelpers.m

@@ -21,6 +21,7 @@
 #import "FBScreenshot.h"
 #import "FBXCDeviceEvent.h"
 #import "FBXCodeCompatibility.h"
+#import "FBXCTestDaemonsProxy.h"
 #import "XCUIDevice.h"
 
 static const NSTimeInterval FBHomeButtonCoolOffTime = 1.;
@@ -157,20 +158,38 @@ static bool fb_isLocked;
             buildError:error];
   }
 
+  NSError *err;
+  if ([FBXCTestDaemonsProxy openDefaultApplicationForURL:parsedUrl error:&err]) {
+    return YES;
+  }
+  if (![err.description containsString:@"does not support"]) {
+    if (error) {
+      *error = err;
+    }
+    return NO;
+  }
+
   id siriService = [self valueForKey:@"siriService"];
   if (nil != siriService) {
     return [self fb_activateSiriVoiceRecognitionWithText:[NSString stringWithFormat:@"Open {%@}", url] error:error];
   }
-#pragma clang diagnostic push
-#pragma clang diagnostic ignored "-Wdeprecated-declarations"
-  // The link never gets opened by this method: https://forums.developer.apple.com/thread/25355
-  if (![[UIApplication sharedApplication] openURL:parsedUrl]) {
-#pragma clang diagnostic pop
+
+  NSString *description = [NSString stringWithFormat:@"Cannot open '%@' with the default application assigned for it. Consider upgrading to Xcode 14.3+/iOS 16.4+", url];
+  return [[[FBErrorBuilder builder]
+           withDescriptionFormat:@"%@", description]
+          buildError:error];;
+}
+
+- (BOOL)fb_openUrl:(NSString *)url withApplication:(NSString *)bundleId error:(NSError **)error
+{
+  NSURL *parsedUrl = [NSURL URLWithString:url];
+  if (nil == parsedUrl) {
     return [[[FBErrorBuilder builder]
-             withDescriptionFormat:@"The URL %@ cannot be opened", url]
+             withDescriptionFormat:@"'%@' is not a valid URL", url]
             buildError:error];
   }
-  return YES;
+
+  return [FBXCTestDaemonsProxy openURL:parsedUrl usingApplication:bundleId error:error];
 }
 
 - (BOOL)fb_activateSiriVoiceRecognitionWithText:(NSString *)text error:(NSError **)error

package/WebDriverAgentLib/Commands/FBSessionCommands.m

@@ -66,9 +66,16 @@
   if (!urlString) {
     return FBResponseWithStatus([FBCommandStatus invalidArgumentErrorWithMessage:@"URL is required" traceback:nil]);
   }
+  NSString* bundleId = request.arguments[@"bundleId"];
   NSError *error;
-  if (![XCUIDevice.sharedDevice fb_openUrl:urlString error:&error]) {
-    return FBResponseWithUnknownError(error);
+  if (nil == bundleId) {
+    if (![XCUIDevice.sharedDevice fb_openUrl:urlString error:&error]) {
+      return FBResponseWithUnknownError(error);
+    }
+  } else {
+    if (![XCUIDevice.sharedDevice fb_openUrl:urlString withApplication:bundleId error:&error]) {
+      return FBResponseWithUnknownError(error);
+    }
   }
   return FBResponseWithOK();
 }

package/WebDriverAgentLib/Routing/FBResponsePayload.m

@@ -24,7 +24,7 @@
 
 NSString *arbitraryAttrPrefix = @"attribute/";
 
-id<FBResponsePayload> FBResponseWithOK()
+id<FBResponsePayload> FBResponseWithOK(void)
 {
   return FBResponseWithStatus(FBCommandStatus.ok);
 }

package/WebDriverAgentLib/Utilities/FBClassChainQueryParser.m

@@ -502,7 +502,9 @@ static NSNumberFormatter *numberFormatter = nil;
   return [[FBErrorBuilder.builder withDescription:fullDescription] build];
 }
 
-+ (nullable FBClassChain*)compiledQueryWithTokenizedQuery:(NSArray<FBBaseClassChainToken *> *)tokenizedQuery originalQuery:(NSString *)originalQuery error:(NSError **)error
++ (nullable FBClassChain*)compiledQueryWithTokenizedQuery:(NSArray<FBBaseClassChainToken *> *)tokenizedQuery
+                                            originalQuery:(NSString *)originalQuery
+                                                    error:(NSError **)error
 {
   NSMutableArray *result = [NSMutableArray array];
   XCUIElementType chainElementType = XCUIElementTypeAny;
@@ -514,8 +516,10 @@ static NSNumberFormatter *numberFormatter = nil;
   for (FBBaseClassChainToken *token in tokenizedQuery) {
     if ([token isKindOfClass:FBClassNameToken.class]) {
       if (isTypeSet) {
-        NSString *description = [NSString stringWithFormat:@"Unexpected token '%@'. The type name can be set only once.", token.asString];
-        *error = [self.class compilationErrorWithQuery:originalQuery description:description];
+        if (error) {
+          NSString *description = [NSString stringWithFormat:@"Unexpected token '%@'. The type name can be set only once.", token.asString];
+          *error = [self.class compilationErrorWithQuery:originalQuery description:description];
+        }
         return nil;
       }
       @try {
@@ -523,16 +527,20 @@ static NSNumberFormatter *numberFormatter = nil;
         isTypeSet = YES;
       } @catch (NSException *e) {
         if ([e.name isEqualToString:FBInvalidArgumentException]) {
-          NSString *description = [NSString stringWithFormat:@"'%@' class name is unknown to WDA", token.asString];
-          *error = [self.class compilationErrorWithQuery:originalQuery description:description];
+          if (error) {
+            NSString *description = [NSString stringWithFormat:@"'%@' class name is unknown to WDA", token.asString];
+            *error = [self.class compilationErrorWithQuery:originalQuery description:description];
+          }
           return nil;
         }
         @throw e;
       }
     } else if ([token isKindOfClass:FBStarToken.class]) {
       if (isTypeSet) {
-        NSString *description = [NSString stringWithFormat:@"Unexpected token '%@'. The type name can be set only once.", token.asString];
-        *error = [self.class compilationErrorWithQuery:originalQuery description:description];
+        if (error) {
+          NSString *description = [NSString stringWithFormat:@"Unexpected token '%@'. The type name can be set only once.", token.asString];
+          *error = [self.class compilationErrorWithQuery:originalQuery description:description];
+        }
         return nil;
       }
       chainElementType = XCUIElementTypeAny;
@@ -540,7 +548,9 @@ static NSNumberFormatter *numberFormatter = nil;
     } else if ([token isKindOfClass:FBDescendantMarkerToken.class]) {
       if (isDescendantSet) {
         NSString *description = [NSString stringWithFormat:@"Unexpected token '%@'. Descendant markers cannot be duplicated.", token.asString];
-        *error = [self.class compilationErrorWithQuery:originalQuery description:description];
+        if (error) {
+          *error = [self.class compilationErrorWithQuery:originalQuery description:description];
+        }
         return nil;
       }
       isTypeSet = NO;
@@ -550,12 +560,16 @@ static NSNumberFormatter *numberFormatter = nil;
     } else if ([token isKindOfClass:FBAbstractPredicateToken.class]) {
       if (isPositionSet) {
         NSString *description = [NSString stringWithFormat:@"Predicate value '%@' must be set before position value.", token.asString];
-        *error = [self.class compilationErrorWithQuery:originalQuery description:description];
+        if (error) {
+          *error = [self.class compilationErrorWithQuery:originalQuery description:description];
+        }
         return nil;
       }
       if (!((FBAbstractPredicateToken *)token).isParsingCompleted) {
         NSString *description = [NSString stringWithFormat:@"Cannot find the end of '%@' predicate value.", token.asString];
-        *error = [self.class compilationErrorWithQuery:originalQuery description:description];
+        if (error) {
+          *error = [self.class compilationErrorWithQuery:originalQuery description:description];
+        }
         return nil;
       }
       NSPredicate *value = [NSPredicate fb_snapshotBlockPredicateWithPredicate:[NSPredicate predicateWithFormat:token.asString]];
@@ -567,13 +581,17 @@ static NSNumberFormatter *numberFormatter = nil;
     } else if ([token isKindOfClass:FBNumberToken.class]) {
       if (isPositionSet) {
         NSString *description = [NSString stringWithFormat:@"Position value '%@' is expected to be set only once.", token.asString];
-        *error = [self.class compilationErrorWithQuery:originalQuery description:description];
+        if (error) {
+          *error = [self.class compilationErrorWithQuery:originalQuery description:description];
+        }
         return nil;
       }
       NSNumber *position = [numberFormatter numberFromString:token.asString];
       if (nil == position || 0 == position.intValue) {
         NSString *description = [NSString stringWithFormat:@"Position value '%@' is expected to be a valid integer number not equal to zero.", token.asString];
-        *error = [self.class compilationErrorWithQuery:originalQuery description:description];
+        if (error) {
+          *error = [self.class compilationErrorWithQuery:originalQuery description:description];
+        }
         return nil;
       }
       chainElementPosition = position;
@@ -602,8 +620,10 @@ static NSNumberFormatter *numberFormatter = nil;
     if (isTypeSet) {
       [result addObject:[[FBClassChainItem alloc] initWithType:chainElementType position:chainElementPosition predicates:predicates.copy isDescendant:YES]];
     } else {
-      NSString *description = @"Descendants lookup modifier '**/' should be followed with the actual element type";
-      *error = [self.class compilationErrorWithQuery:originalQuery description:description];
+      if (error) {
+        NSString *description = @"Descendants lookup modifier '**/' should be followed with the actual element type";
+        *error = [self.class compilationErrorWithQuery:originalQuery description:description];
+      }
       return nil;
     }
   } else {

package/WebDriverAgentLib/Utilities/FBRuntimeUtils.m

@@ -47,7 +47,7 @@ void *FBRetrieveSymbolFromBinary(const char *binary, const char *name)
 
 static NSString *sdkVersion = nil;
 static dispatch_once_t onceSdkVersionToken;
-NSString * _Nullable FBSDKVersion()
+NSString * _Nullable FBSDKVersion(void)
 {
   dispatch_once(&onceSdkVersionToken, ^{
     NSString *sdkName = [[NSBundle mainBundle] infoDictionary][@"DTSDKName"];

package/WebDriverAgentLib/Utilities/FBXCTestDaemonsProxy.h

@@ -14,9 +14,6 @@ NS_ASSUME_NONNULL_BEGIN
 
 @protocol XCTestManager_ManagerInterface;
 
-/**
- Temporary class used to abstract interactions with TestManager daemon between Xcode 8.2.1 and Xcode 8.3-beta
- */
 @interface FBXCTestDaemonsProxy : NSObject
 
 + (id<XCTestManager_ManagerInterface>)testRunnerProxy;
@@ -28,6 +25,9 @@ NS_ASSUME_NONNULL_BEGIN
 + (BOOL)synthesizeEventWithRecord:(XCSynthesizedEventRecord *)record
                             error:(NSError *__autoreleasing*)error;
 
++ (BOOL)openURL:(NSURL *)url usingApplication:(NSString *)bundleId error:(NSError **)error;
++ (BOOL)openDefaultApplicationForURL:(NSURL *)url error:(NSError **)error;
+
 @end
 
 NS_ASSUME_NONNULL_END

package/WebDriverAgentLib/Utilities/FBXCTestDaemonsProxy.m

@@ -12,6 +12,7 @@
 #import <objc/runtime.h>
 
 #import "FBConfiguration.h"
+#import "FBErrorBuilder.h"
 #import "FBLogger.h"
 #import "FBRunLoopSpinner.h"
 #import "XCTestDriver.h"
@@ -96,4 +97,54 @@ static dispatch_once_t onceTestRunnerDaemonClass;
   return didSucceed;
 }
 
++ (BOOL)openURL:(NSURL *)url usingApplication:(NSString *)bundleId error:(NSError *__autoreleasing*)error
+{
+  XCTRunnerDaemonSession *session = [FBXCTRunnerDaemonSessionClass sharedSession];
+  if (![session respondsToSelector:@selector(openURL:usingApplication:completion:)]) {
+    if (error) {
+      [[[FBErrorBuilder builder]
+        withDescriptionFormat:@"The current Xcode SDK does not support opening of URLs with given application"]
+       buildError:error];
+    }
+    return NO;
+  }
+
+  __block BOOL didSucceed = NO;
+  [FBRunLoopSpinner spinUntilCompletion:^(void(^completion)(void)){
+    [session openURL:url usingApplication:bundleId completion:^(bool result, NSError *invokeError) {
+      if (error) {
+        *error = invokeError;
+      }
+      didSucceed = invokeError == nil && result;
+      completion();
+    }];
+  }];
+  return didSucceed;
+}
+
++ (BOOL)openDefaultApplicationForURL:(NSURL *)url error:(NSError *__autoreleasing*)error
+{
+  XCTRunnerDaemonSession *session = [FBXCTRunnerDaemonSessionClass sharedSession];
+  if (![session respondsToSelector:@selector(openDefaultApplicationForURL:completion:)]) {
+    if (error) {
+      [[[FBErrorBuilder builder]
+        withDescriptionFormat:@"The current Xcode SDK does not support opening of URLs. Consider upgrading to Xcode 14.3+/iOS 16.4+"]
+       buildError:error];
+    }
+    return NO;
+  }
+
+  __block BOOL didSucceed = NO;
+  [FBRunLoopSpinner spinUntilCompletion:^(void(^completion)(void)){
+    [session openDefaultApplicationForURL:url completion:^(bool result, NSError *invokeError) {
+      if (error) {
+        *error = invokeError;
+      }
+      didSucceed = invokeError == nil && result;
+      completion();
+    }];
+  }];
+  return didSucceed;
+}
+
 @end

package/WebDriverAgentTests/IntegrationTests/XCUIDeviceHelperTests.m

@@ -118,15 +118,32 @@
   XCTAssertNil(error);
 }
 
-- (void)disabled_testUrlSchemeActivation
+- (void)testUrlSchemeActivation
 {
-  // This test is not stable on CI because of system slowness
+  if (SYSTEM_VERSION_LESS_THAN(@"16.4")) {
+    return;
+  }
+
   NSError *error;
   XCTAssertTrue([XCUIDevice.sharedDevice fb_openUrl:@"https://apple.com" error:&error]);
   FBAssertWaitTillBecomesTrue([FBApplication.fb_activeApplication.bundleID isEqualToString:@"com.apple.mobilesafari"]);
   XCTAssertNil(error);
 }
 
+- (void)testUrlSchemeActivationWithApp
+{
+  if (SYSTEM_VERSION_LESS_THAN(@"16.4")) {
+    return;
+  }
+
+  NSError *error;
+  XCTAssertTrue([XCUIDevice.sharedDevice fb_openUrl:@"https://apple.com"
+                                    withApplication:@"com.apple.mobilesafari"
+                                              error:&error]);
+  FBAssertWaitTillBecomesTrue([FBApplication.fb_activeApplication.bundleID isEqualToString:@"com.apple.mobilesafari"]);
+  XCTAssertNil(error);
+}
+
 - (void)testPressingUnsupportedButton
 {
   NSError *error;

package/WebDriverAgentTests/UnitTests/FBXPathTests.m

@@ -29,7 +29,7 @@
   xmlTextWriterPtr writer = xmlNewTextWriterDoc(&doc, 0);
   NSMutableDictionary *elementStore = [NSMutableDictionary dictionary];
   int buffersize;
-  xmlChar *xmlbuff;
+  xmlChar *xmlbuff = NULL;
   int rc = xmlTextWriterStartDocument(writer, NULL, "UTF-8", NULL);
   if (rc >= 0) {
     rc = [FBXPath xmlRepresentationWithRootElement:element

package/package.json

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