detox 20.0.15-prerelease.0 → 20.1.0

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/package.json

@@ -1,7 +1,7 @@
 {
   "name": "detox",
   "description": "E2E tests and automation for mobile",
-  "version": "20.0.15-prerelease.0",
+  "version": "20.1.0",
   "bin": {
     "detox": "local-cli/cli.js"
   },
@@ -61,10 +61,9 @@
     "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",
@@ -82,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",
@@ -164,7 +162,6 @@
       "runners/jest/testEnvironment",
       "src/DetoxWorker.js",
       "src/logger/utils/streamUtils.js",
-      "src/ipc",
       "src/realms"
     ],
     "resetMocks": true,
@@ -190,5 +187,5 @@
       }
     }
   },
-  "gitHead": "5bfd04ef867767c3eb9690c418bf80588d367d3e"
+  "gitHead": "57097c7301cae2460bd3b36c1749c4048d84dd39"
 }

package/runners/deprecation.js

@@ -26,7 +26,7 @@ console.error(centerText(`\
 
 ${bold(header)}
 
-https://wix.github.io/Detox/docs/next/guide/migration
+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.
@@ -40,6 +40,6 @@ ${bold(header)}
 
 `, header.length));
 
-const error = new Error('\nPlease follow the migration guide:\nhttps://wix.github.io/Detox/docs/next/guide/migration\n\n');
+const error = new Error('\nPlease follow the migration guide:\nhttps://wix.github.io/Detox/docs/guide/migration\n\n');
 error.stack = '';
 throw error;

package/src/artifacts/utils/temporaryPath.js

@@ -1,14 +1,42 @@
 const path = require('path');
+const { promisify } = require('util');
 
+const glob = require('glob');
 const tempfile = require('tempfile');
 
+const { useForwardSlashes } = require('../../utils/shellUtils');
+
+const globSync = glob.sync;
+const globAsync = promisify(glob);
+
+function getRoot() {
+  return path.dirname(tempfile());
+}
+
+function createGlobber(ext) {
+  const fullExt = `.detox.${ext}`;
+
+  return {
+    sync: (pattern) => {
+      const cwd = getRoot();
+      const files = globSync(useForwardSlashes(pattern + fullExt), { cwd });
+      return files.map(f => path.join(cwd, f));
+    },
+    async: async (pattern) => {
+      const cwd = getRoot();
+      const files = await globAsync(useForwardSlashes(pattern + fullExt), { cwd });
+      return files.map(f => path.join(cwd, f));
+    },
+  };
+}
+
 function createTempFileBuilderFn(fileExtension) {
   /**
    * @param {string} [basename]
    */
   return (basename) => {
     return basename
-      ? path.join(path.dirname(tempfile()), `${basename}.detox.${fileExtension}`)
+      ? path.join(getRoot(), `${basename}.detox.${fileExtension}`)
       : tempfile(`.detox.${fileExtension}`);
   };
 }
@@ -23,5 +51,7 @@ module.exports = {
     dtxrec: createTempFileBuilderFn('dtxrec'),
     viewhierarchy: createTempFileBuilderFn('viewhierarchy'),
   },
-  mask: () => path.join(tempfile(), '..') + path.sep + '*.detox.*',
+  find: {
+    jsonl: createGlobber('jsonl'),
+  },
 };

package/src/client/actions/SyncStatusSchema.json

@@ -232,6 +232,27 @@
                 ],
                 "additionalProperties":false
               },
+              {
+                "properties":{
+                  "name":{
+                    "const":"bg"
+                  },
+                  "description":{
+                    "type":"object",
+                    "properties":{
+                      "reason":{
+                        "type":"string"
+                      }
+                    },
+                    "additionalProperties":false
+                  }
+                },
+                "required":[
+                  "name",
+                  "description"
+                ],
+                "additionalProperties":false
+              },
               {
                 "properties":{
                   "name":{

package/src/client/actions/formatters/SyncStatusFormatter.js

@@ -4,6 +4,7 @@ const Ajv = require('ajv');
 const DetoxInternalError = require('../../../errors/DetoxInternalError');
 const statusSchema = require('../SyncStatusSchema.json');
 
+const bgThreadFormatter = require('./sync-resources/BgThreadFormatter');
 const delayedPerformSelectorFormatter = require('./sync-resources/DelayedPerformSelectorFormatter');
 const dispatchQueueFormatter = require('./sync-resources/DispatchQueueFormatter');
 const jsTimersFormatter = require('./sync-resources/JavaScriptTimersFormatter');
@@ -51,6 +52,7 @@ function resourcesDescriptionsFromJSON(jsonDescriptions) {
 }
 
 const resourceFormatters = {
+  bg: bgThreadFormatter,
   delayed_perform_selector: delayedPerformSelectorFormatter,
   dispatch_queue: dispatchQueueFormatter,
   run_loop: runLoopFormatter,

package/src/client/actions/formatters/sync-resources/BgThreadFormatter.js

@@ -0,0 +1,5 @@
+const { makeResourceTitle } = require('./utils');
+
+module.exports = function(properties) {
+  return `${makeResourceTitle(`Background work taking place in ${properties.reason}.`)}`;
+};

package/src/configuration/composeRunnerConfig.js

@@ -91,7 +91,7 @@ function adaptLegacyRunnerConfig(globalConfig) {
     return globalConfig.testRunner;
   }
 
-  log.warn(`Please migrate your Detox config according to the guide:\nhttps://wix.github.io/Detox/docs/next/guide/migration\n`);
+  log.warn(`Please migrate your Detox config according to the guide:\nhttps://wix.github.io/Detox/docs/guide/migration\n`);
   const testRunner = globalConfig[testRunnerKey];
   const runnerConfig = globalConfig[runnerConfigKey];
   const specs = globalConfig.specs != null ? String(globalConfig.specs) : undefined;

package/src/devices/allocation/drivers/android/emulator/EmulatorLauncher.js

@@ -36,7 +36,7 @@ class EmulatorLauncher extends DeviceLauncher {
         retries: 2,
         interval: 100,
         conditionFn: isUnknownEmulatorError,
-      }, () => this._launchEmulator(avdName, launchCommand));
+      }, () => this._launchEmulator(avdName, launchCommand, adbName));
     }
     await this._awaitEmulatorBoot(adbName);
     await this._notifyBootEvent(adbName, avdName, !isRunning);
@@ -60,8 +60,8 @@ class EmulatorLauncher extends DeviceLauncher {
     await this._notifyShutdownCompleted(adbName);
   }
 
-  _launchEmulator(emulatorName, launchCommand) {
-    return launchEmulatorProcess(emulatorName, this._emulatorExec, launchCommand);
+  _launchEmulator(emulatorName, launchCommand, adbName) {
+    return launchEmulatorProcess(emulatorName, this._emulatorExec, launchCommand, this._adb, adbName);
   }
 
   async _awaitEmulatorBoot(adbName) {

package/src/devices/allocation/drivers/android/emulator/launchEmulatorProcess.js

@@ -1,29 +1,15 @@
 const fs = require('fs');
 
 const _ = require('lodash');
-const { Tail } = require('tail');
 
 const unitLogger = require('../../../../../utils/logger').child({ cat: 'device' });
 
-function launchEmulatorProcess(emulatorName, emulatorExec, emulatorLaunchCommand) {
+function launchEmulatorProcess(emulatorName, emulatorExec, emulatorLaunchCommand, adb, adbName) {
   let childProcessOutput;
-
   const portName = emulatorLaunchCommand.port ? `-${emulatorLaunchCommand.port}` : '';
   const tempLog = `./${emulatorName}${portName}.log`;
   const stdout = fs.openSync(tempLog, 'a');
   const stderr = fs.openSync(tempLog, 'a');
-  const tailOptions = {
-    useWatchFile: true,
-    fsWatchOptions: {
-      interval: 1500,
-    },
-  };
-  const tail = new Tail(tempLog, tailOptions)
-    .on('line', (line) => {
-      if (line.includes('Adb connected, start proxing data')) {
-        childProcessPromise._cpResolve();
-      }
-    });
 
   function detach() {
     if (childProcessOutput) {
@@ -32,7 +18,6 @@ function launchEmulatorProcess(emulatorName, emulatorExec, emulatorLaunchCommand
 
     childProcessOutput = fs.readFileSync(tempLog, 'utf8');
 
-    tail.unwatch();
     fs.closeSync(stdout);
     fs.closeSync(stderr);
     fs.unlink(tempLog, _.noop);
@@ -46,6 +31,8 @@ function launchEmulatorProcess(emulatorName, emulatorExec, emulatorLaunchCommand
 
   log = log.child({ child_pid: childProcessPromise.childProcess.pid });
 
+  adb.waitForDevice(adbName).then(() => childProcessPromise._cpResolve());
+
   return childProcessPromise.then(() => true).catch((err) => {
     detach();
 

package/src/devices/common/drivers/android/exec/ADB.js

@@ -189,6 +189,10 @@ class ADB {
     }
   }
 
+  async waitForDevice(deviceId) {
+    return await this.adbCmd(deviceId, 'wait-for-device');
+  }
+
   async apiLevel(deviceId) {
     if (this._cachedApiLevels.has(deviceId)) {
       return this._cachedApiLevels.get(deviceId);

package/src/devices/common/drivers/ios/tools/AppleSimUtils.js

@@ -93,7 +93,7 @@ class AppleSimUtils {
       `(https://developer.apple.com/xcode/). In case you already have the latest Xcode version installed, ` +
       `try run the command: \`sudo xcode-select -s /Applications/Xcode.app\`. If you are running tests from CI, ` +
       `we recommend running them with "--headless" device configuration (see: ` +
-      `https://wix.github.io/Detox/docs/next/cli/test/#options).`
+      `https://wix.github.io/Detox/docs/cli/test/#options).`
     );
   }
 

package/src/devices/lifecycle/GenyGlobalLifecycleHandler.js

@@ -6,7 +6,9 @@ const cleanupLogData = {
 
 class GenyGlobalLifecycleHandler {
   constructor({ deviceCleanupRegistry, instanceLifecycleService }) {
+    /** @private */
     this._deviceCleanupRegistry = deviceCleanupRegistry;
+    /** @private */
     this._instanceLifecycleService = instanceLifecycleService;
   }
 

package/src/errors/DetoxError.js

@@ -8,6 +8,10 @@ class DetoxError extends Error {
     this.name = 'DetoxError';
   }
 
+  format() {
+    return this.message;
+  }
+
   static get reportIssue() {
     return 'Please report this issue on our GitHub tracker:\nhttps://github.com/wix/Detox/issues';
   }
@@ -32,7 +36,7 @@ class DetoxError extends Error {
    */
   static format(err, inspectOptions = { depth: 1 }) {
     if (err instanceof DetoxError) {
-      return err.message;
+      return err.format();
     }
 
     if (_.isError(err) && /^Command failed:/.test(err.message)) {

package/src/ipc/IPCClient.js

@@ -4,21 +4,21 @@ const { DetoxInternalError } = require('../errors');
 const { serializeObjectWithError } = require('../utils/errorUtils');
 
 class IPCClient {
-  constructor({ id, logger, state }) {
+  constructor({ id, logger, sessionState }) {
     this._id = id;
     /** @type {import('../logger/DetoxLogger')} logger */
     this._logger = logger.child({ cat: 'ipc' });
     /** @type {import('./SessionState')} */
-    this._state = state;
+    this._sessionState = sessionState;
 
-    this._client = null;
+    this._ipc = null;
     this._serverConnection = null;
   }
 
   async init() {
-    this._client = new IPC();
+    this._ipc = new IPC();
 
-    Object.assign(this._client.config, {
+    Object.assign(this._ipc.config, {
       id: this._id,
       appspace: 'detox.',
       logger: (msg) => this._logger.trace(msg),
@@ -33,14 +33,22 @@ class IPCClient {
   async dispose() {
     this._serverConnection = null;
 
-    if (this._client) {
-      this._client.disconnect(this.serverId);
-      this._client = null;
+    if (this._ipc) {
+      await new Promise((resolve, reject) => {
+        this._ipc.of[this.serverId]
+          // @ts-ignore
+          .once('disconnect', resolve)
+          .once('error', reject);
+
+        this._ipc.disconnect(this.serverId);
+      });
+
+      this._ipc = null;
     }
   }
 
   get sessionState() {
-    return this._state;
+    return this._sessionState;
   }
 
   get serverId() {
@@ -49,7 +57,7 @@ class IPCClient {
 
   async registerWorker(workerId) {
     const sessionState = await this._emit('registerWorker', { workerId });
-    this._state.patch(sessionState);
+    this._sessionState.patch(sessionState);
   }
 
   /**
@@ -59,18 +67,18 @@ class IPCClient {
     const sessionState = await this._emit('reportTestResults', {
       testResults: testResults.map(r => serializeObjectWithError(r, 'testExecError')),
     });
-    this._state.patch(sessionState);
+    this._sessionState.patch(sessionState);
   }
 
   async _connectToServer() {
     const serverId = this.serverId;
 
     this._serverConnection = await new Promise((resolve, reject) => {
-      this._client.connectTo(serverId, (client) => {
+      this._ipc.connectTo(serverId, (client) => {
         client.of[serverId]
-          .on('error', reject)
-          .on('disconnect', () => reject(new DetoxInternalError('IPC server has unexpectedly disconnected.')))
-          .on('connect', () => resolve(client.of[serverId]));
+          .once('error', reject)
+          .once('disconnect', () => reject(new DetoxInternalError('IPC server has unexpectedly disconnected.')))
+          .once('connect', () => resolve(client.of[serverId]));
       });
     });
 
@@ -79,7 +87,7 @@ class IPCClient {
 
   async _registerContext() {
     const sessionState = await this._emit('registerContext', { id: this._id });
-    this._state.patch(sessionState);
+    this._sessionState.patch(sessionState);
   }
 
   async _emit(event, payload) {
@@ -90,6 +98,7 @@ class IPCClient {
     return new Promise((resolve, reject) => {
       const server = this._serverConnection;
 
+      /* istanbul ignore next */
       function onError(err) {
         server.off('error', onError);
         server.off(`${event}Done`, onDone);
@@ -110,7 +119,7 @@ class IPCClient {
   }
 
   _onSessionStateUpdate = (payload) => {
-    this._state.patch(payload);
+    this._sessionState.patch(payload);
   };
 }
 

package/src/ipc/IPCServer.js

@@ -14,12 +14,17 @@ class IPCServer {
     this._logger = logger.child({ cat: 'ipc,ipc-server' });
     this._ipc = null;
     this._workers = new Set();
+    this._contexts = new Set();
   }
 
   get id() {
     return this._sessionState.detoxIPCServer;
   }
 
+  get contexts() {
+    return [...this._contexts];
+  }
+
   get sessionState() {
     return this._sessionState;
   }
@@ -45,15 +50,18 @@ class IPCServer {
       return;
     }
 
-    return new Promise((resolve, reject) =>{
+    await new Promise((resolve, reject) =>{
       // @ts-ignore
-      this._ipc.server.server.close(e => e ? reject(e) : resolve());
+      this._ipc.server.server.close(e => /* istanbul ignore next */
+        e ? reject(e) : resolve());
       this._ipc.server.stop();
     });
+
+    this._ipc = null;
   }
 
   onRegisterContext({ id }, socket) {
-    this._sessionState.contexts.push(id);
+    this._contexts.add(id);
 
     this._ipc.server.emit(socket, 'registerContextDone', {
       testResults: this._sessionState.testResults,

package/src/ipc/SessionState.js

@@ -9,7 +9,6 @@ const context = vm.createContext({ require }, {
 class SessionState {
   constructor({
     id = '',
-    contexts = [],
     detoxConfig = null,
     detoxIPCServer = '',
     testResults = [],
@@ -17,7 +16,6 @@ class SessionState {
     workersCount = 0
   }) {
     this.id = id;
-    this.contexts = contexts;
     this.detoxConfig = detoxConfig;
     this.detoxIPCServer = detoxIPCServer;
     this.testResults = testResults;
@@ -30,7 +28,7 @@ class SessionState {
   }
 
   stringify() {
-    return cycle.stringify(this, SessionState.stringifier);
+    return cycle.stringify(this, SessionState._stringifier);
   }
 
   /**
@@ -39,10 +37,10 @@ class SessionState {
   static parse(stringified) {
     const Class = this; // eslint-disable-line unicorn/no-this-assignment
     // @ts-ignore
-    return new Class(cycle.parse(stringified, SessionState.reviver));
+    return new Class(cycle.parse(stringified, SessionState._reviver));
   }
 
-  static reviver(key, val) {
+  static _reviver(key, val) {
     if (typeof val === 'object' && val !== null && typeof val.$fn == 'string') {
       return vm.runInContext(val.$fn, context);
     } else {
@@ -50,7 +48,7 @@ class SessionState {
     }
   }
 
-  static stringifier(key, val) {
+  static _stringifier(key, val) {
     if (typeof val === 'function') {
       return { $fn: `(${val})` };
     } else {

package/src/logger/DetoxLogger.js

@@ -19,11 +19,12 @@ const sanitizeBunyanContext = require('./utils/sanitizeBunyanContext');
  * @property {CategoryThreadDispatcher} [dispatcher]
  * @property {BunyanLogger} [bunyan]
  * @property {MessageStack} [messageStack]
+ * @property {boolean} [unsafeMode] Disables sanitization of user input, used for integration tests.
  */
 
 class DetoxLogger {
   /**
-   * @param {Pick<SharedLoggerConfig, 'file' | 'userConfig'>} sharedConfig
+   * @param {SharedLoggerConfig} sharedConfig
    * @param {object} [context]
    */
   constructor(sharedConfig, context) {
@@ -91,7 +92,7 @@ class DetoxLogger {
    * @returns {DetoxLogger}
    */
   child(overrides) {
-    const merged = this._mergeContexts(this._context, sanitizeBunyanContext(overrides));
+    const merged = this._mergeContexts(this._context, this._sanitizeContext(overrides));
     return new DetoxLogger(this._sharedConfig, merged);
   }
 
@@ -119,6 +120,25 @@ class DetoxLogger {
     this.overrideConsole();
   }
 
+  /**
+   * Closes the file descriptors to make sure that the temporary
+   * JSONL files are flushed and contain the last error messages.
+   * This safety measure is especially important for Windows OS.
+   *
+   * @async
+   * @internal
+   */
+  async close() {
+    if (this._context) {
+      throw new DetoxInternalError(
+        'Trying to close file streams from a non-root logger.\n' +
+        'If you are not fiddling with Detox internals on purpose, yet you see this error, then...'
+      );
+    }
+
+    await this._sharedConfig.bunyan.closeFileStreams();
+  }
+
   /**
    * @internal
    */
@@ -192,7 +212,7 @@ class DetoxLogger {
 
   /** @private */
   _beginInternal(level, context, msg) {
-    this._sharedConfig.messageStack.push(context.tid, msg);
+    this._sharedConfig.messageStack.push(context, msg);
     this._sharedConfig.bunyan.logger[level](context, ...msg);
   }
 
@@ -204,7 +224,7 @@ class DetoxLogger {
 
   /** @private */
   _endInternal(level, context, msg) {
-    const beginMsg = this._sharedConfig.messageStack.pop(context.tid);
+    const beginMsg = this._sharedConfig.messageStack.pop(context);
     if (msg.length === 0) {
       msg = beginMsg;
     }
@@ -272,12 +292,21 @@ class DetoxLogger {
     const context = this._mergeContexts(
       this._context,
       boundContext,
-      sanitizeBunyanContext(userContext),
+      this._sanitizeContext(userContext),
     );
 
     return { context, msg };
   }
 
+  /** @private */
+  _sanitizeContext(context) {
+    if (this._sharedConfig.unsafeMode) {
+      return context;
+    }
+
+    return sanitizeBunyanContext(context);
+  }
+
   /** @internal */
   static defaultOptions({ level }) {
     const ph = level === 'trace' || level === 'debug'

package/src/logger/utils/BunyanLogger.js

@@ -71,6 +71,45 @@ class BunyanLogger {
 
     return this;
   }
+
+  async closeFileStreams() {
+    const { _closeStream } = BunyanLogger;
+    const internalBunyanStreams = this._bunyan['streams'];
+    const openFileStreams = _.filter(internalBunyanStreams, this._isOpenFileStream);
+    _.remove(internalBunyanStreams, openFileStreams);
+
+    await Promise.all(openFileStreams.map(_closeStream));
+  }
+
+  /** @private */
+  _isOpenFileStream = (bunyanStream) => {
+    switch (bunyanStream.type) {
+      case 'file':
+        return bunyanStream.path && !bunyanStream.stream.destroyed;
+      case 'raw':
+        /* istanbul ignore next */
+        const stream = bunyanStream.stream === this._debugStream.stream
+          ? bunyanStream.stream._out
+          : bunyanStream.stream;
+
+        /* istanbul ignore next */
+        return stream.fd !== undefined && !stream.closed;
+    }
+  };
+
+  /** @private */
+  static _closeStream(bunyanStream) {
+    return new Promise((resolve, reject) => {
+      bunyanStream.stream.end((err) => {
+        /* istanbul ignore next */
+        if (err) {
+          reject(err);
+        } else {
+          resolve();
+        }
+      });
+    });
+  }
 }
 
 module.exports = BunyanLogger;

package/src/logger/utils/CategoryThreadDispatcher.js

@@ -1,4 +1,5 @@
 const ThreadDispatcher = require('./ThreadDispatcher');
+const getMainCategory = require('./getMainCategory');
 
 class CategoryThreadDispatcher {
   constructor() {
@@ -24,7 +25,7 @@ class CategoryThreadDispatcher {
 
   /** @returns {ThreadDispatcher} */
   _resolveDispatcher(cat) {
-    const mainCategory = cat ? cat.split(',', 1)[0] : 'undefined';
+    const mainCategory = getMainCategory(cat);
     if (!this._dispatchers[mainCategory]) {
       this._dispatchers[mainCategory] = new ThreadDispatcher(mainCategory);
     }