♻️ Unify logger name placement

Author: Michal Vlasák

src/index.ts

@@ -25,6 +25,9 @@ export interface AckeeLoggerFactory extends AckeeLogger {
     (data?: string | AckeeLoggerOptions): AckeeLogger;
 }
 
+export const loggerNameKey = 'cosmas.loggerName';
+export const pkgVersionKey = 'cosmas.pkgVersion';
+
 const makeCallable = <T extends object, F extends (...args: any[]) => any>(obj: T, fun: F): T & F =>
     new Proxy(fun as any, {
         get: (_target, key) => (obj as any)[key],
@@ -67,7 +70,7 @@ const defaultLogger = (options: AckeeLoggerOptions & { loggerName?: string } = {
 
     const isTesting = process.env.NODE_ENV === 'test';
     const defaultLevel: Level = options.defaultLevel || (isTesting ? 'silent' : 'debug');
-    const messageKey = options.pretty ? 'msg' : 'message'; // "message" is the best option for Google Stackdriver,
+    const messageKey = 'message'; // best option for Google Stackdriver,
     const streams = initLoggerStreams(defaultLevel, Object.assign({}, options, { messageKey }));
 
     options.ignoredHttpMethods = options.ignoredHttpMethods || ['OPTIONS'];

src/streams.ts

@@ -3,12 +3,11 @@ import * as path from 'path';
 import * as pino from 'pino';
 import { Transform, TransformCallback } from 'stream';
 import * as util from 'util';
+import { loggerNameKey, pkgVersionKey } from '.';
 import { AckeeLoggerOptions, AckeeLoggerStream } from './interfaces';
 import { levels } from './levels';
 import { StackDriverFormatStream } from './stackdriver';
 
-const isString = (x: any) => typeof x === 'string' || x instanceof String;
-
 const pkgJson = JSON.parse(fs.readFileSync(path.resolve(path.join(__dirname, '..', 'package.json')), 'utf8'));
 
 const getDefaultTransformStream = (options: AckeeLoggerOptions & { messageKey: string; loggerName?: string }) => {
@@ -18,18 +17,20 @@ const getDefaultTransformStream = (options: AckeeLoggerOptions & { messageKey: s
             const obj = JSON.parse(chunk);
             const loggerName = options.loggerName;
             let res;
+            if (loggerName) {
+                // always put logger name to message
+                obj[options.messageKey] = `[${loggerName}] ${obj[options.messageKey]}`;
+            }
+            if (loggerName && !options.pretty) {
+                // do not put logger name field to pretty outputs
+                obj[loggerNameKey] = loggerName;
+            }
+
             if (options.pretty) {
-                // obj['name\0'] = obj.name; // add null character so that it is not interpreted by pino-pretty but still visible to user unchanged
-                delete obj.name;
-                if (loggerName) {
-                    obj.name = loggerName;
-                }
                 res = util.inspect(obj, { colors: true, showHidden: true, depth: 10 });
             } else {
-                obj.pkgVersion = pkgJson.version;
-                if (obj[options.messageKey] && isString(obj[options.messageKey]) && loggerName) {
-                    obj[options.messageKey] = `[${loggerName}] ${obj[options.messageKey]}`;
-                }
+                // do not put pkgVersion to pretty outputs
+                obj[pkgVersionKey] = pkgJson.version;
                 res = JSON.stringify(obj);
             }
 

src/tests/index.test.ts

@@ -1,7 +1,7 @@
 import 'jest-extended';
 import isString = require('lodash.isstring');
 import { Writable } from 'stream';
-import loggerFactory from '..';
+import loggerFactory, { pkgVersionKey, loggerNameKey } from '..';
 import { levels } from '../levels';
 
 test('can create default logger', () => {
@@ -15,7 +15,7 @@ test('can create named logger', () => {
     expect((logger.options as any).loggerName).toBe('myApp');
 });
 
-test.skip('can create logger with options', () => { // TODO: will work after pretty mechanics update - broken bc of deps update
+test('can create logger with options', () => {
     const logger = loggerFactory({ pretty: true });
     expect(logger).toBeDefined();
     expect(logger.options.pretty).toBe(true);
@@ -92,7 +92,7 @@ test('automatic severity field can be disabled by options', () =>
 test('logger version is logged', () =>
     new Promise((resolve, reject) => {
         const logger = loggerFactory({
-            streams: [testWriteStream(resolve, json => expect(json.pkgVersion).not.toBe(undefined))],
+            streams: [testWriteStream(resolve, json => expect(json[pkgVersionKey]).not.toBe(undefined))],
         });
 
         logger.fatal('Hello');
@@ -120,8 +120,8 @@ test('silent stream does not write', () => {
 
 const exampleMessages = [
     { type: 'simple', logData: 'Hello' },
-    { type: 'message-key', logData: { message: 'You gotta do, what you gotta do' } },
-    { type: 'msg-key', logData: { message: 'Mirror, mirror, on the wall' } },
+    { type: 'message-key', logData: { message: 'You gotta do, what you gotta do', name: 'Futurama' } },
+    { type: 'msg-key', logData: { msg: 'Mirror, mirror, on the wall', name: 'Sleeping Beauty' } },
 ];
 
 exampleMessages.forEach(data => {
@@ -133,6 +133,10 @@ exampleMessages.forEach(data => {
                 streams: [
                     testWriteStream(resolve, json => {
                         expect(json.message).toStartWith(`[${loggerName}] `);
+                        expect(json[loggerNameKey]).toBe(loggerName);
+                        if ((data.logData as any).name) {
+                            expect(json.name).toBe((data.logData as any).name);
+                        }
                     }),
                 ],
             });
@@ -157,6 +161,9 @@ exampleMessages.forEach(data => {
                         resolve,
                         message => {
                             expect(message).toContain(loggerName);
+                            if ((data.logData as any).name) {
+                                expect(message).toContain((data.logData as any).name);
+                            }
                         },
                         false
                     ),