@emartech/json-logger 5.0.2 → 7.0.0

package/.eslintrc

@@ -0,0 +1,25 @@
+{
+  "env": {
+    "node": true,
+    "mocha": true,
+    "es6": true
+  },
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "ecmaFeatures": {
+      "impliedStrict": true
+    }
+  },
+  "globals": {
+    "expect": true
+  },
+  "rules": {
+    "security/detect-object-injection": 0,
+    "security/detect-non-literal-regexp": 0,
+    "no-unused-expressions": 0,
+    "func-style": 0
+  },
+  "extends": [
+    "emarsys"
+  ]
+}

package/.github/workflows/main.yml

@@ -0,0 +1,33 @@
+name: CI
+
+on:
+  push:
+    branches: [ master, main ]
+
+env:
+  NPM_TOKEN: ${{ secrets.SEMANTIC_RELEASE_NPM_TOKEN }}
+  GH_TOKEN: ${{ secrets.SEMANTIC_RELEASE_GH_TOKEN }}
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Node version
+        id: engines
+        run: echo "##[set-output name=NODE_VERSION;]$(cat .nvmrc)"
+      - name: Use Node.js ${{ steps.engines.outputs.NODE_VERSION }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ steps.engines.outputs.NODE_VERSION }}
+      - name: Install
+        run: npm install
+      - name: Lint
+        run: npm run lint
+      - name: Test
+        run: npm run test
+      - name: Build
+        run: npm run build
+      - name: Release
+        run: npm run semantic-release

package/README.md

@@ -11,10 +11,13 @@ npm install @emartech/json-logger
 
 ### Usage
 
+#### Script
+
 ```javascript
 process.env.DEBUG = 'redis';
-const mongoLogger = require('@emartech/json-logger')('mongo');
-const redisLogger = require('@emartech/json-logger')('redis');
+const { createLogger } = require('@emartech/json-logger');
+const mongoLogger = createLogger('mongo');
+const redisLogger = createLogger('redis');
 
 redisLogger.info('connected', { domain: 'yahoo' });
 // {"name":"redis","action":"connected","level":30,"time":"2016-08-15T08:50:23.566Z","domain":"yahoo"}
@@ -26,6 +29,47 @@ redisLogger.fromError('query', new Error('Unauthorized'), { problem: 'missmatch'
 // {"name":"redis","action":"query","level":50,"time":"2016-08-15T08:50:23.569Z","error_name":"Error","error_stack":"Error: Unauthorized\n    at Object.<anonymous> (/home/blacksonic/workspace/bunyan-debug/example.js:15:32)\n    at Module._compile (module.js:541:32)\n    at Object.Module._extensions..js (module.js:550:10)\n    at Module.load (module.js:458:32)\n    at tryModuleLoad (module.js:417:12)\n    at Function.Module._load (module.js:409:3)\n    at Module.runMain (module.js:575:10)\n    at run (bootstrap_node.js:352:7)\n    at startup (bootstrap_node.js:144:9)\n    at bootstrap_node.js:467:3","error_message":"Unauthorized","problem":"missmatch"}
 ```
 
+#### Class
+
+```javascript
+const { createLogger } = require('@emartech/json-logger');
+const logger = createLogger('Exporter');
+
+class Exporter {
+  export() {
+    mongoLogger.info('export', { customer_id: 123 });
+  }
+}
+```
+
+```typescript
+import { createLogger } from '@emartech/json-logger';
+const logger = createLogger('Exporter');
+
+class Exporter {
+  export() {
+    mongoLogger.info('export', { customer_id: 123 });
+  }
+}
+```
+
+#### Tests
+
+```javascript
+import { Logger } from '@emartech/json-logger';
+
+describe('Exporter', () => {
+  it('should log', () => {
+    jest.spyOn(Logger.prototype, 'info').mockReturnValue();
+    const exporter = new Exporter();
+    
+    exporter.export();
+
+    expect(Logger.prototype.info).toHaveBeenCalledWith('export', { customer_id: 123 });
+  })
+});
+```
+
 More examples can be found in the `examples` directory.
 
 ### API
@@ -39,11 +83,12 @@ Disabled instances output no logs.
 
 ```javascript
 process.env.DEBUG = 'redis,mysql';
+const { createLogger } = require('@emartech/json-logger');
 
-const mongoLogger = require('@emartech/json-logger')('mongo');
+const mongoLogger = createLogger('mongo');
 // mongo instance will be disabled
 
-const redisLogger = require('@emartech/json-logger')('redis');
+const redisLogger = createLogger('redis');
 // redis instance will be enabled
 ```
 
@@ -52,7 +97,8 @@ const redisLogger = require('@emartech/json-logger')('redis');
 Prints the provided data to the console in JSON format.
 
 ```javascript
-const redisLogger = require('@emartech/json-logger')('redis');
+const { createLogger } = require('@emartech/json-logger');
+const redisLogger = createLogger('redis');
 
 redisLogger.info('connected', { domain: 'yahoo' });
 // {"name":"redis","action":"connected","level":30,"time":"2016-08-15T08:50:23.566Z","domain":"yahoo"}
@@ -92,7 +138,8 @@ The displayed line contains the stack trace, the name and the message of the err
 The log level defaults to error.
 
 ```javascript
-const redisLogger = require('@emartech/json-logger')('redis');
+const { createLogger } = require('@emartech/json-logger');
+const redisLogger = createLogger('redis');
 
 redisLogger.fromError('query', new Error('Unauthorized'), { problem: 'missmatch' });
 // {"name":"redis","action":"query","level":50,"time":"2016-08-15T08:50:23.569Z","error_name":"Error","error_stack":"Error: Unauthorized\n    at Object.<anonymous> (/home/blacksonic/workspace/bunyan-debug/example.js:15:32)\n    at Module._compile (module.js:541:32)\n    at Object.Module._extensions..js (module.js:550:10)\n    at Module.load (module.js:458:32)\n    at tryModuleLoad (module.js:417:12)\n    at Function.Module._load (module.js:409:3)\n    at Module.runMain (module.js:575:10)\n    at run (bootstrap_node.js:352:7)\n    at startup (bootstrap_node.js:144:9)\n    at bootstrap_node.js:467:3","error_message":"Unauthorized","problem":"missmatch"}
@@ -109,7 +156,8 @@ but also logs the elapsed time in milliseconds from the creation of the instance
 The elapsed time will be logged into the `duration` field.
 
 ```javascript
-const redisLogger = require('@emartech/json-logger')('redis');
+const { createLogger } = require('@emartech/json-logger');
+const redisLogger = createLogger('redis');
 
 const timer = redisLogger.timer();
 
@@ -127,9 +175,9 @@ With transformers we can alter the data to be logged before passing to the forma
 It is a perfect place to add the name of the machine is running on or the request id associated with the current thread stored on a continuation local storage. 
 
 ```javascript
-const Logger = require('@emartech/json-logger');
+const { createLogger } = require('@emartech/json-logger');
 
-Logger.configure({
+createLogger.configure({
   formatter: JSON.stringify,
   output: console.log,
   transformers: []
@@ -160,11 +208,11 @@ For automating
 
 ```javascript
 const Koa = require('koa');
-const logFactory = require('@emartech/json-logger');
+const { createLogger } = require('@emartech/json-logger');
 const clsAdapter = require('@emartech/cls-adapter');
-const logger = logFactory('redis');
+const logger = createLogger('redis');
 
-logFactory.configure({
+createLogger.configure({
   transformers: [
     clsAdapter.addContextStorageToInput()
   ]

package/dist/config.d.ts

@@ -5,6 +5,5 @@ interface Color {
 export declare const config: {
     levels: Record<string, Color>;
     availableLevels: string[];
-    coloredNames: Record<string, string>;
 };
 export {};

package/dist/config.js

@@ -1,10 +1,6 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.config = void 0;
-const chalk_1 = __importDefault(require("chalk"));
 const levels = {
     trace: {
         number: 10,
@@ -20,20 +16,16 @@ const levels = {
     },
     warn: {
         number: 40,
-        name: chalk_1.default.yellow('WARN')
+        name: 'WARN'
     },
     error: {
         number: 50,
-        name: chalk_1.default.red('ERROR')
+        name: 'ERROR'
     },
     fatal: {
         number: 60,
-        name: chalk_1.default.red('FATAL')
-    },
+        name: 'FATAL'
+    }
 };
 const availableLevels = Object.keys(levels);
-const coloredNames = {};
-availableLevels.forEach((levelName) => {
-    coloredNames[levels[levelName].number] = levels[levelName].name;
-});
-exports.config = { levels, availableLevels, coloredNames };
+exports.config = { levels, availableLevels };

package/dist/formatter/index.d.ts

@@ -1,8 +1,6 @@
 import { jsonFormatter } from './json';
 import { logentriesFormatter } from './logentries';
-import { debugFormatter } from './debug';
 export declare const formatter: {
     json: typeof jsonFormatter;
-    debug: typeof debugFormatter;
     logentries: typeof logentriesFormatter;
 };

package/dist/formatter/index.js

@@ -3,9 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.formatter = void 0;
 const json_1 = require("./json");
 const logentries_1 = require("./logentries");
-const debug_1 = require("./debug");
 exports.formatter = {
     json: json_1.jsonFormatter,
-    debug: debug_1.debugFormatter,
     logentries: logentries_1.logentriesFormatter
 };

package/dist/formatter/logentries.js

@@ -1,4 +1,4 @@
-'use strict';
+"use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.logentriesFormatter = void 0;
 const isNumeric = (value) => !isNaN(parseFloat(value)) && isFinite(value);

package/dist/index.d.ts

@@ -1,16 +1,12 @@
 import { Logger, LoggerConfig } from './logger/logger';
 export { Logger, LoggerConfig } from './logger/logger';
 export { Timer } from './timer/timer';
-export declare function logFactory(namespace: string): Logger;
-export declare namespace logFactory {
-    var Logger: typeof import("./logger/logger").Logger;
-    var Timer: typeof import("./timer/timer").Timer;
+export declare function createLogger(namespace: string): Logger;
+export declare namespace createLogger {
     var getNamespaces: () => string;
     var configure: (options: LoggerConfig) => void;
     var formatter: {
         json: typeof import("./formatter/json").jsonFormatter;
-        debug: typeof import("./formatter/debug").debugFormatter;
         logentries: typeof import("./formatter/logentries").logentriesFormatter;
     };
 }
-export default logFactory;

package/dist/index.js

@@ -1,26 +1,21 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.logFactory = exports.Timer = exports.Logger = void 0;
+exports.createLogger = exports.Timer = exports.Logger = void 0;
 const logger_1 = require("./logger/logger");
 var logger_2 = require("./logger/logger");
 Object.defineProperty(exports, "Logger", { enumerable: true, get: function () { return logger_2.Logger; } });
-const timer_1 = require("./timer/timer");
-var timer_2 = require("./timer/timer");
-Object.defineProperty(exports, "Timer", { enumerable: true, get: function () { return timer_2.Timer; } });
+var timer_1 = require("./timer/timer");
+Object.defineProperty(exports, "Timer", { enumerable: true, get: function () { return timer_1.Timer; } });
 const enabled_1 = require("./enabled/enabled");
 const formatter_1 = require("./formatter");
-function logFactory(namespace) {
-    return new logger_1.Logger(namespace, (0, enabled_1.isNamespaceEnabled)(logFactory.getNamespaces(), namespace));
+function createLogger(namespace) {
+    return new logger_1.Logger(namespace, (0, enabled_1.isNamespaceEnabled)(createLogger.getNamespaces(), namespace));
 }
-exports.logFactory = logFactory;
-logFactory.Logger = logger_1.Logger;
-logFactory.Timer = timer_1.Timer;
-logFactory.getNamespaces = function () {
+exports.createLogger = createLogger;
+createLogger.getNamespaces = function () {
     return process.env.DEBUG || '';
 };
-logFactory.configure = function (options) {
+createLogger.configure = function (options) {
     logger_1.Logger.configure(options);
 };
-logFactory.formatter = formatter_1.formatter;
-exports.default = logFactory;
-module.exports = logFactory;
+createLogger.formatter = formatter_1.formatter;

package/dist/logger/logger.js

@@ -76,18 +76,18 @@ class Logger {
         if (!stack) {
             return;
         }
-        return stack.length > STACK_TRACE_LIMIT
-            ? stack.substring(0, STACK_TRACE_LIMIT) + ' ...'
-            : stack;
+        return stack.length > STACK_TRACE_LIMIT ?
+            stack.substring(0, STACK_TRACE_LIMIT) + ' ...' :
+            stack;
     }
     _shortenData(data) {
         if (typeof data === 'undefined') {
             return;
         }
         const stringifiedData = typeof data === 'object' ? JSON.stringify(data) : data;
-        return stringifiedData.length > DATA_LIMIT
-            ? stringifiedData.substring(0, DATA_LIMIT) + ' ...'
-            : stringifiedData;
+        return stringifiedData.length > DATA_LIMIT ?
+            stringifiedData.substring(0, DATA_LIMIT) + ' ...' :
+            stringifiedData;
     }
     _getErrorDetails(error) {
         if (!(error instanceof Object)) {
@@ -102,8 +102,9 @@ class Logger {
         return Object.assign(baseDetails, this._getAxiosErrorDetails(error));
     }
     _getAxiosErrorDetails(error) {
-        if (!error.isAxiosError)
+        if (!error.isAxiosError) {
             return {};
+        }
         return {
             request_method: error.config.method,
             request_url: error.config.url,

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "@emartech/json-logger",
-  "version": "5.0.2",
+  "version": "7.0.0",
   "description": "Tiny and fast json logger with namespace support",
   "main": "dist/index.js",
   "scripts": {
-    "test": "mocha --require ts-node/register ./src/ --recursive",
-    "test:watch": "mocha --require ts-node/register ./src/ --recursive --watch",
+    "test": "mocha --require ts-node/register ./src --recursive",
+    "test:watch": "mocha --require ts-node/register ./src --recursive --watch",
+    "lint": "eslint ./src/**/*.{ts,js}",
     "build": "rm -rf dist && tsc --project ./tsconfig.json",
     "semantic-release": "CI=true semantic-release",
     "example-js": "DEBUG=* node examples/index-js.js",
@@ -27,13 +28,16 @@
     "debug",
     "json"
   ],
-  "dependencies": {
-    "chalk": "4.1.2"
-  },
+  "dependencies": {},
   "devDependencies": {
     "@emartech/cls-adapter": "1.3.0",
     "@types/node": "18.7.2",
+    "@typescript-eslint/parser": "5.35.1",
     "chai": "4.3.6",
+    "eslint": "7.21.0",
+    "eslint-config-emarsys": "5.1.0",
+    "eslint-plugin-no-only-tests": "2.4.0",
+    "eslint-plugin-security": "1.4.0",
     "express": "4.18.1",
     "koa": "2.13.4",
     "mocha": "10.0.0",

package/dist/formatter/debug.d.ts

@@ -1,6 +0,0 @@
-interface Log {
-    name: string;
-    level: string;
-}
-export declare function debugFormatter(log: Log): string;
-export {};

package/dist/formatter/debug.js

@@ -1,18 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.debugFormatter = void 0;
-const color_name_1 = require("../output/color-name/color-name");
-const stringify_level_1 = require("../output/stringify-level/stringify-level");
-const format_time_1 = require("../output/format-time/format-time");
-const format_body_1 = require("../output/format-body/format-body");
-const formatTime = new format_time_1.FormatTime();
-function debugFormatter(log) {
-    return [
-        color_name_1.ColorName.addColor(log.name),
-        (0, stringify_level_1.stringifyLevel)(log.level),
-        formatTime.elapsedTime(),
-        (0, format_body_1.formatBody)(log)
-    ].join(' ');
-}
-exports.debugFormatter = debugFormatter;
-;

package/dist/output/color-name/color-name.d.ts

@@ -1,11 +0,0 @@
-interface Color {
-    color: number;
-}
-export declare class ColorName {
-    static counter: number;
-    static colors: string[];
-    static names: Record<string, Color>;
-    static addColor(name: string): any;
-    static reset(): void;
-}
-export {};

package/dist/output/color-name/color-name.js

@@ -1,27 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ColorName = void 0;
-const chalk_1 = __importDefault(require("chalk"));
-const colors = ['cyan', 'magenta', 'grey', 'blue', 'green', 'yellow', 'white', 'red'];
-class ColorName {
-    static addColor(name) {
-        if (!this.names[name]) {
-            this.names[name] = { color: this.counter % colors.length };
-            this.counter++;
-        }
-        const color = colors[this.names[name].color];
-        // @ts-ignore
-        return chalk_1.default[color](name);
-    }
-    static reset() {
-        this.counter = 0;
-        this.names = {};
-    }
-}
-exports.ColorName = ColorName;
-ColorName.counter = 0;
-ColorName.colors = colors;
-ColorName.names = {};

package/dist/output/format-body/format-body.d.ts

@@ -1 +0,0 @@
-export declare function formatBody(logBody: any): string;

package/dist/output/format-body/format-body.js

@@ -1,23 +0,0 @@
-'use strict';
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.formatBody = void 0;
-function formatBody(logBody) {
-    const log = Object.assign({}, logBody);
-    delete log.name;
-    delete log.level;
-    delete log.v;
-    delete log.pid;
-    delete log.hostname;
-    delete log.time;
-    if (!log.msg) {
-        delete log.msg;
-    }
-    const keys = Object.keys(log);
-    return keys
-        .sort()
-        .map(function (key) {
-        return key + '=' + JSON.stringify(log[key]);
-    })
-        .join(' ');
-}
-exports.formatBody = formatBody;

package/dist/output/format-time/format-time.d.ts

@@ -1,5 +0,0 @@
-export declare class FormatTime {
-    lastLog: number;
-    elapsedTime(): string;
-    getCurrentTime(): number;
-}

package/dist/output/format-time/format-time.js

@@ -1,21 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.FormatTime = void 0;
-class FormatTime {
-    constructor() {
-        this.lastLog = 0;
-    }
-    elapsedTime() {
-        const current = this.getCurrentTime();
-        let elapsed = 0;
-        if (this.lastLog) {
-            elapsed = current - this.lastLog;
-        }
-        this.lastLog = current;
-        return '+' + elapsed + 'ms';
-    }
-    getCurrentTime() {
-        return new Date().getTime();
-    }
-}
-exports.FormatTime = FormatTime;

package/dist/output/stringify-level/stringify-level.d.ts

@@ -1 +0,0 @@
-export declare function stringifyLevel(level: string): string;

package/dist/output/stringify-level/stringify-level.js

@@ -1,8 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.stringifyLevel = void 0;
-const config_1 = require("../../config");
-function stringifyLevel(level) {
-    return config_1.config.coloredNames[level];
-}
-exports.stringifyLevel = stringifyLevel;