(v3.x) Allow custom Context Config types for hooks' request propert…

…ies (#3787) * Types hooks requests with custom Context Config * Test custom Context Config types for hooks
fastify · Mar 21, 2022 · f00f2a2 · f00f2a2
1 parent f66d2a8
commit f00f2a2
Show file tree

Hide file tree

Showing 2 changed files with 69 additions and 19 deletions.
diff --git a/test/types/hooks.test-d.ts b/test/types/hooks.test-d.ts
@@ -9,9 +9,11 @@ import fastify, {
   RawServerBase,
   RouteOptions,
   RegisterOptions,
-  FastifyPluginOptions
+  FastifyPluginOptions,
+  FastifyContextConfig
 } from '../../fastify'
 import { preHandlerAsyncHookHandler, RequestPayload } from '../../types/hooks'
+import { RouteGenericInterface } from '../../types/route'
 
 const server = fastify()
 
@@ -226,3 +228,51 @@ Record<string, unknown>
 server.register(async (instance) => {
   instance.addHook('preHandler', customTypedHook)
 })
+
+// Test custom Context Config types for hooks
+type CustomContextConfig = FastifyContextConfig & {
+  foo: string;
+  bar: number;
+}
+
+server.route<RouteGenericInterface, CustomContextConfig>({
+  method: 'GET',
+  url: '/',
+  handler: () => {},
+  onRequest: (request, reply) => {
+    expectType<CustomContextConfig>(request.context.config)
+    expectType<CustomContextConfig>(reply.context.config)
+  },
+  preParsing: (request, reply) => {
+    expectType<CustomContextConfig>(request.context.config)
+    expectType<CustomContextConfig>(reply.context.config)
+  },
+  preValidation: (request, reply) => {
+    expectType<CustomContextConfig>(request.context.config)
+    expectType<CustomContextConfig>(reply.context.config)
+  },
+  preHandler: (request, reply) => {
+    expectType<CustomContextConfig>(request.context.config)
+    expectType<CustomContextConfig>(reply.context.config)
+  },
+  preSerialization: (request, reply) => {
+    expectType<CustomContextConfig>(request.context.config)
+    expectType<CustomContextConfig>(reply.context.config)
+  },
+  onSend: (request, reply) => {
+    expectType<CustomContextConfig>(request.context.config)
+    expectType<CustomContextConfig>(reply.context.config)
+  },
+  onResponse: (request, reply) => {
+    expectType<CustomContextConfig>(request.context.config)
+    expectType<CustomContextConfig>(reply.context.config)
+  },
+  onTimeout: (request, reply) => {
+    expectType<CustomContextConfig>(request.context.config)
+    expectType<CustomContextConfig>(reply.context.config)
+  },
+  onError: (request, reply) => {
+    expectType<CustomContextConfig>(request.context.config)
+    expectType<CustomContextConfig>(reply.context.config)
+  }
+})
diff --git a/types/hooks.d.ts b/types/hooks.d.ts
@@ -30,7 +30,7 @@ export interface onRequestHookHandler<
 > {
   (
     this: FastifyInstance,
-    request: FastifyRequest<RouteGeneric, RawServer, RawRequest>,
+    request: FastifyRequest<RouteGeneric, RawServer, RawRequest, ContextConfig>,
     reply: FastifyReply<RawServer, RawRequest, RawReply, RouteGeneric, ContextConfig>,
     done: HookHandlerDoneFunction
   ): void;
@@ -45,7 +45,7 @@ export interface onRequestAsyncHookHandler<
 > {
   (
     this: FastifyInstance,
-    request: FastifyRequest<RouteGeneric, RawServer, RawRequest>,
+    request: FastifyRequest<RouteGeneric, RawServer, RawRequest, ContextConfig>,
     reply: FastifyReply<RawServer, RawRequest, RawReply, RouteGeneric, ContextConfig>,
   ): Promise<unknown>;
 }
@@ -63,7 +63,7 @@ export interface preParsingHookHandler<
 > {
   (
     this: FastifyInstance,
-    request: FastifyRequest<RouteGeneric, RawServer, RawRequest>,
+    request: FastifyRequest<RouteGeneric, RawServer, RawRequest, ContextConfig>,
     reply: FastifyReply<RawServer, RawRequest, RawReply, RouteGeneric, ContextConfig>,
     payload: RequestPayload,
     done: <TError extends Error = FastifyError>(err?: TError | null, res?: RequestPayload) => void
@@ -79,7 +79,7 @@ export interface preParsingAsyncHookHandler<
 > {
   (
     this: FastifyInstance,
-    request: FastifyRequest<RouteGeneric, RawServer, RawRequest>,
+    request: FastifyRequest<RouteGeneric, RawServer, RawRequest, ContextConfig>,
     reply: FastifyReply<RawServer, RawRequest, RawReply, RouteGeneric, ContextConfig>,
     payload: RequestPayload,
   ): Promise<RequestPayload | unknown>;
@@ -97,7 +97,7 @@ export interface preValidationHookHandler<
 > {
   (
     this: FastifyInstance,
-    request: FastifyRequest<RouteGeneric, RawServer, RawRequest>,
+    request: FastifyRequest<RouteGeneric, RawServer, RawRequest, ContextConfig>,
     reply: FastifyReply<RawServer, RawRequest, RawReply, RouteGeneric, ContextConfig>,
     done: HookHandlerDoneFunction
   ): void;
@@ -112,7 +112,7 @@ export interface preValidationAsyncHookHandler<
 > {
   (
     this: FastifyInstance,
-    request: FastifyRequest<RouteGeneric, RawServer, RawRequest>,
+    request: FastifyRequest<RouteGeneric, RawServer, RawRequest, ContextConfig>,
     reply: FastifyReply<RawServer, RawRequest, RawReply, RouteGeneric, ContextConfig>,
   ): Promise<unknown>;
 }
@@ -129,7 +129,7 @@ export interface preHandlerHookHandler<
 > {
   (
     this: FastifyInstance,
-    request: FastifyRequest<RouteGeneric, RawServer, RawRequest>,
+    request: FastifyRequest<RouteGeneric, RawServer, RawRequest, ContextConfig>,
     reply: FastifyReply<RawServer, RawRequest, RawReply, RouteGeneric, ContextConfig>,
     done: HookHandlerDoneFunction
   ): void;
@@ -144,7 +144,7 @@ export interface preHandlerAsyncHookHandler<
 > {
   (
     this: FastifyInstance,
-    request: FastifyRequest<RouteGeneric, RawServer, RawRequest>,
+    request: FastifyRequest<RouteGeneric, RawServer, RawRequest, ContextConfig>,
     reply: FastifyReply<RawServer, RawRequest, RawReply, RouteGeneric, ContextConfig>,
   ): Promise<unknown>;
 }
@@ -170,7 +170,7 @@ export interface preSerializationHookHandler<
 > {
   (
     this: FastifyInstance,
-    request: FastifyRequest<RouteGeneric, RawServer, RawRequest>,
+    request: FastifyRequest<RouteGeneric, RawServer, RawRequest, ContextConfig>,
     reply: FastifyReply<RawServer, RawRequest, RawReply, RouteGeneric, ContextConfig>,
     payload: PreSerializationPayload,
     done: DoneFuncWithErrOrRes
@@ -187,7 +187,7 @@ export interface preSerializationAsyncHookHandler<
 > {
   (
     this: FastifyInstance,
-    request: FastifyRequest<RouteGeneric, RawServer, RawRequest>,
+    request: FastifyRequest<RouteGeneric, RawServer, RawRequest, ContextConfig>,
     reply: FastifyReply<RawServer, RawRequest, RawReply, RouteGeneric, ContextConfig>,
     payload: PreSerializationPayload
   ): Promise<unknown>;
@@ -207,7 +207,7 @@ export interface onSendHookHandler<
 > {
   (
     this: FastifyInstance,
-    request: FastifyRequest<RouteGeneric, RawServer, RawRequest>,
+    request: FastifyRequest<RouteGeneric, RawServer, RawRequest, ContextConfig>,
     reply: FastifyReply<RawServer, RawRequest, RawReply, RouteGeneric, ContextConfig>,
     payload: OnSendPayload,
     done: DoneFuncWithErrOrRes
@@ -224,7 +224,7 @@ export interface onSendAsyncHookHandler<
 > {
   (
     this: FastifyInstance,
-    request: FastifyRequest<RouteGeneric, RawServer, RawRequest>,
+    request: FastifyRequest<RouteGeneric, RawServer, RawRequest, ContextConfig>,
     reply: FastifyReply<RawServer, RawRequest, RawReply, RouteGeneric, ContextConfig>,
     payload: OnSendPayload,
   ): Promise<unknown>;
@@ -243,7 +243,7 @@ export interface onResponseHookHandler<
 > {
   (
     this: FastifyInstance,
-    request: FastifyRequest<RouteGeneric, RawServer, RawRequest>,
+    request: FastifyRequest<RouteGeneric, RawServer, RawRequest, ContextConfig>,
     reply: FastifyReply<RawServer, RawRequest, RawReply, RouteGeneric, ContextConfig>,
     done: HookHandlerDoneFunction
   ): void;
@@ -258,7 +258,7 @@ export interface onResponseAsyncHookHandler<
 > {
   (
     this: FastifyInstance,
-    request: FastifyRequest<RouteGeneric, RawServer, RawRequest>,
+    request: FastifyRequest<RouteGeneric, RawServer, RawRequest, ContextConfig>,
     reply: FastifyReply<RawServer, RawRequest, RawReply, RouteGeneric, ContextConfig>
   ): Promise<unknown>;
 }
@@ -276,7 +276,7 @@ export interface onTimeoutHookHandler<
 > {
   (
     this: FastifyInstance,
-    request: FastifyRequest<RouteGeneric, RawServer, RawRequest>,
+    request: FastifyRequest<RouteGeneric, RawServer, RawRequest, ContextConfig>,
     reply: FastifyReply<RawServer, RawRequest, RawReply, RouteGeneric, ContextConfig>,
     done: HookHandlerDoneFunction
   ): void;
@@ -291,7 +291,7 @@ export interface onTimeoutAsyncHookHandler<
 > {
   (
     this: FastifyInstance,
-    request: FastifyRequest<RouteGeneric, RawServer, RawRequest>,
+    request: FastifyRequest<RouteGeneric, RawServer, RawRequest, ContextConfig>,
     reply: FastifyReply<RawServer, RawRequest, RawReply, RouteGeneric, ContextConfig>
   ): Promise<unknown>;
 }
@@ -312,7 +312,7 @@ export interface onErrorHookHandler<
 > {
   (
     this: FastifyInstance,
-    request: FastifyRequest<RouteGeneric, RawServer, RawRequest>,
+    request: FastifyRequest<RouteGeneric, RawServer, RawRequest, ContextConfig>,
     reply: FastifyReply<RawServer, RawRequest, RawReply, RouteGeneric, ContextConfig>,
     error: TError,
     done: () => void
@@ -329,7 +329,7 @@ export interface onErrorAsyncHookHandler<
 > {
   (
     this: FastifyInstance,
-    request: FastifyRequest<RouteGeneric, RawServer, RawRequest>,
+    request: FastifyRequest<RouteGeneric, RawServer, RawRequest, ContextConfig>,
     reply: FastifyReply<RawServer, RawRequest, RawReply, RouteGeneric, ContextConfig>,
     error: TError
   ): Promise<unknown>;