testium-driver-wd/lib/browser/console.js

Testium backend powered by wd

/*
 * Copyright (c) 2015, Groupon, Inc.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * Redistributions of source code must retain the above copyright notice,
 * this list of conditions and the following disclaimer.
 *
 * Redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution.
 *
 * Neither the name of GROUPON nor the names of its contributors may be
 * used to endorse or promote products derived from this software without
 * specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
 * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
 * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

'use strict';

const assert = require('assert');

const logMap = {
  SEVERE: 'error',
  WARNING: 'warn',
  INFO: 'log',
  DEBUG: 'debug',
};

const TYPES = new Set(['error', 'warn', 'log', 'debug']);

let cachedLogs = [];

/**
 * @typedef {Object} BrowserLog
 * @property {string} level
 * @property {string} message
 * @property {string} source
 * @property {number} timestamp
 */

/**
 * @typedef {Object} ParsedLogs
 * @property {('error'|'warn'|'log'|'debug')} type
 * @property {string} message
 * @property {string} source
 * @property {number} timestamp
 */

/**
 * @param {BrowserLog} log
 * @returns {ParsedLogs}
 */
function convertLogType(log) {
  if (log.level) {
    log.type = logMap[log.level];
    delete log.level;
  }
  return log;
}

/**
 *
 * @param {BrowserLog[]} logs
 * @returns {ParsedLogs[]}
 */
function parseLogs(logs) {
  return logs.map(log => convertLogType(log));
}

/**
 * @param {Log[]} logs
 * @param {('error'|'warn'|'log'|'debug')?} type
 * @returns {{matched: ParsedLogs[], rest?: ParsedLogs[] }}
 */
function filterLogs(logs, type) {
  if (!type) {
    return { matched: logs };
  }
  return logs.reduce(
    (acc, log) => {
      log.type === type ? acc.matched.push(log) : acc.rest.push(log);
      return acc;
    },
    { matched: [], rest: [] }
  );
}

/**
 *
 * @param {string} type
 * @param {ParsedLogs} newLogs
 * @returns {ParsedLogs[]}
 */
function processLogs(type, newLogs) {
  const logs = cachedLogs.concat(newLogs);
  const filtered = filterLogs(logs, type);

  cachedLogs = filtered.rest || [];
  return filtered.matched || [];
}

/**
 * @param {('error'|'warn'|'log'|'debug')?} type
 * @returns {Promise<ParsedLogs|ParsedLogs[]>}

 * @example browser.getConsoleLogs()
 * @example browser.getConsoleLogs('error')
 * @example browser.getConsoleLogs('warn')
 * @example browser.getConsoleLogs('log')
 * @example browser.getConsoleLogs('debug')
 */
async function getConsoleLogs(type) {
  if (type) {
    assert.ok(TYPES.has(type));
  }

  return this.log('browser').then(parseLogs).then(processLogs.bind(null, type));
}

module.exports = {
  getConsoleLogs,
};