egg 3.30.1 → 3.32.0

package/README.md

@@ -4,7 +4,7 @@ English | [简体中文](./README.zh-CN.md)
 	<img src="site/public/assets/egg-banner.png" />
 </div>
 
-[![NPM version](https://img.shields.io/npm/v/egg.svg?style=flat-square)](https://npmjs.org/package/egg)
+[![NPM version](https://img.shields.io/npm/v/egg/release-3.x.svg?style=flat-square)](https://www.npmjs.com/package/egg/v/release-3.x)
 [![NPM quality](http://npm.packagequality.com/shield/egg.svg?style=flat-square)](http://packagequality.com/#?package=egg)
 [![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)
@@ -37,7 +37,7 @@ $ open http://localhost:7001
 
 ## Documentations
 
-- [Documentations](https://eggjs.org/en/index.html)
+- [Documentations](https://v3.eggjs.org/)
 - [Plugins](https://github.com/search?q=topic%3Aegg-plugin&type=Repositories)
 - [Frameworks](https://github.com/search?q=topic%3Aegg-framework&type=Repositories)
 - [Examples](https://github.com/eggjs/examples)

package/README.zh-CN.md

@@ -4,7 +4,7 @@
 	<img src="site/public/assets/egg-banner.png" />
 </div>
 
-[![NPM version](https://img.shields.io/npm/v/egg.svg?style=flat-square)](https://npmjs.org/package/egg)
+[![NPM version](https://img.shields.io/npm/v/egg/release-3.x.svg?style=flat-square)](https://www.npmjs.com/package/egg/v/release-3.x)
 [![NPM quality](http://npm.packagequality.com/shield/egg.svg?style=flat-square)](http://packagequality.com/#?package=egg)
 [![NPM download](https://img.shields.io/npm/dm/egg.svg?style=flat-square)](https://npmjs.org/package/egg)
 
@@ -34,7 +34,7 @@ $ open http://localhost:7001
 
 ## 文档
 
-- [官方文档](https://eggjs.org/zh-cn/)
+- [官方文档](https://v3.eggjs.org/zh-CN/)
 - [插件列表](https://github.com/search?q=topic%3Aegg-plugin&type=Repositories)
 - [框架列表](https://github.com/search?q=topic%3Aegg-framework&type=Repositories)
 - [官方示例](https://github.com/eggjs/examples)

package/index.d.ts

@@ -2,7 +2,7 @@ import accepts = require('accepts');
 import { AsyncLocalStorage } from 'async_hooks';
 import { EventEmitter } from 'events'
 import { Readable } from 'stream';
-import { Socket } from 'net';
+import { Socket, LookupFunction } from 'net';
 import { IncomingMessage, ServerResponse } from 'http';
 import KoaApplication = require('koa');
 import KoaRouter = require('koa-router');
@@ -23,6 +23,10 @@ import {
   RequestOptions,
   HttpClientResponse as HttpClientResponseNext,
 } from 'urllib-next';
+import {
+  FetchFactory,
+  fetch,
+} from 'urllib4';
 import {
   EggCoreBase,
   FileLoaderOption,
@@ -313,6 +317,8 @@ declare module 'egg' {
     useHttpClientNext?: boolean;
     /** Allow to use HTTP2 first, only work on `useHttpClientNext = true`. Default is `false` */
     allowH2?: boolean;
+    /** Custom lookup function for DNS resolution */
+    lookup?: LookupFunction;
   }
 
   export interface EggAppConfig {
@@ -589,6 +595,12 @@ declare module 'egg' {
      */
     httpclient: EggHttpClient;
 
+    /**
+     * node fetch
+     */
+    FetchFactory: FetchFactory;
+    fetch: typeof fetch,
+
     /**
      * Logger for Application, wrapping app.coreLogger with context infomation
      *
@@ -1287,4 +1299,4 @@ declare module 'egg' {
   export interface Singleton<T> {
     get(id: string): T;
   }
-}
+}

package/lib/core/fetch_factory.js

@@ -0,0 +1,56 @@
+const debug = require('util').debuglog('egg:lib:core:fetch_factory');
+
+const mainNodejsVersion = parseInt(process.versions.node.split('.')[0]);
+let FetchFactory;
+let fetch;
+let fetchInitialized = false;
+let safeFetch;
+let ssrfFetchFactory;
+
+if (mainNodejsVersion >= 20) {
+  // urllib@4 only works on Node.js >= 20
+  try {
+    const urllib4 = require('urllib4');
+    FetchFactory = urllib4.FetchFactory;
+    debug('urllib4 enable');
+
+
+    fetch = function fetch(url, init) {
+      if (!fetchInitialized) {
+        const clientOptions = {};
+        if (this.config.httpclient?.lookup) {
+          clientOptions.lookup = this.config.httpclient.lookup;
+        }
+        FetchFactory.setClientOptions(clientOptions);
+        fetchInitialized = true;
+      }
+      return FetchFactory.fetch(url, init);
+    };
+
+    safeFetch = function safeFetch(url, init) {
+      if (!ssrfFetchFactory) {
+        const ssrfConfig = this.config.security?.ssrf;
+        const clientOptions = {};
+        if (ssrfConfig?.checkAddress) {
+          clientOptions.checkAddress = ssrfConfig.checkAddress;
+        } else {
+          this.logger.warn('[egg-security] please configure `config.security.ssrf` first');
+        }
+        if (this.config.httpclient?.lookup) {
+          clientOptions.lookup = this.config.httpclient.lookup;
+        }
+        ssrfFetchFactory = new FetchFactory();
+        ssrfFetchFactory.setClientOptions(clientOptions);
+      }
+      return ssrfFetchFactory.fetch(url, init);
+    };
+  } catch (err) {
+    debug('require urllib4 error: %s', err);
+  }
+}
+
+module.exports = {
+  FetchFactory,
+  safeFetch,
+  fetch,
+};

package/lib/core/httpclient.js

@@ -30,6 +30,7 @@ class HttpClient extends urllib.HttpClient2 {
     } else {
       args.tracer = args.tracer || this.app.tracer;
     }
+    args.lookup = args.lookup ?? this.app.config.httpclient?.lookup;
 
     try {
       return await super.request(url, args);

package/lib/core/httpclient_next.js

@@ -5,8 +5,8 @@ const SSRF_HTTPCLIENT = Symbol('SSRF_HTTPCLIENT');
 
 const mainNodejsVersion = parseInt(process.versions.node.split('.')[0]);
 let HttpClient;
-if (mainNodejsVersion >= 18) {
-  // urllib@4 only works on Node.js >= 18
+if (mainNodejsVersion >= 20) {
+  // urllib@4 only works on Node.js >= 20
   try {
     HttpClient = require('urllib4').HttpClient;
     debug('urllib4 enable');
@@ -32,6 +32,7 @@ class HttpClientNext extends HttpClient {
       app,
       defaultArgs: options.request,
       allowH2: options.allowH2,
+      lookup: options.lookup ?? app.config.httpclient?.lookup,
       // use on egg-security ssrf
       // https://github.com/eggjs/egg-security/blob/master/lib/extend/safe_curl.js#L11
       checkAddress: options.checkAddress,
@@ -62,8 +63,12 @@ class HttpClientNext extends HttpClient {
       } else {
         this.app.logger.warn('[egg-security] please configure `config.security.ssrf` first');
       }
+      if (!options.lookup && this.app.config.httpclient.lookup) {
+        options.lookup = this.app.config.httpclient.lookup;
+      }
       this[SSRF_HTTPCLIENT] = new HttpClientNext(this.app, {
         checkAddress: ssrfConfig.checkAddress,
+        lookup: options.lookup,
       });
     }
     return await this[SSRF_HTTPCLIENT].request(url, options);

package/lib/egg.js

@@ -14,6 +14,7 @@ const Messenger = require('./core/messenger');
 const DNSCacheHttpClient = require('./core/dnscache_httpclient');
 const HttpClient = require('./core/httpclient');
 const HttpClientNext = require('./core/httpclient_next');
+const { FetchFactory, safeFetch, fetch } = require('./core/fetch_factory');
 const createLoggers = require('./core/logger');
 const Singleton = require('./core/singleton');
 const utils = require('./core/utils');
@@ -51,7 +52,11 @@ class EggApplication extends EggCore {
     this.ContextHttpClient = ContextHttpClient;
     this.HttpClient = HttpClient;
     this.HttpClientNext = HttpClientNext;
-
+    this.FetchFactory = FetchFactory;
+    if (FetchFactory) {
+      this.fetch = fetch.bind(this);
+      this.safeFetch = safeFetch.bind(this);
+    }
     this.loader.loadConfig();
 
     /**
@@ -290,11 +295,13 @@ class EggApplication extends EggCore {
    * Create a new HttpClient instance with custom options
    * @param {Object} [options] HttpClient init options
    */
-  createHttpClient(options) {
+  createHttpClient(options = {}) {
     let httpClient;
+    options.lookup = options.lookup ?? this.config.httpclient.lookup;
+
     if (this.config.httpclient.useHttpClientNext || this.config.httpclient.allowH2) {
       httpClient = new this.HttpClientNext(this, options);
-    } else if (this.config.httpclient.enableDNSCache) {
+    } else if (this.config.httpclient?.enableDNSCache) {
       httpClient = new DNSCacheHttpClient(this, options);
     } else {
       httpClient = new this.HttpClient(this, options);
@@ -488,7 +495,7 @@ class EggApplication extends EggCore {
     return this.config.env;
   }
   /* eslint no-empty-function: off */
-  set env(_) {}
+  set env(_) { }
 
   /**
    * app.proxy delegate app.config.proxy
@@ -499,7 +506,7 @@ class EggApplication extends EggCore {
     return this.config.proxy;
   }
   /* eslint no-empty-function: off */
-  set proxy(_) {}
+  set proxy(_) { }
 
   /**
    * create a singleton instance

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "egg",
-  "version": "3.30.1",
+  "version": "3.32.0",
   "publishConfig": {
-    "tag": "latest",
+    "tag": "release-3.x",
     "access": "public"
   },
   "description": "A web framework's framework for Node.js",
@@ -79,10 +79,10 @@
     "eslint": "^8.23.1",
     "eslint-config-egg": "^12.0.0",
     "formstream": "^1.1.1",
-    "https-pem": "^3.0.0",
     "jsdoc": "^3.6.11",
     "koa": "^2.13.4",
     "koa-static": "^5.0.0",
+    "node-forge": "^1.3.3",
     "node-libs-browser": "^2.2.1",
     "pedding": "^1.1.0",
     "prettier": "^2.7.1",
@@ -126,7 +126,7 @@
   "homepage": "https://github.com/eggjs/egg",
   "repository": {
     "type": "git",
-    "url": "https://github.com/eggjs/egg.git"
+    "url": "git+https://github.com/eggjs/egg.git"
   },
   "engines": {
     "node": ">= 14.20.0"