egg 2.29.3 → 2.32.0

package/History.md

@@ -1,5 +1,69 @@
 # 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
+
+* **fixes**
+  * remove internal interval handler when close agent
+* **docs**
+  * Added english doc to how-to-migrate-from-1.x, Thx @ZixiaoWang
+  * typo improvement
+
+### Commits
+
+  * [[`ce234226b`](http://github.com/eggjs/egg/commit/ce234226bf0c43f03aedf727a7d195ae4175c01f)] - fix: remove internal interval handler when close agent (#4654) (Harry Chen <<czy88840616@gmail.com>>)
+  * [[`6a6d68fb2`](http://github.com/eggjs/egg/commit/6a6d68fb228a3eae9b5cab3ba7afe0892d5e08ea)] - Typo fixture：制定 -> 指定 (#4639) (华晨 <<chanjsq@gmail.com>>)
+  * [[`603c74b58`](http://github.com/eggjs/egg/commit/603c74b581d6b3a9ad80170335425b0876ffcb1f)] - docs: Added english doc to how-to-migrate-from-1.x (#4630) (Jacky Wang <<www.wangzixiao@126.com>>)
+  * [[`693df6066`](http://github.com/eggjs/egg/commit/693df60661735008e8a758258fc2df0bb9783f04)] - docs: fix schedule reference (#4556) (xuxu <<must414@163.com>>)
+  * [[`4ebbe8143`](http://github.com/eggjs/egg/commit/4ebbe814386102377870959129e831a3b20133c1)] - docs: fix typo (#4596) (suinia <<suini_a@163.com>>)
+
 ## 2021-02-19, Version 2.29.3 @killa
 
 ### Notable Changes
@@ -8,7 +72,7 @@
   * fix ctx body typing
 
 ### Commits
-  * [[`e9fba1b7b`](http://github.com/eggjs/egg/commit/e9fba1b7bbe3f54b023262aeb5487b31047e119e)] - fix: fix ctx body as any (#4613) (killa <<killa123@126.com>>) 
+  * [[`e9fba1b7b`](http://github.com/eggjs/egg/commit/e9fba1b7bbe3f54b023262aeb5487b31047e119e)] - fix: fix ctx body as any (#4613) (killa <<killa123@126.com>>)
 
 ## 2021-02-18, Version 2.29.2 @killa
 
@@ -17,14 +81,14 @@
 * **fixes**
   * fix query typing
   * add overrideIgnore define
-  
+
 ### Commits
 
   * [[`99682e4bd`](http://github.com/eggjs/egg/commit/99682e4bd5afe1697cab02001e919b967c264869)] - fix: fix query typing (#4611) (killa <<killa123@126.com>>)
   * [[`26017ee2e`](http://github.com/eggjs/egg/commit/26017ee2e49bd8a42b660baabe31284e00f81bcb)] - chore: fix comment typo at request.js (#4513) (Albert 理斯特 <<shuaizhexu@gmail.com>>)
   * [[`34048c275`](http://github.com/eggjs/egg/commit/34048c275afe1126716ef4265b667169e9866e53)] - fix: add overrideIgnore define (#4490) (kotot <<317643941@qq.com>>)
   * [[`d652658d1`](http://github.com/eggjs/egg/commit/d652658d1205d0fbc73b4417c2ae54ee0a24f395)] - docs: d2 ads (#4508) (Suyi <<thonatos.yang@gmail.com>>)
-  
+
 ## 2020-10-19, Version 2.29.1 @atian25
 
 ### Notable Changes

package/index.d.ts

@@ -466,6 +466,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';

package/lib/agent.js

@@ -26,10 +26,13 @@ class Agent extends EggApplication {
     // dump config after loaded, ensure all the dynamic modifications will be recorded
     const dumpStartTime = Date.now();
     this.dumpConfig();
-    this.coreLogger.info('[egg:core] dump config after load, %s', ms(Date.now() - dumpStartTime));
+    this.coreLogger.info(
+      '[egg:core] dump config after load, %s',
+      ms(Date.now() - dumpStartTime)
+    );
 
     // keep agent alive even it doesn't have any io tasks
-    setInterval(() => {}, 24 * 60 * 60 * 1000);
+    this.agentAliveHandler = setInterval(() => {}, 24 * 60 * 60 * 1000);
 
     this._uncaughtExceptionHandler = this._uncaughtExceptionHandler.bind(this);
     process.on('uncaughtException', this._uncaughtExceptionHandler);
@@ -55,7 +58,13 @@ class Agent extends EggApplication {
   }
 
   _wrapMessenger() {
-    for (const methodName of [ 'broadcast', 'sendTo', 'sendToApp', 'sendToAgent', 'sendRandom' ]) {
+    for (const methodName of [
+      'broadcast',
+      'sendTo',
+      'sendToApp',
+      'sendToAgent',
+      'sendRandom',
+    ]) {
       wrapMethod(methodName, this.messenger, this.coreLogger);
     }
 
@@ -63,8 +72,11 @@ class Agent extends EggApplication {
       const originMethod = messenger[methodName];
       messenger[methodName] = function() {
         const stack = new Error().stack.split('\n').slice(1).join('\n');
-        logger.warn('agent can\'t call %s before server started\n%s',
-          methodName, stack);
+        logger.warn(
+          "agent can't call %s before server started\n%s",
+          methodName,
+          stack
+        );
         originMethod.apply(this, arguments);
       };
       messenger.prependOnceListener('egg-ready', () => {
@@ -75,9 +87,9 @@ class Agent extends EggApplication {
 
   close() {
     process.removeListener('uncaughtException', this._uncaughtExceptionHandler);
+    clearInterval(this.agentAliveHandler);
     return super.close();
   }
-
 }
 
 module.exports = Agent;

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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "egg",
-  "version": "2.29.3",
+  "version": "2.32.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",