appium/lib/cli/utils.js

Automation for Apps.

/* eslint-disable no-console */

import ora from 'ora';

export const JSON_SPACES = 4;

/***
 * Log an error to the console and exit the process.
 * @param {boolean} json - whether we should log json or text
 * @param {any} msg - error message, object, Error instance, etc.
 */
export function errAndQuit(json, msg) {
  if (json) {
    console.log(JSON.stringify({error: `${msg}`}, null, JSON_SPACES));
  } else {
    console.error(`${msg}`.red);
    if (msg.stderr) {
      console.error(`${msg.stderr}`.red);
    }
  }
  process.exit(1);
}

/**
 * Conditionally log something to the console
 * @param {boolean} json - whether we are in json mode (and should therefore not log)
 * @param {string} msg - string to log
 */
export function log(json, msg) {
  if (!json) {
    console.log(msg);
  }
}

/**
 * Start a spinner, execute an async function, and then stop the spinner
 * @param {boolean} json - whether we are in json mode (and should therefore not log)
 * @param {string} msg - string to log
 * @param {function} fn - function to wrap with spinning
 */
export async function spinWith(json, msg, fn) {
  if (json) {
    return await fn();
  }
  const spinner = ora(msg).start();
  let res;
  try {
    res = await fn();
    spinner.succeed();
    return res;
  } catch (err) {
    spinner.fail();
    throw err;
  }
}

export class RingBuffer {
  constructor(size = 50) {
    this.size = size;
    this.buffer = [];
  }

  /**
   * Get the current buffer contents
   *
   * @returns {any[]}
   */
  getBuff() {
    return this.buffer;
  }

  /**
   * Remove the oldest item from the buffer
   *
   * @returns {void}
   */
  dequeue() {
    this.buffer.shift();
  }
  /**
   * Add an item to the buffer
   *
   * @param {any} item
   */
  enqueue(item) {
    if (this.buffer.length >= this.size) {
      this.dequeue();
    }
    this.buffer.push(item);
  }
}