detox 21.0.0-breaking.new-global-lifecycle.0 → 21.0.1-rc.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "detox",
   "description": "E2E tests and automation for mobile",
-  "version": "21.0.0-breaking.new-global-lifecycle.0",
+  "version": "21.0.1-rc.0",
   "bin": {
     "detox": "local-cli/cli.js"
   },
@@ -24,6 +24,8 @@
     "build:android-native": "cd android && ./gradlew publish -Dversion=999.999.999 -DbuildFlavour=coreNative -DforceLocal=true && cd ..",
     "lint": "eslint .",
     "unit": "jest --coverage --verbose",
+    "unit:android-debug": "cd android && ./gradlew testFullDebug",
+    "unit:android-release": "cd android && ./gradlew testFullRelease",
     "pretest": "npm run lint",
     "test": "npm run unit",
     "posttest": "cp coverage/lcov.info coverage/unit.lcov",
@@ -35,21 +37,23 @@
     "@types/bunyan": "^1.8.8",
     "@types/child-process-promise": "^2.2.1",
     "@types/fs-extra": "^9.0.13",
-    "@types/jest": "^27.0.3",
-    "@types/node": "^12.20.37",
+    "@types/jest": "^28.1.8",
+    "@types/node": "^14.18.33",
     "@types/node-ipc": "^9.2.0",
     "@types/ws": "^7.4.0",
     "@typescript-eslint/eslint-plugin": "^5.4.0",
     "@typescript-eslint/parser": "^5.4.0",
+    "cross-env": "^7.0.3",
     "eslint": "^8.3.0",
     "eslint-plugin-import": "^2.23.3",
     "eslint-plugin-no-only-tests": "^2.6.0",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-unicorn": "^39.0.0",
-    "jest": "^27.5.1",
+    "jest": "^28.1.3",
+    "jest-allure2-reporter": "^1.2.1",
     "mockdate": "^2.0.1",
     "prettier": "1.7.0",
-    "react-native": "0.67.2",
+    "react-native": "0.70.7",
     "react-native-codegen": "^0.0.8",
     "typescript": "^4.5.2",
     "wtfnode": "^0.9.1"
@@ -57,20 +61,22 @@
   "dependencies": {
     "ajv": "^8.6.3",
     "bunyan": "^1.8.12",
-    "bunyan-debug-stream": "^3.0.2",
-    "chalk": "^2.4.2",
+    "bunyan-debug-stream": "^3.1.0",
+    "caf": "^15.0.1",
+    "chalk": "^4.0.0",
     "child-process-promise": "^2.2.0",
-    "duplexify": "^4.1.2",
-    "find-up": "^4.1.0",
-    "fs-extra": "^4.0.2",
-    "funpermaproxy": "^1.0.1",
+    "execa": "^5.1.1",
+    "find-up": "^5.0.0",
+    "fs-extra": "^11.0.0",
+    "funpermaproxy": "^1.1.0",
+    "glob": "^8.0.3",
     "ini": "^1.3.4",
     "json-cycle": "^1.3.0",
-    "lodash": "^4.17.5",
-    "minimist": "^1.2.0",
+    "lodash": "^4.17.11",
     "multi-sort-stream": "^1.0.3",
     "multipipe": "^4.0.0",
-    "node-ipc": "^9.2.1",
+    "node-ipc": "9.2.1",
+    "node-osascript": "^2.1.0",
     "proper-lockfile": "^3.0.2",
     "resolve-from": "^5.0.0",
     "sanitize-filename": "^1.6.1",
@@ -80,18 +86,17 @@
     "signal-exit": "^3.0.3",
     "stream-json": "^1.7.4",
     "strip-ansi": "^6.0.1",
-    "tail": "^2.0.0",
     "telnet-client": "1.2.8",
     "tempfile": "^2.0.0",
-    "trace-event-lib": "^1.1.0",
+    "trace-event-lib": "^1.3.1",
     "which": "^1.3.1",
     "ws": "^7.0.0",
-    "yargs": "^16.0.3",
-    "yargs-parser": "^20.2.9",
+    "yargs": "^17.0.0",
+    "yargs-parser": "^21.0.0",
     "yargs-unparser": "^2.0.0"
   },
   "peerDependencies": {
-    "jest": "28.x.x || ^27.2.5"
+    "jest": "29.x.x || 28.x.x || ^27.2.5"
   },
   "peerDependenciesMeta": {
     "jest": {
@@ -99,7 +104,7 @@
     }
   },
   "engines": {
-    "node": ">=12.10.0"
+    "node": ">=14.5.0"
   },
   "jest": {
     "setupFiles": [
@@ -122,6 +127,8 @@
       "__tests__",
       ".test.js$",
       ".mock.js$",
+      "index.js",
+      "internals.js",
       "local-cli/utils",
       "src/environmentFactory",
       "src/android/espressoapi",
@@ -158,10 +165,23 @@
       "src/utils/pipeCommands.js",
       "src/utils/pressAnyKey.js",
       "src/utils/shellUtils.js",
-      "runners/jest/.*.js"
+      "runners/jest/reporters",
+      "runners/jest/testEnvironment",
+      "src/DetoxWorker.js",
+      "src/logger/utils/streamUtils.js",
+      "src/realms"
     ],
     "resetMocks": true,
     "resetModules": true,
+    "reporters": [
+      "default",
+      [
+        "jest-allure2-reporter",
+        {
+          "getEnvironmentInfo": false
+        }
+      ]
+    ],
     "coverageReporters": [
       "html",
       "json",
@@ -176,12 +196,12 @@
     ],
     "coverageThreshold": {
       "global": {
-        "statements": 0,
-        "branches": 0,
-        "functions": 0,
-        "lines": 0
+        "statements": 100,
+        "branches": 100,
+        "functions": 100,
+        "lines": 100
       }
     }
   },
-  "gitHead": "5c9f55d001261c12376998bce4d3221540a52cc4"
+  "gitHead": "4715e6e5c52ec2414a3a44f66bd9c3f16579fd0e"
 }

package/runners/deprecation.js

@@ -1,47 +1,45 @@
 const chalk = require('chalk');
 
 // @ts-ignore
-console.error(chalk.yellow(`
-=========================  THE NEW JOURNEY BEGINS  =============================
-
-        https://github.com/wix/Detox/blob/master/docs/Guide.Jest.md
-
-             _.-;-._              Sorry, traveler from the lands of Detox 19!
-            ;_.JL___;
-            F"-/\\_-7L             Detox 20 comes without old adapters for Jest
-            | a/ e | \\            and Mocha test runners. You have to rearrange
-           ,L,c;,.='/;,           your init code before you can continue your
-        _,-;;S:;:S;;:' '--._      journey.
-       ;. \\;;s:::s;;: .'   /\\
-      /  \\  ;::::;;  /    /  \\    Navigate to the link above and follow the
-     / ,  k ;S';;'S.'    j __,l   migration guide steps.
-  ,---/| /  /S   /S '.   |'   ;
- ,Ljjj |/|.' s .' s   \\  L    |   Sincerely yours,
- LL,_ ]( \\    /    '.  '.||   ;   Detox team.
- ||\\ > /  ;-.'_.-.___\\.-'(|=="(
- JJ," /   |_  [   ]     _]|   /
-  LL\\/   ,' '--'-'-----'  \\  (
-  ||     ;      |          |  >
-  JJ     |      |\\         |,/
-   LL    |      ||       ' |
-   ||    |      ||       . |
-   JJ    /_     ||       ;_|
-    LL   L "==='|i======='_|
-    ||    i----' '-------';
-    JJ    ';-----.------,-'
-     LL     L_.__J,'---;'
-     ||      |   ,|    (
-     JJ     .'=  (|  ,_|
-      LL   /    .'L_    \\
-snd   ||   '---'    '.___>
-Credit: "Gimli" by Shanaka Dias
-
-        https://github.com/wix/Detox/blob/master/docs/Guide.Jest.md
-
-=========================  THE NEW JOURNEY BEGINS  =============================
-
-`));
-
-throw Object.assign(new Error(
-  '\n\nPlease follow the new Jest setup guide:\nhttps://github.com/wix/Detox/blob/master/docs/Guide.Jest.md\n\n'
-), { stack: '' });
+const bold = chalk.bold;
+
+function getMaxWidth(text) {
+  const lines = text.split('\n');
+  return lines.reduce((acc, line) => Math.max(acc, line.length), 0);
+}
+
+function centerText(text, maxWidth = getMaxWidth(text)) {
+  return text
+    .split('\n')
+    .map(line => {
+      const padStart = Math.max(0, Math.floor((maxWidth - line.length) / 2));
+      const padEnd = Math.max(0, maxWidth - line.length - padStart);
+      return ' '.repeat(padStart) + line + ' '.repeat(padEnd);
+    })
+    .join('\n');
+}
+
+const header = `\
+=========================  THE NEW JOURNEY BEGINS  =============================`;
+
+console.error(centerText(`\
+
+${bold(header)}
+
+https://wix.github.io/Detox/docs/guide/migration
+
+Sorry to say that Detox 20 comes without old adapters for Jest.
+You have to rearrange your init code before you can continue your journey.
+
+Navigate to the link and follow the migration guide steps.
+
+Sincerely yours,
+Detox team.
+
+${bold(header)}
+
+`, header.length));
+
+const error = new Error('\nPlease follow the migration guide:\nhttps://wix.github.io/Detox/docs/guide/migration\n\n');
+error.stack = '';
+throw error;

package/runners/jest/globalSetup.js

@@ -1 +1 @@
-module.exports = async () => require('../../internals').globalSetup();
+module.exports = async () => require('../../internals').init({ workerId: null });

package/runners/jest/globalTeardown.js

@@ -1 +1 @@
-module.exports = async () => require('../../internals').globalTeardown();
+module.exports = async () => require('../../internals').cleanup();

package/runners/jest/index.d.ts

@@ -0,0 +1,61 @@
+declare module 'detox/runners/jest' {
+  import type NodeEnvironment from 'jest-environment-node';
+
+  export function globalSetup(): Promise<void>;
+  export function globalTeardown(): Promise<void>;
+
+  export type DetoxCircusListenerConstructorOpts = {
+    readonly env: DetoxCircusEnvironment;
+  }
+
+  /**
+   * @example
+   * class CustomListener implements DetoxCircusListener {
+   *   constructor(opts: DetoxCircusListenerConstructorOpts) {
+   *     console.log('Current test path is:', opts.env.testPath);
+   *   }
+   * }
+   */
+  export interface DetoxCircusListener {
+    start_describe_definition?(event: unknown, state: unknown): void;
+    finish_describe_definition?(event: unknown, state: unknown): void;
+    add_hook?(event: unknown, state: unknown): void;
+    add_test?(event: unknown, state: unknown): void;
+    error?(event: unknown, state: unknown): void;
+
+    setup?(event: unknown, state: unknown): void | Promise<void>;
+    include_test_location_in_result?(event: unknown, state: unknown): void | Promise<void>;
+    hook_start?(event: unknown, state: unknown): void | Promise<void>;
+    hook_success?(event: unknown, state: unknown): void | Promise<void>;
+    hook_failure?(event: unknown, state: unknown): void | Promise<void>;
+    test_fn_start?(event: unknown, state: unknown): void | Promise<void>;
+    test_fn_success?(event: unknown, state: unknown): void | Promise<void>;
+    test_fn_failure?(event: unknown, state: unknown): void | Promise<void>;
+    test_retry?(event: unknown, state: unknown): void | Promise<void>;
+    test_start?(event: unknown, state: unknown): void | Promise<void>;
+    test_skip?(event: unknown, state: unknown): void | Promise<void>;
+    test_todo?(event: unknown, state: unknown): void | Promise<void>;
+    test_done?(event: unknown, state: unknown): void | Promise<void>;
+    run_describe_start?(event: unknown, state: unknown): void | Promise<void>;
+    run_describe_finish?(event: unknown, state: unknown): void | Promise<void>;
+    run_start?(event: unknown, state: unknown): void | Promise<void>;
+    run_finish?(event: unknown, state: unknown): void | Promise<void>;
+    teardown?(event: unknown, state: unknown): void | Promise<void>;
+  }
+
+  export interface DetoxListenerFactory {
+    new (opts: DetoxCircusListenerConstructorOpts): DetoxCircusListener;
+  }
+
+  export class DetoxCircusEnvironment extends NodeEnvironment {
+    public readonly testPath: string;
+
+    public handleTestEvent(event: unknown, state: unknown): void | Promise<void>;
+
+    protected registerListeners(map: Record<string, DetoxListenerFactory>): void;
+    protected setupTimeout: number;
+    protected teardownTimeout: number;
+    protected initDetox(): Promise<DetoxInternals.Worker>;
+    protected cleanupDetox(): Promise<void>;
+  }
+}

package/runners/jest/index.js

@@ -1,14 +1,11 @@
-module.exports = {
-  //#region *** Runner Realm ***
+// Lazy require() is used to avoid initializing a bare Detox context when it is not needed.
+// At the moment, this safety measure is not really needed, but it's better to be on the safe side.
 
+module.exports = {
   get DetoxCircusEnvironment() {
     return require('./testEnvironment');
   },
 
-  //#endregion
-
-  //#region *** Worker Realm ***
-
   get globalSetup() {
     return require('./globalSetup');
   },
@@ -16,6 +13,4 @@ module.exports = {
   get globalTeardown() {
     return require('./globalTeardown');
   },
-
-  //#endregion
 };

package/runners/jest/reporters/DetoxReporter.js

@@ -1,5 +1,36 @@
-const { VerboseReporter: JestVerboseReporter } = require('@jest/reporters'); // eslint-disable-line node/no-extraneous-require
+const resolveFrom = require('resolve-from');
+/** @type {typeof import('@jest/reporters').VerboseReporter} */
+const JestVerboseReporter = require(resolveFrom(process.cwd(), '@jest/reporters')).VerboseReporter;
 
-class DetoxReporter extends JestVerboseReporter {}
+const { config, reportTestResults } = require('../../../internals');
+
+class DetoxReporter extends JestVerboseReporter {
+  /**
+   * @param {import('@jest/test-result').AggregatedResult} results
+   */
+  // @ts-ignore
+  async onRunComplete(_contexts, results) {
+    // @ts-ignore
+    await super.onRunComplete(_contexts, results);
+
+    await reportTestResults(results.testResults.map(r => ({
+      success: !r.failureMessage,
+      testFilePath: r.testFilePath,
+      testExecError: r.testExecError,
+      isPermanentFailure: this._isPermanentFailure(r),
+    })));
+  }
+
+  /**
+   * @param {import('@jest/test-result').TestResult} testResult
+   */
+  _isPermanentFailure(testResult) {
+    if (config.testRunner.jest.retryAfterCircusRetries) {
+      return false;
+    }
+
+    return testResult.testResults.some(r => r.status === 'failed' && r.invocations > 1);
+  }
+}
 
 module.exports = DetoxReporter;

package/runners/jest/testEnvironment/index.js

@@ -1,9 +1,11 @@
-// @ts-nocheck
-const maybeNodeEnvironment = require('jest-environment-node'); // eslint-disable-line node/no-extraneous-require
+const path = require('path');
+
+const resolveFrom = require('resolve-from');
+const maybeNodeEnvironment = require(resolveFrom(process.cwd(), 'jest-environment-node'));
+/** @type {typeof import('@jest/environment').JestEnvironment} */
 const NodeEnvironment = maybeNodeEnvironment.default || maybeNodeEnvironment;
 
 const detox = require('../../../internals');
-const { DetoxError } = require('../../../src/errors');
 const Timer = require('../../../src/utils/Timer');
 
 const {
@@ -24,6 +26,8 @@ const SYNC_CIRCUS_EVENTS = new Set([
   'error',
 ]);
 
+const log = detox.log.child({ cat: 'lifecycle,jest-environment' });
+
 /**
  * @see https://www.npmjs.com/package/jest-circus#overview
  */
@@ -32,98 +36,93 @@ class DetoxCircusEnvironment extends NodeEnvironment {
     super(assertJestCircus27(config), assertExistingContext(context));
 
     /** @private */
-    this._timer = null;
+    this._shouldManageDetox = detox.getStatus() === 'inactive';
     /** @private */
-    this._listenerFactories = {
+    this._timer = new Timer();
+
+    /** @internal */
+    this.testPath = path.relative(process.cwd(), context.testPath);
+    /** @protected */
+    this.testEventListeners = [];
+    /** @protected */
+    this.setupTimeout = detox.config.testRunner.jest.setupTimeout;
+    /** @protected */
+    this.teardownTimeout = detox.config.testRunner.jest.teardownTimeout;
+
+    log.trace.begin(this.testPath);
+
+    this.handleTestEvent = this.handleTestEvent.bind(this);
+    this.setup = this._wrapSetup(this.setup);
+    this.teardown = this._wrapTeardown(this.teardown);
+
+    this.registerListeners({
       DetoxInitErrorListener,
       DetoxPlatformFilterListener,
       DetoxCoreListener,
       SpecReporter,
       WorkerAssignReporter,
-    };
-    /** @protected */
-    this.testPath = context.testPath;
-    /** @protected */
-    this.testEventListeners = [];
-    /** @protected */
-    this.initTimeout = detox.config.runnerConfig.jest.initTimeout;
+    });
   }
 
   /** @override */
   async setup() {
     await super.setup();
-
-    await Timer.run({
-      description: `setting up Detox environment`,
-      timeout: this.initTimeout,
-      fn: async () => {
-        await this.initDetox();
-        this._instantiateListeners();
-      },
-    });
+    await this.initDetox();
   }
 
-  /** @override */
   async handleTestEvent(event, state) {
-    const { name } = event;
+    this._timer.schedule(state.testTimeout != null ? state.testTimeout : this.setupTimeout);
 
-    if (SYNC_CIRCUS_EVENTS.has(name)) {
-      return this._handleTestEventSync(event, state);
-    }
-
-    this._timer = new Timer({
-      description: `handling jest-circus "${name}" event`,
-      timeout: state.testTimeout != null ? state.testTimeout : this.initTimeout,
-    });
-
-    try {
-      for (const listener of this.testEventListeners) {
-        if (typeof listener[name] !== 'function') {
-          continue;
-        }
-
-        try {
-          await this._timer.run(() => listener[name](event, state));
-        } catch (listenerError) {
-          this._logError(listenerError);
-          break;
-        }
-      }
-    } finally {
-      this._timer.dispose();
-      this._timer = null;
+    if (SYNC_CIRCUS_EVENTS.has(event.name)) {
+      this._handleTestEventSync(event, state);
+    } else {
+      await this._handleTestEventAsync(event, state);
     }
   }
 
   /** @override */
   async teardown() {
-    await Timer.run({
-      description: `tearing down Detox environment`,
-      timeout: this.initTimeout,
-      fn: async () => {
-        await this.cleanupDetox();
-      },
-    });
+    try {
+      await this.cleanupDetox();
+    } finally {
+      await super.teardown();
+    }
   }
 
   /** @protected */
   registerListeners(map) {
-    Object.assign(this._listenerFactories, map);
+    for (const Listener of Object.values(map)) {
+      this.testEventListeners.push(new Listener({
+        env: this,
+      }));
+    }
   }
 
   /**
    * @protected
    */
   async initDetox() {
-    await detox.setup({
+    const opts = {
       global: this.global,
-      workerId: +process.env.JEST_WORKER_ID,
-    });
+      workerId: `w${process.env.JEST_WORKER_ID}`,
+    };
+
+    if (this._shouldManageDetox) {
+      await detox.init(opts);
+    } else {
+      await detox.installWorker(opts);
+    }
+
+    return detox.worker;
   }
 
   /** @protected */
   async cleanupDetox() {
-    await detox.teardown();
+    if (this._shouldManageDetox) {
+      await detox.cleanup();
+    } else {
+      await detox.uninstallWorker();
+    }
   }
 
   /** @private */
@@ -138,17 +137,69 @@ class DetoxCircusEnvironment extends NodeEnvironment {
   }
 
   /** @private */
-  _instantiateListeners() {
-    for (const Listener of Object.values(this._listenerFactories)) {
-      this.testEventListeners.push(new Listener({
-        env: this,
-      }));
+  async _handleTestEventAsync(event, state = null) {
+    const description = `handling ${state ? 'jest-circus' : 'jest-environment'} "${event.name}" event`;
+
+    for (const listener of this.testEventListeners) {
+      if (typeof listener[event.name] !== 'function') {
+        continue;
+      }
+
+      try {
+        await this._timer.run(description, () => listener[event.name](event, state));
+      } catch (listenerError) {
+        log.error(listenerError);
+        if (this._timer.expired) {
+          break;
+        }
+      }
     }
   }
 
-  /** @private */
-  _logError(e) {
-    detox.log.error(DetoxError.format(e));
+  _wrapSetup(fn) {
+    const _setup = fn.bind(this);
+
+    return async () => {
+      await log.trace.complete('set up environment', async () => {
+        try {
+          this._timer.schedule(this.setupTimeout);
+          await this._handleTestEventAsync({ name: 'environment_setup_start' });
+          await this._timer.run(`setting up Detox environment`, _setup);
+          await this._handleTestEventAsync({ name: 'environment_setup_success' });
+        } catch (error) {
+          this._timer.schedule(this.teardownTimeout);
+          await this._handleTestEventAsync({ name: 'environment_setup_failure', error });
+          throw error;
+        } finally {
+          this._timer.clear();
+        }
+      });
+    };
+  }
+
+  _wrapTeardown(fn) {
+    const _teardown = fn.bind(this);
+
+    return async () => {
+      await log.trace.complete('tear down environment', async () => {
+        try {
+          this._timer.schedule(this.teardownTimeout);
+          await this._handleTestEventAsync({ name: 'environment_teardown_start' });
+          await this._timer.run(`tearing down Detox environment`, _teardown);
+          await this._handleTestEventAsync({ name: 'environment_teardown_success' });
+        } catch (error) {
+          if (this._timer.expired) {
+            this._timer.schedule(this.teardownTimeout);
+          }
+
+          await this._handleTestEventAsync({ name: 'environment_teardown_failure', error });
+          throw error;
+        } finally {
+          this._timer.clear();
+          log.trace.end();
+        }
+      });
+    };
   }
 }