appium-webdriveragent 5.1.2 → 5.1.4

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+## [5.1.4](https://github.com/appium/WebDriverAgent/compare/v5.1.3...v5.1.4) (2023-05-16)
+
+
+### Bug Fixes
+
+* Prevent freeze on launch/activate of a missing app ([#706](https://github.com/appium/WebDriverAgent/issues/706)) ([c4976e3](https://github.com/appium/WebDriverAgent/commit/c4976e3e99afa4d471bd39c3dccfc7d9f58d8bfc))
+
+## [5.1.3](https://github.com/appium/WebDriverAgent/compare/v5.1.2...v5.1.3) (2023-05-16)
+
+
+### Bug Fixes
+
+* Revert "fix: Assert app is installed before launching or activating it ([#704](https://github.com/appium/WebDriverAgent/issues/704))" ([#705](https://github.com/appium/WebDriverAgent/issues/705)) ([00baeb2](https://github.com/appium/WebDriverAgent/commit/00baeb2045b9aac98d27fe2e96cedce0dde5e8be))
+
 ## [5.1.2](https://github.com/appium/WebDriverAgent/compare/v5.1.1...v5.1.2) (2023-05-15)
 
 

package/PrivateHeaders/XCTest/XCTRunnerDaemonSession.h

@@ -80,4 +80,11 @@
 @property(readonly) _Bool supportsLocationSimulation;
 #endif
 
+// Since Xcode 10.2
+- (void)launchApplicationWithPath:(NSString *)arg1
+                         bundleID:(NSString *)arg2
+                        arguments:(NSArray *)arg3
+                      environment:(NSDictionary *)arg4
+                       completion:(void (^)(_Bool, NSError *))arg5;
+
 @end

package/WebDriverAgentLib/FBApplication.h

@@ -44,16 +44,6 @@ NS_ASSUME_NONNULL_BEGIN
  */
 + (BOOL)fb_switchToSystemApplicationWithError:(NSError **)error;
 
-/**
- Returns the bundle indentifier of the system app (ususally Springboard)
- */
-+ (NSString *)fb_systemApplicationBundleID;
-
-/**
- Checks if the app is installed on the device under test.
- */
-- (BOOL)fb_isInstalled;
-
 @end
 
 NS_ASSUME_NONNULL_END

package/WebDriverAgentLib/FBApplication.m

@@ -9,7 +9,6 @@
 
 #import "FBApplication.h"
 
-#import "FBExceptions.h"
 #import "FBXCAccessibilityElement.h"
 #import "FBLogger.h"
 #import "FBRunLoopSpinner.h"
@@ -17,7 +16,6 @@
 #import "FBActiveAppDetectionPoint.h"
 #import "FBXCodeCompatibility.h"
 #import "FBXCTestDaemonsProxy.h"
-#import "LSApplicationWorkspace.h"
 #import "XCUIApplication.h"
 #import "XCUIApplication+FBHelpers.h"
 #import "XCUIApplicationImpl.h"
@@ -135,16 +133,6 @@ static const NSTimeInterval APP_STATE_CHANGE_TIMEOUT = 5.0;
    [[FBXCAXClientProxy.sharedClient systemApplication] processIdentifier]];
 }
 
-+ (NSString *)fb_systemApplicationBundleID
-{
-  static dispatch_once_t onceToken;
-  static NSString *systemAppBundleID;
-  dispatch_once(&onceToken, ^{
-    systemAppBundleID = [[self.class fb_systemApplication] bundleID];
-  });
-  return systemAppBundleID;
-}
-
 + (instancetype)applicationWithPID:(pid_t)processID
 {
   if ([NSProcessInfo processInfo].processIdentifier == processID) {
@@ -153,33 +141,14 @@ static const NSTimeInterval APP_STATE_CHANGE_TIMEOUT = 5.0;
   return (FBApplication *)[FBXCAXClientProxy.sharedClient monitoredApplicationWithProcessIdentifier:processID];
 }
 
-/**
- https://github.com/appium/WebDriverAgent/issues/702
- */
-- (void)fb_assertInstalledByAction:(NSString *)action
-{
-  if (![self.bundleID isEqualToString:[self.class fb_systemApplicationBundleID]] && !self.fb_isInstalled) {
-    NSString *message = [NSString stringWithFormat:@"The application '%@' cannot be %@ because it is not installed on the device under test",
-                         self.bundleID, action];
-    [[NSException exceptionWithName:FBApplicationMissingException reason:message userInfo:nil] raise];
-  }
-}
-
 - (void)launch
 {
-  [self fb_assertInstalledByAction:@"launched"];
   [super launch];
   if (![self fb_waitForAppElement:APP_STATE_CHANGE_TIMEOUT]) {
     [FBLogger logFmt:@"The application '%@' is not running in foreground after %.2f seconds", self.bundleID, APP_STATE_CHANGE_TIMEOUT];
   }
 }
 
-- (void)activate
-{
-  [self fb_assertInstalledByAction:@"activated"];
-  [super activate];
-}
-
 - (void)terminate
 {
   [super terminate];
@@ -212,9 +181,4 @@ static const NSTimeInterval APP_STATE_CHANGE_TIMEOUT = 5.0;
           error:error];
 }
 
-- (BOOL)fb_isInstalled
-{
-  return [[LSApplicationWorkspace defaultWorkspace] applicationIsInstalled:self.bundleID];
-}
-
 @end

package/WebDriverAgentLib/Utilities/FBXCTestDaemonsProxy.m

@@ -13,6 +13,7 @@
 
 #import "FBConfiguration.h"
 #import "FBErrorBuilder.h"
+#import "FBExceptions.h"
 #import "FBLogger.h"
 #import "FBRunLoopSpinner.h"
 #import "XCTestDriver.h"
@@ -20,23 +21,61 @@
 #import "XCUIApplication.h"
 #import "XCUIDevice.h"
 
-@implementation FBXCTestDaemonsProxy
+#define LAUNCH_APP_TIMEOUT_SEC 300
+
+static void (*originalLaunchAppMethod)(id, SEL, NSString*, NSString*, NSArray*, NSDictionary*, void (^)(_Bool, NSError *));
 
-static Class FBXCTRunnerDaemonSessionClass = nil;
-static dispatch_once_t onceTestRunnerDaemonClass;
+static void swizzledLaunchApp(id self, SEL _cmd, NSString *path, NSString *bundleID,
+                              NSArray *arguments, NSDictionary *environment,
+                              void (^reply)(_Bool, NSError *))
+{
+  __block BOOL isSuccessful;
+  __block NSError *error;
+  dispatch_semaphore_t sem = dispatch_semaphore_create(0);
+  originalLaunchAppMethod(self, _cmd, path, bundleID, arguments, environment, ^(BOOL passed, NSError *innerError) {
+    isSuccessful = passed;
+    error = innerError;
+    dispatch_semaphore_signal(sem);
+  });
+  int64_t timeoutNs = (int64_t)(LAUNCH_APP_TIMEOUT_SEC * NSEC_PER_SEC);
+  if (0 != dispatch_semaphore_wait(sem, dispatch_time(DISPATCH_TIME_NOW, timeoutNs))) {
+    NSString *message = [NSString stringWithFormat:@"The application '%@' cannot be launched within %d seconds timeout",
+                         bundleID ?: path, LAUNCH_APP_TIMEOUT_SEC];
+    @throw [NSException exceptionWithName:FBTimeoutException reason:message userInfo:nil];
+  }
+  if (!isSuccessful || nil != error) {
+    [FBLogger logFmt:@"%@", error.description];
+    NSString *message = error.description ?: [NSString stringWithFormat:@"The application '%@' is not installed on the device under test",
+                         bundleID ?: path];
+    @throw [NSException exceptionWithName:FBApplicationMissingException reason:message userInfo:nil];
+  }
+  reply(isSuccessful, error);
+}
+
+@implementation FBXCTestDaemonsProxy
 
 #pragma clang diagnostic push
 #pragma clang diagnostic ignored "-Wobjc-load-method"
 
 + (void)load
 {
-  dispatch_once(&onceTestRunnerDaemonClass, ^{
-    FBXCTRunnerDaemonSessionClass = objc_lookUpClass("XCTRunnerDaemonSession");
-  });
+  [self.class swizzleLaunchApp];
 }
 
 #pragma clang diagnostic pop
 
++ (void)swizzleLaunchApp {
+  Method original = class_getInstanceMethod([XCTRunnerDaemonSession class],
+                                            @selector(launchApplicationWithPath:bundleID:arguments:environment:completion:));
+  if (original == nil) {
+    [FBLogger log:@"Could not find method -[XCTRunnerDaemonSession launchApplicationWithPath:]"];
+    return;
+  }
+  // Workaround for https://github.com/appium/WebDriverAgent/issues/702
+  originalLaunchAppMethod = (void(*)(id, SEL, NSString*, NSString*, NSArray*, NSDictionary*, void (^)(_Bool, NSError *))) method_getImplementation(original);
+  method_setImplementation(original, (IMP)swizzledLaunchApp);
+}
+
 + (id<XCTestManager_ManagerInterface>)testRunnerProxy
 {
   static id<XCTestManager_ManagerInterface> proxy = nil;
@@ -56,7 +95,7 @@ static dispatch_once_t onceTestRunnerDaemonClass;
 
 + (id<XCTestManager_ManagerInterface>)retrieveTestRunnerProxy
 {
-  return ((XCTRunnerDaemonSession *)[FBXCTRunnerDaemonSessionClass sharedSession]).daemonProxy;
+  return ((XCTRunnerDaemonSession *)[XCTRunnerDaemonSession sharedSession]).daemonProxy;
 }
 
 + (BOOL)synthesizeEventWithRecord:(XCSynthesizedEventRecord *)record error:(NSError *__autoreleasing*)error
@@ -70,24 +109,20 @@ static dispatch_once_t onceTestRunnerDaemonClass;
       didSucceed = (invokeError == nil);
       completion();
     };
-    
-    if (nil == FBXCTRunnerDaemonSessionClass) {
-      [[self testRunnerProxy] _XCT_synthesizeEvent:record completion:errorHandler];
-    } else {
-      XCEventGeneratorHandler handlerBlock = ^(XCSynthesizedEventRecord *innerRecord, NSError *invokeError) {
-        errorHandler(invokeError);
-      };
-      [[XCUIDevice.sharedDevice eventSynthesizer] synthesizeEvent:record completion:(id)^(BOOL result, NSError *invokeError) {
-        handlerBlock(record, invokeError);
-      }];
-    }
+
+    XCEventGeneratorHandler handlerBlock = ^(XCSynthesizedEventRecord *innerRecord, NSError *invokeError) {
+      errorHandler(invokeError);
+    };
+    [[XCUIDevice.sharedDevice eventSynthesizer] synthesizeEvent:record completion:(id)^(BOOL result, NSError *invokeError) {
+      handlerBlock(record, invokeError);
+    }];
   }];
   return didSucceed;
 }
 
 + (BOOL)openURL:(NSURL *)url usingApplication:(NSString *)bundleId error:(NSError *__autoreleasing*)error
 {
-  XCTRunnerDaemonSession *session = [FBXCTRunnerDaemonSessionClass sharedSession];
+  XCTRunnerDaemonSession *session = [XCTRunnerDaemonSession sharedSession];
   if (![session respondsToSelector:@selector(openURL:usingApplication:completion:)]) {
     if (error) {
       [[[FBErrorBuilder builder]
@@ -112,7 +147,7 @@ static dispatch_once_t onceTestRunnerDaemonClass;
 
 + (BOOL)openDefaultApplicationForURL:(NSURL *)url error:(NSError *__autoreleasing*)error
 {
-  XCTRunnerDaemonSession *session = [FBXCTRunnerDaemonSessionClass sharedSession];
+  XCTRunnerDaemonSession *session = [XCTRunnerDaemonSession sharedSession];
   if (![session respondsToSelector:@selector(openDefaultApplicationForURL:completion:)]) {
     if (error) {
       [[[FBErrorBuilder builder]
@@ -138,7 +173,7 @@ static dispatch_once_t onceTestRunnerDaemonClass;
 #if !TARGET_OS_TV
 + (BOOL)setSimulatedLocation:(CLLocation *)location error:(NSError *__autoreleasing*)error
 {
-  XCTRunnerDaemonSession *session = [FBXCTRunnerDaemonSessionClass sharedSession];
+  XCTRunnerDaemonSession *session = [XCTRunnerDaemonSession sharedSession];
   if (![session respondsToSelector:@selector(setSimulatedLocation:completion:)]) {
     if (error) {
       [[[FBErrorBuilder builder]
@@ -171,7 +206,7 @@ static dispatch_once_t onceTestRunnerDaemonClass;
 
 + (nullable CLLocation *)getSimulatedLocation:(NSError *__autoreleasing*)error;
 {
-  XCTRunnerDaemonSession *session = [FBXCTRunnerDaemonSessionClass sharedSession];
+  XCTRunnerDaemonSession *session = [XCTRunnerDaemonSession sharedSession];
   if (![session respondsToSelector:@selector(getSimulatedLocationWithReply:)]) {
     if (error) {
       [[[FBErrorBuilder builder]
@@ -206,7 +241,7 @@ static dispatch_once_t onceTestRunnerDaemonClass;
 
 + (BOOL)clearSimulatedLocation:(NSError *__autoreleasing*)error
 {
-  XCTRunnerDaemonSession *session = [FBXCTRunnerDaemonSessionClass sharedSession];
+  XCTRunnerDaemonSession *session = [XCTRunnerDaemonSession sharedSession];
   if (![session respondsToSelector:@selector(clearSimulatedLocationWithReply:)]) {
     if (error) {
       [[[FBErrorBuilder builder]

package/WebDriverAgentTests/IntegrationTests/FBSessionIntegrationTests.m

@@ -101,6 +101,13 @@ static NSString *const SETTINGS_BUNDLE_ID = @"com.apple.Preferences";
   FBAssertWaitTillBecomesTrue([self.session.activeApplication.bundleID isEqualToString:testedApp.bundleID]);
 }
 
+- (void)testLaunchUnattachedApp
+{
+  [FBUnattachedAppLauncher launchAppWithBundleId:SETTINGS_BUNDLE_ID];
+  [self.session kill];
+  XCTAssertEqualObjects(SETTINGS_BUNDLE_ID, FBApplication.fb_activeApplication.bundleID);
+}
+
 - (void)testAppWithInvalidBundleIDCannotBeStarted
 {
   FBApplication *testedApp = [[FBApplication alloc] initWithBundleIdentifier:@"yolo"];
@@ -123,17 +130,4 @@ static NSString *const SETTINGS_BUNDLE_ID = @"com.apple.Preferences";
   }
 }
 
-- (void)testAppWithInvalidBundleIDCannotBeTerminated
-{
-  FBApplication *testedApp = [[FBApplication alloc] initWithBundleIdentifier:@"yolo"];
-  [testedApp terminate];
-}
-
-- (void)testLaunchUnattachedApp
-{
-  [FBUnattachedAppLauncher launchAppWithBundleId:SETTINGS_BUNDLE_ID];
-  [self.session kill];
-  XCTAssertEqualObjects(SETTINGS_BUNDLE_ID, FBApplication.fb_activeApplication.bundleID);
-}
-
 @end

package/package.json

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