feat: enable request started log on meta middleware (eggjs#1877)

app/middleware/meta.js

@@ -4,8 +4,11 @@
 
 'use strict';
 
-module.exports = () => {
+module.exports = options => {
   return async function meta(ctx, next) {
+    if (options.logging) {
+      ctx.coreLogger.info('[meta] request started, host: %s, user-agent: %s', ctx.host, ctx.header['user-agent']);
+    }
     await next();
     // total response time header
     ctx.set('x-readtime', Date.now() - ctx.starttime);

config/config.default.js

@@ -268,6 +268,18 @@ module.exports = appInfo => {
     },
   };
 
+  /**
+   * The option of `meta` middleware
+   *
+   * @member Config#meta
+   * @property {Boolean} enable - enable meta or not, default is true
+   * @property {Boolean} logging - enable logging start request, default is false
+   */
+  config.meta = {
+    enable: true,
+    logging: false,
+  };
+
   /**
    * core enable middlewares
    * @member {Array} Config#middleware

test/app/middleware/meta.test.js

@@ -1,23 +1,45 @@
 'use strict';
 
+const assert = require('assert');
 const mm = require('egg-mock');
+const fs = require('mz/fs');
 const utils = require('../../utils');
 
 describe('test/app/middleware/meta.test.js', () => {
-  let app;
-  before(() => {
-    app = utils.app('apps/middlewares');
-    return app.ready();
-  });
+  afterEach(mm.restore);
 
-  after(() => app.close());
+  describe('default config', () => {
+    let app;
+    before(() => {
+      app = utils.app('apps/middlewares');
+      return app.ready();
+    });
+    after(() => app.close());
 
-  afterEach(mm.restore);
+    it('should get X-Readtime header', () => {
+      return app.httpRequest()
+        .get('/')
+        .expect('X-Readtime', /\d+/)
+        .expect(200);
+    });
+  });
+
+  describe('meta.logging = true', () => {
+    let app;
+    before(() => {
+      app = utils.app('apps/meta-logging-app');
+      return app.ready();
+    });
+    after(() => app.close());
 
-  it('should get X-Readtime header', () => {
-    return app.httpRequest()
-      .get('/')
-      .expect('X-Readtime', /\d+/)
-      .expect(200);
+    it('should get X-Readtime header', async () => {
+      await app.httpRequest()
+        .get('/?foo=bar')
+        .expect('X-Readtime', /\d+/)
+        .expect('hello world')
+        .expect(200);
+      const content = (await fs.readFile(app.coreLogger.options.file, 'utf8')).split('\n').slice(-2, -1)[0];
+      assert(content.includes('[meta] request started, host: '));
+    });
   });
 });

test/fixtures/apps/meta-logging-app/app.js

@@ -0,0 +1,9 @@
+'use strict';
+
+module.exports = app => {
+  app.ready(() => {
+    app.config.tips = 'hello egg started';
+    // dynamic router
+    app.all('/all', app.controller.home);
+  });
+};

test/fixtures/apps/meta-logging-app/app/controller/home.js

@@ -0,0 +1,5 @@
+'use strict';
+
+module.exports = async ctx => {
+  ctx.body = 'hello world';
+};

test/fixtures/apps/meta-logging-app/app/router.js

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

test/fixtures/apps/meta-logging-app/config/config.default.js

@@ -0,0 +1,5 @@
+exports.keys = 'foo';
+
+exports.meta = {
+  logging: true,
+};

test/fixtures/apps/meta-logging-app/package.json

@@ -0,0 +1,3 @@
+{
+  "name": "meta-logging-app"
+}