detox 20.0.14-next-is-hittable-check-2.0 → 20.0.14-prerelease.0

package/src/logger/utils/customConsoleLogger.js

@@ -25,20 +25,20 @@ function getStackDump() {
 
 function proxyLog(bunyanLoggerFn) {
   return (...args) => {
-    bunyanLoggerFn({ origin: getOrigin() }, util.format(...args));
+    bunyanLoggerFn({ cat: 'user', origin: getOrigin() }, util.format(...args));
   };
 }
 
 function proxyTracing(bunyanLoggerFn) {
   return (...args) => {
-    bunyanLoggerFn({ origin: getOrigin(), stack: getStackDump() }, util.format(...args));
+    bunyanLoggerFn({ cat: 'user', origin: getOrigin(), stack: getStackDump() }, util.format(...args));
   };
 }
 
 function proxyAssert(bunyanLoggerFn) {
   return (condition, ...args) => {
     if (!condition) {
-      bunyanLoggerFn({ origin: getOrigin() }, 'AssertionError:', util.format(...args));
+      bunyanLoggerFn({ cat: 'user', origin: getOrigin() }, 'AssertionError:', util.format(...args));
     }
   };
 }
@@ -48,6 +48,7 @@ function overrideConsoleMethods(console, bunyanLogger) {
     const log = bunyanLogger;
 
     override(console, 'log', log.info.bind(log));
+    override(console, 'info', log.info.bind(log));
     override(console, 'warn', log.warn.bind(log));
     override(console, 'trace', log.info.bind(log));
     override(console, 'error', log.error.bind(log));

package/src/logger/utils/streamUtils.js

@@ -3,14 +3,12 @@ const { PassThrough, Transform } = require('stream');
 const bunyanDebugStream = require('bunyan-debug-stream');
 const duplexify = require('duplexify');
 const fs = require('fs-extra');
-const glob = require('glob');
 const multiSort = require('multi-sort-stream');
 const pipe = require('multipipe');
 const JsonlParser = require('stream-json/jsonl/Parser');
 const stripAnsi = require('strip-ansi');
 const { AbstractEventBuilder } = require('trace-event-lib');
 
-const temporary = require('../../artifacts/utils/temporaryPath');
 const log = require('../../utils/logger').child({ cat: 'logger' });
 
 function compareTimestamps(a, b) {
@@ -143,27 +141,49 @@ class SimpleEventBuilder extends AbstractEventBuilder {
   }
 }
 
-function chromeTraceStream() {
+const ERROR_TID = 37707;
+
+function getTidHash({ pid, tid, cat }) {
+  const mainCategory = String(cat).split(',')[0];
+  return `${pid}:${mainCategory}:${tid}`;
+}
+
+function getFixedTID(tidHashMap, event) {
+  let tid = tidHashMap.get(getTidHash(event));
+  if (tid === undefined) {
+    tid = ERROR_TID;
+  }
+
+  return tid;
+}
+
+/**
+ * @param {Map<string, number>} [tidHashMap]
+ */
+function chromeTraceStream(tidHashMap) {
   const knownPids = new Set();
   const knownTids = new Set();
+  const fixTID = tidHashMap ? getFixedTID.bind(null, tidHashMap) : (x) => x.tid;
 
   return flatMapTransform((data) => {
     // eslint-disable-next-line no-unused-vars, @typescript-eslint/no-unused-vars
-    const { cat = 'default', msg: name, ph = 'i', pid, tid, time, name: _name, hostname: _hostname, ...args } = data;
+    const { cat: rawCat, msg: name, ph = 'i', pid, tid: _tid, time, name: _name, hostname: _hostname, ...args } = data;
     const ts = new Date(time).getTime() * 1E3;
+    const cat = rawCat || 'undefined';
+    const tid = fixTID(data);
 
     const builder = new SimpleEventBuilder();
     if (!knownPids.has(pid)) {
-      builder.process_name(pid === process.pid ? 'primary' : 'secondary', pid);
+      builder.metadata({ pid, ts, name: 'process_name', args: { name: pid === process.pid ? 'primary' : 'secondary' } });
+      builder.metadata({ pid, ts, name: 'process_sort_index', args: { sort_index: knownPids.size } });
       knownPids.add(pid);
     }
 
-    const tidHash = `${pid}:${tid}`;
-    if (!knownTids.has(tidHash)) {
+    if (!knownTids.has(tid)) {
       const primaryCategory = cat.split(',', 1)[0];
-      builder.thread_name(primaryCategory, tid, pid);
-      builder.thread_sort_index(tid, tid, pid);
-      knownTids.add(tidHash);
+      builder.metadata({ pid, tid, ts, name: 'thread_name', args: { name: primaryCategory } });
+      builder.metadata({ pid, tid, ts, name: 'thread_sort_index', args: { sort_index: tid } });
+      knownTids.add(tid);
     }
 
     const event = { ph, name, pid, tid, cat, ts, args };
@@ -207,25 +227,13 @@ function readJSONL() {
 }
 
 /**
- * @param {string} sessionId
+ * @param {string[]} logs
  * @returns {NodeJS.ReadableStream}
  */
-function uniteSessionLogs(sessionId) {
+function uniteSessionLogs(logs) {
   const readable = through();
-
-  glob(temporary.for.jsonl(`${sessionId}.*`), function (err, logs) {
-    if (err) {
-      return readable.emit('error', err);
-    }
-
-    if (logs.length === 0) {
-      return;
-    }
-
-    const jsonlStreams = logs.map(filePath => fs.createReadStream(filePath).pipe(readJSONL()));
-    mergeSortedJSONL(jsonlStreams).pipe(readable);
-  });
-
+  const jsonlStreams = logs.map(filePath => fs.createReadStream(filePath).pipe(readJSONL()));
+  mergeSortedJSONL(jsonlStreams).pipe(readable);
   return readable;
 }
 

package/src/realms/DetoxContext.js

@@ -2,13 +2,14 @@ const funpermaproxy = require('funpermaproxy');
 
 const temporary = require('../artifacts/utils/temporaryPath');
 const { DetoxRuntimeError } = require('../errors');
-const { DetoxLogger, installLegacyTracerInterface } = require('../logger');
+const { DetoxLogger, DetoxLogFinalizer, installLegacyTracerInterface } = require('../logger');
 const symbols = require('../symbols');
 
 const DetoxConstants = require('./DetoxConstants');
 
 //#region Protected symbols
 const $cleanup = Symbol('cleanup');
+const $logFinalizer = Symbol('logFinalizer');
 const $restoreSessionState = Symbol('restoreSessionState');
 const $sessionState = Symbol('restoreSessionState');
 const $status = Symbol('status');
@@ -58,6 +59,10 @@ class DetoxContext {
     this.log = this[symbols.logger].child({ cat: 'user' });
     installLegacyTracerInterface(this.log, this);
 
+    this[$logFinalizer] = new DetoxLogFinalizer({
+      session: this[$sessionState]
+    });
+
     /** @type {import('../DetoxWorker') | null} */
     this[$worker] = null;
   }
@@ -91,12 +96,7 @@ class DetoxContext {
   [symbols.config] = funpermaproxy(() => this[symbols.session].detoxConfig);
   [symbols.session] = funpermaproxy(() => this[$sessionState]);
   [symbols.tracing] = Object.freeze({
-    createEventStream: () => {
-      const streamUtils = require('../logger/utils/streamUtils');
-      return streamUtils
-        .uniteSessionLogs(this[$sessionState].id)
-        .pipe(streamUtils.chromeTraceStream());
-    },
+    createEventStream: () => this[$logFinalizer].createEventStream(),
   });
   /** @abstract */
   [symbols.reportTestResults](_testResults) {}
@@ -175,6 +175,7 @@ class DetoxContext {
 module.exports = DetoxContext;
 module.exports.protected = {
   $cleanup,
+  $logFinalizer,
   $restoreSessionState,
   $status,
   $sessionState,

package/src/realms/DetoxPrimaryContext.js

@@ -1,36 +1,29 @@
-const path = require('path');
 const { URL } = require('url');
-const { promisify } = require('util');
 
 const fs = require('fs-extra');
-const glob = require('glob');
-const pipe = require('multipipe');
 const onSignalExit = require('signal-exit');
 
 const temporary = require('../artifacts/utils/temporaryPath');
 const { DetoxRuntimeError } = require('../errors');
 const SessionState = require('../ipc/SessionState');
 const symbols = require('../symbols');
-
-const globAsync = promisify(glob);
-const globSync = glob.sync;
+const { getCurrentCommand } = require('../utils/argparse');
+const uuid = require('../utils/uuid');
 
 const DetoxContext = require('./DetoxContext');
 
 // Protected symbols
-const { $restoreSessionState, $sessionState, $worker } = DetoxContext.protected;
+const { $logFinalizer, $restoreSessionState, $sessionState, $worker } = DetoxContext.protected;
 
 //#region Private symbols
-const _finalizeLogs = Symbol('finalizeLogs');
-const _finalizeLogsSync = Symbol('finalizeLogsSync');
 const _globalLifecycleHandler = Symbol('globalLifecycleHandler');
 const _ipcServer = Symbol('ipcServer');
 const _resetLockFile = Symbol('resetLockFile');
 const _wss = Symbol('wss');
 const _dirty = Symbol('dirty');
 const _emergencyTeardown = Symbol('emergencyTeardown');
-const _areLogsEnabled = Symbol('areLogsEnabled');
 const _lifecycleLogger = Symbol('lifecycleLogger');
+const _sessionFile = Symbol('sessionFile');
 //#endregion
 
 class DetoxPrimaryContext extends DetoxContext {
@@ -40,6 +33,8 @@ class DetoxPrimaryContext extends DetoxContext {
     this[_dirty] = false;
     this[_wss] = null;
     this[_globalLifecycleHandler] = null;
+    /** Path to file where the initial session object is serialized */
+    this[_sessionFile] = '';
     /**
      * @type {import('../ipc/IPCServer') | null}
      */
@@ -91,8 +86,9 @@ class DetoxPrimaryContext extends DetoxContext {
     await this[symbols.logger].setConfig(loggerConfig);
 
     this[_lifecycleLogger].trace.begin({
+      cwd: process.cwd(),
       data: this[$sessionState],
-    }, process.argv.slice(1).join(' '));
+    }, getCurrentCommand());
 
     const IPCServer = require('../ipc/IPCServer');
     this[_ipcServer] = new IPCServer({
@@ -130,8 +126,10 @@ class DetoxPrimaryContext extends DetoxContext {
       sessionConfig.server = `ws://localhost:${this[_wss].port}`;
     }
 
-    await fs.writeFile(this[$sessionState].detoxConfigSnapshotPath, this[$sessionState].stringify());
-    process.env.DETOX_CONFIG_SNAPSHOT_PATH = this[$sessionState].detoxConfigSnapshotPath;
+    this[_sessionFile] = temporary.for.json(this[$sessionState].id);
+    await fs.writeFile(this[_sessionFile], this[$sessionState].stringify());
+    process.env.DETOX_CONFIG_SNAPSHOT_PATH = this[_sessionFile];
+    this[_lifecycleLogger].trace(`Serialized the session state at: ${this[_sessionFile]}`);
 
     if (opts.workerId !== null) {
       await this[symbols.installWorker](opts);
@@ -173,12 +171,14 @@ class DetoxPrimaryContext extends DetoxContext {
         this[_ipcServer] = null;
       }
 
-      await fs.remove(this[$sessionState].detoxConfigSnapshotPath);
+      if (this[_sessionFile]) {
+        await fs.remove(this[_sessionFile]);
+      }
 
       if (this[_dirty]) {
         try {
           this[_lifecycleLogger].trace.end();
-          await this[_finalizeLogs]();
+          await this[$logFinalizer].finalize();
         } catch (err) {
           this[_lifecycleLogger].error({ err }, 'Encountered an error while merging the process logs:');
         }
@@ -204,9 +204,13 @@ class DetoxPrimaryContext extends DetoxContext {
       this[_ipcServer].dispose();
     }
 
+    if (this[_sessionFile]) {
+      fs.removeSync(this[_sessionFile]);
+    }
+
     try {
       this[_lifecycleLogger].trace.end({ abortSignal: signal });
-      this[_finalizeLogsSync]();
+      this[$logFinalizer].finalizeSync();
     } catch (err) {
       this[symbols.logger].error({ err }, 'Encountered an error while merging the process logs:');
     }
@@ -222,77 +226,13 @@ class DetoxPrimaryContext extends DetoxContext {
    */
   [$restoreSessionState]() {
     return new SessionState({
-      detoxConfigSnapshotPath: temporary.for.json(),
+      id: uuid.UUID(),
       detoxIPCServer: `primary-${process.pid}`,
     });
   }
   //#endregion
 
   //#region Private members
-  async[_finalizeLogs]() {
-    const sessionId = this[$sessionState].id;
-    const logs = await globAsync(temporary.for.jsonl(`${sessionId}.*`));
-    if (logs.length === 0) {
-      return;
-    }
-
-    if (this[_areLogsEnabled]()) {
-      const streamUtils = require('../logger/utils/streamUtils');
-      const { rootDir } = this[symbols.config].artifacts;
-
-      await fs.mkdirp(rootDir);
-      const [out1Stream, out2Stream] = ['detox.log', 'detox.trace.json']
-        .map((filename) => fs.createWriteStream(path.join(rootDir, filename)));
-
-      const mergedStream = streamUtils.uniteSessionLogs(sessionId);
-
-      await Promise.all([
-        pipe(mergedStream, streamUtils.debugStream(this[symbols.logger].config.options), out1Stream),
-        pipe(mergedStream, streamUtils.chromeTraceStream(), streamUtils.writeJSON(), out2Stream),
-      ]);
-    }
-
-    await Promise.all(logs.map(filepath => fs.remove(filepath)));
-  }
-
-  async[_finalizeLogsSync]() {
-    const logsEnabled = this[_areLogsEnabled]();
-
-    const { rootDir } = this[symbols.config].artifacts;
-
-    if (logsEnabled) {
-      fs.mkdirpSync(rootDir);
-    }
-
-    const sessionId = this[$sessionState].id;
-    const logs = globSync(temporary.for.jsonl(`${sessionId}.*`));
-
-    for (const log of logs) {
-      if (logsEnabled) {
-        fs.moveSync(log, path.join(rootDir, path.basename(log)));
-      } else {
-        fs.removeSync(log);
-      }
-    }
-  }
-
-  [_areLogsEnabled]() {
-    const { rootDir, plugins } = this[symbols.config].artifacts || {};
-    if (!rootDir || !plugins) {
-      return false;
-    }
-
-    if (!plugins.log.enabled) {
-      return false;
-    }
-
-    if (!plugins.log.keepOnlyFailedTestsArtifacts) {
-      return true;
-    }
-
-    return this[$sessionState].testResults.some(r => !r.success);
-  }
-
   async[_resetLockFile]() {
     const DeviceRegistry = require('../devices/DeviceRegistry');
 

package/src/realms/DetoxSecondaryContext.js

@@ -11,7 +11,6 @@ const { $restoreSessionState, $sessionState, $worker } = DetoxContext.protected;
 
 //#region Private symbols
 const _ipcClient = Symbol('ipcClient');
-const _shortLifecycle = Symbol('shortLifecycle');
 //#endregion
 
 class DetoxSecondaryContext extends DetoxContext {
@@ -23,13 +22,6 @@ class DetoxSecondaryContext extends DetoxContext {
      * @type {import('../ipc/IPCClient')}
      */
     this[_ipcClient] = null;
-    /**
-     * @private
-     * @type {undefined | boolean}
-     *
-     * TODO: explain what is short lifecycle and why we need it
-     */
-    this[_shortLifecycle] = false;
   }
 
   //#region Internal members

package/src/utils/argparse.js

@@ -1,3 +1,5 @@
+const path = require('path');
+
 const _ = require('lodash');
 const argv = require('minimist')(process.argv.slice(2));
 
@@ -81,9 +83,18 @@ function joinArgs(keyValues, options = DEFAULT_JOIN_ARGUMENTS_OPTIONS) {
   return argArray.join(' ');
 }
 
+function getCurrentCommand() {
+  const cwd = process.cwd();
+
+  return process.argv.slice(1).map((value, index) => {
+    return index ? value : path.relative(cwd, value);
+  }).join(' ');
+}
+
 module.exports = {
   getArgValue,
   getEnvValue,
   getFlag,
   joinArgs,
+  getCurrentCommand,
 };

package/Detox-android/com/wix/detox/20.0.14-next-is-hittable-check-2.0/detox-20.0.14-next-is-hittable-check-2.0-javadoc.jar.md5

@@ -1 +0,0 @@
-0b09890dab4c0f9d2e18ce9810152b48

package/Detox-android/com/wix/detox/20.0.14-next-is-hittable-check-2.0/detox-20.0.14-next-is-hittable-check-2.0-javadoc.jar.sha1

@@ -1 +0,0 @@
-4fb3f1aa20e1d1a833a2ef036ca603165505cc54

package/Detox-android/com/wix/detox/20.0.14-next-is-hittable-check-2.0/detox-20.0.14-next-is-hittable-check-2.0-javadoc.jar.sha256

@@ -1 +0,0 @@
-6bfd20ec1ae900abd578d862751e5ac04ef373cbe27201e7dbb078779340eaa5

package/Detox-android/com/wix/detox/20.0.14-next-is-hittable-check-2.0/detox-20.0.14-next-is-hittable-check-2.0-javadoc.jar.sha512

@@ -1 +0,0 @@
-f969f49c3ed45ff55bc020e06ed2ce25ec442379d558f6c9a7a1f0345a472a4245cfaad8ceba876e6459920c8fb691eddc7906baf4231ef7838bc49c3822f2cd

package/Detox-android/com/wix/detox/20.0.14-next-is-hittable-check-2.0/detox-20.0.14-next-is-hittable-check-2.0-sources.jar.md5

@@ -1 +0,0 @@
-d9897e95c4ecf505d3f7b2ae7e11eb47

package/Detox-android/com/wix/detox/20.0.14-next-is-hittable-check-2.0/detox-20.0.14-next-is-hittable-check-2.0-sources.jar.sha1

@@ -1 +0,0 @@
-fad4877aef09f6ff02c3fd424200df022e44f047

package/Detox-android/com/wix/detox/20.0.14-next-is-hittable-check-2.0/detox-20.0.14-next-is-hittable-check-2.0-sources.jar.sha256

@@ -1 +0,0 @@
-6d018ab8b1a477b086e9cb9daabb86b406a84b908acb5b51aa19e07cf178c4f7

package/Detox-android/com/wix/detox/20.0.14-next-is-hittable-check-2.0/detox-20.0.14-next-is-hittable-check-2.0-sources.jar.sha512

@@ -1 +0,0 @@
-fb025c2b71f43d76d274e2a9c62654f6b3497cdf8ddf4b92318a35508e3383c87a0ed0b9f5e461c7e1a6779962d3a012f23baa9a9f2116525f6c32d8c163882c

package/Detox-android/com/wix/detox/20.0.14-next-is-hittable-check-2.0/detox-20.0.14-next-is-hittable-check-2.0.aar.md5

@@ -1 +0,0 @@
-3bdd1b42fa0f182255a47fcdda8f544c

package/Detox-android/com/wix/detox/20.0.14-next-is-hittable-check-2.0/detox-20.0.14-next-is-hittable-check-2.0.aar.sha1

@@ -1 +0,0 @@
-457ae10d202b196ea92bade4a33ce2dbc2f8bb3f

package/Detox-android/com/wix/detox/20.0.14-next-is-hittable-check-2.0/detox-20.0.14-next-is-hittable-check-2.0.aar.sha256

@@ -1 +0,0 @@
-52342d1b0d1fae681b2ea1e6f9ac6f6278299ed70d7867fd60b95d63eb7a9ec3

package/Detox-android/com/wix/detox/20.0.14-next-is-hittable-check-2.0/detox-20.0.14-next-is-hittable-check-2.0.aar.sha512

@@ -1 +0,0 @@
-5dfa73d84d647fd870a2e915d9943c9502c967abfd89a834ef7dee50a2a77d5a8b0be7b13407a34a6b97cbc10e9ed6f5e608fe7366d5a3041e462e3322d5b10d

package/Detox-android/com/wix/detox/20.0.14-next-is-hittable-check-2.0/detox-20.0.14-next-is-hittable-check-2.0.pom.md5

@@ -1 +0,0 @@
-a3e045f487ba8e722d220f63208ad9ac

package/Detox-android/com/wix/detox/20.0.14-next-is-hittable-check-2.0/detox-20.0.14-next-is-hittable-check-2.0.pom.sha1

@@ -1 +0,0 @@
-779c98eabebaa2cebd52d12afa1981259ecdb05a

package/Detox-android/com/wix/detox/20.0.14-next-is-hittable-check-2.0/detox-20.0.14-next-is-hittable-check-2.0.pom.sha256

@@ -1 +0,0 @@
-ba3edd4b7874e8e296a34bc55fa4aa1d49a40eb36ce442de000e62e9876e3b2d

package/Detox-android/com/wix/detox/20.0.14-next-is-hittable-check-2.0/detox-20.0.14-next-is-hittable-check-2.0.pom.sha512

@@ -1 +0,0 @@
-05ee92a5fcff9f5b53bc52ba1d5e3915369d0b34df12f94690f8b87f30ec705d2ba00d52bc79293cbcfecfbdc6773167b544b4973d82fbb4d6ecaed4ee3ae2a5

package/runners/jest/deprecation.js

@@ -1,25 +0,0 @@
-const chalk = require('chalk');
-
-// @ts-ignore
-console.error(chalk.yellow(`
-=========================  THE NEW JOURNEY BEGINS  =============================
-
-                  https://wix.github.io/Detox/docs/guide/jest
-
-         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.
-
-                  https://wix.github.io/Detox/docs/guide/jest
-
-=========================  THE NEW JOURNEY BEGINS  =============================
-
-`));
-
-throw Object.assign(new Error(
-  '\n\nPlease follow the new Jest setup guide:\nhttps://wix.github.io/Detox/docs/guide/jest\n\n'
-), { stack: '' });

package/src/configuration/utils/warnings.js

@@ -1,12 +0,0 @@
-const DEVICE_LAUNCH_ARGS_DEPRECATION = `\
---device-launch-args is a deprecated name of this option.
-Please change your scripts to use --device-boot-args instead.`;
-
-const DEVICE_LAUNCH_ARGS_GENERIC_DEPRECATION = `\
---device-launch-args / $DETOX_DEVICE_LAUNCH_ARGS is a deprecated name of this option.
-Please change your scripts to use --device-boot-args / $DETOX_DEVICE_BOOT_ARGS instead.`;
-
-module.exports = {
-  DEVICE_LAUNCH_ARGS_DEPRECATION,
-  DEVICE_LAUNCH_ARGS_GENERIC_DEPRECATION,
-};