Merge branch 'master' into ts

Author: popomore

.autod.conf.js

@@ -25,6 +25,7 @@ module.exports = {
     '@types/accepts',
     '@types/koa',
     '@types/koa-router',
+    '@types/urllib',
   ],
   test: 'scripts',
 };

History.md

@@ -1,5 +1,89 @@
 # History
 
+## 2018-05-03, Version 2.8.0 @dead-horse
+
+### Notable changes
+
+* **feature**
+  * add time duration for dump config
+
+* **fix**
+  * make singleton work for unextensible or frozen instance
+
+* **docs**
+  * switch to English document
+  * add middleware to Application and other ts improvement (typescript)
+  * update wxapp-socket-io project to weapp.socket.io
+  * update title and remove unused files
+
+### Commits
+
+  * [[`4b602d037`](http://github.com/eggjs/egg/commit/4b602d037554b72c8261b7abb7efd94f8f59f3fe)] - fix: make singleton work for unextensible or frozen instance (#2472) (Yiyu He <<dead_horse@qq.com>>)
+  * [[`824200c11`](http://github.com/eggjs/egg/commit/824200c11cac8e20b2c275daa7f5a4a365c71259)] - feat: add time duration for dump config (#2485) (Haoliang Gao <<sakura9515@gmail.com>>)
+  * [[`73dac083d`](http://github.com/eggjs/egg/commit/73dac083d2a029f893e9b6737080c921027e308f)] - docs: update wxapp-socket-io project to weapp.socket.io (#2421) (liuguili <<gongzili456@gmail.com>>)
+  * [[`1ada8e384`](http://github.com/eggjs/egg/commit/1ada8e3848be9f09680d7cac091fb14206df5a11)] - feat(d.ts): add middleware to Application and other ts improvement (#2465) (Axes <<whxaxes@qq.com>>)
+  * [[`437785315`](http://github.com/eggjs/egg/commit/437785315f28a828ea0cf7bece80223d5b796dc5)] - docs: fix the code error of LOCALS in view.md (#2464) (zjz19901029 <<346663801@qq.com>>)
+  * [[`f341b9fb8`](http://github.com/eggjs/egg/commit/f341b9fb8bdf36b6280500578e8448c59aec10f1)] - chore: update title and remove unused files (#2433) (TZ | 
+天猪 <<atian25@qq.com>>)
+  * [[`a5ab29cbd`](http://github.com/eggjs/egg/commit/a5ab29cbd1de0f5425019085258a496b4bce8b45)] - docs: switch to English document (#2426) (Haoliang Gao <<sakura9515@gmail.com>>)
+  * [[`4ab7df25f`](http://github.com/eggjs/egg/commit/4ab7df25f152609d494745eac2794b78e66444f0)] - deps: update dependencies, add @types/urllib to autod config (#2423) (Yiyu He <<dead_horse@qq.com>>)
+
+## 2018-04-17, Version 2.7.1 @dead-horse
+
+### Notable changes
+
+* **fix**
+  * imporve compatibility of singleton
+
+### Commits
+
+  * [[`e4d219f`](http://github.com/eggjs/egg/commit/e4d219f1aaecbca13601c7813e57c67934e8c32b)] - fix: imporve compatibility of singleton (#2410) (Yiyu He <<dead_horse@qq.com>>)
+
+## 2018-04-16, Version 2.7.0 @dead-horse [DEPRECATED]
+
+### Notable changes
+
+* **feature**
+  * singleton support asynchronous create function
+
+* **fix**
+  * dump config support circular json
+
+* **docs**
+  * improve router and typescript
+
+### Commits
+
+  * [[`3d499a9`](http://github.com/eggjs/egg/commit/3d499a90bab7095569e115e223de40e63812f2f5)] - docs(plugin): add singleton support async create function (#2392) (Yiyu He <<dead_horse@qq.com>>)
+  * [[`05d925f`](http://github.com/eggjs/egg/commit/05d925fea4e0b2d8efa48cb01ced2133c0c059cd)] - docs: change English document on Readme (#2397) (Haoliang Gao <<sakura9515@gmail.com>>)
+  * [[`590bd8c`](http://github.com/eggjs/egg/commit/590bd8cb400845706ec7cc84232b812cb468c8ac)] - fix: dumpConfig support circular json (#2394) (Yiyu He <<dead_horse@qq.com>>)
+  * [[`3a489b6`](http://github.com/eggjs/egg/commit/3a489b6f47b39ff2ec31efe936504918300b3f08)] - feat(singleton): support async create function (#2382) (Yiyu He <<dead_horse@qq.com>>)
+  * [[`a5b6731`](http://github.com/eggjs/egg/commit/a5b673133b35e9b005e19c1e3267a2ff3d58e32b)] - docs: chore for router and typescript (#2390) (TZ | 天猪 <<atian25@qq.com>>)
+  * [[`ee2d2b3`](http://github.com/eggjs/egg/commit/ee2d2b3c33671a822b45a6c474d3710aab5e70d5)] - docs(passport): translation for passport tutorial (#2235) (Cemre Mengu <<cemremengu@gmail.com>>)
+  * [[`6fad4e1`](http://github.com/eggjs/egg/commit/6fad4e1bed3c388e964fc656244e5e606b258085)] - chore: update package.json for release (#2381) (TZ | 天猪 <<atian25@qq.com>>)
+
+## 2018-04-12, Version 2.6.1 @atian25
+
+### Notable changes
+
+* **docs**
+  * TypeScript Guide (#2324)
+  * fix d.ts with ts support
+  * docs improve
+
+### Commits
+
+  * [[`2998bf733`](http://github.com/eggjs/egg/commit/2998bf733268d4d88d5fc77e05943b3fa0f824d4)] - chore(typings): add index signature of EggAppConfig (#2359) (waiting <<waiting@xiaozhong.biz>>)
+  * [[`5f2358bbd`](http://github.com/eggjs/egg/commit/5f2358bbdd6e21a1ab387a8425d0fefc30954227)] - docs: intro session.renew in the doc (#2375) (Yiyu He <<dead_horse@qq.com>>)
+  * [[`f0e7773f2`](http://github.com/eggjs/egg/commit/f0e7773f28eb7a233230a847ff2f8bc737aa3c01)] - docs: add TypeScript Guide (#2324) (TZ | 天猪 <<atian25@qq.com>>)
+  * [[`cd418f57a`](http://github.com/eggjs/egg/commit/cd418f57a843b504dcac6d8c25b99026e1edf072)] - docs(controller): add ctx.redirect (#2373) (Yiyu He <<dead_horse@qq.com>>)
+  * [[`2fafb16b8`](http://github.com/eggjs/egg/commit/2fafb16b8810e41b86d15f51257c2a0531c78357)] - docs(socketio): update demo & solve problem on chrome (#2354) (Suyi <<thonatos@users.noreply.github.com>>)
+  * [[`ba708ca4e`](http://github.com/eggjs/egg/commit/ba708ca4e911a345d2ee6aea5d4cf5845f93212b)] - feat: support customized client error (#2283) (Khaidi Chu <<i@2333.moe>>)
+  * [[`8697140d6`](http://github.com/eggjs/egg/commit/8697140d6ab10f42980ea301e7122331b6e5573a)] - chore: add export to declarations (#2344) (Axes <<whxaxes@qq.com>>)
+  * [[`441884145`](http://github.com/eggjs/egg/commit/4418841452a20a4fcca212e17dad0fbe9ff97646)] - chore(typings): export PowerPartial (#2327) (waiting <<waiting@xiaozhong.biz>>)
+  * [[`33d39519e`](http://github.com/eggjs/egg/commit/33d39519e1bd9bb1451776abe4986cdf4dee7626)] - docs(passport): config passport-github behind of proxy (#2318) (Suyi <<thonatos@users.noreply.github.com>>)
+  * [[`84e0dc4e7`](http://github.com/eggjs/egg/commit/84e0dc4e74e4e907d39b5485e1b19c3900aec393)] - fix(d.ts): add modifier to plugin and add middleware to config (#2322) (Axes <<whxaxes@qq.com>>)
+
 ## 2018-04-04, Version 2.6.0 @atian25
 
 ### Notable changes

README.md

@@ -45,14 +45,11 @@ Node.js >= 8.0.0 required.
 
 ## Docs & Community
 
-- [Website && Documentations](https://eggjs.org)
+- [Website && Documentations](https://eggjs.org/en/index.html)
 - [Plugins](https://github.com/search?q=topic%3Aegg-plugin&type=Repositories)
 - [Frameworks](https://github.com/search?q=topic%3Aegg-framework&type=Repositories)
 - [Plugin Dependency](http://uml.mvnsearch.org/github/eggjs/egg/blob/master/docs/plugins.puml)
 
-> All the documentations (comments, README, etc.) are in English, except the tutorials and api documentations are still [being translated](https://github.com/eggjs/egg/issues/363).
-> Feel free to join us and translate egg documentations. It's appreciated.
-
 ## Getting Started
 
 Follow the commands listed below.

README.zh-CN.md

@@ -38,7 +38,7 @@ $ npm install egg --save
 - ✔︎ 内置多进程管理
 - ✔︎ 高度可扩展的插件机制
 - ✔︎ 深度框架定制
-- ✔︎ 丰富的[插件](https://eggjs.org/badgeboard/)
+- ✔︎ 丰富的[插件](https://github.com/search?q=topic%3Aegg-plugin&type=Repositories)
 
 ## 文档和社区
 

config/config.default.js

@@ -318,6 +318,7 @@ module.exports = appInfo => {
    * @property {Number} responseTimeout - response timeout, default is 60000
    */
   config.clusterClient = {
+    maxWaitTime: 60000,
     responseTimeout: 60000,
   };
 

docs/_config.yml

@@ -2,8 +2,8 @@ title: Egg.js
 subtitle: "Born to build better enterprise frameworks and apps"
 description: "Born to build better enterprise frameworks and apps"
 language:
-- zh-cn
 - en
+- zh-cn
 timezone: UTC
 url: https://eggjs.org
 root: /
@@ -26,4 +26,4 @@ less:
 
 deer:
   spmAPos: 'a454'
-  spmBPos: 'b4893'
+  spmBPos: 'b4893'

docs/source/_data/guide_toc.yml

@@ -35,6 +35,7 @@ Tutorials:
   Passport: /tutorials/passport.html
   Socket.IO: /tutorials/socketio.html
   Assets: /tutorials/assets.html
+  TypeScript: /tutorials/typescript.html
 Advanced:
   Loader: /advanced/loader.html
   Plugin Development: /advanced/plugin.html

docs/source/en/advanced/plugin.md

@@ -56,7 +56,7 @@ Plugin is actually a 'mini application', directory of plugin is as below
         └── mw.test.js
 ```
 
-It is almost the same as the application directory, what's the difference?  
+It is almost the same as the application directory, what's the difference?
 
 1. Plugin have no independant router or controller. This is because:
 
@@ -135,7 +135,7 @@ We've discussed what plugin is. Now what can it do?
 
 ### Built-in Objects API Extension
 
-Extend the built-in objects of the framework, just like the application 
+Extend the built-in objects of the framework, just like the application
 
 - `app/extend/request.js` - extends Koa#Request object
 - `app/extend/response.js` - extends Koa#Response object
@@ -173,7 +173,7 @@ Extend the built-in objects of the framework, just like the application
   const assert = require('assert');
 
   module.exports = app => {
-    // insert static middleware before bodyParser 
+    // insert static middleware before bodyParser
     const index = app.config.coreMiddleware.indexOf('bodyParser');
     assert(index >= 0, 'bodyParser highly needed');
 
@@ -273,7 +273,7 @@ If each plugin makes their own implementation, all sorts of configs  and  initia
 
 #### Writing Plugin
 
-We simplify the [egg-mysql] plugin and to see how to write such a plugin: 
+We simplify the [egg-mysql] plugin and to see how to write such a plugin:
 
 ```js
 // egg-mysql/app.js
@@ -284,7 +284,7 @@ module.exports = app => {
 }
 
 /**
- * @param  {Object} config   The config which already processed by the framework. If the application configured multiple MySQL instances, each config would be passed in and call multiple createMysql 
+ * @param  {Object} config   The config which already processed by the framework. If the application configured multiple MySQL instances, each config would be passed in and call multiple createMysql
  * @param  {Application} app  the current application
  * @return {Object}          return the created MySQL instance
  */
@@ -294,16 +294,33 @@ function createMysql(config, app) {
   const client = new Mysql(config);
 
   // check before start the application
-  app.beforeStart(async function startMysql() {
+  app.beforeStart(async () => {
     const rows = await client.query('select now() as currentTime;');
-    const index = count++;
-    app.coreLogger.info(`[egg-mysql] instance[${index}] status OK, rds currentTime: ${rows[0].currentTime}`);
+    app.coreLogger.info(`[egg-mysql] init instance success, rds currentTime: ${rows[0].currentTime}`);
   });
 
   return client;
 }
 ```
 
+The initialization function also support `Async function`, convenient for some special plugins that need to be asynchronous to get some configuration files.
+
+```js
+async function createMysql(config, app) {
+  // get mysql configurations asynchronous
+  const mysqlConfig = await app.configManager.getMysqlConfig(config.mysql);
+  assert(mysqlConfig.host && mysqlConfig.port && mysqlConfig.user && mysqlConfig.database);
+  // create instance
+  const client = new Mysql(mysqlConfig);
+
+  // check before start the application
+  const rows = await client.query('select now() as currentTime;');
+  app.coreLogger.info(`[egg-mysql] init instance success, rds currentTime: ${rows[0].currentTime}`);
+
+  return client;
+}
+```
+
 As you can see, all we need to do for this plugin is passing in the field that need to be mounted and the corresponding initialization function. Framework will be in charge of managing all the configs and the ways to access the instances.
 
 #### Application Layer Usage Case
@@ -366,7 +383,7 @@ exports.mysql = {
 };
 ```
 
-2. Access the corresponding instance by `app.mysql.get('db1')` 
+2. Access the corresponding instance by `app.mysql.get('db1')`
 
 ```js
 // app/controller/post.js
@@ -388,12 +405,12 @@ module.exports = app => {
     //  get MySQL config from configuration center { host, post, password, ... }
     const mysqlConfig = await app.configCenter.fetch('mysql');
     // create MySQL instance dynamically
-    app.database = app.mysql.createInstance(mysqlConfig);
+    app.database = app.mysql.createInstanceAsync(mysqlConfig);
   });
 };
 ```
 
-Access the instance through `app.database` 
+Access the instance through `app.database`
 
 ```js
 // app/controller/post.js
@@ -455,7 +472,7 @@ We are very welcome your contribution to the new plugins, but also hope you foll
 
 Egg defines the plugin name through the `eggPlugin.name`, it is only unique in application or framework, that means **many npm packages might get the same plugin name**, why design in this way?
 
-First, Egg plugin do not only support npm package, it also supports search plugins in local directory. In Chapter [progressive](../tutorials/progressive.md) we mentioned how to make progress by using these two configurations. Directory is more friendly to unit test. So, Egg can not ensure uniqueness through npm package name. 
+First, Egg plugin do not only support npm package, it also supports search plugins in local directory. In Chapter [progressive](../tutorials/progressive.md) we mentioned how to make progress by using these two configurations. Directory is more friendly to unit test. So, Egg can not ensure uniqueness through npm package name.
 
 What's more, Egg can use this feature to make Adapter. For example, the plugin defined in[Template Develop Spec](./view-plugin.md#PluginNameSpecification) was named as view, but there are plugins named `egg-view-nunjucks` and `egg-view-react`, the users only need to change the plugin and modify the templates, no need to modify the Controller, because all these plugins have implemented the same API.
 

docs/source/en/basics/controller.md

@@ -920,3 +920,22 @@ class ProxyController extends Controller {
   }
 }
 ```
+
+### Redirect
+
+The framework overwrites koa's native `ctx.redirect` implementation with a security plugin to provide a more secure redirect.
+
+
+* `ctx.redirect(url)` Forbids redirect if it is not in the configured whitelist domain name.
+* `ctx.unsafeRedirect(url)` does not determine the domain name and redirect directly. Generally, it is not recommended to use it. Use it after clearly understanding the possible risks.
+
+If you use the `ctx.redirect` method, you need to configure the application configuration file as follows:
+
+```js
+// config/config.default.js
+exports.security = {
+  domainWhiteList:['.domain.com'],  // Security whitelist, starts with `.`
+};
+```
+
+If the user does not configure the `domainWhiteList` or the `domainWhiteList` array to be empty, then all redirect requests will be released by default, which is equivalent to `ctx.unsafeRedirect(url)`.

docs/source/en/basics/router.md

@@ -341,3 +341,5 @@ module.exports = app => {
   app.router.get('/admin/log', app.controller.admin.log);
 };
 ```
+
+or using [egg-router-plus](https://github.com/eggjs/egg-router-plus).