egg 2.33.1 → 2.36.0

package/README.md

@@ -1,10 +1,11 @@
 <div style="text-align:center">
-	<img src="docs/assets/egg-banner.png" />
+	<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 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)
 
 [![Continuous Integration](https://github.com/eggjs/egg/workflows/Continuous%20integration/badge.svg)](https://github.com/eggjs/egg/actions?query=branch%3Amaster)
 [![Test coverage](https://img.shields.io/codecov/c/github/eggjs/egg.svg?style=flat-square)](https://codecov.io/gh/eggjs/egg)
@@ -31,7 +32,7 @@ $ npm run dev
 $ open http://localhost:7001
 ```
 
-> Node.js >= 8.0.0 required.
+> Node.js >= 8.5.0 required.
 
 ## Documentations
 
@@ -42,7 +43,7 @@ $ open http://localhost:7001
 
 ## Contributors
 
-[![contributors](https://ergatejs.implements.io/badges/contributors/eggjs/egg.png)](https://github.com/eggjs/egg/graphs/contributors)
+[![contributors](https://contrib.rocks/image?repo=eggjs/egg&max=240&columns=26)](https://github.com/eggjs/egg/graphs/contributors)
 
 ## How to Contribute
 
@@ -58,3 +59,6 @@ To become a contributor, please follow our [contributing guide](CONTRIBUTING.md)
 ## License
 
 [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)

package/README.zh-CN.md

@@ -1,5 +1,5 @@
 <div style="text-align:center">
-	<img src="docs/assets/egg-banner.png" />
+	<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)
@@ -18,7 +18,7 @@
 - 深度框架定制
 - 丰富的[插件](https://github.com/search?q=topic%3Aegg-plugin&type=Repositories)
 
-> 支持 Node.js 8.x 及以上版本。
+> 支持 Node.js 8.5.x 及以上版本。
 
 ## 快速开始
 
@@ -39,7 +39,7 @@ $ open http://localhost:7001
 
 ## 贡献者
 
-[![contributors](https://ergatejs.implements.io/badges/contributors/eggjs/egg.png)](https://github.com/eggjs/egg/graphs/contributors)
+[![contributors](https://contrib.rocks/image?repo=eggjs/egg&max=240&columns=26)](https://github.com/eggjs/egg/graphs/contributors)
 
 ## 贡献代码
 

package/app/middleware/site_file.js

@@ -1,7 +1,6 @@
 'use strict';
 
 const path = require('path');
-const MAX_AGE = 'public, max-age=2592000'; // 30 days
 
 module.exports = options => {
   return function siteFile(ctx, next) {
@@ -19,7 +18,7 @@ module.exports = options => {
     // '/robots.txt': Buffer <xx..
     // content is buffer
     if (Buffer.isBuffer(content)) {
-      ctx.set('cache-control', MAX_AGE);
+      ctx.set('cache-control', options.cacheControl);
       ctx.body = content;
       ctx.type = path.extname(ctx.path);
       return;

package/config/config.default.js

@@ -190,6 +190,7 @@ module.exports = appInfo => {
    * You can map some files using this options, it will response immdiately when matching.
    *
    * @member {Object} Config#siteFile - key is path, and value is url or buffer.
+   * @property {String} cacheControl - files cache , default is public, max-age=2592000
    * @example
    * // specific app's favicon, => '/favicon.ico': 'https://eggjs.org/favicon.ico',
    * config.siteFile = {
@@ -198,6 +199,8 @@ module.exports = appInfo => {
    */
   config.siteFile = {
     '/favicon.ico': fs.readFileSync(path.join(__dirname, 'favicon.png')),
+    // default cache in 30 days
+    cacheControl: 'public, max-age=2592000',
   };
 
   /**

package/lib/application.js

@@ -127,7 +127,7 @@ class Application extends EggApplication {
     if (typeof this.config.onClientError === 'function') {
       const p = eggUtils.callFn(this.config.onClientError, [ err, socket, this ]);
 
-      // the returned object should like:
+      // the returned object should be something like:
       //
       //   {
       //     body: '...',

package/lib/core/dnscache_httpclient.js

@@ -71,7 +71,7 @@ class DNSCacheHttpClient extends HttpClient {
 
     args = args || {};
     args.headers = args.headers || {};
-    // set host header is not exists
+    // set when host header doesn't exist
     if (!args.headers.host && !args.headers.Host) {
       // host must combine with hostname:port, node won't use `parsed.host`
       args.headers.host = parsed.port ? `${hostname}:${parsed.port}` : hostname;
@@ -81,7 +81,7 @@ class DNSCacheHttpClient extends HttpClient {
     const now = Date.now();
     if (record) {
       if (now - record.timestamp >= this.dnsCacheLookupInterval) {
-        // make sure next request don't refresh dns query
+        // make sure the next request doesn't refresh dns query
         record.timestamp = now;
         this[UPDATE_DNS](hostname, args).catch(err => this.app.emit('error', err));
       }

package/lib/egg.js

@@ -373,7 +373,7 @@ class EggApplication extends EggCore {
       ignoreList = [];
     }
 
-    const json = extend(true, {}, { config: this.config, plugins: this.loader.allPlugins });
+    const json = extend(true, {}, { config: this.config, plugins: this.loader.allPlugins, appInfo: this.loader.appInfo });
     utils.convertObject(json, ignoreList);
     return {
       config: json,
@@ -426,6 +426,13 @@ class EggApplication extends EggCore {
   _setupTimeoutTimer() {
     const startTimeoutTimer = setTimeout(() => {
       this.coreLogger.error(`${this.type} still doesn't ready after ${this.config.workerStartTimeout} ms.`);
+      // log unfinished
+      const json = this.timing.toJSON();
+      for (const item of json) {
+        if (item.end) continue;
+        this.coreLogger.error(`unfinished timing item: ${CircularJSON.stringify(item)}`);
+      }
+      this.coreLogger.error(`check run/${this.type}_timing_${process.pid}.json for more details.`);
       this.emit('startTimeout');
     }, this.config.workerStartTimeout);
     this.ready(() => clearTimeout(startTimeoutTimer));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "egg",
-  "version": "2.33.1",
+  "version": "2.36.0",
   "description": "A web framework's framework for Node.js",
   "keywords": [
     "web",
@@ -57,15 +57,19 @@
     "ylru": "^1.2.1"
   },
   "devDependencies": {
+    "@umijs/preset-react": "^2.1.2",
     "address": "^1.0.3",
+    "antd": "^4.18.6",
     "assert-extends": "^1.0.1",
     "assert-file": "^1.0.0",
     "autod": "^3.0.1",
     "autod-egg": "^1.1.0",
     "coffee": "^5.2.1",
+    "dumi": "^1.1.38",
+    "dumi-theme-egg": "^1.2.0",
     "egg-alinode": "^1.0.3",
     "egg-bin": "^4.12.3",
-    "egg-doctools": "^2.8.3",
+    "egg-doctools": "^2.9.1",
     "egg-mock": "^3.21.0",
     "egg-plugin-puml": "^2.4.0",
     "egg-tracer": "^1.1.0",
@@ -75,11 +79,13 @@
     "findlinks": "^2.1.0",
     "formstream": "^1.1.0",
     "glob": "^7.1.3",
+    "jsdoc": "^3.6.10",
     "koa": "^2.11.0",
     "koa-static": "^3.0.0",
     "mz": "^2.7.0",
     "mz-modules": "^2.1.0",
     "pedding": "^1.1.0",
+    "prettier": "^2.5.1",
     "runscript": "^1.3.0",
     "spy": "^1.0.0",
     "supertest": "^3.4.2",
@@ -103,11 +109,12 @@
     "test-local-changed": "egg-bin test --changed",
     "cov": "egg-bin cov --timeout 100000",
     "ci": "npm run lint && egg-bin pkgfiles --check && npm run cov",
-    "doc-server": "doctools server",
-    "doc-build": "doctools build",
-    "doc-deploy": "doctools deploy",
+    "site:jsdoc": "node ./scripts/jsdoc.js",
+    "site:dev": "APP_ROOT=./site dumi dev",
+    "site:build": "APP_ROOT=./site dumi build && npm run site:jsdoc",
+    "site:prettier": "prettier --config site/.prettierrc --ignore-path site/.prettierignore --write \"site/**/*.{js,jsx,tsx,ts,less,md,json}\"",
     "autod": "autod",
-    "puml": "puml . --dest ./docs",
+    "puml": "puml . --dest ./site",
     "commits": "./scripts/commits.sh"
   },
   "homepage": "https://github.com/eggjs/egg",