@contrast/route-metrics/lib/log-processor/reporters/base-reporter.cjs

`route-metrics` allows server performance, exclusive of network time, to be compared on a route-by-route basis. It was created to compare server performance with and without `@contrast/agent` being loaded and active.

'use strict';

/**
 * @classdesc Implement the base functions for reporters.
 *
 * @class BaseReporter
 *
 * @param {object} stream the stream to write the report to
 * @param {object} overallInfo details information about the
 * @param {object} meta meta information about the summary
 * @param {object} options
 *
 */
class BaseReporter {
  constructor(stream, overallInfo, options) {
    this.stream = stream;
    this.overallInfo = overallInfo;
    this.options = options;

    this.runSummaries = this.overallInfo.runSummaries;
  }

  /**
   * function to report information that pertains to the entire file
   * that was read.
   */
  reportOverall() {
    const count = this.runSummaries.length;
    const {file, linesRead, charCount} = this.overallInfo;
    const yOrIes = count === 1 ? 'summary' : 'summaries';
    // eslint-disable-next-line no-console
    console.log(`[[read ${count} ${yOrIes} (${linesRead} lines, ${charCount} chars) from ${file}]]\n`);
  }

  report() {
    throw new Error('report must be implemented by BaseReporter subclasses');
  }

  getTimeSeriesCount(timeSeries) {
    let count = 0;
    for (const tsKey in timeSeries) {
      if (timeSeries[tsKey].count !== 0) {
        count += timeSeries[tsKey].count;
      }
    }
    return count;
  }
}

module.exports = BaseReporter;