egg

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] - fix: make singleton work for unextensible or frozen instance (#2472) (Yiyu He <[email protected]>)
• [824200c11] - feat: add time duration for dump config (#2485) (Haoliang Gao <[email protected]>)
• [73dac083d] - docs: update wxapp-socket-io project to weapp.socket.io (#2421) (liuguili <[email protected]>)
• [1ada8e384] - feat(d.ts): add middleware to Application and other ts improvement (#2465) (Axes <[email protected]>)
• [437785315] - docs: fix the code error of LOCALS in view.md (#2464) (zjz19901029 <[email protected]>)
• [f341b9fb8] - chore: update title and remove unused files (#2433) (TZ |
  天猪 <[email protected]>)
• [a5ab29cbd] - docs: switch to English document (#2426) (Haoliang Gao <[email protected]>)
• [4ab7df25f] - deps: update dependencies, add @types/urllib to autod config (#2423) (Yiyu He <[email protected]>)

Notable changes

• fix
  • imporve compatibility of singleton

Commits

• [e4d219f] - fix: imporve compatibility of singleton (#2410) (Yiyu He <[email protected]>)

Notable changes

• feature

  • singleton support asynchronous create function

• fix

  • dump config support circular json

• docs

  • improve router and typescript

Commits

• [3d499a9] - docs(plugin): add singleton support async create function (#2392) (Yiyu He <[email protected]>)
• [05d925f] - docs: change English document on Readme (#2397) (Haoliang Gao <[email protected]>)
• [590bd8c] - fix: dumpConfig support circular json (#2394) (Yiyu He <[email protected]>)
• [3a489b6] - feat(singleton): support async create function (#2382) (Yiyu He <[email protected]>)
• [a5b6731] - docs: chore for router and typescript (#2390) (TZ | 天猪 <[email protected]>)
• [ee2d2b3] - docs(passport): translation for passport tutorial (#2235) (Cemre Mengu <[email protected]>)
• [6fad4e1] - chore: update package.json for release (#2381) (TZ | 天猪 <[email protected]>)

Notable changes

• fix
  • dump config support circular json

Commits

• [8507c5e] - fix: dumpConfig support circular json (#2395) (Yiyu He <[email protected]>)

• docs
  • TypeScript Guide (#2324)
  • fix d.ts with ts support
  • docs improve

Commits

• [2998bf733] - chore(typings): add index signature of EggAppConfig (#2359) (waiting <[email protected]>)
• [5f2358bbd] - docs: intro session.renew in the doc (#2375) (Yiyu He <[email protected]>)
• [f0e7773f2] - docs: add TypeScript Guide (#2324) (TZ | 天猪 <[email protected]>)
• [cd418f57a] - docs(controller): add ctx.redirect (#2373) (Yiyu He <[email protected]>)
• [2fafb16b8] - docs(socketio): update demo & solve problem on chrome (#2354) (Suyi <[email protected]>)
• [ba708ca4e] - feat: support customized client error (#2283) (Khaidi Chu <[email protected]>)
• [8697140d6] - chore: add export to declarations (#2344) (Axes <[email protected]>)
• [441884145] - chore(typings): export PowerPartial (#2327) (waiting <[email protected]>)
• [33d39519e] - docs(passport): config passport-github behind of proxy (#2318) (Suyi <[email protected]>)
• [84e0dc4e7] - fix(d.ts): add modifier to plugin and add middleware to config (#2322) (Axes <[email protected]>)

• feature

  • TypeScript tool support (#2272)

• docs

  • improve d.ts with ts support (#2306)
  • docs improve and translation

Commits

• [406142758] - chore: improve d.ts with ts support (#2306) (Axes <[email protected]>)
• [7fba689b7] - docs(controller): session example bug (#2313) (Suyi <[email protected]>)
• [e0e7ed146] - chore(typings): change export interface to class definition (#2293) (waiting <[email protected]>)
• [161107929] - docs(plugin): add config notice for addSingleton function (#2305) (Shangbin Yang <[email protected]>)
• [1c74a8491] - docs: add assets document (#2220) (Haoliang Gao <[email protected]>)
• [e4531e563] - docs: EN translation for view plugin dev doc (#2240) (Cemre Mengu <[email protected]>)
• [348ff18d8] - docs: EN translation for style guide doc (#2239) (Cemre Mengu <[email protected]>)
• [d9c4ec2bb] - EN translation for resources doc (#2238) (Cemre Mengu <[email protected]>)
• [46217a5d2] - docs(security): add ssrf in security (#2274) (Yiyu He <[email protected]>)
• [c3586eab5] - docs: deprecate ignoreJSON (#2270) (Yiyu He <[email protected]>)
• [a86334c59] - docs: example for custom id when mysql update (#2165) (OnedayLiu <[email protected]>)
• [10327e185] - docs: EN translation for socketio tutorial doc (#2167) (Cemre Mengu <[email protected]>)
• [5b059db6a] - docs: add boilerplate type desc (#2250) (QiChang Li <[email protected]>)
• [9007b5847] - chore: update package.json for release (#2244) (Haoliang Gao <[email protected]>)

Notable changes

• feature

  • display router when log app (#2230)
  • update favicon.png
  • upgrade cluster-client to 2.x (#2236)

• docs

  • improve d.ts
  • add socket.io webchat description (#2198)

Commits

• [6040d6f8f] - chore: fix spelling error rotator (#2242) (HE ZIQIANG <[email protected]>)
• [1554da57e] - chore: upgrade cluster-client to 2.x (#2236) (zōng yǔ <[email protected]>)
• [9faa052bf] - feat: tsd add init module (#2233) (Eward Song <[email protected]>)
• [d5f9059f1] - docs: translation for basic plugin (#2166) (Cemre Mengu <[email protected]>)
• [7afc7e24b] - feat: display router when log app (#2230) (Kiho · Cham <[email protected]>)
• [5e99fd6fd] - docs: egg-passsport-local -> egg-passport-local (楊傑文 Chuck Yang <[email protected]>)
• [c042366df] - docs(socket.io): add webchat description (#2198) (TZ | 天猪 <[email protected]>)
• [5cce8795a] - chore: fix typo. (#2172) (薛定谔的猫 <[email protected]>)

Notable changes

• fix

  • [security] don't allow x-forwarded-host header by default
  • ctx.runInBackground will try to use custom function name first

• docs

  • improve d.ts
    • add regexp as type of path in Router
    • fix type of render
  • more semantic and moment installation in quickstart

Commits

• [0eabce6] - fix: don't allow x-forwarded-host header (#2163) (Haoliang Gao <[email protected]>)
• [f0edf96] - fix: try to use custom function name first (#2161) (fengmk2 <[email protected]>)
• [1a73720] - fix(typings): add regexp as type of path (#2157) (AngrySean <[email protected]>)
• [b55e908] - doc(quickstart): more semantic and moment installation (#2154) (Kiho · Cham <[email protected]>)
• [951e236] - Fix type of render (#2155) (Arniu Tseng <[email protected]>)

Notable changes

• fix
  • [security] don't allow x-forwarded-host header by default
  • ctx.runInBackground will try to use custom function name first

Commits

• [70d5898] - fix: don't allow x-forwarded-host header (#2162) (Haoliang Gao <[email protected]>)
• [be618f8] - fix: try to use custom function name first (#2156) (fengmk2 <[email protected]>)

Notable changes

• feature

  • support Keep-Alive Header

• fix

  • add logger in base_context_class

• docs

  • Lots of d.ts improved.
    • add context
    • add urllib
    • add resources & logger
  • new documents
    • how to call the service
    • socket.io tutorial
    • add events on application

Commits

• [79927324a] - fix: add logger in base_context_class (#2149) (Axes <[email protected]>)
• [a73900231] - feat: support Keep-Alive Header (#2146) (fengmk2 <[email protected]>)
• [c8284367c] - docs(ts): fix some d.ts (#2144) (TZ | 天猪 <[email protected]>)
• [e0282b923] - docs(router): add definition of ctx (#2136) (重庆 <[email protected]>)
• [3e7ef6aa5] - docs(app-start): how to call service (#2133) (TZ | 天猪 <[email protected]>)
• [9472b5828] - docs(schedule): fix log dir (#2123) (TZ | 天猪 <[email protected]>)
• [ede433fc5] - docs(unittest):fix some mistakes (#2110) (恬竹 <[email protected]>)
• [2d03c79a1] - chore: add urllib declaration support in index.d.ts (#2117) (SoraYama <[email protected]>)
• [fd6fa2495] - docs(2.x-advanced-plugin):fix some descriptions (#2111) (恬竹 <[email protected]>)
• [0a208d741] - docs: translation for advanced/plugin.md (#2075) (DukeFightLife <[email protected]>)
• [42e4ea4c1] - docs(schedule):fix some places (#2105) (恬竹 <[email protected]>)
• [63278c229] - docs(2.x-basic-extend):fix some mistakes (#2107) (恬竹 <[email protected]>)
• [7a604d37f] - docs(2.x-basic-service):fix some mistakes of service (#2102) (恬竹 <[email protected]>)
• [a1a4e7dd3] - docs(plugin): add description for plugin.local.js (#2104) (TZ | 天猪 <[email protected]>)
• [2cdfcc249] - docs(development): adjust to new version vscode (#2098) (TZ | 天猪 <[email protected]>)
• [bb4b29002] - docs(faq): add the most common mistake of config (#2086) (TZ | 天猪 <[email protected]>)
• [5621a8574] - docs(schedule): logging && args (#2091) (TZ | 天猪 <[email protected]>)
• [03a894439] - docs: d.ts of resources& logger (#2079) (x22x22 <[email protected]>)
• [bbfacc5a7] - docs(middleware): use app.middleware instead of app.middlewares (#2077) (x22x22 <[email protected]>)
• [7e9f330ee] - docs(socket.io): add tutorial (#1913) (Suyi <[email protected]>)
• [1224dd65f] - docs(2.x-basic-controller):fix some descriptions of basic-controller (#2043) (恬竹 <[email protected]>)
• [fa5bdaeb5] - style(app/extend/request.js): Some Comments from Chinese To English in union (#2051) (DongWei <[email protected]>)
• [06e7710c7] - docs: add events on application (#2039) (Yiyu He <[email protected]>)
• [65e038132] - docs(advanced/loader): translate (#1654) (Weilun Xiong <[email protected]>)

Notable changes

• feature

  • emit request and response event in every request

• docs

  • improve english docs
  • add alinode usage

Commits

• [50a0f8a] - doc: fix deploy example (dead-horse <[email protected]>)
• [3b7a313] - docs(deploy): more about alinode (#2036) (TZ | 天猪 <[email protected]>)
• [950b9e6] - doc: fix deploy docs (dead-horse <[email protected]>)
• [18d6436] - docs: translate advanced/cluster-client.md (#1839) (学究 <[email protected]>)
• [287c761] - Update deployment.md (#1979) (juju <[email protected]>)
• [22dfaa7] - feat: emit request and response event (#2020) (Yiyu He <[email protected]>)
• [ddbb4b3] - docs(deploy): add alinode (#2025) (TZ | 天猪 <[email protected]>)
• [b5d823f] - docs(core/unittest): fix path of helper.js(#2029) (#2030) (Jiulong Hu <[email protected]>)
• [1e3a4b3] - docs(basic-router):fix some places of basic-router (#2012) (恬竹 <[email protected]>)

Notable changes

• feature
  • emit request and response event in every request

Commits

• [49ec2fc] - feat: emit request and response event (#2021) (Yiyu He <[email protected]>)

Notable changes

• fix

  • log cookie's key when cookie exceed limit length

• document

  • improve english documents, fix some grammars
  • add link to alicloud node.js perfomance platform
  • use PATCH method in resource router

Commits

• [aa46eb2] - fix: log cookie's key when cookie exceed limit length (#1996) (Yiyu He <[email protected]>)
• [7993b45] - docs(basic-middleware):fix some descriptions of basic-middleware (#1998) (恬竹 <[email protected]>)
• [b2d09e1] - docs: put => patch. (#1793) (#1938) (吴建金 <[email protected]>)
• [dede240] - feat: add helper interface in d.ts (#1989) (Axes <[email protected]>)
• [19fe608] - docs: add deer stat (#1974) (TZ | 天猪 <[email protected]>)
• [cef371e] - docs(basic-env): fix some descriptions base on the Chinese version (#1930) (恬竹 <[email protected]>)
• [55d08bd] - fix(ts): error declare of route.resource (#1959) (AntSworD <[email protected]>)
• [32d7c81] - docs: fix word error (#1965) (jxDeveloper <[email protected]>)
• [3acf45f] - docs(basic-config): fix some word spelling (#1931) (恬竹 <[email protected]>)
• [0e90819] - docs(advanced/framework): translation (#1668) (freebyron <[email protected]>)
• [ab1b08e] - docs: fix en index (#1915) (Weilun Xiong <[email protected]>)
• [2270f7f] - docs(basic-objects): fix some descriptions (#1903) (恬竹 <[email protected]>)
• [c136470] - test: use Buffer.alloc, Buffer.from. (#1895) (薛定谔的猫 <[email protected]>)
• [73bc636] - docs(links): Add link to alicloud node.js perfomance platform (#1894) (Jackson Tian <[email protected]>)
• [55d1b0e] - docs(deploy): add --ignore-stderr (#1876) (TZ | 天猪 <[email protected]>)
• [532110a] - fix: fix 404 page url (#1881) (sam <[email protected]>)

Notable changes

• fix
  • log cookie's key when cookie exceed limit length

Commits

• [ba9ecd4] - fix: log cookie's key when cookie exceed limit length (#1997) (Yiyu He <[email protected]>)
• [4f6ec61] - feat: add 400 response for broken client request to instead of empty response (#1836) (Khaidi Chu <[email protected]>)

Notable changes

• feature

  • config.meta.logging to enable log every request when recieved

• document

  • fix some grammars
  • add rule for issue

Commits

• [9fe5b85] - feat: enable request started log on meta middleware (#1877) (fengmk2 <[email protected]>)
• [8ce9611] - docs(objects): fix some grammars (#1806) (恬竹 <[email protected]>)
• [e43aa2b] - docs(error-handling): fix some words (#1874) (Fan <[email protected]>)
• [4c1617a] - docs(faq): add rule for issue (#1861) (TZ | 天猪 <[email protected]>)

Notable changes

• feature

  • add 400 response for broken client request to instead of empty response
  • dump application router json

• fix

  • fix: run dumpConfig at the last ready callback

• document

  • migrate docs to egg 2
  • add document for passport

Commits

• [40df153] - feat: add 400 response for broken client request to instead of empty response (#1829) (Khaidi Chu <[email protected]>)
• [d0ee9f2] - docs(passport): fix some description (#1828) (TZ | 天猪 <[email protected]>)
• [f7c6a0a] - docs(passport): add description (#1825) (TZ | 天猪 <[email protected]>)
• [f66d9be] - docs(passport): the missing docs for passport (#1824) (TZ | 天猪 <[email protected]>)
• [18f93f0] - docs(core/view.md): translation (#1577) (Zhongyuan <[email protected]>)
• [7e05669] - 1. docs(error-handle): missing function keywords. (#1819) (M.Y.Akashi <[email protected]>)
• [89e114c] - docs: add AntV links (#1809) (TZ | 天猪 <[email protected]>)
• [bdfd3cc] - docs(router): new style & remove app.verb (#1803) (TZ | 天猪 <[email protected]>)
• [4c9eacb] - docs(middleware): add description of import koa middleware (#1805) (TZ | 天猪 <[email protected]>)
• [c152dee] - docs(loader): adjust extends way (#1729) (TZ | 天猪 <[email protected]>)
• [289f8cd] - docs(progressive):changes some grammar (#1773) (恬竹 <[email protected]>)
• [ae87460] - docs(migration): add description for plugin breakchange (#1766) (TZ | 天猪 <[email protected]>)
• [a2788a8] - docs(controller): import base controller directly (#1771) (Yiyu He <[email protected]>)
• [7ebfc9b] - docs(quickstart): fix typo in code example (#1765) (Darren Poon <[email protected]>)
• [6ff6998] - docs: add security english translation (#1691) (Adams <[email protected]>)
• [a061f21] - docs(intro): make some changes for egg-and-koa (#1739) (恬竹 <[email protected]>)
• [d752b3b] - docs(deployment): adjust with new version egg-scripts (#1757) (TZ | 天猪 <[email protected]>)
• [1b12b51] - docs(cookie-session): use async (#1723) (TZ | 天猪 <[email protected]>)
• [5c88026] - docs(plugin): use async (#1730) (TZ | 天猪 <[email protected]>)
• [ebb8adf] - some changes of docs(what is egg) (#1734) (恬竹 <[email protected]>)
• [2da00fc] - docs(framework): use new way (#1728) (TZ | 天猪 <[email protected]>)
• [47fbee5] - docs(cluster-client): use async (#1727) (TZ | 天猪 <[email protected]>)
• [1420682] - docs(ipc): use async (#1722) (TZ | 天猪 <[email protected]>)
• [503b69b] - feat: dump application router json (fengmk2 <[email protected]>)
• [76ff783] - fix: run dumpConfig at the last ready callback (fengmk2 <[email protected]>)
• [50efe4c] - docs(httpclient): use async (#1724) (TZ | 天猪 <[email protected]>)
• [d043148] - docs: remove async-function (#1713) (TZ | 天猪 <[email protected]>)
• [e3ef3ec] - docs(restful): use async (#1709) (TZ | 天猪 <[email protected]>)
• [b042937] - docs(error-handling): use async (#1721) (TZ | 天猪 <[email protected]>)
• [80ab243] - docs(i18n): use async (#1720) (TZ | 天猪 <[email protected]>)
• [6741999] - docs(logger): use async (#1719) (TZ | 天猪 <[email protected]>)
• [f39c105] - docs(view): use async (#1717) (TZ | 天猪 <[email protected]>)
• [cf3de0f] - docs(unittest): use async (#1716) (TZ | 天猪 <[email protected]>)
• [cb9c9a4] - docs(mysql): use async (#1711) (TZ | 天猪 <[email protected]>)

Notable changes

• performance

  • By removing the wrapper code of co library, performance increase over 30% (which not include the performance boost coming with Node 8), see #14 and benchmark

• feature

  • [BREAKING CHANGE] drop node <8 support
  • upgrade to egg-core@4(base on koa 2), but still supports all the usages in egg 1
  • upgrade built-in plugins to adapt egg@2
  • runInBackground use location as scope name when anonymous

• fix

  • dump async function as AsyncFunction

• document

  • migration guide
  • migrate some documents to async function
  • split plugin and plugin development
  • refactor the description about cluster client @vincenthou
  • add document for how to customize error handler
  • translate cookie and session @zhang-z
  • translate basics/schedule.md, thanks @Azard

Commits

• [8197826] - docs: refine egg-and-koa with egg 2 (#1686) (Yiyu He <[email protected]>)
• [757f275] - fix: dump async function as AsyncFunction (#1687) (Yiyu He <[email protected]>)
• [12edd64] - test: use async function instead of generator function (#1684) (Yiyu He <[email protected]>)
• [5513456] - feat: runInBackground use location as scope name when anonymous (#1683) (Yiyu He <[email protected]>)
• [212b077] - doc: Add th.yml (#1682) (NatPi <[email protected]>)
• [3ddd67f] - docs(advanced/cluster-client): refactor the description about cluster client (#1417) (vincent.hou <[email protected]>)
• [3d948e4] - docs(plugin): split plugin and plugin development (#1663) (TZ | 天猪 <[email protected]>)
• [b1343ad] - docs(core/unittest): translate unittest.md (#1660) (freebyron <[email protected]>)
• [fb2d96a] - docs(app-start): generator -> async (#1662) (TZ | 天猪 <[email protected]>)
• [12c0a8a] - docs(quickstart): fix app.Service (#1661) (TZ | 天猪 <[email protected]>)
• [49b0071] - docs(core/cookie-and-session): translate section Cookie (#1562) (Zhongyuan <[email protected]>)
• [ac55d5e] - docs: fix typo in async function (#1657) (BccSafe <[email protected]>)
• [9f362d8] - docs(basics/schedule.md): translate (#1648) (Weilun Xiong <[email protected]>)
• [448d094] - deps: upgrade all plugins to adapt egg@2 (#1653) (Yiyu He <[email protected]>)
• [4993ee8] - docs(quickstart): generator -> async (#1650) (TZ | 天猪 <[email protected]>)
• [8c6f16d] - docs: how to customize error handler (#1651) (Yiyu He <[email protected]>)
• [8e8869a] - refactor: upgrade egg-core@4 (#1631) (Yiyu He <[email protected]>)

Notable changes

• feature

  • upgrade built-in plugins to adapt egg@2

• document

  • translate basics/schedule.md, thanks @Azard
  • change quickstart examples to async function
  • add document for how to customize error handler
  • fix typo in async function

Commits

• [ac55d5e] - docs: fix typo in async function (#1657) (BccSafe <[email protected]>)
• [9f362d8] - docs(basics/schedule.md): translate (#1648) (Weilun Xiong <[email protected]>)
• [448d094] - deps: upgrade all plugins to adapt egg@2 (#1653) (Yiyu He <[email protected]>)
• [4993ee8] - docs(quickstart): generator -> async (#1650) (TZ | 天猪 <[email protected]>)
• [8c6f16d] - docs: how to customize error handler (#1651) (Yiyu He <[email protected]>)

Notable changes

• feature
  • [BREAKING CHANGE] drop node <8 support
  • upgrade to egg-core@4(base on koa 2), but still supports all the usages in egg 1

Commits

• [8e8869a] - refactor: upgrade egg-core@4 (#1631) (Yiyu He <[email protected]>)

Notable changes

• feature
  • export global namespace at d.ts @atian25

Commits

• [b131a4c] - feat: export global namespace at d.ts (#1633) (TZ | 天猪 <[email protected]>)