detox 20.0.14-is-hittable-over-master.0 → 20.0.14-prerelease.0

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

@@ -0,0 +1 @@
+8c0da6d59d09fe12e65641c05b23baa3

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

@@ -0,0 +1 @@
+31332781d3002ae93a1eaec77474e9f55bc7e5c7

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

@@ -0,0 +1 @@
+dcdfc5160bc82d542532fabc0b278164e550b9df0fc3f7a5afe6beaff60701f5

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

@@ -0,0 +1 @@
+71f4200bf6199efed9fb74fb1cd92570ed90abbe4bdf7c37816571c49af0d0559fcb943eafac23fd3a4e4004b822bb2248e062185df77ea13110acc9b0a4c26d

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

@@ -0,0 +1 @@
+7335013c99da31006342449417fedf5a

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

@@ -0,0 +1 @@
+04ee086f0aed13fd42de03340cc5c1d8d8749f6d

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

@@ -0,0 +1 @@
+904c995d85c623ebe69096dba272c0e855d99b96c9997dfb2f4a2321b603356e

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

@@ -0,0 +1 @@
+fc2b80324b5b497e17a4e9adf5d7b06d003fca036559e7e61b39b8777e9238377e182f0959e54ee452053538fa1b17d65537158ed952b8b99e995d2fde590b0f

package/Detox-android/com/wix/detox/{20.0.14-is-hittable-over-master.0/detox-20.0.14-is-hittable-over-master.0.pom → 20.0.14-prerelease.0/detox-20.0.14-prerelease.0.pom}

@@ -3,7 +3,7 @@
   <modelVersion>4.0.0</modelVersion>
   <groupId>com.wix</groupId>
   <artifactId>detox</artifactId>
-  <version>20.0.14-is-hittable-over-master.0</version>
+  <version>20.0.14-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.14-prerelease.0/detox-20.0.14-prerelease.0.pom.md5

@@ -0,0 +1 @@
+8bd920eb4542d031002c33d93308f426

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

@@ -0,0 +1 @@
+914ef3c1658d24794b7b94393578d899b16c0ed0

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

@@ -0,0 +1 @@
+a9b0b7bda22739644dee243f227c20d956ea3294378f75dea8d0f3d0d861d559

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

@@ -0,0 +1 @@
+523b294c136c5be73335a2c75f3ebb8bce7aa79579810a7cd96cb28a69e000043dbf188b44e30b06ee5762fead96255c3efd272ab4d9a8691428510e055160d5

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

@@ -3,11 +3,11 @@
   <groupId>com.wix</groupId>
   <artifactId>detox</artifactId>
   <versioning>
-    <latest>20.0.14-is-hittable-over-master.0</latest>
-    <release>20.0.14-is-hittable-over-master.0</release>
+    <latest>20.0.14-prerelease.0</latest>
+    <release>20.0.14-prerelease.0</release>
     <versions>
-      <version>20.0.14-is-hittable-over-master.0</version>
+      <version>20.0.14-prerelease.0</version>
     </versions>
-    <lastUpdated>20221106162428</lastUpdated>
+    <lastUpdated>20221108145605</lastUpdated>
   </versioning>
 </metadata>

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

@@ -1 +1 @@
-36f4a2be3d5428adbd7ef7d9d658caf2
+ba7d8cb5496d1d9366a8234bc4e64055

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

@@ -1 +1 @@
-e3d9c2e702cf221804d9e08ef5474c31acaa2a97
+77f004770bdd78a7442584a10dd84ef431783841

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

@@ -1 +1 @@
-77786aeb086510b2a6cd1ad411cbf3ae648ddd7f66f2265ae53fb2e917e7eb6c
+dd9c1791bb2c603c4806ebca0b071f52229edadedc9e487d52a434c1c24638b7

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

@@ -1 +1 @@
-551879251459e011fb04bc7be88d05705f47603ee1495f16524386ea26f7b1c4462dbfe6c4b916f6da5499a2d1f6ea98f97714a65e713e8fa9b563e4bc17e075
+a2914ac9dc6c4bd7a1f84a46a8f84e467d314b71f96d6603c4303bc54344d354fdc2903e1934c275ee785cd4a544c7a7f575c512ad6b623b76f943b672be718c

package/android/build.gradle

@@ -37,7 +37,6 @@ allprojects {
         mavenLocal()
         mavenCentral()
         google()
-        jcenter()
         maven {
             url "$projectDir/../../node_modules/react-native/android"
         }

package/android/detox/proguard-rules-app.pro

@@ -1,4 +1,5 @@
 -keepattributes InnerClasses, Exceptions
+
 -keep class com.facebook.react.modules.** { *; }
 -keep class com.facebook.react.uimanager.** { *; }
 -keep class com.facebook.react.animated.** { *; }
@@ -8,8 +9,9 @@
 -keep class com.facebook.react.ReactInstanceManager** { *; }
 -keep class com.facebook.react.ReactInstanceEventListener { *; }
 
--keep class com.facebook.react.views.slider.ReactSlider { *; }
--keep class com.reactnativecommunity.slider.ReactSlider { *; }
+-keep class com.facebook.react.views.slider.** { *; }
+-keep class com.google.android.material.slider.** { *; }
+-keep class com.reactnativecommunity.slider.** { *; }
 -keep class com.reactnativecommunity.asyncstorage.** { *; }
 
 -keep class kotlin.jvm.** { *; }

package/index.d.ts

@@ -32,7 +32,7 @@ declare global {
     }
 
     namespace Detox {
-        // region DetoxConfig
+        //#region DetoxConfig
 
         interface DetoxConfig extends DetoxConfigurationCommon {
             /**
@@ -82,15 +82,19 @@ declare global {
                  */
                 exposeGlobals?: boolean;
                 /**
-                 * By default, Detox will uninstall and install the app upon the initialization.
+                 * By default, Detox will uninstall and install the app upon initialization.
                  * If you wish to reuse the existing app for a faster run, set the property to
                  * `false`.
                  */
                 reinstallApp?: boolean;
                 /**
-                 * If you wish to run multiple "detox test" commands in parallel,
-                 * make sure they don't delete the shared lock file – only the
-                 * first command should reset the lock file.
+                 * When false, `detox test` command always deletes the shared lock file on start,
+                 * assuming it had been left from the previous, already finished test session.
+                 * The lock file contains information about busy and free devices and ensures
+                 * no device can be used simultaneously by multiple test workers.
+                 *
+                 * Setting it to **true** might be useful when if you need to run multiple
+                 * `detox test` commands in parallel, e.g. test a few configurations at once.
                  *
                  * @default false
                  */
@@ -102,13 +106,43 @@ declare global {
             };
         }
 
+        type _DetoxLoggerOptions = Omit<BunyanDebugStreamOptions, 'out'>;
+
         interface DetoxLoggerConfig {
+            /**
+             * Log level filters the messages printed to your terminal,
+             * and it does not affect the logs written to the artifacts.
+             *
+             * Use `info` by default.
+             * Use `error` or warn when you want to make the output as silent as possible.
+             * Use `debug` to control what generally is happening under the hood.
+             * Use `trace` when troubleshooting specific issues.
+             *
+             * @default 'info'
+             */
             level?: DetoxLogLevel;
             /**
-             * @default 'sandbox'
+             * When enabled, hijacks all the console methods (console.log, console.warn, etc)
+             * so that the messages printed via them are formatted and saved as Detox logs.
+             *
+             * @default true
+             */
+            overrideConsole?: boolean;
+            /**
+             * Since Detox is using
+             * {@link https://www.npmjs.com/package/bunyan-debug-stream bunyan-debug-stream}
+             * for printing logs, all its options are exposed for sake of simplicity
+             * of customization.
+             *
+             * The only exception is {@link BunyanDebugStreamOptions#out} option,
+             * which is always set to `process.stdout`.
+             *
+             * You can also pass a callback function to override the logger config
+             * programmatically, e.g. depending on the selected log level.
+             *
+             * @see {@link BunyanDebugStreamOptions}
              */
-            overrideConsole?: 'all' | 'sandbox' | 'none';
-            options?: BunyanDebugStreamOptions | ((config: Partial<DetoxLoggerConfig>) => BunyanDebugStreamOptions);
+            options?: _DetoxLoggerOptions | ((config: Partial<DetoxLoggerConfig>) => _DetoxLoggerOptions);
         }
 
         interface DetoxSessionConfig {
@@ -133,25 +167,78 @@ declare global {
                  */
                 [prop: string]: unknown;
             };
+
             /**
-             * Configuration of custom integration features
-             * between Detox and Jest
+             * This is an add-on section used by our Jest integration code (but not Detox core itself).
+             * In other words, if you’re implementing (or using) a custom integration with some other test runner, feel free to define a section for yourself (e.g. `testRunner.mocha`)
              */
             jest?: {
                 /**
                  * Environment setup timeout
+                 *
+                 * As a part of the environment setup, Detox boots the device and installs the apps.
+                 * If that takes longer than the specified value, the entire test suite will be considered as failed, e.g.:
+                 * ```plain text
+                 * FAIL  e2e/starter.test.js
+                 * ● Test suite failed to run
+                 *
+                 * Exceeded timeout of 300000ms while setting up Detox environment
+                 * ```
+                 *
+                 * The default value is 5 minutes.
+                 *
+                 * @default 300000
+                 * @see {@link https://jestjs.io/docs/configuration/#testenvironment-string}
                  */
                 setupTimeout?: number | undefined;
                 /**
-                 * Environment teardown timeout
+                 * Environemnt teardown timeout
+                 *
+                 * If the environment teardown takes longer than the specified value, Detox will throw a timeout error.
+                 * The default value is half a minute.
+                 *
+                 * @default 30000 (30 seconds)
+                 * @see {@link https://jestjs.io/docs/configuration/#testenvironment-string}
                  */
                 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.
+                 * Jest provides an API to re-run individual failed tests: `jest.retryTimes(count)`.
+                 * When Detox detects the use of this API, it suppresses its own CLI retry mechanism controlled via `detox test … --retries <N>` or {@link DetoxTestRunnerConfig#retries}.
+                 * The motivation is simple – activating the both mechanisms is apt to increase your test duration dramatically, if your tests are flaky.
+                 * If you wish nevertheless to use both the mechanisms simultaneously, set it to `true`.
+                 *
+                 * @default false
+                 * @see {@link https://jestjs.io/docs/29.0/jest-object#jestretrytimesnumretries-options}
                  */
                 retryAfterCircusRetries?: boolean;
+                /**
+                 * By default, Jest prints the test names and their status (_passed_ or _failed_) at the very end of the test session.
+                 * When enabled, it makes Detox to print messages like these each time the new test starts and ends:
+                 * ```plain text
+                 * 18:03:36.258 detox[40125] i Sanity: should have welcome screen
+                 * 18:03:37.495 detox[40125] i Sanity: should have welcome screen [OK]
+                 * 18:03:37.496 detox[40125] i Sanity: should show hello screen after tap
+                 * 18:03:38.928 detox[40125] i Sanity: should show hello screen after tap [OK]
+                 * 18:03:38.929 detox[40125] i Sanity: should show world screen after tap
+                 * 18:03:40.351 detox[40125] i Sanity: should show world screen after tap [OK]
+                 * ```
+                 * By default, it is enabled automatically in test sessions with a single worker.
+                 * And vice versa, if multiple tests are executed concurrently, Detox turns it off to avoid confusion in the log.
+                 * Use boolean values, `true` or `false`, to turn off the automatic choice.
+                 *
+                 * @default undefined
+                 */
                 reportSpecs?: boolean | undefined;
+                /**
+                 * In the environment setup phase, Detox boots the device and installs the apps.
+                 * This flag tells Detox to print messages like these every time the device gets assigned to a specific suite:
+                 *
+                 * ```plain text
+                 * 18:03:29.869 detox[40125] i starter.test.js is assigned to 4EC84833-C7EA-4CA3-A6E9-5C30A29EA596 (iPhone 12 Pro Max)
+                 * ```
+                 *
+                 * @default true
+                 */
                 reportWorkerAssign?: boolean | undefined;
             };
             /**
@@ -170,9 +257,9 @@ declare global {
             bail?: boolean;
             /**
              * Custom handler to process --inspect-brk CLI flag.
-             * Use it when you rely on another test runner than Jest.
+             * Use it when you rely on another test runner than Jest to mutate the config.
              */
-            inspectBrk?: boolean | ((config: DetoxTestRunnerConfig) => void);
+            inspectBrk?: (config: DetoxTestRunnerConfig) => void;
             /**
              * Forward environment variables to the spawned test runner
              * accordingly to the given CLI argument overrides.
@@ -321,8 +408,6 @@ declare global {
             os: string;
         }
 
-        type DetoxKnownDeviceType = DetoxBuiltInDeviceConfig['type'];
-
         type DetoxConfiguration = DetoxConfigurationCommon & (
             | DetoxConfigurationSingleApp
             | DetoxConfigurationMultiApps
@@ -342,7 +427,7 @@ declare global {
 
         type DetoxAliasedApp = string | DetoxAppConfig;
 
-        // endregion DetoxConfig
+        //#endregion
 
         interface DetoxExportWrapper {
             readonly device: Device;
@@ -596,10 +681,11 @@ declare global {
              * Relaunch the app. Convenience method that calls {@link Device#launchApp}
              * with { newInstance: true } override.
              *
+             * @deprecated
              * @param config
              * @see Device#launchApp
              */
-            relaunchApp(config?: Omit<DeviceLaunchAppConfig, 'newInstance'>): Promise<void>;
+            relaunchApp(config?: DeviceLaunchAppConfig): Promise<void>;
 
             /**
              * Access the user-defined launch-arguments predefined through static scopes such as the Detox configuration file and

package/internals.d.ts

@@ -6,52 +6,113 @@ declare global {
     type DetoxStatus = 'inactive' | 'init' | 'active' | 'cleanup';
 
     type Facade = {
-      // region Initialization
+      //#region Initialization
       /**
        * Use with a caution, when you still have no config, yet need to avoid {@link Facade#init}
        */
       resolveConfig(options?: Partial<DetoxInitOptions>): Promise<RuntimeConfig>;
 
       /**
+       * Returns one of statuses depending on what’s going with the current Detox context:
        *
+       * `inactive` – before `init()` and after `cleanup()` is called.
+       * `init` – while `init()` is executing.
+       * `active` – after `init()` and before `cleanup()` is called.
+       * `cleanup` – while `cleanup()` is executing.
        */
       getStatus(): DetoxStatus;
 
       /**
-       * This is the phase where Detox reads its configuration, starts a server.
+       * Starts a new Detox test session with the provided configuration.
+       * See {@link https://wix.github.io/Detox/docs/next/api/internals} for more details.
        */
       init(options?: Partial<DetoxInitOptions>): Promise<void>;
 
       /**
-       * This is the phase where Detox loads its expectation library and starts a device.
+       * This is the phase where Detox loads its expectation library and boots a device.
+       * You don't need to call it separately unless you use `init({ workerId: null })` override.
        */
       installWorker(options?: Partial<DetoxInstallWorkerOptions>): Promise<void>;
 
       /**
        * Deallocates the device.
+       * Most Client API (device, by, element, expect) will stop working, except for the logger.
        */
       uninstallWorker(): Promise<void>;
 
       /**
-       * The global cleanup phase should happen after all the tests have finished.
-       * This is the phase where the Detox server shuts down.
+       * This method should be called when the main or child process is about to exit.
+       * See {@link https://wix.github.io/Detox/docs/next/api/internals} for more details.
        */
       cleanup(): Promise<void>;
-      // endregion
-
-      // region Lifecycle
-      onRunStart(event: unknown): Promise<void>;
-      onRunDescribeStart(event: unknown): Promise<void>;
-      onTestStart(event: unknown): Promise<void>;
-      onHookStart(event: unknown): Promise<void>;
-      onHookFailure(event: unknown): Promise<void>;
-      onHookSuccess(event: unknown): Promise<void>;
-      onTestFnStart(event: unknown): Promise<void>;
-      onTestFnFailure(event: unknown): Promise<void>;
-      onTestFnSuccess(event: unknown): Promise<void>;
-      onTestDone(event: unknown): Promise<void>;
-      onRunDescribeFinish(event: unknown): Promise<void>;
-      onRunFinish(event: unknown): Promise<void>;
+      //#endregion
+
+      //#region Lifecycle
+      /**
+       * Reports that the test runner started executing a test suite, e.g. a `beforeAll` hook or a first test.
+       */
+      onRunDescribeStart(event: {
+        /** Test suite name */
+        name: string;
+      }): Promise<void>;
+      /**
+       * Reports that the test runner started executing a specific test.
+       */
+      onTestStart(event: {
+        /** Test name */
+        title: string;
+        /** Test name including the ancestor suite titles */
+        fullName: string;
+        /**
+         * N-th time this test is running, if there is a retry mechanism.
+         *
+         * @default 1
+         */
+        invocations?: number;
+        status: 'running';
+      }): Promise<void>;
+      /**
+       * Reports about an error in the midst of `beforeAll`, `beforeEach`, `afterEach`, `afterAll` or any other hook.
+       */
+      onHookFailure(event: {
+        error: Error | string;
+        /**
+         * @example 'beforeAll'
+         * @example 'afterEach'
+         */
+        hook: string;
+      }): Promise<void>;
+      /**
+       * Reports about an error in the midst of a test function, `test` or `it`.
+       */
+      onTestFnFailure(event: {
+        error: Error | string;
+      }): Promise<void>;
+      /**
+       * Reports the final status of the test, `passed` or `failed`.
+       */
+      onTestDone(event: {
+        /** Test name */
+        title: string;
+        /** Test name including the ancestor suite titles */
+        fullName: string;
+        /**
+         * N-th time this test is running, if there is a retry mechanism.
+         *
+         * @default 1
+         */
+        invocations?: number;
+        status: 'passed' | 'failed';
+        /** Whether a timeout was the reason for why the test failed. */
+        timedOut?: boolean;
+      }): Promise<void>;
+      /**
+       * Reports that the test runner has finished executing a test suite, e.g. all the `afterAll` hooks have been executed or the last test has finished running.
+       */
+      onRunDescribeFinish(event: {
+        /** Test suite name */
+        name: string;
+      }): Promise<void>;
 
       /**
        * Reports to Detox CLI about passed and failed test files.
@@ -61,7 +122,7 @@ declare global {
        * @param testResults - reports about test files
        */
       reportTestResults(testResults: DetoxTestFileReport[]): Promise<void>;
-      // endregion
+      //#endregion
 
       readonly config: RuntimeConfig;
       readonly log: Detox.Logger;
@@ -78,6 +139,10 @@ declare global {
         createEventStream(): NodeJS.ReadableStream;
       };
 
+      /**
+       * Not documented on purpose.
+       * Provides direct access to the object which holds the device driver, websocket client, matchers, expectations, etc.
+       */
       readonly worker: Worker;
     }
 
@@ -87,6 +152,9 @@ declare global {
 
     type DetoxInitOptions = {
       cwd: string;
+      /**
+       * @internal
+       */
       argv: Record<string, unknown>;
       testRunnerArgv: Record<string, unknown>;
       override: Partial<Detox.DetoxConfig>;
@@ -174,7 +242,7 @@ declare global {
        * or equal to "default" if the name is not configured.
        */
       apps: Record<string, Readonly<Detox.DetoxAppConfig>>;
-      artifacts: Readonly<Detox.DetoxArtifactsConfig>;
+      artifacts: Readonly<RuntimeArtifactsConfig>;
       behavior: Readonly<Detox.DetoxBehaviorConfig>;
       cli: Readonly<CLIConfig>;
       device: Readonly<Detox.DetoxDeviceConfig>;
@@ -183,6 +251,19 @@ declare global {
       session: Readonly<Detox.DetoxSessionConfig>;
     }>;
 
+    type RuntimeArtifactsConfig = {
+      rootDir: string;
+      pathBuilder: string;
+      plugins: Readonly<{
+        log: Readonly<Detox.DetoxLogArtifactsPluginConfig>;
+        screenshot: Readonly<Detox.DetoxScreenshotArtifactsPluginConfig>;
+        video: Readonly<Detox.DetoxVideoArtifactsPluginConfig>;
+        instruments: Readonly<Detox.DetoxInstrumentsArtifactsPluginConfig>;
+        uiHierarchy: Readonly<Detox.DetoxUIHierarchyArtifactsPluginConfig>;
+        [pluginId: string]: unknown;
+      }>;
+    };
+
     type CLIConfig = Readonly<Partial<{
       appLaunchArgs: string;
       artifactsLocation: string;

package/local-cli/cli.js

@@ -30,7 +30,7 @@ yargs
     if (err) {
       logger.error(DetoxError.format(err));
       // eslint-disable-next-line no-console
-      console.error('');
+      process.stderr.write('\n');
       // @ts-ignore
       _.attempt(() => fs.unlinkSync(logger.file));
       // eslint-disable-next-line no-process-exit

package/local-cli/init.js

@@ -9,7 +9,7 @@ const jestTemplates = require('./templates/jest');
 let exitCode = 0;
 
 module.exports.command = 'init';
-module.exports.desc = 'Scaffold initial E2E test folder structure for Detox';
+module.exports.desc = 'Creates template files to get you started with Detox';
 module.exports.builder = {};
 
 module.exports.handler = async function init() {

package/local-cli/test.js

@@ -3,7 +3,7 @@ const detox = require('../internals');
 const TestRunnerCommand = require('./testCommand/TestRunnerCommand');
 
 module.exports.command = 'test';
-module.exports.desc = 'Run your test suite with the test runner specified in package.json';
+module.exports.desc = 'Run your test suites with the test runner specified in the project\'s Detox config';
 module.exports.builder = require('./testCommand/builder');
 module.exports.middlewares = require('./testCommand/middlewares').default;
 
@@ -16,14 +16,14 @@ module.exports.handler = async function test({ detoxArgs, runnerArgs }) {
     };
 
     const config = await detox.resolveConfig(opts);
-    if (!config.testRunner.inspectBrk) {
+    if (!config.cli.inspectBrk) {
       await detox.init(opts);
     }
 
-    const runnerCommand = new TestRunnerCommand()
-      .setDeviceConfig(detox.config.device)
-      .replicateCLIConfig(detox.config.cli)
-      .setRunnerConfig(detox.config.testRunner);
+    const runnerCommand = new TestRunnerCommand({
+      config,
+      env: process.env,
+    });
 
     await runnerCommand.execute();
   } finally {