detox 19.13.0 → 20.0.0

package/src/utils/Timer.js

@@ -1,56 +1,81 @@
-// @ts-nocheck
-const DetoxRuntimeError = require('../errors/DetoxRuntimeError');
+const { DetoxRuntimeError, DetoxInternalError } = require('../errors');
 
 const Deferred = require('./Deferred');
 
 class Timer {
-  /**
-   * @param {string} description - gives more context for thrown errors
-   * @param {number} timeout - maximal allowed duration in milliseconds
-   */
-  constructor({ description, timeout }) {
+  constructor() {
     /** @private */
-    this._timeout = timeout;
-    /** @public */
-    this.description = description;
+    this._eta = NaN;
+    /** @private */
+    this._timeout = NaN;
+    /** @type {NodeJS.Timer | null} */
+    this._timeoutHandle = null;
+    /** @type {Deferred | null} */
+    this._timeoutDeferred = null;
+  }
+
+  clear() {
+    if (this._timeoutHandle) {
+      clearTimeout(this._timeoutHandle);
+      this._timeoutHandle = null;
+    }
+
+    this._eta = NaN;
+    this._timeout = NaN;
+    this._timeoutDeferred = null;
+  }
 
-    this._schedule();
+  get expired() {
+    return this._timeoutDeferred ? this._timeoutDeferred.isResolved() : false;
   }
 
-  _schedule() {
-    this._createdAt = Date.now();
+  /**
+   * @param {number} timeout - maximal allowed duration in milliseconds
+   */
+  schedule(timeout) {
+    this.clear();
+
+    this._eta = Date.now() + timeout;
+    this._timeout = timeout;
     this._timeoutDeferred = new Deferred();
     this._timeoutHandle = setTimeout(() => {
       this._timeoutDeferred.resolve();
     }, this._timeout);
-  }
-
-  async run(action) {
-    const error = new DetoxRuntimeError();
-    delete error.stack;
 
-    return Promise.race([
-      this._timeoutDeferred.promise.then(() => {
-        error.message = `Exceeded timeout of ${this._timeout}ms while ${this.description}`;
-        throw error;
-      }),
-      Promise.resolve().then(action),
-    ]);
+    return this;
   }
 
-  dispose() {
+  extend(ms) {
+    if (this.expired) {
+      return this.schedule(ms);
+    }
+
     clearTimeout(this._timeoutHandle);
+    this._eta += ms;
+    this._timeout += ms;
+    this._timeoutHandle = setTimeout(() => {
+      this._timeoutDeferred.resolve();
+    }, this._eta - Date.now());
   }
 
-  reset(extraDelayMs) {
-    this._timeout = extraDelayMs;
+  async run(description, action) {
+    if (!this._timeoutDeferred) {
+      throw new DetoxInternalError('Cannot run a timer action from an uninitialized timer');
+    }
+
+    const error = new DetoxRuntimeError({
+      message: `Exceeded timeout of ${this._timeout}ms while ${description}`,
+      noStack: true,
+    });
 
-    if (this._timeoutDeferred.status !== Deferred.PENDING) {
-      this._schedule();
-    } else {
-      clearTimeout(this._timeoutHandle);
-      this._timeoutHandle = setTimeout(() => this._timeoutDeferred.resolve(), extraDelayMs);
+    if (this.expired) {
+      throw error;
     }
+
+    return Promise.race([
+      this._timeoutDeferred.promise.then(() => { throw error; }),
+      Promise.resolve().then(action),
+    ]);
   }
 }
 

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/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/{local-cli/utils/misc.js → src/utils/envUtils.js}

@@ -1,13 +1,5 @@
 const path = require('path');
 
-function getPlatformSpecificString(platform) {
-  switch (platform) {
-    case 'ios': return ':android:';
-    case 'android': return ':ios:';
-    default: return undefined;
-  }
-}
-
 function printEnvironmentVariables(envObject) {
   return Object.entries(envObject).reduce((cli, [key, value]) => {
     if (value == null || value === '') {
@@ -33,7 +25,6 @@ function prependNodeModulesBinToPATH(env) {
 }
 
 module.exports = {
-  getPlatformSpecificString,
   printEnvironmentVariables,
   prependNodeModulesBinToPATH,
 };

package/src/utils/errorUtils.js

@@ -1,4 +1,6 @@
 const { isError } = require('lodash');
+const { deserializeError, serializeError } = require('serialize-error');
+
 const CLEAN_AT = /\n\s*at [\s\S]*/m;
 
 function filterErrorStack(error, predicate) {
@@ -38,9 +40,27 @@ function asError(error) {
   return isError(error) ? error : new Error(error);
 }
 
+function serializeObjectWithError(obj, errorKey) {
+  if (obj[errorKey]) {
+    return { ...obj, [errorKey]: serializeError(obj[errorKey]) };
+  }
+
+  return obj;
+}
+
+function deserializeObjectWithError(obj, errorKey) {
+  if (typeof obj[errorKey] === 'object' && !(obj[errorKey] instanceof Error)) {
+    return { ...obj, [errorKey]: deserializeError(obj[errorKey]) };
+  }
+
+  return obj;
+}
+
 module.exports = {
   asError,
   replaceErrorStack,
   filterErrorStack,
   createErrorWithUserStack,
+  serializeObjectWithError,
+  deserializeObjectWithError,
 };

package/src/utils/logger.js

@@ -1,164 +1,4 @@
-// @ts-nocheck
-
-const path = require('path');
-
-const bunyan = require('bunyan');
-const bunyanDebugStream = require('bunyan-debug-stream');
-const fs = require('fs-extra');
-const onExit = require('signal-exit');
-
-const temporaryPath = require('../artifacts/utils/temporaryPath');
-
-const argparse = require('./argparse');
-const customConsoleLogger = require('./customConsoleLogger');
-const { shortFormat: shortDateFormat } = require('./dateUtils');
-
-function adaptLogLevelName(level) {
-  switch (level) {
-    case 'fatal':
-    case 'error':
-    case 'warn':
-    case 'info':
-    case 'debug':
-    case 'trace':
-      return level;
-
-    case 'verbose':
-      return 'debug';
-
-    default:
-      return 'info';
-  }
-}
-
-function tryOverrideConsole(logger, global) {
-  if (argparse.getArgValue('use-custom-logger') === 'true') {
-    const userLogger = logger.child({ component: 'USER_LOG' });
-    customConsoleLogger.overrideConsoleMethods(global.console, userLogger);
-  }
-}
-
-function createPlainBunyanStream({ logPath, level, showDate = true }) {
-  const options = {
-    showDate: showDate,
-    showLoggerName: true,
-    showPid: true,
-    showMetadata: false,
-    basepath: __dirname,
-    out: process.stderr,
-    prefixers: {
-      '__filename': (filename, { entry }) => {
-        if (entry.event === 'USER_LOG') {
-          return '';
-        }
-
-        if (entry.event === 'ERROR') {
-          return `${filename}/${entry.event}`;
-        }
-
-        return entry.event ? entry.event : filename;
-      },
-      'trackingId': id => ` #${id}`,
-      'cpid': pid => ` cpid=${pid}`,
-    },
-  };
-
-  if (logPath) {
-    options.colors = false;
-    options.out = fs.createWriteStream(logPath, {
-      flags: 'a',
-    });
-  }
-
-  if (argparse.getFlag('--no-color')) {
-    options.colors = false;
-  }
-
-  return {
-    level,
-    type: 'raw',
-    stream: bunyanDebugStream(options),
-    serializers: bunyanDebugStream.serializers,
-  };
-}
-
 /**
- * @returns {Logger}
+ * @type {Detox.Logger}
  */
-function init() {
-  const levelFromArg = argparse.getArgValue('loglevel', 'l');
-  const level = adaptLogLevelName(levelFromArg);
-  const debugStream = createPlainBunyanStream({ level, showDate: shortDateFormat });
-  const bunyanStreams = [debugStream];
-
-  let jsonFileStreamPath, plainFileStreamPath;
-  if (!global.DETOX_CLI && !global.IS_RUNNING_DETOX_UNIT_TESTS) {
-    {
-      jsonFileStreamPath = temporaryPath.for.log();
-      fs.ensureFileSync(jsonFileStreamPath);
-      bunyanStreams.push({
-        level: 'trace',
-        path: jsonFileStreamPath,
-      });
-    }
-    {
-      plainFileStreamPath = temporaryPath.for.log();
-      fs.ensureFileSync(plainFileStreamPath);
-      bunyanStreams.push(createPlainBunyanStream({
-        level: 'trace',
-        logPath: plainFileStreamPath,
-      }));
-    }
-
-    onExit(() => {
-      try { fs.unlinkSync(jsonFileStreamPath); } catch (e) {}
-      try { fs.unlinkSync(plainFileStreamPath); } catch (e) {}
-    });
-  }
-
-  const logger = bunyan.createLogger({
-    name: 'detox',
-    streams: bunyanStreams,
-  });
-
-  if (jsonFileStreamPath) {
-    logger.jsonFileStreamPath = jsonFileStreamPath;
-  }
-
-  if (plainFileStreamPath) {
-    logger.plainFileStreamPath = plainFileStreamPath;
-  }
-
-  tryOverrideConsole(logger, global);
-
-  logger.getDetoxLevel = () => level;
-
-  logger.reinitialize = (global) => {
-    if (jsonFileStreamPath) {
-      fs.ensureFileSync(jsonFileStreamPath);
-    }
-
-    if (plainFileStreamPath) {
-      fs.ensureFileSync(plainFileStreamPath);
-    }
-
-    tryOverrideConsole(logger, global);
-  };
-
-  const originalChild = logger.child.bind(logger);
-
-  logger.child = (options) => {
-    if (options && options.__filename) {
-      return originalChild({
-        ...options,
-        __filename: path.basename(options.__filename)
-      });
-    }
-
-    return originalChild(options);
-  };
-
-  return logger;
-}
-
-module.exports = init();
+module.exports = require('../../internals').log;

package/src/utils/shellUtils.js

@@ -1,7 +1,17 @@
+const SPACE = ' ';
 const BACK_SLASH = '\\';
 const SINGLE_QUOTE = "'";
 const DOUBLE_QUOTE = '"';
 
+function escapeSpacesCMD(str) {
+  return str.includes(' ') ? `"${str}"` : str;
+}
+
+const BACK_SLASH_SPACE = BACK_SLASH + SPACE;
+function escapeSpacesShell(str) {
+  return str.replace(/ /g, BACK_SLASH_SPACE);
+}
+
 const ESCAPED_DOUBLE_QUOTE = BACK_SLASH + DOUBLE_QUOTE;
 function escapeInDoubleQuotedString(fragment) {
   return fragment.replace(/"/g, ESCAPED_DOUBLE_QUOTE);
@@ -62,12 +72,20 @@ const autoEscape = isRunningInCMDEXE()
   /* istanbul ignore next */ ? autoEscapeCmd
   /* istanbul ignore next */ : autoEscapeShell;
 
+const escapeSpaces = isRunningInCMDEXE()
+  /* istanbul ignore next */ ? escapeSpacesCMD
+  /* istanbul ignore next */ : escapeSpacesShell;
+
 module.exports = {
   escapeInDoubleQuotedString,
   escapeInDoubleQuotedRegexp,
   escapeWithSingleQuotedString,
   escapeWithDoubleQuotedString,
   isRunningInCMDEXE,
+  escapeSpaces: Object.assign(escapeSpaces, {
+    cmd: escapeSpacesCMD,
+    shell: escapeSpacesShell,
+  }),
   hasUnsafeChars: Object.assign(hasUnsafeChars, {
     cmd: hasUnsafeCMDChars,
     shell: hasUnsafeShellChars,

package/src/utils/traceInvocationCall.js

@@ -0,0 +1,21 @@
+function _getCallStackTrace() {
+  return new Error().stack
+    .split('\n')
+    .slice(1) // Ignore Error message
+    .map(line => line
+      .replace(/^\s*at\s+/, '')
+      .replace(process.cwd(), '')
+    )
+    .filter(line => !line.includes('/detox/src')) // Ignore detox internal calls
+    .join('\n');
+}
+
+function invocationCall(logger, sectionName, invocation, action) {
+  return logger.trace.complete({
+    cat: 'ws-client,ws-client-invocation',
+    data: invocation,
+    stack: _getCallStackTrace(),
+  }, sectionName, action);
+}
+
+module.exports = invocationCall;

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/19.13.0/detox-19.13.0-javadoc.jar.md5

@@ -1 +0,0 @@
-a8ce440899ef9148a31b864c3094962d

package/Detox-android/com/wix/detox/19.13.0/detox-19.13.0-javadoc.jar.sha1

@@ -1 +0,0 @@
-174e8eaf7c6ea466dfa88a298dfd4d1deb637163

package/Detox-android/com/wix/detox/19.13.0/detox-19.13.0-javadoc.jar.sha256

@@ -1 +0,0 @@
-8cd8c4dd41157086419503abeb4cce716b5158e8f64de760d0c6a1ec9177840a

package/Detox-android/com/wix/detox/19.13.0/detox-19.13.0-javadoc.jar.sha512

@@ -1 +0,0 @@
-2777810ccd14eace29e3885089f2556669558d2290062f3b63f397fd29b3514683dad1df809a3faf6b622775ba13ce2eef069a47185336bdd1f4ad3e358e2a57

package/Detox-android/com/wix/detox/19.13.0/detox-19.13.0-sources.jar.md5

@@ -1 +0,0 @@
-0dcf8c98531c3a397bb077037367d943

package/Detox-android/com/wix/detox/19.13.0/detox-19.13.0-sources.jar.sha1

@@ -1 +0,0 @@
-45419e1782517e6f66b27b21f61c9ebb2e4eefde

package/Detox-android/com/wix/detox/19.13.0/detox-19.13.0-sources.jar.sha256

@@ -1 +0,0 @@
-cfddd6927b600e279e05e31dafc7dc65f16771e130192e95e49f462dfb81bb20

package/Detox-android/com/wix/detox/19.13.0/detox-19.13.0-sources.jar.sha512

@@ -1 +0,0 @@
-6c89ba08cab48a97f43e271147684bfbd6e0bed6a6d91ec7ec8c312c68b1438d0f39c5405dc9e04d0a6ed6fd71df4c36f2b89a027a36200faefdff60480402a1

package/Detox-android/com/wix/detox/19.13.0/detox-19.13.0.aar.md5

@@ -1 +0,0 @@
-d01f4a6e5efdfc00a2a36597297e5157

package/Detox-android/com/wix/detox/19.13.0/detox-19.13.0.aar.sha1

@@ -1 +0,0 @@
-f025d605b8b455cc9c242f88e3cb85f62a62b190

package/Detox-android/com/wix/detox/19.13.0/detox-19.13.0.aar.sha256

@@ -1 +0,0 @@
-4e18865814a0b6c26afb7c157d8aec507a9b9ec0f601e34b45937a7eb8e425d1

package/Detox-android/com/wix/detox/19.13.0/detox-19.13.0.aar.sha512

@@ -1 +0,0 @@
-abb4bae2959c784a4dfc0d2b10c044df4ec22a584bf40b204a9aa402b59d4d507d570d98f7d0bf0ce907232b66d074a14af2df2caf7341bf7ff25660ed0781e1

package/Detox-android/com/wix/detox/19.13.0/detox-19.13.0.pom.md5

@@ -1 +0,0 @@
-e2ad754efdb027593e52727a78281695

package/Detox-android/com/wix/detox/19.13.0/detox-19.13.0.pom.sha1

@@ -1 +0,0 @@
-8ab06eb57045034c591c3d818ba7eeec5cf6162d

package/Detox-android/com/wix/detox/19.13.0/detox-19.13.0.pom.sha256

@@ -1 +0,0 @@
-0e3a9fbaea75253f5690ed2991f97a3fa09c4b93f1f67cc2d3561d96309ad862

package/Detox-android/com/wix/detox/19.13.0/detox-19.13.0.pom.sha512

@@ -1 +0,0 @@
-616dda94b962b4be24c7012d27f515aa3d6675ac66d16d877a28e401a6e9ce6f27bc4bad9fe1ff43d9492b092c1a7d07982f1d0725ebc25cc8ed8c650b8a6626

package/local-cli/templates/mocha.js

@@ -1,32 +0,0 @@
-const firstTestContent = require('./firstTestContent');
-
-const mochaRcContent = JSON.stringify({
-  recursive: true,
-  timeout: 120000,
-  bail: true,
-  file: 'e2e/init.js',
-}, null, 4);
-
-const initjsContent = `const detox = require('detox');
-const adapter = require('detox/runners/mocha/adapter');
-
-before(async () => {
-  await detox.init();
-});
-
-beforeEach(async function () {
-  await adapter.beforeEach(this);
-});
-
-afterEach(async function () {
-  await adapter.afterEach(this);
-});
-
-after(async () => {
-  await detox.cleanup();
-});
-`;
-
-exports.initjs = initjsContent;
-exports.firstTest = firstTestContent;
-exports.runnerConfig = mochaRcContent;

package/local-cli/utils/splitArgv.js

@@ -1,107 +0,0 @@
-const _ = require('lodash');
-
-const { resolveJestCliArgs } = require('./jestInternals');
-const testCommandArgs = require('./testCommandArgs');
-
-function extractKnownKeys(yargsBuilder) {
-  return Object.entries(yargsBuilder).reduce(
-    (set, [key, option]) => {
-      if (option.alias) {
-        if (Array.isArray(option.alias)) {
-          for (const value of option.alias) {
-            set.add(value);
-          }
-        } else {
-          set.add(option.alias);
-        }
-      }
-
-      return set.add(key);
-    },
-    new Set()
-  );
-}
-
-function disengageBooleanArgs(argv, booleanKeys) {
-  const result = {};
-  const passthrough = [];
-
-  for (const entry of Object.entries(argv)) {
-    const [key, value] = entry;
-    if (key === '_' || key === '--') {
-      continue;
-    }
-
-    const positiveKey = key.startsWith('no-') ? key.slice(3) : key;
-    if (booleanKeys.has(positiveKey) && typeof value !== 'boolean') {
-      result[positiveKey] = key === positiveKey;
-      passthrough.push(value);
-    } else {
-      result[key] = value;
-    }
-  }
-
-  return {
-    specs: passthrough.concat(argv._),
-    passthrough: {
-      _: argv['--'] || [],
-      ...result,
-    },
-  };
-}
-
-function getJestBooleanArgs() {
-  return _(resolveJestCliArgs())
-    .thru(args => args.options)
-    .pickBy(({ type }) => type === 'boolean')
-    .thru(extractKnownKeys)
-    .value();
-}
-
-function getMochaBooleanArgs() {
-  const metadata = require('mocha/lib/cli/run-option-metadata');
-
-  return _(metadata.types.boolean)
-    .flatMap(key => [key, ...(metadata.aliases[key] || [])])
-    .thru(keys => new Set(keys))
-    .value();
-}
-
-function splitDetoxArgv(argv) {
-  const aliases = extractKnownKeys(testCommandArgs);
-  const isDetoxArg = (_value, key) => aliases.has(key);
-
-  const detoxArgs = _.pickBy(argv, isDetoxArg);
-  const runnerArgs = _.omitBy(argv, isDetoxArg);
-  runnerArgs._ = runnerArgs._.slice(1); // omit 'test' string, as in 'detox test'
-  if (typeof detoxArgs['debug-synchronization'] === 'string') {
-    const erroneousPassthrough = detoxArgs['debug-synchronization'];
-    detoxArgs['debug-synchronization'] = 3000;
-    runnerArgs._.unshift(erroneousPassthrough);
-  }
-
-  return { detoxArgs, runnerArgs };
-}
-
-function splitMochaArgv(argv) {
-  return disengageBooleanArgs(argv, getMochaBooleanArgs());
-}
-
-function splitJestArgv(argv) {
-  return realiasJestArgv(disengageBooleanArgs(argv, getJestBooleanArgs()));
-}
-
-function realiasJestArgv({ specs, passthrough }) {
-  if (passthrough.hasOwnProperty('t')) {
-    passthrough.testNamePattern = passthrough.t;
-    delete passthrough.t;
-  }
-
-  return { specs, passthrough };
-}
-
-module.exports = {
-  detox: splitDetoxArgv,
-  jest: splitJestArgv,
-  mocha: splitMochaArgv,
-};

package/runners/integration.js

@@ -1,16 +0,0 @@
-module.exports = {
-  lifecycle: {
-    onRunStart: Symbol('run_start'),
-    onRunDescribeStart: Symbol('run_describe_start'),
-    onTestStart: Symbol('test_start'),
-    onHookStart: Symbol('hook_start'),
-    onHookFailure: Symbol('hook_failure'),
-    onHookSuccess: Symbol('hook_success'),
-    onTestFnStart: Symbol('test_fn_start'),
-    onTestFnFailure: Symbol('test_fn_failure'),
-    onTestFnSuccess: Symbol('test_fn_success'),
-    onTestDone: Symbol('test_done'),
-    onRunDescribeFinish: Symbol('run_describe_finish'),
-    onRunFinish: Symbol('run_finish'),
-  },
-};