📦 NEW: Upgrade egg-logger v3 to enable localStorage (#5085)

eggjs/egg-logger#81

app/extend/context.js

@@ -95,6 +95,9 @@ const proto = module.exports = {
    * @return {Logger} logger
    */
   getLogger(name) {
+    if (this.app.config.logger.enableFastContextLogger) {
+      return this.app.getLogger(name);
+    }
     let cache = this[CONTEXT_LOGGERS];
     if (!cache) {
       cache = this[CONTEXT_LOGGERS] = {};

config/config.default.js

@@ -258,6 +258,7 @@ module.exports = appInfo => {
    * @property {Object} coreLogger - custom config of coreLogger
    * @property {Boolean} allowDebugAtProd - allow debug log at prod, defaults to false
    * @property {Boolean} enablePerformanceTimer - using performance.now() timer instead of Date.now() for more more precise milliseconds, defaults to false. e.g.: logger will set 1.456ms instead of 1ms.
+   * @property {Boolean} enableFastContextLogger - using the app logger instead of EggContextLogger, defaults to false
    */
   config.logger = {
     dir: path.join(appInfo.root, 'logs', appInfo.name),
@@ -275,6 +276,7 @@ module.exports = appInfo => {
     coreLogger: {},
     allowDebugAtProd: false,
     enablePerformanceTimer: false,
+    enableFastContextLogger: false,
   };
 
   /**

index.d.ts

@@ -231,6 +231,8 @@ declare module 'egg' {
     disableConsoleAfterReady?: boolean;
     /** using performance.now() timer instead of Date.now() for more more precise milliseconds, defaults to `false`. e.g.: logger will set 1.456ms instead of 1ms. */
     enablePerformanceTimer?: boolean;
+    /** using the app logger instead of EggContextLogger, defaults to `false` */
+    enableFastContextLogger?: boolean;
   }
 
   /** Custom Loader Configuration */
@@ -343,6 +345,7 @@ declare module 'egg' {
      * @property {Object} coreLogger - custom config of coreLogger
      * @property {Boolean} allowDebugAtProd - allow debug log at prod, defaults to false
      * @property {Boolean} enablePerformanceTimer - using performance.now() timer instead of Date.now() for more more precise milliseconds, defaults to false. e.g.: logger will set 1.456ms instead of 1ms.
+     * @property {Boolean} enableFastContextLogger - using the app logger instead of EggContextLogger, defaults to false
      */
     logger: EggLoggerConfig;
 

lib/core/logger.js

@@ -5,6 +5,7 @@ const Loggers = require('egg-logger').EggLoggers;
 module.exports = function createLoggers(app) {
   const loggerConfig = app.config.logger;
   loggerConfig.type = app.type;
+  loggerConfig.localStorage = app.ctxStorage;
 
   if (app.config.env === 'prod' && loggerConfig.level === 'DEBUG' && !loggerConfig.allowDebugAtProd) {
     loggerConfig.level = 'INFO';

package.json

@@ -33,7 +33,7 @@
     "egg-errors": "^2.3.1",
     "egg-i18n": "^2.1.1",
     "egg-jsonp": "^2.0.0",
-    "egg-logger": "^2.9.0",
+    "egg-logger": "^3.0.1",
     "egg-logrotator": "^3.1.0",
     "egg-multipart": "^3.1.0",
     "egg-onerror": "^2.1.1",

test/fixtures/apps/app-enableFastContextLogger/app/controller/home.js

@@ -0,0 +1,6 @@
+exports.index = async ctx => {
+  ctx.logger.info('enableFastContextLogger: %s', ctx.app.config.logger.enableFastContextLogger);
+  ctx.body = {
+    enableFastContextLogger: ctx.app.config.logger.enableFastContextLogger,
+  };
+};

test/fixtures/apps/app-enableFastContextLogger/app/router.js

@@ -0,0 +1,3 @@
+module.exports = app => {
+  app.get('/', 'home.index');
+};

test/fixtures/apps/app-enableFastContextLogger/config/config.default.js

@@ -0,0 +1,5 @@
+exports.keys = 'tracer-demo keys';
+
+exports.logger = {
+  enableFastContextLogger: true,
+};

test/fixtures/apps/app-enableFastContextLogger/package.json

@@ -0,0 +1,3 @@
+{
+  "name": "demo_app"
+}

test/fixtures/apps/tracer-demo/app/controller/foo.js

@@ -0,0 +1,14 @@
+module.exports = app => {
+  return {
+    async index(ctx) {
+      const r = await app.curl(ctx.query.url, {
+        dataType: 'json',
+      });
+      app.logger.info('app logger support traceId');
+      ctx.body = {
+        url: ctx.query.url,
+        data: r.data,
+      };
+    },
+  };
+};

test/fixtures/apps/tracer-demo/app/router.js

@@ -2,4 +2,5 @@
 
 module.exports = app => {
   app.get('/', 'home.index');
+  app.get('/foo', 'foo.index');
 };

test/lib/core/httpclient_tracer_demo.test.js

@@ -35,4 +35,24 @@ describe('test/lib/core/httpclient_tracer_demo.test.js', () => {
       })
       .expect(200);
   });
+
+  it('should app logger support localStorage by default', async () => {
+    const traceId = 'mock-traceId-123123';
+    app.mockContext({
+      tracer: {
+        traceId,
+      },
+    });
+    await app.httpRequest()
+      .get('/foo?url=' + encodeURIComponent(url + '/get_headers'))
+      .expect(res => {
+        assert(res.body.url === url + '/get_headers');
+        assert(res.body.data['x-request-id']);
+        assert(res.body.data['x-request-id'].startsWith('anonymous-'));
+      })
+      .expect(200);
+    // wait for windows log store
+    if (process.platform === 'win32') await utils.sleep(2000);
+    app.expectLog(/ INFO \d+ \[-\/127.0.0.1\/mock-traceId-123123\/\d+ms GET \/foo\?url=http%3A%2F%2F127.0.0.1%3A\d+%2Fget_headers] app logger support traceId/);
+  });
 });

test/lib/core/logger.test.js

@@ -218,6 +218,23 @@ describe('test/lib/core/logger.test.js', () => {
     assert(app.agent.logger.options.file === app.agent.coreLogger.options.file);
   });
 
+  it('should config.logger.enableFastContextLogger = true work', async () => {
+    app = utils.app('apps/app-enableFastContextLogger');
+    await app.ready();
+    app.mockContext({
+      tracer: {
+        traceId: 'mock-trace-id-123',
+      },
+    });
+    await app.httpRequest()
+      .get('/')
+      .expect(200)
+      .expect({
+        enableFastContextLogger: true,
+      });
+    app.expectLog(/ INFO \d+ \[-\/127\.0\.0\.1\/mock-trace-id-123\/\d+ms GET \/] enableFastContextLogger: true/);
+  });
+
   describe('logger.level = DEBUG', () => {
     let app;
     before(() => {