feat: add legacy timing (#249)

- beforeStart with name
- readyCallback timing

Author: killagu

lib/egg.js

@@ -212,9 +212,10 @@ class EggCore extends KoaApplication {
    * @see https://eggjs.org/en/advanced/loader.html#beforestart
    *
    * @param  {Function|GeneratorFunction|AsyncFunction} scope function will execute before app start
+   * @param {string} [name] scope name, default is empty string
    */
-  beforeStart(scope) {
-    this.lifecycle.registerBeforeStart(scope);
+  beforeStart(scope, name) {
+    this.lifecycle.registerBeforeStart(scope, name || '');
   }
 
   /**

lib/lifecycle.js

@@ -71,7 +71,23 @@ class Lifecycle extends EventEmitter {
   }
 
   legacyReadyCallback(name, opt) {
-    return this.loadReady.readyCallback(name, opt);
+    const timingKeyPrefix = 'Did Load';
+    if (!opt) {
+      const timing = this.timing;
+      const cb = this.loadReady.readyCallback(name);
+      const timingkey = `${timingKeyPrefix} in ` + utils.getResolvedFilename(name, this.app.baseDir);
+      this.timing.start(timingkey);
+      return function legacyReadyCallback(...args) {
+        timing.end(timingkey);
+        cb(...args);
+      };
+    }
+    this[REGISTER_READY_CALLBACK]({
+      scope: opt,
+      ready: this.loadReady,
+      timingKeyPrefix,
+      scopeFullName: name,
+    });
   }
 
   addBootHook(hook) {
@@ -102,11 +118,12 @@ class Lifecycle extends EventEmitter {
     this[BOOTS] = this[BOOT_HOOKS].map(t => new t(this.app));
   }
 
-  registerBeforeStart(scope) {
+  registerBeforeStart(scope, name) {
     this[REGISTER_READY_CALLBACK]({
       scope,
       ready: this.loadReady,
       timingKeyPrefix: 'Before Start',
+      scopeFullName: name,
     });
   }
 

test/egg.test.js

@@ -480,7 +480,7 @@ describe('test/egg.test.js', () => {
         yield app.ready();
 
         const json = app.timing.toJSON();
-        assert(json.length === 25);
+        assert(json.length === 28);
 
         assert(json[1].name === 'Application Start');
         assert(json[1].end - json[1].start === json[1].duration);
@@ -502,25 +502,29 @@ describe('test/egg.test.js', () => {
         assert(json[11].name === 'Load app.js');
         assert(json[12].name === 'Require(6) app.js');
         assert(json[13].name === 'Before Start in app.js:6:9');
-        assert(json[14].name === 'Load "proxy" to Context');
-        assert(json[15].name === 'Load Controller');
-        assert(json[16].name === 'Load "controller" to Application');
+        assert(json[14].name === 'Before Start in mock Block');
+        assert(json[15].name === 'Did Load in mockReadyCallbackWithFunction');
+        assert(json[16].name === 'Did Load in mockReadyCallbackWithoutFunction');
+
+        assert(json[17].name === 'Load "proxy" to Context');
+        assert(json[18].name === 'Load Controller');
+        assert(json[19].name === 'Load "controller" to Application');
 
         // loadService
-        assert(json[17].name === 'Load Service');
-        assert(json[18].name === 'Load "service" to Context');
+        assert(json[20].name === 'Load Service');
+        assert(json[21].name === 'Load "service" to Context');
 
         // loadMiddleware
-        assert(json[19].name === 'Load Middleware');
-        assert(json[20].name === 'Load "middlewares" to Application');
+        assert(json[22].name === 'Load Middleware');
+        assert(json[23].name === 'Load "middlewares" to Application');
 
         // loadController
-        assert(json[21].name === 'Load Controller');
-        assert(json[22].name === 'Load "controller" to Application');
+        assert(json[24].name === 'Load Controller');
+        assert(json[25].name === 'Load "controller" to Application');
 
         // loadRouter
-        assert(json[23].name === 'Load Router');
-        assert(json[24].name === 'Require(7) app/router.js');
+        assert(json[26].name === 'Load Router');
+        assert(json[27].name === 'Require(7) app/router.js');
       });
     });
 

test/fixtures/timing/app.js

@@ -8,7 +8,17 @@ module.exports = app => {
 
   app.beforeStart(function* () {
     block();
-  })
+  });
+
+  app.beforeStart(function* () {
+    block();
+  }, 'mock Block');
+
+  app.readyCallback('mockReadyCallbackWithFunction', function() {
+  });
+
+  const cb = app.readyCallback('mockReadyCallbackWithoutFunction');
+  setTimeout(cb, 1000);
 
   const directory = path.join(app.baseDir, 'app/proxy');
   app.loader.loadToContext(directory, 'proxy');