fix example using db decorator on fastify instance #4406

ghost · 2022-11-08T04:57:09Z

I believe the current docs are a typo/broken example, unless that's an undocumented syntax. This change replaces the existing example with two examples for both returning the value since we're using async/await, along with still using reply.send() and then awaiting reply.

Checklist

run npm run test and npm run benchmark
tests and/or benchmarks are included
documentation is changed or added
commit message and code follows the Developer's Certification of Origin
and the Code of conduct

I believe the current docs are a typo/broken example, unless that's an undocumented syntax. This change adds an example for both returning the value since we're using async/await, along with an example for still using `reply.send()` and then `await`ing `reply`.

[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [fastify](https://www.fastify.io/) ([source](https://togithub.com/fastify/fastify)) | [`4.9.2` -> `4.10.2`](https://renovatebot.com/diffs/npm/fastify/4.9.2/4.10.2) | [![age](https://badges.renovateapi.com/packages/npm/fastify/4.10.2/age-slim)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://badges.renovateapi.com/packages/npm/fastify/4.10.2/adoption-slim)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://badges.renovateapi.com/packages/npm/fastify/4.10.2/compatibility-slim/4.9.2)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://badges.renovateapi.com/packages/npm/fastify/4.10.2/confidence-slim/4.9.2)](https://docs.renovatebot.com/merge-confidence/) | ### GitHub Vulnerability Alerts #### [CVE-2022-41919](https://togithub.com/fastify/fastify/security/advisories/GHSA-3fjj-p79j-c9hh) ### Impact The attacker can use the incorrect `Content-Type` to bypass the `Pre-Flight` checking of `fetch`. `fetch()` requests with Content-Type’s [essence](https://mimesniff.spec.whatwg.org/#mime-type-essence) as "application/x-www-form-urlencoded", "multipart/form-data", or "text/plain", could potentially be used to invoke routes that only accepts `application/json` content type, thus bypassing any [CORS protection](https://fetch.spec.whatwg.org/#simple-header), and therefore they could lead to a Cross-Site Request Forgery attack. ### Patches For `4.x` users, please update to at least `4.10.2` For `3.x` users, please update to at least `3.29.4` ### Workarounds Implement Cross-Site Request Forgery protection using [`@fastify/csrf`](https://www.npmjs.com/package/@fastify/csrf). ### References Check out the HackerOne report: https://hackerone.com/reports/1763832. ### For more information [Fastify security policy](https://togithub.com/fastify/fastify/security/policy) --- ### Release Notes <details> <summary>fastify/fastify</summary> ### [`v4.10.2`](https://togithub.com/fastify/fastify/releases/tag/v4.10.2) [Compare Source](https://togithub.com/fastify/fastify/compare/v4.10.1...v4.10.2) #### ⚠️ Security Release ⚠️ - Fix for ["Incorrect Content-Type parsing can lead to CSRF attack"](https://togithub.com/fastify/fastify/security/advisories/GHSA-3fjj-p79j-c9hh) and CVE-2022-41919 **Full Changelog**: fastify/fastify@v4.10.1...v4.10.2 ### [`v4.10.1`](https://togithub.com/fastify/fastify/releases/tag/v4.10.1) [Compare Source](https://togithub.com/fastify/fastify/compare/v4.10.0...v4.10.1) #### What's Changed - fix node 19.1.0 port validation test by [@Uzlopak](https://togithub.com/Uzlopak) in [fastify/fastify#4427 - Add fastify-constraints to community plugins by [@Ceres6](https://togithub.com/Ceres6) in [fastify/fastify#4428 - build(deps-dev): bump [@sinonjs/fake-timers](https://togithub.com/sinonjs/fake-timers) from 9.1.2 to 10.0.0 by [@dependabot](https://togithub.com/dependabot) in [fastify/fastify#4421 - add silent option to LogLevel by [@Uzlopak](https://togithub.com/Uzlopak) in [fastify/fastify#4432 #### New Contributors - [@Ceres6](https://togithub.com/Ceres6) made their first contribution in [fastify/fastify#4428 **Full Changelog**: fastify/fastify@v4.10.0...v4.10.1 ### [`v4.10.0`](https://togithub.com/fastify/fastify/releases/tag/v4.10.0) [Compare Source](https://togithub.com/fastify/fastify/compare/v4.9.2...v4.10.0) #### What's Changed - docs(reference/reply): spelling fixes by [@Fdawgs](https://togithub.com/Fdawgs) in [fastify/fastify#4358 - Support different content-type typed reply with TypeProvider by [@rain714](https://togithub.com/rain714) in [fastify/fastify#4360 - chore: remove leading empty lines by [@LinusU](https://togithub.com/LinusU) in [fastify/fastify#4364 - fix types after pino 8.7.0 change by [@mcollina](https://togithub.com/mcollina) in [fastify/fastify#4365 - Node.js V19 support by [@mcollina](https://togithub.com/mcollina) in [fastify/fastify#4366 - fix: no check on `null` or `undefined` values passed as fn by [@metcoder95](https://togithub.com/metcoder95) in [fastify/fastify#4367 - docs(server): config is lost when reply.call not found() is called by [@cesarvspr](https://togithub.com/cesarvspr) in [fastify/fastify#4368 - Fix typo - 'sever' to 'server' by [@utsav91](https://togithub.com/utsav91) in [fastify/fastify#4372 - Add platformatic to the Acknowledgements by [@mcollina](https://togithub.com/mcollina) in [fastify/fastify#4378 - docs: add Simone Busoli to plugin maintainers by [@simoneb](https://togithub.com/simoneb) in [fastify/fastify#4379 - add missing 'validationContext' field to FastifyError type by [@jakubburzynski](https://togithub.com/jakubburzynski) in [fastify/fastify#4363 - fix(type-providers): assignability of instance with enabled type provider by [@driimus](https://togithub.com/driimus) in [fastify/fastify#4371 - feat: support async trailer by [@climba03003](https://togithub.com/climba03003) in [fastify/fastify#4380 - fix: trailers async race condition by [@climba03003](https://togithub.com/climba03003) in [fastify/fastify#4383 - docs(ecosystem): Add fastify-list-routes by [@chuongtrh](https://togithub.com/chuongtrh) in [fastify/fastify#4385 - build(deps-dev): bump [@sinclair/typebox](https://togithub.com/sinclair/typebox) from 0.24.51 to 0.25.2 by [@dependabot](https://togithub.com/dependabot) in [fastify/fastify#4388 - \[ Fix ] Improve error message for hooks check by [@debadutta98](https://togithub.com/debadutta98) in [fastify/fastify#4387 - fix: tiny-lru usage by [@climba03003](https://togithub.com/climba03003) in [fastify/fastify#4391 - Removes old note about named imports in ESM by [@fox1t](https://togithub.com/fox1t) in [fastify/fastify#4392 - docs: Add section about capacity planning by [@kibertoad](https://togithub.com/kibertoad) in [fastify/fastify#4386 - docs(recommendations): grammar fixes by [@Fdawgs](https://togithub.com/Fdawgs) in [fastify/fastify#4396 - chore(doc): duplicated menu item by [@Eomm](https://togithub.com/Eomm) in [fastify/fastify#4398 - feat: add request.routeOptions object by [@debadutta98](https://togithub.com/debadutta98) in [fastify/fastify#4397 - docs: Document multiple app approach by [@kibertoad](https://togithub.com/kibertoad) in [fastify/fastify#4393 - fix example using db decorator on fastify instance by [@mmarti](https://togithub.com/mmarti) in [fastify/fastify#4406 - docs: fix removeAdditional refer by [@shunyue1320](https://togithub.com/shunyue1320) in [fastify/fastify#4410 #### New Contributors - [@rain714](https://togithub.com/rain714) made their first contribution in [fastify/fastify#4360 - [@LinusU](https://togithub.com/LinusU) made their first contribution in [fastify/fastify#4364 - [@cesarvspr](https://togithub.com/cesarvspr) made their first contribution in [fastify/fastify#4368 - [@utsav91](https://togithub.com/utsav91) made their first contribution in [fastify/fastify#4372 - [@jakubburzynski](https://togithub.com/jakubburzynski) made their first contribution in [fastify/fastify#4363 - [@driimus](https://togithub.com/driimus) made their first contribution in [fastify/fastify#4371 - [@chuongtrh](https://togithub.com/chuongtrh) made their first contribution in [fastify/fastify#4385 - [@debadutta98](https://togithub.com/debadutta98) made their first contribution in [fastify/fastify#4387 - [@mmarti](https://togithub.com/mmarti) made their first contribution in [fastify/fastify#4406 - [@shunyue1320](https://togithub.com/shunyue1320) made their first contribution in [fastify/fastify#4410 **Full Changelog**: fastify/fastify@v4.9.2...v4.10.0 </details> --- ### Configuration 📅 **Schedule**: Branch creation - "" (UTC), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/quirrel-dev/quirrel).  Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

github-actions bot added the documentation Improvements or additions to documentation label Nov 8, 2022

remove semicolons

0a07247

climba03003 approved these changes Nov 8, 2022

View reviewed changes

Eomm approved these changes Nov 8, 2022

View reviewed changes

Eomm merged commit ea58581 into fastify:main Nov 8, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix example using db decorator on fastify instance #4406

fix example using db decorator on fastify instance #4406

ghost commented Nov 8, 2022

fix example using db decorator on fastify instance #4406

fix example using db decorator on fastify instance #4406

Conversation

ghost commented Nov 8, 2022

Checklist