egg 3.30.0 → 3.31.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

@@ -19,10 +19,14 @@ import {
   HttpClientResponse as HttpClientResponseOld,
 } from 'urllib';
 import {
-  RequestURL as HttpClientRequestURL,
-  RequestOptions as HttpClientRequestOptions,
-  HttpClientResponse,
+  RequestURL,
+  RequestOptions,
+  HttpClientResponse as HttpClientResponseNext,
 } from 'urllib-next';
+import {
+  FetchFactory,
+  fetch,
+} from 'urllib4';
 import {
   EggCoreBase,
   FileLoaderOption,
@@ -60,7 +64,9 @@ declare module 'egg' {
   //   return await app.httpclient.request(url, options);
   // }
   // ```
-  export { HttpClientRequestURL, HttpClientRequestOptions, HttpClientResponse };
+  export type HttpClientRequestURL = RequestURL;
+  export type HttpClientRequestOptions = RequestOptions;
+  export type HttpClientResponse<T = any> = HttpClientResponseNext<T>;
   // Compatible with both urllib@2 and urllib@3 RequestOptions to request
   export interface EggHttpClient extends EventEmitter {
     request<T = any>(url: HttpClientRequestURL): Promise<HttpClientResponseOld<T> | HttpClientResponse<T>>;
@@ -587,6 +593,12 @@ declare module 'egg' {
      */
     httpclient: EggHttpClient;
 
+    /**
+     * node fetch
+     */
+    FetchFactory: FetchFactory;
+    fetch: typeof fetch,
+
     /**
      * Logger for Application, wrapping app.coreLogger with context infomation
      *

package/lib/core/fetch_factory.js

@@ -0,0 +1,37 @@
+const debug = require('util').debuglog('egg:lib:core:fetch_factory');
+
+const mainNodejsVersion = parseInt(process.versions.node.split('.')[0]);
+let FetchFactory;
+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');
+
+    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');
+        }
+        ssrfFetchFactory = new FetchFactory();
+        ssrfFetchFactory.setClientOptions(clientOptions);
+      }
+      return ssrfFetchFactory.fetch(url, init);
+    };
+  } catch (err) {
+    debug('require urllib4 error: %s', err);
+  }
+}
+
+module.exports = {
+  FetchFactory,
+  safeFetch,
+};

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');

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 } = require('./core/fetch_factory');
 const createLoggers = require('./core/logger');
 const Singleton = require('./core/singleton');
 const utils = require('./core/utils');
@@ -51,6 +52,12 @@ class EggApplication extends EggCore {
     this.ContextHttpClient = ContextHttpClient;
     this.HttpClient = HttpClient;
     this.HttpClientNext = HttpClientNext;
+    this.FetchFactory = FetchFactory;
+    if (FetchFactory) {
+      this.FetchFactory.setClientOptions();
+      this.fetch = FetchFactory.fetch;
+      this.safeFetch = safeFetch.bind(this);
+    }
 
     this.loader.loadConfig();
 

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "egg",
-  "version": "3.30.0",
+  "version": "3.31.0",
   "publishConfig": {
-    "tag": "latest",
+    "tag": "release-3.x",
     "access": "public"
   },
   "description": "A web framework's framework for Node.js",