node-fastify 5.8.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (354) hide show
  1. package/.borp.yaml +3 -0
  2. package/.markdownlint-cli2.yaml +22 -0
  3. package/.prettierignore +1 -0
  4. package/GOVERNANCE.md +4 -0
  5. package/LICENSE +21 -0
  6. package/PROJECT_CHARTER.md +126 -0
  7. package/README.md +423 -0
  8. package/SECURITY.md +220 -0
  9. package/SPONSORS.md +24 -0
  10. package/build/build-error-serializer.js +35 -0
  11. package/build/build-validation.js +169 -0
  12. package/build/sync-version.js +11 -0
  13. package/docs/Guides/Benchmarking.md +60 -0
  14. package/docs/Guides/Database.md +321 -0
  15. package/docs/Guides/Delay-Accepting-Requests.md +608 -0
  16. package/docs/Guides/Detecting-When-Clients-Abort.md +172 -0
  17. package/docs/Guides/Ecosystem.md +726 -0
  18. package/docs/Guides/Fluent-Schema.md +127 -0
  19. package/docs/Guides/Getting-Started.md +620 -0
  20. package/docs/Guides/Index.md +43 -0
  21. package/docs/Guides/Migration-Guide-V3.md +287 -0
  22. package/docs/Guides/Migration-Guide-V4.md +267 -0
  23. package/docs/Guides/Migration-Guide-V5.md +727 -0
  24. package/docs/Guides/Plugins-Guide.md +520 -0
  25. package/docs/Guides/Prototype-Poisoning.md +383 -0
  26. package/docs/Guides/Recommendations.md +378 -0
  27. package/docs/Guides/Serverless.md +604 -0
  28. package/docs/Guides/Style-Guide.md +246 -0
  29. package/docs/Guides/Testing.md +481 -0
  30. package/docs/Guides/Write-Plugin.md +103 -0
  31. package/docs/Guides/Write-Type-Provider.md +34 -0
  32. package/docs/Reference/ContentTypeParser.md +271 -0
  33. package/docs/Reference/Decorators.md +436 -0
  34. package/docs/Reference/Encapsulation.md +194 -0
  35. package/docs/Reference/Errors.md +377 -0
  36. package/docs/Reference/HTTP2.md +94 -0
  37. package/docs/Reference/Hooks.md +958 -0
  38. package/docs/Reference/Index.md +73 -0
  39. package/docs/Reference/LTS.md +86 -0
  40. package/docs/Reference/Lifecycle.md +99 -0
  41. package/docs/Reference/Logging.md +268 -0
  42. package/docs/Reference/Middleware.md +79 -0
  43. package/docs/Reference/Plugins.md +245 -0
  44. package/docs/Reference/Principles.md +73 -0
  45. package/docs/Reference/Reply.md +1001 -0
  46. package/docs/Reference/Request.md +295 -0
  47. package/docs/Reference/Routes.md +802 -0
  48. package/docs/Reference/Server.md +2389 -0
  49. package/docs/Reference/Type-Providers.md +256 -0
  50. package/docs/Reference/TypeScript.md +1729 -0
  51. package/docs/Reference/Validation-and-Serialization.md +1130 -0
  52. package/docs/Reference/Warnings.md +58 -0
  53. package/docs/index.md +24 -0
  54. package/docs/resources/encapsulation_context.drawio +1 -0
  55. package/docs/resources/encapsulation_context.svg +3 -0
  56. package/eslint.config.js +35 -0
  57. package/examples/asyncawait.js +38 -0
  58. package/examples/benchmark/body.json +3 -0
  59. package/examples/benchmark/hooks-benchmark-async-await.js +44 -0
  60. package/examples/benchmark/hooks-benchmark.js +52 -0
  61. package/examples/benchmark/parser.js +47 -0
  62. package/examples/benchmark/simple.js +30 -0
  63. package/examples/benchmark/webstream.js +27 -0
  64. package/examples/hooks.js +91 -0
  65. package/examples/http2.js +39 -0
  66. package/examples/https.js +38 -0
  67. package/examples/parser.js +53 -0
  68. package/examples/plugin.js +12 -0
  69. package/examples/route-prefix.js +38 -0
  70. package/examples/shared-schema.js +38 -0
  71. package/examples/simple-stream.js +20 -0
  72. package/examples/simple.js +32 -0
  73. package/examples/simple.mjs +27 -0
  74. package/examples/typescript-server.ts +79 -0
  75. package/examples/use-plugin.js +29 -0
  76. package/fastify.d.ts +253 -0
  77. package/fastify.js +985 -0
  78. package/integration/server.js +29 -0
  79. package/integration/test.sh +23 -0
  80. package/lib/config-validator.js +1266 -0
  81. package/lib/content-type-parser.js +413 -0
  82. package/lib/content-type.js +160 -0
  83. package/lib/context.js +98 -0
  84. package/lib/decorate.js +152 -0
  85. package/lib/error-handler.js +173 -0
  86. package/lib/error-serializer.js +134 -0
  87. package/lib/error-status.js +14 -0
  88. package/lib/errors.js +516 -0
  89. package/lib/four-oh-four.js +190 -0
  90. package/lib/handle-request.js +195 -0
  91. package/lib/head-route.js +45 -0
  92. package/lib/hooks.js +429 -0
  93. package/lib/initial-config-validation.js +37 -0
  94. package/lib/logger-factory.js +136 -0
  95. package/lib/logger-pino.js +68 -0
  96. package/lib/noop-set.js +10 -0
  97. package/lib/plugin-override.js +90 -0
  98. package/lib/plugin-utils.js +169 -0
  99. package/lib/promise.js +23 -0
  100. package/lib/reply.js +1030 -0
  101. package/lib/req-id-gen-factory.js +52 -0
  102. package/lib/request.js +391 -0
  103. package/lib/route.js +686 -0
  104. package/lib/schema-controller.js +164 -0
  105. package/lib/schemas.js +207 -0
  106. package/lib/server.js +441 -0
  107. package/lib/symbols.js +71 -0
  108. package/lib/validation.js +280 -0
  109. package/lib/warnings.js +57 -0
  110. package/lib/wrap-thenable.js +84 -0
  111. package/package.json +225 -0
  112. package/scripts/validate-ecosystem-links.js +179 -0
  113. package/test/404s.test.js +2035 -0
  114. package/test/500s.test.js +422 -0
  115. package/test/allow-unsafe-regex.test.js +92 -0
  116. package/test/als.test.js +65 -0
  117. package/test/async-await.test.js +705 -0
  118. package/test/async-dispose.test.js +20 -0
  119. package/test/async_hooks.test.js +52 -0
  120. package/test/body-limit.test.js +224 -0
  121. package/test/buffer.test.js +74 -0
  122. package/test/build/error-serializer.test.js +36 -0
  123. package/test/build/version.test.js +14 -0
  124. package/test/build-certificate.js +109 -0
  125. package/test/bundler/README.md +29 -0
  126. package/test/bundler/esbuild/bundler-test.js +32 -0
  127. package/test/bundler/esbuild/package.json +10 -0
  128. package/test/bundler/esbuild/src/fail-plugin-version.js +14 -0
  129. package/test/bundler/esbuild/src/index.js +9 -0
  130. package/test/bundler/webpack/bundler-test.js +32 -0
  131. package/test/bundler/webpack/package.json +11 -0
  132. package/test/bundler/webpack/src/fail-plugin-version.js +14 -0
  133. package/test/bundler/webpack/src/index.js +9 -0
  134. package/test/bundler/webpack/webpack.config.js +15 -0
  135. package/test/case-insensitive.test.js +102 -0
  136. package/test/chainable.test.js +40 -0
  137. package/test/child-logger-factory.test.js +128 -0
  138. package/test/client-timeout.test.js +38 -0
  139. package/test/close-pipelining.test.js +78 -0
  140. package/test/close.test.js +706 -0
  141. package/test/conditional-pino.test.js +47 -0
  142. package/test/connection-timeout.test.js +42 -0
  143. package/test/constrained-routes.test.js +1138 -0
  144. package/test/content-length.test.js +174 -0
  145. package/test/content-parser.test.js +739 -0
  146. package/test/content-type.test.js +181 -0
  147. package/test/context-config.test.js +164 -0
  148. package/test/custom-http-server.test.js +118 -0
  149. package/test/custom-parser-async.test.js +59 -0
  150. package/test/custom-parser.0.test.js +701 -0
  151. package/test/custom-parser.1.test.js +266 -0
  152. package/test/custom-parser.2.test.js +91 -0
  153. package/test/custom-parser.3.test.js +208 -0
  154. package/test/custom-parser.4.test.js +218 -0
  155. package/test/custom-parser.5.test.js +130 -0
  156. package/test/custom-querystring-parser.test.js +129 -0
  157. package/test/decorator.test.js +1330 -0
  158. package/test/delete.test.js +344 -0
  159. package/test/diagnostics-channel/404.test.js +49 -0
  160. package/test/diagnostics-channel/async-delay-request.test.js +65 -0
  161. package/test/diagnostics-channel/async-request.test.js +64 -0
  162. package/test/diagnostics-channel/error-before-handler.test.js +35 -0
  163. package/test/diagnostics-channel/error-request.test.js +53 -0
  164. package/test/diagnostics-channel/error-status.test.js +123 -0
  165. package/test/diagnostics-channel/init.test.js +50 -0
  166. package/test/diagnostics-channel/sync-delay-request.test.js +49 -0
  167. package/test/diagnostics-channel/sync-request-reply.test.js +51 -0
  168. package/test/diagnostics-channel/sync-request.test.js +54 -0
  169. package/test/encapsulated-child-logger-factory.test.js +69 -0
  170. package/test/encapsulated-error-handler.test.js +237 -0
  171. package/test/esm/errorCodes.test.mjs +10 -0
  172. package/test/esm/esm.test.mjs +13 -0
  173. package/test/esm/index.test.js +8 -0
  174. package/test/esm/named-exports.mjs +14 -0
  175. package/test/esm/other.mjs +8 -0
  176. package/test/esm/plugin.mjs +8 -0
  177. package/test/fastify-instance.test.js +300 -0
  178. package/test/find-route.test.js +152 -0
  179. package/test/fluent-schema.test.js +209 -0
  180. package/test/genReqId.test.js +426 -0
  181. package/test/handler-context.test.js +45 -0
  182. package/test/handler-timeout.test.js +367 -0
  183. package/test/has-route.test.js +88 -0
  184. package/test/header-overflow.test.js +55 -0
  185. package/test/helper.js +496 -0
  186. package/test/hooks-async.test.js +1099 -0
  187. package/test/hooks.on-listen.test.js +1162 -0
  188. package/test/hooks.on-ready.test.js +421 -0
  189. package/test/hooks.test.js +3578 -0
  190. package/test/http-methods/copy.test.js +35 -0
  191. package/test/http-methods/custom-http-methods.test.js +114 -0
  192. package/test/http-methods/get.test.js +412 -0
  193. package/test/http-methods/head.test.js +263 -0
  194. package/test/http-methods/lock.test.js +108 -0
  195. package/test/http-methods/mkcalendar.test.js +143 -0
  196. package/test/http-methods/mkcol.test.js +35 -0
  197. package/test/http-methods/move.test.js +42 -0
  198. package/test/http-methods/propfind.test.js +136 -0
  199. package/test/http-methods/proppatch.test.js +105 -0
  200. package/test/http-methods/report.test.js +142 -0
  201. package/test/http-methods/search.test.js +233 -0
  202. package/test/http-methods/trace.test.js +21 -0
  203. package/test/http-methods/unlock.test.js +38 -0
  204. package/test/http2/closing.test.js +270 -0
  205. package/test/http2/constraint.test.js +109 -0
  206. package/test/http2/head.test.js +34 -0
  207. package/test/http2/plain.test.js +68 -0
  208. package/test/http2/secure-with-fallback.test.js +113 -0
  209. package/test/http2/secure.test.js +67 -0
  210. package/test/http2/unknown-http-method.test.js +34 -0
  211. package/test/https/custom-https-server.test.js +58 -0
  212. package/test/https/https.test.js +136 -0
  213. package/test/imports.test.js +17 -0
  214. package/test/inject.test.js +502 -0
  215. package/test/input-validation.js +335 -0
  216. package/test/internals/all.test.js +38 -0
  217. package/test/internals/content-type-parser.test.js +111 -0
  218. package/test/internals/context.test.js +31 -0
  219. package/test/internals/decorator.test.js +156 -0
  220. package/test/internals/errors.test.js +982 -0
  221. package/test/internals/handle-request.test.js +270 -0
  222. package/test/internals/hook-runner.test.js +449 -0
  223. package/test/internals/hooks.test.js +96 -0
  224. package/test/internals/initial-config.test.js +383 -0
  225. package/test/internals/logger.test.js +163 -0
  226. package/test/internals/plugin.test.js +170 -0
  227. package/test/internals/promise.test.js +63 -0
  228. package/test/internals/reply-serialize.test.js +714 -0
  229. package/test/internals/reply.test.js +1920 -0
  230. package/test/internals/req-id-gen-factory.test.js +133 -0
  231. package/test/internals/request-validate.test.js +1402 -0
  232. package/test/internals/request.test.js +506 -0
  233. package/test/internals/schema-controller-perf.test.js +40 -0
  234. package/test/internals/server.test.js +91 -0
  235. package/test/internals/validation.test.js +352 -0
  236. package/test/issue-4959.test.js +118 -0
  237. package/test/keep-alive-timeout.test.js +42 -0
  238. package/test/listen.1.test.js +154 -0
  239. package/test/listen.2.test.js +113 -0
  240. package/test/listen.3.test.js +83 -0
  241. package/test/listen.4.test.js +168 -0
  242. package/test/listen.5.test.js +122 -0
  243. package/test/logger/instantiation.test.js +341 -0
  244. package/test/logger/logger-test-utils.js +47 -0
  245. package/test/logger/logging.test.js +460 -0
  246. package/test/logger/options.test.js +579 -0
  247. package/test/logger/request.test.js +292 -0
  248. package/test/logger/response.test.js +183 -0
  249. package/test/logger/tap-parallel-not-ok +0 -0
  250. package/test/max-requests-per-socket.test.js +113 -0
  251. package/test/middleware.test.js +37 -0
  252. package/test/noop-set.test.js +19 -0
  253. package/test/nullable-validation.test.js +187 -0
  254. package/test/options.error-handler.test.js +5 -0
  255. package/test/options.test.js +5 -0
  256. package/test/output-validation.test.js +140 -0
  257. package/test/patch.error-handler.test.js +5 -0
  258. package/test/patch.test.js +5 -0
  259. package/test/plugin.1.test.js +230 -0
  260. package/test/plugin.2.test.js +314 -0
  261. package/test/plugin.3.test.js +287 -0
  262. package/test/plugin.4.test.js +504 -0
  263. package/test/plugin.helper.js +8 -0
  264. package/test/plugin.name.display.js +10 -0
  265. package/test/post-empty-body.test.js +38 -0
  266. package/test/pretty-print.test.js +366 -0
  267. package/test/promises.test.js +125 -0
  268. package/test/proto-poisoning.test.js +145 -0
  269. package/test/put.error-handler.test.js +5 -0
  270. package/test/put.test.js +5 -0
  271. package/test/register.test.js +184 -0
  272. package/test/reply-code.test.js +148 -0
  273. package/test/reply-early-hints.test.js +100 -0
  274. package/test/reply-error.test.js +815 -0
  275. package/test/reply-trailers.test.js +445 -0
  276. package/test/reply-web-stream-locked.test.js +37 -0
  277. package/test/request-error.test.js +624 -0
  278. package/test/request-header-host.test.js +339 -0
  279. package/test/request-id.test.js +118 -0
  280. package/test/request-timeout.test.js +53 -0
  281. package/test/route-hooks.test.js +635 -0
  282. package/test/route-prefix.test.js +904 -0
  283. package/test/route-shorthand.test.js +48 -0
  284. package/test/route.1.test.js +259 -0
  285. package/test/route.2.test.js +100 -0
  286. package/test/route.3.test.js +213 -0
  287. package/test/route.4.test.js +127 -0
  288. package/test/route.5.test.js +211 -0
  289. package/test/route.6.test.js +306 -0
  290. package/test/route.7.test.js +406 -0
  291. package/test/route.8.test.js +225 -0
  292. package/test/router-options.test.js +1108 -0
  293. package/test/same-shape.test.js +124 -0
  294. package/test/schema-examples.test.js +661 -0
  295. package/test/schema-feature.test.js +2198 -0
  296. package/test/schema-serialization.test.js +1171 -0
  297. package/test/schema-special-usage.test.js +1348 -0
  298. package/test/schema-validation.test.js +1572 -0
  299. package/test/scripts/validate-ecosystem-links.test.js +339 -0
  300. package/test/serialize-response.test.js +186 -0
  301. package/test/server.test.js +347 -0
  302. package/test/set-error-handler.test.js +69 -0
  303. package/test/skip-reply-send.test.js +317 -0
  304. package/test/stream-serializers.test.js +40 -0
  305. package/test/stream.1.test.js +94 -0
  306. package/test/stream.2.test.js +129 -0
  307. package/test/stream.3.test.js +198 -0
  308. package/test/stream.4.test.js +176 -0
  309. package/test/stream.5.test.js +188 -0
  310. package/test/sync-routes.test.js +32 -0
  311. package/test/throw.test.js +359 -0
  312. package/test/toolkit.js +63 -0
  313. package/test/trust-proxy.test.js +162 -0
  314. package/test/type-provider.test.js +22 -0
  315. package/test/types/content-type-parser.test-d.ts +72 -0
  316. package/test/types/decorate-request-reply.test-d.ts +18 -0
  317. package/test/types/dummy-plugin.ts +9 -0
  318. package/test/types/errors.test-d.ts +90 -0
  319. package/test/types/fastify.test-d.ts +352 -0
  320. package/test/types/hooks.test-d.ts +550 -0
  321. package/test/types/import.ts +2 -0
  322. package/test/types/instance.test-d.ts +588 -0
  323. package/test/types/logger.test-d.ts +277 -0
  324. package/test/types/plugin.test-d.ts +97 -0
  325. package/test/types/register.test-d.ts +237 -0
  326. package/test/types/reply.test-d.ts +254 -0
  327. package/test/types/request.test-d.ts +188 -0
  328. package/test/types/route.test-d.ts +553 -0
  329. package/test/types/schema.test-d.ts +135 -0
  330. package/test/types/serverFactory.test-d.ts +37 -0
  331. package/test/types/type-provider.test-d.ts +1213 -0
  332. package/test/types/using.test-d.ts +17 -0
  333. package/test/upgrade.test.js +52 -0
  334. package/test/url-rewriting.test.js +122 -0
  335. package/test/use-semicolon-delimiter.test.js +168 -0
  336. package/test/validation-error-handling.test.js +900 -0
  337. package/test/versioned-routes.test.js +603 -0
  338. package/test/web-api.test.js +616 -0
  339. package/test/wrap-thenable.test.js +30 -0
  340. package/types/content-type-parser.d.ts +75 -0
  341. package/types/context.d.ts +22 -0
  342. package/types/errors.d.ts +92 -0
  343. package/types/hooks.d.ts +875 -0
  344. package/types/instance.d.ts +609 -0
  345. package/types/logger.d.ts +107 -0
  346. package/types/plugin.d.ts +44 -0
  347. package/types/register.d.ts +42 -0
  348. package/types/reply.d.ts +81 -0
  349. package/types/request.d.ts +95 -0
  350. package/types/route.d.ts +199 -0
  351. package/types/schema.d.ts +61 -0
  352. package/types/server-factory.d.ts +19 -0
  353. package/types/type-provider.d.ts +130 -0
  354. package/types/utils.d.ts +98 -0
@@ -0,0 +1,1572 @@
1
+ 'use strict'
2
+
3
+ const { test } = require('node:test')
4
+ const Fastify = require('..')
5
+
6
+ const AJV = require('ajv')
7
+ const Schema = require('fluent-json-schema')
8
+ const { waitForCb } = require('./toolkit')
9
+
10
+ const customSchemaCompilers = {
11
+ body: new AJV({
12
+ coerceTypes: false
13
+ }),
14
+ params: new AJV({
15
+ coerceTypes: true
16
+ }),
17
+ querystring: new AJV({
18
+ coerceTypes: true
19
+ })
20
+ }
21
+
22
+ const customValidatorCompiler = req => {
23
+ if (!req.httpPart) {
24
+ throw new Error('Missing httpPart')
25
+ }
26
+
27
+ const compiler = customSchemaCompilers[req.httpPart]
28
+
29
+ if (!compiler) {
30
+ throw new Error(`Missing compiler for ${req.httpPart}`)
31
+ }
32
+
33
+ return compiler.compile(req.schema)
34
+ }
35
+
36
+ const schemaA = {
37
+ $id: 'urn:schema:foo',
38
+ type: 'object',
39
+ definitions: {
40
+ foo: { type: 'integer' }
41
+ },
42
+ properties: {
43
+ foo: { $ref: '#/definitions/foo' }
44
+ }
45
+ }
46
+ const schemaBRefToA = {
47
+ $id: 'urn:schema:response',
48
+ type: 'object',
49
+ required: ['foo'],
50
+ properties: {
51
+ foo: { $ref: 'urn:schema:foo#/definitions/foo' }
52
+ }
53
+ }
54
+
55
+ const schemaCRefToB = {
56
+ $id: 'urn:schema:request',
57
+ type: 'object',
58
+ required: ['foo'],
59
+ properties: {
60
+ foo: { $ref: 'urn:schema:response#/properties/foo' }
61
+ }
62
+ }
63
+
64
+ const schemaArtist = {
65
+ type: 'object',
66
+ properties: {
67
+ name: { type: 'string' },
68
+ work: { type: 'string' }
69
+ },
70
+ required: ['name', 'work']
71
+ }
72
+
73
+ test('Basic validation test', (t, testDone) => {
74
+ t.plan(6)
75
+
76
+ const fastify = Fastify()
77
+ fastify.post('/', {
78
+ schema: {
79
+ body: schemaArtist
80
+ }
81
+ }, function (req, reply) {
82
+ reply.code(200).send(req.body.name)
83
+ })
84
+
85
+ const completion = waitForCb({ steps: 2 })
86
+ fastify.inject({
87
+ method: 'POST',
88
+ payload: {
89
+ name: 'michelangelo',
90
+ work: 'sculptor, painter, architect and poet'
91
+ },
92
+ url: '/'
93
+ }, (err, res) => {
94
+ t.assert.ifError(err)
95
+ t.assert.deepStrictEqual(res.payload, 'michelangelo')
96
+ t.assert.strictEqual(res.statusCode, 200)
97
+ completion.stepIn()
98
+ })
99
+ fastify.inject({
100
+ method: 'POST',
101
+ payload: { name: 'michelangelo' },
102
+ url: '/'
103
+ }, (err, res) => {
104
+ t.assert.ifError(err)
105
+ t.assert.deepStrictEqual(res.json(), { statusCode: 400, code: 'FST_ERR_VALIDATION', error: 'Bad Request', message: "body must have required property 'work'" })
106
+ t.assert.strictEqual(res.statusCode, 400)
107
+ completion.stepIn()
108
+ })
109
+ completion.patience.then(testDone)
110
+ })
111
+
112
+ test('Different schema per content type', (t, testDone) => {
113
+ t.plan(12)
114
+
115
+ const fastify = Fastify()
116
+ fastify.addContentTypeParser('application/octet-stream', {
117
+ parseAs: 'buffer'
118
+ }, async function (_, payload) {
119
+ return payload
120
+ })
121
+ fastify.post('/', {
122
+ schema: {
123
+ body: {
124
+ content: {
125
+ 'application/json': {
126
+ schema: schemaArtist
127
+ },
128
+ 'application/octet-stream': {
129
+ schema: {} // Skip validation
130
+ },
131
+ 'text/plain': {
132
+ schema: { type: 'string' }
133
+ }
134
+ }
135
+ }
136
+ }
137
+ }, async function (req, reply) {
138
+ return reply.send(req.body)
139
+ })
140
+
141
+ const completion = waitForCb({ steps: 4 })
142
+ fastify.inject({
143
+ url: '/',
144
+ method: 'POST',
145
+ headers: { 'Content-Type': 'application/json' },
146
+ body: {
147
+ name: 'michelangelo',
148
+ work: 'sculptor, painter, architect and poet'
149
+ }
150
+ }, (err, res) => {
151
+ t.assert.ifError(err)
152
+ t.assert.deepStrictEqual(JSON.parse(res.payload).name, 'michelangelo')
153
+ t.assert.strictEqual(res.statusCode, 200)
154
+ completion.stepIn()
155
+ })
156
+ fastify.inject({
157
+ url: '/',
158
+ method: 'POST',
159
+ headers: { 'Content-Type': 'application/json' },
160
+ body: { name: 'michelangelo' }
161
+ }, (err, res) => {
162
+ t.assert.ifError(err)
163
+ t.assert.deepStrictEqual(res.json(), { statusCode: 400, code: 'FST_ERR_VALIDATION', error: 'Bad Request', message: "body must have required property 'work'" })
164
+ t.assert.strictEqual(res.statusCode, 400)
165
+ completion.stepIn()
166
+ })
167
+ fastify.inject({
168
+ url: '/',
169
+ method: 'POST',
170
+ headers: { 'Content-Type': 'application/octet-stream' },
171
+ body: Buffer.from('AAAAAAAA')
172
+ }, (err, res) => {
173
+ t.assert.ifError(err)
174
+ t.assert.deepStrictEqual(res.payload, 'AAAAAAAA')
175
+ t.assert.strictEqual(res.statusCode, 200)
176
+ completion.stepIn()
177
+ })
178
+ fastify.inject({
179
+ url: '/',
180
+ method: 'POST',
181
+ headers: { 'Content-Type': 'text/plain' },
182
+ body: 'AAAAAAAA'
183
+ }, (err, res) => {
184
+ t.assert.ifError(err)
185
+ t.assert.deepStrictEqual(res.payload, 'AAAAAAAA')
186
+ t.assert.strictEqual(res.statusCode, 200)
187
+ completion.stepIn()
188
+ })
189
+ completion.patience.then(testDone)
190
+ })
191
+
192
+ test('Skip validation if no schema for content type', (t, testDone) => {
193
+ t.plan(3)
194
+
195
+ const fastify = Fastify()
196
+ fastify.post('/', {
197
+ schema: {
198
+ body: {
199
+ content: {
200
+ 'application/json': {
201
+ schema: schemaArtist
202
+ }
203
+ // No schema for 'text/plain'
204
+ }
205
+ }
206
+ }
207
+ }, async function (req, reply) {
208
+ return reply.send(req.body)
209
+ })
210
+ fastify.inject({
211
+ url: '/',
212
+ method: 'POST',
213
+ headers: { 'Content-Type': 'text/plain' },
214
+ body: 'AAAAAAAA'
215
+ }, (err, res) => {
216
+ t.assert.ifError(err)
217
+ t.assert.deepStrictEqual(res.payload, 'AAAAAAAA')
218
+ t.assert.strictEqual(res.statusCode, 200)
219
+ testDone()
220
+ })
221
+ })
222
+
223
+ test('Skip validation if no content type schemas', (t, testDone) => {
224
+ t.plan(3)
225
+
226
+ const fastify = Fastify()
227
+ fastify.post('/', {
228
+ schema: {
229
+ body: {
230
+ content: {
231
+ // No schemas
232
+ }
233
+ }
234
+ }
235
+ }, async function (req, reply) {
236
+ return reply.send(req.body)
237
+ })
238
+ fastify.inject({
239
+ url: '/',
240
+ method: 'POST',
241
+ headers: { 'Content-Type': 'text/plain' },
242
+ body: 'AAAAAAAA'
243
+ }, (err, res) => {
244
+ t.assert.ifError(err)
245
+ t.assert.deepStrictEqual(res.payload, 'AAAAAAAA')
246
+ t.assert.strictEqual(res.statusCode, 200)
247
+ testDone()
248
+ })
249
+ })
250
+
251
+ test('External AJV instance', (t, testDone) => {
252
+ t.plan(5)
253
+
254
+ const fastify = Fastify()
255
+ const ajv = new AJV()
256
+ ajv.addSchema(schemaA)
257
+ ajv.addSchema(schemaBRefToA)
258
+
259
+ // the user must provide the schemas to fastify also
260
+ fastify.addSchema(schemaA)
261
+ fastify.addSchema(schemaBRefToA)
262
+
263
+ fastify.setValidatorCompiler(({ schema, method, url, httpPart }) => {
264
+ t.assert.ok('custom validator compiler called')
265
+ return ajv.compile(schema)
266
+ })
267
+
268
+ fastify.post('/', {
269
+ handler (req, reply) { reply.send({ foo: 1 }) },
270
+ schema: {
271
+ body: schemaCRefToB,
272
+ response: {
273
+ '2xx': ajv.getSchema('urn:schema:response').schema
274
+ }
275
+ }
276
+ })
277
+
278
+ const completion = waitForCb({ steps: 2 })
279
+ fastify.inject({
280
+ method: 'POST',
281
+ url: '/',
282
+ payload: { foo: 42 }
283
+ }, (err, res) => {
284
+ t.assert.ifError(err)
285
+ t.assert.strictEqual(res.statusCode, 200)
286
+ completion.stepIn()
287
+ })
288
+ fastify.inject({
289
+ method: 'POST',
290
+ url: '/',
291
+ payload: { foo: 'not a number' }
292
+ }, (err, res) => {
293
+ t.assert.ifError(err)
294
+ t.assert.strictEqual(res.statusCode, 400)
295
+ completion.stepIn()
296
+ })
297
+ completion.patience.then(testDone)
298
+ })
299
+
300
+ test('Encapsulation', (t, testDone) => {
301
+ t.plan(21)
302
+
303
+ const fastify = Fastify()
304
+ const ajv = new AJV()
305
+ ajv.addSchema(schemaA)
306
+ ajv.addSchema(schemaBRefToA)
307
+
308
+ // the user must provide the schemas to fastify also
309
+ fastify.addSchema(schemaA)
310
+ fastify.addSchema(schemaBRefToA)
311
+
312
+ fastify.register((instance, opts, done) => {
313
+ const validator = ({ schema, method, url, httpPart }) => {
314
+ t.assert.ok('custom validator compiler called')
315
+ return ajv.compile(schema)
316
+ }
317
+ instance.setValidatorCompiler(validator)
318
+ instance.post('/one', {
319
+ handler (req, reply) { reply.send({ foo: 'one' }) },
320
+ schema: {
321
+ body: ajv.getSchema('urn:schema:response').schema
322
+ }
323
+ })
324
+
325
+ instance.register((instance, opts, done) => {
326
+ instance.post('/two', {
327
+ handler (req, reply) {
328
+ t.assert.deepStrictEqual(instance.validatorCompiler, validator)
329
+ reply.send({ foo: 'two' })
330
+ },
331
+ schema: {
332
+ body: ajv.getSchema('urn:schema:response').schema
333
+ }
334
+ })
335
+
336
+ const anotherValidator = ({ schema, method, url, httpPart }) => {
337
+ return () => { return true } // always valid
338
+ }
339
+ instance.post('/three', {
340
+ validatorCompiler: anotherValidator,
341
+ handler (req, reply) {
342
+ t.assert.deepStrictEqual(instance.validatorCompiler, validator, 'the route validator does not change the instance one')
343
+ reply.send({ foo: 'three' })
344
+ },
345
+ schema: {
346
+ body: ajv.getSchema('urn:schema:response').schema
347
+ }
348
+ })
349
+ done()
350
+ })
351
+ done()
352
+ })
353
+
354
+ fastify.register((instance, opts, done) => {
355
+ instance.post('/clean', function (req, reply) {
356
+ t.assert.strictEqual(instance.validatorCompiler, undefined)
357
+ reply.send({ foo: 'bar' })
358
+ })
359
+ done()
360
+ })
361
+
362
+ const completion = waitForCb({ steps: 6 })
363
+ fastify.inject({
364
+ method: 'POST',
365
+ url: '/one',
366
+ payload: { foo: 1 }
367
+ }, (err, res) => {
368
+ t.assert.ifError(err)
369
+ t.assert.strictEqual(res.statusCode, 200)
370
+ t.assert.deepStrictEqual(res.json(), { foo: 'one' })
371
+ completion.stepIn()
372
+ })
373
+ fastify.inject({
374
+ method: 'POST',
375
+ url: '/one',
376
+ payload: { wrongFoo: 'bar' }
377
+ }, (err, res) => {
378
+ t.assert.ifError(err)
379
+ t.assert.strictEqual(res.statusCode, 400)
380
+ completion.stepIn()
381
+ })
382
+ fastify.inject({
383
+ method: 'POST',
384
+ url: '/two',
385
+ payload: { foo: 2 }
386
+ }, (err, res) => {
387
+ t.assert.ifError(err)
388
+ t.assert.strictEqual(res.statusCode, 200)
389
+ t.assert.deepStrictEqual(res.json(), { foo: 'two' })
390
+ completion.stepIn()
391
+ })
392
+ fastify.inject({
393
+ method: 'POST',
394
+ url: '/two',
395
+ payload: { wrongFoo: 'bar' }
396
+ }, (err, res) => {
397
+ t.assert.ifError(err)
398
+ t.assert.strictEqual(res.statusCode, 400)
399
+ completion.stepIn()
400
+ })
401
+ fastify.inject({
402
+ method: 'POST',
403
+ url: '/three',
404
+ payload: { wrongFoo: 'but works' }
405
+ }, (err, res) => {
406
+ t.assert.ifError(err)
407
+ t.assert.strictEqual(res.statusCode, 200)
408
+ t.assert.deepStrictEqual(res.json(), { foo: 'three' })
409
+ completion.stepIn()
410
+ })
411
+ fastify.inject({
412
+ method: 'POST',
413
+ url: '/clean',
414
+ payload: { wrongFoo: 'bar' }
415
+ }, (err, res) => {
416
+ t.assert.ifError(err)
417
+ t.assert.strictEqual(res.statusCode, 200)
418
+ t.assert.deepStrictEqual(res.json(), { foo: 'bar' })
419
+ completion.stepIn()
420
+ })
421
+ completion.patience.then(testDone)
422
+ })
423
+
424
+ test('Triple $ref with a simple $id', (t, testDone) => {
425
+ t.plan(7)
426
+
427
+ const fastify = Fastify()
428
+ const ajv = new AJV()
429
+ ajv.addSchema(schemaA)
430
+ ajv.addSchema(schemaBRefToA)
431
+ ajv.addSchema(schemaCRefToB)
432
+
433
+ // the user must provide the schemas to fastify also
434
+ fastify.addSchema(schemaA)
435
+ fastify.addSchema(schemaBRefToA)
436
+ fastify.addSchema(schemaCRefToB)
437
+
438
+ fastify.setValidatorCompiler(({ schema, method, url, httpPart }) => {
439
+ t.assert.ok('custom validator compiler called')
440
+ return ajv.compile(schema)
441
+ })
442
+
443
+ fastify.post('/', {
444
+ handler (req, reply) { reply.send({ foo: 105, bar: 'foo' }) },
445
+ schema: {
446
+ body: ajv.getSchema('urn:schema:request').schema,
447
+ response: {
448
+ '2xx': ajv.getSchema('urn:schema:response').schema
449
+ }
450
+ }
451
+ })
452
+
453
+ const completion = waitForCb({ steps: 2 })
454
+ fastify.inject({
455
+ method: 'POST',
456
+ url: '/',
457
+ payload: { foo: 43 }
458
+ }, (err, res) => {
459
+ t.assert.ifError(err)
460
+ t.assert.strictEqual(res.statusCode, 200)
461
+ t.assert.deepStrictEqual(res.json(), { foo: 105 })
462
+ completion.stepIn()
463
+ })
464
+ fastify.inject({
465
+ method: 'POST',
466
+ url: '/',
467
+ payload: { fool: 'bar' }
468
+ }, (err, res) => {
469
+ t.assert.ifError(err)
470
+ t.assert.strictEqual(res.statusCode, 400)
471
+ t.assert.deepStrictEqual(res.json().message, "body must have required property 'foo'")
472
+ completion.stepIn()
473
+ })
474
+ completion.patience.then(testDone)
475
+ })
476
+
477
+ test('Extending schema', (t, testDone) => {
478
+ t.plan(4)
479
+ const fastify = Fastify()
480
+
481
+ fastify.addSchema({
482
+ $id: 'address.id',
483
+ type: 'object',
484
+ definitions: {
485
+ address: {
486
+ type: 'object',
487
+ properties: {
488
+ city: { type: 'string' },
489
+ state: { type: 'string' }
490
+ },
491
+ required: ['city', 'state']
492
+ }
493
+ }
494
+ })
495
+
496
+ fastify.post('/', {
497
+ handler (req, reply) { reply.send('works') },
498
+ schema: {
499
+ body: {
500
+ type: 'object',
501
+ properties: {
502
+ billingAddress: { $ref: 'address.id#/definitions/address' },
503
+ shippingAddress: {
504
+ allOf: [
505
+ { $ref: 'address.id#/definitions/address' },
506
+ {
507
+ type: 'object',
508
+ properties: { type: { enum: ['residential', 'business'] } },
509
+ required: ['type']
510
+ }
511
+ ]
512
+ }
513
+ }
514
+ }
515
+ }
516
+ })
517
+ fastify.inject({
518
+ method: 'POST',
519
+ url: '/',
520
+ payload: {
521
+ shippingAddress: {
522
+ city: 'Forlì',
523
+ state: 'FC'
524
+ }
525
+ }
526
+ }, (err, res) => {
527
+ t.assert.ifError(err)
528
+ t.assert.strictEqual(res.statusCode, 400)
529
+ })
530
+ fastify.inject({
531
+ method: 'POST',
532
+ url: '/',
533
+ payload: {
534
+ shippingAddress: {
535
+ city: 'Forlì',
536
+ state: 'FC',
537
+ type: 'business'
538
+ }
539
+ }
540
+ }, (err, res) => {
541
+ t.assert.ifError(err)
542
+ t.assert.strictEqual(res.statusCode, 200)
543
+ testDone()
544
+ })
545
+ })
546
+
547
+ test('Should work with nested ids', (t, testDone) => {
548
+ t.plan(6)
549
+ const fastify = Fastify()
550
+
551
+ fastify.addSchema({
552
+ $id: 'test',
553
+ type: 'object',
554
+ properties: {
555
+ id: { type: 'number' }
556
+ }
557
+ })
558
+
559
+ fastify.addSchema({
560
+ $id: 'greetings',
561
+ type: 'string'
562
+ })
563
+
564
+ fastify.post('/:id', {
565
+ handler (req, reply) { reply.send(typeof req.params.id) },
566
+ schema: {
567
+ params: { $ref: 'test#' },
568
+ body: {
569
+ type: 'object',
570
+ properties: {
571
+ hello: { $ref: 'greetings#' }
572
+ }
573
+ }
574
+ }
575
+ })
576
+
577
+ const completion = waitForCb({ steps: 2 })
578
+ fastify.inject({
579
+ method: 'POST',
580
+ url: '/123',
581
+ payload: {
582
+ hello: 'world'
583
+ }
584
+ }, (err, res) => {
585
+ t.assert.ifError(err)
586
+ t.assert.strictEqual(res.statusCode, 200)
587
+ t.assert.strictEqual(res.payload, 'number')
588
+ completion.stepIn()
589
+ })
590
+ fastify.inject({
591
+ method: 'POST',
592
+ url: '/abc',
593
+ payload: {
594
+ hello: 'world'
595
+ }
596
+ }, (err, res) => {
597
+ t.assert.ifError(err)
598
+ t.assert.strictEqual(res.statusCode, 400)
599
+ t.assert.strictEqual(res.json().message, 'params/id must be number')
600
+ completion.stepIn()
601
+ })
602
+ completion.patience.then(testDone)
603
+ })
604
+
605
+ test('Use the same schema across multiple routes', async (t) => {
606
+ t.plan(4)
607
+ const fastify = Fastify()
608
+
609
+ fastify.addSchema({
610
+ $id: 'test',
611
+ type: 'object',
612
+ properties: {
613
+ id: { type: 'number' }
614
+ }
615
+ })
616
+
617
+ fastify.get('/first/:id', {
618
+ handler (req, reply) { reply.send(typeof req.params.id) },
619
+ schema: {
620
+ params: { $ref: 'test#' }
621
+ }
622
+ })
623
+
624
+ fastify.get('/second/:id', {
625
+ handler (req, reply) { reply.send(typeof req.params.id) },
626
+ schema: {
627
+ params: { $ref: 'test#' }
628
+ }
629
+ })
630
+
631
+ const validTestCases = [
632
+ '/first/123',
633
+ '/second/123'
634
+ ]
635
+
636
+ for (const url of validTestCases) {
637
+ const res = await fastify.inject({
638
+ url,
639
+ method: 'GET'
640
+ })
641
+
642
+ t.assert.strictEqual(res.payload, 'number')
643
+ }
644
+
645
+ const invalidTestCases = [
646
+ '/first/abc',
647
+ '/second/abc'
648
+ ]
649
+
650
+ for (const url of invalidTestCases) {
651
+ const res = await fastify.inject({
652
+ url,
653
+ method: 'GET'
654
+ })
655
+ t.assert.strictEqual(res.statusCode, 400)
656
+ }
657
+ })
658
+
659
+ test('JSON Schema validation keywords', (t, testDone) => {
660
+ t.plan(6)
661
+ const fastify = Fastify()
662
+
663
+ fastify.addSchema({
664
+ $id: 'test',
665
+ type: 'object',
666
+ properties: {
667
+ ip: {
668
+ type: 'string',
669
+ format: 'ipv4'
670
+ }
671
+ }
672
+ })
673
+
674
+ fastify.get('/:ip', {
675
+ handler (req, reply) { reply.send(typeof req.params.ip) },
676
+ schema: {
677
+ params: { $ref: 'test#' }
678
+ }
679
+ })
680
+
681
+ const completion = waitForCb({ steps: 2 })
682
+ fastify.inject({
683
+ method: 'GET',
684
+ url: '/127.0.0.1'
685
+ }, (err, res) => {
686
+ t.assert.ifError(err)
687
+ t.assert.strictEqual(res.statusCode, 200)
688
+ t.assert.strictEqual(res.payload, 'string')
689
+ completion.stepIn()
690
+ })
691
+ fastify.inject({
692
+ method: 'GET',
693
+ url: '/localhost'
694
+ }, (err, res) => {
695
+ t.assert.ifError(err)
696
+ t.assert.strictEqual(res.statusCode, 400)
697
+ t.assert.deepStrictEqual(res.json(), {
698
+ statusCode: 400,
699
+ code: 'FST_ERR_VALIDATION',
700
+ error: 'Bad Request',
701
+ message: 'params/ip must match format "ipv4"'
702
+ })
703
+ completion.stepIn()
704
+ })
705
+ completion.patience.then(testDone)
706
+ })
707
+
708
+ test('Nested id calls', (t, testDone) => {
709
+ t.plan(6)
710
+ const fastify = Fastify()
711
+
712
+ fastify.addSchema({
713
+ $id: 'test',
714
+ type: 'object',
715
+ properties: {
716
+ ip: {
717
+ type: 'string',
718
+ format: 'ipv4'
719
+ }
720
+ }
721
+ })
722
+
723
+ fastify.addSchema({
724
+ $id: 'hello',
725
+ type: 'object',
726
+ properties: {
727
+ host: { $ref: 'test#' }
728
+ }
729
+ })
730
+
731
+ fastify.post('/', {
732
+ handler (req, reply) { reply.send(typeof req.body.host.ip) },
733
+ schema: {
734
+ body: { $ref: 'hello#' }
735
+ }
736
+ })
737
+
738
+ const completion = waitForCb({ steps: 2 })
739
+ fastify.inject({
740
+ method: 'POST',
741
+ url: '/',
742
+ payload: { host: { ip: '127.0.0.1' } }
743
+ }, (err, res) => {
744
+ t.assert.ifError(err)
745
+ t.assert.strictEqual(res.statusCode, 200)
746
+ t.assert.strictEqual(res.payload, 'string')
747
+ completion.stepIn()
748
+ })
749
+ fastify.inject({
750
+ method: 'POST',
751
+ url: '/',
752
+ payload: { host: { ip: 'localhost' } }
753
+ }, (err, res) => {
754
+ t.assert.ifError(err)
755
+ t.assert.strictEqual(res.statusCode, 400)
756
+ t.assert.deepStrictEqual(res.json(), {
757
+ error: 'Bad Request',
758
+ message: 'body/host/ip must match format "ipv4"',
759
+ statusCode: 400,
760
+ code: 'FST_ERR_VALIDATION'
761
+ })
762
+ completion.stepIn()
763
+ })
764
+ completion.patience.then(testDone)
765
+ })
766
+
767
+ test('Use the same schema id in different places', (t, testDone) => {
768
+ t.plan(2)
769
+ const fastify = Fastify()
770
+
771
+ fastify.addSchema({
772
+ $id: 'test',
773
+ type: 'object',
774
+ properties: {
775
+ id: { type: 'number' }
776
+ }
777
+ })
778
+
779
+ fastify.post('/', {
780
+ handler (req, reply) { reply.send({ id: req.body.id / 2 }) },
781
+ schema: {
782
+ body: { $ref: 'test#' },
783
+ response: {
784
+ 200: { $ref: 'test#' }
785
+ }
786
+ }
787
+ })
788
+ fastify.inject({
789
+ method: 'POST',
790
+ url: '/',
791
+ payload: { id: 42 }
792
+ }, (err, res) => {
793
+ t.assert.ifError(err)
794
+ t.assert.deepStrictEqual(res.json(), { id: 21 })
795
+ testDone()
796
+ })
797
+ })
798
+
799
+ test('Use shared schema and $ref with $id ($ref to $id)', (t, testDone) => {
800
+ t.plan(5)
801
+ const fastify = Fastify()
802
+
803
+ fastify.addSchema({
804
+ $id: 'http://foo/test',
805
+ type: 'object',
806
+ properties: {
807
+ id: { type: 'number' }
808
+ }
809
+ })
810
+
811
+ const body = {
812
+ $id: 'http://foo/user',
813
+ $schema: 'http://json-schema.org/draft-07/schema#',
814
+ type: 'object',
815
+ definitions: {
816
+ address: {
817
+ $id: '#address',
818
+ type: 'object',
819
+ properties: {
820
+ city: { type: 'string' }
821
+ }
822
+ }
823
+ },
824
+ required: ['address'],
825
+ properties: {
826
+ test: { $ref: 'http://foo/test#' }, // to external
827
+ address: { $ref: '#address' } // to local
828
+ }
829
+ }
830
+
831
+ fastify.post('/', {
832
+ handler (req, reply) { reply.send(req.body.test) },
833
+ schema: {
834
+ body,
835
+ response: {
836
+ 200: { $ref: 'http://foo/test#' }
837
+ }
838
+ }
839
+ })
840
+
841
+ const id = Date.now()
842
+ const completion = waitForCb({ steps: 2 })
843
+ fastify.inject({
844
+ method: 'POST',
845
+ url: '/',
846
+ payload: {
847
+ address: { city: 'New Node' },
848
+ test: { id }
849
+ }
850
+ }, (err, res) => {
851
+ t.assert.ifError(err)
852
+ t.assert.deepStrictEqual(res.json(), { id })
853
+ completion.stepIn()
854
+ })
855
+ fastify.inject({
856
+ method: 'POST',
857
+ url: '/',
858
+ payload: { test: { id } }
859
+ }, (err, res) => {
860
+ t.assert.ifError(err)
861
+ t.assert.strictEqual(res.statusCode, 400)
862
+ t.assert.deepStrictEqual(res.json(), {
863
+ error: 'Bad Request',
864
+ message: "body must have required property 'address'",
865
+ statusCode: 400,
866
+ code: 'FST_ERR_VALIDATION'
867
+ })
868
+ completion.stepIn()
869
+ })
870
+ completion.patience.then(testDone)
871
+ })
872
+
873
+ test('Use items with $ref', (t, testDone) => {
874
+ t.plan(4)
875
+ const fastify = Fastify()
876
+
877
+ fastify.addSchema({
878
+ $id: 'http://fastify.test/ref-to-external-validator.json',
879
+ type: 'object',
880
+ properties: {
881
+ hello: { type: 'string' }
882
+ }
883
+ })
884
+
885
+ const body = {
886
+ type: 'array',
887
+ items: { $ref: 'http://fastify.test/ref-to-external-validator.json#' }
888
+ }
889
+
890
+ fastify.post('/', {
891
+ schema: { body },
892
+ handler: (_, r) => { r.send('ok') }
893
+ })
894
+
895
+ const completion = waitForCb({ steps: 2 })
896
+ fastify.inject({
897
+ method: 'POST',
898
+ url: '/',
899
+ payload: [{ hello: 'world' }]
900
+ }, (err, res) => {
901
+ t.assert.ifError(err)
902
+ t.assert.strictEqual(res.payload, 'ok')
903
+ completion.stepIn()
904
+ })
905
+ fastify.inject({
906
+ method: 'POST',
907
+ url: '/',
908
+ payload: { hello: 'world' }
909
+ }, (err, res) => {
910
+ t.assert.ifError(err)
911
+ t.assert.strictEqual(res.statusCode, 400)
912
+ completion.stepIn()
913
+ })
914
+ completion.patience.then(testDone)
915
+ })
916
+
917
+ test('Use $ref to /definitions', (t, testDone) => {
918
+ t.plan(6)
919
+ const fastify = Fastify()
920
+
921
+ fastify.addSchema({
922
+ $id: 'test',
923
+ type: 'object',
924
+ properties: {
925
+ id: { type: 'number' }
926
+ }
927
+ })
928
+
929
+ const body = {
930
+ type: 'object',
931
+ definitions: {
932
+ address: {
933
+ $id: '#otherId',
934
+ type: 'object',
935
+ properties: {
936
+ city: { type: 'string' }
937
+ }
938
+ }
939
+ },
940
+ properties: {
941
+ test: { $ref: 'test#' },
942
+ address: { $ref: '#/definitions/address' }
943
+ },
944
+ required: ['address', 'test']
945
+ }
946
+
947
+ fastify.post('/', {
948
+ schema: {
949
+ body,
950
+ response: {
951
+ 200: body
952
+ }
953
+ },
954
+ handler: (req, reply) => {
955
+ req.body.removeThis = 'it should not be serialized'
956
+ reply.send(req.body)
957
+ }
958
+ })
959
+
960
+ const payload = {
961
+ address: { city: 'New Node' },
962
+ test: { id: Date.now() }
963
+ }
964
+ const completion = waitForCb({ steps: 2 })
965
+ fastify.inject({
966
+ method: 'POST',
967
+ url: '/',
968
+ payload
969
+ }, (err, res) => {
970
+ t.assert.ifError(err)
971
+ t.assert.strictEqual(res.statusCode, 200)
972
+ t.assert.deepStrictEqual(res.json(), payload)
973
+ completion.stepIn()
974
+ })
975
+ fastify.inject({
976
+ method: 'POST',
977
+ url: '/',
978
+ payload: {
979
+ address: { city: 'New Node' },
980
+ test: { id: 'wrong' }
981
+ }
982
+ }, (err, res) => {
983
+ t.assert.ifError(err)
984
+ t.assert.strictEqual(res.statusCode, 400)
985
+ t.assert.deepStrictEqual(res.json(), {
986
+ error: 'Bad Request',
987
+ message: 'body/test/id must be number',
988
+ statusCode: 400,
989
+ code: 'FST_ERR_VALIDATION'
990
+ })
991
+ completion.stepIn()
992
+ })
993
+ completion.patience.then(testDone)
994
+ })
995
+
996
+ test('Custom AJV settings - pt1', (t, testDone) => {
997
+ t.plan(4)
998
+ const fastify = Fastify()
999
+
1000
+ fastify.post('/', {
1001
+ schema: {
1002
+ body: {
1003
+ type: 'object',
1004
+ properties: {
1005
+ num: { type: 'integer' }
1006
+ }
1007
+ }
1008
+ },
1009
+ handler: (req, reply) => {
1010
+ t.assert.strictEqual(req.body.num, 12)
1011
+ reply.send(req.body)
1012
+ }
1013
+ })
1014
+ fastify.inject({
1015
+ method: 'POST',
1016
+ url: '/',
1017
+ payload: {
1018
+ num: '12'
1019
+ }
1020
+ }, (err, res) => {
1021
+ t.assert.ifError(err)
1022
+ t.assert.strictEqual(res.statusCode, 200)
1023
+ t.assert.deepStrictEqual(res.json(), { num: 12 })
1024
+ testDone()
1025
+ })
1026
+ })
1027
+
1028
+ test('Custom AJV settings - pt2', (t, testDone) => {
1029
+ t.plan(2)
1030
+ const fastify = Fastify({
1031
+ ajv: {
1032
+ customOptions: {
1033
+ coerceTypes: false
1034
+ }
1035
+ }
1036
+ })
1037
+
1038
+ fastify.post('/', {
1039
+ schema: {
1040
+ body: {
1041
+ type: 'object',
1042
+ properties: {
1043
+ num: { type: 'integer' }
1044
+ }
1045
+ }
1046
+ },
1047
+ handler: (req, reply) => {
1048
+ t.fail('the handler is not called because the "12" is not coerced to number')
1049
+ }
1050
+ })
1051
+ fastify.inject({
1052
+ method: 'POST',
1053
+ url: '/',
1054
+ payload: {
1055
+ num: '12'
1056
+ }
1057
+ }, (err, res) => {
1058
+ t.assert.ifError(err)
1059
+ t.assert.strictEqual(res.statusCode, 400)
1060
+ testDone()
1061
+ })
1062
+ })
1063
+
1064
+ test('Custom AJV settings on different parameters - pt1', (t, testDone) => {
1065
+ t.plan(2)
1066
+ const fastify = Fastify()
1067
+
1068
+ fastify.setValidatorCompiler(customValidatorCompiler)
1069
+
1070
+ fastify.post('/api/:id', {
1071
+ schema: {
1072
+ querystring: {
1073
+ type: 'object',
1074
+ properties: {
1075
+ id: { type: 'integer' }
1076
+ }
1077
+ },
1078
+ body: {
1079
+ type: 'object',
1080
+ properties: {
1081
+ num: { type: 'number' }
1082
+ },
1083
+ required: ['num']
1084
+ }
1085
+ },
1086
+ handler: (req, reply) => {
1087
+ t.fail('the handler is not called because the "12" is not coerced to number')
1088
+ }
1089
+ })
1090
+ fastify.inject({
1091
+ method: 'POST',
1092
+ url: '/api/42',
1093
+ payload: {
1094
+ num: '12'
1095
+ }
1096
+ }, (err, res) => {
1097
+ t.assert.ifError(err)
1098
+ t.assert.strictEqual(res.statusCode, 400)
1099
+ testDone()
1100
+ })
1101
+ })
1102
+
1103
+ test('Custom AJV settings on different parameters - pt2', (t, testDone) => {
1104
+ t.plan(4)
1105
+ const fastify = Fastify()
1106
+
1107
+ fastify.setValidatorCompiler(customValidatorCompiler)
1108
+
1109
+ fastify.post('/api/:id', {
1110
+ schema: {
1111
+ params: {
1112
+ type: 'object',
1113
+ properties: {
1114
+ id: { type: 'number' }
1115
+ },
1116
+ required: ['id']
1117
+ },
1118
+ body: {
1119
+ type: 'object',
1120
+ properties: {
1121
+ num: { type: 'number' }
1122
+ },
1123
+ required: ['num']
1124
+ }
1125
+ },
1126
+ handler: (req, reply) => {
1127
+ t.assert.deepStrictEqual(typeof req.params.id, 'number')
1128
+ t.assert.deepStrictEqual(typeof req.body.num, 'number')
1129
+ t.assert.deepStrictEqual(req.params.id, 42)
1130
+ t.assert.deepStrictEqual(req.body.num, 12)
1131
+ testDone()
1132
+ }
1133
+ })
1134
+ fastify.inject({
1135
+ method: 'POST',
1136
+ url: '/api/42',
1137
+ payload: {
1138
+ num: 12
1139
+ }
1140
+ })
1141
+ })
1142
+
1143
+ test("The same $id in route's schema must not overwrite others", (t, testDone) => {
1144
+ t.plan(4)
1145
+ const fastify = Fastify()
1146
+
1147
+ const UserSchema = Schema.object()
1148
+ .id('http://mydomain.com/user')
1149
+ .title('User schema')
1150
+ .description('Contains all user fields')
1151
+ .prop('id', Schema.integer())
1152
+ .prop('username', Schema.string().minLength(4))
1153
+ .prop('firstName', Schema.string().minLength(1))
1154
+ .prop('lastName', Schema.string().minLength(1))
1155
+ .prop('fullName', Schema.string().minLength(1))
1156
+ .prop('email', Schema.string())
1157
+ .prop('password', Schema.string().minLength(6))
1158
+ .prop('bio', Schema.string())
1159
+
1160
+ const userCreateSchema = UserSchema.only([
1161
+ 'username',
1162
+ 'firstName',
1163
+ 'lastName',
1164
+ 'email',
1165
+ 'bio',
1166
+ 'password',
1167
+ 'password_confirm'
1168
+ ])
1169
+ .required([
1170
+ 'username',
1171
+ 'firstName',
1172
+ 'lastName',
1173
+ 'email',
1174
+ 'bio',
1175
+ 'password'
1176
+ ])
1177
+
1178
+ const userPatchSchema = UserSchema.only([
1179
+ 'firstName',
1180
+ 'lastName',
1181
+ 'bio'
1182
+ ])
1183
+
1184
+ fastify
1185
+ .patch('/user/:id', {
1186
+ schema: { body: userPatchSchema },
1187
+ handler: () => { return 'ok' }
1188
+ })
1189
+ .post('/user', {
1190
+ schema: { body: userCreateSchema },
1191
+ handler: () => { return 'ok' }
1192
+ })
1193
+
1194
+ const completion = waitForCb({ steps: 2 })
1195
+ fastify.inject({
1196
+ method: 'POST',
1197
+ url: '/user',
1198
+ body: {}
1199
+ }, (err, res) => {
1200
+ t.assert.ifError(err)
1201
+ t.assert.deepStrictEqual(res.json().message, "body must have required property 'username'")
1202
+ completion.stepIn()
1203
+ })
1204
+ fastify.inject({
1205
+ url: '/user/1',
1206
+ method: 'PATCH',
1207
+ body: {}
1208
+ }, (err, res) => {
1209
+ t.assert.ifError(err)
1210
+ t.assert.deepStrictEqual(res.payload, 'ok')
1211
+ completion.stepIn()
1212
+ })
1213
+ completion.patience.then(testDone)
1214
+ })
1215
+
1216
+ test('Custom validator compiler should not mutate schema', async t => {
1217
+ t.plan(2)
1218
+ class Headers { }
1219
+ const fastify = Fastify()
1220
+
1221
+ fastify.setValidatorCompiler(({ schema, method, url, httpPart }) => {
1222
+ t.assert.ok(schema instanceof Headers)
1223
+ return () => { }
1224
+ })
1225
+
1226
+ fastify.get('/', {
1227
+ schema: {
1228
+ headers: new Headers()
1229
+ }
1230
+ }, () => { })
1231
+
1232
+ await fastify.ready()
1233
+ })
1234
+
1235
+ test('Custom validator builder override by custom validator compiler', async t => {
1236
+ t.plan(3)
1237
+ const ajvDefaults = {
1238
+ removeAdditional: true,
1239
+ coerceTypes: true,
1240
+ allErrors: true
1241
+ }
1242
+ const ajv1 = new AJV(ajvDefaults).addKeyword({ keyword: 'extended_one', type: 'object', validator: () => true })
1243
+ const ajv2 = new AJV(ajvDefaults).addKeyword({ keyword: 'extended_two', type: 'object', validator: () => true })
1244
+ const fastify = Fastify({
1245
+ schemaController: {
1246
+ compilersFactory: {
1247
+ buildValidator: () => (routeSchemaDef) => ajv1.compile(routeSchemaDef.schema)
1248
+ }
1249
+ }
1250
+ })
1251
+
1252
+ fastify.setValidatorCompiler((routeSchemaDef) => ajv2.compile(routeSchemaDef.schema))
1253
+
1254
+ fastify.post('/two/:id', {
1255
+ schema: {
1256
+ params: {
1257
+ type: 'object',
1258
+ extended_two: true,
1259
+ properties: {
1260
+ id: { type: 'number' }
1261
+ },
1262
+ required: ['id']
1263
+ }
1264
+ },
1265
+ handler: (req, _reply) => {
1266
+ t.assert.deepStrictEqual(typeof req.params.id, 'number')
1267
+ t.assert.deepStrictEqual(req.params.id, 43)
1268
+ return 'ok'
1269
+ }
1270
+ })
1271
+
1272
+ await fastify.ready()
1273
+
1274
+ const two = await fastify.inject({
1275
+ method: 'POST',
1276
+ url: '/two/43'
1277
+ })
1278
+ t.assert.strictEqual(two.statusCode, 200)
1279
+ })
1280
+
1281
+ test('Custom validator builder override by custom validator compiler in child instance', async t => {
1282
+ t.plan(6)
1283
+ const ajvDefaults = {
1284
+ removeAdditional: true,
1285
+ coerceTypes: true,
1286
+ allErrors: true
1287
+ }
1288
+ const ajv1 = new AJV(ajvDefaults).addKeyword({ keyword: 'extended_one', type: 'object', validator: () => true })
1289
+ const ajv2 = new AJV(ajvDefaults).addKeyword({ keyword: 'extended_two', type: 'object', validator: () => true })
1290
+ const fastify = Fastify({
1291
+ schemaController: {
1292
+ compilersFactory: {
1293
+ buildValidator: () => (routeSchemaDef) => ajv1.compile(routeSchemaDef.schema)
1294
+ }
1295
+ }
1296
+ })
1297
+
1298
+ fastify.register((embedded, _opts, done) => {
1299
+ embedded.setValidatorCompiler((routeSchemaDef) => ajv2.compile(routeSchemaDef.schema))
1300
+ embedded.post('/two/:id', {
1301
+ schema: {
1302
+ params: {
1303
+ type: 'object',
1304
+ extended_two: true,
1305
+ properties: {
1306
+ id: { type: 'number' }
1307
+ },
1308
+ required: ['id']
1309
+ }
1310
+ },
1311
+ handler: (req, _reply) => {
1312
+ t.assert.deepStrictEqual(typeof req.params.id, 'number')
1313
+ t.assert.deepStrictEqual(req.params.id, 43)
1314
+ return 'ok'
1315
+ }
1316
+ })
1317
+ done()
1318
+ })
1319
+
1320
+ fastify.post('/one/:id', {
1321
+ schema: {
1322
+ params: {
1323
+ type: 'object',
1324
+ extended_one: true,
1325
+ properties: {
1326
+ id: { type: 'number' }
1327
+ },
1328
+ required: ['id']
1329
+ }
1330
+ },
1331
+ handler: (req, _reply) => {
1332
+ t.assert.deepStrictEqual(typeof req.params.id, 'number')
1333
+ t.assert.deepStrictEqual(req.params.id, 42)
1334
+ return 'ok'
1335
+ }
1336
+ })
1337
+
1338
+ await fastify.ready()
1339
+
1340
+ const one = await fastify.inject({
1341
+ method: 'POST',
1342
+ url: '/one/42'
1343
+ })
1344
+ t.assert.strictEqual(one.statusCode, 200)
1345
+
1346
+ const two = await fastify.inject({
1347
+ method: 'POST',
1348
+ url: '/two/43'
1349
+ })
1350
+ t.assert.strictEqual(two.statusCode, 200)
1351
+ })
1352
+
1353
+ test('Schema validation when no content type is provided', async t => {
1354
+ // this case should not be happened in normal use-case,
1355
+ // it is added for the completeness of code branch
1356
+ const fastify = Fastify()
1357
+
1358
+ fastify.post('/', {
1359
+ schema: {
1360
+ body: {
1361
+ content: {
1362
+ 'application/json': {
1363
+ schema: {
1364
+ type: 'object',
1365
+ properties: {
1366
+ foo: { type: 'string' }
1367
+ },
1368
+ required: ['foo'],
1369
+ additionalProperties: false
1370
+ }
1371
+ }
1372
+ }
1373
+ }
1374
+ },
1375
+ preValidation: async (request) => {
1376
+ request.headers['content-type'] = undefined
1377
+ }
1378
+ }, async () => 'ok')
1379
+
1380
+ await fastify.ready()
1381
+
1382
+ const invalid = await fastify.inject({
1383
+ method: 'POST',
1384
+ url: '/',
1385
+ headers: {
1386
+ 'content-type': 'application/json'
1387
+ },
1388
+ body: { invalid: 'string' }
1389
+ })
1390
+ t.assert.strictEqual(invalid.statusCode, 200)
1391
+ })
1392
+
1393
+ test('Schema validation will not be bypass by different content type', async t => {
1394
+ const fastify = Fastify()
1395
+
1396
+ fastify.post('/', {
1397
+ schema: {
1398
+ body: {
1399
+ content: {
1400
+ 'application/json': {
1401
+ schema: {
1402
+ type: 'object',
1403
+ properties: {
1404
+ foo: { type: 'string' }
1405
+ },
1406
+ required: ['foo'],
1407
+ additionalProperties: false
1408
+ }
1409
+ }
1410
+ }
1411
+ }
1412
+ }
1413
+ }, async () => 'ok')
1414
+
1415
+ await fastify.listen({ port: 0 })
1416
+ t.after(() => fastify.close())
1417
+ const address = fastify.listeningOrigin
1418
+
1419
+ let found = await fetch(address, {
1420
+ method: 'POST',
1421
+ url: '/',
1422
+ headers: {
1423
+ 'content-type': 'application/json'
1424
+ },
1425
+ body: JSON.stringify({ foo: 'string' })
1426
+ })
1427
+ t.assert.strictEqual(found.status, 200)
1428
+ await found.bytes()
1429
+
1430
+ found = await fetch(address, {
1431
+ method: 'POST',
1432
+ url: '/',
1433
+ headers: {
1434
+ 'content-type': 'application/json; charset=utf-8'
1435
+ },
1436
+ body: JSON.stringify({ foo: 'string' })
1437
+ })
1438
+ t.assert.strictEqual(found.status, 200)
1439
+ await found.bytes()
1440
+
1441
+ found = await fetch(address, {
1442
+ method: 'POST',
1443
+ url: '/',
1444
+ headers: {
1445
+ 'content-type': 'application/json\t; charset=utf-8'
1446
+ },
1447
+ body: JSON.stringify({ foo: 'string' })
1448
+ })
1449
+ t.assert.strictEqual(found.status, 200)
1450
+ await found.bytes()
1451
+
1452
+ found = await fetch(address, {
1453
+ method: 'POST',
1454
+ url: '/',
1455
+ headers: {
1456
+ 'content-type': 'application/json ;'
1457
+ },
1458
+ body: JSON.stringify({ invalid: 'string' })
1459
+ })
1460
+ t.assert.strictEqual(found.status, 400)
1461
+ t.assert.strictEqual((await found.json()).code, 'FST_ERR_VALIDATION')
1462
+
1463
+ found = await fetch(address, {
1464
+ method: 'POST',
1465
+ url: '/',
1466
+ headers: {
1467
+ 'content-type': 'ApPlIcAtIoN/JsOn;'
1468
+ },
1469
+ body: JSON.stringify({ invalid: 'string' })
1470
+ })
1471
+ t.assert.strictEqual(found.status, 400)
1472
+ t.assert.strictEqual((await found.json()).code, 'FST_ERR_VALIDATION')
1473
+
1474
+ found = await fetch(address, {
1475
+ method: 'POST',
1476
+ url: '/',
1477
+ headers: {
1478
+ 'content-type': 'ApPlIcAtIoN/JsOn ;'
1479
+ },
1480
+ body: JSON.stringify({ invalid: 'string' })
1481
+ })
1482
+ t.assert.strictEqual(found.status, 400)
1483
+ t.assert.strictEqual((await found.json()).code, 'FST_ERR_VALIDATION')
1484
+
1485
+ found = await fetch(address, {
1486
+ method: 'POST',
1487
+ url: '/',
1488
+ headers: {
1489
+ 'content-type': 'ApPlIcAtIoN/JsOn foo;'
1490
+ },
1491
+ body: JSON.stringify({ invalid: 'string' })
1492
+ })
1493
+ t.assert.strictEqual(found.status, 415)
1494
+ t.assert.strictEqual((await found.json()).code, 'FST_ERR_CTP_INVALID_MEDIA_TYPE')
1495
+
1496
+ found = await fetch(address, {
1497
+ method: 'POST',
1498
+ url: '/',
1499
+ headers: {
1500
+ 'content-type': 'ApPlIcAtIoN/JsOn \tfoo;'
1501
+ },
1502
+ body: JSON.stringify({ invalid: 'string' })
1503
+ })
1504
+ t.assert.strictEqual(found.status, 415)
1505
+ t.assert.strictEqual((await found.json()).code, 'FST_ERR_CTP_INVALID_MEDIA_TYPE')
1506
+
1507
+ found = await fetch(address, {
1508
+ method: 'POST',
1509
+ url: '/',
1510
+ headers: {
1511
+ 'content-type': 'ApPlIcAtIoN/JsOn\t foo;'
1512
+ },
1513
+ body: JSON.stringify({ invalid: 'string' })
1514
+ })
1515
+ t.assert.strictEqual(found.status, 415)
1516
+ t.assert.strictEqual((await found.json()).code, 'FST_ERR_CTP_INVALID_MEDIA_TYPE')
1517
+
1518
+ found = await fetch(address, {
1519
+ method: 'POST',
1520
+ url: '/',
1521
+ headers: {
1522
+ 'content-type': 'ApPlIcAtIoN/JsOn \t'
1523
+ },
1524
+ body: JSON.stringify({ invalid: 'string' })
1525
+ })
1526
+ t.assert.strictEqual(found.status, 400)
1527
+ t.assert.strictEqual((await found.json()).code, 'FST_ERR_VALIDATION')
1528
+
1529
+ found = await fetch(address, {
1530
+ method: 'POST',
1531
+ url: '/',
1532
+ headers: {
1533
+ 'content-type': 'ApPlIcAtIoN/JsOn\t'
1534
+ },
1535
+ body: JSON.stringify({ invalid: 'string' })
1536
+ })
1537
+ t.assert.strictEqual(found.status, 400)
1538
+ t.assert.strictEqual((await found.json()).code, 'FST_ERR_VALIDATION')
1539
+
1540
+ found = await fetch(address, {
1541
+ method: 'POST',
1542
+ url: '/',
1543
+ headers: {
1544
+ 'content-type': 'ApPlIcAtIoN/JsOn\ta'
1545
+ },
1546
+ body: JSON.stringify({ invalid: 'string' })
1547
+ })
1548
+ t.assert.strictEqual(found.status, 415)
1549
+ t.assert.strictEqual((await found.json()).code, 'FST_ERR_CTP_INVALID_MEDIA_TYPE')
1550
+
1551
+ found = await fetch(address, {
1552
+ method: 'POST',
1553
+ url: '/',
1554
+ headers: {
1555
+ 'content-type': 'ApPlIcAtIoN/JsOn\ta; charset=utf-8'
1556
+ },
1557
+ body: JSON.stringify({ invalid: 'string' })
1558
+ })
1559
+ t.assert.strictEqual(found.status, 415)
1560
+ t.assert.strictEqual((await found.json()).code, 'FST_ERR_CTP_INVALID_MEDIA_TYPE')
1561
+
1562
+ found = await fetch(address, {
1563
+ method: 'POST',
1564
+ url: '/',
1565
+ headers: {
1566
+ 'content-type': 'application/ json'
1567
+ },
1568
+ body: JSON.stringify({ invalid: 'string' })
1569
+ })
1570
+ t.assert.strictEqual(found.status, 415)
1571
+ t.assert.strictEqual((await found.json()).code, 'FST_ERR_CTP_INVALID_MEDIA_TYPE')
1572
+ })