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,277 @@
1
+ import * as fs from 'node:fs'
2
+ import { IncomingMessage, Server, ServerResponse } from 'node:http'
3
+ import P from 'pino'
4
+ import { expectAssignable, expectDeprecated, expectError, expectNotAssignable, expectType } from 'tsd'
5
+ import fastify, {
6
+ FastifyBaseLogger,
7
+ FastifyLogFn,
8
+ FastifyReply,
9
+ FastifyRequest,
10
+ LogLevel
11
+ } from '../../fastify'
12
+ import { FastifyLoggerInstance, ResSerializerReply } from '../../types/logger'
13
+
14
+ expectType<FastifyBaseLogger>(fastify().log)
15
+
16
+ class Foo { }
17
+
18
+ ['trace', 'debug', 'info', 'warn', 'error', 'fatal'].forEach(logLevel => {
19
+ expectType<FastifyLogFn>(
20
+ fastify<Server, IncomingMessage, ServerResponse, FastifyBaseLogger>().log[logLevel as LogLevel]
21
+ )
22
+ expectType<void>(
23
+ fastify<Server, IncomingMessage, ServerResponse, FastifyBaseLogger>().log[logLevel as LogLevel]('')
24
+ )
25
+ expectType<void>(
26
+ fastify<Server, IncomingMessage, ServerResponse, FastifyBaseLogger>().log[logLevel as LogLevel]({})
27
+ )
28
+ expectType<void>(
29
+ fastify<Server, IncomingMessage, ServerResponse, FastifyBaseLogger>().log[logLevel as LogLevel]({ foo: 'bar' })
30
+ )
31
+ expectType<void>(
32
+ fastify<Server, IncomingMessage, ServerResponse, FastifyBaseLogger>().log[logLevel as LogLevel](new Error())
33
+ )
34
+ expectType<void>(
35
+ fastify<Server, IncomingMessage, ServerResponse, FastifyBaseLogger>().log[logLevel as LogLevel](new Foo())
36
+ )
37
+ })
38
+
39
+ interface CustomLogger extends FastifyBaseLogger {
40
+ customMethod(msg: string, ...args: unknown[]): void;
41
+ }
42
+
43
+ class CustomLoggerImpl implements CustomLogger {
44
+ level = 'info'
45
+ customMethod (msg: string, ...args: unknown[]) { console.log(msg, args) }
46
+
47
+ // Implementation signature must be compatible with all overloads of FastifyLogFn
48
+ info (arg1: unknown, arg2?: unknown, ...args: unknown[]): void {
49
+ console.log(arg1, arg2, ...args)
50
+ }
51
+
52
+ warn (...args: unknown[]) { console.log(args) }
53
+ error (...args: unknown[]) { console.log(args) }
54
+ fatal (...args: unknown[]) { console.log(args) }
55
+ trace (...args: unknown[]) { console.log(args) }
56
+ debug (...args: unknown[]) { console.log(args) }
57
+ silent (...args: unknown[]) { }
58
+
59
+ child (bindings: P.Bindings, options?: P.ChildLoggerOptions): CustomLoggerImpl { return new CustomLoggerImpl() }
60
+ }
61
+
62
+ const customLogger = new CustomLoggerImpl()
63
+
64
+ const serverWithCustomLogger = fastify<
65
+ Server,
66
+ IncomingMessage,
67
+ ServerResponse,
68
+ CustomLoggerImpl
69
+ >({ logger: customLogger })
70
+
71
+ expectType<CustomLoggerImpl>(serverWithCustomLogger.log)
72
+
73
+ const serverWithPino = fastify<
74
+ Server,
75
+ IncomingMessage,
76
+ ServerResponse,
77
+ P.Logger
78
+ >({
79
+ logger: P({
80
+ level: 'info',
81
+ redact: ['x-userinfo']
82
+ })
83
+ })
84
+
85
+ expectType<P.Logger>(serverWithPino.log)
86
+
87
+ serverWithPino.route({
88
+ method: 'GET',
89
+ url: '/',
90
+ handler (request) {
91
+ expectType<P.Logger>(this.log)
92
+ expectType<P.Logger>(request.log)
93
+ }
94
+ })
95
+
96
+ serverWithPino.get('/', function (request) {
97
+ expectType<P.Logger>(this.log)
98
+ expectType<P.Logger>(request.log)
99
+ })
100
+
101
+ const serverWithLogOptions = fastify<
102
+ Server,
103
+ IncomingMessage,
104
+ ServerResponse
105
+ >({
106
+ logger: {
107
+ level: 'info'
108
+ }
109
+ })
110
+
111
+ expectType<FastifyBaseLogger>(serverWithLogOptions.log)
112
+
113
+ const serverWithFileOption = fastify<
114
+ Server,
115
+ IncomingMessage,
116
+ ServerResponse
117
+ >({
118
+ logger: {
119
+ level: 'info',
120
+ file: '/path/to/file'
121
+ }
122
+ })
123
+
124
+ expectType<FastifyBaseLogger>(serverWithFileOption.log)
125
+
126
+ const serverAutoInferringTypes = fastify({
127
+ logger: {
128
+ level: 'info'
129
+ }
130
+ })
131
+
132
+ expectType<FastifyBaseLogger>(serverAutoInferringTypes.log)
133
+
134
+ const serverWithLoggerInstance = fastify({
135
+ loggerInstance: P({
136
+ level: 'info',
137
+ redact: ['x-userinfo']
138
+ })
139
+ })
140
+
141
+ expectType<P.Logger>(serverWithLoggerInstance.log)
142
+
143
+ const serverWithPinoConfig = fastify({
144
+ logger: {
145
+ level: 'info',
146
+ serializers: {
147
+ req (IncomingMessage) {
148
+ expectType<FastifyRequest>(IncomingMessage)
149
+ return {
150
+ method: 'method',
151
+ url: 'url',
152
+ version: 'version',
153
+ host: 'fastify.test',
154
+ remoteAddress: 'remoteAddress',
155
+ remotePort: 80,
156
+ other: ''
157
+ }
158
+ },
159
+ res (ServerResponse) {
160
+ expectType<ResSerializerReply<Server, FastifyReply>>(ServerResponse)
161
+ expectAssignable<Partial<FastifyReply> & Pick<FastifyReply, 'statusCode'>>(ServerResponse)
162
+ expectNotAssignable<FastifyReply>(ServerResponse)
163
+ return {
164
+ statusCode: 'statusCode'
165
+ }
166
+ },
167
+ err (FastifyError) {
168
+ return {
169
+ other: '',
170
+ type: 'type',
171
+ message: 'msg',
172
+ stack: 'stack'
173
+ }
174
+ }
175
+ }
176
+ }
177
+ })
178
+
179
+ expectType<FastifyBaseLogger>(serverWithPinoConfig.log)
180
+
181
+ const serverAutoInferredFileOption = fastify({
182
+ logger: {
183
+ level: 'info',
184
+ file: '/path/to/file'
185
+ }
186
+ })
187
+
188
+ expectType<FastifyBaseLogger>(serverAutoInferredFileOption.log)
189
+
190
+ const serverAutoInferredSerializerResponseObjectOption = fastify({
191
+ logger: {
192
+ serializers: {
193
+ res (ServerResponse) {
194
+ expectType<ResSerializerReply<Server, FastifyReply>>(ServerResponse)
195
+ expectAssignable<Partial<FastifyReply> & Pick<FastifyReply, 'statusCode'>>(ServerResponse)
196
+ expectNotAssignable<FastifyReply>(ServerResponse)
197
+ return {
198
+ status: '200'
199
+ }
200
+ }
201
+ }
202
+ }
203
+ })
204
+
205
+ expectType<FastifyBaseLogger>(serverAutoInferredSerializerResponseObjectOption.log)
206
+
207
+ const serverAutoInferredSerializerObjectOption = fastify({
208
+ logger: {
209
+ serializers: {
210
+ req (IncomingMessage) {
211
+ expectType<FastifyRequest>(IncomingMessage)
212
+ return {
213
+ method: 'method',
214
+ url: 'url',
215
+ version: 'version',
216
+ host: 'fastify.test',
217
+ remoteAddress: 'remoteAddress',
218
+ remotePort: 80,
219
+ other: ''
220
+ }
221
+ },
222
+ res (ServerResponse) {
223
+ expectType<ResSerializerReply<Server, FastifyReply>>(ServerResponse)
224
+ expectAssignable<Partial<FastifyReply> & Pick<FastifyReply, 'statusCode'>>(ServerResponse)
225
+ expectNotAssignable<FastifyReply>(ServerResponse)
226
+ return {
227
+ statusCode: 'statusCode'
228
+ }
229
+ },
230
+ err (FastifyError) {
231
+ return {
232
+ other: '',
233
+ type: 'type',
234
+ message: 'msg',
235
+ stack: 'stack'
236
+ }
237
+ }
238
+ }
239
+ }
240
+ })
241
+
242
+ expectType<FastifyBaseLogger>(serverAutoInferredSerializerObjectOption.log)
243
+
244
+ const passStreamAsOption = fastify({
245
+ logger: {
246
+ stream: fs.createWriteStream('/tmp/stream.out')
247
+ }
248
+ })
249
+
250
+ expectType<FastifyBaseLogger>(passStreamAsOption.log)
251
+
252
+ const passPinoOption = fastify({
253
+ logger: {
254
+ redact: ['custom'],
255
+ messageKey: 'msg',
256
+ nestedKey: 'nested',
257
+ enabled: true
258
+ }
259
+ })
260
+
261
+ expectType<FastifyBaseLogger>(passPinoOption.log)
262
+
263
+ // FastifyLoggerInstance is deprecated
264
+ expectDeprecated({} as FastifyLoggerInstance)
265
+
266
+ const childParent = fastify().log
267
+ // we test different option variant here
268
+ expectType<FastifyBaseLogger>(childParent.child({}, { level: 'info' }))
269
+ expectType<FastifyBaseLogger>(childParent.child({}, { level: 'silent' }))
270
+ expectType<FastifyBaseLogger>(childParent.child({}, { redact: ['pass', 'pin'] }))
271
+ expectType<FastifyBaseLogger>(childParent.child({}, { serializers: { key: () => { } } }))
272
+ expectType<FastifyBaseLogger>(childParent.child({}, { level: 'info', redact: ['pass', 'pin'], serializers: { key: () => { } } }))
273
+
274
+ // no option pass
275
+ expectError(childParent.child())
276
+ // wrong option
277
+ expectError(childParent.child({}, { nonExist: true }))
@@ -0,0 +1,97 @@
1
+ import fastify, { FastifyInstance, FastifyPluginOptions, SafePromiseLike } from '../../fastify'
2
+ import * as http from 'node:http'
3
+ import * as https from 'node:https'
4
+ import { expectType, expectError, expectAssignable } from 'tsd'
5
+ import { FastifyPluginCallback, FastifyPluginAsync } from '../../types/plugin'
6
+ import { FastifyError } from '@fastify/error'
7
+
8
+ // FastifyPlugin & FastifyRegister
9
+ interface TestOptions extends FastifyPluginOptions {
10
+ option1: string;
11
+ option2: boolean;
12
+ }
13
+ const testOptions: TestOptions = {
14
+ option1: 'a',
15
+ option2: false
16
+ }
17
+ const testPluginOpts: FastifyPluginCallback<TestOptions> = function (instance, opts, done) {
18
+ expectType<TestOptions>(opts)
19
+ }
20
+ const testPluginOptsAsync: FastifyPluginAsync<TestOptions> = async function (instance, opts) {
21
+ expectType<TestOptions>(opts)
22
+ }
23
+
24
+ const testPluginOptsWithType = (
25
+ instance: FastifyInstance,
26
+ opts: FastifyPluginOptions,
27
+ done: (error?: FastifyError) => void
28
+ ) => { }
29
+ const testPluginOptsWithTypeAsync = async (
30
+ instance: FastifyInstance,
31
+ opts: FastifyPluginOptions
32
+ ) => { }
33
+
34
+ expectError(fastify().register(testPluginOpts, {})) // error because missing required options from generic declaration
35
+ expectError(fastify().register(testPluginOptsAsync, {})) // error because missing required options from generic declaration
36
+
37
+ expectAssignable<FastifyInstance>(fastify().register(testPluginOpts, { option1: '', option2: true }))
38
+ expectAssignable<FastifyInstance>(fastify().register(testPluginOptsAsync, { option1: '', option2: true }))
39
+
40
+ expectAssignable<FastifyInstance>(fastify().register(function (instance, opts, done) { }))
41
+ expectAssignable<FastifyInstance>(fastify().register(function (instance, opts, done) { }, () => { }))
42
+ expectAssignable<FastifyInstance>(fastify().register(function (instance, opts, done) { }, { logLevel: 'info', prefix: 'foobar' }))
43
+
44
+ expectAssignable<FastifyInstance>(fastify().register(import('./dummy-plugin')))
45
+ expectAssignable<FastifyInstance>(fastify().register(import('./dummy-plugin'), { foo: 1 }))
46
+
47
+ const testPluginCallback: FastifyPluginCallback = function (instance, opts, done) { }
48
+ expectAssignable<FastifyInstance>(fastify().register(testPluginCallback, {}))
49
+
50
+ const testPluginAsync: FastifyPluginAsync = async function (instance, opts) { }
51
+ expectAssignable<FastifyInstance>(fastify().register(testPluginAsync, {}))
52
+
53
+ expectAssignable<FastifyInstance>(
54
+ fastify().register(function (instance, opts): Promise<void> { return Promise.resolve() })
55
+ )
56
+ expectAssignable<FastifyInstance>(fastify().register(async function (instance, opts) { }, () => { }))
57
+ expectAssignable<FastifyInstance>(fastify().register(async function (instance, opts) { }, { logLevel: 'info', prefix: 'foobar' }))
58
+
59
+ expectError(fastify().register(function (instance, opts, done) { }, { ...testOptions, logLevel: '' })) // must use a valid logLevel
60
+
61
+ const httpsServer = fastify({ https: {} })
62
+ expectError<
63
+ FastifyInstance<https.Server, http.IncomingMessage, http.ServerResponse> &
64
+ Promise<FastifyInstance<https.Server, http.IncomingMessage, http.ServerResponse>>
65
+ >(httpsServer)
66
+ expectAssignable<
67
+ FastifyInstance<https.Server, http.IncomingMessage, http.ServerResponse> &
68
+ PromiseLike<FastifyInstance<https.Server, http.IncomingMessage, http.ServerResponse>>
69
+ >(httpsServer)
70
+ expectType<
71
+ FastifyInstance<https.Server, http.IncomingMessage, http.ServerResponse> &
72
+ SafePromiseLike<FastifyInstance<https.Server, http.IncomingMessage, http.ServerResponse>>
73
+ >(httpsServer)
74
+
75
+ // Chainable
76
+ httpsServer
77
+ .register(testPluginOpts, testOptions)
78
+ .after((_error) => { })
79
+ .ready((_error) => { })
80
+ .close(() => { })
81
+
82
+ // Thenable
83
+ expectAssignable<PromiseLike<undefined>>(httpsServer.after())
84
+ expectAssignable<PromiseLike<undefined>>(httpsServer.close())
85
+ expectAssignable<PromiseLike<undefined>>(httpsServer.ready())
86
+ expectAssignable<PromiseLike<undefined>>(httpsServer.register(testPluginOpts, testOptions))
87
+ expectAssignable<PromiseLike<undefined>>(httpsServer.register(testPluginOptsWithType))
88
+ expectAssignable<PromiseLike<undefined>>(httpsServer.register(testPluginOptsWithTypeAsync))
89
+ expectAssignable<PromiseLike<undefined>>(httpsServer.register(testPluginOptsWithType, { prefix: '/test' }))
90
+ expectAssignable<PromiseLike<undefined>>(httpsServer.register(testPluginOptsWithTypeAsync, { prefix: '/test' }))
91
+
92
+ /* eslint-disable @typescript-eslint/no-unused-vars */
93
+ async function testAsync (): Promise<void> {
94
+ await httpsServer
95
+ .register(testPluginOpts, testOptions)
96
+ .register(testPluginOpts, testOptions)
97
+ }
@@ -0,0 +1,237 @@
1
+ import { expectAssignable, expectError, expectType } from 'tsd'
2
+ import { IncomingMessage, Server, ServerResponse } from 'node:http'
3
+ import { Http2Server, Http2ServerRequest, Http2ServerResponse } from 'node:http2'
4
+ import fastify, { FastifyInstance, FastifyError, FastifyBaseLogger, FastifyPluginAsync, FastifyPluginCallback, FastifyPluginOptions, RawServerDefault } from '../../fastify'
5
+
6
+ const testPluginCallback: FastifyPluginCallback = function (instance, opts, done) { }
7
+ const testPluginAsync: FastifyPluginAsync = async function (instance, opts) { }
8
+
9
+ const testPluginOpts: FastifyPluginCallback = function (instance, opts, done) { }
10
+ const testPluginOptsAsync: FastifyPluginAsync = async function (instance, opts) { }
11
+
12
+ const testPluginOptsWithType = (
13
+ instance: FastifyInstance,
14
+ opts: FastifyPluginOptions,
15
+ done: (error?: FastifyError) => void
16
+ ) => { }
17
+ const testPluginOptsWithTypeAsync = async (instance: FastifyInstance, opts: FastifyPluginOptions) => { }
18
+
19
+ interface TestOptions extends FastifyPluginOptions {
20
+ option1: string;
21
+ option2: boolean;
22
+ }
23
+
24
+ // Type validation
25
+ expectError(fastify().register(testPluginOptsAsync, { prefix: 1 }))
26
+ expectError(fastify().register(testPluginOptsAsync, { logLevel: () => ({}) }))
27
+ expectError(fastify().register(testPluginOptsAsync, { logSerializers: () => ({}) }))
28
+ expectError(fastify().register({}))
29
+
30
+ expectAssignable<FastifyInstance>(
31
+ fastify().register(
32
+ testPluginOptsAsync, { prefix: '/example', logLevel: 'info', logSerializers: { key: (value: any) => `${value}` } }
33
+ )
34
+ )
35
+
36
+ expectAssignable<FastifyInstance>(
37
+ fastify().register(testPluginOptsAsync, () => {
38
+ return {}
39
+ })
40
+ )
41
+
42
+ expectAssignable<FastifyInstance>(
43
+ fastify().register(testPluginOptsAsync, (instance) => {
44
+ expectType<FastifyInstance>(instance)
45
+ })
46
+ )
47
+
48
+ // With Http2
49
+ const serverWithHttp2 = fastify({ http2: true })
50
+ type ServerWithHttp2 = FastifyInstance<Http2Server, Http2ServerRequest, Http2ServerResponse>
51
+ const testPluginWithHttp2: FastifyPluginCallback<TestOptions, Http2Server> = function (instance, opts, done) { }
52
+ const testPluginWithHttp2Async: FastifyPluginAsync<TestOptions, Http2Server> = async function (instance, opts) { }
53
+ const testPluginWithHttp2WithType = (
54
+ instance: ServerWithHttp2,
55
+ opts: FastifyPluginOptions,
56
+ done: (error?: FastifyError) => void
57
+ ) => { }
58
+ const testPluginWithHttp2WithTypeAsync = async (
59
+ instance: ServerWithHttp2,
60
+ opts: FastifyPluginOptions
61
+ ) => { }
62
+ const testOptions: TestOptions = {
63
+ option1: 'a',
64
+ option2: false
65
+ }
66
+ expectAssignable<ServerWithHttp2>(serverWithHttp2.register(testPluginCallback))
67
+ expectAssignable<ServerWithHttp2>(serverWithHttp2.register(testPluginAsync))
68
+ expectAssignable<ServerWithHttp2>(serverWithHttp2.register(testPluginOpts))
69
+ expectAssignable<ServerWithHttp2>(serverWithHttp2.register(testPluginOptsAsync))
70
+ expectAssignable<ServerWithHttp2>(serverWithHttp2.register(testPluginOptsWithType))
71
+ expectAssignable<ServerWithHttp2>(serverWithHttp2.register(testPluginOptsWithTypeAsync))
72
+ // @ts-expect-error
73
+ serverWithHttp2.register(testPluginWithHttp2)
74
+ expectAssignable<ServerWithHttp2>(serverWithHttp2.register(testPluginWithHttp2, testOptions))
75
+ // @ts-expect-error
76
+ serverWithHttp2.register(testPluginWithHttp2Async)
77
+ expectAssignable<ServerWithHttp2>(serverWithHttp2.register(testPluginWithHttp2Async, testOptions))
78
+ expectAssignable<ServerWithHttp2>(serverWithHttp2.register(testPluginWithHttp2WithType))
79
+ expectAssignable<ServerWithHttp2>(serverWithHttp2.register(testPluginWithHttp2WithTypeAsync))
80
+ expectAssignable<ServerWithHttp2>(serverWithHttp2.register((instance) => {
81
+ expectAssignable<FastifyInstance>(instance)
82
+ }))
83
+ expectAssignable<ServerWithHttp2>(serverWithHttp2.register((instance: ServerWithHttp2) => {
84
+ expectAssignable<ServerWithHttp2>(instance)
85
+ }))
86
+ expectAssignable<ServerWithHttp2>(serverWithHttp2.register(async (instance) => {
87
+ expectAssignable<FastifyInstance>(instance)
88
+ }))
89
+ expectAssignable<ServerWithHttp2>(serverWithHttp2.register(async (instance: ServerWithHttp2) => {
90
+ expectAssignable<ServerWithHttp2>(instance)
91
+ }))
92
+
93
+ // With Type Provider
94
+ type TestTypeProvider = { schema: 'test', validator: 'test', serializer: 'test' }
95
+ const serverWithTypeProvider = fastify().withTypeProvider<TestTypeProvider>()
96
+ type ServerWithTypeProvider = FastifyInstance<
97
+ Server,
98
+ IncomingMessage,
99
+ ServerResponse,
100
+ FastifyBaseLogger,
101
+ TestTypeProvider
102
+ >
103
+ const testPluginWithTypeProvider: FastifyPluginCallback<
104
+ TestOptions,
105
+ RawServerDefault,
106
+ TestTypeProvider
107
+ > = function (instance, opts, done) { }
108
+ const testPluginWithTypeProviderAsync: FastifyPluginAsync<
109
+ TestOptions,
110
+ RawServerDefault,
111
+ TestTypeProvider
112
+ > = async function (instance, opts) { }
113
+ const testPluginWithTypeProviderWithType = (
114
+ instance: ServerWithTypeProvider,
115
+ opts: FastifyPluginOptions,
116
+ done: (error?: FastifyError) => void
117
+ ) => { }
118
+ const testPluginWithTypeProviderWithTypeAsync = async (
119
+ instance: ServerWithTypeProvider,
120
+ opts: FastifyPluginOptions
121
+ ) => { }
122
+ expectAssignable<ServerWithTypeProvider>(serverWithTypeProvider.register(testPluginCallback))
123
+ expectAssignable<ServerWithTypeProvider>(serverWithTypeProvider.register(testPluginAsync))
124
+ expectAssignable<ServerWithTypeProvider>(serverWithTypeProvider.register(testPluginOpts))
125
+ expectAssignable<ServerWithTypeProvider>(serverWithTypeProvider.register(testPluginOptsAsync))
126
+ expectAssignable<ServerWithTypeProvider>(serverWithTypeProvider.register(testPluginOptsWithType))
127
+ expectAssignable<ServerWithTypeProvider>(serverWithTypeProvider.register(testPluginOptsWithTypeAsync))
128
+ // @ts-expect-error
129
+ serverWithTypeProvider.register(testPluginWithTypeProvider)
130
+ expectAssignable<ServerWithTypeProvider>(serverWithTypeProvider.register(testPluginWithTypeProvider, testOptions))
131
+ // @ts-expect-error
132
+ serverWithTypeProvider.register(testPluginWithTypeProviderAsync)
133
+ expectAssignable<ServerWithTypeProvider>(serverWithTypeProvider.register(testPluginWithTypeProviderAsync, testOptions))
134
+ expectAssignable<ServerWithTypeProvider>(serverWithTypeProvider.register(testPluginWithTypeProviderWithType))
135
+ expectAssignable<ServerWithTypeProvider>(serverWithTypeProvider.register(testPluginWithTypeProviderWithTypeAsync))
136
+ expectAssignable<ServerWithTypeProvider>(serverWithTypeProvider.register((instance) => {
137
+ expectAssignable<FastifyInstance>(instance)
138
+ }))
139
+ expectAssignable<ServerWithTypeProvider>(serverWithTypeProvider.register((instance: ServerWithTypeProvider) => {
140
+ expectAssignable<ServerWithTypeProvider>(instance)
141
+ }))
142
+ expectAssignable<ServerWithTypeProvider>(serverWithTypeProvider.register(async (instance) => {
143
+ expectAssignable<FastifyInstance>(instance)
144
+ }))
145
+ expectAssignable<ServerWithTypeProvider>(serverWithTypeProvider.register(async (instance: ServerWithTypeProvider) => {
146
+ expectAssignable<ServerWithTypeProvider>(instance)
147
+ }))
148
+
149
+ // With Type Provider and logger
150
+ const customLogger = {
151
+ level: 'info',
152
+ info: () => { },
153
+ warn: () => { },
154
+ error: () => { },
155
+ fatal: () => { },
156
+ trace: () => { },
157
+ debug: () => { },
158
+ child: () => customLogger,
159
+ silent: () => { }
160
+ }
161
+ const serverWithTypeProviderAndLogger = fastify({
162
+ loggerInstance: customLogger
163
+ }).withTypeProvider<TestTypeProvider>()
164
+ type ServerWithTypeProviderAndLogger = FastifyInstance<
165
+ Server,
166
+ IncomingMessage,
167
+ ServerResponse,
168
+ typeof customLogger,
169
+ TestTypeProvider
170
+ >
171
+ const testPluginWithTypeProviderAndLogger: FastifyPluginCallback<
172
+ TestOptions,
173
+ RawServerDefault,
174
+ TestTypeProvider,
175
+ typeof customLogger
176
+ > = function (instance, opts, done) { }
177
+ const testPluginWithTypeProviderAndLoggerAsync: FastifyPluginAsync<
178
+ TestOptions,
179
+ RawServerDefault,
180
+ TestTypeProvider,
181
+ typeof customLogger
182
+ > = async function (instance, opts) { }
183
+ const testPluginWithTypeProviderAndLoggerWithType = (
184
+ instance: ServerWithTypeProviderAndLogger,
185
+ opts: FastifyPluginOptions,
186
+ done: (error?: FastifyError) => void
187
+ ) => { }
188
+ const testPluginWithTypeProviderAndLoggerWithTypeAsync = async (
189
+ instance: ServerWithTypeProviderAndLogger,
190
+ opts: FastifyPluginOptions
191
+ ) => { }
192
+ expectAssignable<ServerWithTypeProviderAndLogger>(serverWithTypeProviderAndLogger.register(testPluginCallback))
193
+ expectAssignable<ServerWithTypeProviderAndLogger>(serverWithTypeProviderAndLogger.register(testPluginAsync))
194
+ expectAssignable<ServerWithTypeProviderAndLogger>(serverWithTypeProviderAndLogger.register(testPluginOpts))
195
+ expectAssignable<ServerWithTypeProviderAndLogger>(serverWithTypeProviderAndLogger.register(testPluginOptsAsync))
196
+ expectAssignable<ServerWithTypeProviderAndLogger>(serverWithTypeProviderAndLogger.register(testPluginOptsWithType))
197
+ expectAssignable<ServerWithTypeProviderAndLogger>(serverWithTypeProviderAndLogger.register(testPluginOptsWithTypeAsync))
198
+ expectAssignable<ServerWithTypeProviderAndLogger>(
199
+ // @ts-expect-error
200
+ serverWithTypeProviderAndLogger.register(testPluginWithTypeProviderAndLogger)
201
+ )
202
+ expectAssignable<ServerWithTypeProviderAndLogger>(
203
+ serverWithTypeProviderAndLogger.register(testPluginWithTypeProviderAndLogger, testOptions)
204
+ )
205
+ expectAssignable<ServerWithTypeProviderAndLogger>(
206
+ // @ts-expect-error
207
+ serverWithTypeProviderAndLogger.register(testPluginWithTypeProviderAndLoggerAsync)
208
+ )
209
+ expectAssignable<ServerWithTypeProviderAndLogger>(
210
+ serverWithTypeProviderAndLogger.register(testPluginWithTypeProviderAndLoggerAsync, testOptions)
211
+ )
212
+ expectAssignable<ServerWithTypeProviderAndLogger>(
213
+ serverWithTypeProviderAndLogger.register(testPluginWithTypeProviderAndLoggerWithType)
214
+ )
215
+ expectAssignable<ServerWithTypeProviderAndLogger>(
216
+ serverWithTypeProviderAndLogger.register(testPluginWithTypeProviderAndLoggerWithTypeAsync)
217
+ )
218
+ expectAssignable<ServerWithTypeProviderAndLogger>(
219
+ serverWithTypeProviderAndLogger.register((instance) => {
220
+ expectAssignable<FastifyInstance>(instance)
221
+ })
222
+ )
223
+ expectAssignable<ServerWithTypeProviderAndLogger>(
224
+ serverWithTypeProviderAndLogger.register((instance: ServerWithTypeProviderAndLogger) => {
225
+ expectAssignable<ServerWithTypeProviderAndLogger>(instance)
226
+ })
227
+ )
228
+ expectAssignable<ServerWithTypeProviderAndLogger>(
229
+ serverWithTypeProviderAndLogger.register(async (instance) => {
230
+ expectAssignable<FastifyInstance>(instance)
231
+ })
232
+ )
233
+ expectAssignable<ServerWithTypeProviderAndLogger>(
234
+ serverWithTypeProviderAndLogger.register(async (instance: ServerWithTypeProviderAndLogger) => {
235
+ expectAssignable<ServerWithTypeProviderAndLogger>(instance)
236
+ })
237
+ )