metalog 3.1.5 → 3.1.8

package/CHANGELOG.md

@@ -2,6 +2,22 @@
 
 ## [Unreleased][unreleased]
 
+## [3.1.8][] - 2022-03-30
+
+- Add support for json-only logs
+
+## [3.1.7][] - 2022-03-17
+
+- Fix unlink empty files
+- Improve error handling
+- Update dependencies and package maintenance
+
+## [3.1.6][] - 2021-12-08
+
+- Fix typings
+- Remove useless code from tests
+- Fix unlink file bug
+
 ## [3.1.5][] - 2021-10-11
 
 - Update dependencies and npm audit fix
@@ -52,7 +68,10 @@
 
 First generation of Metarhia Logger
 
-[unreleased]: https://github.com/metarhia/metalog/compare/v3.1.5...HEAD
+[unreleased]: https://github.com/metarhia/metalog/compare/v3.1.8...HEAD
+[3.1.8]: https://github.com/metarhia/metalog/compare/v3.1.7...v3.1.8
+[3.1.7]: https://github.com/metarhia/metalog/compare/v3.1.6...v3.1.7
+[3.1.6]: https://github.com/metarhia/metalog/compare/v3.1.5...v3.1.6
 [3.1.5]: https://github.com/metarhia/metalog/compare/v3.1.4...v3.1.5
 [3.1.4]: https://github.com/metarhia/metalog/compare/v3.1.3...v3.1.4
 [3.1.3]: https://github.com/metarhia/metalog/compare/v3.1.2...v3.1.3

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2017-2021 Metarhia
+Copyright (c) 2017-2022 Metarhia
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,7 +1,6 @@
 # Meta Logger for Metarhia
 
 [![ci status](https://github.com/metarhia/metalog/workflows/Testing%20CI/badge.svg)](https://github.com/metarhia/metalog/actions?query=workflow%3A%22Testing+CI%22+branch%3Amaster)
-[![codacy](https://api.codacy.com/project/badge/Grade/7aaad5ed17c74634855fa6202a03a56e)](https://www.codacy.com/app/metarhia/metalog)
 [![snyk](https://snyk.io/test/github/metarhia/impress/badge.svg)](https://snyk.io/test/github/metarhia/impress)
 [![npm version](https://img.shields.io/npm/v/metalog.svg?style=flat)](https://www.npmjs.com/package/metalog)
 [![npm downloads/month](https://img.shields.io/npm/dm/metalog.svg)](https://www.npmjs.com/package/metalog)
@@ -22,6 +21,7 @@ const logger = await metalog.openLog({
   writeBuffer: 64 * 1024, // buffer size (default 64kb)
   keepDays: 5, // delete after N days, 0 - disable
   home: process.cwd(), // remove substring from paths
+  json: false, // print logs in JSON format, by default false
 });
 
 const { console } = logger;
@@ -31,6 +31,6 @@ await logger.close();
 
 ## License & Contributors
 
-Copyright (c) 2017-2021 [Metarhia contributors](https://github.com/metarhia/metalog/graphs/contributors).
+Copyright (c) 2017-2022 [Metarhia contributors](https://github.com/metarhia/metalog/graphs/contributors).
 Metalog is [MIT licensed](./LICENSE).\
 Metalog is a part of [Metarhia](https://github.com/metarhia) technology stack.

package/metalog.d.ts

@@ -3,13 +3,14 @@ import EventEmitter = require('events');
 interface LoggerOptions {
   path: string;
   home: string;
-  workerId: number;
-  createStream: () => NodeJS.WritableStream;
+  workerId?: number;
+  createStream?: () => NodeJS.WritableStream;
   writeInterval: number;
   writeBuffer: number;
   keepDays: number;
-  toFile: Array<string>;
-  toStdout: Array<string>;
+  json?: boolean;
+  toFile?: Array<string>;
+  toStdout?: Array<string>;
 }
 
 export class Logger extends EventEmitter {
@@ -27,9 +28,9 @@ export class Logger extends EventEmitter {
   lock: boolean;
   buffer: Array<Buffer>;
   file: string;
-  toFile: Array<string>;
+  toFile: Record<string, boolean>;
   fsEnabled: boolean;
-  toStdout: Array<string>;
+  toStdout: Record<string, boolean>;
   console: Console;
   constructor(args: LoggerOptions);
   createLogDir(): Promise<void>;

package/metalog.js

@@ -77,10 +77,13 @@ const getNextReopen = () => {
   return nextDate - curTime + DAY_MILLISECONDS;
 };
 
+const isError = (val) =>
+  Object.prototype.toString.call(val) === '[object Error]';
+
 class Console {
   constructor(write) {
     this._write = write;
-    this._groupIndent = '';
+    this._groupIndent = 0;
     this._counts = new Map();
     this._times = new Map();
   }
@@ -89,7 +92,7 @@ class Console {
     try {
       console.assert(assertion, ...args);
     } catch (err) {
-      this._write('error', `${this._groupIndent}${err.stack}`);
+      this._write('error', this._groupIndent, err.stack);
     }
   }
 
@@ -102,7 +105,7 @@ class Console {
     let cnt = this._counts.get(label) || 0;
     cnt++;
     this._counts.set(label, cnt);
-    this._write('debug', `${this._groupIndent}${label}: ${cnt}`);
+    this._write('debug', this._groupIndent, `${label}: ${cnt}`);
   }
 
   countReset(label = 'default') {
@@ -110,23 +113,38 @@ class Console {
   }
 
   debug(...args) {
-    const msg = util.format(...args);
-    this._write('debug', `${this._groupIndent}${msg}`);
+    this._write('debug', this._groupIndent, ...args);
   }
 
   dir(...args) {
-    const msg = util.inspect(...args);
-    this._write('debug', `${this._groupIndent}${msg}`);
+    this._write('debug', this._groupIndent, ...args);
   }
 
-  error(...args) {
+  trace(...args) {
     const msg = util.format(...args);
-    this._write('error', `${this._groupIndent}${msg}`);
+    const err = new Error(msg);
+    this._write('debug', this._groupIndent, `Trace${err.stack}`);
+  }
+
+  info(...args) {
+    this._write('info', this._groupIndent, ...args);
+  }
+
+  log(...args) {
+    this._write('log', this._groupIndent, ...args);
+  }
+
+  warn(...args) {
+    this._write('warn', this._groupIndent, ...args);
+  }
+
+  error(...args) {
+    this._write('error', this._groupIndent, ...args);
   }
 
   group(...args) {
     if (args.length !== 0) this.log(...args);
-    this._groupIndent = ' '.repeat(this._groupIndent.length + INDENT);
+    this._groupIndent += INDENT;
   }
 
   groupCollapsed(...args) {
@@ -135,21 +153,11 @@ class Console {
 
   groupEnd() {
     if (this._groupIndent.length === 0) return;
-    this._groupIndent = ' '.repeat(this._groupIndent.length - INDENT);
-  }
-
-  info(...args) {
-    const msg = util.format(...args);
-    this._write('info', `${this._groupIndent}${msg}`);
-  }
-
-  log(...args) {
-    const msg = util.format(...args);
-    this._write('log', `${this._groupIndent}${msg}`);
+    this._groupIndent -= INDENT;
   }
 
   table(tabularData) {
-    this._write('log', JSON.stringify(tabularData));
+    this._write('log', 0, JSON.stringify(tabularData));
   }
 
   time(label = 'default') {
@@ -160,31 +168,18 @@ class Console {
     const startTime = this._times.get(label);
     const totalTime = process.hrtime(startTime);
     const totalTimeMs = totalTime[0] * 1e3 + totalTime[1] / 1e6;
-    const msg = `${this._groupIndent}${label}: ${totalTimeMs}ms`;
-    this.timeLog(label, msg);
+    this.timeLog(label, `${label}: ${totalTimeMs}ms`);
     this._times.delete(label);
   }
 
   timeLog(label, ...args) {
     const startTime = this._times.get(label);
     if (startTime === undefined) {
-      const msg = `${this._groupIndent}Warning: No such label '${label}'`;
-      this._write('warn', msg);
+      const msg = `Warning: No such label '${label}'`;
+      this._write('warn', this._groupIndent, msg);
       return;
     }
-    const msg = util.format(...args);
-    this._write('debug', msg);
-  }
-
-  trace(...args) {
-    const msg = util.format(...args);
-    const err = new Error(msg);
-    this._write('debug', `${this._groupIndent}Trace${err.stack}`);
-  }
-
-  warn(...args) {
-    const msg = util.format(...args);
-    this._write('warn', `${this._groupIndent}${msg}`);
+    this._write('debug', this._groupIndent, ...args);
   }
 }
 
@@ -192,7 +187,7 @@ class Logger extends events.EventEmitter {
   constructor(args) {
     super();
     const { workerId = 0, createStream = fs.createWriteStream } = args;
-    const { writeInterval, writeBuffer, keepDays, home } = args;
+    const { writeInterval, writeBuffer, keepDays, home, json } = args;
     const { toFile, toStdout } = args;
     this.active = false;
     this.path = args.path;
@@ -202,6 +197,7 @@ class Logger extends events.EventEmitter {
     this.writeBuffer = writeBuffer || DEFAULT_BUFFER_SIZE;
     this.keepDays = keepDays || DEFAULT_KEEP_DAYS;
     this.home = home;
+    this.json = Boolean(json);
     this.stream = null;
     this.reopenTimer = null;
     this.flushTimer = null;
@@ -211,7 +207,7 @@ class Logger extends events.EventEmitter {
     this.toFile = logTypes(toFile);
     this.fsEnabled = Object.keys(this.toFile).length !== 0;
     this.toStdout = logTypes(toStdout);
-    this.console = new Console((type, message) => this.write(type, message));
+    this.console = new Console((...args) => this.write(...args));
     return this.open();
   }
 
@@ -224,7 +220,8 @@ class Logger extends events.EventEmitter {
             resolve();
             return;
           }
-          this.emit(new Error(`Can not create directory: ${this.path}\n`));
+          const error = new Error(`Can not create directory: ${this.path}\n`);
+          this.emit('error', error);
           reject();
         });
       });
@@ -246,7 +243,10 @@ class Logger extends events.EventEmitter {
       this.once('close', () => {
         this.open();
       });
-      this.close();
+      this.close().catch((err) => {
+        process.stdout.write(`${err.stack}\n`);
+        this.emit('error', err);
+      });
     }, nextReopen);
     if (this.keepDays) await this.rotate();
     const options = { flags: 'a', bufferSize: this.writeBuffer };
@@ -278,8 +278,6 @@ class Logger extends events.EventEmitter {
     return new Promise((resolve, reject) => {
       this.flush((err) => {
         if (err) {
-          process.stdout.write(`${err.stack}\n`);
-          this.emit('error', err);
           reject(err);
           return;
         }
@@ -291,11 +289,11 @@ class Logger extends events.EventEmitter {
           this.reopenTimer = null;
           const fileName = this.file;
           this.emit('close');
-          resolve();
           fs.stat(fileName, (err, stats) => {
             if (!err && stats.size === 0) {
-              fsp.unlink(this.file);
+              fsp.unlink(fileName).catch(() => {});
             }
+            resolve();
           });
         });
       });
@@ -321,25 +319,63 @@ class Logger extends events.EventEmitter {
     }
   }
 
-  write(type, s) {
-    const date = new Date();
-    const dateTime = date.toISOString();
+  format(type, indent, ...args) {
     const normalize = type === 'error' || type === 'debug';
-    const message = normalize ? this.normalizeStack(s) : s;
+    const s = `${' '.repeat(indent)}${util.format(...args)}`;
+    return normalize ? this.normalizeStack(s) : s;
+  }
+
+  formatPretty(type, indent, ...args) {
+    const dateTime = new Date().toISOString();
+    const message = this.format(type, indent, ...args);
+    const normalColor = TEXT_COLOR[type];
+    const markColor = TYPE_COLOR[type];
+    const time = normalColor(dateTime.substring(TIME_START, TIME_END));
+    const id = normalColor(this.workerId);
+    const mark = markColor(' ' + type.padEnd(TYPE_LENGTH));
+    const msg = normalColor(message);
+    return `${time}  ${id}  ${mark}  ${msg}`;
+  }
+
+  formatFile(type, indent, ...args) {
+    const dateTime = new Date().toISOString();
+    const message = this.format(type, indent, ...args);
+    const msg = metautil.replace(message, '\n', LINE_SEPARATOR);
+    return `${dateTime} [${type}] ${msg}`;
+  }
+
+  formatJson(type, indent, ...args) {
+    const log = {
+      timestamp: new Date().toISOString(),
+      workerId: this.workerId,
+      level: type,
+      message: null,
+    };
+    if (isError(args[0])) {
+      log.err = this.expandError(args[0]);
+      args = args.slice(1);
+    } else if (typeof args[0] === 'object') {
+      Object.assign(log, args[0]);
+      if (isError(log.err)) log.err = this.expandError(log.err);
+      if (isError(log.error)) log.error = this.expandError(log.error);
+      args = args.slice(1);
+    }
+    log.message = util.format(...args);
+    return JSON.stringify(log);
+  }
+
+  write(type, indent, ...args) {
     if (this.toStdout[type]) {
-      const normalColor = TEXT_COLOR[type];
-      const markColor = TYPE_COLOR[type];
-      const time = normalColor(dateTime.substring(TIME_START, TIME_END));
-      const id = normalColor(this.workerId);
-      const mark = markColor(' ' + type.padEnd(TYPE_LENGTH));
-      const msg = normalColor(message);
-      const line = `${time}  ${id}  ${mark}  ${msg}\n`;
-      process.stdout.write(line);
+      const line = this.json
+        ? this.formatJson(type, indent, ...args)
+        : this.formatPretty(type, indent, ...args);
+      process.stdout.write(line + '\n');
     }
     if (this.toFile[type]) {
-      const msg = metautil.replace(message, '\n', LINE_SEPARATOR);
-      const line = `${dateTime} [${type}] ${msg}\n`;
-      const buffer = Buffer.from(line);
+      const line = this.json
+        ? this.formatJson(type, indent, ...args)
+        : this.formatFile(type, indent, ...args);
+      const buffer = Buffer.from(line + '\n');
       this.buffer.push(buffer);
     }
   }
@@ -375,6 +411,14 @@ class Logger extends events.EventEmitter {
     if (this.home) res = metautil.replace(res, this.home, '');
     return res;
   }
+
+  expandError(err) {
+    return {
+      message: err.message,
+      stack: this.normalizeStack(err.stack),
+      ...err,
+    };
+  }
 }
 
 const openLog = async (args) => new Logger(args);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "metalog",
-  "version": "3.1.5",
+  "version": "3.1.8",
   "author": "Timur Shemsedinov <timur.shemsedinov@gmail.com>",
   "description": "Logger for Metarhia",
   "license": "MIT",
@@ -49,21 +49,21 @@
     "fmt": "prettier --write \"**/*.js\" \"**/*.json\" \"**/*.md\" \"**/.*rc\" \"**/*.ts\""
   },
   "engines": {
-    "node": "^12.10 || 14 || 16"
+    "node": "^12.10 || 14 || 16 || 17"
   },
   "dependencies": {
     "concolor": "^1.0.2",
-    "metautil": "^3.5.16"
+    "metautil": "^3.5.19"
   },
   "devDependencies": {
-    "@types/node": "^16.10.3",
-    "eslint": "^7.32.0",
+    "@types/node": "^17.0.21",
+    "eslint": "^8.11.0",
     "eslint-config-metarhia": "^7.0.0",
-    "eslint-config-prettier": "^8.3.0",
-    "eslint-plugin-import": "^2.24.2",
+    "eslint-config-prettier": "^8.5.0",
+    "eslint-plugin-import": "^2.25.4",
     "eslint-plugin-prettier": "^4.0.0",
-    "metatests": "^0.7.2",
-    "prettier": "^2.4.1",
-    "typescript": "^4.4.3"
+    "metatests": "^0.8.2",
+    "prettier": "^2.6.0",
+    "typescript": "^4.6.2"
   }
 }