detox 20.0.2-breaking.new-global-lifecycle.0 → 20.0.2

package/local-cli/testCommand/TestRunnerCommand.js

@@ -5,51 +5,86 @@ const parser = require('yargs-parser');
 const unparse = require('yargs-unparser');
 
 const detox = require('../../internals');
-const { DetoxRuntimeError } = require('../../src/errors');
+const log = detox.log.child({ cat: ['lifecycle', 'cli'] });
 const { printEnvironmentVariables, prependNodeModulesBinToPATH } = require('../../src/utils/envUtils');
-const { escapeSpaces } = require('../../src/utils/shellUtils');
+const { toSimplePath } = require('../../src/utils/pathUtils');
+const { escapeSpaces, useForwardSlashes } = require('../../src/utils/shellUtils');
+
+const TestRunnerError = require('./TestRunnerError');
 
 class TestRunnerCommand {
-  constructor() {
-    this._argv = {};
-    this._env = {};
-    this._envHint = {};
-    this._retries = 0;
-    /** @type {Detox.DetoxDeviceConfig} */
-    this._deviceConfig = null;
+  /*
+    @param {object} opts
+    @param {DetoxInternals.RuntimeConfig} opts.config
+    @param {ProcessEnv} opts.env
+  */
+  constructor(opts) {
+    const cliConfig = opts.config.cli;
+    const deviceConfig = opts.config.device;
+    const runnerConfig = opts.config.testRunner;
+
+    this._argv = runnerConfig.args;
+    this._retries = runnerConfig.retries;
+    this._envHint = this._buildEnvHint(opts.env);
+    this._envFwd = {};
+    if (runnerConfig.forwardEnv) {
+      this._envFwd = this._buildEnvOverride(cliConfig, deviceConfig);
+      Object.assign(this._envHint, this._envFwd);
+    }
   }
 
-  /**
-   * @param {Detox.DetoxDeviceConfig} config
-   * @returns {this}
-   */
-  setDeviceConfig(config) {
-    this._deviceConfig = config;
+  async execute() {
+    let runsLeft = 1 + this._retries;
+    let launchError = null;
 
-    return this;
-  }
+    do {
+      try {
+        await this._spawnTestRunner();
+        launchError = null;
+      } catch (e) {
+        launchError = e;
 
-  /**
-   * @param {Detox.DetoxTestRunnerConfig} config
-   * @returns {this}
-   */
-  setRunnerConfig(config) {
-    this._argv = config.args;
-    this._retries = config.retries;
+        const failedTestFiles = detox.session.testResults.filter(r => !r.success);
+
+        const { bail } = detox.config.testRunner;
+        if (bail && failedTestFiles.some(r => r.isPermanentFailure)) {
+          throw e;
+        }
+
+        const testFilesToRetry = failedTestFiles.filter(r => !r.isPermanentFailure).map(r => r.testFilePath);
+        if (_.isEmpty(testFilesToRetry)) {
+          throw e;
+        }
 
-    if (config.inspectBrk === true) {
-      this._env = this._envHint;
+        if (--runsLeft > 0) {
+          // @ts-ignore
+          detox.session.testSessionIndex++; // it is always the primary context, so we can update it
+
+          this._argv._ = testFilesToRetry.map(useForwardSlashes);
+          this._logRelaunchError(testFilesToRetry);
+        }
+      }
+    } while (launchError && runsLeft > 0);
+
+    if (launchError) {
+      throw launchError;
     }
+  }
 
-    return this;
+  _buildEnvHint(env) {
+    return _(env)
+      .mapKeys((_value, key) => key.toUpperCase())
+      .pickBy((_value, key) => key.startsWith('DETOX_'))
+      .omit(['DETOX_CONFIG_SNAPSHOT_PATH'])
+      .value();
   }
 
   /**
-   * @param {Partial<Readonly<DetoxInternals.DetoxCLIConfig>>} cliConfig
-   * @returns {this}
+   * @param {DetoxInternals.CLIConfig} cliConfig
+   * @param {Detox.DetoxDeviceConfig} deviceConfig
    */
-  replicateCLIConfig(cliConfig) {
-    this._envHint = _.omitBy({
+  _buildEnvOverride(cliConfig, deviceConfig) {
+    return _.omitBy({
       DETOX_APP_LAUNCH_ARGS: cliConfig.appLaunchArgs,
       DETOX_ARTIFACTS_LOCATION: cliConfig.artifactsLocation,
       DETOX_CAPTURE_VIEW_HIERARCHY: cliConfig.captureViewHierarchy,
@@ -59,7 +94,7 @@ class TestRunnerCommand {
       DETOX_DEBUG_SYNCHRONIZATION: cliConfig.debugSynchronization,
       DETOX_DEVICE_BOOT_ARGS: cliConfig.deviceBootArgs,
       DETOX_DEVICE_NAME: cliConfig.deviceName,
-      DETOX_FORCE_ADB_INSTALL: this._deviceConfig.type.startsWith('android.')
+      DETOX_FORCE_ADB_INSTALL: deviceConfig.type.startsWith('android.')
         ? cliConfig.forceAdbInstall
         : undefined,
       DETOX_GPU: cliConfig.gpu,
@@ -76,50 +111,13 @@ class TestRunnerCommand {
       DETOX_TAKE_SCREENSHOTS: cliConfig.takeScreenshots,
       DETOX_USE_CUSTOM_LOGGER: cliConfig.useCustomLogger,
     }, _.isUndefined);
-
-    return this;
-  }
-
-  async execute() {
-    let runsLeft = 1 + this._retries;
-    let launchError;
-
-    do {
-      try {
-        if (launchError) {
-          const list = this._argv._.map((file, index) => `  ${index + 1}. ${file}`).join('\n');
-          detox.log.error({ event: 'RETRY_RUN' },
-            `There were failing tests in the following files:\n${list}\n\n` +
-            'Detox CLI is going to restart the test runner with those files...\n'
-          );
-        }
-
-        await this._doExecute();
-        launchError = null;
-      } catch (e) {
-        launchError = e;
-
-        const { failedTestFiles, testFilesToRetry } = detox.session;
-        if (!_.isEmpty(failedTestFiles) || _.isEmpty(testFilesToRetry)) {
-          throw e;
-        }
-
-        this._argv._ = testFilesToRetry.splice(0, Infinity);
-        // @ts-ignore
-        detox.session.testSessionIndex++; // it is always a primary context, so we can update it
-      }
-    } while (launchError && --runsLeft > 0);
-
-    if (launchError) {
-      throw launchError;
-    }
   }
 
-  async _doExecute() {
+  async _spawnTestRunner() {
     const fullCommand = this._buildSpawnArguments().map(escapeSpaces);
     const fullCommandWithHint = printEnvironmentVariables(this._envHint) + fullCommand.join(' ');
 
-    detox.log.info({ event: 'RUN_START', env: this._envHint }, fullCommandWithHint);
+    log.info.begin({ env: this._envHint }, fullCommandWithHint);
 
     return new Promise((resolve, reject) => {
       cp.spawn(fullCommand[0], fullCommand.slice(1), {
@@ -127,20 +125,31 @@ class TestRunnerCommand {
         stdio: 'inherit',
         env: _({})
           .assign(process.env)
-          .assign(this._env)
+          .assign(this._envFwd)
           .omitBy(_.isUndefined)
           .tap(prependNodeModulesBinToPATH)
           .value()
       })
-        .on('error', (err) => reject(err))
-        .on('exit', (code) => code === 0
-          ? resolve()
-          : reject(new DetoxRuntimeError(`Command failed with exit code = ${code}:\n${fullCommandWithHint}`)
-        ));
+        .on('error', /* istanbul ignore next */ (err) => reject(err))
+        .on('exit', (code, signal) => {
+          if (code === 0) {
+            log.trace.end({ success: true });
+            resolve();
+          } else {
+            const error = new TestRunnerError({
+              command: fullCommandWithHint,
+              code,
+              signal,
+            });
+            log.error.end({ success: false, code, signal }, error.message);
+            reject(error);
+          }
+        });
     });
   }
 
   _buildSpawnArguments() {
+    /* istanbul ignore next */
     const { _: specs = [], '--': passthrough = [], $0, ...argv } = this._argv;
     const { _: $0_, ...$0argv } = parser($0);
 
@@ -151,6 +160,17 @@ class TestRunnerCommand {
       ...unparse({ _: [...passthrough, ...specs] }),
     ].map(String);
   }
+
+  _logRelaunchError(filePaths) {
+    const list = filePaths.map((file, index) => {
+      return `  ${index + 1}. ${toSimplePath(file)}`;
+    }).join('\n');
+
+    log.error(
+      `There were failing tests in the following files:\n${list}\n\n` +
+      'Detox CLI is going to restart the test runner with those files...\n'
+    );
+  }
 }
 
 module.exports = TestRunnerCommand;

package/local-cli/testCommand/TestRunnerError.js

@@ -0,0 +1,17 @@
+const { DetoxError } = require('../../src/errors');
+
+class TestRunnerError extends DetoxError {
+  constructor({ command, code, signal }) {
+    super(`Command failed with exit code = ${code}:\n${command}`);
+
+    this.code = code;
+    this.signal = signal;
+    this.name = 'TestRunnerError';
+  }
+
+  format() {
+    return '';
+  }
+}
+
+module.exports = TestRunnerError;

package/local-cli/testCommand/TestRunnerError.test.js

@@ -0,0 +1,25 @@
+const { DetoxError } = require('../../src/errors');
+
+const TestRunnerError = require('./TestRunnerError');
+
+describe('TestRunnerError', () => {
+  let error;
+
+  beforeAll(() => {
+    error = new TestRunnerError({ command: 'foo', code: 1, signal: null });
+  });
+
+  it('should format an error message', () => {
+    expect(`${error}`).toMatch(/Command failed with exit code = 1:\nfoo/);
+  });
+
+  it('should assign properties (code, signal)', () => {
+    expect(error.code).toBe(1);
+    expect(error.signal).toBe(null);
+  });
+
+  it('should be formatted to an empty string', () => {
+    // So that the try-catch block in cli.js will not print it for the second time
+    expect(DetoxError.format(error)).toBe('');
+  });
+});

package/local-cli/testCommand/builder.js

@@ -109,7 +109,6 @@ module.exports = {
     describe: 'Override the device name specified in a configuration. Useful for running a single build configuration on multiple devices.',
   },
   'device-boot-args': {
-    alias: 'device-launch-args',
     group: 'Execution:',
     describe: 'Custom arguments to pass (through) onto the device (emulator/simulator) binary when booted.',
   },

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/local-cli/utils/jestInternals.js

@@ -4,6 +4,7 @@ const path = require('path');
 
 const _ = require('lodash');
 const resolveFrom = require('resolve-from');
+const semver = require('semver');
 
 const { DetoxRuntimeError } = require('../../src/errors');
 
@@ -50,7 +51,9 @@ function resolveJestCliArgs() {
 
   try {
     const jestCliManifest = resolveJestDependency(jestLocation, 'jest-cli/package.json');
-    const argsJsFile = path.join(path.dirname(jestCliManifest), 'build/cli/args.js');
+    const jestCliVersion = require(jestCliManifest).version;
+    const argsJsFilePath = semver.gt(jestCliVersion, '29.1.2') ? 'build/args.js' : 'build/cli/args.js';
+    const argsJsFile = path.join(path.dirname(jestCliManifest), argsJsFilePath);
 
     return require(argsJsFile);
   } catch (e) {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "detox",
   "description": "E2E tests and automation for mobile",
-  "version": "20.0.2-breaking.new-global-lifecycle.0",
+  "version": "20.0.2",
   "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.68.2",
+    "react-native": "0.69.7",
     "react-native-codegen": "^0.0.8",
     "typescript": "^4.5.2",
     "wtfnode": "^0.9.1"
@@ -57,13 +57,14 @@
   "dependencies": {
     "ajv": "^8.6.3",
     "bunyan": "^1.8.12",
-    "bunyan-debug-stream": "^3.0.2",
+    "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",
     "lodash": "^4.17.5",
@@ -83,7 +84,7 @@
     "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",
@@ -91,7 +92,7 @@
     "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 +100,7 @@
     }
   },
   "engines": {
-    "node": ">=12.10.0"
+    "node": ">=14.5.0"
   },
   "jest": {
     "setupFiles": [
@@ -158,7 +159,12 @@
       "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/ipc",
+      "src/realms"
     ],
     "resetMocks": true,
     "resetModules": true,
@@ -176,12 +182,12 @@
     ],
     "coverageThreshold": {
       "global": {
-        "statements": 0,
-        "branches": 0,
-        "functions": 0,
-        "lines": 0
+        "statements": 100,
+        "branches": 100,
+        "functions": 100,
+        "lines": 100
       }
     }
   },
-  "gitHead": "cda5a555ec90aaeafe8c557157270e36a2b27688"
+  "gitHead": "caef3fd2ce6fe7ad2a8267102ee521153abbcbb2"
 }

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,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
 };