types: extended FastifyAuthFunction type to accept async functions

[ozers]

Checklist

• run npm run test and npm run benchmark
• tests and/or benchmarks are included
• documentation is changed or added
• commit message and code follows the Developer's Certification of Origin
  and the Code of conduct

All tests are passing:

• Unit tests
• TypeScript tests
• Benchmark script not included, so I couldn't run.
• Documentation is not changed because of this change is only affect TypeScript type annotation, we can add if needed.

I would like to open a PR for this issue due to contribute if you allow me.
I've made the the update and updated the tests in this context. Due to TypeScript's inability to automatically infer 'this' context in union types, needed to explicitly specify 'this: FastifyInstance' type annotation in functions that use 'this'. I've updated the tests to reflect this requirement, also added async and promise-based tests to cover the update.

In the function below, which is used without specifying a pre-usable type, the need to use 'this: FastifyInstance' arises due to the situation I mentioned above.

app.auth([
    // this should be transform to function (this: FastifyInstance) for TypeScript annotation needs.
    function () { 
      expectType<FastifyInstance>(this)
      return Promise.resolve()
    },
  ])

Changes made:

• Updated FastifyAuthFunction type to support both callback and Promise patterns with proper this context
• Added explicit this type annotation in auth tests
• Reorganized test structure for better readability
• tests with { relation: 'or' } added, defaultRelation is already 'or' but defaultRelation definition can be changed.

Please review the changes.

[Uzlopak]

Afaik this is not working properly. Basically you get a "merged" function. Basically

((this: FastifyInstance, request: Request, reply: Reply, done: (error?: Error) => void) => void)
    | ((this: FastifyInstance, request: Request, reply: Reply) => Promise<void>)

results in

((this: FastifyInstance, request: Request, reply: Reply, done?: (error?: Error) => void) => (void | Promise<void)

compare with
https://github.com/fastify/fastify/blob/be8f72fcb3c99fad1982fe4853119a9a79db40ba/types/hooks.d.ts#L78

[ozers]

Thanks for your comment @Uzlopak , I updated the PR after reviewing the hook link you mentioned and now it looks better and meets the issues mentioned above.

[Copilot]

Pull Request Overview

This PR extends the FastifyAuthFunction type to accept async functions in addition to the existing callback-based functions. The change allows authentication functions to use modern async/await patterns or return Promises directly, providing better TypeScript support for asynchronous authentication workflows.

• Extended FastifyAuthFunction type to support async functions and Promise-returning functions
• Added comprehensive TypeScript tests covering callback, async, and Promise-based authentication patterns
• Added tests for various configuration options (relation: 'or'/'and', run: 'all')

---

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
You can also share your feedback on Copilot code review for a chance to win a $100 gift card. Take the survey.}