egg 2.32.0 → 2.33.0

package/History.md

@@ -1,3 +1,9 @@
+
+2.33.0 / 2021-12-06
+==================
+
+**features**
+  * [[`0f6589e1d`](http://github.com/eggjs/egg/commit/0f6589e1dc9e538434eb1580327556d5aa264822)] - feat: support better logger timer in precise milliseconds (#4806) (fengmk2 <<fengmk2@gmail.com>>)
 # History
 
 ## 2021-11-15, Version 2.32.0 @atian25

package/app/extend/context.js

@@ -1,5 +1,6 @@
 'use strict';
 
+const { performance } = require('perf_hooks');
 const delegate = require('delegates');
 const { assign } = require('utility');
 const eggUtils = require('egg-core').utils;
@@ -219,7 +220,7 @@ const proto = module.exports = {
   // e.g.: https://github.com/eggjs/egg-mock/pull/78
   _runInBackground(scope) {
     const ctx = this;
-    const start = Date.now();
+    const start = performance.now();
     /* istanbul ignore next */
     const taskName = scope._name || scope.name || eggUtils.getCalleeFromStack(true);
     // use setImmediate to ensure all sync logic will run async
@@ -227,11 +228,13 @@ const proto = module.exports = {
       // use app.toAsyncFunction to support both generator function and async function
       .then(() => ctx.app.toAsyncFunction(scope)(ctx))
       .then(() => {
-        ctx.coreLogger.info('[egg:background] task:%s success (%dms)', taskName, Date.now() - start);
+        ctx.coreLogger.info('[egg:background] task:%s success (%dms)',
+          taskName, Math.floor((performance.now() - start) * 1000) / 1000);
       })
       .catch(err => {
         // background task process log
-        ctx.coreLogger.info('[egg:background] task:%s fail (%dms)', taskName, Date.now() - start);
+        ctx.coreLogger.info('[egg:background] task:%s fail (%dms)',
+          taskName, Math.floor((performance.now() - start) * 1000) / 1000);
 
         // emit error when promise catch, and set err.runInBackground flag
         err.runInBackground = true;

package/config/config.default.js

@@ -249,6 +249,8 @@ module.exports = appInfo => {
    * @property {String} coreLogName - file name of coreLogger
    * @property {String} agentLogName - file name of agent worker log
    * @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.
    */
   config.logger = {
     dir: path.join(appInfo.root, 'logs', appInfo.name),
@@ -265,6 +267,7 @@ module.exports = appInfo => {
     errorLogName: 'common-error.log',
     coreLogger: {},
     allowDebugAtProd: false,
+    enablePerformanceTimer: false,
   };
 
   /**

package/index.d.ts

@@ -217,10 +217,12 @@ declare module 'egg' {
   export interface EggLoggerConfig extends RemoveSpecProp<EggLoggersOptions, 'type'> {
     /** custom config of coreLogger */
     coreLogger?: Partial<EggLoggerOptions>;
-    /** allow debug log at prod, defaults to true */
+    /** allow debug log at prod, defaults to `false` */
     allowDebugAtProd?: boolean;
     /** disable logger console after app ready. defaults to `false` on local and unittest env, others is `true`. */
     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;
   }
 
   /** Custom Loader Configuration */
@@ -329,7 +331,8 @@ declare module 'egg' {
      * @property {String} coreLogName - file name of coreLogger
      * @property {String} agentLogName - file name of agent worker log
      * @property {Object} coreLogger - custom config of coreLogger
-     * @property {Boolean} allowDebugAtProd - allow debug log at prod, defaults to true
+     * @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.
      */
     logger: EggLoggerConfig;
 
@@ -924,6 +927,11 @@ declare module 'egg' {
      */
     starttime: number;
 
+    /**
+     * Request start timer using `performance.now()`
+     */
+    performanceStarttime?: number;
+
     /**
      * http request helper base on httpclient, it will auto save httpclient log.
      * Keep the same api with httpclient.request(url, args).

package/lib/egg.js

@@ -1,5 +1,6 @@
 'use strict';
 
+const { performance } = require('perf_hooks');
 const path = require('path');
 const fs = require('fs');
 const ms = require('ms');
@@ -547,6 +548,14 @@ class EggApplication extends EggCore {
      * @member {Number} Context#starttime
      */
     context.starttime = Date.now();
+
+    if (this.config.logger.enablePerformanceTimer) {
+      /**
+       * Request start timer using `performance.now()`
+       * @member {Number} Context#performanceStarttime
+       */
+      context.performanceStarttime = performance.now();
+    }
     return context;
   }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "egg",
-  "version": "2.32.0",
+  "version": "2.33.0",
   "description": "A web framework's framework for Node.js",
   "keywords": [
     "web",
@@ -116,7 +116,7 @@
     "url": "https://github.com/eggjs/egg.git"
   },
   "engines": {
-    "node": ">= 8.0.0"
+    "node": ">= 8.5.0"
   },
   "license": "MIT"
 }