Support RouteShorthandOptions to receive async hooks

[MatanYadaev]

Prerequisites

• I have written a descriptive issue title
• I have searched existing issues to ensure the issue has not already been raised

Issue

Currently, RouteShorthandOptions type doesn't allow passing async hooks:

export interface RouteShorthandOptions<
  // ...
> {
  // ...
  onRequest?: onRequestHookHandler<RawServer, RawRequest, RawReply, RouteGeneric, ContextConfig, SchemaCompiler, TypeProvider, Logger>
  | onRequestHookHandler<RawServer, RawRequest, RawReply, RouteGeneric, ContextConfig, SchemaCompiler, TypeProvider, Logger>[];

It should be something like that:

export interface RouteShorthandOptions<
  // ...
> {
  // ...
  onRequest?: onRequestHookHandler<RawServer, RawRequest, RawReply, RouteGeneric, ContextConfig, SchemaCompiler, TypeProvider, Logger>
  | onRequestHookHandler<RawServer, RawRequest, RawReply, RouteGeneric, ContextConfig, SchemaCompiler, TypeProvider, Logger>[]
  // Add these two:
  | onRequestAsyncHookHandler<RawServer, RawRequest, RawReply, RouteGeneric, ContextConfig, SchemaCompiler, TypeProvider, Logger>
  | onRequestAsyncHookHandler<RawServer, RawRequest, RawReply, RouteGeneric, ContextConfig, SchemaCompiler, TypeProvider, Logger>[];

[mcollina]

Thanks for reporting! Would you like to send a Pull Request to address this issue? Remember to add unit tests.

[climba03003]

For anyone who would like to works on this issue.
Please also check #4705

[gimnathperera]

Hi @mcollina assign this to me

[BrendenInhelder]

I would like to work on solving this issue with a solution different from #4655 and #4862 to avoid regression.

[Uzlopak]

Please provide a PR. Reassigning this to you.

[Uzlopak]

Here is a TS Playground mvce

https://www.typescriptlang.org/play?#code/JYOwLgpgTgZghgYwgAgMJwDYYEaINbIDeAsAFDIXIAUADnFALYCMAXMgM5hSgDmANMgAmAexAQ2VaFAD8bAKJQowqAEpkAXgB8yAG7DgglWz0GyAXzJlQkWIhQBBdgE8QCImUrU6jVhy68jZAAFJQZgdggAHhNBTXNLUmtoeCRkAHkaMGBRdndySgALYWE8djZ0LFwEAgAfZEcXBHjSMgQcsGQ4NgysnI08zyKSss7nV2QYAFdXXpAvemY1EnyKC1IzZCA

[Uzlopak]

I asked @webstrand on discord if he could help us.

[Uzlopak]

Maybe somebody can open a question on stackoverflow? Usually @jcalz also answers there really fast.

[BrendenInhelder]

Hopefully, this is not repetitive but I wanted to note something (feel free to delete/hide if not beneficial to issue efforts).
With the (reverted) change from #4655 in route.d.ts:

  onRequest?: onRequestHookHandler<RawServer, RawRequest, RawReply, RouteGeneric, ContextConfig, SchemaCompiler, TypeProvider, Logger>
  | onRequestHookHandler<RawServer, RawRequest, RawReply, RouteGeneric, ContextConfig, SchemaCompiler, TypeProvider, Logger>[]
  | onRequestAsyncHookHandler<RawServer, RawRequest, RawReply, RouteGeneric, ContextConfig, SchemaCompiler, TypeProvider, Logger>
  | onRequestAsyncHookHandler<RawServer, RawRequest, RawReply, RouteGeneric, ContextConfig, SchemaCompiler, TypeProvider, Logger>[];

Even if we specify the return as a Promise<void> in associated test in hooks.test-d.ts we still have any types. request and reply are any (not recognized):

server.get<RouteGenericInterface, CustomContextConfig>('/', {
  onRequest: async (request, reply):Promise<void> => {
    expectType<CustomContextConfigWithDefault>(request.context.config)
    expectType<CustomContextConfigWithDefault>(reply.context.config)
  },

And likewise, providing an additional argument will resolve the issue (not really because it is meant to be async) because it recognizes the three args as one that includes a hookHandlerDoneFunction parameter no matter what that parameter actually is.

Maybe this is indicative of a complicated issue; I am not an expert on typescript.