@workablehr/riviere/lib/formatters/BaseFormatter.js

log inbound/outbound HTTP traffic

const logTags = require('../logTags');
const chalk = require('chalk');
const colors = require('../appenders/colors');

const outRes = logTags.CATEGORY.OUTBOUND_RESPONSE;
const inReq = logTags.CATEGORY.INBOUND_REQUEST;
const outReq = logTags.CATEGORY.OUTBOUND_REQUEST;
const inRes = logTags.CATEGORY.INBOUND_RESPONSE;
const inReqH = logTags.CATEGORY.INBOUND_REQUEST_HEALTH;
const outResH = logTags.CATEGORY.OUTBOUND_RESPONSE_HEALTH;
const unexpectedErr = logTags.CATEGORY.UNEXPECTED_ERROR;

const colorStatusCodes = {
  7: 'magenta',
  5: 'red',
  4: 'yellow',
  3: 'cyan',
  2: 'green',
  1: 'green',
  0: 'yellow'
};

class BaseFormatter {
  constructor(color = false, appendDate = false, requestType = '', loggerCallback = null) {
    this.color = color;
    this.appendDate = appendDate;
    this.requestType = requestType;
    this.loggerCallback = loggerCallback;
  }

  formatObject(obj) {
    throw new Error('Not implemented');
  }

  getColorByStatus(status) {
    const s = Math.floor(status / 100);
    return s in colorStatusCodes ? colorStatusCodes[s] : colorStatusCodes[0];
  }

  getPrefix(obj) {
    const prefixMapper = {
      [inReq.TAG]: obj => {
        return this.getInRequestPrefix(obj);
      },
      [outReq.TAG]: obj => {
        return this.getOutRequestPrefix(obj);
      },
      [inReqH.TAG]: obj => {
        return this.getInRequestHealthPrefix(obj);
      },
      [inRes.TAG]: obj => {
        return this.getInResponsePrefix(obj);
      },
      [outRes.TAG]: obj => {
        return this.getOutResponsePrefix(obj);
      },
      [outResH.TAG]: obj => {
        return this.getOutResponseHealthPrefix(obj);
      },
      [unexpectedErr.TAG]: obj => {
        return this.getUnexpectedErrorPrefix(obj);
      }
    };

    return prefixMapper[this.requestType] ? prefixMapper[this.requestType](obj) : '';
  }

  getInRequestPrefix(obj) {
    let requestInfo = `[${obj.requestId}]`;
    let method = obj.method;

    if (this.appendDate) {
      requestInfo = `[${new Date().toISOString()}] ${requestInfo}`;
    }

    if (this.color) {
      requestInfo = chalk.grey(requestInfo);
      method = chalk.bold(method);
    }

    return `${requestInfo} ${inReq.MSG} ${method} ${obj.path}`;
  }

  getOutRequestPrefix(obj) {
    let requestInfo = `[${obj.requestId}]`;
    let method = obj.method;

    if (this.appendDate) {
      requestInfo = `[${new Date().toISOString()}] ${requestInfo}`;
    }

    if (this.color) {
      requestInfo = chalk.grey(requestInfo);
      method = chalk.bold(method);
    }

    return `${requestInfo} ${outReq.MSG} ${method} ${obj.href} ${obj.contentLength}b`;
  }

  getInResponsePrefix(obj) {
    let requestInfo = `[${obj.requestId}]`;
    let method = obj.method;
    let status = obj.status;

    if (this.appendDate) {
      requestInfo = `[${new Date().toISOString()}] ${requestInfo}`;
    }

    if (this.color) {
      requestInfo = chalk.grey(requestInfo);
      method = chalk.bold(method);
      status = chalk[this.getColorByStatus(status)](status);
    }

    return `${requestInfo} ${inRes.MSG} ${method} ${obj.href} ${status} ${obj.duration}ms ${obj.contentLength}b`;
  }

  getOutResponsePrefix(obj) {
    let requestInfo = `[${obj.requestId}]`;
    let method = obj.method;
    let status = obj.status;

    if (this.appendDate) {
      requestInfo = `[${new Date().toISOString()}] ${requestInfo}`;
    }

    if (this.color) {
      requestInfo = chalk.grey(requestInfo);
      method = chalk.bold(method);
      status = chalk[this.getColorByStatus(status)](status);
    }

    return `${requestInfo} ${outRes.MSG} ${method} ${obj.path} ${status} ${obj.duration}ms ${obj.contentLength}b`;
  }

  getInRequestHealthPrefix(obj) {
    let prefix = `${inReqH.MSG} ${obj.method} ${obj.path}`;
    if (this.appendDate) {
      prefix = `[${new Date().toISOString()}] ${prefix}`;
    }
    if (this.color) {
      prefix = chalk[colors[inReqH.TAG]](prefix);
    }
    return prefix;
  }

  getOutResponseHealthPrefix(obj) {
    let prefix = `${outResH.MSG} ${obj.method} ${obj.path} ${obj.status} ${obj.duration}ms`;
    if (this.appendDate) {
      prefix = `[${new Date().toISOString()}] ${prefix}`;
    }
    if (this.color) {
      prefix = obj.status < 400 ? chalk[colors[outResH.TAG]](prefix) : chalk[colors.err](prefix);
    }
    return prefix;
  }

  getUnexpectedErrorPrefix(obj) {
    let prefix = `[${obj.context.requestId}] ${obj.context.protocol} ${obj.context.method} ${obj.context.path} |`;
    if (this.appendDate) {
      prefix = `[${new Date().toISOString()}] ${prefix}`;
    }
    if (this.color) {
      prefix = chalk[colors[unexpectedErr.TAG]](prefix);
    }
    return `${prefix} ${obj.stack}`;
  }
}

module.exports = BaseFormatter;