All files / src/packages/logger index.ts

8.45% Statements 6/71
0% Branches 0/18
6.25% Functions 1/16
10% Lines 6/60

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142  1x 1x   1x   1x         1x 1x                                                                                                                                                                                                                                                                  
import { Request, Response } from 'express';
import * as format from 'string-template';
import { LOGGER_TYPE_MAPPER, LoggerType } from './shared/const';
import { IBaseLogger, IBaseLoggerOptions, IKafkaLogContext, ILogInput } from './shared/interface';
import { formatResBodyString, getUserId } from './shared/utils';
 
export class Logger implements IBaseLogger {
  logger: IBaseLogger;
  options: IBaseLoggerOptions;
 
  constructor(type: LoggerType, options: IBaseLoggerOptions) {
    this.options = options;
    this.logger = new LOGGER_TYPE_MAPPER[type](this.options);
  }
 
  info(message: string, data?: ILogInput): void {
    this.logger.info(message, data);
  }
  debug(message: string, data?: ILogInput): void {
    this.logger.debug(message, data);
  }
  warn(message: string, data?: ILogInput): void {
    this.logger.warn(message, data);
  }
  error(message: string, data?: ILogInput): void {
    this.logger.error(message, data);
  }
  fatal(message: string, data?: ILogInput): void {
    this.logger.fatal(message, data);
  }
 
  httpLog(req: Request & { timestamp?: number }, res: Response) {
    const elapsedStart = req.timestamp ?? 0;
    const elapsedEnd = Date.now();
    const processTime = format('{0}ms', [elapsedStart > 0 ? elapsedEnd - elapsedStart : 0]);
    res.setHeader('x-process-time', processTime);
 
    const rawResponse = res.write;
    const rawResponseEnd = res.end;
    const chunks: Buffer[] = [];
 
    res.write = (...args: any[]) => {
      const restArgs: any = [];
      for (let i = 0; i < args.length; i++) restArgs[i] = args[i];
      chunks.push(Buffer.from(restArgs[0]));
      rawResponse.apply(res, restArgs);
      return true;
    };
 
    res.end = (...args: any[]) => {
      const restArgs: any = [];
      for (let i = 0; i < args.length; i++) restArgs[i] = args[i];
      Iif (restArgs[0]) chunks.push(Buffer.from(restArgs[0]));
      const body = Buffer.concat(chunks).toString('utf8');
      const payload = {
        userId: getUserId(),
        timestamp: new Date().toISOString(),
        processTime,
        request: {
          headers: req.headers,
          body: req.body,
          clientIP: req.headers['x-forwarded-for'] || req.socket.remoteAddress,
          userAgent: req.headers['user-agent'],
          originalUri: req.originalUrl,
          uri: req.url,
          method: req.method,
        },
        response: {
          headers: res.getHeaders(),
          body: formatResBodyString(body),
          statusCode: res.statusCode,
        },
      };
      if (res.statusCode >= 200 && res.statusCode < 400)
        this.info(`HTTP Success Log [${res.statusCode}]`, payload);
      else this.error(`HTTP Error Log [${res.statusCode}]`, payload);
      rawResponseEnd.apply(res, restArgs);
      return res;
    };
  }
 
  httpRequestLog(req: Request) {
    const payload = {
      userId: getUserId(),
      timestamp: new Date().toISOString(),
      headers: req.headers,
      body: req.body,
      clientIP: req.headers['x-forwarded-for'] || req.socket.remoteAddress,
      userAgent: req.headers['user-agent'],
      originalUri: req.originalUrl,
      uri: req.url,
      method: req.method,
    };
    this.info(`HTTP Incoming Request`, payload);
  }
 
  httpResponseLog(res: Response) {
    const rawResponse = res.write;
    const rawResponseEnd = res.end;
    const chunks: Buffer[] = [];
 
    res.write = (...args: any[]) => {
      const restArgs: any = [];
      for (let i = 0; i < args.length; i++) restArgs[i] = args[i];
      chunks.push(Buffer.from(restArgs[0]));
      rawResponse.apply(res, restArgs);
      return true;
    };
 
    res.end = (...args: any[]) => {
      const restArgs: any = [];
      for (let i = 0; i < args.length; i++) restArgs[i] = args[i];
      Iif (restArgs[0]) chunks.push(Buffer.from(restArgs[0]));
      const body = Buffer.concat(chunks).toString('utf8');
      const payload = {
        userId: getUserId(),
        timestamp: new Date().toISOString(),
        headers: res.getHeaders(),
        body: formatResBodyString(body),
        statusCode: res.statusCode,
      };
      const message = `HTTP Outgoing Response [${res.statusCode}]`;
      if (res.statusCode >= 200 && res.statusCode < 400) this.info(message, payload);
      else this.error(message, payload);
      rawResponseEnd.apply(res, restArgs);
      return res;
    };
  }
 
  kafkaRequestLog(context: IKafkaLogContext) {
    this.info(`Kafka Incoming Request`, context);
  }
 
  kafkaResponseLog(context: IKafkaLogContext) {
    this.info(`Kafka Outgoing Response`, context);
  }
 
  kafkaResponseErrorLog(err: Error) {
    this.error(`Kafka Outgoing Response`, err);
  }
}