Merge pull request #84 from trojs/feature/console-format-json

Possible to choose between console simple or json

README.md

@@ -97,3 +97,4 @@ More info:
 
 * level (default: trace)
 * debug (default: false, stacktrace in console)
+* format (default: simple, also possible to set to json which is useful for different log systems)

package.json

@@ -1,7 +1,7 @@
 {
     "name": "@trojs/logger",
     "description": "Winston logger for TroJS",
-    "version": "0.4.5",
+    "version": "0.5.0",
     "author": {
         "name": "Pieter Wigboldus",
         "url": "https://trojs.org/"

src/logger.js

@@ -1,6 +1,12 @@
 import winston from 'winston';
 import makeLoggers from './loggers/index.js';
 
+/**
+ * @typedef {import('./models/schemas/logger.js').Logger} LoggerType
+ * @typedef {import('./models/enums/level.js').LevelType} LevelType
+ */
+
+/** @type {LoggerType[]} */
 const defaultLoggers = [
     {
         type: 'console',
@@ -19,7 +25,7 @@ const levels = {
 /**
  * Create the logger
  * @param {object} config
- * @param {Array=} config.loggers
+ * @param {LoggerType=} config.loggers
  * @param {string?=} config.level
  * @param {object?=} config.meta
  * @returns {winston.Logger}

src/loggers/__tests__/console.unit.test.js

@@ -5,7 +5,10 @@ import makeConsoleLogger from '../console.js';
 
 test('Test the console logger', async (t) => {
     await t.test('It should make the console logger', () => {
-        const logger = makeConsoleLogger({ winston });
+        const logger = makeConsoleLogger({
+            winston,
+            logger: { type: 'console' },
+        });
         assert.strictEqual(logger.name, 'console');
         assert.strictEqual(logger instanceof winston.Transport, true);
         assert.strictEqual(logger.level, 'trace');
@@ -18,4 +21,26 @@ test('Test the console logger', async (t) => {
         assert.strictEqual(logger.filename, undefined);
         assert.strictEqual(logger.options, undefined);
     });
+    await t.test('It should make the json console logger', () => {
+        const logger = makeConsoleLogger({
+            winston,
+            logger: {
+                type: 'console',
+                format: 'json',
+                debug: true,
+                level: 'info',
+            },
+        });
+        assert.strictEqual(logger.name, 'console');
+        assert.strictEqual(logger instanceof winston.Transport, true);
+        assert.strictEqual(logger.level, 'info');
+        assert.strictEqual(logger.handleExceptions, undefined);
+        assert.strictEqual(logger.handleRejections, undefined);
+        assert.strictEqual(logger.silent, undefined);
+        assert.deepEqual(logger.stderrLevels, {});
+        assert.strictEqual(logger.writable, true);
+        assert.deepEqual(logger.consoleWarnLevels, {});
+        assert.strictEqual(logger.filename, undefined);
+        assert.strictEqual(logger.options, undefined);
+    });
 });

src/loggers/console.js

@@ -5,12 +5,15 @@ export default ({ winston, logger }) => {
 
     return new winston.transports.Console({
         level: logger?.level || defaultLevel,
-        format: winston.format.combine(
-            winston.format.errors({ stack: logger?.debug ?? false }),
-            winston.format(
-                stackDriver({ level: logger?.level, defaultLevel })
-            )(),
-            winston.format.json()
-        ),
+        format:
+            logger.format === 'json'
+                ? winston.format.combine(
+                      winston.format.errors({ stack: logger?.debug ?? false }),
+                      winston.format(
+                          stackDriver({ level: logger?.level, defaultLevel })
+                      )(),
+                      winston.format.json()
+                  )
+                : undefined,
     });
 };

src/loggers/index.js

@@ -12,6 +12,18 @@ const winstonLoggers = {
     console: makeConsoleLogger,
 };
 
+/**
+ * @typedef {import('../models/schemas/logger.js').Logger} LoggerType
+ * @typedef {import('winston-transport').TransportStreamOptions} TransportStream
+ */
+
+/**
+ * Create all loggers
+ * @param {object} opts
+ * @param {object} opts.winston
+ * @param {LoggerType[]} opts.loggers
+ * @returns {TransportStream[]}
+ */
 const makeLoggers = ({ winston, loggers }) =>
     Logger.createAll(loggers).map((logger) => {
         const loggerFn = winstonLoggers[logger.type];

src/models/logger.js

@@ -6,9 +6,6 @@ import LoggerMutator from './mutators/logger.js';
  * @typedef {import('./schemas/logger.js').Logger} LoggerType
  */
 
-/**
- * @type {LoggerType}
- */
 const LoggerObject = Obj({ schema: loggerSchema });
 
 export default class Logger {

src/models/schemas/logger.js

@@ -8,16 +8,17 @@ import Level from '../enums/level.js';
  * The logger object
  * @typedef {object} Logger
  * @property {string} type
- * @property {string?} location
- * @property {LevelType?} level
- * @property {string?} key
- * @property {object?} credentials
- * @property {string?} environment
- * @property {string?} serverName
- * @property {string?} release
- * @property {boolean?} debug
- * @property {number?} sampleRate
- * @property {number?} tracesSampleRate
+ * @property {string=} location
+ * @property {LevelType=} level
+ * @property {string=} key
+ * @property {object=} credentials
+ * @property {string=} environment
+ * @property {string=} serverName
+ * @property {string=} release
+ * @property {boolean=} debug
+ * @property {number=} sampleRate
+ * @property {number=} tracesSampleRate
+ * @property {string=} format
  */
 
 export default {
@@ -32,4 +33,5 @@ export default {
     'debug?': Boolean,
     'sampleRate?': Number,
     'tracesSampleRate?': Number,
+    'format?': String,
 };