detox 21.0.0-breaking.new-global-lifecycle.0 → 21.0.1-rc.0

package/src/artifacts/timeline/TimelineContextTypes.js

@@ -0,0 +1,7 @@
+const TIMELINE_CONTEXT_TYPES = {
+  TEST: 'test',
+  DESCRIBE: 'describe',
+  INVOCATION: 'invocation'
+};
+
+module.exports = TIMELINE_CONTEXT_TYPES;

package/src/artifacts/utils/temporaryPath.js

@@ -1,16 +1,55 @@
 const path = require('path');
+const { promisify } = require('util');
 
+const glob = require('glob');
+const _ = require('lodash');
 const tempfile = require('tempfile');
 
+const { useForwardSlashes } = require('../../utils/shellUtils');
+
+const globSync = glob.sync;
+const globAsync = promisify(glob);
+const getRoot = _.once(() => 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(getRoot(), `${basename}.detox.${fileExtension}`)
+      : tempfile(`.detox.${fileExtension}`);
+  };
+}
+
 module.exports = {
   for: {
-    json: () => tempfile('.detox.json'),
-    jsonl: () => tempfile('.detox.jsonl'),
-    png: () => tempfile('.detox.png'),
-    log: () => tempfile('.detox.log'),
-    mp4: () => tempfile('.detox.mp4'),
-    dtxrec: () => tempfile('.detox.dtxrec'),
-    viewhierarchy: () => tempfile('.detox.viewhierarchy'),
+    json: createTempFileBuilderFn('json'),
+    jsonl: createTempFileBuilderFn('jsonl'),
+    png: createTempFileBuilderFn('png'),
+    log: createTempFileBuilderFn('log'),
+    mp4: createTempFileBuilderFn('mp4'),
+    dtxrec: createTempFileBuilderFn('dtxrec'),
+    viewhierarchy: createTempFileBuilderFn('viewhierarchy'),
+  },
+  find: {
+    jsonl: createGlobber('jsonl'),
   },
-  mask: () => path.join(tempfile(), '..') + path.sep + '*.detox.*',
 };

package/src/artifacts/video/SimulatorRecordVideoPlugin.js

@@ -1,7 +1,7 @@
 const fs = require('fs-extra');
 
 const { interruptProcess } = require('../../utils/childProcess');
-const log = require('../../utils/logger').child({ __filename });
+const log = require('../../utils/logger').child({ cat: 'artifacts-plugin,artifact' });
 const Artifact = require('../templates/artifact/Artifact');
 const FileArtifact = require('../templates/artifact/FileArtifact');
 const temporaryPath = require('../utils/temporaryPath');

package/src/client/AsyncWebSocket.js

@@ -1,3 +1,4 @@
+/* eslint @typescript-eslint/no-unused-vars: ["error", { "args": "none" }] */
 // @ts-nocheck
 const _ = require('lodash');
 const WebSocket = require('ws');
@@ -5,25 +6,16 @@ const WebSocket = require('ws');
 const DetoxInternalError = require('../errors/DetoxInternalError');
 const DetoxRuntimeError = require('../errors/DetoxRuntimeError');
 const Deferred = require('../utils/Deferred');
-const log = require('../utils/logger').child({ __filename, cat: 'ws-client,ws' });
+const log = require('../utils/logger').child({ cat: 'ws-client,ws' });
 
 const InflightRequest = require('./InflightRequest');
 
-const EVENTS = {
-  OPEN: Object.freeze({ event: 'WS_OPEN' }),
-  ERROR: Object.freeze({ event: 'WS_ERROR' }),
-  MESSAGE: Object.freeze({ event: 'WS_MESSAGE' }),
-  SEND: Object.freeze({ event: 'WS_SEND' }),
-  LATE_RESPONSE: Object.freeze({ event: 'WS_LATE_RESPONSE' }),
-};
-
 const DEFAULT_SEND_OPTIONS = {
   timeout: 0,
 };
 
 class AsyncWebSocket {
   constructor(url) {
-    this._log = log.child({ url });
     this._url = url;
     this._ws = null;
     this._eventCallbacks = {};
@@ -99,9 +91,9 @@ class AsyncWebSocket {
 
     this.handleMultipleNonAtomicPendingActions();
 
-    const messageAsString = JSON.stringify(message);
-    this._log.trace(EVENTS.SEND, messageAsString);
-    this._ws.send(messageAsString);
+    const payload = JSON.stringify(message);
+    log.trace({ data: payload }, 'send message');
+    this._ws.send(payload);
 
     return inFlight.promise;
   }
@@ -157,7 +149,7 @@ class AsyncWebSocket {
     }
 
     if (!hasPendingActions) {
-      log.error(EVENTS.ERROR, DetoxRuntimeError.format(error));
+      log.error({ error });
     }
   }
 
@@ -185,8 +177,8 @@ class AsyncWebSocket {
    * @param {WebSocket.OpenEvent} event
    * @private
    */
-  _onOpen(event) { // eslint-disable-line no-unused-vars
-    this._log.trace(EVENTS.OPEN, `opened web socket to: ${this._url}`);
+  _onOpen(event) {
+    log.trace(`opened web socket to: ${this._url}`);
     this._opening.resolve();
     this._opening = null;
   }
@@ -234,7 +226,7 @@ class AsyncWebSocket {
     const data = event && event.data || null;
 
     try {
-      this._log.trace(EVENTS.MESSAGE, data);
+      log.trace({ data }, 'get message');
 
       const json = JSON.parse(data);
       if (!json || !json.type) {
@@ -259,7 +251,7 @@ class AsyncWebSocket {
 
       if (!handled) {
         if (this._abortedMessageIds.has(json.messageId)) {
-          log.debug(EVENTS.LATE_RESPONSE, `Received late response for messageId=${json.messageId}`);
+          log.debug({ messageId: json.messageId }, `late response`);
         } else {
           throw new DetoxRuntimeError('Unexpected message received over the web socket: ' + json.type);
         }
@@ -277,7 +269,7 @@ class AsyncWebSocket {
    * @param {WebSocket.CloseEvent | null} event
    * @private
    */
-  _onClose(event) { // eslint-disable-line no-unused-vars
+  _onClose(event) {
     if (this._closing) {
       this._closing.resolve();
     }

package/src/client/Client.js

@@ -9,7 +9,7 @@ const DetoxRuntimeError = require('../errors/DetoxRuntimeError');
 const failedToReachTheApp = require('../errors/longreads/failedToReachTheApp');
 const Deferred = require('../utils/Deferred');
 const { asError, createErrorWithUserStack, replaceErrorStack } = require('../utils/errorUtils');
-const log = require('../utils/logger').child({ __filename });
+const log = require('../utils/logger').child({ cat: 'ws-client,ws' });
 
 const AsyncWebSocket = require('./AsyncWebSocket');
 const actions = require('./actions/actions');
@@ -34,6 +34,7 @@ class Client {
     this._slowInvocationStatusHandle = null;
     this._whenAppIsConnected = this._invalidState('before connecting to the app');
     this._whenAppIsReady = this._whenAppIsConnected;
+    this._whenAppDisconnected = Deferred.resolved();
     this._isCleaningUp = false;
     this._pendingAppCrash = null;
     this._appTerminationHandle = null;
@@ -71,6 +72,7 @@ class Client {
   async connect() {
     await this.open();
     const sessionStatus = await this.sendAction(new actions.Login(this._sessionId));
+    console.log('sessionStatus', sessionStatus);
     if (sessionStatus.appConnected) {
       this._onAppConnected();
     }
@@ -185,7 +187,9 @@ class Client {
       this._whenAppIsConnected = new Deferred();
       this._whenAppIsReady = new Deferred();
 
+      console.warn('App is not connected yet. Waiting for it to connect...');
       await this._whenAppIsConnected.promise;
+      console.warn('App is connected. Waiting for it to be ready...');
       // TODO: optimize traffic (!) - we can just listen for 'ready' event
       // if app always sends it upon load completion. On iOS it works,
       // but not on Android. Afterwards, this will suffice:
@@ -196,11 +200,17 @@ class Client {
     // TODO: move to else branch after the optimization
     if (!this._whenAppIsReady.isResolved()) {
       this._whenAppIsReady = new Deferred();
+      console.log('Waiting for app to become ready...');
       await this.sendAction(new actions.Ready());
       this._whenAppIsReady.resolve();
     }
   }
 
+  /** @async */
+  waitUntilDisconnected() {
+    return this._whenAppDisconnected.promise;
+  }
+
   async waitForBackground() {
     await this.sendAction(new actions.WaitForBackground());
   }
@@ -209,6 +219,10 @@ class Client {
     await this.sendAction(new actions.WaitForActive());
   }
 
+  async sendToHome() {
+    await this.sendAction(new actions.SendToHome());
+  }
+
   async captureViewHierarchy({ viewHierarchyURL }) {
     return await this.sendAction(new actions.CaptureViewHierarchy({
       viewHierarchyURL
@@ -227,6 +241,12 @@ class Client {
     await this.sendAction(new actions.Shake());
   }
 
+  async terminateIfNeeded() {
+    if (this.isConnected) {
+      await this.sendAction(new actions.Terminate());
+    }
+  }
+
   async setOrientation(orientation) {
     await this.sendAction(new actions.SetOrientation(orientation));
   }
@@ -246,7 +266,7 @@ class Client {
   }
 
   async terminateApp() {
-    /* see the property injection from Detox.js */
+    /* see the property injection from DetoxWorker.js */
   }
 
   _scheduleSlowInvocationQuery() {
@@ -296,11 +316,14 @@ class Client {
   }
 
   _onAppConnected() {
+    console.log('App connected.');
     if (this._whenAppIsConnected.isPending()) {
       this._whenAppIsConnected.resolve();
     } else {
       this._whenAppIsConnected = Deferred.resolved();
     }
+
+    this._whenAppDisconnected = new Deferred();
   }
 
   _onAppReady() {
@@ -320,6 +343,10 @@ class Client {
   }
 
   _onBeforeAppCrash({ params }) {
+    if (this._pendingAppCrash) {
+      return;
+    }
+
     this._pendingAppCrash = new DetoxRuntimeError({
       message: 'The app has crashed, see the details below:',
       debugInfo: params.errorDetails,
@@ -338,10 +365,15 @@ class Client {
     this._whenAppIsReady = this._whenAppIsConnected;
 
     if (this._pendingAppCrash) {
+      this._whenAppDisconnected.reject(this._pendingAppCrash);
       this._asyncWebSocket.rejectAll(this._pendingAppCrash);
       this._pendingAppCrash = null;
     } else if (this._asyncWebSocket.hasPendingActions()) {
-      this._asyncWebSocket.rejectAll(new DetoxRuntimeError('The app has unexpectedly disconnected from Detox server.'));
+      const error = new DetoxRuntimeError('The app has unexpectedly disconnected from Detox server.');
+      this._asyncWebSocket.rejectAll(error);
+      this._whenAppDisconnected.resolve();
+    } else {
+      this._whenAppDisconnected.resolve();
     }
   }
 

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/actions.js

@@ -124,6 +124,24 @@ class WaitForActive extends Action {
   }
 }
 
+class SendToHome extends Action {
+  constructor() {
+    super('sendToHome');
+  }
+
+  get isAtomic() {
+    return true;
+  }
+
+  get timeout() {
+    return 0;
+  }
+
+  async handle(response) {
+    this.expectResponseOfType(response, 'sendToHomeDone');
+  }
+}
+
 class Shake extends Action {
   constructor() {
     super('shakeDevice');
@@ -142,6 +160,24 @@ class Shake extends Action {
   }
 }
 
+class Terminate extends Action {
+  constructor() {
+    super('terminate');
+  }
+
+  get isAtomic() {
+    return true;
+  }
+
+  get timeout() {
+    return 0;
+  }
+
+  async handle(response) {
+    this.expectResponseOfType(response, 'willTerminate');
+  }
+}
+
 class SetOrientation extends Action {
   constructor(params) {
     super('setOrientation', params);
@@ -325,6 +361,7 @@ module.exports = {
   Login,
   WaitForBackground,
   WaitForActive,
+  SendToHome,
   Ready,
   Invoke,
   ReloadReactNative,
@@ -336,4 +373,5 @@ module.exports = {
   SetOrientation,
   SetInstrumentsRecordingState,
   CaptureViewHierarchy,
+  Terminate,
 };

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/client/actions/formatters/sync-resources/NetworkFormatter.js

@@ -1,7 +1,7 @@
 const { makeResourceTitle, makeResourceSubTitle } = require('./utils');
 
 function makeURLDescription(url, urlCount) {
-  return makeResourceSubTitle(`URL #${urlCount}: ${url}.`);
+  return makeResourceSubTitle(`URL #${urlCount}: ${url}`);
 }
 
 module.exports = function(properties) {

package/src/configuration/collectCliConfig.js

@@ -1,9 +1,6 @@
 const _ = require('lodash');
 
 const argparse = require('../utils/argparse');
-const log = require('../utils/logger').child({ __filename });
-
-const { DEVICE_LAUNCH_ARGS_GENERIC_DEPRECATION } = require('./utils/warnings');
 
 const asBoolean = (value) => {
   if (typeof value === 'boolean') {
@@ -25,16 +22,8 @@ const asNumber = (value) => {
     : undefined;
 };
 
-const deprecateDeviceLaunchArgs = (value) => {
-  if (value) {
-    log.warn(DEVICE_LAUNCH_ARGS_GENERIC_DEPRECATION);
-  }
-
-  return value;
-};
-
 function collectCliConfig({ argv }) {
-  const env = (key) => argparse.getArgValue(key);
+  const env = (key) => argparse.getEnvValue(key);
   const get = (key, fallback) => {
     const value = argv && Reflect.has(argv, key) ? argv[key] : env(key);
     return value === undefined ? fallback : value;
@@ -51,7 +40,7 @@ function collectCliConfig({ argv }) {
     configPath: get('config-path'),
     configuration: get('configuration'),
     debugSynchronization: asNumber(get('debug-synchronization')),
-    deviceBootArgs: get('device-boot-args', deprecateDeviceLaunchArgs(argparse.getEnvValue('device-launch-args'))),
+    deviceBootArgs: get('device-boot-args'),
     appLaunchArgs: get('app-launch-args'),
     deviceName: get('device-name'),
     forceAdbInstall: asBoolean(get('force-adb-install')),
@@ -66,6 +55,7 @@ function collectCliConfig({ argv }) {
     useCustomLogger: asBoolean(get('use-custom-logger')),
     retries: asNumber(get('retries')),
     inspectBrk: asBoolean(get('inspect-brk')),
+    start: get('start'),
   }, _.isUndefined);
 }
 

package/src/configuration/composeAppsConfig.js

@@ -1,6 +1,6 @@
 // @ts-nocheck
 const _ = require('lodash');
-const parse = require('yargs/yargs').Parser;
+const parse = require('yargs-parser');
 
 const deviceAppTypes = require('./utils/deviceAppTypes');
 
@@ -144,6 +144,10 @@ function validateAppConfig({ appConfig, appPath, deviceConfig, errorComposer })
   if (appConfig.launchArgs && !_.isObject(appConfig.launchArgs)) {
     throw errorComposer.malformedAppLaunchArgs(appPath);
   }
+
+  if (appConfig.type !== 'android.apk' && appConfig.reversePorts) {
+    throw errorComposer.unsupportedReversePorts(appPath);
+  }
 }
 
 module.exports = composeAppsConfig;

package/src/configuration/composeDeviceConfig.js

@@ -2,7 +2,7 @@
 const _ = require('lodash');
 
 const environmentFactory = require('../environmentFactory');
-const log = require('../utils/logger').child({ __filename });
+const log = require('../utils/logger').child({ cat: 'config' });
 
 /**
  * @param {DetoxConfigErrorComposer} opts.errorComposer

package/src/configuration/composeLoggerConfig.js

@@ -1,3 +1,4 @@
+/* eslint @typescript-eslint/no-unused-vars: ["error", { "args": "none" }] */
 const _ = require('lodash');
 
 const { castLevel, defaultOptions } = require('../logger/DetoxLogger');
@@ -7,25 +8,34 @@ const { castLevel, defaultOptions } = require('../logger/DetoxLogger');
  * @param {Detox.DetoxConfig} opts.globalConfig
  * @param {Detox.DetoxConfiguration} opts.localConfig
  * @param {*} opts.cliConfig
- * @returns {Detox.DetoxLoggerConfig}
  */
 function composeLoggerConfig(opts) {
   const { globalConfig, localConfig, cliConfig } = opts;
 
-  return _.merge(
+  const items = [
     {
       level: 'info',
-      overrideConsole: 'sandbox',
-      options: {
-        ...defaultOptions,
-        prefixers: {
-          ...defaultOptions.prefixers,
-        },
-      },
+      overrideConsole: true,
+      options: defaultOptions,
     },
     globalConfig.logger,
     localConfig.logger,
     adaptCLI(cliConfig),
+  ];
+
+  return items.reduce(
+    /**
+     * @param {Partial<Detox.DetoxLoggerConfig>} acc
+     * @param config
+     */
+    (acc, config) => {
+      if (!config) return acc;
+      const { options } = config;
+      return _.merge(acc, {
+        options: typeof options === 'function' ? options(acc) : options
+      });
+    },
+    items.reduce((a, b) => _.merge(a, _.omit(b, 'options')), {})
   );
 }
 
@@ -37,7 +47,7 @@ function adaptCLI(cliConfig) {
   }
 
   if (cliConfig.useCustomLogger !== undefined) {
-    result.overrideConsole = cliConfig.useCustomLogger ? 'all' : 'none';
+    result.overrideConsole = cliConfig.useCustomLogger;
   }
 
   if (cliConfig.noColor) {

package/src/configuration/composeRunnerConfig.js

@@ -2,17 +2,19 @@ const os = require('os');
 
 const _ = require('lodash');
 
+const log = require('../utils/logger');
+
 /**
  * @param {object} opts
  * @param {Detox.DetoxConfig} opts.globalConfig
  * @param {Detox.DetoxConfiguration} opts.localConfig
- * @param {DetoxInternals.DetoxCLIConfig} opts.cliConfig
+ * @param {DetoxInternals.CLIConfig} opts.cliConfig
  * @param {Record<string, any>} opts.testRunnerArgv
  * @param {import('../errors/DetoxConfigErrorComposer')} opts.errorComposer
  * @returns {Detox.DetoxTestRunnerConfig} opts.testRunnerArgv
  */
 function composeRunnerConfig(opts) {
-  const globalConfig = opts.globalConfig.testRunner;
+  const globalConfig = adaptLegacyRunnerConfig(opts.globalConfig);
   if (globalConfig != null && typeof globalConfig !== 'object') {
     throw opts.errorComposer.invalidTestRunnerProperty(true);
   }
@@ -29,8 +31,12 @@ function composeRunnerConfig(opts) {
     {
       retries: 0,
       inspectBrk: inspectBrkHookDefault,
+      forwardEnv: false,
+      bail: false,
       jest: {
-        initTimeout: 300000,
+        setupTimeout: 300000,
+        teardownTimeout: 30000,
+        retryAfterCircusRetries: false,
         reportSpecs: undefined,
         reportWorkerAssign: true,
       },
@@ -50,16 +56,62 @@ function composeRunnerConfig(opts) {
 
   if (typeof merged.inspectBrk === 'function') {
     if (cliConfig.inspectBrk) {
+      merged.retries = 0;
+      merged.forwardEnv = true;
       merged.inspectBrk(merged);
-      merged.inspectBrk = true;
-    } else {
-      merged.inspectBrk = false;
     }
+
+    delete merged.inspectBrk;
   }
 
   return merged;
 }
 
+function adaptLegacyRunnerConfig(globalConfig) {
+  let isLegacy = false;
+
+  const runnerConfigKey = 'runnerConfig' in globalConfig ? 'runnerConfig' : 'runner-config';
+  if (_.isString(globalConfig[runnerConfigKey])) {
+    isLegacy = true;
+    log.warn(`Detected a deprecated "${runnerConfigKey}" property (string).`);
+  }
+
+  const testRunnerKey = 'testRunner' in globalConfig ? 'testRunner' : 'test-runner';
+  if (_.isString(globalConfig[testRunnerKey])) {
+    isLegacy = true;
+    log.warn(`Detected a deprecated "${testRunnerKey}" property (string).`);
+  }
+
+  if (globalConfig.specs != null) {
+    isLegacy = true;
+    log.warn(`Detected a deprecated "specs" property.`);
+  }
+
+  if (!isLegacy) {
+    return globalConfig.testRunner;
+  }
+
+  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;
+
+  const args = {};
+  if (_.isString(testRunner)) {
+    args.$0 = testRunner;
+  }
+
+  if (_.isString(runnerConfig)) {
+    args.config = runnerConfig;
+  }
+
+  if (specs) {
+    args._ = [specs];
+  }
+
+  return { args };
+}
+
 function hasEmptyPositionalArgs(value, key) {
   return key === '_' ? _.isEmpty(value) : false;
 }
@@ -68,9 +120,10 @@ function hasEmptyPositionalArgs(value, key) {
  * @param {Detox.DetoxTestRunnerConfig} config
  */
 function inspectBrkHookDefault(config) {
-  config.args.$0 = /* istanbul ignore if */ os.platform() === 'win32'
-    ? `node --inspect-brk ./node_modules/jest/bin/jest.js`
-    : `node --inspect-brk ./node_modules/.bin/jest`;
+  /* istanbul ignore next */
+  config.args.$0 = os.platform() !== 'win32'
+    ? `node --inspect-brk ./node_modules/.bin/jest`
+    : `node --inspect-brk ./node_modules/jest/bin/jest.js`;
   config.args.runInBand = true;
   delete config.args.w;
   delete config.args.workers;