feat(cls): remove cls with middlewares from logger, move it to @emartech/cls-adapter

BREAKING CHANGE: middlewares and automatic cls storage removed

Author: sonicoder86

README.md

@@ -33,19 +33,26 @@ Examples can be found in ```examples/index.js```.
 
 ### Logging request identifier automatically
 
-The library provides middlewares for both Koa and Express applications.
-These middlewares add the request identifiers coming from the header X-Request-Id to every log 
-(in the log: `request_id`).
+The continuation local storage handling has moved to the `@emartech/cls-adapter` package.
+You need to use the middlewares of `@emartech/cls-adapter` and add its transformer to the loggers configure method.
+This way it will log the request identifier coming from the header field (`X-Request-Id`).
+
+For automatting 
 
 ```javascript
 const Koa = require('koa');
 const logFactory = require('@emartech/json-logger');
+const clsAdapter = require('@emartech/cls-adapter');
 
-app.use(logFactory.getMiddleware());
-```
+logFactory.configure({
+  transformers: [
+    clsAdapter.addContextStorageToInput()
+  ]
+});
 
-The method `getMiddleware` creates a Koa middleware (alias for `getKoaMiddleware`).
-The `getExpressMiddleware` method does the same, but returns an Express middleware.
+const app = new Koa();
+app.use(clsAdapter.getKoaMiddleware());
+```
 
 ## Development
 

examples/express.js

@@ -2,17 +2,23 @@
 
 const express = require('express');
 const logFactory = require('../index');
+const clsAdapter = require('@emartech/cls-adapter');
 const logger = logFactory('example');
 const port = 3000;
 
+logFactory.configure({
+  transformers: [
+    clsAdapter.addContextStorageToInput()
+  ]
+});
 const app = express();
 
-app.use(logFactory.getExpressMiddleware());
+app.use(clsAdapter.getExpressMiddleware());
 
 app.get('/', (req, res) => {
   logger.info('before');
 
-  logFactory.setOnContext('customer_id', Math.round(Math.random() * 1000));
+  clsAdapter.setOnContext('customer_id', Math.round(Math.random() * 1000));
 
   logger.info('after');
   res.send('It works')

examples/koa.js

@@ -2,17 +2,23 @@
 
 const Koa = require('koa');
 const logFactory = require('../index');
+const clsAdapter = require('@emartech/cls-adapter');
 const logger = logFactory('example');
 const port = 3000;
 
+logFactory.configure({
+  transformers: [
+    clsAdapter.addContextStorageToInput()
+  ]
+});
 const app = new Koa();
 
-app.use(logFactory.getMiddleware());
+app.use(clsAdapter.getKoaMiddleware());
 
 app.use(async (ctx) => {
   logger.info('before');
 
-  logFactory.setOnContext('customer_id', Math.round(Math.random() * 1000));
+  clsAdapter.setOnContext('customer_id', Math.round(Math.random() * 1000));
 
   logger.info('after');
   ctx.body = 'It works';

index.js

@@ -2,7 +2,6 @@
 
 const Logger = require('./src/logger/logger');
 const isNamespaceEnabled = require('./src/enabled/enabled');
-const contextMiddlewareFactory = require('./src/context-middleware-factory/context-middleware-factory');
 const formatter = require('./src/formatter');
 
 /**
@@ -20,10 +19,6 @@ logFactory.Logger = Logger;
 logFactory.getNamespaces = function() {
   return process.env.DEBUG || '';
 };
-logFactory.getKoaMiddleware = contextMiddlewareFactory.getKoaMiddleware.bind(contextMiddlewareFactory);
-logFactory.getExpressMiddleware = contextMiddlewareFactory.getExpressMiddleware.bind(contextMiddlewareFactory);
-logFactory.getMiddleware = logFactory.getKoaMiddleware;
-logFactory.setOnContext = contextMiddlewareFactory.setOnContext.bind(contextMiddlewareFactory);
 logFactory.configure = function(options) {
   Logger.configure(options);
 };

package-lock.json

@@ -18,7 +18,6 @@
     }
   },
   "release": {
-    "analyzeCommits": "@bubltechnology/customizable-commit-analyzer",
     "verifyConditions": {
       "path": "./node_modules/semantic-release/src/lib/plugin-noop.js"
     }
@@ -35,12 +34,10 @@
     "json"
   ],
   "dependencies": {
-    "chalk": "2.3.0",
-    "cls-hooked": "4.2.2",
-    "uuid": "3.1.0"
+    "chalk": "2.3.0"
   },
   "devDependencies": {
-    "@bubltechnology/customizable-commit-analyzer": "1.0.2-0",
+    "@emartech/cls-adapter": "1.1.0",
     "chai": "4.1.2",
     "express": "4.16.2",
     "koa": "2.3.0",

package.json

@@ -1,24 +1,13 @@
 'use strict';
 
 const config = require('../config');
-const continuationLocalStorage = require('cls-hooked');
 const STACK_TRACE_LIMIT = 3000;
 const DATA_LIMIT = 3000;
 const Timer = require('../timer/timer');
 const jsonFormatter = require('../formatter/json');
 const consoleOutput = require('../output/console');
 const allowedKeys = ['output', 'formatter', 'transformers'];
 
-const getContextStorage = function() {
-  const contextNamespace = continuationLocalStorage.getNamespace('session');
-  if (contextNamespace && contextNamespace.active) {
-    const { id, _ns_name, ...contextData } = contextNamespace.active;
-    return contextData;
-  }
-
-  return {};
-};
-
 class Logger {
   constructor(namespace, enabled) {
     this._namespace = namespace;
@@ -101,7 +90,6 @@ const logMethodFactory = function(level) {
         level: config.levels[level].number,
         time: new Date().toISOString()
       },
-      getContextStorage(),
       data
     );
 

src/context-middleware-factory/context-middleware-factory.js

@@ -1,7 +1,6 @@
 'use strict';
 
 const Logger = require('./logger');
-const continuationLocalStorage = require('cls-hooked');
 const jsonFormatter = require('../formatter/json');
 const consoleOutput = require('../output/console');
 
@@ -31,18 +30,6 @@ describe('Logger', function() {
     expect(logArguments.details).to.eql('forever');
   });
 
-  it('should log prequest id if there is namespace present', function() {
-    const namespace = continuationLocalStorage
-      .createNamespace('session');
-
-    namespace.run(function(){
-      namespace.set('request_id', 'uid');
-      logger.info('wedidit');
-      const logArguments = JSON.parse(console.log.args[0]);
-      expect(logArguments.request_id).to.eql('uid');
-    });
-  });
-
   it('should not call log info method when disabled', function() {
     logger = new Logger('mongo', false);