Add the eventloopIdleDelaySec capability (wdaEventloopIdleDelay for users)

README.md

@@ -162,6 +162,7 @@ Differences noted here
 |`permissions`| Allows to set permissions for the specified application bundle on Simulator only. The capability value is expected to be a valid JSON string with `{"<bundleId1>": {"<serviceName1>": "<serviceStatus1>", ...}, ...}` format. It is required that `applesimutils` package is installed and available in PATH. The list of available service names and statuses can be found at https://github.com/wix/AppleSimulatorUtils. | e. g. `{"com.apple.mobilecal": {"calendar": "YES"}}` |
 |`screenshotQuality`| Changes the quality of phone display screenshots following [xctest/xctimagequality](https://developer.apple.com/documentation/xctest/xctimagequality?language=objc)  Default value is `1`. `0` is the highest and `2` is the lowest quality. You can also change it via [settings](https://github.com/appium/appium/blob/master/docs/en/advanced-concepts/settings.md) command. `0` might cause OutOfMemory crash on high-resolution devices like iPad Pro. | e.g. `0`, `1`, `2` |
 |`skipLogCapture`|Skips to start capturing logs such as crash, system, safari console and safari network. It might improve performance such as network. Log related commands will not work. Defaults to `false`. |`true` or `false`|
+|`eventloopIdleDelaySec`|Delays the invocation of `-[XCUIApplicationProcess setEventLoopHasIdled:]` by the number of seconds specified with this capability. This can help quiescence apps that fail to do so for no obvious reason (and creating a session fails for that reason). This increases the time for session creation because `-[XCUIApplicationProcess setEventLoopHasIdled:]` is called multiple times. If you enable this capability start with at least `3` seconds and try increasing it, if creating the session still fails. Defaults to `0`. |e.g. `5`|
 
 ## Development<a id="development"></a>
 

lib/desired-caps.js

@@ -168,6 +168,9 @@ let desiredCapConstraints = _.defaults({
   skipLogCapture: {
     isBoolean: true
   },
+  eventloopIdleDelaySec: {
+    isNumber: true
+  },
 }, iosDesiredCapConstraints);
 
 export { desiredCapConstraints };

lib/driver.js

@@ -844,6 +844,7 @@ class XCUITestDriver extends BaseDriver {
     let maxTypingFrequency = util.hasValue(this.opts.maxTypingFrequency) ? this.opts.maxTypingFrequency : 60;
     let shouldUseSingletonTestManager = util.hasValue(this.opts.shouldUseSingletonTestManager) ? this.opts.shouldUseSingletonTestManager : true;
     let shouldUseTestManagerForVisibilityDetection = false;
+    let eventloopIdleDelaySec = util.hasValue(this.opts.eventloopIdleDelaySec) ? this.opts.eventloopIdleDelaySec : 0;
     if (util.hasValue(this.opts.simpleIsVisibleCheck)) {
       shouldUseTestManagerForVisibilityDetection = this.opts.simpleIsVisibleCheck;
     }
@@ -865,6 +866,7 @@ class XCUITestDriver extends BaseDriver {
         bundleId,
         arguments: args,
         environment: env,
+        eventloopIdleDelaySec,
         shouldWaitForQuiescence,
         shouldUseTestManagerForVisibilityDetection,
         maxTypingFrequency,

test/unit/language-specs.js

@@ -24,6 +24,7 @@ describe('language and locale', function () {
           shouldUseTestManagerForVisibilityDetection: true,
           maxTypingFrequency: 60,
           shouldUseSingletonTestManager: true,
+          eventloopIdleDelaySec: 0,
         }
       };
       let desiredCapabilities = {
@@ -73,6 +74,7 @@ describe('language and locale', function () {
           shouldUseTestManagerForVisibilityDetection: true,
           maxTypingFrequency: 60,
           shouldUseSingletonTestManager: true,
+          eventloopIdleDelaySec: 0,
         }
       };
 

test/unit/processargs-specs.js

@@ -24,6 +24,7 @@ describe('process args', function () {
       shouldUseTestManagerForVisibilityDetection: false,
       maxTypingFrequency: 60,
       shouldUseSingletonTestManager: true,
+      eventloopIdleDelaySec: 0,
     }
   };