Fix/add missing types fastifycontextconfig (#4850)

fastify · Jun 25, 2023 · 8de9eab · 8de9eab
1 parent c4b8d85
commit 8de9eab
Show file tree

Hide file tree

Showing 3 changed files with 86 additions and 4 deletions.
diff --git a/test/types/route.test-d.ts b/test/types/route.test-d.ts
@@ -74,23 +74,27 @@ type LowerCaseHTTPMethods = 'get' | 'post' | 'put' | 'patch' | 'head' | 'delete'
     Headers: HeadersInterface;
   }
 
-  fastify()[lowerCaseMethod]<RouteGeneric, RouteSpecificContextConfigType>('/', { config: { foo: 'bar', bar: 100, extra: true } }, (req, res) => {
+  fastify()[lowerCaseMethod]<RouteGeneric, RouteSpecificContextConfigType>('/', { config: { foo: 'bar', bar: 100, extra: true, url: '/', method: lowerCaseMethod } }, (req, res) => {
     expectType<BodyInterface>(req.body)
     expectType<QuerystringInterface>(req.query)
     expectType<ParamsInterface>(req.params)
     expectType<http.IncomingHttpHeaders & HeadersInterface>(req.headers)
     expectType<string>(req.context.config.foo)
     expectType<number>(req.context.config.bar)
     expectType<boolean>(req.context.config.extra)
+    expectType<string>(req.context.config.url)
+    expectType<HTTPMethods | HTTPMethods[]>(req.context.config.method)
     expectType<string>(res.context.config.foo)
     expectType<number>(res.context.config.bar)
     expectType<boolean>(res.context.config.extra)
+    expectType<string>(req.routeConfig.url)
+    expectType<HTTPMethods | HTTPMethods[]>(req.routeConfig.method)
   })
 
   fastify().route<RouteGeneric>({
     url: '/',
     method: method as HTTPMethods,
-    config: { foo: 'bar', bar: 100 },
+    config: { foo: 'bar', bar: 100, url: '/', method: method as HTTPMethods },
     prefixTrailingSlash: 'slash',
     onRequest: (req, res, done) => { // these handlers are tested in `hooks.test-d.ts`
       expectType<BodyInterface>(req.body)
@@ -99,8 +103,12 @@ type LowerCaseHTTPMethods = 'get' | 'post' | 'put' | 'patch' | 'head' | 'delete'
       expectType<http.IncomingHttpHeaders & HeadersInterface>(req.headers)
       expectType<string>(req.context.config.foo)
       expectType<number>(req.context.config.bar)
+      expectType<string>(req.context.config.url)
+      expectType<HTTPMethods | HTTPMethods[]>(req.context.config.method)
       expectType<string>(res.context.config.foo)
       expectType<number>(res.context.config.bar)
+      expectType<string>(req.routeConfig.url)
+      expectType<HTTPMethods | HTTPMethods[]>(req.routeConfig.method)
     },
     preParsing: (req, res, payload, done) => {
       expectType<BodyInterface>(req.body)
@@ -109,8 +117,12 @@ type LowerCaseHTTPMethods = 'get' | 'post' | 'put' | 'patch' | 'head' | 'delete'
       expectType<http.IncomingHttpHeaders & HeadersInterface>(req.headers)
       expectType<string>(req.context.config.foo)
       expectType<number>(req.context.config.bar)
+      expectType<string>(req.context.config.url)
+      expectType<HTTPMethods | HTTPMethods[]>(req.context.config.method)
       expectType<string>(res.context.config.foo)
       expectType<number>(res.context.config.bar)
+      expectType<string>(req.routeConfig.url)
+      expectType<HTTPMethods | HTTPMethods[]>(req.routeConfig.method)
       expectType<RequestPayload>(payload)
       expectAssignable<(err?: FastifyError | null, res?: RequestPayload) => void>(done)
       expectAssignable<(err?: NodeJS.ErrnoException) => void>(done)
@@ -122,8 +134,12 @@ type LowerCaseHTTPMethods = 'get' | 'post' | 'put' | 'patch' | 'head' | 'delete'
       expectType<http.IncomingHttpHeaders & HeadersInterface>(req.headers)
       expectType<string>(req.context.config.foo)
       expectType<number>(req.context.config.bar)
+      expectType<string>(req.context.config.url)
+      expectType<HTTPMethods | HTTPMethods[]>(req.context.config.method)
       expectType<string>(res.context.config.foo)
       expectType<number>(res.context.config.bar)
+      expectType<string>(req.routeConfig.url)
+      expectType<HTTPMethods | HTTPMethods[]>(req.routeConfig.method)
     },
     preHandler: (req, res, done) => {
       expectType<BodyInterface>(req.body)
@@ -132,8 +148,12 @@ type LowerCaseHTTPMethods = 'get' | 'post' | 'put' | 'patch' | 'head' | 'delete'
       expectType<http.IncomingHttpHeaders & HeadersInterface>(req.headers)
       expectType<string>(req.context.config.foo)
       expectType<number>(req.context.config.bar)
+      expectType<string>(req.context.config.url)
+      expectType<HTTPMethods | HTTPMethods[]>(req.context.config.method)
       expectType<string>(res.context.config.foo)
       expectType<number>(res.context.config.bar)
+      expectType<string>(req.routeConfig.url)
+      expectType<HTTPMethods | HTTPMethods[]>(req.routeConfig.method)
     },
     onResponse: (req, res, done) => {
       expectType<BodyInterface>(req.body)
@@ -142,8 +162,12 @@ type LowerCaseHTTPMethods = 'get' | 'post' | 'put' | 'patch' | 'head' | 'delete'
       expectType<http.IncomingHttpHeaders & HeadersInterface>(req.headers)
       expectType<string>(req.context.config.foo)
       expectType<number>(req.context.config.bar)
+      expectType<string>(req.context.config.url)
+      expectType<HTTPMethods | HTTPMethods[]>(req.context.config.method)
       expectType<string>(res.context.config.foo)
       expectType<number>(res.context.config.bar)
+      expectType<string>(req.routeConfig.url)
+      expectType<HTTPMethods | HTTPMethods[]>(req.routeConfig.method)
       expectType<number>(res.statusCode)
     },
     onError: (req, res, error, done) => {
@@ -153,8 +177,12 @@ type LowerCaseHTTPMethods = 'get' | 'post' | 'put' | 'patch' | 'head' | 'delete'
       expectType<http.IncomingHttpHeaders & HeadersInterface>(req.headers)
       expectType<string>(req.context.config.foo)
       expectType<number>(req.context.config.bar)
+      expectType<string>(req.context.config.url)
+      expectType<HTTPMethods | HTTPMethods[]>(req.context.config.method)
       expectType<string>(res.context.config.foo)
       expectType<number>(res.context.config.bar)
+      expectType<string>(req.routeConfig.url)
+      expectType<HTTPMethods | HTTPMethods[]>(req.routeConfig.method)
     },
     preSerialization: (req, res, payload, done) => {
       expectType<BodyInterface>(req.body)
@@ -163,8 +191,12 @@ type LowerCaseHTTPMethods = 'get' | 'post' | 'put' | 'patch' | 'head' | 'delete'
       expectType<http.IncomingHttpHeaders & HeadersInterface>(req.headers)
       expectType<string>(req.context.config.foo)
       expectType<number>(req.context.config.bar)
+      expectType<string>(req.context.config.url)
+      expectType<HTTPMethods | HTTPMethods[]>(req.context.config.method)
       expectType<string>(res.context.config.foo)
       expectType<number>(res.context.config.bar)
+      expectType<string>(req.routeConfig.url)
+      expectType<HTTPMethods | HTTPMethods[]>(req.routeConfig.method)
     },
     onSend: (req, res, payload, done) => {
       expectType<BodyInterface>(req.body)
@@ -173,8 +205,12 @@ type LowerCaseHTTPMethods = 'get' | 'post' | 'put' | 'patch' | 'head' | 'delete'
       expectType<http.IncomingHttpHeaders & HeadersInterface>(req.headers)
       expectType<string>(req.context.config.foo)
       expectType<number>(req.context.config.bar)
+      expectType<string>(req.context.config.url)
+      expectType<HTTPMethods | HTTPMethods[]>(req.context.config.method)
       expectType<string>(res.context.config.foo)
       expectType<number>(res.context.config.bar)
+      expectType<string>(req.routeConfig.url)
+      expectType<HTTPMethods | HTTPMethods[]>(req.routeConfig.method)
     },
     handler: (req, res) => {
       expectType<BodyInterface>(req.body)
@@ -183,15 +219,19 @@ type LowerCaseHTTPMethods = 'get' | 'post' | 'put' | 'patch' | 'head' | 'delete'
       expectType<http.IncomingHttpHeaders & HeadersInterface>(req.headers)
       expectType<string>(req.context.config.foo)
       expectType<number>(req.context.config.bar)
+      expectType<string>(req.context.config.url)
+      expectType<HTTPMethods | HTTPMethods[]>(req.context.config.method)
       expectType<string>(res.context.config.foo)
       expectType<number>(res.context.config.bar)
+      expectType<string>(req.routeConfig.url)
+      expectType<HTTPMethods | HTTPMethods[]>(req.routeConfig.method)
     }
   })
 
   fastify().route<RouteGeneric>({
     url: '/',
     method: method as HTTPMethods,
-    config: { foo: 'bar', bar: 100 },
+    config: { foo: 'bar', bar: 100, url: '/', method: method as HTTPMethods },
     prefixTrailingSlash: 'slash',
     onRequest: async (req, res, done) => { // these handlers are tested in `hooks.test-d.ts`
       expectType<BodyInterface>(req.body)
@@ -200,8 +240,12 @@ type LowerCaseHTTPMethods = 'get' | 'post' | 'put' | 'patch' | 'head' | 'delete'
       expectType<http.IncomingHttpHeaders & HeadersInterface>(req.headers)
       expectType<string>(req.context.config.foo)
       expectType<number>(req.context.config.bar)
+      expectType<string>(req.context.config.url)
+      expectType<HTTPMethods | HTTPMethods[]>(req.context.config.method)
       expectType<string>(res.context.config.foo)
       expectType<number>(res.context.config.bar)
+      expectType<string>(req.routeConfig.url)
+      expectType<HTTPMethods | HTTPMethods[]>(req.routeConfig.method)
     },
     preParsing: async (req, res, payload, done) => {
       expectType<BodyInterface>(req.body)
@@ -210,8 +254,12 @@ type LowerCaseHTTPMethods = 'get' | 'post' | 'put' | 'patch' | 'head' | 'delete'
       expectType<http.IncomingHttpHeaders & HeadersInterface>(req.headers)
       expectType<string>(req.context.config.foo)
       expectType<number>(req.context.config.bar)
+      expectType<string>(req.context.config.url)
+      expectType<HTTPMethods | HTTPMethods[]>(req.context.config.method)
       expectType<string>(res.context.config.foo)
       expectType<number>(res.context.config.bar)
+      expectType<string>(req.routeConfig.url)
+      expectType<HTTPMethods | HTTPMethods[]>(req.routeConfig.method)
       expectType<RequestPayload>(payload)
       expectAssignable<(err?: FastifyError | null, res?: RequestPayload) => void>(done)
       expectAssignable<(err?: NodeJS.ErrnoException) => void>(done)
@@ -223,8 +271,12 @@ type LowerCaseHTTPMethods = 'get' | 'post' | 'put' | 'patch' | 'head' | 'delete'
       expectType<http.IncomingHttpHeaders & HeadersInterface>(req.headers)
       expectType<string>(req.context.config.foo)
       expectType<number>(req.context.config.bar)
+      expectType<string>(req.context.config.url)
+      expectType<HTTPMethods | HTTPMethods[]>(req.context.config.method)
       expectType<string>(res.context.config.foo)
       expectType<number>(res.context.config.bar)
+      expectType<string>(req.routeConfig.url)
+      expectType<HTTPMethods | HTTPMethods[]>(req.routeConfig.method)
     },
     preHandler: async (req, res, done) => {
       expectType<BodyInterface>(req.body)
@@ -233,8 +285,12 @@ type LowerCaseHTTPMethods = 'get' | 'post' | 'put' | 'patch' | 'head' | 'delete'
       expectType<http.IncomingHttpHeaders & HeadersInterface>(req.headers)
       expectType<string>(req.context.config.foo)
       expectType<number>(req.context.config.bar)
+      expectType<string>(req.context.config.url)
+      expectType<HTTPMethods | HTTPMethods[]>(req.context.config.method)
       expectType<string>(res.context.config.foo)
       expectType<number>(res.context.config.bar)
+      expectType<string>(req.routeConfig.url)
+      expectType<HTTPMethods | HTTPMethods[]>(req.routeConfig.method)
     },
     onResponse: async (req, res, done) => {
       expectType<BodyInterface>(req.body)
@@ -243,8 +299,12 @@ type LowerCaseHTTPMethods = 'get' | 'post' | 'put' | 'patch' | 'head' | 'delete'
       expectType<http.IncomingHttpHeaders & HeadersInterface>(req.headers)
       expectType<string>(req.context.config.foo)
       expectType<number>(req.context.config.bar)
+      expectType<string>(req.context.config.url)
+      expectType<HTTPMethods | HTTPMethods[]>(req.context.config.method)
       expectType<string>(res.context.config.foo)
       expectType<number>(res.context.config.bar)
+      expectType<string>(req.routeConfig.url)
+      expectType<HTTPMethods | HTTPMethods[]>(req.routeConfig.method)
       expectType<number>(res.statusCode)
     },
     onError: async (req, res, error, done) => {
@@ -254,8 +314,12 @@ type LowerCaseHTTPMethods = 'get' | 'post' | 'put' | 'patch' | 'head' | 'delete'
       expectType<http.IncomingHttpHeaders & HeadersInterface>(req.headers)
       expectType<string>(req.context.config.foo)
       expectType<number>(req.context.config.bar)
+      expectType<string>(req.context.config.url)
+      expectType<HTTPMethods | HTTPMethods[]>(req.context.config.method)
       expectType<string>(res.context.config.foo)
       expectType<number>(res.context.config.bar)
+      expectType<string>(req.routeConfig.url)
+      expectType<HTTPMethods | HTTPMethods[]>(req.routeConfig.method)
     },
     preSerialization: async (req, res, payload, done) => {
       expectType<BodyInterface>(req.body)
@@ -264,8 +328,12 @@ type LowerCaseHTTPMethods = 'get' | 'post' | 'put' | 'patch' | 'head' | 'delete'
       expectType<http.IncomingHttpHeaders & HeadersInterface>(req.headers)
       expectType<string>(req.context.config.foo)
       expectType<number>(req.context.config.bar)
+      expectType<string>(req.context.config.url)
+      expectType<HTTPMethods | HTTPMethods[]>(req.context.config.method)
       expectType<string>(res.context.config.foo)
       expectType<number>(res.context.config.bar)
+      expectType<string>(req.routeConfig.url)
+      expectType<HTTPMethods | HTTPMethods[]>(req.routeConfig.method)
     },
     onSend: async (req, res, payload, done) => {
       expectType<BodyInterface>(req.body)
@@ -274,8 +342,12 @@ type LowerCaseHTTPMethods = 'get' | 'post' | 'put' | 'patch' | 'head' | 'delete'
       expectType<http.IncomingHttpHeaders & HeadersInterface>(req.headers)
       expectType<string>(req.context.config.foo)
       expectType<number>(req.context.config.bar)
+      expectType<string>(req.context.config.url)
+      expectType<HTTPMethods | HTTPMethods[]>(req.context.config.method)
       expectType<string>(res.context.config.foo)
       expectType<number>(res.context.config.bar)
+      expectType<string>(req.routeConfig.url)
+      expectType<HTTPMethods | HTTPMethods[]>(req.routeConfig.method)
     },
     handler: (req, res) => {
       expectType<BodyInterface>(req.body)
@@ -284,8 +356,12 @@ type LowerCaseHTTPMethods = 'get' | 'post' | 'put' | 'patch' | 'head' | 'delete'
       expectType<http.IncomingHttpHeaders & HeadersInterface>(req.headers)
       expectType<string>(req.context.config.foo)
       expectType<number>(req.context.config.bar)
+      expectType<string>(req.context.config.url)
+      expectType<HTTPMethods | HTTPMethods[]>(req.context.config.method)
       expectType<string>(res.context.config.foo)
       expectType<number>(res.context.config.bar)
+      expectType<string>(req.routeConfig.url)
+      expectType<HTTPMethods | HTTPMethods[]>(req.routeConfig.method)
     }
   })
 })

diff --git a/types/context.d.ts b/types/context.d.ts
@@ -1,7 +1,8 @@
 import { ContextConfigDefault } from './utils'
+import { FastifyRouteConfig } from './route'
 
 // eslint-disable-next-line @typescript-eslint/no-empty-interface
-export interface FastifyContextConfig {
+export interface FastifyContextConfig extends FastifyRouteConfig {
 }
 
 /**

diff --git a/types/route.d.ts b/types/route.d.ts
@@ -13,6 +13,11 @@ import {
 } from './type-provider'
 import { FastifyBaseLogger, LogLevel } from './logger'
 
+export interface FastifyRouteConfig {
+  url: string;
+  method: HTTPMethods | HTTPMethods[];
+}
+
 export interface RouteGenericInterface extends RequestGenericInterface, ReplyGenericInterface {}
 
 /**