Improve typing and usage of getDefaultDelay (#432)

Co-authored-by: Wojciech Stachowski <[email protected]>

Author: Antiavanti

README.md

@@ -320,7 +320,7 @@ Given example
 ```js
    const customRetryLogic = ({err, req, res, attempt, getDefaultRetry}) => {
     //If this block is not included all non 500 errors will not be retried
-    const defaultDelay = getDefaultDelay();
+    const defaultDelay = getDefaultDelay(req, res, err, attempt);
     if (defaultDelay) return defaultDelay();
 
     //Custom retry logic

test/retry-with-a-custom-handler.test.js

@@ -55,8 +55,8 @@ test('a 500 status code with no custom handler should fail', async (t) => {
 })
 
 test("a server 500's with a custom handler and should revive", async (t) => {
-  const customRetryLogic = ({ req, res, getDefaultDelay }) => {
-    const defaultDelay = getDefaultDelay()
+  const customRetryLogic = ({ req, res, err, attempt, getDefaultDelay }) => {
+    const defaultDelay = getDefaultDelay(req, res, err, attempt)
     if (defaultDelay) return defaultDelay
 
     if (res && res.statusCode === 500 && req.method === 'GET') {
@@ -92,9 +92,9 @@ test('custom retry does not invoke the default delay causing a 501', async (t) =
 })
 
 test('custom retry delay functions can invoke the default delay', async (t) => {
-  const customRetryLogic = ({ req, res, getDefaultDelay }) => {
+  const customRetryLogic = ({ req, res, err, attempt, getDefaultDelay }) => {
     // registering the default retry logic for non 500 errors if it occurs
-    const defaultDelay = getDefaultDelay()
+    const defaultDelay = getDefaultDelay(req, res, err, attempt)
     if (defaultDelay) return defaultDelay
 
     if (res && res.statusCode === 500 && req.method === 'GET') {

types/index.d.ts

@@ -54,7 +54,12 @@ declare namespace fastifyReplyFrom {
     res: FastifyReply<RouteGenericInterface, RawServerBase>;
     attempt: number;
     retriesCount: number;
-    getDefaultDelay: () => number | null;
+    getDefaultDelay: (
+      req: FastifyRequest<RequestGenericInterface, RawServerBase>,
+      res: FastifyReply<RouteGenericInterface, RawServerBase>,
+      err: Error,
+      retries: number,
+    ) => number | null;
   }
 
   export type RawServerResponse<T extends RawServerBase> = RawReplyDefaultExpression<T> & {
@@ -64,7 +69,7 @@ declare namespace fastifyReplyFrom {
   export interface FastifyReplyFromHooks {
     queryString?: { [key: string]: unknown } | QueryStringFunction;
     contentType?: string;
-    retryDelay?: (details: RetryDetails) => {} | null;
+    retryDelay?: (details: RetryDetails) => number | null;
     retriesCount?: number;
     onResponse?: (
       request: FastifyRequest<RequestGenericInterface, RawServerBase>,

types/index.test-d.ts

@@ -103,8 +103,8 @@ async function main () {
   instance.get('/http2', (_request, reply) => {
     reply.from('/', {
       method: 'POST',
-      retryDelay: ({ req, res, getDefaultDelay }) => {
-        const defaultDelay = getDefaultDelay()
+      retryDelay: ({ req, res, err, attempt, getDefaultDelay }) => {
+        const defaultDelay = getDefaultDelay(req, res, err, attempt)
         if (defaultDelay) return defaultDelay
 
         if (res && res.statusCode === 500 && req.method === 'GET') {