egg 2.29.4 → 2.33.0

package/History.md

@@ -1,5 +1,57 @@
+
+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
+
+### Notable Changes
+
+* **features**
+  * handle ENETUNREACH error on httpclient
+
+### Commits
+
+  * [[`189c47804`](http://github.com/eggjs/egg/commit/189c478048d820b7b1a6ba6e8bce3444604876ff)] - feat: handle ENETUNREACH error on httpclient (#4792) (fengmk2 <<fengmk2@gmail.com>>)
+
+
+## 2021-10-18, Version 2.31.0 @killagu
+
+### Notable Changes
+
+* **typing**
+  * support ssrf typing in config
+
+### Commits
+
+* [[`debfda7ab`](https://github.com/eggjs/egg/commit/debfda7ab38f4893b6f122abfbf3e5288af1441e)] - feat(config): support ssrf field in security config. (#4778) (Jasin Yip <<yejunxing@gmail.com>>)
+
+
+## 2021-08-09, Version 2.30.0 @mansonchor
+
+### Notable Changes
+
+* **features**
+  * support disableDNSCache in one request even though config set to `enableDNSCache: true`
+
+* **docs**
+  * update ts docs, add missing zh-CN doc
+  * typo fix
+
+### Commits
+
+  * [[`13dd55076`](https://github.com/eggjs/egg.git/commit/13dd5507694a57a11e12d1ac6f71ba4a562d88c0)] - feat: support disableDNSCache by request args handle (#4728) (mansonchor.github.com <<mansonchor1987@gmail.com>>)
+  * [[`1b4fde454`](https://github.com/eggjs/egg.git/commit/1b4fde454d2d61200a8b066ba841ad6d81b5b69d)] - unittest: rename and remove some useless tests (#4705) (Maledong <<maledong_public@foxmail.com>>)
+  * [[`156980d36`](https://github.com/eggjs/egg.git/commit/156980d369570531c1ef9cf842f02f513b56fe4a)] - doc: Typo fixture (#4707) (Maledong <<maledong_public@foxmail.com>>)
+  * [[`27aa49b59`](https://github.com/eggjs/egg.git/commit/27aa49b5945f08fa6b636479cf4cba7822e3af2d)] - doc: Typo fixture:「,」->「，」 (#4708) (陈煮酒 <<501205587@qq.com>>)
+  * [[`1f02a8d45`](https://github.com/eggjs/egg.git/commit/1f02a8d4560ca3334425e646c1ac87226aba3a63)] - doc: Add the missing zh-CN trans for typescript (#4703) (Maledong <<52018749+MaledongGit@users.noreply.github.com>>)
+  * [[`f5cf0d965`](https://github.com/eggjs/egg.git/commit/f5cf0d965fa4077da10e87f070e113496077872c)] - doc: "登陆" should be "登录" (#4697) (HOU Ce <<594965698@qq.com>>)
+  * [[`750558400`](https://github.com/eggjs/egg.git/commit/750558400e3bd5f39658dfcbedd4af7bc0bdda2a)] - docs: update ts docs (#4666) (吖猩 <<whxaxes@gmail.com>>)
+  * [[`93d2b04b9`](https://github.com/eggjs/egg.git/commit/93d2b04b985145f27a39335300a78002a61da2a8)] - docs: fix loaderUpdate.md didReady example (#4652) (shadyzoz <<shadyzoz@icloud.com>>)
+
 ## 2021-04-13, Version 2.29.4 @popomore
 
 ### Notable Changes

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;
 
@@ -466,6 +469,10 @@ declare module 'egg' {
       protocolWhiteList: string[];
       defaultMiddleware: string;
       csrf: any;
+      ssrf: {
+        ipBlackList: string[];
+        checkAddress?(ip: string): boolean;
+      };
       xframe: {
         enable: boolean;
         value: 'SAMEORIGIN' | 'DENY' | 'ALLOW-FROM';
@@ -920,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/core/dnscache_httpclient.js

@@ -27,6 +27,11 @@ class DNSCacheHttpClient extends HttpClient {
     // the callback style
     if (callback) {
       this.app.deprecate('[dnscache_httpclient] We now support async for this function, so callback isn\'t recommended.');
+      // disable dns cache in request by args handle
+      if (args && args.enableDNSCache === false) {
+        super.request(url, args, callback);
+        return;
+      }
       this[DNSLOOKUP](url, args)
         .then(result => {
           return super.request(result.url, result.args);
@@ -38,6 +43,10 @@ class DNSCacheHttpClient extends HttpClient {
 
     // the Promise style
     return (async () => {
+      // disable dns cache in request by args handle
+      if (args && args.enableDNSCache === false) {
+        return super.request(url, args);
+      }
       const result = await this[DNSLOOKUP](url, args);
       return super.request(result.url, result.args);
     })();

package/lib/core/httpclient.js

@@ -4,6 +4,13 @@ const Agent = require('agentkeepalive');
 const HttpsAgent = require('agentkeepalive').HttpsAgent;
 const urllib = require('urllib');
 const ms = require('humanize-ms');
+const { FrameworkBaseError } = require('egg-errors');
+
+class HttpClientError extends FrameworkBaseError {
+  get module() {
+    return 'httpclient';
+  }
+}
 
 class HttpClient extends urllib.HttpClient2 {
   constructor(app) {
@@ -42,7 +49,13 @@ class HttpClient extends urllib.HttpClient2 {
     }
 
     // the Promise style
-    return super.request(url, args);
+    return super.request(url, args)
+      .catch(err => {
+        if (err.code === 'ENETUNREACH') {
+          throw HttpClientError.create(err.message, err.code);
+        }
+        throw err;
+      });
   }
 
   curl(url, args, callback) {

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.29.4",
+  "version": "2.33.0",
   "description": "A web framework's framework for Node.js",
   "keywords": [
     "web",
@@ -27,6 +27,7 @@
     "egg-cookies": "^2.3.0",
     "egg-core": "^4.18.0",
     "egg-development": "^2.4.2",
+    "egg-errors": "^2.3.0",
     "egg-i18n": "^2.0.0",
     "egg-jsonp": "^2.0.0",
     "egg-logger": "^2.3.2",
@@ -115,7 +116,7 @@
     "url": "https://github.com/eggjs/egg.git"
   },
   "engines": {
-    "node": ">= 8.0.0"
+    "node": ">= 8.5.0"
   },
   "license": "MIT"
 }