detox/src/errors/DetoxRuntimeError.js

E2E tests and automation for mobile

const _ = require('lodash');

const DetoxError = require('./DetoxError');

/**
 * @typedef DetoxRuntimeErrorOptions
 * @property [message] { String }
 * @property [hint] { String }
 * @property [debugInfo] { * }
 * @property [noStack] { Boolean }
 * @property [inspectOptions] { Object }
 */

class DetoxRuntimeError extends DetoxError {
  /**
   * @param [options] { String | DetoxRuntimeErrorOptions }
   */
  constructor(options) {
    super(formatOptions(options));
    this.name = 'DetoxRuntimeError';

    if (options && typeof options !== 'string' && options.noStack) {
      this.stack = '';
    }
  }
}

function formatOptions(options) {
  if (_.isObject(options)) {
    const {
      message = '',
      hint = '',
      debugInfo = '',
      inspectOptions = null,
    } = options;

    return _.compact([
      message,
      hint && `HINT: ${hint}`,
      _.isString(debugInfo)
        ? debugInfo
        : DetoxError.format(debugInfo, inspectOptions),
    ]).join('\n\n');
  }

  return options;
}

module.exports = DetoxRuntimeError;