egg 3.24.1 → 3.26.0

package/README.md

@@ -9,12 +9,11 @@ English | [简体中文](./README.zh-CN.md)
 [![NPM download](https://img.shields.io/npm/dm/egg.svg?style=flat-square)](https://npmjs.org/package/egg)
 [![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Feggjs%2Fegg.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Feggjs%2Fegg?ref=badge_shield)
 
-[![Continuous Integration](https://github.com/eggjs/egg/actions/workflows/nodejs.yml/badge.svg)](https://github.com/eggjs/egg/actions?query=branch%3Amaster)
+[![Continuous Integration](https://github.com/eggjs/egg/actions/workflows/nodejs-3.x.yml/badge.svg)](https://github.com/eggjs/egg/actions?query=branch%3A3.x)
 [![Test coverage](https://img.shields.io/codecov/c/github/eggjs/egg.svg?style=flat-square)](https://codecov.io/gh/eggjs/egg)
 [![Known Vulnerabilities](https://snyk.io/test/npm/egg/badge.svg?style=flat-square)](https://snyk.io/test/npm/egg)
 [![Open Collective backers and sponsors](https://img.shields.io/opencollective/all/eggjs?style=flat-square)](https://opencollective.com/eggjs)
 
-
 ## Features
 
 - Built-in Process Management
@@ -62,5 +61,4 @@ To become a contributor, please follow our [contributing guide](CONTRIBUTING.md)
 
 [MIT](LICENSE)
 
-
-[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Feggjs%2Fegg.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Feggjs%2Fegg?ref=badge_large)
+[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Feggjs%2Fegg.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Feggjs%2Fegg?ref=badge_large)

package/config/config.default.js

@@ -304,6 +304,7 @@ module.exports = appInfo => {
    * @property {Number} httpsAgent.maxSockets - https agent max socket number of one host, default is `Number.MAX_SAFE_INTEGER` @ses https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/MAX_SAFE_INTEGER
    * @property {Number} httpsAgent.maxFreeSockets - https agent max free socket number of one host, default is 256.
    * @property {Boolean} useHttpClientNext - use urllib@3 HttpClient
+   * @property {Boolean} allowH2 - Allow to use HTTP2 first, only work on `useHttpClientNext = true`
    */
   config.httpclient = {
     enableDNSCache: false,
@@ -326,6 +327,7 @@ module.exports = appInfo => {
       maxFreeSockets: 256,
     },
     useHttpClientNext: false,
+    // allowH2: false,
   };
 
   /**

package/index.d.ts

@@ -296,16 +296,18 @@ declare module 'egg' {
     request?: HttpClientRequestOptions | RequestOptionsOld;
     /** Whether enable dns cache */
     enableDNSCache?: boolean;
-    /** Enable proxy request, default is false. */
+    /** Enable proxy request. Default is `false`. */
     enableProxy?: boolean;
-    /** proxy agent uri or options, default is null. */
+    /** proxy agent uri or options. Default is `null`. */
     proxy?: string | { [key: string]: any };
     /** DNS cache lookup interval */
     dnsCacheLookupInterval?: number;
     /** DNS cache max age */
     dnsCacheMaxLength?: number;
-    /** use urllib@3 HttpClient */
+    /** use urllib@3 HttpClient. Default is `false`  */
     useHttpClientNext?: boolean;
+    /** Allow to use HTTP2 first, only work on `useHttpClientNext = true`. Default is `false` */
+    allowH2?: boolean;
   }
 
   export interface EggAppConfig {

package/lib/core/httpclient_next.js

@@ -2,12 +2,20 @@ const { HttpClient } = require('urllib-next');
 const ms = require('humanize-ms');
 
 class HttpClientNext extends HttpClient {
-  constructor(app) {
+  constructor(app, options) {
     normalizeConfig(app);
-    const config = app.config.httpclient;
+    options = options || {};
+    options = {
+      ...app.config.httpclient,
+      ...options,
+    };
     super({
       app,
-      defaultArgs: config.request,
+      defaultArgs: options.request,
+      allowH2: options.allowH2,
+      // use on egg-security ssrf
+      // https://github.com/eggjs/egg-security/blob/master/lib/extend/safe_curl.js#L11
+      checkAddress: options.checkAddress,
     });
     this.app = app;
   }

package/lib/egg.js

@@ -286,6 +286,22 @@ class EggApplication extends EggCore {
     return await this.httpclient.request(url, opts);
   }
 
+  /**
+   * Create a new HttpClient instance with custom options
+   * @param {Object} [options] HttpClient init options
+   */
+  createHttpClient(options) {
+    let httpClient;
+    if (this.config.httpclient.useHttpClientNext) {
+      httpClient = new this.HttpClientNext(this, options);
+    } else if (this.config.httpclient.enableDNSCache) {
+      httpClient = new DNSCacheHttpClient(this, options);
+    } else {
+      httpClient = new this.HttpClient(this, options);
+    }
+    return httpClient;
+  }
+
   /**
    * HttpClient instance
    * @see https://github.com/node-modules/urllib
@@ -293,13 +309,7 @@ class EggApplication extends EggCore {
    */
   get httpclient() {
     if (!this[HTTPCLIENT]) {
-      if (this.config.httpclient.useHttpClientNext) {
-        this[HTTPCLIENT] = new this.HttpClientNext(this);
-      } else if (this.config.httpclient.enableDNSCache) {
-        this[HTTPCLIENT] = new DNSCacheHttpClient(this);
-      } else {
-        this[HTTPCLIENT] = new this.HttpClient(this);
-      }
+      this[HTTPCLIENT] = this.createHttpClient();
     }
     return this[HTTPCLIENT];
   }

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "egg",
-  "version": "3.24.1",
+  "version": "3.26.0",
   "publishConfig": {
-    "tag": "latest"
+    "tag": "release-3.x",
+    "access": "public"
   },
   "description": "A web framework's framework for Node.js",
   "keywords": [
@@ -54,7 +55,7 @@
     "onelogger": "^1.0.0",
     "sendmessage": "^2.0.0",
     "urllib": "^2.33.0",
-    "urllib-next": "npm:urllib@^3.22.4",
+    "urllib-next": "npm:urllib@^3.26.0",
     "utility": "^2.1.0",
     "ylru": "^1.3.2"
   },