[ { "path": ".codecov.yml", "content": "coverage:\n parsers:\n javascript:\n enable_partials: yes\n" }, { "path": ".editorconfig", "content": "# editorconfig.org\nroot = true\n\n[*]\nindent_style = space\nindent_size = 2\nend_of_line = lf\ncharset = utf-8\ntrim_trailing_whitespace = true\ninsert_final_newline = true\n\n[*.md]\ntrim_trailing_whitespace = false\n\n[Makefile]\nindent_style = tab\n" }, { "path": ".github/FUNDING.yml", "content": "open_collective: koajs\n" }, { "path": ".github/dependabot.yml", "content": "version: 2\nupdates:\n - package-ecosystem: npm\n directory: \"/\"\n schedule:\n interval: daily\n open-pull-requests-limit: 5\n versioning-strategy: increase-if-necessary\n" }, { "path": ".github/workflows/node.js.yml", "content": "name: Node.js CI\n\non:\n push:\n branches: [master]\n pull_request:\n branches: [master]\n\njobs:\n build:\n\n runs-on: ubuntu-latest\n\n strategy:\n matrix:\n node-version: [18.x, 20.x, 22.x]\n\n steps:\n - uses: actions/checkout@v4\n - name: Use Node.js ${{ matrix.node-version }}\n uses: actions/setup-node@v4\n with:\n node-version: ${{ matrix.node-version }}\n - run: npm ci\n - run: npm run lint\n - run: npm run test:coverage\n - name: Upload coverage to Codecov\n uses: codecov/codecov-action@v5\n with:\n token: ${{ secrets.CODECOV_TOKEN }}\n" }, { "path": ".github/workflows/npm-publish.yml", "content": "name: NPM Publish\n\n# Trigger when tags matching semver format are pushed, or manually via workflow_dispatch.\n# Manual triggers allow selecting a specific tag to publish (e.g. tags from the v2.x branch).\n#\n# Patterns match common semver formats:\n# - v1.0.0 (standard)\n# - v1.0.0-alpha (pre-release)\n# - v1.0.0-beta.1 (pre-release with number)\n#\n# Note: GitHub Actions uses glob patterns (not full regex), which limits\n# complex semver matching. These patterns cover most npm publishing scenarios.\n# For complex dotted pre-releases (v1.0.0-alpha.beta.1), use simpler formats\n# like v1.0.0-alphabeta1 or create the workflow manually.\n\"on\":\n push:\n tags:\n - 'v[0-9]+.[0-9]+.[0-9]+'\n - 'v[0-9]+.[0-9]+.[0-9]+-[a-zA-Z0-9]+'\n - 'v[0-9]+.[0-9]+.[0-9]+-[a-zA-Z0-9]+.[0-9]+'\n workflow_dispatch:\n inputs:\n tag:\n description: 'Git tag to checkout and publish (e.g. v2.15.4)'\n required: true\n type: string\n\n# Permissions for NPM trusted publishing with provenance\npermissions:\n contents: read\n id-token: write\n\njobs:\n publish:\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5\n with:\n ref: ${{ inputs.tag || github.ref }}\n \n - name: Setup Node.js\n uses: actions/setup-node@2028fbc5c25fe9cf00d9f06a71cc4710d4507903 #v6\n with:\n node-version: 22\n\n - name: Install npm@latest\n run: npm install -g npm@latest\n \n - name: Install dependencies\n run: npm ci\n \n - name: Publish to NPM\n run: npm publish\n" }, { "path": ".gitignore", "content": "node_modules\ntest.js\ncoverage\nnpm-debug.log\n.idea\n*.iml\ndist\n" }, { "path": ".mailmap", "content": "Michał Gołębiowski-Owczarek \n" }, { "path": "AUTHORS", "content": "小菜 \nAaron Heckmann \nAdam L \nAdam Lau \nAesop Wolf \nAlexeyKhristov \nAlexsey \nAmit Portnoy \nAnton Harniakou \nArjun \nAsiel Leal \nAvindra Goolcharan \nBartol Karuza \nBen Reinhart \nBernie Stern \nBryan Bess \nC.T. Lin \nChiahao Lin \nChris Tarquini \nChristoffer Hallas \nClark Du \nDarren Cauthon \nDebjeet Biswas \nDmitry Mazuro \nDouglas Christopher Wilson \nEivind Fjeldstad \nEquim \nFangdun Cai \nFelix Becker \nFilip Skokan \nFrancisco Presencia \nGao Sheng \nGeorge Chung \nGilles De Mey \nGrand \nGuilherme Pacheco \nHanHor Wu \nHartley Melamed \nHrvoje Šimić \nHugh Kennedy \nIan Storm Taylor \nIlkka Oksanen \nIvan Kleshnin \nIvan Lyons \nJacob Bass \nJamesWang \nJan Buschtöns \nJan Carlo Viray \nJason Macgowan \nJed Schmidt \nJeff Moore \nJesus Rodriguez \nJesús Rodríguez Rodríguez \nJingwei \"John\" Liu \nJohan Bergström \nJonas Zhang <106856363@qq.com>\nJonathan Ong \nJonathan Ong \nJoseph Lin \nJulian Gruber \nKareem Kwong \nKarl Böhlmark \nKenneth Ormandy \nKim Joar Bekkelund \nKwyn Alice Meagher \nKyle Suss \nLee Bousfield \nLouis DeScioli \nLuke Bousfield \nMalcolm \nMarceli.no \nMars Wong \nMartin Iwanowski \nMartin Iwanowski \nMartin fl0w Iwanowski \nMatheus Azzi \nMathieu Gallé-Tessonneau \nMatthew Chase Whittemore \nMatthew King \nMatthew Mueller \nMengdi Gao \nMichaël Zasso \nMichał Gołębiowski-Owczarek \nNathan Rajlich \nNew Now Nohow \nNick McCurdy \nNicolae Vartolomei \nPatrickJS \nPaul Anderson \nPedro Pablo Aste Kompen \nPeeyush Kushwaha \nPhillip Alexander \nPlasmaPower \nPrayag Verma \nQiming zhao \nRemek Ambroziak \nRiceball LEE \nRichard Marmorstein \nRico Sta. Cruz \nRobert Sköld \nRobin Pokorný \nRuben Bridgewater \nRui Marinho \nRui Marinho \nRyunosuke SATO \nSaad Quadri \nSantiago Sotomayor \nSergei Osipov \nShaun Warman \nShawn Cheung <958033967@qq.com>\nShawn Sit \nSlobodan Stojanovic \nSonny Piers \nSterling Williams \nStéphane Bisinger \nTJ Holowaychuk \nTJ Holowaychuk \nTaehwan, No \nTejas Manohar \nTeoman Soygul \nThiago Lagden \nTiago Ribeiro \nTim Schaub \nTodor Stoychev \nTomas Ruud \nTravis Jeffery \nUsman Hussain \nVeselin Todorov \nWang Dàpéng \nXavier Damman \nXiang Gao \nYanick Rochon \nYazhong Liu \nYazhong Liu \nYiyu He \nYiyu He \nYoshua Wuyts \nYu Qi \nYu Qi \nZack Tanner \nalsotang \nbananaappletw \nbhanuc \nblaz \nbroucz \nd3v \ndead-horse \ndead_horse \ndesigngrill \nfengmk2 \nfengmk2 \nfrank \nfundon \ngyson \nhaoxin \nhaoxin \niamchenxin \ninitial-wu \njeromew \njoehecn \njongleberry \njongleberry \nllambda \nmako-taco \nmdemo \nnicoder \nnswbmw \npana \nqingming <358242939@qq.com>\nsong \nsuperchink \ntmilewski \nyoshuawuyts \nyosssi \nzensh \nziyunfei <446240525@qq.com>\n石发磊 \n" }, { "path": "CODE_OF_CONDUCT.md", "content": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as\ncontributors and maintainers pledge to making participation in our project and\nour community a harassment-free experience for everyone, regardless of age, body\nsize, disability, ethnicity, gender identity and expression, level of experience,\nnationality, personal appearance, race, religion, or sexual identity and\norientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment\ninclude:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or\nadvances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic\n address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a\n professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable\nbehavior and are expected to take appropriate and fair corrective action in\nresponse to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or\nreject comments, commits, code, wiki edits, issues, and other contributions\nthat are not aligned to this Code of Conduct, or to ban temporarily or\npermanently any contributor for other behaviors that they deem inappropriate,\nthreatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces\nwhen an individual is representing the project or its community. Examples of\nrepresenting a project or community include using an official project e-mail\naddress, posting via an official social media account, or acting as an appointed\nrepresentative at an online or offline event. Representation of a project may be\nfurther defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be\nreported by contacting the project team at tj@tjholowaychuk.com. All\ncomplaints will be reviewed and investigated and will result in a response that\nis deemed necessary and appropriate to the circumstances. The project team is\nobligated to maintain confidentiality with regard to the reporter of an incident.\nFurther details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good\nfaith may face temporary or permanent repercussions as determined by other\nmembers of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,\navailable at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n" }, { "path": "History.md", "content": "\n> [!IMPORTANT]\n> Moving forwards we are using the GitHub releases page at in combination with [np](https://www.npmjs.com/package/np) for publishing releases and their changelogs.\n\n---\n\n3.0.0-alpha.3 / 2025-02-11\n==================\n\n**fixes**\n- Avoid redos on host and protocol getter\n\n3.0.0-alpha.2 / 2024-11-04\n==================\n\n**breaking changes**\n- Update `http-errors` to `v2.0.0` [#1486](https://github.com/koajs/koa/pull/1486)\n - `ctx.throw` now requires a format of `ctx.throw(status, error, properties)`. See: https://www.npmjs.com/package/http-errors\n- Remove `res.redirect('back')`, add `back()` method to `ctx` [#1115](https://github.com/koajs/koa/pull/1115)\n- Replace node querystring with `URLSearchParams` [#1828](https://github.com/koajs/koa/pull/1828)\n- Remove obsolete `createAsyncCtxStorageMiddleware` [#1817](https://github.com/koajs/koa/pull/1817)\n\n**features**\n- Add support for web WHATWG [#1830](https://github.com/koajs/koa/pull/1830)\n\n**updates**\n- Update `cookies` to `~0.9.1` [#1846](https://github.com/koajs/koa/pull/1846)\n- Update `statuses` to `^2.0.1`\n- Update `supertest` to `^7.0.0` [#1841](https://github.com/koajs/koa/pull/1841)\n\n**fixes**\n- Fix `exports.defaults` in `package.json` [#1630](https://github.com/koajs/koa/pull/1630)\n- Fix leaky handles in tests [#1838](https://github.com/koajs/koa/pull/1838)\n- Fix body null checks [#1814](https://github.com/koajs/koa/pull/1814)\n- Fix reformatting redirect URLs [#1805](https://github.com/koajs/koa/pull/1805) [#1804](https://github.com/koajs/koa/pull/1804)\n- Fix passing `ctx` in error handler [#1758](https://github.com/koajs/koa/pull/1758)\n\n**migrations**\n- Migrate from `jest` to the native node test runner [#1845](https://github.com/koajs/koa/pull/1845)\n\n3.0.0-alpha.1 / 2023-04-12\n==================\n\n**fixes**\n * [[`e98b8d1`](http://github.com/koajs/koa/commit/e98b8d1918376dc2957aa62906bf5893bef66c4c)] - fix: can not get currentContext in error handler (#1758) (Gxkl <>)\n\n3.0.0-alpha.0 / 2023-01-02\n==================\n\n## Breaking Changes\n\n- Supports node@12+ only.\n- Removes generator deprecation messages.\n Generators are no longer supported.\n Koa no longer asserts if generators are used.\n- Set `content-length: 0` if body is explicitly set to `null` @ognjenjevremovic #1528\n\n## Features\n\n- Use asyncLocalStorage to get current context from app, e.g.: `const ctx = app.currentContext`.\n\n## Fixes\n\n- fix: Do not response Content-Length if Transfer-Encoding is defined #1562 @charlyzeng\n- fix: Set body to `null` if `ctx.type = json` and `ctx.body = null` #1059 @likegun\n\n2.13.1 / 2021-01-04\n==================\n\n**fixes**\n * [[`b5472f4`](http://github.com/koajs/koa/commit/b5472f4cbb87349becae36b4a9ad5f76a825abb8)] - fix: make ESM transpiled CommonJS play nice for TS folks, fix #1513 (#1518) (miwnwski <>)\n * [[`68d97d6`](http://github.com/koajs/koa/commit/68d97d69e4536065504bf9ef1e348a66b3f35709)] - fix: fixed order of vulnerability disclosure addresses (niftylettuce <>)\n\n**others**\n * [[`b4398f5`](http://github.com/koajs/koa/commit/b4398f5d68f9546167419f394a686afdcb5e10e2)] - correct verb tense in doc (#1512) (Matan Shavit <<71092861+matanshavit@users.noreply.github.com>>)\n * [[`39e1a5a`](http://github.com/koajs/koa/commit/39e1a5a380aa2bbc4e2d164e8e4bf37cfd512516)] - fixed multiple grammatical errors in docs. (#1497) (Hridayesh Sharma <>)\n * [[`aeb5d19`](http://github.com/koajs/koa/commit/aeb5d1984dcc5f8e3386f8f9724807ae6f3aa1c4)] - docs: added niftylettuce@gmail.com to vulnerability disclosure (niftylettuce <>)\n * [[`6e1093b`](http://github.com/koajs/koa/commit/6e1093be27b41135c8e67fce108743d54e9cab67)] - docs: remove babel from readme (#1494) (miwnwski <>)\n * [[`38cb591`](http://github.com/koajs/koa/commit/38cb591254ff5f65a04e8fb57be293afe697c46e)] - docs: update specific for auto response status (AlbertAZ1992 <>)\n * [[`2224cd9`](http://github.com/koajs/koa/commit/2224cd9b6a648e7ac2eb27eac332e7d6de7db26c)] - docs: remove babel ref. (#1488) (Imed Jaberi <>)\n * [[`d51f983`](http://github.com/koajs/koa/commit/d51f98328c3b84493cc6bda0732aabb69e20e3a1)] - docs: fix assert example for response (#1489) (Imed Jaberi <>)\n * [[`f8b49b8`](http://github.com/koajs/koa/commit/f8b49b859363ad6c3d9ea5c11ee62341407ceafd)] - chore: fix grammatical and spelling errors in comments and tests (#1490) (Matt Kubej <>)\n * [[`d1c9263`](http://github.com/koajs/koa/commit/d1c92638c95d799df2fdff5576b96fc43a62813f)] - deps: update depd >> v2.0.0 (#1482) (imed jaberi <>)\n\n2.13.0 / 2020-06-21\n==================\n\n**features**\n * [[`bbcde76`](http://github.com/koajs/koa/commit/bbcde76f5cb5b67bbcd3201791cf0ef648fd3a8b)] - feat: support esm (#1474) (ZYSzys <>)\n\n**others**\n * [[`20e58cf`](http://github.com/koajs/koa/commit/20e58cf3e4f20fc5d5886df1d0ac6dd8c33bd202)] - test: imporve coverage to 100% (dead-horse <>)\n * [[`4a40d63`](http://github.com/koajs/koa/commit/4a40d633c4b4a203c6656078f9952ccef65c5875)] - build: use prepare instead of prepublish (dead-horse <>)\n * [[`226ba8c`](http://github.com/koajs/koa/commit/226ba8c8e81e83da48e7bf137be3f146d03f40b8)] - build: use prepublish instead of prepack (dead-horse <>)\n\n2.12.1 / 2020-06-13\n==================\n\n**fixes**\n * [[`e2030c7`](http://github.com/koajs/koa/commit/e2030c7249c7ae24e28158d8eae405a02fefc9f8)] - fix: Improve checks for Error in onerror handlers (#1468) (Julien Wajsberg <>)\n\n**others**\n * [[`5208c5e`](http://github.com/koajs/koa/commit/5208c5e15d35b3653fce6b8ed68d09865abea843)] - chore: Use single console.error() statement in error handler (#1471) (Mike Vosseller <>)\n\n2.12.0 / 2020-05-18\n==================\n\n**features**\n * [[`0d2f421`](http://github.com/koajs/koa/commit/0d2f421c265350d3d84e1bc261572954479f27d3)] - feat: error handler treat err.statusCode as the same as err.status (#1460) (Vijay Krishnavanshi <>)\n * [[`8d52105`](http://github.com/koajs/koa/commit/8d52105a34234be9e771ff3b76b43e4e30328943)] - feat: allow bodyless responses for non empty status codes (#1447) (ejose19 <<8742215+ejose19@users.noreply.github.com>>)\n\n**others**\n * [[`faeaff5`](http://github.com/koajs/koa/commit/faeaff5c149a81a188ab8e5af0b994029e45acbb)] - fox: remove `error-inject` and fix error handling (#1409) (Konstantin Vyatkin <>)\n * [[`f7c732f`](http://github.com/koajs/koa/commit/f7c732fd06f724505e9090add4d977e667da55a8)] - docs: fixed incorrect onerror example (#1459) (Paul Annekov <>)\n * [[`143d8f7`](http://github.com/koajs/koa/commit/143d8f72f2a232b4c97eac00e7811015911e4f7c)] - Always use strict equality. (#1225) (Yazan Medanat <>)\n * [[`6b6b0dd`](http://github.com/koajs/koa/commit/6b6b0ddf7aff073e65493c6efaffab8331c0331c)] - docs(api): add app.use chainability note (#1449) (Zac Anger <>)\n * [[`8ddab48`](http://github.com/koajs/koa/commit/8ddab48cbdbca1e6d1cc8c3ddae45491db524d51)] - docs: Document response status with empty body (#1445) (Marc-Aurèle DARCHE <<152407+madarche@users.noreply.github.com>>)\n * [[`7deedb2`](http://github.com/koajs/koa/commit/7deedb235274223f1b9da46dee296545b23598de)] - docs: Updating context.md with the latest cookies opts (#1433) (Brad Ito <>)\n * [[`3e97a10`](http://github.com/koajs/koa/commit/3e97a106bb846d9337737011bb85149ddd797229)] - docs(links): remove Google+ link (#1439) (laffachan <<45162759+laffachan@users.noreply.github.com>>)\n * [[`eda2760`](http://github.com/koajs/koa/commit/eda27608f7d39ede86d7b402aae64b1867ce31c6)] - build: Drop unused Travis sudo: false directive (#1416) (Olle Jonsson <>)\n\n2.11.0 / 2019-10-28\n==================\n\n**features**\n * [[`422e539`](http://github.com/koajs/koa/commit/422e539e8989e65ba43ecc39ddbaa3c4f755d465)] - feat: support app.proxyIPHeader and app.maxIpsCount to make ctx.ips more security (Yiyu He <>)\n * [[`d48d88e`](http://github.com/koajs/koa/commit/d48d88ee17b780c02123e6d657274cab456e943e)] - feat: implement response.has (#1397) (Konstantin Vyatkin <>)\n\n**others**\n * [[`4dc56f6`](http://github.com/koajs/koa/commit/4dc56f6d04e8f5fe12ba53a8a776653b3d7b60ed)] - chore: update ESLint and plugins/configs (#1407) (Konstantin Vyatkin <>)\n * [[`be7d334`](http://github.com/koajs/koa/commit/be7d334778481639294cdf87f5c359a230aeb65b)] - chore: removes code duplication at handling HEAD method (#1400) (Konstantin Vyatkin <>)\n * [[`f155785`](http://github.com/koajs/koa/commit/f155785e2bb42b5ddf0a8156401c6dafdf57ba8b)] - chore: support `writableEnded` (#1402) (Konstantin Vyatkin <>)\n * [[`b968688`](http://github.com/koajs/koa/commit/b968688afe2c727ae141f50aa983d481dbc1dbbf)] - chore: add FUNDING.yml (#1403) (Konstantin Vyatkin <>)\n * [[`4f96829`](http://github.com/koajs/koa/commit/4f968298f97394e488297ec32c8e927a3a322076)] - chore: remove isJSON in res.length (#1399) (Konstantin Vyatkin <>)\n * [[`8be5626`](http://github.com/koajs/koa/commit/8be5626bbb54e6c899a1b71d22411709126d9fea)] - build: enable codecov partial coverage and use bash uploader (#1396) (Konstantin Vyatkin <>)\n * [[`ef5c43b`](http://github.com/koajs/koa/commit/ef5c43bcbcf31819e032c3b7ae7654b7f8e9358b)] - chore: use rest params (#1393) (Konstantin Vyatkin <>)\n\n2.10.0 / 2019-10-12\n==================\n\n**features**\n * [[`d7f7f77`](http://github.com/koajs/koa/commit/d7f7f77689e2eaef050686be2bdf3e72881a79ac)] - feat: support sameSite=none cookies (bump cookies dependency) (#1390) (Filip Skokan <>)\n\n2.9.0 / 2019-10-12\n==================\n\n**features**\n * [[`2d1c598`](http://github.com/koajs/koa/commit/2d1c5981869e0fe6f5bc71b5c5582accfd125cc6)] - feat: export HttpError from http-errors library (Micheal Hill <>)\n\n**others**\n * [[`cf70dbc`](http://github.com/koajs/koa/commit/cf70dbc6d2ba62bf1eb12b563dd5ecd27af6e2be)] - Chore: Use https in readme (#1389) (谭九鼎 <<109224573@qq.com>>)\n\n2.8.2 / 2019-09-28\n==================\n\n**fixes**\n * [[`54e8fab`](http://github.com/koajs/koa/commit/54e8fab3e3d907bbb264caf3e28a24773d0d6fdb)] - fix: encode redirect url if not already encoded (#1384) (fengmk2 <>)\n\n**others**\n * [[`817b498`](http://github.com/koajs/koa/commit/817b49830571b45a8aec6b1fc1525434f5798c58)] - test: fix body test (#1375) (Robert Nagy <>)\n * [[`f75d445`](http://github.com/koajs/koa/commit/f75d4455359ecdf30eeb676e2c7f31d4cf7b42ed)] - test: fix end after end (#1374) (Robert Nagy <>)\n\n2.8.1 / 2019-08-19\n==================\n\n**fixes**\n * [[`287e589`](http://github.com/koajs/koa/commit/287e589ac773d3738b2aa7d40e0b6d43dde5261b)] - fix: make options more compatibility (dead-horse <>)\n\n2.8.0 / 2019-08-19\n==================\n\n**features**\n * [[`5afff89`](http://github.com/koajs/koa/commit/5afff89eca0efe7081309dc2d123309e825df221)] - feat: accept options in the Application constructor (#1372) (Jake <>)\n\n**fixes**\n * [[`ff70bdc`](http://github.com/koajs/koa/commit/ff70bdc75a30a37f63fc1f7d8cbae3204df3d982)] - fix: typo on document (#1355) (Jeff <>)\n\n**others**\n * [[`3b23865`](http://github.com/koajs/koa/commit/3b23865340cfba075f61f7dba0ea31fcc27260ec)] - docs: parameter of request.get is case-insensitive (#1373) (Gunnlaugur Thor Briem <>)\n * [[`a245d18`](http://github.com/koajs/koa/commit/a245d18a131341feec4f87659746954e78cae780)] - docs: Update response.socket (#1357) (Jeff <>)\n * [[`d1d65dd`](http://github.com/koajs/koa/commit/d1d65dd29d7bbaf9ea42eaa5fcb0da3fb4df98e9)] - chore(deps): install egg-bin, mm as devDeps not deps (#1366) (Edvard Chen <>)\n * [[`2c86b10`](http://github.com/koajs/koa/commit/2c86b10feafd868ebd071dda3a222e6f51972b5d)] - test: remove jest and use egg-bin(mocha) (#1363) (Yiyu He <>)\n * [[`219bf22`](http://github.com/koajs/koa/commit/219bf22237b11bc375e2e110b93db512f1acfdd4)] - docs(context): update link (#1354) (Peng Jie <>)\n * [[`52a6737`](http://github.com/koajs/koa/commit/52a673703a87a93c0f6a8552e6bd73caba66d2eb)] - chore: ignore Intellij IDEA project files (#1361) (Imon-Haque <<38266345+Imon-Haque@users.noreply.github.com>>)\n * [[`b9e3546`](http://github.com/koajs/koa/commit/b9e35469d3bbd0a1ee92e0a815ce2512904d4a18)] - docs(api): fix keygrip link (#1350) (Peng Jie <>)\n * [[`d4bdb5e`](http://github.com/koajs/koa/commit/d4bdb5ed9e2fe06ec44698b66c029f624135a0ab)] - chore: update eslint and fix lint errors (dead-horse <>)\n * [[`12960c4`](http://github.com/koajs/koa/commit/12960c437cc25c53e682cfe5bff06d74a5bb1eb9)] - build: test on 8/10/12 (dead-horse <>)\n * [[`00e8f7a`](http://github.com/koajs/koa/commit/00e8f7a1b7603aabdb7fb3567f485cb1c2076702)] - docs: ctx.type aliases ctx.response, not ctx.request (#1343) (Alex Berk <>)\n * [[`62f29eb`](http://github.com/koajs/koa/commit/62f29eb0c4dee01170a5511615e5bcc9faca26ca)] - docs(context): update cookies link (#1348) (Peng Jie <>)\n * [[`b7fc526`](http://github.com/koajs/koa/commit/b7fc526ea49894f366153bd32997e02568c0b8a6)] - docs: fix typo in cookie path default value docs (#1340) (Igor Adamenko <>)\n * [[`23f7f54`](http://github.com/koajs/koa/commit/23f7f545abfe1fb6499cd61cc8ff41fd86cef4a0)] - chore: simplify variable (#1332) (kzhang <>)\n * [[`132c9ee`](http://github.com/koajs/koa/commit/132c9ee63f92a586a120ed3bd6b7ef023badb8bb)] - docs: Clarify the format of request.headers (#1325) (Dobes Vandermeer <>)\n * [[`5810f27`](http://github.com/koajs/koa/commit/5810f279a4caeda115f39e429c9671795613abf8)] - docs: Removed Document in Progress note in Koa vs Express (#1336) (Andrew Peterson <>)\n * [[`75233d9`](http://github.com/koajs/koa/commit/75233d974a30af6e3b8ab38a73e5ede67172fc1c)] - chore: Consider removing this return statement; it will be ignored. (#1322) (Vern Brandl <>)\n * [[`04e07fd`](http://github.com/koajs/koa/commit/04e07fdc620841068f12b8edf36f27e6592a0a18)] - test: Buffer() is deprecated due to security and usability issues. so use the Buffer.alloc() instead (#1321) (Vern Brandl <>)\n * [[`130e363`](http://github.com/koajs/koa/commit/130e363856747b487652f04b5550056d7778e43a)] - docs: use 'fs-extra' instead of 'fs-promise' (#1309) (rosald <<35028438+rosald@users.noreply.github.com>>)\n * [[`2f2078b`](http://github.com/koajs/koa/commit/2f2078bf998bd3f44289ebd17eeccf5e12e4c134)] - chore: Update PR-welcome badge url (#1299) (James George <>)\n\n2.7.0 / 2019-01-28\n==================\n\n**features**\n * [[`b7bfa71`](http://github.com/koajs/koa/commit/b7bfa7113b8d1af49a57ab767f24a599ed92044f)] - feat: change set status assert, allowing valid custom statuses (#1308) (Martin Iwanowski <>)\n\n**others**\n * [[`72f325b`](http://github.com/koajs/koa/commit/72f325b78edd0dc2aac940a76ce5f644005ce4c3)] - chore: add pr welcoming badge (#1291) (James George <>)\n * [[`b15115b`](http://github.com/koajs/koa/commit/b15115b2cbfffe15827cd5e4368267d417b72f08)] - chore: Reduce unnecessary variable declarations (#1298) (call me saisai <<1457358080@qq.com>>)\n * [[`ad91ce2`](http://github.com/koajs/koa/commit/ad91ce2346cb34e5d5a49d07dd952d15f6c832a3)] - chore: license 2019 (dead-horse <>)\n * [[`b25e79d`](http://github.com/koajs/koa/commit/b25e79dfb599777a38157bd419395bd28369ee86)] - Mark two examples as live for the corresponding documentation change in https://github.com/koajs/koajs.com/pull/38. (#1031) (Francisco Ryan Tolmasky I <>)\n * [[`d9ef603`](http://github.com/koajs/koa/commit/d9ef60398e88f2c2f958ab2b159d38052ffe7f8a)] - chore: Optimize array split (#1295) (Mikhail Bodrov <>)\n * [[`9be8583`](http://github.com/koajs/koa/commit/9be858312553002841725b617050aaff3c48951d)] - chore: replace ~~ with Math.trunc in res.length (option) (#1288) (jeremiG <>)\n * [[`7e46c20`](http://github.com/koajs/koa/commit/7e46c2058cb5994809eab5f4dbb12f21e937c72b)] - docs: add link to the license file (#1290) (James George <>)\n * [[`48993ad`](http://github.com/koajs/koa/commit/48993ade9b0831fbce28d94b3b0963a4b0dccbdd)] - docs: Document other body types (#1285) (Douglas Wade <>)\n * [[`acb388b`](http://github.com/koajs/koa/commit/acb388bc0546b48fca11dce8aa7a595af2cda5e2)] - docs: Add security vulnerability disclosure instructions to the Readme (#1283) (Douglas Wade <>)\n * [[`a007198`](http://github.com/koajs/koa/commit/a007198fa23c19902b1f3ffb81498629e0e9c875)] - docs: Document ctx.app.emit (#1284) (Douglas Wade <>)\n * [[`f90e825`](http://github.com/koajs/koa/commit/f90e825da9d505c11b4262c50cd54553f979c300)] - docs: response.set(fields) won't overwrites previous header fields(#1282) (Douglas Wade <>)\n * [[`fc93c05`](http://github.com/koajs/koa/commit/fc93c05f68398f30abc46fd16ae6c673a1eee099)] - docs: update readme to add babel 7 instructions (#1274) (Vikram Rangaraj <>)\n * [[`5560f72`](http://github.com/koajs/koa/commit/5560f729124f022ffed00085aafea43dded7fb03)] - chore: use the ability of `content-type` lib directly (#1276) (Jordan <>)\n\n2.6.2 / 2018-11-10\n==================\n\n**fixes**\n * [[`9905199`](http://github.com/koajs/koa/commit/99051992a9f45eb0dd79e062681d6f5d366deb41)] - fix: Status message is not supported on HTTP/2 (#1264) (André Cruz <>)\n\n**others**\n * [[`325792a`](http://github.com/koajs/koa/commit/325792aee92de0ba6fea306657933fc63dc00474)] - docs: add table of contents for guide.md (#1267) (ZYSzys <>)\n * [[`71aaa29`](http://github.com/koajs/koa/commit/71aaa29591d6681f8579486f18d32ba1ee651a5b)] - docs: fix spelling in throw docs (#1269) (Martin Iwanowski <>)\n * [[`bc81ca9`](http://github.com/koajs/koa/commit/bc81ca9414296234c764b7306a19ba72b2e59b52)] - chore: use res instead of this.res (#1271) (Jordan <>)\n * [[`0251b38`](http://github.com/koajs/koa/commit/0251b38a8405471892c5eeaba7c8d54bd7028214)] - test: node v11 on travis (#1265) (Martin Iwanowski <>)\n * [[`88b92b4`](http://github.com/koajs/koa/commit/88b92b43153f21609aee71d47abcd4dc27a6586d)] - doc: updated docs for throw() to pass status as first param. (#1268) (Waleed Ashraf <>)\n\n2.6.1 / 2018-10-23\n==================\n\n**fixes**\n * [[`4964242`](http://github.com/koajs/koa/commit/49642428342e5f291eb9d690802e83ed830623b5)] - fix: use X-Forwarded-Host first on app.proxy present (#1263) (fengmk2 <>)\n\n2.6.0 / 2018-10-23\n==================\n\n**features**\n * [[`9c5c58b`](http://github.com/koajs/koa/commit/9c5c58b18363494976185e7ddc790ac63de840ed)] - feat: use :authority header of http2 requests as host (#1262) (Martin Michaelis <>)\n * [[`9146024`](http://github.com/koajs/koa/commit/9146024e1094e8bb871ab15d1b7fc556a710732f)] - feat: response.attachment append a parameter: options from contentDisposition (#1240) (小雷 <<863837949@qq.com>>)\n\n**others**\n * [[`d32623b`](http://github.com/koajs/koa/commit/d32623baa7a6273d47be67d587ad4ea0ecffc5de)] - docs: Update error-handling.md (#1239) (urugator <>)\n\n2.5.3 / 2018-09-11\n==================\n\n**fixes**\n * [[`2ee32f5`](http://github.com/koajs/koa/commit/2ee32f50b88b383317e33cc0a4bfaa5f2eadead7)] - fix: pin debug@~3.1.0 avoid deprecated warnning (#1245) (fengmk2 <>)\n\n**others**\n * [[`2180839`](http://github.com/koajs/koa/commit/2180839eda2cb16edcfda46ccfe24711680af850)] - docs: Update koa-vs-express.md (#1230) (Clayton Ray <>)\n\n2.5.2 / 2018-07-12\n==================\n\n * deps: upgrade all dependencies\n * perf: avoid stringify when set header (#1220)\n * perf: cache content type's result (#1218)\n * perf: lazy init cookies and ip when first time use it (#1216)\n * chore: fix comment & approve cov (#1214)\n * docs: fix grammar\n * test&cov: add test case (#1211)\n * Lazily initialize `request.accept` and delegate `context.accept` (#1209)\n * fix: use non deprecated custom inspect (#1198)\n * Simplify processes in the getter `request.protocol` (#1203)\n * docs: better demonstrate middleware flow (#1195)\n * fix: Throw a TypeError instead of a AssertionError (#1199)\n * chore: mistake in a comment (#1201)\n * chore: use this.res.socket insteadof this.ctx.req.socket (#1177)\n * chore: Using \"listenerCount\" instead of \"listeners\" (#1184)\n\n2.5.1 / 2018-04-27\n==================\n\n * test: node v10 on travis (#1182)\n * fix tests: remove unnecessary assert doesNotThrow and api calls (#1170)\n * use this.response insteadof this.ctx.response (#1163)\n * deps: remove istanbul (#1151)\n * Update guide.md (#1150)\n\n2.5.0 / 2018-02-11\n==================\n\n * feat: ignore set header/status when header sent (#1137)\n * run coverage using --runInBand (#1141)\n * [Update] license year to 2018 (#1130)\n * docs: small grammatical fix in api docs index (#1111)\n * docs: fixed typo (#1112)\n * docs: capitalize K in word koa (#1126)\n * Error handling: on non-error throw try to stringify if error is an object (#1113)\n * Use eslint-config-koa (#1105)\n * Update mgol's name in AUTHORS, add .mailmap (#1100)\n * Avoid generating package locks instead of ignoring them (#1108)\n * chore: update copyright year to 2017 (#1095)\n\n\n2.4.1 / 2017-11-06\n==================\n\n * fix bad merge w/ 2.4.0\n\n2.4.0 / 2017-11-06\n==================\n\nUNPUBLISHED\n\n * update `package.engines.node` to be more strict\n * update `fresh@^0.5.2`\n * fix: `inspect()` no longer crashes `context`\n * fix: gated `res.statusMessage` for HTTP/2\n * added: `app.handleRequest()` is exposed\n\n2.3.0 / 2017-06-20\n==================\n\n * fix: use `Buffer.from()`\n * test on node 7 & 8\n * add `package-lock.json` to `.gitignore`\n * run `lint --fix`\n * add `request.header` in addition to `request.headers`\n * add IPv6 hostname support\n\n2.2.0 / 2017-03-14\n==================\n\n * fix: drop `package.engines.node` requirement to >= 6.0.0\n * this fixes `yarn`, which errors when this semver range is not satisfied\n * bump `cookies@~0.7.0`\n * bump `fresh@^0.5.0`\n\n2.1.0 / 2017-03-07\n==================\n\n * added: return middleware chain promise from `callback()` #848\n * added: node v7.7+ `res.getHeaderNames()` support #930\n * added: `err.headerSent` in error handling #919\n * added: lots of docs!\n\n2.0.1 / 2017-02-25\n==================\n\nNOTE: we hit a versioning snafu. `v2.0.0` was previously released,\nso `v2.0.1` is released as the first `v2.x` with a `latest` tag.\n\n * upgrade mocha #900\n * add names to `application`'s request and response handlers #805\n * breaking: remove unused `app.name` #899\n * breaking: drop official support for node < 7.6\n\n2.0.0 / ??????????\n==================\n\n * Fix malformed content-type header causing exception on charset get (#898)\n * fix: subdomains should be [] if the host is an ip (#808)\n * don't pre-bound onerror [breaking change] (#800)\n * fix `ctx.flushHeaders()` to use `res.flushHeaders()` instead of `res.writeHead()` (#795)\n * fix(response): correct response.writable logic (#782)\n * merge v1.1.2 and v1.2.0 changes\n * include `koa-convert` so that generator functions still work\n * NOTE: generator functions are deprecated in v2 and will be removed in v3\n * improve linting\n * improve docs\n\n2.0.0-alpha.8 / 2017-02-13\n==================\n\n * Fix malformed content-type header causing exception on charset get (#898)\n\n2.0.0-alpha.7 / 2016-09-07\n==================\n\n * fix: subdomains should be [] if the host is an ip (#808)\n\n2.0.0-alpha.6 / 2016-08-29\n==================\n\n * don't pre-bound onerror [breaking change]\n\n2.0.0-alpha.5 / 2016-08-10\n==================\n\n * fix `ctx.flushHeaders()` to use `res.flushHeaders()` instead of `res.writeHead()`\n\n2.0.0-alpha.4 / 2016-07-23\n==================\n\n * fix `response.writeable` during pipelined requests\n\n1.2.0 / 2016-03-03\n==================\n\n * add support for `err.headers` in `ctx.onerror()`\n - see: https://github.com/koajs/koa/pull/668\n - note: you should set these headers in your custom error handlers as well\n - docs: https://github.com/koajs/koa/blob/master/docs/error-handling.md\n * fix `cookies`' detection of http/https\n - see: https://github.com/koajs/koa/pull/614\n * deprecate `app.experimental = true`. Koa v2 does not use this signature.\n * add a code of conduct\n * test against the latest version of node\n * add a lot of docs\n\n1.1.2 / 2015-11-05\n==================\n\n * ensure parseurl always working as expected\n * fix Application.inspect() – missing .proxy value.\n\n2.0.0-alpha.3 / 2015-11-05\n==================\n\n * ensure parseurl always working as expected. #586\n * fix Application.inspect() – missing .proxy value. Closes #563\n\n2.0.0-alpha.2 / 2015-10-27\n==================\n\n * remove `co` and generator support completely\n * improved documentation\n * more refactoring into ES6\n\n2.0.0-alpha.1 / 2015-10-22\n==================\n\n * change the middleware signature to `async (ctx, next) => await next()`\n * drop node < 4 support and rewrite the codebase in ES6\n\n1.1.1 / 2015-10-22\n==================\n\n * do not send a content-type when the type is unknown #536\n\n1.1.0 / 2015-10-11\n==================\n\n * add `app.silent=` to toggle error logging @tejasmanohar #486\n * add `ctx.origin` @chentsulin #480\n * various refactoring\n - add `use strict` everywhere\n\n1.0.0 / 2015-08-22\n==================\n\n * add `this.req` check for `querystring()`\n * don't log errors with `err.expose`\n * `koa` now follows semver!\n\n0.21.0 / 2015-05-23\n==================\n\n * empty `request.query` objects are now always the same instance\n * bump `fresh@0.3.0`\n\n0.20.0 / 2015-04-30\n==================\n\nBreaking change if you're using `this.get('ua') === undefined` etc.\nFor more details please checkout [#438](https://github.com/koajs/koa/pull/438).\n\n * make sure helpers return strict string\n * feat: alias response.headers to response.header\n\n0.19.1 / 2015-04-14\n==================\n\n * non-error thrown, fixed #432\n\n0.19.0 / 2015-04-05\n==================\n\n * `req.host` and `req.hostname` now always return a string (semi-breaking change)\n * improved test coverage\n\n0.18.1 / 2015-03-01\n==================\n\n * move babel to `devDependencies`\n\n0.18.0 / 2015-02-14\n==================\n\n * experimental es7 async function support via `app.experimental = true`\n * use `content-type` instead of `media-typer`\n\n0.17.0 / 2015-02-05\n==================\n\nBreaking change if you're using an old version of node v0.11!\nOtherwise, you should have no trouble upgrading.\n\n * official iojs support\n * drop support for node.js `>= 0.11.0 < 0.11.16`\n * use `Object.setPrototypeOf()` instead of `__proto__`\n * update dependencies\n\n0.16.0 / 2015-01-27\n==================\n\n * add `res.append()`\n * fix path usage for node@0.11.15\n\n0.15.0 / 2015-01-18\n==================\n\n * add `this.href`\n\n0.14.0 / 2014-12-15\n==================\n\n * remove `x-powered-by` response header\n * fix the content type on plain-text redirects\n * add ctx.state\n * bump `co@4`\n * bump dependencies\n\n0.13.0 / 2014-10-17\n==================\n\n * add this.message\n * custom status support via `statuses`\n\n0.12.2 / 2014-09-28\n==================\n\n * use wider semver ranges for dependencies koa maintainers also maintain\n\n0.12.1 / 2014-09-21\n==================\n\n * bump content-disposition\n * bump statuses\n\n0.12.0 / 2014-09-20\n==================\n\n * add this.assert()\n * use content-disposition\n\n0.11.0 / 2014-09-08\n==================\n\n * fix app.use() assertion #337\n * bump a lot of dependencies\n\n0.10.0 / 2014-08-12\n==================\n\n * add `ctx.throw(err, object)` support\n * add `ctx.throw(err, status, object)` support\n\n0.9.0 / 2014-08-07\n==================\n\n * add: do not set `err.expose` to true when err.status not a valid http status code\n * add: alias `request.headers` as `request.header`\n * add context.inspect(), cleanup app.inspect()\n * update cookies\n * fix `err.status` invalid lead to uncaughtException\n * fix middleware gif, close #322\n\n0.8.2 / 2014-07-27\n==================\n\n * bump co\n * bump parseurl\n\n0.8.1 / 2014-06-24\n==================\n\n * bump type-is\n\n0.8.0 / 2014-06-13\n==================\n\n * add `this.response.is()``\n * remove `.status=string` and `res.statusString` #298\n\n0.7.0 / 2014-06-07\n==================\n\n * add `this.lastModified` and `this.etag` as both getters and setters for ubiquity #292.\n See koajs/koa@4065bf7 for an explanation.\n * refactor `this.response.vary()` to use [vary](https://github.com/expressjs/vary) #291\n * remove `this.response.append()` #291\n\n0.6.3 / 2014-06-06\n==================\n\n * fix res.type= when the extension is unknown\n * assert when non-error is passed to app.onerror #287\n * bump finished\n\n0.6.2 / 2014-06-03\n==================\n\n * switch from set-type to mime-types\n\n0.6.1 / 2014-05-11\n==================\n\n * bump type-is\n * bump koa-compose\n\n0.6.0 / 2014-05-01\n==================\n\n * add nicer error formatting\n * add: assert object type in ctx.onerror\n * change .status default to 404. Closes #263\n * remove .outputErrors, suppress output when handled by the dev. Closes #272\n * fix content-length when body is re-assigned. Closes #267\n\n0.5.5 / 2014-04-14\n==================\n\n * fix length when .body is missing\n * fix: make sure all intermediate stream bodies will be destroyed\n\n0.5.4 / 2014-04-12\n==================\n\n * fix header stripping in a few cases\n\n0.5.3 / 2014-04-09\n==================\n\n * change res.type= to always default charset. Closes #252\n * remove ctx.inspect() implementation. Closes #164\n\n0.5.2 / 2014-03-23\n==================\n\n * fix: inspection of `app` and `app.toJSON()`\n * fix: let `this.throw`n errors provide their own status\n * fix: overwriting of `content-type` w/ `HEAD` requests\n * refactor: use statuses\n * refactor: use escape-html\n * bump dev deps\n\n0.5.1 / 2014-03-06\n==================\n\n * add request.hostname(getter). Closes #224\n * remove response.charset and ctx.charset (too confusing in relation to ctx.type) [breaking change]\n * fix a debug() name\n\n0.5.0 / 2014-02-19\n==================\n\n * add context.charset\n * add context.charset=\n * add request.charset\n * add response.charset\n * add response.charset=\n * fix response.body= html content sniffing\n * change ctx.length and ctx.type to always delegate to response object [breaking change]\n\n0.4.0 / 2014-02-11\n==================\n\n * remove app.jsonSpaces settings - moved to [koa-json](https://github.com/koajs/json)\n * add this.response=false to bypass koa's response handling\n * fix response handling after body has been sent\n * changed ctx.throw() to no longer .expose 5xx errors\n * remove app.keys getter/setter, update cookies, and remove keygrip deps\n * update fresh\n * update koa-compose\n\n0.3.0 / 2014-01-17\n==================\n\n * add ctx.host= delegate\n * add req.host=\n * add: context.throw supports Error instances\n * update co\n * update cookies\n\n0.2.1 / 2013-12-30\n==================\n\n * add better 404 handling\n * add check for fn._name in debug() output\n * add explicit .toJSON() calls to ctx.toJSON()\n\n0.2.0 / 2013-12-28\n==================\n\n * add support for .throw(status, msg). Closes #130\n * add GeneratorFunction assertion for app.use(). Closes #120\n * refactor: move `.is()` to `type-is`\n * refactor: move content negotiation to \"accepts\"\n * refactor: allow any streams with .pipe method\n * remove `next` in callback for now\n\n0.1.2 / 2013-12-21\n==================\n\n * update co, koa-compose, keygrip\n * use on-socket-error\n * add throw(status, msg) support\n * assert middleware is GeneratorFunction\n * ducktype stream checks\n * remove `next` is `app.callback()`\n\n0.1.1 / 2013-12-19\n==================\n\n * fix: cleanup socker error handler on response\n" }, { "path": "LICENSE", "content": "(The MIT License)\n\nCopyright (c) 2019 Koa contributors\n\nPermission is hereby granted, free of charge, to any person obtaining\na copy of this software and associated documentation files (the\n'Software'), to deal in the Software without restriction, including\nwithout limitation the rights to use, copy, modify, merge, publish,\ndistribute, sublicense, and/or sell copies of the Software, and to\npermit persons to whom the Software is furnished to do so, subject to\nthe following conditions:\n\nThe above copyright notice and this permission notice shall be\nincluded in all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,\nEXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF\nMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.\nIN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY\nCLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,\nTORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE\nSOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n" }, { "path": "Readme.md", "content": "\"Koa\n\n [![gitter][gitter-image]][gitter-url]\n [![NPM version][npm-image]][npm-url]\n [![build status][github-action-image]][github-action-url]\n [![Test coverage][coveralls-image]][coveralls-url]\n [![OpenCollective Backers][backers-image]](#backers)\n [![OpenCollective Sponsors][sponsors-image]](#sponsors)\n [![PR's Welcome][pr-welcoming-image]][pr-welcoming-url]\n\n Expressive HTTP middleware framework for node.js to make web applications and APIs more enjoyable to write. Koa's middleware stack flows in a stack-like manner, allowing you to perform actions downstream then filter and manipulate the response upstream.\n\n Only methods that are common to nearly all HTTP servers are integrated directly into Koa's small ~570 SLOC codebase. This\n includes things like content negotiation, normalization of node inconsistencies, redirection, and a few others.\n\n Koa is not bundled with any middleware.\n\n## Installation\n\nKoa requires __node v18.0.0__ or higher for ES2015 and async function support.\n\n```sh\nnpm install koa\n```\n\n## Hello Koa\n\n```js\nconst Koa = require('koa');\nconst app = new Koa();\n\n// response\napp.use(ctx => {\n ctx.body = 'Hello Koa';\n});\n\napp.listen(3000);\n```\n\n## Getting started\n\n - [Kick-Off-Koa](https://github.com/koajs/kick-off-koa) - An intro to Koa via a set of self-guided workshops.\n - [Guide](docs/guide.md) - Go straight to the docs.\n\n## Middleware\n\nKoa is a middleware framework that can take two different kinds of functions as middleware:\n\n * async function\n * common function\n\nHere is an example of logger middleware with each of the different functions:\n\n### ___async___ functions (node v7.6+)\n\n```js\napp.use(async (ctx, next) => {\n const start = Date.now();\n await next();\n const ms = Date.now() - start;\n console.log(`${ctx.method} ${ctx.url} - ${ms}ms`);\n});\n```\n\n### Common function\n\n```js\n// Middleware normally takes two parameters (ctx, next), ctx is the context for one request,\n// next is a function that is invoked to execute the downstream middleware. It returns a Promise with a then function for running code after completion.\n\napp.use((ctx, next) => {\n const start = Date.now();\n return next().then(() => {\n const ms = Date.now() - start;\n console.log(`${ctx.method} ${ctx.url} - ${ms}ms`);\n });\n});\n```\n\n### Koa v1.x Middleware Signature\n\nThe middleware signature changed between v1.x and v2.x. The older signature is deprecated.\n\n**Old signature middleware support has been removed in v3**\n\nPlease see the [Migration Guide from v2.x to v3.x](docs/migration-v2-to-v3.md) for information on upgrading from v2.x to v3.x, and the [Migration Guide from v1.x to v2.x](docs/migration-v1-to-v2.md) for information on upgrading from v1.x to v2.x.\n\n## Context, Request and Response\n\nEach middleware receives a Koa `Context` object that encapsulates an incoming\nhttp message and the corresponding response to that message. `ctx` is often used\nas the parameter name for the context object.\n\n```js\napp.use(async (ctx, next) => { await next(); });\n```\n\nKoa provides a `Request` object as the `request` property of the `Context`.\nKoa's `Request` object provides helpful methods for working with\nhttp requests which delegate to an [IncomingMessage](https://nodejs.org/api/http.html#http_class_http_incomingmessage)\nfrom the node `http` module.\n\nHere is an example of checking that a requesting client supports xml.\n\n```js\napp.use(async (ctx, next) => {\n ctx.assert(ctx.request.accepts('xml'), 406);\n // equivalent to:\n // if (!ctx.request.accepts('xml')) ctx.throw(406);\n await next();\n});\n```\n\nKoa provides a `Response` object as the `response` property of the `Context`.\nKoa's `Response` object provides helpful methods for working with\nhttp responses which delegate to a [ServerResponse](https://nodejs.org/api/http.html#http_class_http_serverresponse)\n.\n\nKoa's pattern of delegating to Node's request and response objects rather than extending them\nprovides a cleaner interface and reduces conflicts between different middleware and with Node\nitself as well as providing better support for stream handling. The `IncomingMessage` can still be\ndirectly accessed as the `req` property on the `Context` and `ServerResponse` can be directly\naccessed as the `res` property on the `Context`.\n\nHere is an example using Koa's `Response` object to stream a file as the response body.\n\n```js\napp.use(async (ctx, next) => {\n await next();\n ctx.response.type = 'xml';\n ctx.response.body = fs.createReadStream('really_large.xml');\n});\n```\n\nThe `Context` object also provides shortcuts for methods on its `request` and `response`. In the prior\nexamples, `ctx.type` can be used instead of `ctx.response.type` and `ctx.accepts` can be used\ninstead of `ctx.request.accepts`.\n\nFor more information on `Request`, `Response` and `Context`, see the [Request API Reference](docs/api/request.md),\n[Response API Reference](docs/api/response.md) and [Context API Reference](docs/api/context.md).\n\n## Koa Application\n\nThe object created when executing `new Koa()` is known as the Koa application object.\n\nThe application object is Koa's interface with node's http server and handles the registration\nof middleware, dispatching to the middleware from http, default error handling, as well as\nconfiguration of the context, request and response objects.\n\nLearn more about the application object in the [Application API Reference](docs/api/index.md).\n\n## Documentation\n\n - [Usage Guide](docs/guide.md)\n - [Error Handling](docs/error-handling.md)\n - [Koa for Express Users](docs/koa-vs-express.md)\n - [FAQ](docs/faq.md)\n - [API documentation](docs/api/index.md)\n\n## Troubleshooting\n\nCheck the [Troubleshooting Guide](docs/troubleshooting.md) or [Debugging Koa](docs/guide.md#debugging-koa) in\nthe general Koa guide.\n\n## Running tests\n\n```\n$ npm test\n```\n\n## Reporting vulnerabilities\n\nTo report a security vulnerability, please do not open an issue, as this notifies attackers of the vulnerability. Instead, please email [dead_horse](mailto:heyiyu.deadhorse@gmail.com), [jonathanong](mailto:me@jongleberry.com), and [niftylettuce](mailto:niftylettuce@gmail.com) to disclose.\n\n## Authors\n\nSee [AUTHORS](AUTHORS).\n\n## Community\n\n - [KoaJS Slack Group](https://join.slack.com/t/koa-js/shared_invite/zt-5pjgthmb-1JeKDbByqqcARtlPbtf~vQ)\n - [Badgeboard](https://koajs.github.io/badgeboard) and list of official modules\n - [Examples](https://github.com/koajs/examples)\n - [Middleware](https://github.com/koajs/koa/wiki) list\n - [Wiki](https://github.com/koajs/koa/wiki)\n - [Reddit Community](https://www.reddit.com/r/koajs)\n - [Mailing list](https://groups.google.com/forum/#!forum/koajs)\n - [中文文档 v1.x](https://github.com/guo-yu/koa-guide)\n - [中文文档 v2.x](https://github.com/demopark/koa-docs-Zh-CN)\n - __[#koajs]__ on freenode\n\n## Backers\n\nSupport us with a monthly donation and help us continue our activities.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n## Sponsors\n\nBecome a sponsor and get your logo on our README on Github with a link to your site.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n# License\n\n [MIT](https://github.com/koajs/koa/blob/master/LICENSE)\n\n[npm-image]: https://img.shields.io/npm/v/koa.svg?style=flat-square\n[npm-url]: https://www.npmjs.com/package/koa\n[github-action-image]: https://github.com/koajs/koa/actions/workflows/node.js.yml/badge.svg\n[github-action-url]: https://github.com/koajs/koa/actions/workflows/node.js.yml\n[coveralls-image]: https://img.shields.io/codecov/c/github/koajs/koa.svg?style=flat-square\n[coveralls-url]: https://codecov.io/github/koajs/koa?branch=master\n[backers-image]: https://opencollective.com/koajs/backers/badge.svg?style=flat-square\n[sponsors-image]: https://opencollective.com/koajs/sponsors/badge.svg?style=flat-square\n[gitter-image]: https://img.shields.io/gitter/room/koajs/koa.svg?style=flat-square\n[gitter-url]: https://gitter.im/koajs/koa?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge\n[#koajs]: https://webchat.freenode.net/?channels=#koajs\n[pr-welcoming-image]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square\n[pr-welcoming-url]: https://github.com/koajs/koa/pull/new\n" }, { "path": "__tests__/.eslintrc.yml", "content": "env:\n jest: true\n\nrules:\n space-before-blocks: [2, {functions: never, keywords: always}]\n no-unused-expressions: 0\n node/no-deprecated-api: 'warn'\n quote-props: 'warn'\n no-prototype-builtins: 'warn'\n array-bracket-spacing: 'warn'\n object-curly-spacing: 'warn'\n dot-notation: 'warn'\n" }, { "path": "__tests__/application/compose.test.js", "content": "'use strict'\n\nconst { describe, it } = require('node:test')\nconst request = require('supertest')\nconst assert = require('node:assert/strict')\nconst Koa = require('../..')\n\ndescribe('app.compose', () => {\n it('should work with default compose ', async () => {\n const app = new Koa()\n const calls = []\n\n app.use((ctx, next) => {\n calls.push(1)\n return next().then(() => {\n calls.push(4)\n })\n })\n\n app.use((ctx, next) => {\n calls.push(2)\n return next().then(() => {\n calls.push(3)\n })\n })\n\n await request(app.callback())\n .get('/')\n .expect(404)\n\n assert.deepStrictEqual(calls, [1, 2, 3, 4])\n })\n\n it('should work with configurable compose', async () => {\n const calls = []\n let count = 0\n const app = new Koa({\n compose (fns) {\n return async (ctx) => {\n const dispatch = async () => {\n count++\n const fn = fns.shift()\n fn && fn(ctx, dispatch)\n }\n dispatch()\n }\n }\n })\n\n app.use((ctx, next) => {\n calls.push(1)\n next()\n calls.push(4)\n })\n app.use((ctx, next) => {\n calls.push(2)\n next()\n calls.push(3)\n })\n\n await request(app.callback())\n .get('/')\n\n assert.deepStrictEqual(calls, [1, 2, 3, 4])\n assert.equal(count, 3)\n })\n})\n" }, { "path": "__tests__/application/context.test.js", "content": "'use strict'\n\nconst { describe, it } = require('node:test')\nconst request = require('supertest')\nconst assert = require('node:assert/strict')\nconst Koa = require('../..')\n\ndescribe('app.context', () => {\n const app1 = new Koa()\n app1.context.msg = 'hello'\n const app2 = new Koa()\n\n it('should merge properties', () => {\n app1.use((ctx, next) => {\n assert.strictEqual(ctx.msg, 'hello')\n ctx.status = 204\n })\n\n return request(app1.callback())\n .get('/')\n .expect(204)\n })\n\n it('should not affect the original prototype', () => {\n app2.use((ctx, next) => {\n assert.strictEqual(ctx.msg, undefined)\n ctx.status = 204\n })\n\n return request(app2.callback())\n .get('/')\n .expect(204)\n })\n})\n" }, { "path": "__tests__/application/currentContext.test.js", "content": "'use strict'\n\nconst { describe, it } = require('node:test')\nconst request = require('supertest')\nconst assert = require('node:assert/strict')\nconst Koa = require('../..')\nconst { AsyncLocalStorage } = require('async_hooks')\n\ndescribe('app.currentContext', () => {\n it('should get currentContext return context when asyncLocalStorage enable', async () => {\n const app = new Koa({ asyncLocalStorage: true })\n\n app.use(async ctx => {\n assert(ctx === app.currentContext)\n await new Promise(resolve => {\n setTimeout(() => {\n assert(ctx === app.currentContext)\n resolve()\n }, 1)\n })\n await new Promise(resolve => {\n assert(ctx === app.currentContext)\n setImmediate(() => {\n assert(ctx === app.currentContext)\n resolve()\n })\n })\n assert(ctx === app.currentContext)\n app.currentContext.body = 'ok'\n })\n\n const requestServer = async () => {\n assert(app.currentContext === undefined)\n await request(app.callback()).get('/').expect('ok')\n assert(app.currentContext === undefined)\n }\n\n await Promise.all([\n requestServer(),\n requestServer(),\n requestServer(),\n requestServer(),\n requestServer()\n ])\n })\n\n it('should get currentContext return undefined when asyncLocalStorage disable', async () => {\n const app = new Koa()\n\n app.use(async ctx => {\n assert(app.currentContext === undefined)\n ctx.body = 'ok'\n })\n\n await request(app.callback()).get('/').expect('ok')\n })\n\n it('should get currentContext return context in error handler when asyncLocalStorage enable', async () => {\n const app = new Koa({ asyncLocalStorage: true })\n\n app.use(async () => {\n throw new Error('error message')\n })\n\n const handleError = new Promise((resolve, reject) => {\n app.on('error', (err, ctx) => {\n try {\n assert.strictEqual(err.message, 'error message')\n assert.strictEqual(app.currentContext, ctx)\n resolve()\n } catch (e) {\n reject(e)\n }\n })\n })\n\n await request(app.callback()).get('/').expect('Internal Server Error')\n await handleError\n })\n\n it('should get currentContext return undefined in error handler when asyncLocalStorage disable', async () => {\n const app = new Koa()\n\n app.use(async () => {\n throw new Error('error message')\n })\n\n const handleError = new Promise((resolve, reject) => {\n app.on('error', (err, ctx) => {\n try {\n assert.strictEqual(err.message, 'error message')\n assert.strictEqual(app.currentContext, undefined)\n resolve()\n } catch (e) {\n reject(e)\n }\n })\n })\n\n await request(app.callback()).get('/').expect('Internal Server Error')\n await handleError\n })\n\n it('should support a custom asyncLocalStorage', async () => {\n const asyncLocalStorage = new AsyncLocalStorage()\n const app = new Koa({ asyncLocalStorage })\n assert(app.currentContext === undefined)\n app.use(async ctx => {\n assert(ctx === app.currentContext)\n assert(asyncLocalStorage.getStore() === ctx)\n ctx.body = 'ok'\n })\n await request(app.callback()).get('/').expect('ok')\n assert(app.currentContext === undefined)\n })\n})\n" }, { "path": "__tests__/application/index.test.js", "content": "'use strict'\n\nconst { describe, it } = require('node:test')\nconst assert = require('node:assert/strict')\nconst { once } = require('node:events')\nconst Koa = require('../..')\n\ndescribe('app', () => {\n it('should handle socket errors', async () => {\n const app = new Koa()\n let errorCaught = false\n\n app.use((ctx) => {\n ctx.socket.destroy(new Error('boom'))\n })\n\n app.on('error', err => {\n assert.strictEqual(err.message, 'boom')\n errorCaught = true\n })\n\n const server = app.listen()\n\n try {\n const req = require('http').get({\n port: server.address().port\n })\n req.on('error', () => {})\n\n const [err] = await once(app, 'error')\n assert.strictEqual(err.message, 'boom')\n assert.strictEqual(errorCaught, true)\n } finally {\n await server.close()\n }\n })\n\n it('should set development env when NODE_ENV missing', () => {\n const NODE_ENV = process.env.NODE_ENV\n process.env.NODE_ENV = ''\n const app = new Koa()\n process.env.NODE_ENV = NODE_ENV\n assert.strictEqual(app.env, 'development')\n })\n\n it('should set env from the constructor', () => {\n const env = 'custom'\n const app = new Koa({ env })\n assert.strictEqual(app.env, env)\n })\n\n it('should set proxy flag from the constructor', () => {\n const proxy = true\n const app = new Koa({ proxy })\n assert.strictEqual(app.proxy, proxy)\n })\n\n it('should set signed cookie keys from the constructor', () => {\n const keys = ['customkey']\n const app = new Koa({ keys })\n assert.strictEqual(app.keys, keys)\n })\n\n it('should set subdomainOffset from the constructor', () => {\n const subdomainOffset = 3\n const app = new Koa({ subdomainOffset })\n assert.strictEqual(app.subdomainOffset, subdomainOffset)\n })\n\n it('should set compose from the constructor', () => {\n const compose = () => (ctx) => {}\n const app = new Koa.default({ compose }) // eslint-disable-line new-cap\n assert.strictEqual(app.compose, compose)\n })\n\n it('should have a static property exporting `HttpError` from http-errors library', () => {\n const CreateError = require('http-errors')\n\n assert.notEqual(Koa.HttpError, undefined)\n assert.deepStrictEqual(Koa.HttpError, CreateError.HttpError)\n assert.throws(() => { throw new CreateError(500, 'test error') }, Koa.HttpError)\n })\n})\n" }, { "path": "__tests__/application/inspect.test.js", "content": "'use strict'\n\nconst { describe, it } = require('node:test')\nconst assert = require('node:assert/strict')\nconst util = require('util')\nconst Koa = require('../..')\n\nprocess.env.NODE_ENV = 'test'\nconst app = new Koa()\n\ndescribe('app.inspect()', () => {\n it('should work', () => {\n const str = util.inspect(app)\n assert.strictEqual(\"{ subdomainOffset: 2, proxy: false, env: 'test' }\", str)\n })\n\n it('should return a json representation', () => {\n assert.deepStrictEqual(\n { subdomainOffset: 2, proxy: false, env: 'test' },\n app.inspect()\n )\n })\n})\n" }, { "path": "__tests__/application/onerror.test.js", "content": "'use strict'\n\nconst { describe, it, mock } = require('node:test')\nconst assert = require('node:assert/strict')\nconst Koa = require('../..')\n\ndescribe('app.onerror(err)', () => {\n it('should throw an error if a non-error is given', () => {\n const app = new Koa()\n\n assert.throws(() => {\n app.onerror('foo')\n }, TypeError, 'non-error thrown: foo')\n })\n\n it('should accept errors coming from other scopes', () => {\n const ExternError = require('vm').runInNewContext('Error')\n\n const app = new Koa()\n const error = Object.assign(new ExternError('boom'), {\n status: 418,\n expose: true\n })\n\n assert.doesNotThrow(() => app.onerror(error))\n })\n\n it('should do nothing if status is 404', () => {\n const app = new Koa()\n const err = new Error()\n\n err.status = 404\n\n const spy = mock.method(console, 'error', () => {})\n app.onerror(err)\n assert.strictEqual(spy.mock.calls.length, 0)\n spy.mock.restore()\n })\n\n it('should do nothing if .silent', () => {\n const app = new Koa()\n app.silent = true\n const err = new Error()\n\n const spy = mock.method(console, 'error', () => {})\n app.onerror(err)\n assert.strictEqual(spy.mock.calls.length, 0)\n spy.mock.restore()\n })\n\n it('should log the error to stderr', () => {\n const app = new Koa()\n app.env = 'dev'\n\n const err = new Error()\n err.stack = 'Foo'\n\n const spy = mock.method(console, 'error', () => {})\n app.onerror(err)\n assert.notStrictEqual(spy.mock.calls.length, 0)\n spy.mock.restore()\n })\n})\n" }, { "path": "__tests__/application/request.test.js", "content": "'use strict'\n\nconst { describe, it } = require('node:test')\nconst request = require('supertest')\nconst assert = require('node:assert/strict')\nconst Koa = require('../..')\n\ndescribe('app.request', () => {\n const app1 = new Koa()\n app1.request.message = 'hello'\n const app2 = new Koa()\n\n it('should merge properties', () => {\n app1.use((ctx, next) => {\n assert.strictEqual(ctx.request.message, 'hello')\n ctx.status = 204\n })\n\n return request(app1.callback())\n .get('/')\n .expect(204)\n })\n\n it('should not affect the original prototype', () => {\n app2.use((ctx, next) => {\n assert.strictEqual(ctx.request.message, undefined)\n ctx.status = 204\n })\n\n return request(app2.callback())\n .get('/')\n .expect(204)\n })\n})\n" }, { "path": "__tests__/application/respond.test.js", "content": "'use strict'\n\nconst { describe, it } = require('node:test')\nconst request = require('supertest')\nconst statuses = require('statuses')\nconst assert = require('node:assert/strict')\nconst Koa = require('../..')\nconst fs = require('fs')\n\ndescribe('app.respond', () => {\n describe('when ctx.respond === false', () => {\n it('should function (ctx)', () => {\n const app = new Koa()\n\n app.use(ctx => {\n ctx.body = 'Hello'\n ctx.respond = false\n\n const res = ctx.res\n res.statusCode = 200\n setImmediate(() => {\n res.setHeader('Content-Type', 'text/plain')\n res.setHeader('Content-Length', '3')\n res.end('lol')\n })\n })\n\n return request(app.callback())\n .get('/')\n .expect(200)\n .expect('lol')\n })\n\n it('should ignore set header after header sent', () => {\n const app = new Koa()\n app.use(ctx => {\n ctx.body = 'Hello'\n ctx.respond = false\n\n const res = ctx.res\n res.statusCode = 200\n res.setHeader('Content-Type', 'text/plain')\n res.setHeader('Content-Length', '3')\n res.end('lol')\n ctx.set('foo', 'bar')\n })\n\n return request(app.callback())\n .get('/')\n .expect(200)\n .expect('lol')\n .expect(res => {\n assert(!res.headers.foo)\n })\n })\n\n it('should ignore set status after header sent', () => {\n const app = new Koa()\n app.use(ctx => {\n ctx.body = 'Hello'\n ctx.respond = false\n\n const res = ctx.res\n res.statusCode = 200\n res.setHeader('Content-Type', 'text/plain')\n res.setHeader('Content-Length', '3')\n res.end('lol')\n ctx.status = 201\n })\n\n return request(app.callback())\n .get('/')\n .expect(200)\n .expect('lol')\n })\n })\n\n describe('when this.type === null', () => {\n it('should not send Content-Type header', async () => {\n const app = new Koa()\n\n app.use(ctx => {\n ctx.body = ''\n ctx.type = null\n })\n\n const res = await request(app.callback())\n .get('/')\n .expect(200)\n\n assert.strictEqual(Object.prototype.hasOwnProperty.call(res.headers, 'Content-Type'), false)\n })\n })\n\n describe('when HEAD is used', () => {\n it('should not respond with the body', async () => {\n const app = new Koa()\n\n app.use(ctx => {\n ctx.body = 'Hello'\n })\n\n const res = await request(app.callback())\n .head('/')\n .expect(200)\n\n assert.strictEqual(res.headers['content-type'], 'text/plain; charset=utf-8')\n assert.strictEqual(res.headers['content-length'], '5')\n assert(!res.text)\n })\n\n it('should keep json headers', async () => {\n const app = new Koa()\n\n app.use(ctx => {\n ctx.body = { hello: 'world' }\n })\n\n const res = await request(app.callback())\n .head('/')\n .expect(200)\n\n assert.strictEqual(res.headers['content-type'], 'application/json; charset=utf-8')\n assert.strictEqual(res.headers['content-length'], '17')\n assert(!res.text)\n })\n\n it('should keep string headers', async () => {\n const app = new Koa()\n\n app.use(ctx => {\n ctx.body = 'hello world'\n })\n\n const res = await request(app.callback())\n .head('/')\n .expect(200)\n\n assert.strictEqual(res.headers['content-type'], 'text/plain; charset=utf-8')\n assert.strictEqual(res.headers['content-length'], '11')\n assert(!res.text)\n })\n\n it('should keep buffer headers', async () => {\n const app = new Koa()\n\n app.use(ctx => {\n ctx.body = Buffer.from('hello world')\n })\n\n const res = await request(app.callback())\n .head('/')\n .expect(200)\n\n assert.strictEqual(res.headers['content-type'], 'application/octet-stream')\n assert.strictEqual(res.headers['content-length'], '11')\n assert(!res.text)\n })\n\n it('should keep stream header if set manually', async () => {\n const app = new Koa()\n\n const { length } = fs.readFileSync('package.json')\n\n app.use(ctx => {\n ctx.length = length\n ctx.body = fs.createReadStream('package.json')\n })\n\n const res = await request(app.callback())\n .head('/')\n .expect(200)\n\n assert.strictEqual(~~res.header['content-length'], length)\n assert(!res.text)\n })\n\n it('should respond with a 404 if no body was set', () => {\n const app = new Koa()\n\n app.use(ctx => {\n\n })\n\n return request(app.callback())\n .head('/')\n .expect(404)\n })\n\n it('should respond with a 200 if body = \"\"', () => {\n const app = new Koa()\n\n app.use(ctx => {\n ctx.body = ''\n })\n\n return request(app.callback())\n .head('/')\n .expect(200)\n })\n\n it('should not overwrite the content-type', () => {\n const app = new Koa()\n\n app.use(ctx => {\n ctx.status = 200\n ctx.type = 'application/javascript'\n })\n\n return request(app.callback())\n .head('/')\n .expect('content-type', /application\\/javascript/)\n .expect(200)\n })\n })\n\n describe('when no middleware is present', () => {\n it('should 404', () => {\n const app = new Koa()\n\n return request(app.callback())\n .get('/')\n .expect(404)\n })\n })\n\n describe('when res has already been written to', () => {\n it('should not cause an app error', () => {\n const app = new Koa()\n\n app.use((ctx, next) => {\n const res = ctx.res\n ctx.status = 200\n res.setHeader('Content-Type', 'text/html')\n res.write('Hello')\n })\n\n app.on('error', err => { throw err })\n\n return request(app.callback())\n .get('/')\n .expect(200)\n })\n\n it('should send the right body', () => {\n const app = new Koa()\n\n app.use((ctx, next) => {\n const res = ctx.res\n ctx.status = 200\n res.setHeader('Content-Type', 'text/html')\n res.write('Hello')\n return new Promise(resolve => {\n setTimeout(() => {\n res.end('Goodbye')\n resolve()\n }, 0)\n })\n })\n\n return request(app.callback())\n .get('/')\n .expect(200)\n .expect('HelloGoodbye')\n })\n })\n\n describe('when .body is missing', () => {\n describe('with status=400', () => {\n it('should respond with the associated status message', () => {\n const app = new Koa()\n\n app.use(ctx => {\n ctx.status = 400\n })\n\n return request(app.callback())\n .get('/')\n .expect(400)\n .expect('Content-Length', '11')\n .expect('Bad Request')\n })\n })\n\n describe('with status=204', () => {\n it('should respond without a body', async () => {\n const app = new Koa()\n\n app.use(ctx => {\n ctx.status = 204\n })\n\n const res = await request(app.callback())\n .get('/')\n .expect(204)\n .expect('')\n\n assert.strictEqual(Object.prototype.hasOwnProperty.call(res.headers, 'Content-Type'), false)\n })\n })\n\n describe('with status=205', () => {\n it('should respond without a body', async () => {\n const app = new Koa()\n\n app.use(ctx => {\n ctx.status = 205\n })\n\n const res = await request(app.callback())\n .get('/')\n .expect(205)\n .expect('')\n\n assert.strictEqual(Object.prototype.hasOwnProperty.call(res.headers, 'Content-Type'), false)\n })\n })\n\n describe('with status=304', () => {\n it('should respond without a body', async () => {\n const app = new Koa()\n\n app.use(ctx => {\n ctx.status = 304\n })\n\n const res = await request(app.callback())\n .get('/')\n .expect(304)\n .expect('')\n\n assert.strictEqual(Object.prototype.hasOwnProperty.call(res.headers, 'Content-Type'), false)\n })\n })\n\n describe('with custom status=700', () => {\n it('should respond with the associated status message', async () => {\n const app = new Koa()\n statuses.message['700'] = 'custom status'\n\n app.use(ctx => {\n ctx.status = 700\n })\n\n const res = await request(app.callback())\n .get('/')\n .expect(700)\n .expect('custom status')\n\n assert.strictEqual(res.res.statusMessage, 'custom status')\n })\n })\n\n describe('with custom statusMessage=ok', () => {\n it('should respond with the custom status message', async () => {\n const app = new Koa()\n\n app.use(ctx => {\n ctx.status = 200\n ctx.message = 'ok'\n })\n\n const res = await request(app.callback())\n .get('/')\n .expect(200)\n .expect('ok')\n\n assert.strictEqual(res.res.statusMessage, 'ok')\n })\n })\n\n describe('with custom status without message', () => {\n it('should respond with the status code number', () => {\n const app = new Koa()\n\n app.use(ctx => {\n ctx.res.statusCode = 701\n })\n\n return request(app.callback())\n .get('/')\n .expect(701)\n .expect('701')\n })\n })\n })\n\n describe('when .body is a null', () => {\n it('should respond 204 by default', async () => {\n const app = new Koa()\n\n app.use(ctx => {\n ctx.body = null\n })\n\n const res = await request(app.callback())\n .get('/')\n .expect(204)\n .expect('')\n\n assert.strictEqual(Object.prototype.hasOwnProperty.call(res.headers, 'Content-Type'), false)\n })\n\n it('should respond 204 with status=200', async () => {\n const app = new Koa()\n\n app.use(ctx => {\n ctx.status = 200\n ctx.body = null\n })\n\n const res = await request(app.callback())\n .get('/')\n .expect(204)\n .expect('')\n\n assert.strictEqual(Object.prototype.hasOwnProperty.call(res.headers, 'Content-Type'), false)\n })\n\n it('should respond 205 with status=205', async () => {\n const app = new Koa()\n\n app.use(ctx => {\n ctx.status = 205\n ctx.body = null\n })\n\n const res = await request(app.callback())\n .get('/')\n .expect(205)\n .expect('')\n\n assert.strictEqual(Object.prototype.hasOwnProperty.call(res.headers, 'Content-Type'), false)\n })\n\n it('should respond 304 with status=304', async () => {\n const app = new Koa()\n\n app.use(ctx => {\n ctx.status = 304\n ctx.body = null\n })\n\n const res = await request(app.callback())\n .get('/')\n .expect(304)\n .expect('')\n\n assert.strictEqual(Object.prototype.hasOwnProperty.call(res.headers, 'Content-Type'), false)\n })\n })\n\n describe('when .body is undefined', () => {\n it('should respond 204 by default', async () => {\n const app = new Koa()\n\n app.use(ctx => {\n ctx.body = undefined\n })\n\n const res = await request(app.callback())\n .get('/')\n .expect(204)\n .expect('')\n\n assert.strictEqual(Object.prototype.hasOwnProperty.call(res.headers, 'Content-Type'), false)\n })\n\n it('should respond 204 with status=200', async () => {\n const app = new Koa()\n app.use(ctx => {\n ctx.status = 200\n ctx.body = undefined\n })\n\n const res = await request(app.callback())\n .get('/')\n .expect(204)\n .expect('')\n\n assert.strictEqual(Object.prototype.hasOwnProperty.call(res.headers, 'Content-Type'), false)\n })\n })\n\n describe('when .body is a string', () => {\n it('should respond', () => {\n const app = new Koa()\n\n app.use(ctx => {\n ctx.body = 'Hello'\n })\n\n return request(app.callback())\n .get('/')\n .expect('Hello')\n })\n })\n\n describe('when .body is a Buffer', () => {\n it('should respond', () => {\n const app = new Koa()\n\n app.use(ctx => {\n ctx.body = Buffer.from('Hello')\n })\n\n return request(app.callback())\n .get('/')\n .expect(200)\n .expect(Buffer.from('Hello'))\n })\n })\n\n describe('when .body is a Blob', () => {\n it('should respond', async () => {\n const app = new Koa()\n\n app.use(ctx => {\n ctx.body = new Blob(['Hello'])\n })\n\n const expectedBlob = new Blob(['Hello'])\n\n const res = await request(app.callback())\n .get('/')\n .expect(200)\n\n assert.deepStrictEqual(res.body, Buffer.from(await expectedBlob.arrayBuffer()))\n })\n\n it('should keep Blob headers', async () => {\n const app = new Koa()\n\n app.use(ctx => {\n ctx.body = new Blob(['hello world'])\n })\n\n return request(app.callback())\n .head('/')\n .expect(200)\n .expect('content-type', 'application/octet-stream')\n .expect('content-length', '11')\n })\n })\n\n describe('when .body is a ReadableStream', () => {\n it('should respond', async () => {\n const app = new Koa()\n\n app.use(async ctx => {\n ctx.body = new ReadableStream()\n })\n\n return request(app.callback())\n .head('/')\n .expect(200)\n .expect('content-type', 'application/octet-stream')\n })\n\n it('should respond hello', async () => {\n const app = new Koa()\n\n app.use(async ctx => {\n const blob = new Blob(['hello'])\n ctx.body = blob.stream()\n })\n\n return request(app.callback())\n .get('/')\n .expect(200)\n .expect('content-type', 'application/octet-stream')\n .expect(Buffer.from('hello'))\n })\n\n it('should handle ReadableStream with chunks', async () => {\n const app = new Koa()\n\n app.use(async ctx => {\n const stream = new ReadableStream({\n start (controller) {\n controller.enqueue(new TextEncoder().encode('Hello '))\n controller.enqueue(new TextEncoder().encode('World'))\n controller.close()\n }\n })\n ctx.body = stream\n })\n\n return request(app.callback())\n .get('/')\n .expect(200)\n .expect('content-type', 'application/octet-stream')\n .expect(Buffer.from('Hello World'))\n })\n\n it('should handle ReadableStream with custom headers', async () => {\n const app = new Koa()\n\n app.use(async ctx => {\n ctx.type = 'text/plain'\n ctx.body = new ReadableStream({\n start (controller) {\n controller.enqueue(new TextEncoder().encode('test content'))\n controller.close()\n }\n })\n })\n\n const res = await request(app.callback())\n .get('/')\n .expect(200)\n .expect('content-type', 'text/plain; charset=utf-8')\n\n assert.strictEqual(res.text, 'test content')\n })\n })\n\n describe('when .body is a Response', () => {\n it('should keep Response headers', () => {\n const app = new Koa()\n\n app.use(ctx => {\n ctx.body = new Response(null, { status: 201, statusText: 'OK', headers: { 'Content-Type': 'text/plain' } })\n })\n\n return request(app.callback())\n .head('/')\n .expect(201)\n .expect('content-type', 'text/plain')\n .expect('content-length', '2')\n })\n\n it('should default to octet-stream', () => {\n const app = new Koa()\n\n app.use(ctx => {\n ctx.body = new Response(null, { status: 200, statusText: 'OK' })\n })\n\n return request(app.callback())\n .get('/')\n .expect(200)\n .expect('content-type', 'application/octet-stream')\n .expect(Buffer.from([]))\n })\n\n it('should respond with body content', async () => {\n const app = new Koa()\n\n app.use(ctx => {\n ctx.body = new Response('Hello World', { status: 200, headers: { 'Content-Type': 'text/plain' } })\n })\n\n const res = await request(app.callback())\n .get('/')\n .expect(200)\n .expect('content-type', 'text/plain')\n\n assert.strictEqual(res.text, 'Hello World')\n })\n\n it('should handle Response from fetch() with JSON', async () => {\n const app = new Koa()\n\n app.use(async ctx => {\n const jsonData = JSON.stringify({ message: 'Hello from fetch', timestamp: Date.now() })\n const response = new Response(jsonData, {\n status: 200,\n headers: {\n 'Content-Type': 'application/json',\n 'X-Custom-Header': 'custom-value'\n }\n })\n ctx.body = response\n })\n\n const res = await request(app.callback())\n .get('/')\n .expect(200)\n .expect('content-type', 'application/json')\n\n const body = JSON.parse(res.text)\n assert.strictEqual(body.message, 'Hello from fetch')\n assert(body.timestamp)\n })\n\n it('should handle Response from fetch() with streaming body', async () => {\n const app = new Koa()\n\n app.use(async ctx => {\n const stream = new ReadableStream({\n start (controller) {\n controller.enqueue(new TextEncoder().encode('Streaming '))\n controller.enqueue(new TextEncoder().encode('response '))\n controller.enqueue(new TextEncoder().encode('from fetch'))\n controller.close()\n }\n })\n\n const response = new Response(stream, {\n status: 200,\n headers: {\n 'Content-Type': 'text/plain'\n }\n })\n ctx.body = response\n })\n\n const res = await request(app.callback())\n .get('/')\n .expect(200)\n .expect('content-type', 'text/plain')\n\n assert.strictEqual(res.text, 'Streaming response from fetch')\n })\n\n it('should handle Response from fetch() with Blob body', async () => {\n const app = new Koa()\n\n app.use(async ctx => {\n const blob = new Blob(['Hello from Blob'], { type: 'text/plain' })\n const response = new Response(blob, {\n status: 200,\n headers: {\n 'Content-Type': 'text/plain'\n }\n })\n ctx.body = response\n })\n\n const res = await request(app.callback())\n .get('/')\n .expect(200)\n .expect('content-type', 'text/plain')\n\n assert.strictEqual(res.text, 'Hello from Blob')\n })\n })\n\n describe('when .body is a Stream', () => {\n it('should respond', async () => {\n const app = new Koa()\n\n app.use(ctx => {\n ctx.body = fs.createReadStream('package.json')\n ctx.set('Content-Type', 'application/json; charset=utf-8')\n })\n\n const res = await request(app.callback())\n .get('/')\n .expect('Content-Type', 'application/json; charset=utf-8')\n\n const pkg = require('../../package')\n assert.strictEqual(Object.prototype.hasOwnProperty.call(res.headers, 'content-length'), false)\n assert.deepStrictEqual(res.body, pkg)\n })\n\n it('should strip content-length when overwriting', async () => {\n const app = new Koa()\n\n app.use(ctx => {\n ctx.body = 'hello'\n ctx.body = fs.createReadStream('package.json')\n ctx.set('Content-Type', 'application/json; charset=utf-8')\n })\n\n const res = await request(app.callback())\n .get('/')\n .expect('Content-Type', 'application/json; charset=utf-8')\n\n const pkg = require('../../package')\n assert.strictEqual(Object.prototype.hasOwnProperty.call(res.headers, 'content-length'), false)\n assert.deepStrictEqual(res.body, pkg)\n })\n\n it('should keep content-length if not overwritten', async () => {\n const app = new Koa()\n\n app.use(ctx => {\n ctx.length = fs.readFileSync('package.json').length\n ctx.body = fs.createReadStream('package.json')\n ctx.set('Content-Type', 'application/json; charset=utf-8')\n })\n\n const res = await request(app.callback())\n .get('/')\n .expect('Content-Type', 'application/json; charset=utf-8')\n\n const pkg = require('../../package')\n assert.strictEqual(Object.prototype.hasOwnProperty.call(res.headers, 'content-length'), true)\n assert.deepStrictEqual(res.body, pkg)\n })\n\n it('should keep content-length if overwritten with the same stream',\n async () => {\n const app = new Koa()\n\n app.use(ctx => {\n ctx.length = fs.readFileSync('package.json').length\n const stream = fs.createReadStream('package.json')\n ctx.body = stream\n ctx.body = stream\n ctx.set('Content-Type', 'application/json; charset=utf-8')\n })\n\n const res = await request(app.callback())\n .get('/')\n .expect('Content-Type', 'application/json; charset=utf-8')\n\n const pkg = require('../../package')\n assert.strictEqual(Object.prototype.hasOwnProperty.call(res.headers, 'content-length'), true)\n assert.deepStrictEqual(res.body, pkg)\n })\n\n it('should handle errors when no content status', () => {\n const app = new Koa()\n\n app.use(ctx => {\n ctx.status = 204\n ctx.body = fs.createReadStream('does not exist')\n })\n\n return request(app.callback())\n .get('/')\n .expect(204)\n })\n })\n\n describe('when using pipeline for streams', () => {\n it('should handle stream errors when error listener exists', async () => {\n const app = new Koa()\n const PassThrough = require('stream').PassThrough\n\n let errorCaught = false\n app.once('error', err => {\n assert(err.message === 'stream error')\n errorCaught = true\n })\n\n app.use(ctx => {\n const stream = new PassThrough()\n ctx.body = stream\n\n setImmediate(() => {\n stream.emit('error', new Error('stream error'))\n })\n })\n\n await request(app.callback())\n .get('/')\n .catch(() => {})\n\n await new Promise(resolve => setTimeout(resolve, 50))\n assert(errorCaught, 'Error should have been caught')\n })\n\n it('should not crash when stream errors and no error listener exists', async () => {\n const app = new Koa()\n const PassThrough = require('stream').PassThrough\n\n app.use(ctx => {\n const stream = new PassThrough()\n ctx.body = stream\n\n setImmediate(() => {\n stream.emit('error', new Error('stream error'))\n })\n })\n\n await request(app.callback())\n .get('/')\n .catch(() => {})\n\n await new Promise(resolve => setTimeout(resolve, 50))\n })\n\n it('should handle ReadableStream errors when error listener exists', async () => {\n const app = new Koa()\n\n let errorCaught = false\n app.once('error', err => {\n assert(err.message === 'readable stream error')\n errorCaught = true\n })\n\n app.use(ctx => {\n const readable = new ReadableStream({\n start (controller) {\n controller.enqueue(new TextEncoder().encode('data'))\n controller.error(new Error('readable stream error'))\n }\n })\n ctx.body = readable\n })\n\n await request(app.callback())\n .get('/')\n .catch(() => {})\n\n await new Promise(resolve => setTimeout(resolve, 50))\n assert(errorCaught, 'Error should have been caught')\n })\n\n it('should cleanup streams on client abort', async () => {\n const app = new Koa()\n const PassThrough = require('stream').PassThrough\n const http = require('http')\n\n let streamDestroyed = false\n\n app.use(ctx => {\n const stream = new PassThrough()\n stream.on('close', () => {\n streamDestroyed = true\n })\n ctx.body = stream\n\n setImmediate(() => {\n stream.write('some data')\n })\n })\n\n const server = app.listen()\n\n await new Promise((resolve) => {\n const req = http.request({\n port: server.address().port,\n path: '/'\n })\n\n req.on('response', (res) => {\n res.on('data', () => {\n req.destroy()\n setTimeout(() => {\n server.close()\n resolve()\n }, 50)\n })\n })\n\n req.end()\n })\n\n assert(streamDestroyed, 'Stream should be destroyed on client abort')\n })\n })\n\n describe('when .body is an Object', () => {\n it('should respond with json', () => {\n const app = new Koa()\n\n app.use(ctx => {\n ctx.body = { hello: 'world' }\n })\n\n return request(app.callback())\n .get('/')\n .expect('Content-Type', 'application/json; charset=utf-8')\n .expect('{\"hello\":\"world\"}')\n })\n describe('and headers sent', () => {\n it('should respond with json body and headers', () => {\n const app = new Koa()\n\n app.use(ctx => {\n ctx.length = 17\n ctx.type = 'json'\n ctx.set('foo', 'bar')\n ctx.res.flushHeaders()\n ctx.body = { hello: 'world' }\n })\n\n return request(app.callback())\n .get('/')\n .expect('Content-Type', 'application/json; charset=utf-8')\n .expect('Content-Length', '17')\n .expect('foo', 'bar')\n .expect('{\"hello\":\"world\"}')\n })\n })\n })\n\n describe('when an error occurs', () => {\n it('should emit \"error\" on the app', async () => {\n const app = new Koa()\n let errorCaught = false\n\n app.on('error', err => {\n assert.strictEqual(err.message, 'test error')\n errorCaught = true\n })\n\n app.use(ctx => {\n throw new Error('test error')\n })\n\n await request(app.callback())\n .get('/')\n .expect(500)\n\n assert.strictEqual(errorCaught, true)\n })\n\n describe('with an .expose property', () => {\n it('should expose the message', () => {\n const app = new Koa()\n\n app.use(ctx => {\n const err = new Error('sorry!')\n err.status = 403\n err.expose = true\n throw err\n })\n\n return request(app.callback())\n .get('/')\n .expect(403, 'sorry!')\n })\n })\n\n describe('with a .status property', () => {\n it('should respond with .status', () => {\n const app = new Koa()\n\n app.use(ctx => {\n const err = new Error('s3 explodes')\n err.status = 403\n throw err\n })\n\n return request(app.callback())\n .get('/')\n .expect(403, 'Forbidden')\n })\n })\n\n it('should respond with 500', () => {\n const app = new Koa()\n\n app.use(ctx => {\n throw new Error('boom!')\n })\n\n return request(app.callback())\n .get('/')\n .expect(500, 'Internal Server Error')\n })\n\n it('should be catchable', () => {\n const app = new Koa()\n\n app.use((ctx, next) => {\n return next().then(() => {\n ctx.body = 'Hello'\n }).catch(() => {\n ctx.body = 'Got error'\n })\n })\n\n app.use((ctx, next) => {\n throw new Error('boom!')\n })\n\n return request(app.callback())\n .get('/')\n .expect(200, 'Got error')\n })\n })\n\n describe('when status and body property', () => {\n it('should 200', () => {\n const app = new Koa()\n\n app.use(ctx => {\n ctx.status = 304\n ctx.body = 'hello'\n ctx.status = 200\n })\n\n return request(app.callback())\n .get('/')\n .expect(200)\n .expect('hello')\n })\n\n it('should 204', async () => {\n const app = new Koa()\n\n app.use(ctx => {\n ctx.status = 200\n ctx.body = 'hello'\n ctx.set('content-type', 'text/plain; charset=utf8')\n ctx.status = 204\n })\n\n const res = await request(app.callback())\n .get('/')\n .expect(204)\n\n assert.strictEqual(Object.prototype.hasOwnProperty.call(res.headers, 'Content-Type'), false)\n })\n })\n\n describe('with explicit null body', () => {\n it('should preserve given status', async () => {\n const app = new Koa()\n\n app.use(ctx => {\n ctx.body = null\n ctx.status = 404\n })\n\n return request(app.callback())\n .get('/')\n .expect(404)\n .expect('')\n .expect({})\n })\n it('should respond with correct headers', async () => {\n const app = new Koa()\n\n app.use(ctx => {\n ctx.body = null\n ctx.status = 401\n })\n\n const res = await request(app.callback())\n .get('/')\n .expect(401)\n .expect('')\n .expect({})\n\n assert.equal(Object.prototype.hasOwnProperty.call(res.headers, 'transfer-encoding'), false)\n assert.equal(Object.prototype.hasOwnProperty.call(res.headers, 'Content-Type'), false)\n assert.equal(Object.prototype.hasOwnProperty.call(res.headers, 'content-length'), true)\n })\n\n it('should return content-length equal to 0', async () => {\n const app = new Koa()\n\n app.use(ctx => {\n ctx.body = null\n ctx.status = 401\n })\n\n const res = await request(app.callback())\n .get('/')\n .expect(401)\n .expect('')\n .expect({})\n\n assert.equal(res.headers['content-length'], '0')\n })\n it('should not overwrite the content-length', async () => {\n const app = new Koa()\n\n app.use(ctx => {\n ctx.body = null\n ctx.length = 10\n ctx.status = 404\n })\n\n const res = await request(app.callback())\n .get('/')\n .expect(404)\n .expect('')\n .expect({})\n\n assert.equal(res.headers['content-length'], '0')\n })\n })\n})\n" }, { "path": "__tests__/application/response.test.js", "content": "'use strict'\n\nconst { describe, it } = require('node:test')\nconst request = require('supertest')\nconst assert = require('node:assert/strict')\nconst Koa = require('../..')\n\ndescribe('app.response', () => {\n const app1 = new Koa()\n app1.response.msg = 'hello'\n const app2 = new Koa()\n const app3 = new Koa()\n const app4 = new Koa()\n const app5 = new Koa()\n const app6 = new Koa()\n const app7 = new Koa()\n\n it('should merge properties', () => {\n app1.use((ctx, next) => {\n assert.strictEqual(ctx.response.msg, 'hello')\n ctx.status = 204\n })\n\n return request(app1.callback())\n .get('/')\n .expect(204)\n })\n\n it('should not affect the original prototype', () => {\n app2.use((ctx, next) => {\n assert.strictEqual(ctx.response.msg, undefined)\n ctx.status = 204\n })\n\n return request(app2.callback())\n .get('/')\n .expect(204)\n })\n\n it('should not include status message in body for http2', async () => {\n app3.use((ctx, next) => {\n ctx.req.httpVersionMajor = 2\n ctx.status = 404\n })\n const response = await request(app3.callback())\n .get('/')\n .expect(404)\n assert.strictEqual(response.text, '404')\n })\n\n it('should set ._explicitNullBody correctly', async () => {\n app4.use((ctx, next) => {\n ctx.body = null\n assert.strictEqual(ctx.response._explicitNullBody, true)\n })\n\n return request(app4.callback())\n .get('/')\n .expect(204)\n })\n\n it('should not set ._explicitNullBody incorrectly', async () => {\n app5.use((ctx, next) => {\n ctx.body = undefined\n assert.strictEqual(ctx.response._explicitNullBody, undefined)\n ctx.body = ''\n assert.strictEqual(ctx.response._explicitNullBody, undefined)\n ctx.body = false\n assert.strictEqual(ctx.response._explicitNullBody, undefined)\n })\n\n return request(app5.callback())\n .get('/')\n .expect(204)\n })\n\n it('should add Content-Length when Transfer-Encoding is not defined', () => {\n app6.use((ctx, next) => {\n ctx.body = 'hello world'\n })\n\n return request(app6.callback())\n .get('/')\n .expect('Content-Length', '11')\n .expect(200)\n })\n\n it('should not add Content-Length when Transfer-Encoding is defined', () => {\n app7.use((ctx, next) => {\n ctx.set('Transfer-Encoding', 'chunked')\n ctx.body = 'hello world'\n assert.strictEqual(ctx.response.get('Content-Length'), undefined)\n })\n\n return request(app7.callback())\n .get('/')\n .expect('Transfer-Encoding', 'chunked')\n .expect(200)\n })\n})\n" }, { "path": "__tests__/application/toJSON.test.js", "content": "'use strict'\n\nconst { describe, it } = require('node:test')\nconst assert = require('node:assert/strict')\nconst Koa = require('../..')\n\ndescribe('app.toJSON()', () => {\n it('should work', () => {\n const app = new Koa({ env: 'test' })\n const obj = app.toJSON()\n\n assert.deepStrictEqual({\n subdomainOffset: 2,\n proxy: false,\n env: 'test'\n }, obj)\n })\n})\n" }, { "path": "__tests__/application/use.test.js", "content": "'use strict'\n\nconst { describe, it } = require('node:test')\nconst request = require('supertest')\nconst assert = require('node:assert/strict')\nconst Koa = require('../..')\n\ndescribe('app.use(fn)', () => {\n it('should compose middleware', async () => {\n const app = new Koa()\n const calls = []\n\n app.use((ctx, next) => {\n calls.push(1)\n return next().then(() => {\n calls.push(6)\n })\n })\n\n app.use((ctx, next) => {\n calls.push(2)\n return next().then(() => {\n calls.push(5)\n })\n })\n\n app.use((ctx, next) => {\n calls.push(3)\n return next().then(() => {\n calls.push(4)\n })\n })\n\n await request(app.callback())\n .get('/')\n .expect(404)\n\n assert.deepStrictEqual(calls, [1, 2, 3, 4, 5, 6])\n })\n\n it('should compose mixed middleware', async () => {\n const app = new Koa()\n const calls = []\n\n app.use((ctx, next) => {\n calls.push(1)\n return next().then(() => {\n calls.push(6)\n })\n })\n\n app.use(async (ctx, next) => {\n calls.push(2)\n await next()\n calls.push(5)\n })\n\n app.use((ctx, next) => {\n calls.push(3)\n return next().then(() => {\n calls.push(4)\n })\n })\n\n await request(app.callback())\n .get('/')\n .expect(404)\n\n assert.deepStrictEqual(calls, [1, 2, 3, 4, 5, 6])\n })\n\n // https://github.com/koajs/koa/pull/530#issuecomment-148138051\n it('should catch thrown errors in non-async functions', () => {\n const app = new Koa()\n\n app.use(ctx => ctx.throw(404, 'Not Found'))\n\n return request(app.callback()).get('/').expect(404)\n })\n\n it('should throw error for non-function', () => {\n const app = new Koa();\n\n [null, undefined, 0, false, 'not a function'].forEach(v => {\n assert.throws(() => app.use(v), /middleware must be a function!/)\n })\n })\n})\n" }, { "path": "__tests__/context/assert.test.js", "content": "'use strict'\n\nconst { describe, it } = require('node:test')\nconst context = require('../../test-helpers/context')\nconst assert = require('node:assert/strict')\n\ndescribe('ctx.assert(value, status)', () => {\n it('should throw an error', () => {\n const ctx = context()\n\n let assertionRan = false\n try {\n ctx.assert(false, 404, 'custom message')\n throw new Error('should not reach here')\n } catch (err) {\n assertionRan = true\n assert.strictEqual(err.status, 404)\n assert.strictEqual(err.message, 'custom message')\n assert.strictEqual(err.expose, true)\n }\n assert(assertionRan)\n })\n})\n" }, { "path": "__tests__/context/cookies.test.js", "content": "'use strict'\n\nconst { describe, it } = require('node:test')\nconst assert = require('node:assert/strict')\nconst request = require('supertest')\nconst Koa = require('../..')\n\ndescribe('ctx.cookies', () => {\n describe('ctx.cookies.set()', () => {\n it('should set an unsigned cookie', async () => {\n const app = new Koa()\n\n app.use((ctx, next) => {\n ctx.cookies.set('name', 'jon')\n ctx.status = 204\n })\n\n const res = await request(app.callback())\n .get('/')\n .expect(204)\n\n const cookie = res.headers['set-cookie'].some(cookie => /^name=/.test(cookie))\n assert.strictEqual(cookie, true)\n })\n\n describe('with .signed', () => {\n describe('when no .keys are set', () => {\n it('should error', () => {\n const app = new Koa()\n\n app.use((ctx, next) => {\n try {\n ctx.cookies.set('foo', 'bar', { signed: true })\n } catch (err) {\n ctx.body = err.message\n }\n })\n\n return request(app.callback())\n .get('/')\n .expect('.keys required for signed cookies')\n })\n })\n\n it('should send a signed cookie', async () => {\n const app = new Koa()\n\n app.keys = ['a', 'b']\n\n app.use((ctx, next) => {\n ctx.cookies.set('name', 'jon', { signed: true })\n ctx.status = 204\n })\n\n const res = await request(app.callback())\n .get('/')\n .expect(204)\n\n const cookies = res.headers['set-cookie']\n\n assert.strictEqual(cookies.some(cookie => /^name=/.test(cookie)), true)\n assert.strictEqual(cookies.some(cookie => /(,|^)name\\.sig=/.test(cookie)), true)\n })\n })\n\n describe('with secure', () => {\n it('should get secure from request', async () => {\n const app = new Koa()\n\n app.proxy = true\n app.keys = ['a', 'b']\n\n app.use(ctx => {\n ctx.cookies.set('name', 'jon', { signed: true })\n ctx.status = 204\n })\n\n const res = await request(app.callback())\n .get('/')\n .set('x-forwarded-proto', 'https') // mock secure\n .expect(204)\n\n const cookies = res.headers['set-cookie']\n assert.strictEqual(cookies.some(cookie => /^name=/.test(cookie)), true)\n assert.strictEqual(cookies.some(cookie => /(,|^)name\\.sig=/.test(cookie)), true)\n assert.strictEqual(cookies.every(cookie => /secure/.test(cookie)), true)\n })\n })\n })\n\n describe('ctx.cookies=', () => {\n it('should override cookie work', async () => {\n const app = new Koa()\n\n app.use((ctx, next) => {\n ctx.cookies = {\n set (key, value) {\n ctx.set(key, value)\n }\n }\n ctx.cookies.set('name', 'jon')\n ctx.status = 204\n })\n\n await request(app.callback())\n .get('/')\n .expect('name', 'jon')\n .expect(204)\n })\n })\n})\n" }, { "path": "__tests__/context/inspect.test.js", "content": "'use strict'\n\nconst { describe, it } = require('node:test')\nconst prototype = require('../../lib/context')\nconst assert = require('node:assert/strict')\nconst util = require('util')\nconst context = require('../../test-helpers/context')\n\ndescribe('ctx.inspect()', () => {\n it('should return a json representation', () => {\n const ctx = context()\n const toJSON = ctx.toJSON(ctx)\n\n assert.deepStrictEqual(toJSON, ctx.inspect())\n assert.deepStrictEqual(util.inspect(toJSON), util.inspect(ctx))\n })\n\n // console.log(require.cache) will call prototype.inspect()\n it('should not crash when called on the prototype', () => {\n assert.deepStrictEqual(prototype, prototype.inspect())\n assert.deepStrictEqual(util.inspect(prototype.inspect()), util.inspect(prototype))\n })\n})\n" }, { "path": "__tests__/context/onerror.test.js", "content": "'use strict'\n\nconst { describe, it } = require('node:test')\nconst assert = require('node:assert/strict')\nconst request = require('supertest')\nconst Koa = require('../..')\nconst context = require('../../test-helpers/context')\n\ndescribe('ctx.onerror(err)', () => {\n it('should respond', () => {\n const app = new Koa()\n\n app.use((ctx, next) => {\n ctx.body = 'something else'\n\n ctx.throw(418, 'boom')\n })\n\n return request(app.callback())\n .get('/')\n .expect(418)\n .expect('Content-Type', 'text/plain; charset=utf-8')\n .expect('Content-Length', '4')\n })\n\n it('should unset all headers', async () => {\n const app = new Koa()\n\n app.use((ctx, next) => {\n ctx.set('Vary', 'Accept-Encoding')\n ctx.set('X-CSRF-Token', 'asdf')\n ctx.body = 'response'\n\n ctx.throw(418, 'boom')\n })\n\n const res = await request(app.callback())\n .get('/')\n .expect(418)\n .expect('Content-Type', 'text/plain; charset=utf-8')\n .expect('Content-Length', '4')\n\n assert.strictEqual(Object.prototype.hasOwnProperty.call(res.headers, 'vary'), false)\n assert.strictEqual(Object.prototype.hasOwnProperty.call(res.headers, 'x-csrf-token'), false)\n })\n\n it('should set headers specified in the error', async () => {\n const app = new Koa()\n\n app.use((ctx, next) => {\n ctx.set('Vary', 'Accept-Encoding')\n ctx.set('X-CSRF-Token', 'asdf')\n ctx.body = 'response'\n\n throw Object.assign(new Error('boom'), {\n status: 418,\n expose: true,\n headers: {\n 'X-New-Header': 'Value'\n }\n })\n })\n\n const res = await request(app.callback())\n .get('/')\n .expect(418)\n .expect('Content-Type', 'text/plain; charset=utf-8')\n .expect('X-New-Header', 'Value')\n\n assert.strictEqual(Object.prototype.hasOwnProperty.call(res.headers, 'vary'), false)\n assert.strictEqual(Object.prototype.hasOwnProperty.call(res.headers, 'x-csrf-token'), false)\n })\n\n it('should ignore error after headerSent', async () => {\n const app = new Koa()\n\n app.on('error', (err, { res }) => {\n assert.strictEqual(err.message, 'mock error')\n assert.strictEqual(err.headerSent, true)\n res.end()\n })\n\n app.use(async ctx => {\n ctx.status = 200\n ctx.set('X-Foo', 'Bar')\n ctx.flushHeaders()\n await Promise.reject(new Error('mock error'))\n ctx.body = 'response'\n })\n\n await request(app.callback())\n .get('/')\n .expect('X-Foo', 'Bar')\n .expect(200)\n })\n\n it('should set status specified in the error using statusCode', () => {\n const app = new Koa()\n\n app.use((ctx, next) => {\n ctx.body = 'something else'\n const err = new Error('Not found')\n err.statusCode = 404\n throw err\n })\n\n return request(app.callback())\n .get('/')\n .expect(404)\n .expect('Content-Type', 'text/plain; charset=utf-8')\n .expect('Not Found')\n })\n\n describe('when invalid err.statusCode', () => {\n describe('not number', () => {\n it('should respond 500', () => {\n const app = new Koa()\n\n app.use((ctx, next) => {\n ctx.body = 'something else'\n const err = new Error('some error')\n err.statusCode = 'notnumber'\n throw err\n })\n\n return request(app.callback())\n .get('/')\n .expect(500)\n .expect('Content-Type', 'text/plain; charset=utf-8')\n .expect('Internal Server Error')\n })\n })\n })\n\n describe('when invalid err.status', () => {\n describe('not number', () => {\n it('should respond 500', () => {\n const app = new Koa()\n\n app.use((ctx, next) => {\n ctx.body = 'something else'\n const err = new Error('some error')\n err.status = 'notnumber'\n throw err\n })\n\n return request(app.callback())\n .get('/')\n .expect(500)\n .expect('Content-Type', 'text/plain; charset=utf-8')\n .expect('Internal Server Error')\n })\n })\n describe('not http status code', () => {\n it('should respond 500', () => {\n const app = new Koa()\n\n app.use((ctx, next) => {\n ctx.body = 'something else'\n const err = new Error('some error')\n err.status = 9999\n throw err\n })\n\n return request(app.callback())\n .get('/')\n .expect(500)\n .expect('Content-Type', 'text/plain; charset=utf-8')\n .expect('Internal Server Error')\n })\n })\n })\n\n describe('when error from another scope thrown', () => {\n it('should handle it like a normal error', async () => {\n const ExternError = require('vm').runInNewContext('Error')\n\n const app = new Koa()\n const error = Object.assign(new ExternError('boom'), {\n status: 418,\n expose: true\n })\n app.use((ctx, next) => {\n throw error\n })\n\n const gotRightErrorPromise = new Promise((resolve, reject) => {\n app.on('error', receivedError => {\n try {\n assert.strictEqual(receivedError, error)\n resolve()\n } catch (e) {\n reject(e)\n }\n })\n })\n\n await request(app.callback())\n .get('/')\n .expect(418)\n\n await gotRightErrorPromise\n })\n })\n\n describe('when non-error thrown', () => {\n it('should respond with non-error thrown message', () => {\n const app = new Koa()\n\n app.use((ctx, next) => {\n throw 'string error' // eslint-disable-line no-throw-literal\n })\n\n return request(app.callback())\n .get('/')\n .expect(500)\n .expect('Content-Type', 'text/plain; charset=utf-8')\n .expect('Internal Server Error')\n })\n\n it('should use res.getHeaderNames() accessor when available', () => {\n let removed = 0\n const ctx = context()\n\n ctx.app.emit = () => {}\n ctx.res = {\n getHeaderNames: () => ['content-type', 'content-length'],\n removeHeader: () => removed++,\n end: () => {},\n emit: () => {}\n }\n\n ctx.onerror(new Error('error'))\n\n assert.strictEqual(removed, 2)\n })\n\n it('should stringify error if it is an object', async () => {\n const app = new Koa()\n\n app.on('error', err => {\n let assertionRan = false\n assert.strictEqual(err.message, 'non-error thrown: {\"key\":\"value\"}')\n assertionRan = true\n assert(assertionRan, 'assertion was not executed')\n })\n\n app.use(async ctx => {\n throw { key: 'value' } // eslint-disable-line no-throw-literal\n })\n\n await request(app.callback())\n .get('/')\n .expect(500)\n .expect('Internal Server Error')\n })\n })\n})\n" }, { "path": "__tests__/context/state.test.js", "content": "'use strict'\n\nconst { describe, it } = require('node:test')\nconst request = require('supertest')\nconst assert = require('node:assert/strict')\nconst Koa = require('../..')\n\ndescribe('ctx.state', () => {\n it('should provide a ctx.state namespace', () => {\n const app = new Koa()\n\n app.use(ctx => {\n assert.deepStrictEqual(ctx.state, {})\n })\n\n return request(app.callback())\n .get('/')\n .expect(404)\n })\n})\n" }, { "path": "__tests__/context/throw.test.js", "content": "'use strict'\n\nconst { describe, it } = require('node:test')\nconst context = require('../../test-helpers/context')\nconst assert = require('node:assert/strict')\n\ndescribe('ctx.throw(msg)', () => {\n it('should set .status to 500', () => {\n const ctx = context()\n\n try {\n ctx.throw('boom')\n } catch (err) {\n assert.strictEqual(err.status, 500)\n assert.strictEqual(err.expose, false)\n }\n })\n})\n\ndescribe('ctx.throw(err)', () => {\n it('should set .status to 500', () => {\n const ctx = context()\n const err = new Error('test')\n\n try {\n ctx.throw(err)\n } catch (err) {\n assert.strictEqual(err.status, 500)\n assert.strictEqual(err.message, 'test')\n assert.strictEqual(err.expose, false)\n }\n })\n})\n\ndescribe('ctx.throw(status, err)', () => {\n it('should throw the error and set .status', () => {\n const ctx = context()\n const error = new Error('test')\n\n try {\n ctx.throw(422, error)\n } catch (err) {\n assert.strictEqual(err.status, 422)\n assert.strictEqual(err.message, 'test')\n assert.strictEqual(err.expose, true)\n }\n })\n})\n\ndescribe('ctx.throw(status, msg)', () => {\n it('should throw an error', () => {\n const ctx = context()\n\n try {\n ctx.throw(400, 'name required')\n } catch (err) {\n assert.strictEqual(err.message, 'name required')\n assert.strictEqual(400, err.status)\n assert.strictEqual(true, err.expose)\n }\n })\n})\n\ndescribe('ctx.throw(status)', () => {\n it('should throw an error', () => {\n const ctx = context()\n\n try {\n ctx.throw(400)\n } catch (err) {\n assert.strictEqual(err.message, 'Bad Request')\n assert.strictEqual(err.status, 400)\n assert.strictEqual(err.expose, true)\n }\n })\n\n describe('when not valid status', () => {\n it('should not expose', () => {\n const ctx = context()\n\n try {\n const err = new Error('some error')\n err.status = -1\n ctx.throw(err)\n } catch (err) {\n assert.strictEqual(err.message, 'some error')\n assert.strictEqual(err.expose, false)\n }\n })\n })\n})\n\ndescribe('ctx.throw(status, msg, props)', () => {\n it('should mixin props', () => {\n const ctx = context()\n\n try {\n ctx.throw(400, 'msg', { prop: true })\n } catch (err) {\n assert.strictEqual(err.message, 'msg')\n assert.strictEqual(err.status, 400)\n assert.strictEqual(err.expose, true)\n assert.strictEqual(err.prop, true)\n }\n })\n\n describe('when props include status', () => {\n it('should be ignored', () => {\n const ctx = context()\n\n try {\n ctx.throw(400, 'msg', {\n prop: true,\n status: -1\n })\n } catch (err) {\n assert.strictEqual(err.message, 'msg')\n assert.strictEqual(err.status, 400)\n assert.strictEqual(err.expose, true)\n assert.strictEqual(err.prop, true)\n }\n })\n })\n})\n\ndescribe('ctx.throw(msg, props)', () => {\n it('should mixin props', () => {\n const ctx = context()\n\n try {\n ctx.throw('msg', { prop: true })\n } catch (err) {\n assert.strictEqual(err.message, 'msg')\n assert.strictEqual(err.status, 500)\n assert.strictEqual(err.expose, false)\n assert.strictEqual(err.prop, true)\n }\n })\n})\n\ndescribe('ctx.throw(status, props)', () => {\n it('should mixin props', () => {\n const ctx = context()\n\n try {\n ctx.throw(400, { prop: true })\n } catch (err) {\n assert.strictEqual(err.message, 'Bad Request')\n assert.strictEqual(err.status, 400)\n assert.strictEqual(err.expose, true)\n assert.strictEqual(err.prop, true)\n }\n })\n})\n\ndescribe('ctx.throw(err, props)', () => {\n it('should mixin props', () => {\n const ctx = context()\n\n try {\n ctx.throw(new Error('test'), { prop: true })\n } catch (err) {\n assert.strictEqual(err.message, 'test')\n assert.strictEqual(err.status, 500)\n assert.strictEqual(err.expose, false)\n assert.strictEqual(err.prop, true)\n }\n })\n})\n" }, { "path": "__tests__/context/toJSON.test.js", "content": "'use strict'\n\nconst { describe, it } = require('node:test')\nconst assert = require('node:assert/strict')\nconst context = require('../../test-helpers/context')\n\ndescribe('ctx.toJSON()', () => {\n it('should return a json representation', () => {\n const ctx = context()\n\n ctx.req.method = 'POST'\n ctx.req.url = '/items'\n ctx.req.headers['content-type'] = 'text/plain'\n ctx.status = 200\n ctx.body = '

Hey

'\n\n const obj = JSON.parse(JSON.stringify(ctx))\n const req = obj.request\n const res = obj.response\n\n assert.deepStrictEqual({\n method: 'POST',\n url: '/items',\n header: {\n 'content-type': 'text/plain'\n }\n }, req)\n\n assert.deepStrictEqual({\n status: 200,\n message: 'OK',\n header: {\n 'content-type': 'text/html; charset=utf-8',\n 'content-length': 10\n }\n }, res)\n })\n})\n" }, { "path": "__tests__/lib/search-params.test.js", "content": "const { describe, it } = require('node:test')\nconst sp = require('../../lib/search-params')\nconst assert = require('node:assert/strict')\n\ndescribe('search-params', () => {\n describe('stringify', () => {\n it('Should stringify a simple object', () => {\n assert.deepStrictEqual(sp.stringify({ a: 1, b: 'b' }), 'a=1&b=b')\n })\n\n it('Should stringify an object with an array', () => {\n assert.deepStrictEqual(sp.stringify({ a: [1, 2] }), 'a=1&a=2')\n })\n\n it('Should stringify an object with an array with a single value', () => {\n assert.deepStrictEqual(sp.stringify({ a: [1] }), 'a=1')\n })\n\n it('Stringify an object with an array with a single empty value', () => {\n assert.deepStrictEqual(sp.stringify({ a: [''] }), 'a=')\n })\n\n it('Should not stringify an object with a nested object', () => {\n assert.deepStrictEqual(sp.stringify({ a: { b: 1 } }), 'a=')\n })\n })\n\n describe('parse', () => {\n it('Should parse a simple query string', () => {\n assert.deepStrictEqual(sp.parse('a=1&b=2'), { a: '1', b: '2' })\n })\n\n it('Should parse a query string with same key and multiple values', () => {\n assert.deepEqual(sp.parse('a=1&a=2'), { a: ['1', '2'] })\n })\n\n it('Should parse a query string with an array with a single empty value', () => {\n assert.deepStrictEqual(sp.parse('a='), { a: '' })\n })\n })\n})\n" }, { "path": "__tests__/load-with-esm.test.js", "content": "const { describe, it } = require('node:test')\nconst assert = require('node:assert/strict')\n\ndescribe('Load with esm', () => {\n it('should default export koa', async () => {\n const exported = await import('koa')\n const required = require('../')\n assert.strictEqual(exported.default, required)\n })\n\n it('should match exports own property names', async () => {\n const exported = new Set(Object.getOwnPropertyNames(await import('koa')))\n const required = new Set(Object.getOwnPropertyNames(require('../')))\n\n // Remove constructor properties + default export.\n for (const k of ['prototype', 'length', 'name']) {\n required.delete(k)\n }\n\n // Commented out to \"fix\" CommonJS, ESM, bundling issue.\n // @see https://github.com/koajs/koa/issues/1513\n // exported.delete('default');\n\n assert.strictEqual(exported.size, required.size)\n assert.strictEqual([...exported].every(property => required.has(property)), true)\n })\n\n it('CommonJS exports default property', async () => {\n const required = require('../')\n assert.strictEqual(Object.prototype.hasOwnProperty.call(required, 'default'), true)\n })\n\n it('CommonJS exports default property referencing self', async () => {\n const required = require('../')\n assert.strictEqual(required.default, required)\n })\n})\n" }, { "path": "__tests__/request/accept.test.js", "content": "'use strict'\n\nconst { describe, it } = require('node:test')\nconst Accept = require('accepts')\nconst assert = require('node:assert/strict')\nconst context = require('../../test-helpers/context')\n\ndescribe('ctx.accept', () => {\n it('should return an Accept instance', () => {\n const ctx = context()\n ctx.req.headers.accept = 'application/*;q=0.2, image/jpeg;q=0.8, text/html, text/plain'\n assert(ctx.accept instanceof Accept)\n })\n})\n\ndescribe('ctx.accept=', () => {\n it('should replace the accept object', () => {\n const ctx = context()\n ctx.req.headers.accept = 'text/plain'\n assert.deepStrictEqual(ctx.accepts(), ['text/plain'])\n\n const request = context.request()\n request.req.headers.accept = 'application/*;q=0.2, image/jpeg;q=0.8, text/html, text/plain'\n ctx.accept = Accept(request.req)\n assert.deepStrictEqual(ctx.accepts(), ['text/html', 'text/plain', 'image/jpeg', 'application/*'])\n })\n})\n" }, { "path": "__tests__/request/accepts.test.js", "content": "'use strict'\n\nconst { describe, it } = require('node:test')\nconst assert = require('node:assert/strict')\nconst context = require('../../test-helpers/context')\n\ndescribe('ctx.accepts(types)', () => {\n describe('with no arguments', () => {\n describe('when Accept is populated', () => {\n it('should return all accepted types', () => {\n const ctx = context()\n ctx.req.headers.accept = 'application/*;q=0.2, image/jpeg;q=0.8, text/html, text/plain'\n assert.deepStrictEqual(ctx.accepts(), ['text/html', 'text/plain', 'image/jpeg', 'application/*'])\n })\n })\n })\n\n describe('with no valid types', () => {\n describe('when Accept is populated', () => {\n it('should return false', () => {\n const ctx = context()\n ctx.req.headers.accept = 'application/*;q=0.2, image/jpeg;q=0.8, text/html, text/plain'\n assert.strictEqual(ctx.accepts('image/png', 'image/tiff'), false)\n })\n })\n\n describe('when Accept is not populated', () => {\n it('should return the first type', () => {\n const ctx = context()\n assert.strictEqual(ctx.accepts('text/html', 'text/plain', 'image/jpeg', 'application/*'), 'text/html')\n })\n })\n })\n\n describe('when extensions are given', () => {\n it('should convert to mime types', () => {\n const ctx = context()\n ctx.req.headers.accept = 'text/plain, text/html'\n assert.strictEqual(ctx.accepts('html'), 'html')\n assert.strictEqual(ctx.accepts('.html'), '.html')\n assert.strictEqual(ctx.accepts('txt'), 'txt')\n assert.strictEqual(ctx.accepts('.txt'), '.txt')\n assert.strictEqual(ctx.accepts('png'), false)\n })\n })\n\n describe('when an array is given', () => {\n it('should return the first match', () => {\n const ctx = context()\n ctx.req.headers.accept = 'text/plain, text/html'\n assert.strictEqual(ctx.accepts(['png', 'text', 'html']), 'text')\n assert.strictEqual(ctx.accepts(['png', 'html']), 'html')\n })\n })\n\n describe('when multiple arguments are given', () => {\n it('should return the first match', () => {\n const ctx = context()\n ctx.req.headers.accept = 'text/plain, text/html'\n assert.strictEqual(ctx.accepts('png', 'text', 'html'), 'text')\n assert.strictEqual(ctx.accepts('png', 'html'), 'html')\n })\n })\n\n describe('when value present in Accept is an exact match', () => {\n it('should return the type', () => {\n const ctx = context()\n ctx.req.headers.accept = 'text/plain, text/html'\n assert.strictEqual(ctx.accepts('text/html'), 'text/html')\n assert.strictEqual(ctx.accepts('text/plain'), 'text/plain')\n })\n })\n\n describe('when value present in Accept is a type match', () => {\n it('should return the type', () => {\n const ctx = context()\n ctx.req.headers.accept = 'application/json, */*'\n assert.strictEqual(ctx.accepts('text/html'), 'text/html')\n assert.strictEqual(ctx.accepts('text/plain'), 'text/plain')\n assert.strictEqual(ctx.accepts('image/png'), 'image/png')\n })\n })\n\n describe('when value present in Accept is a subtype match', () => {\n it('should return the type', () => {\n const ctx = context()\n ctx.req.headers.accept = 'application/json, text/*'\n assert.strictEqual(ctx.accepts('text/html'), 'text/html')\n assert.strictEqual(ctx.accepts('text/plain'), 'text/plain')\n assert.strictEqual(ctx.accepts('image/png'), false)\n assert.strictEqual(ctx.accepts('png'), false)\n })\n })\n})\n" }, { "path": "__tests__/request/acceptsCharsets.test.js", "content": "'use strict'\n\nconst { describe, it } = require('node:test')\nconst assert = require('node:assert/strict')\nconst context = require('../../test-helpers/context')\n\ndescribe('ctx.acceptsCharsets()', () => {\n describe('with no arguments', () => {\n describe('when Accept-Charset is populated', () => {\n it('should return accepted types', () => {\n const ctx = context()\n ctx.req.headers['accept-charset'] = 'utf-8, iso-8859-1;q=0.2, utf-7;q=0.5'\n assert.deepStrictEqual(ctx.acceptsCharsets(), ['utf-8', 'utf-7', 'iso-8859-1'])\n })\n })\n })\n\n describe('with multiple arguments', () => {\n describe('when Accept-Charset is populated', () => {\n describe('if any types match', () => {\n it('should return the best fit', () => {\n const ctx = context()\n ctx.req.headers['accept-charset'] = 'utf-8, iso-8859-1;q=0.2, utf-7;q=0.5'\n assert.strictEqual(ctx.acceptsCharsets('utf-7', 'utf-8'), 'utf-8')\n })\n })\n\n describe('if no types match', () => {\n it('should return false', () => {\n const ctx = context()\n ctx.req.headers['accept-charset'] = 'utf-8, iso-8859-1;q=0.2, utf-7;q=0.5'\n assert.strictEqual(ctx.acceptsCharsets('utf-16'), false)\n })\n })\n })\n\n describe('when Accept-Charset is not populated', () => {\n it('should return the first type', () => {\n const ctx = context()\n assert.strictEqual(ctx.acceptsCharsets('utf-7', 'utf-8'), 'utf-7')\n })\n })\n })\n\n describe('with an array', () => {\n it('should return the best fit', () => {\n const ctx = context()\n ctx.req.headers['accept-charset'] = 'utf-8, iso-8859-1;q=0.2, utf-7;q=0.5'\n assert.strictEqual(ctx.acceptsCharsets(['utf-7', 'utf-8']), 'utf-8')\n })\n })\n})\n" }, { "path": "__tests__/request/acceptsEncodings.test.js", "content": "'use strict'\n\nconst { describe, it } = require('node:test')\nconst assert = require('node:assert/strict')\nconst context = require('../../test-helpers/context')\n\ndescribe('ctx.acceptsEncodings()', () => {\n describe('with no arguments', () => {\n describe('when Accept-Encoding is populated', () => {\n it('should return accepted types', () => {\n const ctx = context()\n ctx.req.headers['accept-encoding'] = 'gzip, compress;q=0.2'\n assert.deepStrictEqual(ctx.acceptsEncodings(), ['gzip', 'compress', 'identity'])\n assert.strictEqual(ctx.acceptsEncodings('gzip', 'compress'), 'gzip')\n })\n })\n\n describe('when Accept-Encoding is not populated', () => {\n it('should return identity', () => {\n const ctx = context()\n assert.deepStrictEqual(ctx.acceptsEncodings(), ['identity'])\n assert.strictEqual(ctx.acceptsEncodings('gzip', 'deflate', 'identity'), 'identity')\n })\n })\n })\n\n describe('with multiple arguments', () => {\n it('should return the best fit', () => {\n const ctx = context()\n ctx.req.headers['accept-encoding'] = 'gzip, compress;q=0.2'\n assert.strictEqual(ctx.acceptsEncodings('compress', 'gzip'), 'gzip')\n assert.strictEqual(ctx.acceptsEncodings('gzip', 'compress'), 'gzip')\n })\n })\n\n describe('with an array', () => {\n it('should return the best fit', () => {\n const ctx = context()\n ctx.req.headers['accept-encoding'] = 'gzip, compress;q=0.2'\n assert.strictEqual(ctx.acceptsEncodings(['compress', 'gzip']), 'gzip')\n })\n })\n})\n" }, { "path": "__tests__/request/acceptsLanguages.test.js", "content": "'use strict'\n\nconst { describe, it } = require('node:test')\nconst assert = require('node:assert/strict')\nconst context = require('../../test-helpers/context')\n\ndescribe('ctx.acceptsLanguages(langs)', () => {\n describe('with no arguments', () => {\n describe('when Accept-Language is populated', () => {\n it('should return accepted types', () => {\n const ctx = context()\n ctx.req.headers['accept-language'] = 'en;q=0.8, es, pt'\n assert.deepStrictEqual(ctx.acceptsLanguages(), ['es', 'pt', 'en'])\n })\n })\n })\n\n describe('with multiple arguments', () => {\n describe('when Accept-Language is populated', () => {\n describe('if any types types match', () => {\n it('should return the best fit', () => {\n const ctx = context()\n ctx.req.headers['accept-language'] = 'en;q=0.8, es, pt'\n assert.strictEqual(ctx.acceptsLanguages('es', 'en'), 'es')\n })\n })\n\n describe('if no types match', () => {\n it('should return false', () => {\n const ctx = context()\n ctx.req.headers['accept-language'] = 'en;q=0.8, es, pt'\n assert.strictEqual(ctx.acceptsLanguages('fr', 'au'), false)\n })\n })\n })\n\n describe('when Accept-Language is not populated', () => {\n it('should return the first type', () => {\n const ctx = context()\n assert.strictEqual(ctx.acceptsLanguages('es', 'en'), 'es')\n })\n })\n })\n\n describe('with an array', () => {\n it('should return the best fit', () => {\n const ctx = context()\n ctx.req.headers['accept-language'] = 'en;q=0.8, es, pt'\n assert.strictEqual(ctx.acceptsLanguages(['es', 'en']), 'es')\n })\n })\n})\n" }, { "path": "__tests__/request/charset.test.js", "content": "'use strict'\n\nconst { describe, it } = require('node:test')\nconst request = require('../../test-helpers/context').request\nconst assert = require('node:assert/strict')\n\ndescribe('req.charset', () => {\n describe('with no content-type present', () => {\n it('should return \"\"', () => {\n const req = request()\n assert(req.charset === '')\n })\n })\n\n describe('with charset present', () => {\n it('should return \"\"', () => {\n const req = request()\n req.header['content-type'] = 'text/plain'\n assert(req.charset === '')\n })\n })\n\n describe('with a charset', () => {\n it('should return the charset', () => {\n const req = request()\n req.header['content-type'] = 'text/plain; charset=utf-8'\n assert.strictEqual(req.charset, 'utf-8')\n })\n\n it('should return \"\" if content-type is invalid', () => {\n const req = request()\n req.header['content-type'] = 'application/json; application/text; charset=utf-8'\n assert.strictEqual(req.charset, '')\n })\n })\n})\n" }, { "path": "__tests__/request/fresh.test.js", "content": "'use strict'\n\nconst { describe, it } = require('node:test')\nconst assert = require('node:assert/strict')\nconst context = require('../../test-helpers/context')\n\ndescribe('ctx.fresh', () => {\n describe('the request method is not GET and HEAD', () => {\n it('should return false', () => {\n const ctx = context()\n ctx.req.method = 'POST'\n assert.strictEqual(ctx.fresh, false)\n })\n })\n\n describe('the response is non-2xx', () => {\n it('should return false', () => {\n const ctx = context()\n ctx.status = 404\n ctx.req.method = 'GET'\n ctx.req.headers['if-none-match'] = '123'\n ctx.set('ETag', '123')\n assert.strictEqual(ctx.fresh, false)\n })\n })\n\n describe('the response is 2xx', () => {\n describe('and etag matches', () => {\n it('should return true', () => {\n const ctx = context()\n ctx.status = 200\n ctx.req.method = 'GET'\n ctx.req.headers['if-none-match'] = '123'\n ctx.set('ETag', '123')\n assert.strictEqual(ctx.fresh, true)\n })\n })\n\n describe('and etag does not match', () => {\n it('should return false', () => {\n const ctx = context()\n ctx.status = 200\n ctx.req.method = 'GET'\n ctx.req.headers['if-none-match'] = '123'\n ctx.set('ETag', 'hey')\n assert.strictEqual(ctx.fresh, false)\n })\n })\n })\n})\n" }, { "path": "__tests__/request/get.test.js", "content": "'use strict'\n\nconst { describe, it } = require('node:test')\nconst assert = require('node:assert/strict')\nconst context = require('../../test-helpers/context')\n\ndescribe('ctx.get(name)', () => {\n it('should return the field value', () => {\n const ctx = context()\n ctx.req.headers.host = 'http://google.com'\n ctx.req.headers.referer = 'http://google.com'\n assert.strictEqual(ctx.get('HOST'), 'http://google.com')\n assert.strictEqual(ctx.get('Host'), 'http://google.com')\n assert.strictEqual(ctx.get('host'), 'http://google.com')\n assert.strictEqual(ctx.get('referer'), 'http://google.com')\n assert.strictEqual(ctx.get('referrer'), 'http://google.com')\n })\n})\n" }, { "path": "__tests__/request/header.test.js", "content": "'use strict'\n\nconst { describe, it } = require('node:test')\nconst assert = require('node:assert/strict')\nconst request = require('../../test-helpers/context').request\n\ndescribe('req.header', () => {\n it('should return the request header object', () => {\n const req = request()\n assert.deepStrictEqual(req.header, req.req.headers)\n })\n\n it('should set the request header object', () => {\n const req = request()\n req.header = { 'X-Custom-Headerfield': 'Its one header, with headerfields' }\n assert.deepStrictEqual(req.header, req.req.headers)\n })\n})\n" }, { "path": "__tests__/request/headers.test.js", "content": "'use strict'\n\nconst { describe, it } = require('node:test')\nconst assert = require('node:assert/strict')\nconst request = require('../../test-helpers/context').request\n\ndescribe('req.headers', () => {\n it('should return the request header object', () => {\n const req = request()\n assert.deepStrictEqual(req.headers, req.req.headers)\n })\n\n it('should set the request header object', () => {\n const req = request()\n req.headers = { 'X-Custom-Headerfield': 'Its one header, with headerfields' }\n assert.deepStrictEqual(req.headers, req.req.headers)\n })\n})\n" }, { "path": "__tests__/request/host.test.js", "content": "'use strict'\n\nconst { describe, it } = require('node:test')\nconst request = require('../../test-helpers/context').request\nconst assert = require('node:assert/strict')\n\ndescribe('req.host', () => {\n it('should return host with port', () => {\n const req = request()\n req.header.host = 'foo.com:3000'\n assert.strictEqual(req.host, 'foo.com:3000')\n })\n\n describe('with no host present', () => {\n it('should return \"\"', () => {\n const req = request()\n assert.strictEqual(req.host, '')\n })\n })\n\n describe('when less then HTTP/2', () => {\n it('should not use :authority header', () => {\n const req = request({\n httpVersionMajor: 1,\n httpVersion: '1.1'\n })\n req.header[':authority'] = 'foo.com:3000'\n req.header.host = 'bar.com:8000'\n assert.strictEqual(req.host, 'bar.com:8000')\n })\n })\n\n describe('when HTTP/2', () => {\n it('should use :authority header', () => {\n const req = request({\n httpVersionMajor: 2,\n httpVersion: '2.0'\n })\n req.header[':authority'] = 'foo.com:3000'\n req.header.host = 'bar.com:8000'\n assert.strictEqual(req.host, 'foo.com:3000')\n })\n\n it('should use host header as fallback', () => {\n const req = request({\n httpVersionMajor: 2,\n httpVersion: '2.0'\n })\n req.header.host = 'bar.com:8000'\n assert.strictEqual(req.host, 'bar.com:8000')\n })\n })\n\n describe('when X-Forwarded-Host is present', () => {\n describe('and proxy is not trusted', () => {\n it('should be ignored on HTTP/1', () => {\n const req = request()\n req.header['x-forwarded-host'] = 'bar.com'\n req.header.host = 'foo.com'\n assert.strictEqual(req.host, 'foo.com')\n })\n\n it('should be ignored on HTTP/2', () => {\n const req = request({\n httpVersionMajor: 2,\n httpVersion: '2.0'\n })\n req.header['x-forwarded-host'] = 'proxy.com:8080'\n req.header[':authority'] = 'foo.com:3000'\n req.header.host = 'bar.com:8000'\n assert.strictEqual(req.host, 'foo.com:3000')\n })\n })\n\n describe('and proxy is trusted', () => {\n it('should be used on HTTP/1', () => {\n const req = request()\n req.app.proxy = true\n req.header['x-forwarded-host'] = 'bar.com, baz.com'\n req.header.host = 'foo.com'\n assert.strictEqual(req.host, 'bar.com')\n })\n\n it('should be used on HTTP/2', () => {\n const req = request({\n httpVersionMajor: 2,\n httpVersion: '2.0'\n })\n req.app.proxy = true\n req.header['x-forwarded-host'] = 'proxy.com:8080'\n req.header[':authority'] = 'foo.com:3000'\n req.header.host = 'bar.com:8000'\n assert.strictEqual(req.host, 'proxy.com:8080')\n })\n })\n })\n\n describe('with Host header containing @', () => {\n it('should correctly parse host from userinfo@host format', () => {\n const req = request()\n req.header.host = 'evil.com:fake@legitimate.com'\n assert.strictEqual(req.host, 'legitimate.com')\n })\n\n it('should correctly parse host from user@host format', () => {\n const req = request()\n req.header.host = 'user@example.com'\n assert.strictEqual(req.host, 'example.com')\n })\n\n it('should correctly parse host with port from userinfo@host:port format', () => {\n const req = request()\n req.header.host = 'user:pass@example.com:8080'\n assert.strictEqual(req.host, 'example.com:8080')\n })\n\n it('should correctly parse @ in X-Forwarded-Host when proxy is trusted', () => {\n const req = request()\n req.app.proxy = true\n req.header['x-forwarded-host'] = 'evil.com:fake@legitimate.com'\n req.header.host = 'foo.com'\n assert.strictEqual(req.host, 'legitimate.com')\n })\n\n it('should correctly parse @ in :authority on HTTP/2', () => {\n const req = request({\n httpVersionMajor: 2,\n httpVersion: '2.0'\n })\n req.header[':authority'] = 'evil.com:fake@legitimate.com'\n req.header.host = 'foo.com'\n assert.strictEqual(req.host, 'legitimate.com')\n })\n\n it('should return empty string for invalid host with @', () => {\n const req = request()\n req.header.host = 'user@'\n assert.strictEqual(req.host, '')\n })\n })\n})\n" }, { "path": "__tests__/request/hostname.test.js", "content": "'use strict'\n\nconst { describe, it } = require('node:test')\nconst request = require('../../test-helpers/context').request\nconst assert = require('node:assert/strict')\n\ndescribe('req.hostname', () => {\n it('should return hostname void of port', () => {\n const req = request()\n req.header.host = 'foo.com:3000'\n assert.strictEqual(req.hostname, 'foo.com')\n })\n\n describe('with no host present', () => {\n it('should return \"\"', () => {\n const req = request()\n assert.strictEqual(req.hostname, '')\n })\n })\n\n describe('with IPv6 in host', () => {\n it('should parse localhost void of port', () => {\n const req = request()\n req.header.host = '[::1]'\n assert.strictEqual(req.hostname, '[::1]')\n })\n\n it('should parse localhost with port 80', () => {\n const req = request()\n req.header.host = '[::1]:80'\n assert.strictEqual(req.hostname, '[::1]')\n })\n\n it('should parse localhost with non-special schema port', () => {\n const req = request()\n req.header.host = '[::1]:1337'\n assert.strictEqual(req.hostname, '[::1]')\n })\n\n it('should reduce IPv6 with non-special schema port as hostname', () => {\n const req = request()\n req.header.host = '[2001:cdba:0000:0000:0000:0000:3257:9652]:1337'\n assert.strictEqual(req.hostname, '[2001:cdba::3257:9652]')\n })\n\n it('should return empty string when invalid', () => {\n const req = request()\n req.header.host = '[invalidIPv6]'\n assert.strictEqual(req.hostname, '')\n })\n })\n\n describe('when X-Forwarded-Host is present', () => {\n describe('and proxy is not trusted', () => {\n it('should be ignored', () => {\n const req = request()\n req.header['x-forwarded-host'] = 'bar.com'\n req.header.host = 'foo.com'\n assert.strictEqual(req.hostname, 'foo.com')\n })\n })\n\n describe('and proxy is trusted', () => {\n it('should be used', () => {\n const req = request()\n req.app.proxy = true\n req.header['x-forwarded-host'] = 'bar.com, baz.com'\n req.header.host = 'foo.com'\n assert.strictEqual(req.hostname, 'bar.com')\n })\n })\n })\n\n describe('with Host header containing @', () => {\n it('should correctly parse hostname from userinfo@host format', () => {\n const req = request()\n req.header.host = 'evil.com:fake@legitimate.com'\n assert.strictEqual(req.hostname, 'legitimate.com')\n })\n\n it('should correctly parse hostname from user@host format', () => {\n const req = request()\n req.header.host = 'user@example.com'\n assert.strictEqual(req.hostname, 'example.com')\n })\n\n it('should correctly parse hostname with port from userinfo@host:port format', () => {\n const req = request()\n req.header.host = 'user:pass@example.com:8080'\n assert.strictEqual(req.hostname, 'example.com')\n })\n\n it('should correctly parse @ in X-Forwarded-Host when proxy is trusted', () => {\n const req = request()\n req.app.proxy = true\n req.header['x-forwarded-host'] = 'evil.com:fake@legitimate.com'\n req.header.host = 'foo.com'\n assert.strictEqual(req.hostname, 'legitimate.com')\n })\n })\n})\n" }, { "path": "__tests__/request/href.test.js", "content": "'use strict'\n\nconst { describe, it } = require('node:test')\nconst assert = require('node:assert/strict')\nconst Stream = require('stream')\nconst request = require('supertest')\nconst Koa = require('../../')\nconst context = require('../../test-helpers/context')\n\ndescribe('ctx.href', () => {\n it('should return the full request url', () => {\n const socket = new Stream.Duplex()\n const req = {\n url: '/users/1?next=/dashboard',\n headers: {\n host: 'localhost'\n },\n socket,\n __proto__: Stream.Readable.prototype\n }\n const ctx = context(req)\n assert.strictEqual(ctx.href, 'http://localhost/users/1?next=/dashboard')\n // change it also work\n ctx.url = '/foo/users/1?next=/dashboard'\n assert.strictEqual(ctx.href, 'http://localhost/users/1?next=/dashboard')\n })\n\n it('should work with `GET http://example.com/foo`', async () => {\n const app = new Koa()\n app.use(ctx => {\n ctx.body = ctx.href\n })\n\n const res = await request(app.callback())\n .get('/foo')\n .set('Host', 'example.com')\n .expect(200)\n\n assert.strictEqual(res.text, 'http://example.com/foo')\n })\n})\n" }, { "path": "__tests__/request/idempotent.test.js", "content": "'use strict'\n\nconst { describe, it } = require('node:test')\nconst assert = require('node:assert/strict')\nconst request = require('../../test-helpers/context').request\n\ndescribe('ctx.idempotent', () => {\n describe('when the request method is idempotent', () => {\n it('should return true', () => {\n ['GET', 'HEAD', 'PUT', 'DELETE', 'OPTIONS', 'TRACE'].forEach(check)\n function check (method) {\n const req = request()\n req.method = method\n assert.strictEqual(req.idempotent, true)\n }\n })\n })\n\n describe('when the request method is not idempotent', () => {\n it('should return false', () => {\n const req = request()\n req.method = 'POST'\n assert.strictEqual(req.idempotent, false)\n })\n })\n})\n" }, { "path": "__tests__/request/inspect.test.js", "content": "'use strict'\n\nconst { describe, it } = require('node:test')\nconst request = require('../../test-helpers/context').request\nconst assert = require('node:assert/strict')\nconst util = require('util')\n\ndescribe('req.inspect()', () => {\n describe('with no request.req present', () => {\n it('should return null', () => {\n const req = request()\n req.method = 'GET'\n delete req.req\n assert(undefined === req.inspect())\n assert(util.inspect(req) === 'undefined')\n })\n })\n\n it('should return a json representation', () => {\n const req = request()\n req.method = 'GET'\n req.url = 'example.com'\n req.header.host = 'example.com'\n\n const expected = {\n method: 'GET',\n url: 'example.com',\n header: {\n host: 'example.com'\n }\n }\n\n assert.deepStrictEqual(req.inspect(), expected)\n assert.deepStrictEqual(util.inspect(req), util.inspect(expected))\n })\n})\n" }, { "path": "__tests__/request/ip.test.js", "content": "'use strict'\n\nconst { describe, it } = require('node:test')\nconst assert = require('node:assert/strict')\nconst Stream = require('stream')\nconst Koa = require('../..')\nconst Request = require('../../test-helpers/context').request\n\ndescribe('req.ip', () => {\n describe('with req.ips present', () => {\n it('should return req.ips[0]', () => {\n const app = new Koa()\n const req = { headers: {}, socket: new Stream.Duplex() }\n app.proxy = true\n req.headers['x-forwarded-for'] = '127.0.0.1'\n req.socket.remoteAddress = '127.0.0.2'\n const request = Request(req, undefined, app)\n assert.strictEqual(request.ip, '127.0.0.1')\n })\n })\n\n describe('with no req.ips present', () => {\n it('should return req.socket.remoteAddress', () => {\n const req = { socket: new Stream.Duplex() }\n req.socket.remoteAddress = '127.0.0.2'\n const request = Request(req)\n assert.strictEqual(request.ip, '127.0.0.2')\n })\n\n describe('with req.socket.remoteAddress not present', () => {\n it('should return an empty string', () => {\n const socket = new Stream.Duplex()\n Object.defineProperty(socket, 'remoteAddress', {\n get: () => undefined, // So that the helper doesn't override it with a reasonable value\n set: () => {}\n })\n assert.strictEqual(Request({ socket }).ip, '')\n })\n })\n })\n\n it('should be lazy inited and cached', () => {\n const req = { socket: new Stream.Duplex() }\n req.socket.remoteAddress = '127.0.0.2'\n const request = Request(req)\n assert.strictEqual(request.ip, '127.0.0.2')\n req.socket.remoteAddress = '127.0.0.1'\n assert.strictEqual(request.ip, '127.0.0.2')\n })\n\n it('should reset ip work', () => {\n const req = { socket: new Stream.Duplex() }\n req.socket.remoteAddress = '127.0.0.2'\n const request = Request(req)\n assert.strictEqual(request.ip, '127.0.0.2')\n request.ip = '127.0.0.1'\n assert.strictEqual(request.ip, '127.0.0.1')\n })\n})\n" }, { "path": "__tests__/request/ips.test.js", "content": "'use strict'\n\nconst { describe, it } = require('node:test')\nconst assert = require('node:assert/strict')\nconst request = require('../../test-helpers/context').request\n\ndescribe('req.ips', () => {\n describe('when X-Forwarded-For is present', () => {\n describe('and proxy is not trusted', () => {\n it('should be ignored', () => {\n const req = request()\n req.app.proxy = false\n req.header['x-forwarded-for'] = '127.0.0.1,127.0.0.2'\n assert.deepStrictEqual(req.ips, [])\n })\n })\n\n describe('and proxy is trusted', () => {\n it('should be used', () => {\n const req = request()\n req.app.proxy = true\n req.header['x-forwarded-for'] = '127.0.0.1,127.0.0.2'\n assert.deepStrictEqual(req.ips, ['127.0.0.1', '127.0.0.2'])\n })\n })\n })\n\n describe('when options.proxyIpHeader is present', () => {\n describe('and proxy is not trusted', () => {\n it('should be ignored', () => {\n const req = request()\n req.app.proxy = false\n req.app.proxyIpHeader = 'x-client-ip'\n req.header['x-client-ip'] = '127.0.0.1,127.0.0.2'\n assert.deepStrictEqual(req.ips, [])\n })\n })\n\n describe('and proxy is trusted', () => {\n it('should be used', () => {\n const req = request()\n req.app.proxy = true\n req.app.proxyIpHeader = 'x-client-ip'\n req.header['x-client-ip'] = '127.0.0.1,127.0.0.2'\n assert.deepStrictEqual(req.ips, ['127.0.0.1', '127.0.0.2'])\n })\n })\n })\n\n describe('when options.maxIpsCount is present', () => {\n describe('and proxy is not trusted', () => {\n it('should be ignored', () => {\n const req = request()\n req.app.proxy = false\n req.app.maxIpsCount = 1\n req.header['x-forwarded-for'] = '127.0.0.1,127.0.0.2'\n assert.deepStrictEqual(req.ips, [])\n })\n })\n\n describe('and proxy is trusted', () => {\n it('should be used', () => {\n const req = request()\n req.app.proxy = true\n req.app.maxIpsCount = 1\n req.header['x-forwarded-for'] = '127.0.0.1,127.0.0.2'\n assert.deepStrictEqual(req.ips, ['127.0.0.2'])\n })\n })\n })\n})\n" }, { "path": "__tests__/request/is.test.js", "content": "'use strict'\n\nconst { describe, it } = require('node:test')\nconst context = require('../../test-helpers/context')\nconst assert = require('node:assert/strict')\n\ndescribe('ctx.is(type)', () => {\n it('should ignore params', () => {\n const ctx = context()\n ctx.header['content-type'] = 'text/html; charset=utf-8'\n ctx.header['transfer-encoding'] = 'chunked'\n\n assert.strictEqual(ctx.is('text/*'), 'text/html')\n })\n\n describe('when no body is given', () => {\n it('should return null', () => {\n const ctx = context()\n\n assert.strictEqual(ctx.is(), null)\n assert.strictEqual(ctx.is('image/*'), null)\n assert.strictEqual(ctx.is('image/*', 'text/*'), null)\n })\n })\n\n describe('when no content type is given', () => {\n it('should return false', () => {\n const ctx = context()\n ctx.header['transfer-encoding'] = 'chunked'\n\n assert.strictEqual(ctx.is(), false)\n assert.strictEqual(ctx.is('image/*'), false)\n assert.strictEqual(ctx.is('text/*', 'image/*'), false)\n })\n })\n\n describe('give no types', () => {\n it('should return the mime type', () => {\n const ctx = context()\n ctx.header['content-type'] = 'image/png'\n ctx.header['transfer-encoding'] = 'chunked'\n\n assert.strictEqual(ctx.is(), 'image/png')\n })\n })\n\n describe('given one type', () => {\n it('should return the type or false', () => {\n const ctx = context()\n ctx.header['content-type'] = 'image/png'\n ctx.header['transfer-encoding'] = 'chunked'\n\n assert.strictEqual(ctx.is('png'), 'png')\n assert.strictEqual(ctx.is('.png'), '.png')\n assert.strictEqual(ctx.is('image/png'), 'image/png')\n assert.strictEqual(ctx.is('image/*'), 'image/png')\n assert.strictEqual(ctx.is('*/png'), 'image/png')\n\n assert.strictEqual(ctx.is('jpeg'), false)\n assert.strictEqual(ctx.is('.jpeg'), false)\n assert.strictEqual(ctx.is('image/jpeg'), false)\n assert.strictEqual(ctx.is('text/*'), false)\n assert.strictEqual(ctx.is('*/jpeg'), false)\n })\n })\n\n describe('given multiple types', () => {\n it('should return the first match or false', () => {\n const ctx = context()\n ctx.header['content-type'] = 'image/png'\n ctx.header['transfer-encoding'] = 'chunked'\n\n assert.strictEqual(ctx.is('png'), 'png')\n assert.strictEqual(ctx.is('.png'), '.png')\n assert.strictEqual(ctx.is('text/*', 'image/*'), 'image/png')\n assert.strictEqual(ctx.is('image/*', 'text/*'), 'image/png')\n assert.strictEqual(ctx.is('image/*', 'image/png'), 'image/png')\n assert.strictEqual(ctx.is('image/png', 'image/*'), 'image/png')\n\n assert.strictEqual(ctx.is(['text/*', 'image/*']), 'image/png')\n assert.strictEqual(ctx.is(['image/*', 'text/*']), 'image/png')\n assert.strictEqual(ctx.is(['image/*', 'image/png']), 'image/png')\n assert.strictEqual(ctx.is(['image/png', 'image/*']), 'image/png')\n\n assert.strictEqual(ctx.is('jpeg'), false)\n assert.strictEqual(ctx.is('.jpeg'), false)\n assert.strictEqual(ctx.is('text/*', 'application/*'), false)\n assert.strictEqual(ctx.is('text/html', 'text/plain', 'application/json; charset=utf-8'), false)\n })\n })\n\n describe('when Content-Type: application/x-www-form-urlencoded', () => {\n it('should match \"urlencoded\"', () => {\n const ctx = context()\n ctx.header['content-type'] = 'application/x-www-form-urlencoded'\n ctx.header['transfer-encoding'] = 'chunked'\n\n assert.strictEqual(ctx.is('urlencoded'), 'urlencoded')\n assert.strictEqual(ctx.is('json', 'urlencoded'), 'urlencoded')\n assert.strictEqual(ctx.is('urlencoded', 'json'), 'urlencoded')\n })\n })\n})\n" }, { "path": "__tests__/request/length.test.js", "content": "'use strict'\n\nconst { describe, it } = require('node:test')\nconst request = require('../../test-helpers/context').request\nconst assert = require('node:assert/strict')\n\ndescribe('ctx.length', () => {\n it('should return length in content-length', () => {\n const req = request()\n req.header['content-length'] = '10'\n assert.strictEqual(req.length, 10)\n })\n\n it('should return undefined with no content-length present', () => {\n const req = request()\n assert.strictEqual(req.length, undefined)\n })\n})\n" }, { "path": "__tests__/request/origin.test.js", "content": "'use strict'\n\nconst { describe, it } = require('node:test')\nconst assert = require('node:assert/strict')\nconst Stream = require('stream')\nconst context = require('../../test-helpers/context')\n\ndescribe('ctx.origin', () => {\n it('should return the origin of url', () => {\n const socket = new Stream.Duplex()\n const req = {\n url: '/users/1?next=/dashboard',\n headers: {\n host: 'localhost',\n origin: 'http://example.com'\n },\n socket,\n __proto__: Stream.Readable.prototype\n }\n const ctx = context(req)\n assert.strictEqual(ctx.origin, 'http://example.com')\n\n // change it also work\n ctx.url = '/foo/users/1?next=/dashboard'\n assert.strictEqual(ctx.origin, 'http://example.com')\n })\n})\n" }, { "path": "__tests__/request/path.test.js", "content": "'use strict'\n\nconst { describe, it } = require('node:test')\nconst assert = require('node:assert/strict')\nconst context = require('../../test-helpers/context')\nconst parseurl = require('parseurl')\n\ndescribe('ctx.path', () => {\n it('should return the pathname', () => {\n const ctx = context()\n ctx.url = '/login?next=/dashboard'\n assert.strictEqual(ctx.path, '/login')\n })\n})\n\ndescribe('ctx.path=', () => {\n it('should set the pathname', () => {\n const ctx = context()\n ctx.url = '/login?next=/dashboard'\n\n ctx.path = '/logout'\n assert.strictEqual(ctx.path, '/logout')\n assert.strictEqual(ctx.url, '/logout?next=/dashboard')\n })\n\n it('should change .url but not .originalUrl', () => {\n const ctx = context({ url: '/login' })\n ctx.path = '/logout'\n assert.strictEqual(ctx.url, '/logout')\n assert.strictEqual(ctx.originalUrl, '/login')\n assert.strictEqual(ctx.request.originalUrl, '/login')\n })\n\n it('should not affect parseurl', () => {\n const ctx = context({ url: '/login?foo=bar' })\n ctx.path = '/login'\n const url = parseurl(ctx.req)\n assert.strictEqual(url.path, '/login?foo=bar')\n })\n})\n" }, { "path": "__tests__/request/protocol.test.js", "content": "'use strict'\n\nconst { describe, it } = require('node:test')\nconst assert = require('node:assert/strict')\nconst request = require('../../test-helpers/context').request\n\ndescribe('req.protocol', () => {\n describe('when encrypted', () => {\n it('should return \"https\"', () => {\n const req = request()\n req.req.socket = { encrypted: true }\n assert.strictEqual(req.protocol, 'https')\n })\n })\n\n describe('when unencrypted', () => {\n it('should return \"http\"', () => {\n const req = request()\n req.req.socket = {}\n assert.strictEqual(req.protocol, 'http')\n })\n })\n\n describe('when X-Forwarded-Proto is set', () => {\n describe('and proxy is trusted', () => {\n it('should be used', () => {\n const req = request()\n req.app.proxy = true\n req.req.socket = {}\n req.header['x-forwarded-proto'] = 'https, http'\n assert.strictEqual(req.protocol, 'https')\n })\n\n describe('and X-Forwarded-Proto is empty', () => {\n it('should return \"http\"', () => {\n const req = request()\n req.app.proxy = true\n req.req.socket = {}\n req.header['x-forwarded-proto'] = ''\n assert.strictEqual(req.protocol, 'http')\n })\n })\n })\n\n describe('and proxy is not trusted', () => {\n it('should not be used', () => {\n const req = request()\n req.req.socket = {}\n req.header['x-forwarded-proto'] = 'https, http'\n assert.strictEqual(req.protocol, 'http')\n })\n })\n })\n})\n" }, { "path": "__tests__/request/query.test.js", "content": "'use strict'\n\nconst { describe, it } = require('node:test')\nconst assert = require('node:assert/strict')\nconst context = require('../../test-helpers/context')\n\ndescribe('ctx.query', () => {\n describe('when missing', () => {\n it('should return an empty object', () => {\n const ctx = context({ url: '/' })\n assert(!Object.keys(ctx.query).length)\n })\n\n it('should return the same object each time it\\'s accessed', () => {\n const ctx = context({ url: '/' })\n ctx.query.a = '2'\n assert.strictEqual(ctx.query.a, '2')\n })\n })\n\n it('should return a parsed query string', () => {\n const ctx = context({ url: '/?page=2' })\n assert.strictEqual(ctx.query.page, '2')\n })\n})\n\ndescribe('ctx.query=', () => {\n it('should stringify and replace the query string and search', () => {\n const ctx = context({ url: '/store/shoes' })\n ctx.query = { page: 2, color: 'blue' }\n assert.strictEqual(ctx.url, '/store/shoes?page=2&color=blue')\n assert.strictEqual(ctx.querystring, 'page=2&color=blue')\n assert.strictEqual(ctx.search, '?page=2&color=blue')\n })\n\n it('should change .url but not .originalUrl', () => {\n const ctx = context({ url: '/store/shoes' })\n ctx.query = { page: 2 }\n assert.strictEqual(ctx.url, '/store/shoes?page=2')\n assert.strictEqual(ctx.originalUrl, '/store/shoes')\n assert.strictEqual(ctx.request.originalUrl, '/store/shoes')\n })\n})\n" }, { "path": "__tests__/request/querystring.test.js", "content": "'use strict'\n\nconst { describe, it } = require('node:test')\nconst assert = require('node:assert/strict')\nconst context = require('../../test-helpers/context')\nconst parseurl = require('parseurl')\n\ndescribe('ctx.querystring', () => {\n it('should return the querystring', () => {\n const ctx = context({ url: '/store/shoes?page=2&color=blue' })\n assert.strictEqual(ctx.querystring, 'page=2&color=blue')\n })\n\n describe('when ctx.req not present', () => {\n it('should return an empty string', () => {\n const ctx = context()\n ctx.request.req = null\n assert.strictEqual(ctx.querystring, '')\n })\n })\n})\n\ndescribe('ctx.querystring=', () => {\n it('should replace the querystring', () => {\n const ctx = context({ url: '/store/shoes' })\n ctx.querystring = 'page=2&color=blue'\n assert.strictEqual(ctx.url, '/store/shoes?page=2&color=blue')\n assert.strictEqual(ctx.querystring, 'page=2&color=blue')\n })\n\n it('should update ctx.search and ctx.query', () => {\n const ctx = context({ url: '/store/shoes' })\n ctx.querystring = 'page=2&color=blue'\n assert.strictEqual(ctx.url, '/store/shoes?page=2&color=blue')\n assert.strictEqual(ctx.search, '?page=2&color=blue')\n assert.strictEqual(ctx.query.page, '2')\n assert.strictEqual(ctx.query.color, 'blue')\n })\n\n it('should change .url but not .originalUrl', () => {\n const ctx = context({ url: '/store/shoes' })\n ctx.querystring = 'page=2&color=blue'\n assert.strictEqual(ctx.url, '/store/shoes?page=2&color=blue')\n assert.strictEqual(ctx.originalUrl, '/store/shoes')\n assert.strictEqual(ctx.request.originalUrl, '/store/shoes')\n })\n\n it('should not affect parseurl', () => {\n const ctx = context({ url: '/login?foo=bar' })\n ctx.querystring = 'foo=bar'\n const url = parseurl(ctx.req)\n assert.strictEqual(url.path, '/login?foo=bar')\n })\n})\n" }, { "path": "__tests__/request/search.test.js", "content": "'use strict'\n\nconst { describe, it } = require('node:test')\nconst assert = require('node:assert/strict')\nconst context = require('../../test-helpers/context')\n\ndescribe('ctx.search=', () => {\n it('should replace the search', () => {\n const ctx = context({ url: '/store/shoes' })\n ctx.search = '?page=2&color=blue'\n assert.strictEqual(ctx.url, '/store/shoes?page=2&color=blue')\n assert.strictEqual(ctx.search, '?page=2&color=blue')\n })\n\n it('should update ctx.querystring and ctx.query', () => {\n const ctx = context({ url: '/store/shoes' })\n ctx.search = '?page=2&color=blue'\n assert.strictEqual(ctx.url, '/store/shoes?page=2&color=blue')\n assert.strictEqual(ctx.querystring, 'page=2&color=blue')\n assert.strictEqual(ctx.query.page, '2')\n assert.strictEqual(ctx.query.color, 'blue')\n })\n\n it('should change .url but not .originalUrl', () => {\n const ctx = context({ url: '/store/shoes' })\n ctx.search = '?page=2&color=blue'\n assert.strictEqual(ctx.url, '/store/shoes?page=2&color=blue')\n assert.strictEqual(ctx.originalUrl, '/store/shoes')\n assert.strictEqual(ctx.request.originalUrl, '/store/shoes')\n })\n\n describe('when missing', () => {\n it('should return \"\"', () => {\n const ctx = context({ url: '/store/shoes' })\n assert.strictEqual(ctx.search, '')\n })\n })\n})\n" }, { "path": "__tests__/request/secure.test.js", "content": "'use strict'\n\nconst { describe, it } = require('node:test')\nconst assert = require('node:assert/strict')\nconst request = require('../../test-helpers/context').request\n\ndescribe('req.secure', () => {\n it('should return true when encrypted', () => {\n const req = request()\n req.req.socket = { encrypted: true }\n assert.strictEqual(req.secure, true)\n })\n})\n" }, { "path": "__tests__/request/stale.test.js", "content": "'use strict'\n\nconst { describe, it } = require('node:test')\nconst assert = require('node:assert/strict')\nconst context = require('../../test-helpers/context')\n\ndescribe('req.stale', () => {\n it('should be the inverse of req.fresh', () => {\n const ctx = context()\n ctx.status = 200\n ctx.method = 'GET'\n ctx.req.headers['if-none-match'] = '\"123\"'\n ctx.set('ETag', '\"123\"')\n assert.strictEqual(ctx.fresh, true)\n assert.strictEqual(ctx.stale, false)\n })\n})\n" }, { "path": "__tests__/request/subdomains.test.js", "content": "'use strict'\n\nconst { describe, it } = require('node:test')\nconst assert = require('node:assert/strict')\nconst request = require('../../test-helpers/context').request\n\ndescribe('req.subdomains', () => {\n it('should return subdomain array', () => {\n const req = request()\n req.header.host = 'tobi.ferrets.example.com'\n req.app.subdomainOffset = 2\n assert.deepStrictEqual(req.subdomains, ['ferrets', 'tobi'])\n\n req.app.subdomainOffset = 3\n assert.deepStrictEqual(req.subdomains, ['tobi'])\n })\n\n it('should work with no host present', () => {\n const req = request()\n assert.deepStrictEqual(req.subdomains, [])\n })\n\n it('should check if the host is an ip address, even with a port', () => {\n const req = request()\n req.header.host = '127.0.0.1:3000'\n assert.deepStrictEqual(req.subdomains, [])\n })\n})\n" }, { "path": "__tests__/request/type.test.js", "content": "'use strict'\n\nconst { describe, it } = require('node:test')\nconst request = require('../../test-helpers/context').request\nconst assert = require('node:assert/strict')\n\ndescribe('req.type', () => {\n it('should return type void of parameters', () => {\n const req = request()\n req.header['content-type'] = 'text/html; charset=utf-8'\n assert.strictEqual(req.type, 'text/html')\n })\n\n it('should return empty string with no host present', () => {\n const req = request()\n assert.strictEqual(req.type, '')\n })\n})\n" }, { "path": "__tests__/request/whatwg-url.test.js", "content": "'use strict'\n\nconst { describe, it } = require('node:test')\nconst request = require('../../test-helpers/context').request\nconst assert = require('node:assert/strict')\n\ndescribe('req.URL', () => {\n it('should not throw when host is void', () => {\n // Accessing the URL should not throw.\n request().URL // eslint-disable-line no-unused-expressions\n })\n\n it('should not throw when header.host is invalid', () => {\n const req = request()\n req.header.host = 'invalid host'\n // Accessing the URL should not throw.\n req.URL // eslint-disable-line no-unused-expressions\n })\n\n it('should return empty object when invalid', () => {\n const req = request()\n req.header.host = 'invalid host'\n assert.deepStrictEqual(req.URL, Object.create(null))\n })\n})\n" }, { "path": "__tests__/response/append.test.js", "content": "'use strict'\n\nconst { describe, it } = require('node:test')\nconst assert = require('node:assert/strict')\nconst context = require('../../test-helpers/context')\n\ndescribe('ctx.append(name, val)', () => {\n it('should append multiple headers', () => {\n const ctx = context()\n ctx.append('x-foo', 'bar1')\n ctx.append('x-foo', 'bar2')\n assert.deepStrictEqual(ctx.response.header['x-foo'], ['bar1', 'bar2'])\n })\n\n it('should accept array of values', () => {\n const ctx = context()\n\n ctx.append('Set-Cookie', ['foo=bar', 'fizz=buzz'])\n ctx.append('Set-Cookie', 'hi=again')\n assert.deepStrictEqual(ctx.response.header['set-cookie'], ['foo=bar', 'fizz=buzz', 'hi=again'])\n })\n\n it('should get reset by res.set(field, val)', () => {\n const ctx = context()\n\n ctx.append('Link', '')\n ctx.append('Link', '')\n\n ctx.set('Link', '')\n\n assert.strictEqual(ctx.response.header.link, '')\n })\n\n it('should work with res.set(field, val) first', () => {\n const ctx = context()\n\n ctx.set('Link', '')\n ctx.append('Link', '')\n\n assert.deepStrictEqual(ctx.response.header.link, ['', ''])\n })\n})\n" }, { "path": "__tests__/response/attachment.test.js", "content": "'use strict'\n\nconst { describe, it } = require('node:test')\nconst assert = require('node:assert/strict')\nconst context = require('../../test-helpers/context')\nconst request = require('supertest')\nconst Koa = require('../..')\n\ndescribe('ctx.attachment([filename])', () => {\n describe('security: prevent Content-Type override (GHSA-c5vw-j4hf-j526)', () => {\n it('should NOT override Content-Type when already set', () => {\n const ctx = context()\n ctx.response.set('Content-Type', 'application/octet-stream')\n ctx.attachment('malicious.html')\n assert.strictEqual(ctx.response.get('Content-Type'), 'application/octet-stream')\n assert.strictEqual(ctx.response.header['content-disposition'], 'attachment; filename=\"malicious.html\"')\n })\n\n it('should preserve safe Content-Type for SVG files', () => {\n const ctx = context()\n ctx.response.set('Content-Type', 'application/octet-stream')\n ctx.attachment('image.svg')\n assert.strictEqual(ctx.response.get('Content-Type'), 'application/octet-stream')\n })\n\n it('should set Content-Type when not previously set', () => {\n const ctx = context()\n ctx.attachment('document.pdf')\n assert.strictEqual(ctx.response.get('Content-Type'), 'application/pdf')\n })\n })\n describe('when given a filename', () => {\n it('should set the filename param', () => {\n const ctx = context()\n ctx.attachment('path/to/tobi.png')\n const str = 'attachment; filename=\"tobi.png\"'\n assert.strictEqual(ctx.response.header['content-disposition'], str)\n })\n })\n\n describe('when omitting filename', () => {\n it('should not set filename param', () => {\n const ctx = context()\n ctx.attachment()\n assert.strictEqual(ctx.response.header['content-disposition'], 'attachment')\n })\n })\n\n describe('when given a non-ascii filename', () => {\n it('should set the encodeURI filename param', () => {\n const ctx = context()\n ctx.attachment('path/to/include-no-ascii-char-中文名-ok.png')\n const str = 'attachment; filename=\"include-no-ascii-char-???-ok.png\"; filename*=UTF-8\\'\\'include-no-ascii-char-%E4%B8%AD%E6%96%87%E5%90%8D-ok.png'\n assert.strictEqual(ctx.response.header['content-disposition'], str)\n })\n\n it('should work with http client', () => {\n const app = new Koa()\n\n app.use((ctx, next) => {\n ctx.attachment('path/to/include-no-ascii-char-中文名-ok.json')\n ctx.body = { foo: 'bar' }\n })\n\n return request(app.callback())\n .get('/')\n .expect('content-disposition', 'attachment; filename=\"include-no-ascii-char-???-ok.json\"; filename*=UTF-8\\'\\'include-no-ascii-char-%E4%B8%AD%E6%96%87%E5%90%8D-ok.json')\n .expect({ foo: 'bar' })\n .expect(200)\n })\n })\n})\n\n// reference test case of content-disposition module\ndescribe('contentDisposition(filename, options)', () => {\n describe('with \"fallback\" option', () => {\n it('should require a string or Boolean', () => {\n const ctx = context()\n assert.throws(() => { ctx.attachment('plans.pdf', { fallback: 42 }) },\n /fallback.*string/)\n })\n\n it('should default to true', () => {\n const ctx = context()\n ctx.attachment('€ rates.pdf')\n assert.strictEqual(ctx.response.header['content-disposition'],\n 'attachment; filename=\"? rates.pdf\"; filename*=UTF-8\\'\\'%E2%82%AC%20rates.pdf')\n })\n\n describe('when \"false\"', () => {\n it('should not generate ISO-8859-1 fallback', () => {\n const ctx = context()\n ctx.attachment('£ and € rates.pdf', { fallback: false })\n assert.strictEqual(ctx.response.header['content-disposition'],\n 'attachment; filename*=UTF-8\\'\\'%C2%A3%20and%20%E2%82%AC%20rates.pdf')\n })\n\n it('should keep ISO-8859-1 filename', () => {\n const ctx = context()\n ctx.attachment('£ rates.pdf', { fallback: false })\n assert.strictEqual(ctx.response.header['content-disposition'],\n 'attachment; filename=\"£ rates.pdf\"')\n })\n })\n\n describe('when \"true\"', () => {\n it('should generate ISO-8859-1 fallback', () => {\n const ctx = context()\n ctx.attachment('£ and € rates.pdf', { fallback: true })\n assert.strictEqual(ctx.response.header['content-disposition'],\n 'attachment; filename=\"£ and ? rates.pdf\"; filename*=UTF-8\\'\\'%C2%A3%20and%20%E2%82%AC%20rates.pdf')\n })\n\n it('should pass through ISO-8859-1 filename', () => {\n const ctx = context()\n ctx.attachment('£ rates.pdf', { fallback: true })\n assert.strictEqual(ctx.response.header['content-disposition'],\n 'attachment; filename=\"£ rates.pdf\"')\n })\n })\n\n describe('when a string', () => {\n it('should require an ISO-8859-1 string', () => {\n const ctx = context()\n assert.throws(() => { ctx.attachment('€ rates.pdf', { fallback: '€ rates.pdf' }) },\n /fallback.*iso-8859-1/i)\n })\n\n it('should use as ISO-8859-1 fallback', () => {\n const ctx = context()\n ctx.attachment('£ and € rates.pdf', { fallback: '£ and EURO rates.pdf' })\n assert.strictEqual(ctx.response.header['content-disposition'],\n 'attachment; filename=\"£ and EURO rates.pdf\"; filename*=UTF-8\\'\\'%C2%A3%20and%20%E2%82%AC%20rates.pdf')\n })\n\n it('should use as fallback even when filename is ISO-8859-1', () => {\n const ctx = context()\n ctx.attachment('\"£ rates\".pdf', { fallback: '£ rates.pdf' })\n assert.strictEqual(ctx.response.header['content-disposition'],\n 'attachment; filename=\"£ rates.pdf\"; filename*=UTF-8\\'\\'%22%C2%A3%20rates%22.pdf')\n })\n\n it('should do nothing if equal to filename', () => {\n const ctx = context()\n ctx.attachment('plans.pdf', { fallback: 'plans.pdf' })\n assert.strictEqual(ctx.response.header['content-disposition'],\n 'attachment; filename=\"plans.pdf\"')\n })\n\n it('should use the basename of the string', () => {\n const ctx = context()\n ctx.attachment('€ rates.pdf', { fallback: '/path/to/EURO rates.pdf' })\n assert.strictEqual(ctx.response.header['content-disposition'],\n 'attachment; filename=\"EURO rates.pdf\"; filename*=UTF-8\\'\\'%E2%82%AC%20rates.pdf')\n })\n\n it('should do nothing without filename option', () => {\n const ctx = context()\n ctx.attachment(undefined, { fallback: 'plans.pdf' })\n assert.strictEqual(ctx.response.header['content-disposition'],\n 'attachment')\n })\n })\n })\n\n describe('with \"type\" option', () => {\n it('should default to attachment', () => {\n const ctx = context()\n ctx.attachment()\n assert.strictEqual(ctx.response.header['content-disposition'],\n 'attachment')\n })\n\n it('should require a string', () => {\n const ctx = context()\n assert.throws(() => { ctx.attachment(undefined, { type: 42 }) },\n /invalid type/)\n })\n\n it('should require a valid type', () => {\n const ctx = context()\n assert.throws(() => { ctx.attachment(undefined, { type: 'invlaid;type' }) },\n /invalid type/)\n })\n\n it('should create a header with inline type', () => {\n const ctx = context()\n ctx.attachment(undefined, { type: 'inline' })\n assert.strictEqual(ctx.response.header['content-disposition'],\n 'inline')\n })\n\n it('should create a header with inline type and filename', () => {\n const ctx = context()\n ctx.attachment('plans.pdf', { type: 'inline' })\n assert.strictEqual(ctx.response.header['content-disposition'],\n 'inline; filename=\"plans.pdf\"')\n })\n\n it('should normalize type', () => {\n const ctx = context()\n ctx.attachment(undefined, { type: 'INLINE' })\n assert.strictEqual(ctx.response.header['content-disposition'],\n 'inline')\n })\n })\n})\n" }, { "path": "__tests__/response/back.test.js", "content": "'use strict'\n\nconst { describe, it } = require('node:test')\nconst assert = require('node:assert/strict')\nconst context = require('../../test-helpers/context')\n\ndescribe('ctx.back([alt])', () => {\n it('should redirect to Referrer', () => {\n const ctx = context({ url: '/', headers: { host: 'example.com' } })\n ctx.req.headers.referrer = '/login'\n ctx.back()\n assert.equal(ctx.response.header.location, '/login')\n })\n\n it('should redirect to the same origin referrer', () => {\n const ctx = context()\n ctx.req.headers.host = 'example.com'\n ctx.req.headers.referrer = 'https://example.com/login'\n ctx.back()\n assert.equal(ctx.response.header.location, 'https://example.com/login')\n })\n\n it('should redirect to root if the same origin referrer is not present', () => {\n const ctx = context()\n ctx.req.headers.host = 'example.com'\n ctx.req.headers.referrer = 'https://other.com/login'\n ctx.back()\n assert.equal(ctx.response.header.location, '/')\n })\n\n it('should redirect to Referer to a relative path', () => {\n const ctx = context({ url: '/', headers: { host: 'example.com' } })\n ctx.req.headers.referer = '/login'\n ctx.back()\n assert.equal(ctx.response.header.location, '/login')\n })\n\n it('should redirect to Referer to a same origin url', () => {\n const ctx = context({ url: '/', headers: { host: 'example.com', referer: 'https://example.com/login' } })\n ctx.back()\n assert.equal(ctx.response.header.location, 'https://example.com/login')\n })\n\n it('should default to alt', () => {\n const ctx = context()\n ctx.back('/index.html')\n assert.equal(ctx.response.header.location, '/index.html')\n })\n\n it('should default redirect to /', () => {\n const ctx = context()\n ctx.back()\n assert.equal(ctx.response.header.location, '/')\n })\n\n it('should fix Trailing Double-Slash security issue', () => {\n const ctx = context({ url: '/', headers: { host: 'example.com' } })\n ctx.req.headers.referrer = '//evil.com/login/'\n ctx.back()\n assert.equal(ctx.response.header.location, '/')\n\n ctx.back('/home')\n assert.equal(ctx.response.header.location, '/home')\n })\n})\n" }, { "path": "__tests__/response/body.test.js", "content": "'use strict'\n\nconst { describe, it } = require('node:test')\nconst response = require('../../test-helpers/context').response\nconst CustomStream = require('../../test-helpers/stream')\nconst assert = require('node:assert/strict')\nconst fs = require('fs')\nconst Stream = require('stream')\n\ndescribe('res.body=', () => {\n describe('when Content-Type is set', () => {\n it('should not override', () => {\n const res = response()\n res.type = 'png'\n res.body = Buffer.from('something')\n assert.strictEqual('image/png', res.header['content-type'])\n })\n\n describe('when body is an object', () => {\n it('should override as json', () => {\n const res = response()\n\n res.body = 'hey'\n assert.strictEqual('text/html; charset=utf-8', res.header['content-type'])\n\n res.body = { foo: 'bar' }\n assert.strictEqual('application/json; charset=utf-8', res.header['content-type'])\n })\n })\n\n it('should override length', () => {\n const res = response()\n res.type = 'html'\n res.body = 'something'\n assert.strictEqual(res.length, 9)\n })\n })\n\n describe('when a string is given', () => {\n it('should default to text', () => {\n const res = response()\n res.body = 'Tobi'\n assert.strictEqual('text/plain; charset=utf-8', res.header['content-type'])\n })\n\n it('should set length', () => {\n const res = response()\n res.body = 'Tobi'\n assert.strictEqual(4, res.header['content-length'])\n })\n\n describe('and contains a non-leading <', () => {\n it('should default to text', () => {\n const res = response()\n res.body = 'aklsdjf < klajsdlfjasd'\n assert.strictEqual('text/plain; charset=utf-8', res.header['content-type'])\n })\n })\n })\n\n describe('when an html string is given', () => {\n it('should default to html', () => {\n const res = response()\n res.body = '

Tobi

'\n assert.strictEqual('text/html; charset=utf-8', res.header['content-type'])\n })\n\n it('should set length', () => {\n const string = '

Tobi

'\n const res = response()\n res.body = string\n assert.strictEqual(res.length, Buffer.byteLength(string))\n })\n\n it('should set length when body is overridden', () => {\n const string = '

Tobi

'\n const res = response()\n res.body = string\n res.body = string + string\n assert.strictEqual(res.length, 2 * Buffer.byteLength(string))\n })\n\n describe('when it contains leading whitespace', () => {\n it('should default to html', () => {\n const res = response()\n res.body = '

Tobi

'\n assert.strictEqual('text/html; charset=utf-8', res.header['content-type'])\n })\n })\n })\n\n describe('when an xml string is given', () => {\n it('should default to html', () => {\n /**\n * ctx test is to show that we're not going\n * to be stricter with the html sniff\n * or that we will sniff other string types.\n * You should `.type=` if ctx simple test fails.\n */\n\n const res = response()\n res.body = '\\n<俄语>данные'\n assert.strictEqual('text/html; charset=utf-8', res.header['content-type'])\n })\n })\n\n describe('when a stream is given', () => {\n it('should default to an octet stream', () => {\n const res = response()\n res.body = fs.createReadStream('LICENSE')\n assert.strictEqual('application/octet-stream', res.header['content-type'])\n })\n\n it('should support custom stream', () => {\n const res = response()\n res.body = new CustomStream.Readable()\n assert.strictEqual('application/octet-stream', res.header['content-type'])\n })\n\n it('should not add error handler to stream (handled by pipeline)', () => {\n const res = response()\n const body = new Stream.PassThrough()\n assert.strictEqual(body.listenerCount('error'), 0)\n res.body = body\n assert.strictEqual(body.listenerCount('error'), 0)\n res.body = body\n assert.strictEqual(body.listenerCount('error'), 0)\n })\n\n it('should NOT cleanup original stream when replaced by new stream (to support wrapping middleware)', () => {\n const res = response()\n const stream1 = new Stream.PassThrough()\n const stream2 = new Stream.PassThrough()\n\n res.body = stream1\n res.body = stream2\n\n assert.strictEqual(stream1.destroyed, false)\n assert.strictEqual(stream2.destroyed, false)\n })\n\n it('should cleanup original stream when replaced by null', () => {\n const res = response()\n const stream = new Stream.PassThrough()\n\n res.body = stream\n res.body = null\n\n assert.strictEqual(stream.destroyed, true)\n })\n\n it('should not throw unhandled errors when replacing failing stream', async () => {\n const res = response()\n\n const stream1 = new Stream.Readable({\n read () {\n }\n })\n\n const stream2 = new Stream.PassThrough()\n\n res.body = stream1\n res.body = stream2\n\n await new Promise((resolve) => {\n process.nextTick(() => {\n stream1.emit('error', new Error('stream1 error'))\n setTimeout(resolve, 10)\n })\n })\n })\n\n it('should handle multiple sequential stream replacements', () => {\n const res = response()\n const stream1 = new Stream.PassThrough()\n const stream2 = new Stream.PassThrough()\n const stream3 = new Stream.PassThrough()\n\n res.body = stream1\n res.body = stream2\n res.body = stream3\n\n assert.strictEqual(stream1.destroyed, false)\n assert.strictEqual(stream2.destroyed, false)\n assert.strictEqual(stream3.destroyed, false)\n })\n\n it('should handle four sequential stream replacements', () => {\n const res = response()\n const stream1 = new Stream.PassThrough()\n const stream2 = new Stream.PassThrough()\n const stream3 = new Stream.PassThrough()\n const stream4 = new Stream.PassThrough()\n\n res.body = stream1\n res.body = stream2\n res.body = stream3\n res.body = stream4\n\n assert.strictEqual(stream1.destroyed, false)\n assert.strictEqual(stream2.destroyed, false)\n assert.strictEqual(stream3.destroyed, false)\n assert.strictEqual(stream4.destroyed, false)\n })\n\n it('should cleanup stream when replaced by string', () => {\n const res = response()\n const stream = new Stream.PassThrough()\n\n res.body = stream\n res.body = 'hello'\n\n assert.strictEqual(stream.destroyed, true)\n })\n\n it('should cleanup stream when replaced by buffer', () => {\n const res = response()\n const stream = new Stream.PassThrough()\n\n res.body = stream\n res.body = Buffer.from('hello')\n\n assert.strictEqual(stream.destroyed, true)\n })\n\n it('should cleanup stream when replaced by object', () => {\n const res = response()\n const stream = new Stream.PassThrough()\n\n res.body = stream\n res.body = { foo: 'bar' }\n\n assert.strictEqual(stream.destroyed, true)\n })\n\n it('should support wrapping stream middleware (like koa-compress)', async () => {\n const res = response()\n const sourceStream = new Stream.Readable({\n read () {\n this.push('hello world')\n this.push(null)\n }\n })\n\n res.body = sourceStream\n\n const wrappedStream = new Stream.PassThrough()\n sourceStream.pipe(wrappedStream)\n res.body = wrappedStream\n\n assert.strictEqual(sourceStream.destroyed, false)\n assert.strictEqual(wrappedStream.destroyed, false)\n\n const chunks = []\n for await (const chunk of wrappedStream) {\n chunks.push(chunk)\n }\n const result = Buffer.concat(chunks).toString()\n assert.strictEqual(result, 'hello world')\n })\n })\n\n describe('when a buffer is given', () => {\n it('should default to an octet stream', () => {\n const res = response()\n res.body = Buffer.from('hey')\n assert.strictEqual('application/octet-stream', res.header['content-type'])\n })\n\n it('should set length', () => {\n const res = response()\n res.body = Buffer.from('Tobi')\n assert.strictEqual(4, res.header['content-length'])\n })\n })\n\n describe('when an object is given', () => {\n it('should default to json', () => {\n const res = response()\n res.body = { foo: 'bar' }\n assert.strictEqual('application/json; charset=utf-8', res.header['content-type'])\n })\n })\n\n describe('when a ReadableStream is given', () => {\n it('should default to an octet stream', () => {\n const res = response()\n res.body = new ReadableStream()\n assert.strictEqual('application/octet-stream', res.header['content-type'])\n })\n })\n\n describe('when a Blob is given', () => {\n it('should default to an octet stream', () => {\n const res = response()\n res.body = new Blob([new Uint8Array([1, 2, 3])], { type: 'application/octet-stream' })\n assert.strictEqual('application/octet-stream', res.header['content-type'])\n })\n\n it('should set length', () => {\n const res = response()\n res.body = new Blob([new Uint8Array([1, 2, 3])], { type: 'application/octet-stream' })\n assert.strictEqual(3, res.header['content-length'])\n })\n })\n\n describe('when a response is given', () => {\n it('should set the status', () => {\n const res = response()\n res.body = new Response(null, { status: 201 })\n assert.strictEqual(201, res.status)\n })\n\n it('should set headers', () => {\n const res = response()\n res.body = new Response(null, { status: 200, headers: { 'x-fizz': 'buzz', 'x-foo': 'bar' } })\n assert.strictEqual('buzz', res.header['x-fizz'])\n assert.strictEqual('bar', res.header['x-foo'])\n })\n\n it('should redirect', () => {\n const res = response()\n res.body = Response.redirect('https://www.example.com/', 301)\n assert.strictEqual(301, res.status)\n assert.strictEqual('https://www.example.com/', res.header.location)\n })\n })\n})\n" }, { "path": "__tests__/response/etag.test.js", "content": "'use strict'\n\nconst { describe, it } = require('node:test')\nconst assert = require('node:assert/strict')\nconst response = require('../../test-helpers/context').response\n\ndescribe('res.etag=', () => {\n it('should not modify an etag with quotes', () => {\n const res = response()\n res.etag = '\"asdf\"'\n assert.strictEqual(res.header.etag, '\"asdf\"')\n })\n\n it('should not modify a weak etag', () => {\n const res = response()\n res.etag = 'W/\"asdf\"'\n assert.strictEqual(res.header.etag, 'W/\"asdf\"')\n })\n\n it('should add quotes around an etag if necessary', () => {\n const res = response()\n res.etag = 'asdf'\n assert.strictEqual(res.header.etag, '\"asdf\"')\n })\n})\n\ndescribe('res.etag', () => {\n it('should return etag', () => {\n const res = response()\n res.etag = '\"asdf\"'\n assert.strictEqual(res.etag, '\"asdf\"')\n })\n})\n" }, { "path": "__tests__/response/flushHeaders.test.js", "content": "'use strict'\n\nconst { describe, it } = require('node:test')\nconst request = require('supertest')\nconst assert = require('node:assert/strict')\nconst Koa = require('../..')\nconst http = require('http')\nconst { once } = require('node:events')\n\ndescribe('ctx.flushHeaders()', () => {\n it('should set headersSent', () => {\n const app = new Koa()\n\n app.use((ctx, next) => {\n ctx.body = 'Body'\n ctx.status = 200\n ctx.flushHeaders()\n assert.strictEqual(ctx.headerSent, true)\n assert.strictEqual(ctx.res.headersSent, true)\n })\n\n return request(app.callback())\n .get('/')\n .expect(200)\n .expect('Body')\n })\n\n it('should allow a response afterwards', () => {\n const app = new Koa()\n\n app.use((ctx, next) => {\n ctx.status = 200\n ctx.res.setHeader('Content-Type', 'text/plain')\n ctx.flushHeaders()\n ctx.body = 'Body'\n })\n\n return request(app.callback())\n .get('/')\n .expect(200)\n .expect('Content-Type', 'text/plain')\n .expect('Body')\n })\n\n it('should send the correct status code', () => {\n const app = new Koa()\n\n app.use((ctx, next) => {\n ctx.status = 401\n ctx.res.setHeader('Content-Type', 'text/plain')\n ctx.flushHeaders()\n ctx.body = 'Body'\n })\n\n return request(app.callback())\n .get('/')\n .expect(401)\n .expect('Content-Type', 'text/plain')\n .expect('Body')\n })\n\n it('should ignore set header after flushHeaders', async () => {\n const app = new Koa()\n\n app.use((ctx, next) => {\n ctx.status = 401\n ctx.res.setHeader('Content-Type', 'text/plain')\n ctx.flushHeaders()\n ctx.body = 'foo'\n ctx.set('X-Shouldnt-Work', 'Value')\n ctx.remove('Content-Type')\n ctx.vary('Content-Type')\n })\n\n const res = await request(app.callback())\n .get('/')\n .expect(401)\n .expect('Content-Type', 'text/plain')\n\n assert.strictEqual(res.headers['x-shouldnt-work'], undefined, 'header set after flushHeaders')\n assert.strictEqual(res.headers.vary, undefined, 'header set after flushHeaders')\n })\n\n it('should flush headers first and delay to send data', async () => {\n const PassThrough = require('stream').PassThrough\n const app = new Koa()\n let headersFlushed = false\n let dataReceived = false\n\n app.use(ctx => {\n ctx.type = 'json'\n ctx.status = 200\n ctx.headers.Link = '; as=style; rel=preload, ; rel=preconnect; crossorigin'\n const stream = ctx.body = new PassThrough()\n ctx.flushHeaders()\n headersFlushed = true\n setTimeout(() => {\n stream.end(JSON.stringify({ message: 'hello!' }))\n }, 10)\n })\n\n const server = app.listen()\n await once(server, 'listening')\n const port = server.address().port\n\n try {\n const req = http.request({ port })\n req.end()\n\n const [res] = await once(req, 'response')\n assert(headersFlushed, 'Headers should be flushed')\n\n const dataPromise = new Promise(resolve => {\n res.once('data', chunk => {\n dataReceived = true\n resolve(chunk)\n })\n })\n\n // Wait for data with a timeout\n const timeoutPromise = new Promise((resolve, reject) =>\n setTimeout(() => reject(new Error('Timeout waiting for data')), 100)\n )\n\n await Promise.race([dataPromise, timeoutPromise])\n res.destroy()\n assert(dataReceived, 'Data should be received after headers')\n } finally {\n server.close()\n }\n })\n\n it('should catch stream error', async () => {\n const PassThrough = require('stream').PassThrough\n const app = new Koa()\n app.once('error', err => {\n assert(err.message === 'mock error')\n })\n\n app.use(ctx => {\n ctx.type = 'json'\n ctx.status = 200\n ctx.headers.Link = '; as=style; rel=preload, ; rel=preconnect; crossorigin'\n ctx.length = 20\n ctx.flushHeaders()\n const stream = ctx.body = new PassThrough()\n\n setTimeout(() => {\n stream.emit('error', new Error('mock error'))\n stream.end()\n })\n })\n\n await request(app.callback()).get('/')\n .then(() => {\n throw new Error('should not successfully end')\n })\n .catch(err => {\n assert(err.message === 'aborted')\n })\n })\n})\n" }, { "path": "__tests__/response/get.test.js", "content": "'use strict'\n\nconst { describe, it } = require('node:test')\nconst assert = require('node:assert/strict')\nconst context = require('../../test-helpers/context')\n\ndescribe('ctx.get(name)', () => {\n it('should get a field value, case insensitive', () => {\n const ctx = context()\n ctx.set('X-Foo', 'bar')\n assert.strictEqual(ctx.response.get('x-FOO'), 'bar')\n })\n\n it('should have the same behavior as ctx.res.getHeader on undefined and null values', () => {\n const ctx = context()\n ctx.res.setHeader('X-Foo', undefined)\n ctx.response.header['x-boo'] = null\n assert.strictEqual(ctx.response.get('x-FOO'), ctx.res.getHeader('X-FOO'))\n assert.strictEqual(ctx.response.get('x-bOO'), ctx.res.getHeader('X-BOO'))\n })\n\n it('should not convert header value type', () => {\n const ctx = context()\n ctx.res.setHeader('Foo-date', new Date())\n ctx.response.header['foo-map'] = new Map()\n ctx.res.setHeader('Foo-empty-string', '')\n ctx.res.setHeader('Foo-number', 0)\n ctx.res.setHeader('Foo-null', null)\n ctx.res.setHeader('Foo-undefined', undefined)\n assert.ok(ctx.response.get('foo-Date') instanceof Date)\n assert.ok(ctx.response.get('foo-Map') instanceof Map)\n assert.strictEqual(ctx.response.get('Foo-empty-String'), '')\n assert.strictEqual(ctx.response.get('Foo-Number'), 0)\n assert.ok(ctx.response.get('foo-NULL') === null)\n assert.ok(typeof ctx.response.get('FOO-undefined') === 'undefined')\n })\n\n it('should return undefined for non-existent headers', () => {\n const ctx = context()\n assert.strictEqual(ctx.response.get('nonexistent'), undefined)\n assert.strictEqual(ctx.response.get(''), undefined)\n })\n})\n" }, { "path": "__tests__/response/has.test.js", "content": "'use strict'\n\nconst { describe, it } = require('node:test')\nconst assert = require('node:assert/strict')\nconst context = require('../../test-helpers/context')\n\ndescribe('ctx.response.has(name)', () => {\n it('should check a field value, case insensitive way', () => {\n const ctx = context()\n ctx.set('X-Foo', '')\n assert.ok(ctx.response.has('x-Foo'))\n assert.ok(ctx.has('x-foo'))\n })\n\n it('should return false for non-existent header', () => {\n const ctx = context()\n assert.strictEqual(ctx.response.has('boo'), false)\n ctx.set('x-foo', 5)\n assert.strictEqual(ctx.has('x-boo'), false)\n })\n})\n" }, { "path": "__tests__/response/header.test.js", "content": "'use strict'\n\nconst { describe, it } = require('node:test')\nconst assert = require('node:assert/strict')\nconst request = require('supertest')\nconst response = require('../../test-helpers/context').response\nconst Koa = require('../..')\n\ndescribe('res.header', () => {\n it('should return the response header object', () => {\n const res = response()\n res.set('X-Foo', 'bar')\n res.set('X-Number', 200)\n assert.deepStrictEqual(res.header, { 'x-foo': 'bar', 'x-number': 200 })\n })\n\n it('should use res.getHeaders() accessor when available', () => {\n const res = response()\n res.res._headers = null\n res.res.getHeaders = () => ({ 'x-foo': 'baz' })\n assert.deepStrictEqual(res.header, { 'x-foo': 'baz' })\n })\n\n it('should return the response header object when no mocks are in use', async () => {\n const app = new Koa()\n let header\n\n app.use(ctx => {\n ctx.set('x-foo', '42')\n header = Object.assign({}, ctx.response.header)\n })\n\n await request(app.callback())\n .get('/')\n\n assert.deepStrictEqual(header, { 'x-foo': '42' })\n })\n\n describe('when res._headers not present', () => {\n it('should return empty object', () => {\n const res = response()\n res.res._headers = null\n assert.deepStrictEqual(res.header, {})\n })\n })\n})\n" }, { "path": "__tests__/response/headers.test.js", "content": "'use strict'\n\nconst { describe, it } = require('node:test')\nconst assert = require('node:assert/strict')\nconst response = require('../../test-helpers/context').response\n\ndescribe('res.header', () => {\n it('should return the response header object', () => {\n const res = response()\n res.set('X-Foo', 'bar')\n assert.deepStrictEqual(res.headers, { 'x-foo': 'bar' })\n })\n\n describe('when res._headers not present', () => {\n it('should return empty object', () => {\n const res = response()\n res.res._headers = null\n assert.deepStrictEqual(res.headers, {})\n })\n })\n})\n" }, { "path": "__tests__/response/inspect.test.js", "content": "'use strict'\n\nconst { describe, it } = require('node:test')\nconst response = require('../../test-helpers/context').response\nconst assert = require('node:assert/strict')\nconst util = require('util')\n\ndescribe('res.inspect()', () => {\n describe('with no response.res present', () => {\n it('should return null', () => {\n const res = response()\n res.body = 'hello'\n delete res.res\n assert.strictEqual(res.inspect(), undefined)\n assert.strictEqual(util.inspect(res), 'undefined')\n })\n })\n\n it('should return a json representation', () => {\n const res = response()\n res.body = 'hello'\n\n const expected = {\n status: 200,\n message: 'OK',\n header: {\n 'content-type': 'text/plain; charset=utf-8',\n 'content-length': 5\n },\n body: 'hello'\n }\n\n assert.deepStrictEqual(res.inspect(), expected)\n assert.deepStrictEqual(util.inspect(res), util.inspect(expected))\n })\n})\n" }, { "path": "__tests__/response/is.test.js", "content": "'use strict'\n\nconst { describe, it } = require('node:test')\nconst context = require('../../test-helpers/context')\nconst assert = require('node:assert/strict')\n\ndescribe('response.is(type)', () => {\n it('should ignore params', () => {\n const res = context().response\n res.type = 'text/html; charset=utf-8'\n\n assert.strictEqual(res.is('text/*'), 'text/html')\n })\n\n describe('when no type is set', () => {\n it('should return false', () => {\n const res = context().response\n\n assert.strictEqual(res.is(), false)\n assert.strictEqual(res.is('html'), false)\n })\n })\n\n describe('when given no types', () => {\n it('should return the type', () => {\n const res = context().response\n res.type = 'text/html; charset=utf-8'\n\n assert.strictEqual(res.is(), 'text/html')\n })\n })\n\n describe('given one type', () => {\n it('should return the type or false', () => {\n const res = context().response\n res.type = 'image/png'\n\n assert.strictEqual(res.is('png'), 'png')\n assert.strictEqual(res.is('.png'), '.png')\n assert.strictEqual(res.is('image/png'), 'image/png')\n assert.strictEqual(res.is('image/*'), 'image/png')\n assert.strictEqual(res.is('*/png'), 'image/png')\n\n assert.strictEqual(res.is('jpeg'), false)\n assert.strictEqual(res.is('.jpeg'), false)\n assert.strictEqual(res.is('image/jpeg'), false)\n assert.strictEqual(res.is('text/*'), false)\n assert.strictEqual(res.is('*/jpeg'), false)\n })\n })\n\n describe('given multiple types', () => {\n it('should return the first match or false', () => {\n const res = context().response\n res.type = 'image/png'\n\n assert.strictEqual(res.is('png'), 'png')\n assert.strictEqual(res.is('.png'), '.png')\n assert.strictEqual(res.is('text/*', 'image/*'), 'image/png')\n assert.strictEqual(res.is('image/*', 'text/*'), 'image/png')\n assert.strictEqual(res.is('image/*', 'image/png'), 'image/png')\n assert.strictEqual(res.is('image/png', 'image/*'), 'image/png')\n\n assert.strictEqual(res.is(['text/*', 'image/*']), 'image/png')\n assert.strictEqual(res.is(['image/*', 'text/*']), 'image/png')\n assert.strictEqual(res.is(['image/*', 'image/png']), 'image/png')\n assert.strictEqual(res.is(['image/png', 'image/*']), 'image/png')\n\n assert.strictEqual(res.is('jpeg'), false)\n assert.strictEqual(res.is('.jpeg'), false)\n assert.strictEqual(res.is('text/*', 'application/*'), false)\n assert.strictEqual(res.is('text/html', 'text/plain', 'application/json; charset=utf-8'), false)\n })\n })\n\n describe('when Content-Type: application/x-www-form-urlencoded', () => {\n it('should match \"urlencoded\"', () => {\n const res = context().response\n res.type = 'application/x-www-form-urlencoded'\n\n assert.strictEqual(res.is('urlencoded'), 'urlencoded')\n assert.strictEqual(res.is('json', 'urlencoded'), 'urlencoded')\n assert.strictEqual(res.is('urlencoded', 'json'), 'urlencoded')\n })\n })\n})\n" }, { "path": "__tests__/response/last-modified.test.js", "content": "'use strict'\n\nconst { describe, it } = require('node:test')\nconst assert = require('node:assert/strict')\nconst response = require('../../test-helpers/context').response\n\ndescribe('res.lastModified', () => {\n it('should set the header as a UTCString', () => {\n const res = response()\n const date = new Date()\n res.lastModified = date\n assert.strictEqual(res.header['last-modified'], date.toUTCString())\n })\n\n it('should work with date strings', () => {\n const res = response()\n const date = new Date()\n res.lastModified = date.toString()\n assert.strictEqual(res.header['last-modified'], date.toUTCString())\n })\n\n it('should get the header as a Date', () => {\n // Note: Date() removes milliseconds, but it's practically important.\n const res = response()\n const date = new Date()\n res.lastModified = date\n assert.strictEqual((res.lastModified.getTime() / 1000), Math.floor(date.getTime() / 1000))\n })\n\n describe('when lastModified not set', () => {\n it('should get undefined', () => {\n const res = response()\n assert.strictEqual(res.lastModified, undefined)\n })\n })\n})\n" }, { "path": "__tests__/response/length.test.js", "content": "'use strict'\n\nconst { describe, it } = require('node:test')\nconst response = require('../../test-helpers/context').response\nconst assert = require('node:assert/strict')\nconst fs = require('fs')\n\ndescribe('res.length', () => {\n describe('when Content-Length is defined', () => {\n it('should return a number', () => {\n const res = response()\n res.set('Content-Length', '1024')\n assert.strictEqual(res.length, 1024)\n })\n\n describe('but not number', () => {\n it('should return 0', () => {\n const res = response()\n res.set('Content-Length', 'hey')\n assert.strictEqual(res.length, 0)\n })\n })\n })\n\n describe('when Content-Length is not defined', () => {\n describe('and a .body is set', () => {\n it('should return a number', () => {\n const res = response()\n\n res.body = null\n assert.strictEqual(res.length, undefined)\n\n res.body = 'foo'\n res.remove('Content-Length')\n assert.strictEqual(res.length, 3)\n\n res.body = 'foo'\n assert.strictEqual(res.length, 3)\n\n res.body = Buffer.from('foo bar')\n res.remove('Content-Length')\n assert.strictEqual(res.length, 7)\n\n res.body = Buffer.from('foo bar')\n assert.strictEqual(res.length, 7)\n\n res.body = { hello: 'world' }\n res.remove('Content-Length')\n assert.strictEqual(res.length, 17)\n\n res.body = { hello: 'world' }\n assert.strictEqual(res.length, 17)\n\n res.body = fs.createReadStream('package.json')\n assert.strictEqual(res.length, undefined)\n\n res.body = null\n assert.strictEqual(res.length, undefined)\n })\n })\n\n describe('and .body is not', () => {\n it('should return undefined', () => {\n const res = response()\n assert.strictEqual(res.length, undefined)\n })\n })\n })\n\n describe('and a .type is set to json', () => {\n describe('and a .body is set to null', () => {\n it('should return a number', () => {\n const res = response()\n\n res.type = 'json'\n res.body = null\n assert.strictEqual(res.length, 4)\n })\n })\n })\n})\n" }, { "path": "__tests__/response/message.test.js", "content": "'use strict'\n\nconst { describe, it } = require('node:test')\nconst assert = require('node:assert/strict')\nconst response = require('../../test-helpers/context').response\n\ndescribe('res.message', () => {\n it('should return the response status message', () => {\n const res = response()\n res.status = 200\n assert.strictEqual(res.message, 'OK')\n })\n\n describe('when res.message not present', () => {\n it('should look up in statuses', () => {\n const res = response()\n res.res.statusCode = 200\n assert.strictEqual(res.message, 'OK')\n })\n })\n})\n\ndescribe('res.message=', () => {\n it('should set response status message', () => {\n const res = response()\n res.status = 200\n res.message = 'ok'\n assert.strictEqual(res.res.statusMessage, 'ok')\n assert.strictEqual(res.inspect().message, 'ok')\n })\n})\n" }, { "path": "__tests__/response/redirect.test.js", "content": "'use strict'\n\nconst { describe, it } = require('node:test')\nconst assert = require('node:assert/strict')\nconst request = require('supertest')\nconst context = require('../../test-helpers/context')\nconst Koa = require('../..')\n\ndescribe('ctx.redirect(url)', () => {\n it('should redirect to the given url', () => {\n const ctx = context()\n ctx.redirect('http://google.com')\n assert.strictEqual(ctx.response.header.location, 'http://google.com/')\n assert.strictEqual(ctx.status, 302)\n })\n\n it('should formatting url before redirect', () => {\n const ctx = context()\n ctx.redirect('http://google.com\\\\@apple.com')\n assert.strictEqual(ctx.response.header.location, 'http://google.com/@apple.com')\n assert.strictEqual(ctx.status, 302)\n })\n\n it('should formatting url before redirect', () => {\n const ctx = context()\n ctx.redirect('HTTP://google.com\\\\@apple.com')\n assert.strictEqual(ctx.response.header.location, 'http://google.com/@apple.com')\n assert.strictEqual(ctx.status, 302)\n })\n\n it('should auto fix not encode url', async () => {\n const app = new Koa()\n\n app.use(ctx => {\n ctx.redirect('http://google.com/😓')\n })\n\n const res = await request(app.callback())\n .get('/')\n\n assert.strictEqual(res.status, 302)\n assert.strictEqual(res.headers.location, 'http://google.com/%F0%9F%98%93')\n })\n\n describe('when html is accepted', () => {\n it('should respond with html', () => {\n const ctx = context()\n const url = 'http://google.com/'\n ctx.header.accept = 'text/html'\n ctx.redirect(url)\n assert.strictEqual(ctx.response.header['content-type'], 'text/html; charset=utf-8')\n assert.strictEqual(ctx.body, `Redirecting to ${url}.`)\n })\n\n it('should escape the url', () => {\n const ctx = context()\n let url = '