appium-webdriveragent 8.9.0 → 8.9.2

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+## [8.9.2](https://github.com/appium/WebDriverAgent/compare/v8.9.1...v8.9.2) (2024-09-13)
+
+### Miscellaneous Chores
+
+* **deps-dev:** bump sinon from 18.0.1 to 19.0.1 ([#938](https://github.com/appium/WebDriverAgent/issues/938)) ([3ef0093](https://github.com/appium/WebDriverAgent/commit/3ef009317801dca47efe34bd048d3cab2e644ee2))
+
+## [8.9.1](https://github.com/appium/WebDriverAgent/compare/v8.9.0...v8.9.1) (2024-08-09)
+
+### Bug Fixes
+
+* Update swizzling of waitForQuiescenceIncludingAnimationsIdle: API for Xcode16-beta5 ([#935](https://github.com/appium/WebDriverAgent/issues/935)) ([2ccc436](https://github.com/appium/WebDriverAgent/commit/2ccc436991ca880a1dfdec688dc8167008fe382d))
+
 ## [8.9.0](https://github.com/appium/WebDriverAgent/compare/v8.8.0...v8.9.0) (2024-08-07)
 
 ### Features

package/PrivateHeaders/XCTest/XCUIApplicationProcess.h

@@ -65,7 +65,11 @@
 - (void)terminate;
 - (void)waitForViewControllerViewDidDisappearWithTimeout:(double)arg1;
 - (void)waitForAutomationSession;
+// Before Xcode16-beta5
 - (void)waitForQuiescenceIncludingAnimationsIdle:(BOOL)arg1;
+// Since Xcode16-beta5
+- (void)waitForQuiescenceIncludingAnimationsIdle:(BOOL)arg1 isPreEvent:(BOOL)arg2;
+
 
 - (id)shortDescription;
 - (id)_queue_description;

package/WebDriverAgentLib/Categories/XCAXClient_iOS+FBSnapshotReqParams.m

@@ -65,6 +65,7 @@ static id swizzledSnapshotParameters(id self, SEL _cmd)
 
 #pragma clang diagnostic push
 #pragma clang diagnostic ignored "-Wobjc-load-method"
+#pragma clang diagnostic ignored "-Wcast-function-type-strict"
 
 + (void)load
 {

package/WebDriverAgentLib/Categories/XCTIssue+FBPatcher.m

@@ -20,6 +20,8 @@ static _Bool swizzledShouldInterruptTest(id self, SEL _cmd)
 
 #pragma clang diagnostic push
 #pragma clang diagnostic ignored "-Wobjc-load-method"
+#pragma clang diagnostic ignored "-Wcast-function-type-strict"
+
 + (void)load
 {
   SEL originalShouldInterruptTest = NSSelectorFromString(@"shouldInterruptTest");
@@ -28,6 +30,7 @@ static _Bool swizzledShouldInterruptTest(id self, SEL _cmd)
   if (nil == originalShouldInterruptTestMethod) return;
   method_setImplementation(originalShouldInterruptTestMethod, (IMP)swizzledShouldInterruptTest);
 }
+
 #pragma clang diagnostic pop
 
 @end

package/WebDriverAgentLib/Categories/XCUIApplicationProcess+FBQuiescence.h

@@ -18,6 +18,11 @@ NS_ASSUME_NONNULL_BEGIN
 /*! Defines wtether the process should perform quiescence checks. YES by default */
 @property (nonatomic) NSNumber* fb_shouldWaitForQuiescence;
 
+/**
+ @param waitForAnimations Set it to YES if XCTest should also wait for application animations to complete
+ */
+- (void)fb_waitForQuiescenceIncludingAnimationsIdle:(bool)waitForAnimations;
+
 @end
 
 NS_ASSUME_NONNULL_END

package/WebDriverAgentLib/Categories/XCUIApplicationProcess+FBQuiescence.m

@@ -12,10 +12,12 @@
 #import <objc/runtime.h>
 
 #import "FBConfiguration.h"
+#import "FBExceptions.h"
 #import "FBLogger.h"
 #import "FBSettings.h"
 
 static void (*original_waitForQuiescenceIncludingAnimationsIdle)(id, SEL, BOOL);
+static void (*original_waitForQuiescenceIncludingAnimationsIdlePreEvent)(id, SEL, BOOL, BOOL);
 
 static void swizzledWaitForQuiescenceIncludingAnimationsIdle(id self, SEL _cmd, BOOL includingAnimations)
 {
@@ -38,17 +40,43 @@ static void swizzledWaitForQuiescenceIncludingAnimationsIdle(id self, SEL _cmd,
   }
 }
 
+static void swizzledWaitForQuiescenceIncludingAnimationsIdlePreEvent(id self, SEL _cmd, BOOL includingAnimations, BOOL isPreEvent)
+{
+  NSString *bundleId = [self bundleID];
+  if (![[self fb_shouldWaitForQuiescence] boolValue] || FBConfiguration.waitForIdleTimeout < DBL_EPSILON) {
+    [FBLogger logFmt:@"Quiescence checks are disabled for %@ application. Making it to believe it is idling",
+     bundleId];
+    return;
+  }
+
+  NSTimeInterval desiredTimeout = FBConfiguration.waitForIdleTimeout;
+  NSTimeInterval previousTimeout = _XCTApplicationStateTimeout();
+  _XCTSetApplicationStateTimeout(desiredTimeout);
+  [FBLogger logFmt:@"Waiting up to %@s until %@ is in idle state (%@ animations)",
+   @(desiredTimeout), bundleId, includingAnimations ? @"including" : @"excluding"];
+  @try {
+    original_waitForQuiescenceIncludingAnimationsIdlePreEvent(self, _cmd, includingAnimations, isPreEvent);
+  } @finally {
+    _XCTSetApplicationStateTimeout(previousTimeout);
+  }
+}
+
 @implementation XCUIApplicationProcess (FBQuiescence)
 
 #pragma clang diagnostic push
 #pragma clang diagnostic ignored "-Wobjc-load-method"
+#pragma clang diagnostic ignored "-Wcast-function-type-strict"
 
 + (void)load
 {
   Method waitForQuiescenceIncludingAnimationsIdleMethod = class_getInstanceMethod(self.class, @selector(waitForQuiescenceIncludingAnimationsIdle:));
+  Method waitForQuiescenceIncludingAnimationsIdlePreEventMethod = class_getInstanceMethod(self.class, @selector(waitForQuiescenceIncludingAnimationsIdle:isPreEvent:));
   if (nil != waitForQuiescenceIncludingAnimationsIdleMethod) {
     IMP swizzledImp = (IMP)swizzledWaitForQuiescenceIncludingAnimationsIdle;
     original_waitForQuiescenceIncludingAnimationsIdle = (void (*)(id, SEL, BOOL)) method_setImplementation(waitForQuiescenceIncludingAnimationsIdleMethod, swizzledImp);
+  } else if (nil != waitForQuiescenceIncludingAnimationsIdlePreEventMethod) {
+    IMP swizzledImp = (IMP)swizzledWaitForQuiescenceIncludingAnimationsIdlePreEvent;
+    original_waitForQuiescenceIncludingAnimationsIdlePreEvent = (void (*)(id, SEL, BOOL, BOOL)) method_setImplementation(waitForQuiescenceIncludingAnimationsIdlePreEventMethod, swizzledImp);
   } else {
     [FBLogger log:@"Could not find method -[XCUIApplicationProcess waitForQuiescenceIncludingAnimationsIdle:]"];
   }
@@ -74,4 +102,18 @@ static char XCUIAPPLICATIONPROCESS_SHOULD_WAIT_FOR_QUIESCENCE;
   objc_setAssociatedObject(self, &XCUIAPPLICATIONPROCESS_SHOULD_WAIT_FOR_QUIESCENCE, value, OBJC_ASSOCIATION_RETAIN_NONATOMIC);
 }
 
+- (void)fb_waitForQuiescenceIncludingAnimationsIdle:(bool)waitForAnimations
+{
+  if ([self respondsToSelector:@selector(waitForQuiescenceIncludingAnimationsIdle:)]) {
+    [self waitForQuiescenceIncludingAnimationsIdle:waitForAnimations];
+  } else if ([self respondsToSelector:@selector(waitForQuiescenceIncludingAnimationsIdle:isPreEvent:)]) {
+    [self waitForQuiescenceIncludingAnimationsIdle:waitForAnimations isPreEvent:NO];
+  } else {
+    @throw [NSException exceptionWithName:FBIncompatibleWdaException
+                                   reason:@"The current WebDriverAgent build is not compatible to your device OS version"
+                                 userInfo:@{}];
+  }
+}
+
+
 @end

package/WebDriverAgentLib/Categories/XCUIElement+FBUID.m

@@ -42,6 +42,7 @@ static void swizzled_validatePredicateWithExpressionsAllowed(id self, SEL _cmd,
 
 #pragma clang diagnostic push
 #pragma clang diagnostic ignored "-Wobjc-load-method"
+#pragma clang diagnostic ignored "-Wcast-function-type-strict"
 + (void)load
 {
   Class XCElementSnapshotCls = objc_lookUpClass("XCElementSnapshot");

package/WebDriverAgentLib/Categories/XCUIElement+FBUtilities.m

@@ -31,6 +31,7 @@
 #import "XCTElementSetTransformer-Protocol.h"
 #import "XCTestPrivateSymbols.h"
 #import "XCTRunnerDaemonSession.h"
+#import "XCUIApplicationProcess+FBQuiescence.h"
 #import "XCUIElement+FBCaching.h"
 #import "XCUIElement+FBWebDriverAttributes.h"
 #import "XCUIElementQuery.h"
@@ -190,7 +191,7 @@
     self.application.fb_shouldWaitForQuiescence = YES;
   }
   [[[self.application applicationImpl] currentProcess]
-   waitForQuiescenceIncludingAnimationsIdle:YES];
+   fb_waitForQuiescenceIncludingAnimationsIdle:YES];
   if (previousQuiescence != self.application.fb_shouldWaitForQuiescence) {
     self.application.fb_shouldWaitForQuiescence = previousQuiescence;
   }

package/WebDriverAgentLib/Info.plist

@@ -15,11 +15,11 @@
     <key>CFBundlePackageType</key>
     <string>FMWK</string>
     <key>CFBundleShortVersionString</key>
-    <string>8.9.0</string>
+    <string>8.9.2</string>
     <key>CFBundleSignature</key>
     <string>????</string>
     <key>CFBundleVersion</key>
-    <string>8.9.0</string>
+    <string>8.9.2</string>
     <key>NSPrincipalClass</key>
     <string/>
   </dict>

package/WebDriverAgentLib/Routing/FBExceptions.h

@@ -55,4 +55,7 @@ extern NSString *const FBApplicationCrashedException;
 /*! Exception used to notify about the application is not installed  */
 extern NSString *const FBApplicationMissingException;
 
+/*! Exception used to notify about WDA incompatibility with the current platform version */
+extern NSString *const FBIncompatibleWdaException;
+
 NS_ASSUME_NONNULL_END

package/WebDriverAgentLib/Routing/FBExceptions.m

@@ -22,3 +22,4 @@ NSString *const FBXPathQueryEvaluationException = @"FBXPathQueryEvaluationExcept
 NSString *const FBClassChainQueryParseException = @"FBClassChainQueryParseException";
 NSString *const FBApplicationCrashedException = @"FBApplicationCrashedException";
 NSString *const FBApplicationMissingException = @"FBApplicationMissingException";
+NSString *const FBIncompatibleWdaException = @"FBIncompatibleWdaException";

package/WebDriverAgentLib/Routing/FBRoute.m

@@ -39,7 +39,10 @@ static NSString *const FBRouteSessionPrefix = @"/session/:sessionID";
 - (void)mountRequest:(FBRouteRequest *)request intoResponse:(RouteResponse *)response
 {
   [self decorateRequest:request];
+#pragma clang diagnostic push
+#pragma clang diagnostic ignored "-Wcast-function-type-strict"
   id<FBResponsePayload> (*requestMsgSend)(id, SEL, FBRouteRequest *) = ((id<FBResponsePayload>(*)(id, SEL, FBRouteRequest *))objc_msgSend);
+#pragma clang diagnostic pop
   id<FBResponsePayload> payload = requestMsgSend(self.target, self.action, request);
   [payload dispatchWithResponse:response];
 }

package/WebDriverAgentLib/Utilities/FBXCTestDaemonsProxy.m

@@ -73,9 +73,12 @@ static void swizzledLaunchApp(id self, SEL _cmd, NSString *path, NSString *bundl
     [FBLogger log:@"Could not find method -[XCTRunnerDaemonSession launchApplicationWithPath:]"];
     return;
   }
+#pragma clang diagnostic push
+#pragma clang diagnostic ignored "-Wcast-function-type-strict"
   // 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);
+#pragma clang diagnostic pop
 }
 
 + (id<XCTestManager_ManagerInterface>)testRunnerProxy

package/WebDriverAgentLib/Utilities/XCUIApplicationProcessDelay.m

@@ -61,7 +61,10 @@ static NSLock * lock = nil;
     [FBLogger log:@"Could not find method -[XCUIApplicationProcess setEventLoopHasIdled:]"];
     return;
   }
+#pragma clang diagnostic push
+#pragma clang diagnostic ignored "-Wcast-function-type-strict"
   orig_set_event_loop_has_idled = (void(*)(id, SEL, BOOL)) method_getImplementation(original);
+#pragma clang diagnostic pop
   Method replace = class_getClassMethod([XCUIApplicationProcessDelay class], @selector(setEventLoopHasIdled:));
   method_setImplementation(original, method_getImplementation(replace));
   isSwizzled = YES;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "appium-webdriveragent",
-  "version": "8.9.0",
+  "version": "8.9.2",
   "description": "Package bundling WebDriverAgent",
   "main": "./build/index.js",
   "types": "./build/index.d.ts",
@@ -68,7 +68,7 @@
     "prettier": "^3.0.0",
     "semantic-release": "^24.0.0",
     "semver": "^7.3.7",
-    "sinon": "^18.0.0",
+    "sinon": "^19.0.1",
     "ts-node": "^10.9.1",
     "typescript": "^5.4.2"
   },