Merge pull request #525 from PermanentOrg/522-retry-configuration-expansion

Support additional retry configuration

Author: slifty

CHANGELOG.md

@@ -7,6 +7,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- SDK clients can now be configured to specify how many `retry` attempts to make.
+- SDK clients can now be configured to specify a custom `retryDelay` function.
+
 ## [0.10.0] - 2025-04-02
 
 ### Added

src/types/sdk/ClientConfiguration.ts

@@ -3,4 +3,6 @@ export interface ClientConfiguration {
   baseUrl?: string;
   stelaBaseUrl?: string;
   retryOn?: number[];
+  retries?: number;
+  retryDelay?: (attempt: number) => number;
 }

src/utils/__tests__/makePermanentApiCall.test.ts

@@ -82,4 +82,39 @@ describe('makePermanentApiCall', () => {
     expect(responseBody).toEqual('it worked');
     expect(mock.isDone()).toBe(true); // All mocked responses were invoked
   });
+
+  it('should retry additional times than the default if configured to do so', async () => {
+    const mock = nock('https://permanent.local', {
+      reqheaders: {
+        Authorization: 'Bearer 12345',
+        'Request-Version': '2',
+        'Content-Type': 'application/json',
+      },
+    })
+      .get('/api/testing')
+      .reply(404, 'it did not work')
+      .get('/api/testing')
+      .reply(404, 'it did not work')
+      .get('/api/testing')
+      .reply(404, 'it did not work')
+      .get('/api/testing')
+      .reply(404, 'it did not work')
+      .get('/api/testing')
+      .reply(200, 'it worked');
+
+    const response = await makePermanentApiCall(
+      {
+        bearerToken: '12345',
+        baseUrl: 'https://permanent.local/api',
+        retryOn: [404],
+        retries: 4,
+        retryDelay: (attempt) => attempt * 0.01,
+      },
+      '/testing',
+    );
+    const responseBody = await response.text();
+
+    expect(responseBody).toEqual('it worked');
+    expect(mock.isDone()).toBe(true); // All mocked responses were invoked
+  });
 });

src/utils/__tests__/makeStelaApiCall.test.ts

@@ -92,4 +92,33 @@ describe('makeStelaApiCall', () => {
     expect(responseBody).toEqual('it worked');
     expect(mock.isDone()).toBe(true); // All mocked responses were invoked
   });
+
+  it('should retry additional times than the default if configured to do so', async () => {
+    const mock = nock('https://api.permanent.local')
+      .get('/api/v2/testing')
+      .reply(404, 'it did not work')
+      .get('/api/v2/testing')
+      .reply(404, 'it did not work')
+      .get('/api/v2/testing')
+      .reply(404, 'it did not work')
+      .get('/api/v2/testing')
+      .reply(404, 'it did not work')
+      .get('/api/v2/testing')
+      .reply(200, 'it worked');
+
+    const response = await makeStelaApiCall(
+      {
+        bearerToken: '12345',
+        stelaBaseUrl: 'https://api.permanent.local/api/v2',
+        retryOn: [404],
+        retries: 4,
+        retryDelay: (attempt) => attempt * 0.01,
+      },
+      '/testing',
+    );
+    const responseBody = await response.text();
+
+    expect(responseBody).toEqual('it worked');
+    expect(mock.isDone()).toBe(true); // All mocked responses were invoked
+  });
 });

src/utils/getFetch.ts

@@ -3,8 +3,8 @@ import fetchRetry from 'fetch-retry';
 import type { ClientConfiguration } from '../types/sdk/ClientConfiguration';
 
 const getFetch = (clientConfiguration: ClientConfiguration) => fetchRetry(originalFetch, {
-  retries: 3,
-  retryDelay: (attempt) => (2 ** attempt) * 1000,
+  retries: clientConfiguration.retries ?? 3,
+  retryDelay: clientConfiguration.retryDelay ?? ((attempt) => (2 ** attempt) * 1000),
   retryOn: clientConfiguration.retryOn ?? [],
 });