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

package/src/realms/DetoxSecondaryContext.js

@@ -1,23 +1,31 @@
 const fs = require('fs');
 
 const { DetoxInternalError } = require('../errors');
-const { SecondarySessionState } = require('../ipc/state');
+const SessionState = require('../ipc/SessionState');
 const symbols = require('../symbols');
 
 const DetoxContext = require('./DetoxContext');
 
-const { $logger, $restoreSessionState, $sessionState } = DetoxContext.protected;
+const { $restoreSessionState, $sessionState, $worker } = DetoxContext.protected;
 const _ipcClient = Symbol('ipcClient');
+const _shortLifecycle = Symbol('shortLifecycle');
 
 class DetoxSecondaryContext extends DetoxContext {
   constructor() {
     super();
 
     /**
-     * @protected
-     * @type {*}
+     * @private
+     * @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
@@ -34,41 +42,28 @@ class DetoxSecondaryContext extends DetoxContext {
   }
 
   /** @override */
-  async [symbols.globalSetup](_opts = {}) {
-    // This is a no-op function.
-    // It is forbidden to add any logic to `globalSetup` of the secondary context.
-    // Violating this principle will almost definitely break some flows, where it is
-    // not guaranteed that `globalSetup` will ever get called. See UML diagrams.
-  }
-
-  /** @override */
-  async [symbols.globalTeardown]() {
-    // This is a no-op function.
-    // It is forbidden to add any logic to `globalTeardown` of the secondary context.
-    // Violating this principle will almost definitely break some flows, where it is
-    // not guaranteed that `globalTeardown` will ever get called. See UML diagrams.
-  }
-
-  /** @override */
-  async [symbols.setup](opts) {
+  async [symbols.init](opts = {}) {
     const IPCClient = require('../ipc/IPCClient');
 
     this[_ipcClient] = new IPCClient({
       id: `secondary-${process.pid}`,
       state: this[$sessionState],
-      logger: this[$logger],
+      logger: this[symbols.logger],
     });
 
-    const workerId = opts.workerId || 1;
     await this[_ipcClient].init();
-    await this[_ipcClient].registerWorker(workerId);
-    await super[symbols.setup](opts);
+
+    if (opts.workerId !== null) {
+      await this[symbols.installWorker](opts);
+    }
   }
 
   /** @override */
-  async [symbols.teardown]() {
+  async [symbols.cleanup]() {
     try {
-      await super[symbols.teardown]();
+      if (this[$worker]) {
+        await this[symbols.uninstallWorker]();
+      }
     } finally {
       if (this[_ipcClient]) {
         await this[_ipcClient].dispose();
@@ -76,17 +71,23 @@ class DetoxSecondaryContext extends DetoxContext {
       }
     }
   }
+
+  /** @override */
+  async [symbols.installWorker](opts = {}) {
+    const workerId = opts.workerId = opts.workerId || 'worker';
+    await this[_ipcClient].registerWorker(workerId);
+    await super[symbols.installWorker](opts);
+  }
   //#endregion
 
   //#region Protected members
-
   /**
    * @protected
    * @override
-   * @return {SecondarySessionState}
+   * @return {SessionState}
    */
   [$restoreSessionState]() {
-    return SecondarySessionState.parse(fs.readFileSync(process.env.DETOX_CONFIG_SNAPSHOT_PATH));
+    return SessionState.parse(fs.readFileSync(process.env.DETOX_CONFIG_SNAPSHOT_PATH));
   }
   //#endregion
 }

package/src/server/DetoxConnection.js

@@ -1,43 +1,37 @@
-// @ts-nocheck
 const _ = require('lodash');
-const { WebSocket } = require('ws'); // eslint-disable-line @typescript-eslint/no-unused-vars, no-unused-vars
 
 const DetoxRuntimeError = require('../errors/DetoxRuntimeError');
-const logger = require('../utils/logger').child({ __filename, cat: 'ws-server,ws' });
+const logger = require('../utils/logger').child({ cat: 'ws-server,ws' });
 
 const AnonymousConnectionHandler = require('./handlers/AnonymousConnectionHandler');
 
-const EVENTS = {
-  NEW: { event: 'WSS_CONNECTION' },
-  GET: { event: 'WSS_GET_FROM' },
-  SEND: { event: 'WSS_SEND_TO' },
-  ERROR: { event: 'ERROR' },
-  SOCKET_ERROR: { event: 'WSS_SOCKET_ERROR' },
-};
-
 class DetoxConnection {
   /**
-   * @param {DetoxSessionManager} sessionManager
-   * @param {WebSocket} webSocket
-   * @param {Socket} socket
+   * @param {{
+   *   sessionManager: import('./DetoxSessionManager');
+   *   webSocket: import('ws');
+   *   socket: import('net').Socket;
+   * }} config
    */
   constructor({ sessionManager, webSocket, socket }) {
     this._onMessage = this._onMessage.bind(this);
     this._onError = this._onError.bind(this);
     this._onClose = this._onClose.bind(this);
 
-    this._log = logger.child({ trackingId: socket.remotePort });
+    this._log = logger.child({ id: socket.remotePort });
+    this._log.debug.begin(`connection :${socket.localPort}<->:${socket.remotePort}`);
+
     this._sessionManager = sessionManager;
     this._webSocket = webSocket;
     this._webSocket.on('message', this._onMessage);
     this._webSocket.on('error', this._onError);
     this._webSocket.on('close', this._onClose);
-    this._log.debug(EVENTS.NEW, 'registered a new connection.');
 
-    const log = this._log;
+    // eslint-disable-next-line unicorn/no-this-assignment
+    const self = this;
     this._handler = new AnonymousConnectionHandler({
       api: {
-        get log() { return log; },
+        get log() { return self._log; },
         appendLogDetails: (details) => { this._log = this._log.child(details); },
 
         registerSession: (params) => this._sessionManager.registerSession(this, params),
@@ -49,13 +43,13 @@ class DetoxConnection {
 
   sendAction(action) {
     const messageAsString = JSON.stringify(action);
-    this._log.trace(EVENTS.SEND, messageAsString);
+    this._log.trace({ data: action }, 'send');
     this._webSocket.send(messageAsString + '\n ');
   }
 
   _onMessage(rawData) {
     const data = _.isString(rawData) ? rawData : rawData.toString('utf8');
-    this._log.trace(EVENTS.GET, data);
+    this._log.trace({ data }, 'get');
 
     try {
       let action;
@@ -84,16 +78,17 @@ class DetoxConnection {
         this._handler.onError(handlerError, action);
       }
     } catch (error) {
-      this._log.warn({ ...EVENTS.ERROR }, error instanceof DetoxRuntimeError ? error.message : `${error}`);
+      this._log.warn({ error }, 'Caught unhandled error:');
     }
   }
 
-  _onError(e) {
-    this._log.warn(EVENTS.SOCKET_ERROR, DetoxRuntimeError.format(e));
+  _onError(error) {
+    this._log.warn({ error }, 'Caught socket error:');
   }
 
   _onClose() {
     this._sessionManager.unregisterConnection(this._webSocket);
+    this._log.debug.end();
   }
 }
 

package/src/server/DetoxServer.js

@@ -4,7 +4,7 @@ const WebSocket = require('ws');
 
 const { DetoxInternalError, DetoxRuntimeError } = require('../errors');
 const Deferred = require('../utils/Deferred');
-const log = require('../utils/logger').child({ __filename });
+const log = require('../utils/logger').child({ cat: 'ws-server,ws' });
 
 const DetoxSessionManager = require('./DetoxSessionManager');
 
@@ -40,18 +40,16 @@ class DetoxServer {
     await this._startListening();
 
     const level = this._options.standalone ? 'info' : 'debug';
-    log[level]({ event: 'WSS_CREATE' }, `Detox server listening on localhost:${this.port}...`);
+    log[level](`Detox server listening on localhost:${this.port}...`);
   }
 
   async close() {
     try {
       await this._closeWithTimeout(10000);
-      log.debug({ event: 'WSS_CLOSE' }, 'Detox server has been closed gracefully');
-    } catch (e) {
-      log.warn({ event: 'ERROR' },
-        `Detox server has been closed abruptly! See the error details below:\n`
-        + DetoxRuntimeError.format(e) + '\n'
-        + DetoxRuntimeError.reportIssue
+      log.debug('Detox server has been closed gracefully');
+    } catch (err) {
+      log.warn({ err },
+        `Detox server has been closed abruptly! See the error details below:`
       );
     }
   }
@@ -90,8 +88,7 @@ class DetoxServer {
     } else if (this._closing) {
       this._closing.reject(err);
     } else {
-      const formattedError = DetoxRuntimeError.format(err);
-      log.error('Detox server has got an unhandled error:\n' + formattedError);
+      log.error({ err }, 'Detox server has got an unhandled error:');
     }
   }
 

package/src/server/DetoxSession.js

@@ -1,6 +1,6 @@
 // @ts-nocheck
 const DetoxInternalError = require('../errors/DetoxInternalError');
-const log = require('../utils/logger').child({ __filename });
+const log = require('../utils/logger').child({ cat: 'ws-server,ws-session' });
 
 class DetoxSession {
   /**
@@ -17,7 +17,7 @@ class DetoxSession {
     /** @type {boolean | null} */
     this._pendingTesterStatus = null;
 
-    log.trace({ event: 'SESSION_CREATED' }, `created session ${id}`);
+    log.trace(`created session ${id}`);
   }
 
   get id() {
@@ -120,7 +120,7 @@ class DetoxSession {
   }
 
   _notifyAboutAppConnect() {
-    log.trace({ event: 'SESSION_JOINED' }, `app joined session ${this.id}`);
+    log.trace(`app joined session ${this.id}`);
 
     if (!this._tester) {
       return;
@@ -132,7 +132,7 @@ class DetoxSession {
   }
 
   _notifyAboutAppDisconnect() {
-    log.trace({ event: 'SESSION_TORN' }, `app exited session ${this.id}`);
+    log.trace(`app exited session ${this.id}`);
 
     if (!this._tester) {
       return;
@@ -144,11 +144,11 @@ class DetoxSession {
   }
 
   _notifyAboutTesterConnect() {
-    log.trace({ event: 'SESSION_JOINED' }, `tester joined session ${this.id}`);
+    log.trace(`tester joined session ${this.id}`);
   }
 
   _notifyAboutTesterDisconnect() {
-    log.trace({ event: 'SESSION_TORN' }, `tester exited session ${this.id}`);
+    log.trace(`tester exited session ${this.id}`);
 
     if (!this._app) {
       return;

package/src/server/DetoxSessionManager.js

@@ -1,6 +1,6 @@
 // @ts-nocheck
 const DetoxInternalError = require('../errors/DetoxInternalError');
-const log = require('../utils/logger').child({ __filename });
+const log = require('../utils/logger').child({ cat: 'ws-server,ws' });
 
 const DetoxConnection = require('./DetoxConnection');
 const DetoxSession = require('./DetoxSession');

package/src/server/handlers/RegisteredConnectionHandler.js

@@ -1,7 +1,6 @@
 // @ts-nocheck
 const { serializeError } = require('serialize-error');
 
-const DetoxError = require('../../errors/DetoxError');
 const DetoxInternalError = require('../../errors/DetoxInternalError');
 
 class RegisteredConnectionHandler {
@@ -41,7 +40,7 @@ class RegisteredConnectionHandler {
         messageId: action && action.messageId,
       });
     } catch (err) {
-      this._api.log.error('Cannot forward the error details to the tester due to the error:\n' + DetoxError.format(err));
+      this._api.log.error({ err }, 'Cannot forward the error details to the tester due to the error:');
       throw error;
     }
   }

package/src/symbols.js

@@ -1,8 +1,11 @@
 /**
  * @type {{
+ *   readonly cleanup: unique symbol;
  *   readonly config: unique symbol;
- *   readonly globalSetup: unique symbol;
- *   readonly globalTeardown: unique symbol;
+ *   readonly getStatus: unique symbol;
+ *   readonly init: unique symbol;
+ *   readonly installWorker: unique symbol;
+ *   readonly logger: unique symbol;
  *   readonly onHookFailure: unique symbol;
  *   readonly onHookStart: unique symbol;
  *   readonly onHookSuccess: unique symbol;
@@ -18,8 +21,7 @@
  *   readonly reportFailedTests: unique symbol;
  *   readonly resolveConfig: unique symbol;
  *   readonly session: unique symbol;
- *   readonly setup: unique symbol;
- *   readonly teardown: unique symbol;
+ *   readonly uninstallWorker: unique symbol;
  *   readonly worker: unique symbol;
  * }}
  */
@@ -44,13 +46,15 @@ module.exports = {
   //#endregion
 
   //#region Main
+  cleanup: Symbol('cleanup'),
   config: Symbol('config'),
-  globalSetup: Symbol('globalSetup'),
-  globalTeardown: Symbol('globalTeardown'),
+  getStatus: Symbol('getStatus'),
+  init: Symbol('init'),
+  installWorker: Symbol('installWorker'),
+  logger: Symbol('logger'),
   resolveConfig: Symbol('resolveConfig'),
   session: Symbol('session'),
-  setup: Symbol('setup'),
-  teardown: Symbol('teardown'),
+  uninstallWorker: Symbol('uninstallWorker'),
   worker: Symbol('worker'),
   //#endregion
 };

package/src/utils/childProcess/exec.js

@@ -3,7 +3,7 @@ const { exec } = require('child-process-promise');
 const _ = require('lodash');
 
 const DetoxRuntimeError = require('../../errors/DetoxRuntimeError');
-const rootLogger = require('../logger').child({ __filename });
+const rootLogger = require('../logger').child({ cat: ['child-process', 'child-process-exec'] });
 const retry = require('../retry');
 
 const execsCounter = require('./opsCounter');

package/src/utils/childProcess/spawn.js

@@ -2,7 +2,7 @@
 const { spawn } = require('child-process-promise');
 const _ = require('lodash');
 
-const rootLogger = require('../logger').child({ __filename });
+const rootLogger = require('../logger').child({ cat: ['child-process', 'child-process-spawn'] });
 const { escape } = require('../pipeCommands');
 const retry = require('../retry');
 

package/src/utils/streamUtils.js

@@ -8,9 +8,7 @@ const JsonlParser = require('stream-json/jsonl/Parser');
 const stripAnsi = require('strip-ansi');
 const { AbstractEventBuilder } = require('trace-event-lib');
 
-const DetoxTracer = require('../logger/DetoxTracer');
-
-const log = require('./logger').child({ __filename });
+const log = require('./logger').child({ cat: 'logger' });
 
 function compareTimestamps(a, b) {
   return +(a.value.time > b.value.time) - +(a.value.time < b.value.time);
@@ -136,6 +134,7 @@ class JsonlStringer extends Transform {
 
 class SimpleEventBuilder extends AbstractEventBuilder {
   events = [];
+
   send(event) {
     this.events.push(event);
   }
@@ -147,8 +146,7 @@ function chromeTraceStream() {
 
   return flatMapTransform((data) => {
     // eslint-disable-next-line no-unused-vars, @typescript-eslint/no-unused-vars
-    const { pid, trace, msg, time, name: _name, hostname: _hostname, ...args } = data;
-    const tid = trace ? trace.tid : DetoxTracer.threadize(args.cat);
+    const { cat = 'default', msg: name, ph = 'i', pid, tid, time, name: _name, hostname: _hostname, ...args } = data;
     const ts = new Date(time).getTime() * 1E3;
 
     const builder = new SimpleEventBuilder();
@@ -159,14 +157,15 @@ function chromeTraceStream() {
 
     const tidHash = `${pid}:${tid}`;
     if (!knownTids.has(tidHash)) {
-      builder.thread_name(DetoxTracer.categorize(tid), tid, pid);
+      const primaryCategory = cat.split(',', 1)[0];
+      builder.thread_name(primaryCategory, tid, pid);
       builder.thread_sort_index(tid, tid, pid);
       knownTids.add(tidHash);
     }
 
-    const event = { ph: 'i', ...data.trace, pid, tid, ts, args };
-    if (!trace || trace.ph !== 'E') {
-      event.name = msg || '';
+    const event = { ph, name, pid, tid, cat, ts, args };
+    if (ph === 'E') {
+      delete event.name;
     }
 
     builder.events.push(event);
@@ -190,11 +189,11 @@ function preventErrorSubscriptions(emitter) {
 }
 
 function readJSONL() {
-  const readable = new PassThrough({ objectMode: true });
+  const readable = through();
   const writable = JsonlParser.make({ checkErrors: true })
     .on('error', (err) => {
       if (err instanceof SyntaxError) {
-        log.debug({ event: 'JSONL_ERROR', err });
+        log.debug({ err });
         readable.end();
       } else {
         readable.emit('error', err);

package/src/utils/trace.js

@@ -1,19 +1,3 @@
-/** @type {Detox.Tracer} */
-const trace = require('../..').trace;
-const traceCall = trace.bind(null);
+const { trace, traceCall } = require('../..');
 
-function traceMethods(obj, cat, methodNames) {
-  for (const name of methodNames) {
-    const originalMethod = obj[name];
-
-    obj[name] = function tracedMethod() {
-      return traceCall({ cat, name }, originalMethod.apply.bind(originalMethod, obj, arguments));
-    };
-  }
-}
-
-module.exports = {
-  trace,
-  traceCall,
-  traceMethods,
-};
+module.exports = { trace, traceCall };

package/src/utils/traceMethods.js

@@ -0,0 +1,15 @@
+function traceMethods(logger, obj, methodNames) {
+  for (const name of methodNames) {
+    const originalMethod = obj[name];
+
+    obj[name] = function tracedMethod(...args) {
+      return logger.trace.complete(
+        { args },
+        name,
+        originalMethod.apply.bind(originalMethod, obj, args)
+      );
+    };
+  }
+}
+
+module.exports = traceMethods;

package/Detox-android/com/wix/detox/20.0.2-breaking.new-global-lifecycle.0/detox-20.0.2-breaking.new-global-lifecycle.0-javadoc.jar.md5

@@ -1 +0,0 @@
-91f1e6b3345b09b266fc6b1f4387d693

package/Detox-android/com/wix/detox/20.0.2-breaking.new-global-lifecycle.0/detox-20.0.2-breaking.new-global-lifecycle.0-javadoc.jar.sha1

@@ -1 +0,0 @@
-a2d07ea0b1bd401ae5cd41fc9f07bbbfb4fee96f

package/Detox-android/com/wix/detox/20.0.2-breaking.new-global-lifecycle.0/detox-20.0.2-breaking.new-global-lifecycle.0-javadoc.jar.sha256

@@ -1 +0,0 @@
-269c444435ef2d7f7267d243b84beefc38508b035df782e1a60eb25b3882a30d

package/Detox-android/com/wix/detox/20.0.2-breaking.new-global-lifecycle.0/detox-20.0.2-breaking.new-global-lifecycle.0-javadoc.jar.sha512

@@ -1 +0,0 @@
-f6d54f916e9b35f686f67a63fe072ffc0781ae7da27daf39a0dce5145fa75de5a240402f10d48df88710730fe40d847e87f7194d999359322e97f483f815496e

package/Detox-android/com/wix/detox/20.0.2-breaking.new-global-lifecycle.0/detox-20.0.2-breaking.new-global-lifecycle.0-sources.jar.md5

@@ -1 +0,0 @@
-613e288168a5ebe791c1b253a0aac51c

package/Detox-android/com/wix/detox/20.0.2-breaking.new-global-lifecycle.0/detox-20.0.2-breaking.new-global-lifecycle.0-sources.jar.sha1

@@ -1 +0,0 @@
-112918ac48c1f2763d5f0fddfa8aba44a35a0c57

package/Detox-android/com/wix/detox/20.0.2-breaking.new-global-lifecycle.0/detox-20.0.2-breaking.new-global-lifecycle.0-sources.jar.sha256

@@ -1 +0,0 @@
-b21e2858bc218ca7402b48d759c6277fce832c73915c874b36d319fe4be2c2d7

package/Detox-android/com/wix/detox/20.0.2-breaking.new-global-lifecycle.0/detox-20.0.2-breaking.new-global-lifecycle.0-sources.jar.sha512

@@ -1 +0,0 @@
-ccbe51ebb24ad5b665f2d4a9d212701096e77f14d9cf04ac8ff6b2b9a452f8fdcf4b2319060bbdc6512b1cbc11846995af3955ac63bd6ea6b75f64c9dd399c24

package/Detox-android/com/wix/detox/20.0.2-breaking.new-global-lifecycle.0/detox-20.0.2-breaking.new-global-lifecycle.0.pom.md5

@@ -1 +0,0 @@
-e68998c30e0c3aefe7cdc34b641fd5e2

package/Detox-android/com/wix/detox/20.0.2-breaking.new-global-lifecycle.0/detox-20.0.2-breaking.new-global-lifecycle.0.pom.sha1

@@ -1 +0,0 @@
-4afd3a2fcdb10c26d6a56a9b8f5c64a05b0152b5

package/Detox-android/com/wix/detox/20.0.2-breaking.new-global-lifecycle.0/detox-20.0.2-breaking.new-global-lifecycle.0.pom.sha256

@@ -1 +0,0 @@
-23b6942ae16e58bb84494f4080b72ef018817833f5a3af6971844ca7d35854ba

package/Detox-android/com/wix/detox/20.0.2-breaking.new-global-lifecycle.0/detox-20.0.2-breaking.new-global-lifecycle.0.pom.sha512

@@ -1 +0,0 @@
-461b3793c3c8fe77b4d7c1494716ae1ce17bf133c99b637f639f176e52c72fdfcf1a2621ce18136f151aa50798007cc68e0eee46a87674a0a22e68534b5f43f6

package/src/logger/DetoxTraceEventBuilder.js

@@ -1,21 +0,0 @@
-const { AbstractEventBuilder } = require('trace-event-lib');
-
-class DetoxTraceEventBuilder extends AbstractEventBuilder {
-  constructor(forward) {
-    super();
-
-    this._forward = forward;
-  }
-
-  send(event) {
-    // eslint-disable-next-line no-unused-vars, @typescript-eslint/no-unused-vars
-    const { pid, ts, name, args = {}, ...trace } = event;
-    if (trace.ph === 'E') {
-      this._forward({ ...args, trace }, `end`);
-    } else {
-      this._forward({ ...args, trace }, name);
-    }
-  }
-}
-
-module.exports = DetoxTraceEventBuilder;