detox 20.1.0-next-is-hittable-check.0 → 20.1.0

package/local-cli/testCommand/middlewares.js

@@ -5,7 +5,7 @@ const { getJestBooleanArgs } = require('../utils/jestInternals');
 const { simpleUnquote, extractKnownKeys, disengageBooleanArgs } = require('../utils/yargsUtils');
 
 const testCommandArgs = require('./builder');
-const { DETOX_ARGV_OVERRIDE_NOTICE, DEVICE_LAUNCH_ARGS_DEPRECATION } = require('./warnings');
+const { DETOX_ARGV_OVERRIDE_NOTICE } = require('./warnings');
 
 function applyEnvironmentVariableAddendum(argv, yargs) {
   if (process.env.DETOX_ARGV_OVERRIDE) {
@@ -13,12 +13,13 @@ function applyEnvironmentVariableAddendum(argv, yargs) {
 
     const { _: positional, '--': passthrough, ...named } = yargs.parse(process.env.DETOX_ARGV_OVERRIDE);
 
-    if (positional) {
+    if (!_.isEmpty(positional)) {
+      /* istanbul ignore next */
       argv._ = argv._ || [];
       argv._.push(...positional.map(simpleUnquote));
     }
 
-    if (passthrough) {
+    if (!_.isEmpty(passthrough)) {
       argv['--'] = argv['--'] || [];
       argv['--'].push(...passthrough.map(simpleUnquote));
     }
@@ -29,14 +30,6 @@ function applyEnvironmentVariableAddendum(argv, yargs) {
   return argv;
 }
 
-function warnDeviceAppLaunchArgsDeprecation(argv) {
-  if (argv['device-boot-args'] && process.argv.some(a => a.startsWith('--device-launch-args'))) {
-    log.warn(DEVICE_LAUNCH_ARGS_DEPRECATION);
-  }
-
-  return argv;
-}
-
 /**
  * @param {Record<string, *>} argv
  * @returns {{
@@ -64,12 +57,10 @@ function splitArgv(argv) {
 // noinspection JSUnusedGlobalSymbols
 module.exports = {
   applyEnvironmentVariableAddendum,
-  warnDeviceAppLaunchArgsDeprecation,
   splitArgv,
 };
 
 module.exports.default = [
   applyEnvironmentVariableAddendum,
-  warnDeviceAppLaunchArgsDeprecation,
   splitArgv,
 ];

package/local-cli/testCommand/warnings.js

@@ -1,5 +1,3 @@
-const { DEVICE_LAUNCH_ARGS_DEPRECATION } = require('../../src/configuration/utils/warnings');
-
 const DETOX_ARGV_OVERRIDE_NOTICE = `
    _____ _____ ___________
   /  ___|_   _|  _  | ___ \\  $DETOX_ARGV_OVERRIDE is detected
@@ -22,5 +20,4 @@ const DETOX_ARGV_OVERRIDE_NOTICE = `
 
 module.exports = {
   DETOX_ARGV_OVERRIDE_NOTICE,
-  DEVICE_LAUNCH_ARGS_DEPRECATION,
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "detox",
   "description": "E2E tests and automation for mobile",
-  "version": "20.1.0-next-is-hittable-check.0",
+  "version": "20.1.0",
   "bin": {
     "detox": "local-cli/cli.js"
   },
@@ -35,8 +35,8 @@
     "@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",
@@ -46,10 +46,10 @@
     "eslint-plugin-no-only-tests": "^2.6.0",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-unicorn": "^39.0.0",
-    "jest": "^28.0.0",
+    "jest": "^28.1.3",
     "mockdate": "^2.0.1",
     "prettier": "1.7.0",
-    "react-native": "0.69.5",
+    "react-native": "0.69.7",
     "react-native-codegen": "^0.0.8",
     "typescript": "^4.5.2",
     "wtfnode": "^0.9.1"
@@ -58,12 +58,12 @@
     "ajv": "^8.6.3",
     "bunyan": "^1.8.12",
     "bunyan-debug-stream": "^3.1.0",
+    "caf": "^15.0.1",
     "chalk": "^2.4.2",
     "child-process-promise": "^2.2.0",
-    "duplexify": "^4.1.2",
     "find-up": "^4.1.0",
     "fs-extra": "^4.0.2",
-    "funpermaproxy": "^1.0.1",
+    "funpermaproxy": "^1.1.0",
     "glob": "^8.0.3",
     "ini": "^1.3.4",
     "json-cycle": "^1.3.0",
@@ -81,7 +81,6 @@
     "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.3.1",
@@ -100,7 +99,7 @@
     }
   },
   "engines": {
-    "node": ">=12.10.0"
+    "node": ">=14.5.0"
   },
   "jest": {
     "setupFiles": [
@@ -159,7 +158,11 @@
       "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,
@@ -177,12 +180,12 @@
     ],
     "coverageThreshold": {
       "global": {
-        "statements": 0,
-        "branches": 0,
-        "functions": 0,
-        "lines": 0
+        "statements": 100,
+        "branches": 100,
+        "functions": 100,
+        "lines": 100
       }
     }
   },
-  "gitHead": "941babbb7b2b0ebef688a92b6f616f83ea738468"
+  "gitHead": "57097c7301cae2460bd3b36c1749c4048d84dd39"
 }

package/runners/deprecation.js

@@ -1,47 +1,45 @@
 const chalk = require('chalk');
 
 // @ts-ignore
-console.error(chalk.yellow(`
-=========================  THE NEW JOURNEY BEGINS  =============================
-
-            https://wix.github.io/Detox/docs/next/guide/migration
-
-             _.-;-._              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://wix.github.io/Detox/docs/next/guide/migration
-
-=========================  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/index.d.ts

@@ -0,0 +1,60 @@
+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 handleTestEvent: (event: unknown, state: unknown) => void | Promise<void>;
+    public readonly testPath: string;
+
+    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

@@ -5,20 +5,31 @@ const JestVerboseReporter = require(resolveFrom(process.cwd(), '@jest/reporters'
 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
    */
-  async onTestResult(test, testResult, results) {
-    await super.onTestResult(test, testResult, results);
+  _isPermanentFailure(testResult) {
+    if (config.testRunner.jest.retryAfterCircusRetries) {
+      return false;
+    }
 
-    await reportTestResults([{
-      success: !testResult.failureMessage,
-      testFilePath: testResult.testFilePath,
-      testExecError: testResult.testExecError,
-      isPermanentFailure: config.testRunner.jest.retryAfterCircusRetries
-        ? false
-        : testResult.testResults.some(r => r.status === 'failed' && r.invocations > 1)
-    }]);
+    return testResult.testResults.some(r => r.status === 'failed' && r.invocations > 1);
   }
 }
 

package/runners/jest/testEnvironment/index.js

@@ -1,3 +1,5 @@
+const path = require('path');
+
 const resolveFrom = require('resolve-from');
 const maybeNodeEnvironment = require(resolveFrom(process.cwd(), 'jest-environment-node'));
 /** @type {typeof import('@jest/environment').JestEnvironment} */
@@ -39,7 +41,7 @@ class DetoxCircusEnvironment extends NodeEnvironment {
     this._timer = new Timer();
 
     /** @internal */
-    this.testPath = context.testPath;
+    this.testPath = path.relative(process.cwd(), context.testPath);
     /** @protected */
     this.testEventListeners = [];
     /** @protected */
@@ -49,45 +51,8 @@ class DetoxCircusEnvironment extends NodeEnvironment {
 
     log.trace.begin(this.testPath);
 
-    const _setup = this.setup.bind(this);
-    this.setup = 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();
-        }
-      });
-    };
-
-    const _teardown = this.teardown.bind(this);
-    this.teardown = 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();
-        }
-      });
-    };
+    this.setup = this._wrapSetup(this.setup);
+    this.teardown = this._wrapTeardown(this.teardown);
 
     this.registerListeners({
       DetoxInitErrorListener,
@@ -100,6 +65,7 @@ class DetoxCircusEnvironment extends NodeEnvironment {
 
   /** @override */
   async setup() {
+    await super.setup();
     await this.initDetox();
   }
 
@@ -115,7 +81,11 @@ class DetoxCircusEnvironment extends NodeEnvironment {
 
   /** @override */
   async teardown() {
-    await this.cleanupDetox();
+    try {
+      await this.cleanupDetox();
+    } finally {
+      await super.teardown();
+    }
   }
 
   /** @protected */
@@ -184,6 +154,52 @@ class DetoxCircusEnvironment extends NodeEnvironment {
       }
     }
   }
+
+  _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();
+        }
+      });
+    };
+  }
 }
 
 module.exports = DetoxCircusEnvironment;

package/runners/jest/testEnvironment/listeners/DetoxCoreListener.js

@@ -11,8 +11,8 @@ const log = detoxInternals.log.child({ cat: 'lifecycle,jest-environment' });
 
 class DetoxCoreListener {
   constructor({ env }) {
-    this._startedTests = new WeakSet();
-    this._testsFailedBeforeStart = new WeakSet();
+    this._startedTests = new Set();
+    this._testsFailedBeforeStart = new Set();
     this._env = env;
     this._circusRetryTimes = 1;
   }
@@ -41,10 +41,22 @@ class DetoxCoreListener {
   }
 
   async test_start({ test }) {
-    if (!_.isEmpty(test.errors)) {
+    const metadata = this._getTestMetadata(test);
+    if (metadata.status === 'failed') {
       this._testsFailedBeforeStart.add(test);
     }
 
+    const logTrace = this._isTestSkipped(test)
+      ? log.trace
+      : log.trace.begin;
+
+    logTrace({
+      context: 'test',
+      status: metadata.status,
+      fullName: metadata.fullName,
+      invocations: metadata.invocations,
+    }, metadata.title);
+
     const circusRetryTimes = +this._env.global[RETRY_TIMES];
     this._circusRetryTimes = isNaN(circusRetryTimes) ? 1 : 1 + circusRetryTimes;
   }
@@ -69,7 +81,11 @@ class DetoxCoreListener {
 
   async test_fn_start({ test }) {
     await this._onBeforeActualTestStart(test);
-    log.trace.begin({ functionCode: test.fn.toString() }, 'test_fn');
+
+    if (!this._testsFailedBeforeStart.has(test)) {
+      // Jest bug workaround: beforeAll hook errors result into an unterminated test_fn_start event.
+      log.trace.begin({ functionCode: test.fn.toString() }, 'test_fn');
+    }
   }
 
   async test_fn_success() {
@@ -82,57 +98,68 @@ class DetoxCoreListener {
   }
 
   async test_done({ test }) {
-    if (this._startedTests.has(test)) {
-      const failed = test.errors.length > 0;
-      const metadata = {
-        ...this._getTestMetadata(test),
-        status: failed ? 'failed' : 'passed',
-        timedOut: failed ? hasTimedOut(test) : undefined,
-      };
+    const metadata = this._getTestMetadata(test);
 
+    if (this._startedTests.has(test)) {
       await detoxInternals.onTestDone(metadata);
       this._startedTests.delete(test);
-      log.trace.end({
-        status: metadata.status,
-        timedOut: metadata.timedOut,
-      });
     }
+
+    log.trace.end(_.pick(metadata, ['status', 'timedOut']));
   }
 
   async _onBeforeActualTestStart(test) {
-    if (!test || test.status === 'skip' || this._startedTests.has(test) || this._testsFailedBeforeStart.has(test)) {
-      return false;
+    if (!this._isTestActuallyStarting(test)) {
+      return;
     }
 
-    const metadata = {
-      ...this._getTestMetadata(test),
-      status: 'running',
-    };
-
     this._startedTests.add(test);
+    await detoxInternals.onTestStart(this._getTestMetadata(test));
+  }
 
-    log.trace.begin({
-      context: 'test',
-      status: metadata.status,
-      fullName: metadata.fullName,
-      invocations: metadata.invocations,
-    }, metadata.title);
-
-    await detoxInternals.onTestStart(metadata);
-    return true;
+  _isTestActuallyStarting(test) {
+    return test && !this._isTestSkipped(test) && !this._startedTests.has(test) && !this._testsFailedBeforeStart.has(test);
   }
 
-  _getTestInvocations(test) {
-    const { testSessionIndex } = detoxInternals.session;
-    return testSessionIndex * this._circusRetryTimes + test.invocations;
+  _isTestSkipped(test) {
+    return test && (test.mode === 'skip' || test.mode === 'todo');
   }
 
   _getTestMetadata(test) {
-    return {
+    const result = {
       title: test.name,
       fullName: getFullTestName(test),
+      status: this._getTestStatus(test),
       invocations: this._getTestInvocations(test),
     };
+
+    if (result.status === 'failed') {
+      result.timedOut = hasTimedOut(test);
+    }
+
+    return result;
+  }
+
+  /** @returns { 'failed' | 'passed' | 'running' | 'skip' | 'todo' } */
+  _getTestStatus(test) {
+    if (!_.isEmpty(test.errors)) {
+      return 'failed';
+    }
+
+    if (this._isTestSkipped(test)) {
+      return test.mode;
+    }
+
+    if (test.status === 'done') {
+      return 'passed';
+    } else {
+      return test.status || 'running';
+    }
+  }
+
+  _getTestInvocations(test) {
+    const { testSessionIndex } = detoxInternals.session;
+    return testSessionIndex * this._circusRetryTimes + test.invocations;
   }
 }