Add retry.backoffLimit option

Fixes #1599
sindresorhus · Apr 15, 2021 · 41c4136 · 41c4136
1 parent 4f21eb3
commit 41c4136
Show file tree

Hide file tree

Showing 3 changed files with 44 additions and 3 deletions.
diff --git a/source/core/calculate-retry-delay.ts b/source/core/calculate-retry-delay.ts
@@ -2,7 +2,13 @@ import type {RetryFunction} from './options';
 
 type Returns<T extends (...args: any) => unknown, V> = (...args: Parameters<T>) => V;
 
-const calculateRetryDelay: Returns<RetryFunction, number> = ({attemptCount, retryOptions, error, retryAfter, computedValue}) => {
+const calculateRetryDelay: Returns<RetryFunction, number> = ({
+	attemptCount,
+	retryOptions,
+	error,
+	retryAfter,
+	computedValue
+}) => {
 	if (error.name === 'RetryError') {
 		return 1;
 	}
@@ -34,7 +40,7 @@ const calculateRetryDelay: Returns<RetryFunction, number> = ({attemptCount, retr
 	}
 
 	const noise = Math.random() * 100;
-	return ((2 ** (attemptCount - 1)) * 1000) + noise;
+	return Math.min(((2 ** (attemptCount - 1)) * 1000), retryOptions.backoffLimit) + noise;
 };
 
 export default calculateRetryDelay;
diff --git a/source/core/options.ts b/source/core/options.ts
@@ -293,6 +293,7 @@ export interface RetryOptions {
 	statusCodes: number[];
 	errorCodes: string[];
 	calculateDelay: RetryFunction;
+	backoffLimit: number;
 	maxRetryAfter?: number;
 }
 
@@ -460,6 +461,7 @@ export interface PaginationOptions<ElementType, BodyType> {
 	@default 0
 	*/
 	backoff?: number;
+
 	/**
 	The maximum amount of request that should be triggered.
 	Retries on failure are not counted towards this limit.
@@ -616,7 +618,8 @@ const defaultInternals: Options['_internals'] = {
 			'EAI_AGAIN'
 		],
 		maxRetryAfter: undefined,
-		calculateDelay: ({computedValue}) => computedValue
+		calculateDelay: ({computedValue}) => computedValue,
+		backoffLimit: Number.POSITIVE_INFINITY
 	},
 	localAddress: undefined,
 	method: 'GET',

diff --git a/test/retry.ts b/test/retry.ts
@@ -565,3 +565,35 @@ test('reuses request options on retry', withServer, async (t, server, got) => {
 	t.is(retryCount, 1);
 	t.is(accept, 'application/json');
 });
+
+test('respects backoffLimit', withServer, async (t, server, got) => {
+	let count = 0;
+	let timestamp = Date.now();
+	const data: number[] = [];
+
+	server.get('/', (_request, response) => {
+		count++;
+
+		const now = Date.now();
+		data.push(now - timestamp);
+		timestamp = now;
+
+		if (count === 3) {
+			response.end(JSON.stringify(data));
+		} else {
+			response.statusCode = 408;
+			response.end();
+		}
+	});
+
+	const body = await got('', {
+		retry: {
+			backoffLimit: 0
+		}
+	}).json<number[]>();
+
+	t.is(body.length, 3);
+	t.true(body[0]! < 200);
+	t.true(body[1]! < 200);
+	t.true(body[2]! < 200);
+});