detox 20.0.10-prerelease.0 → 20.0.12-prerelease.0

package/Detox-android/com/wix/detox/20.0.12-prerelease.0/detox-20.0.12-prerelease.0-javadoc.jar.md5

@@ -0,0 +1 @@
+83f58f2114c4c11df13dc19fb48ec8f3

package/Detox-android/com/wix/detox/20.0.12-prerelease.0/detox-20.0.12-prerelease.0-javadoc.jar.sha1

@@ -0,0 +1 @@
+79e4ecf9e3a592932f8ee594c287345fbcb50ccc

package/Detox-android/com/wix/detox/20.0.12-prerelease.0/detox-20.0.12-prerelease.0-javadoc.jar.sha256

@@ -0,0 +1 @@
+b9135f4a994d21ab1543c223940ba2eae57411c514b6b5ede58db8179ef48ec5

package/Detox-android/com/wix/detox/20.0.12-prerelease.0/detox-20.0.12-prerelease.0-javadoc.jar.sha512

@@ -0,0 +1 @@
+035992cf8193c98d4335ca7f94842ca794a8a40f94f437a076eee068d930a86623d1e6d7755f624fcad632e092faa445b83557ae297c2ba7f05131848c251fa4

package/Detox-android/com/wix/detox/20.0.12-prerelease.0/detox-20.0.12-prerelease.0-sources.jar.md5

@@ -0,0 +1 @@
+6a09651b807ee852e1fbb3e374bc95ca

package/Detox-android/com/wix/detox/20.0.12-prerelease.0/detox-20.0.12-prerelease.0-sources.jar.sha1

@@ -0,0 +1 @@
+c3769eddce862d29deba41c68b1c3457056d746c

package/Detox-android/com/wix/detox/20.0.12-prerelease.0/detox-20.0.12-prerelease.0-sources.jar.sha256

@@ -0,0 +1 @@
+3263d7cca6d9ae2a88716ef6aa4cd936d47b6c27888c7b3c40c6f745e3407d60

package/Detox-android/com/wix/detox/20.0.12-prerelease.0/detox-20.0.12-prerelease.0-sources.jar.sha512

@@ -0,0 +1 @@
+190e018641c86048d3c8f61efcdd8694d91b099c863f7740898f311bfb2e927179ceed13502e6efad6a915846271c0fc46177a7ac692cdda1899a9ca320dc852

package/Detox-android/com/wix/detox/20.0.12-prerelease.0/detox-20.0.12-prerelease.0.aar.md5

@@ -0,0 +1 @@
+3bdd1b42fa0f182255a47fcdda8f544c

package/Detox-android/com/wix/detox/20.0.12-prerelease.0/detox-20.0.12-prerelease.0.aar.sha1

@@ -0,0 +1 @@
+457ae10d202b196ea92bade4a33ce2dbc2f8bb3f

package/Detox-android/com/wix/detox/20.0.12-prerelease.0/detox-20.0.12-prerelease.0.aar.sha256

@@ -0,0 +1 @@
+52342d1b0d1fae681b2ea1e6f9ac6f6278299ed70d7867fd60b95d63eb7a9ec3

package/Detox-android/com/wix/detox/20.0.12-prerelease.0/detox-20.0.12-prerelease.0.aar.sha512

@@ -0,0 +1 @@
+5dfa73d84d647fd870a2e915d9943c9502c967abfd89a834ef7dee50a2a77d5a8b0be7b13407a34a6b97cbc10e9ed6f5e608fe7366d5a3041e462e3322d5b10d

package/Detox-android/com/wix/detox/{20.0.10-prerelease.0/detox-20.0.10-prerelease.0.pom → 20.0.12-prerelease.0/detox-20.0.12-prerelease.0.pom}

@@ -3,7 +3,7 @@
   <modelVersion>4.0.0</modelVersion>
   <groupId>com.wix</groupId>
   <artifactId>detox</artifactId>
-  <version>20.0.10-prerelease.0</version>
+  <version>20.0.12-prerelease.0</version>
   <packaging>aar</packaging>
   <name>Detox</name>
   <description>Gray box end-to-end testing and automation library for mobile apps</description>

package/Detox-android/com/wix/detox/20.0.12-prerelease.0/detox-20.0.12-prerelease.0.pom.md5

@@ -0,0 +1 @@
+0493506a4e0ab469402bb1ec8060d6be

package/Detox-android/com/wix/detox/20.0.12-prerelease.0/detox-20.0.12-prerelease.0.pom.sha1

@@ -0,0 +1 @@
+368ca67e6718ee04781403230f984973b7226f4e

package/Detox-android/com/wix/detox/20.0.12-prerelease.0/detox-20.0.12-prerelease.0.pom.sha256

@@ -0,0 +1 @@
+516654dfdf2f2ef5dc08619ab644dd4aeca1a2603bad93520897a6206b43554d

package/Detox-android/com/wix/detox/20.0.12-prerelease.0/detox-20.0.12-prerelease.0.pom.sha512

@@ -0,0 +1 @@
+d02dc795d31bf3818e6682da9bbef6399c611cfcd5ed9189f8ff9edad231bd5c98c66b0582fc86cd1843abcaf57cda394cb47e3ba5be641325357b656dcc9585

package/Detox-android/com/wix/detox/maven-metadata.xml

@@ -3,11 +3,11 @@
   <groupId>com.wix</groupId>
   <artifactId>detox</artifactId>
   <versioning>
-    <latest>20.0.10-prerelease.0</latest>
-    <release>20.0.10-prerelease.0</release>
+    <latest>20.0.12-prerelease.0</latest>
+    <release>20.0.12-prerelease.0</release>
     <versions>
-      <version>20.0.10-prerelease.0</version>
+      <version>20.0.12-prerelease.0</version>
     </versions>
-    <lastUpdated>20220915145552</lastUpdated>
+    <lastUpdated>20221011170939</lastUpdated>
   </versioning>
 </metadata>

package/Detox-android/com/wix/detox/maven-metadata.xml.md5

@@ -1 +1 @@
-1191a5f6183621bd8fee757b41eb2d43
+79cf31a8db7ad74ff1286cd11496ad71

package/Detox-android/com/wix/detox/maven-metadata.xml.sha1

@@ -1 +1 @@
-0aff1596476fa2a5c51711508d7d9afdb1bb1464
+0d7ee0e81eefa10376669b9858bd76020fde79ca

package/Detox-android/com/wix/detox/maven-metadata.xml.sha256

@@ -1 +1 @@
-2f27894de27a5a63d47e2fce362ad81bb48dd9ea28c4ff01ede9f19158626db6
+d36ef71b4b4869d33efcc8332d5a8ba0e78539d934e0bf9879af9ff9a47a8f29

package/Detox-android/com/wix/detox/maven-metadata.xml.sha512

@@ -1 +1 @@
-2a3a2ba69037611029babb76220f61d51b9b586ea450b6604f7ce9ae7dddfee84712b308ec877f5a626daf4b5ba8c16aca10168017180b0266a7904577c6ac33
+91d5852150f7da4be8a3758d64a7eb28bede7863ac6d34e56b81b1587b837c935a4e5af1e5476c0beb90ada1a154efc3028ae6e4f7878699d2942aba64293579

package/README.md

@@ -1,4 +1,4 @@
-## Detox
+# Detox
 
 Graybox End-to-End Tests and Automation Library for Mobile
 

package/android/detox/proguard-rules.pro

@@ -13,6 +13,9 @@
 -dontnote org.hamcrest.**
 -dontnote com.facebook.**
 
+-keep class org.apache.commons.lang3.** { *; }
+-keep class org.apache.commons.io.** { *; }
+
 # Detox profiler (optional)
 
 -keep class com.wix.detoxprofiler.** { *; }

package/android/detox/src/full/java/com/wix/detox/reactnative/idlingresources/IdlingResourceDescription.kt

@@ -1,20 +1,26 @@
 package com.wix.detox.reactnative.idlingresources
 
 class IdlingResourceDescription private constructor(
-  private val name: String,
-  private val description: Map<String, Any>) {
-    fun json(): Map<String, Any> = mutableMapOf<String, Any>("name" to name)
-      .apply { if (description.isNotEmpty()) put("description", description) }
+    private val name: String,
+    private val description: Map<String, Any>) {
 
-    override fun equals(other: Any?): Boolean = other is IdlingResourceDescription &&
-        other.json() == this.json()
+    fun json() =
+        mutableMapOf<String, Any>("name" to name)
+          .apply {
+            if (description.isNotEmpty()) put("description", description)
+          }.toMap()
 
-    data class Builder(
-      var name: String = "unknown",
-      var description: MutableMap<String, Any> = mutableMapOf()) {
+    override fun equals(other: Any?) =
+      (other is IdlingResourceDescription && other.json() == this.json())
+
+    override fun hashCode(): Int =
+      (31 * name.hashCode() + description.hashCode())
 
-        fun name(name: String) = apply { this.name = name }
-        fun addDescription(key: String, value: Any) = apply { this.description[key] = value }
-        fun build() = IdlingResourceDescription(name, description)
-    }
+    data class Builder(
+        var name: String = "unknown",
+        var description: MutableMap<String, Any> = mutableMapOf()) {
+            fun name(value: String) = apply { name = value }
+            fun addDescription(key: String, value: Any) = apply { description[key] = value }
+            fun build() = IdlingResourceDescription(name, description)
+      }
 }

package/android/detox/src/full/java/com/wix/detox/reactnative/idlingresources/NetworkIdlingResource.java

@@ -69,42 +69,13 @@ public class NetworkIdlingResource extends DetoxBaseIdlingResource implements Ch
 
     @NotNull
     @Override
-    public IdlingResourceDescription getDescription() {
+    public synchronized IdlingResourceDescription getDescription() {
         return new IdlingResourceDescription.Builder()
                 .name("network")
                 .addDescription("urls", new ArrayList<>(busyResources))
                 .build();
     }
 
-    @Override
-    protected boolean checkIdle() {
-        boolean idle = true;
-        busyResources.clear();
-        List<Call> calls = dispatcher.runningCalls();
-        for (Call call : calls) {
-            idle = false;
-            String url = call.request().url().toString();
-            for (Pattern pattern : blacklist) {
-                if (pattern.matcher(url).matches()) {
-                    idle = true;
-                    break;
-                }
-            }
-            if (!idle) {
-                busyResources.add(call.request().url().toString());
-            }
-        }
-        if (!idle) {
-            Choreographer.getInstance().postFrameCallback(this);
-            Log.i(LOG_TAG, "Network is busy");
-        } else {
-            if (callback != null) {
-                callback.onTransitionToIdle();
-            }
-        }
-        return idle;
-    }
-
     @Override
     public void registerIdleTransitionCallback(ResourceCallback callback) {
         this.callback = callback;
@@ -116,10 +87,42 @@ public class NetworkIdlingResource extends DetoxBaseIdlingResource implements Ch
         isIdleNow();
     }
 
+    @Override
+    protected synchronized boolean checkIdle() {
+        busyResources.clear();
+
+        List<Call> calls = dispatcher.runningCalls();
+        for (Call call: calls) {
+            final String url = call.request().url().toString();
+
+            if (!isUrlBlacklisted(url)) {
+                busyResources.add(url);
+            }
+        }
+
+        if (!busyResources.isEmpty()) {
+            Log.i(LOG_TAG, "Network is busy, with " + busyResources.size() + " in-flight calls");
+            Choreographer.getInstance().postFrameCallback(this);
+            return false;
+        }
+
+        notifyIdle();
+        return true;
+    }
+
     @Override
     protected void notifyIdle() {
         if (callback != null) {
             callback.onTransitionToIdle();
         }
     }
+
+    private boolean isUrlBlacklisted(String url) {
+        for (Pattern pattern: blacklist) {
+            if (pattern.matcher(url).matches()) {
+                return true;
+            }
+        }
+        return false;
+    }
 }

package/android/detox/src/testFull/java/com/wix/detox/reactnative/idlingresources/NetworkIdlingResourcesTest.kt

@@ -0,0 +1,61 @@
+package com.wix.detox.reactnative.idlingresources
+
+import com.wix.detox.UTHelpers.yieldToOtherThreads
+import org.assertj.core.api.Assertions.assertThat
+
+import okhttp3.Dispatcher
+import org.junit.Before
+import org.junit.Test
+import org.junit.runner.RunWith
+import org.robolectric.RobolectricTestRunner
+import java.util.concurrent.Executors
+
+@RunWith(RobolectricTestRunner::class)
+class NetworkIdlingResourcesTest {
+    lateinit var dispatcher: Dispatcher
+    lateinit var uut: NetworkIdlingResource
+
+    @Before
+    fun setup() {
+        dispatcher = Dispatcher()
+        uut = NetworkIdlingResource(dispatcher)
+    }
+
+    // Note: Ideally, we should test that the list of busy resources is protected,
+    // rather than testing thread-safety as a whole.
+    @Test
+    fun `should return the description in a thread-safe way`() {
+        val localExecutor = Executors.newSingleThreadExecutor()
+        var description: IdlingResourceDescription? = null
+
+        synchronized(uut) {
+            localExecutor.submit {
+                description = uut.getDescription()
+            }
+
+            yieldToOtherThreads(localExecutor)
+            assertThat(description).isNull()
+        }
+        yieldToOtherThreads(localExecutor)
+        assertThat(description).isNotNull()
+    }
+
+    // Note: Ideally, we should test that the list of busy resources is protected,
+    // rather than testing thread-safety as a whole.
+    @Test
+    fun `should check for idle in a thread-safe way`() {
+        val localExecutor = Executors.newSingleThreadExecutor()
+        var idle = false
+
+        synchronized(uut) {
+            localExecutor.submit {
+                idle = uut.isIdleNow
+            }
+
+            yieldToOtherThreads(localExecutor)
+            assertThat(idle).isFalse
+        }
+        yieldToOtherThreads(localExecutor)
+        assertThat(idle).isTrue
+    }
+}

package/index.d.ts

@@ -11,6 +11,7 @@
 import { BunyanDebugStreamOptions } from 'bunyan-debug-stream';
 
 declare global {
+    const detox: Detox.DetoxExportWrapper;
     const device: Detox.DetoxExportWrapper['device'];
     const element: Detox.DetoxExportWrapper['element'];
     const waitFor: Detox.DetoxExportWrapper['waitFor'];
@@ -20,6 +21,7 @@ declare global {
 
     namespace NodeJS {
         interface Global {
+            detox: Detox.DetoxExportWrapper;
             device: Detox.DetoxExportWrapper['device'];
             element: Detox.DetoxExportWrapper['element'];
             waitFor: Detox.DetoxExportWrapper['waitFor'];
@@ -137,9 +139,13 @@ declare global {
              */
             jest?: {
                 /**
-                 * Device init timeout
+                 * Environment setup timeout
                  */
-                initTimeout?: number | undefined;
+                setupTimeout?: number | undefined;
+                /**
+                 * Environment teardown timeout
+                 */
+                teardownTimeout?: number | undefined;
                 /**
                  * Insist on CLI-based retry mechanism even when the failed tests have been handled
                  * by jest.retryTimes(n) mechanism from Jest Circus.
@@ -152,6 +158,16 @@ declare global {
              * Retries count. Zero means a single attempt to run tests.
              */
             retries?: number;
+            /**
+             * When true, tells Detox CLI to cancel next retrying if it gets
+             * at least one report about a permanent test suite failure.
+             * Has no effect, if {@link DetoxTestRunnerConfig#retries} is
+             * undefined or set to zero.
+             *
+             * @default false
+             * @see {DetoxInternals.DetoxTestFileReport#isPermanentFailure}
+             */
+            bail?: boolean;
             /**
              * Custom handler to process --inspect-brk CLI flag.
              * Use it when you rely on another test runner than Jest.
@@ -238,6 +254,13 @@ declare global {
             build?: string;
             testBinaryPath?: string;
             launchArgs?: Record<string, any>;
+            /**
+             * TCP ports to `adb reverse` upon the installation.
+             * E.g. 8081 - to be able to access React Native packager in Debug mode.
+             *
+             * @example [8081]
+             */
+            reversePorts?: number[];
         }
 
         interface DetoxCustomAppConfig {

package/internals.d.ts

@@ -54,14 +54,13 @@ declare global {
       onRunFinish(event: unknown): Promise<void>;
 
       /**
-       * Reports to Detox CLI about failed tests that could have been re-run if
+       * Reports to Detox CLI about passed and failed test files.
+       * The failed test files might be re-run again if
        * {@link Detox.DetoxTestRunnerConfig#retries} is set to a non-zero.
        *
-       * @param testFilePaths array of failed test files' paths
-       * @param permanent whether the failure is permanent, and the tests
-       * should not be re-run.
+       * @param testResults - reports about test files
        */
-      reportFailedTests(testFilePaths: string[], permanent?: boolean): Promise<void>;
+      reportTestResults(testResults: DetoxTestFileReport[]): Promise<void>;
       // endregion
 
       readonly config: RuntimeConfig;
@@ -92,7 +91,7 @@ declare global {
       testRunnerArgv: Record<string, unknown>;
       override: Partial<Detox.DetoxConfig>;
       /** @inheritDoc */
-      global: NodeJS.Global;
+      global: NodeJS.Global | {};
       /**
        * Worker ID. Used to distinguish allocated workers in parallel test execution environment.
        *
@@ -111,7 +110,7 @@ declare global {
        * {@link DetoxInternals.Facade#setup} might override {@link Console} methods
        * to integrate it with Detox loggeing subsystem.
        */
-      global: NodeJS.Global;
+      global: NodeJS.Global | {};
       /**
        * Worker ID. Used to distinguish allocated workers in parallel test execution environment.
        *
@@ -120,25 +119,48 @@ declare global {
       workerId: string;
     };
 
+    type DetoxTestFileReport = {
+      /**
+       * Global or relative path to the failed test file.
+       */
+      testFilePath: string;
+      /**
+       * Whether the test passed or not.
+       */
+      success: boolean;
+      /**
+       * Top-level error if the entire test file failed.
+       */
+      testExecError?: { name?: string; message: string; stack?: string; };
+      /**
+       * If the test failed, it should tell whether the failure is permanent.
+       * Permanent failure means that the test file should not be re-run.
+       *
+       * @default false
+       * @see {Detox.DetoxTestRunnerConfig#retries}
+       */
+      isPermanentFailure?: boolean;
+    };
+
     type SessionState = Readonly<{
       /**
        * Randomly generated ID for the entire Detox test session, including retries.
        */
       id: string;
       /**
-       * Permanently failed test file paths.
+       * Results of test file executions. Primarily used for Detox CLI retry mechanism.
        */
-      failedTestFiles: string[];
-      /**
-       * Failed test file paths suggested to retry via Detox CLI mechanism.
-       */
-      testFilesToRetry: string[];
+      testResults: DetoxTestFileReport[];
       /**
        * Retry index of the test session: 0..retriesCount.
        */
       testSessionIndex: number;
       /**
-       * TODO
+       * Count of Detox contexts with a worker installed.
+       * Oversimplified, it reflects the count of allocated devices in the current test session.
+       *
+       * @see {Facade#init}
+       * @see {Facade#installWorker}
        */
       workersCount: number;
     }>;

package/local-cli/cli.js

@@ -1,8 +1,11 @@
 #!/usr/bin/env node
+const fs = require('fs');
+
+const _ = require('lodash');
 const yargs = require('yargs');
 
+const logger = require('../internals').log.child({ cat: 'cli' });
 const DetoxError = require('../src/errors/DetoxError');
-const logger = require('../src/utils/logger').child({ cat: 'cli' });
 
 yargs
   .scriptName('detox')
@@ -25,12 +28,11 @@ yargs
   .wrap(yargs.terminalWidth() * 0.9)
   .fail(function(msg, err, program) {
     if (err) {
-      const lines = DetoxError.format(err).split('\n');
-      for (const line of lines) {
-        logger.error(line);
-      }
+      logger.error(DetoxError.format(err));
       // eslint-disable-next-line no-console
       console.error('');
+      // @ts-ignore
+      _.attempt(() => fs.unlinkSync(logger.file));
       // eslint-disable-next-line no-process-exit
       process.exit(1);
     }

package/local-cli/init.js

@@ -76,7 +76,7 @@ function createDefaultConfigurations() {
         config: 'e2e/jest.config.js',
       },
       jest: {
-        initTimeout: 120000,
+        setupTimeout: 120000,
       },
     },
     apps: {
@@ -94,6 +94,7 @@ function createDefaultConfigurations() {
         type: 'android.apk',
         binaryPath: 'android/app/build/outputs/apk/debug/app-debug.apk',
         build: 'cd android ; ./gradlew assembleDebug assembleAndroidTest -DtestBuildType=debug ; cd -',
+        reversePorts: [8081],
       },
       'android.release': {
         type: 'android.apk',

package/local-cli/reset-lock-file.js

@@ -0,0 +1,16 @@
+const { log } = require('../internals');
+const DeviceRegistry = require('../src/devices/DeviceRegistry');
+const { getDetoxLibraryRootPath } = require('../src/utils/environment');
+
+
+module.exports.command = 'reset-lock-file';
+module.exports.desc = 'Resets all Detox lock files. Useful when you need to run multiple `detox test` commands in parallel with --keepLockFile.';
+
+module.exports.handler = async function resetLockFile() {
+  await Promise.all([
+    DeviceRegistry.forIOS().reset(),
+    DeviceRegistry.forAndroid().reset(),
+  ]);
+
+  log.info(`Cleaned lock files from: ${getDetoxLibraryRootPath()}`);
+};

package/local-cli/templates/jest.js

@@ -1,6 +1,8 @@
 const firstTestContent = require('./firstTestContent');
 
-const runnerConfig = `module.exports = {
+const runnerConfig = `\
+/** @type {import('@jest/types').Config.InitialOptions} */
+module.exports = {
   rootDir: '..',
   testMatch: ['<rootDir>/e2e/**/*.test.js'],
   testTimeout: 120000,