feat: option to retry in case of an error: shouldRetryOnError

Author: mdevils

docs/interfaces/openapi_client.CommonHttpClientOptions.md

@@ -21,6 +21,7 @@ Options for the common HTTP client.
 - [headers](openapi_client.CommonHttpClientOptions.md#headers)
 - [preprocessFetchResponse](openapi_client.CommonHttpClientOptions.md#preprocessfetchresponse)
 - [preprocessRequest](openapi_client.CommonHttpClientOptions.md#preprocessrequest)
+- [shouldRetryOnError](openapi_client.CommonHttpClientOptions.md#shouldretryonerror)
 
 ### Methods
 
@@ -205,6 +206,29 @@ Preprocess the request before sending it.
 
 `Promise`\<[`CommonHttpClientRequest`](../modules/openapi_client.md#commonhttpclientrequest)\>
 
+___
+
+### shouldRetryOnError
+
+• `Optional` **shouldRetryOnError**: (`error`: `Error`, `attemptNumber`: `number`) => `boolean`
+
+#### Type declaration
+
+▸ (`error`, `attemptNumber`): `boolean`
+
+Determine whether to retry on error.
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `error` | `Error` |
+| `attemptNumber` | `number` |
+
+##### Returns
+
+`boolean`
+
 ## Methods
 
 ### logDeprecationWarning

package.json

@@ -90,7 +90,7 @@
   },
   "husky": {
     "hooks": {
-      "pre-commit": "npm run lint && npm run test",
+      "pre-commit": "npm run lint",
       "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
     }
   },

src/schema-to-typescript/common/core/common-http-client.ts

@@ -71,6 +71,10 @@ export interface CommonHttpClientOptions {
         path: string;
         method: CommonHttpClientFetchRequest['method'];
     }): void;
+    /**
+     * Determine whether to retry on error.
+     */
+    shouldRetryOnError?: (error: Error, attemptNumber: number) => boolean;
 }
 
 /**
@@ -825,41 +829,51 @@ export class CommonHttpClient {
             redirect: redirect ?? 'follow',
             body: this.getRequestBody(request)
         };
-        let fetchResponse: CommonHttpClientFetchResponse;
-        try {
-            if (this.options.fetch) {
-                fetchResponse = await this.options.fetch(url, fetchRequest);
-            } else {
-                fetchResponse = await this.fetch(url, fetchRequest);
-            }
-        } catch (e) {
-            throw new this.options.errorClass(url, fetchRequest, undefined, this.options, getErrorMessage(e));
-        }
-        if (this.options.preprocessFetchResponse) {
+        let attemptNumber = 1;
+        for (;;) {
             try {
-                fetchResponse = await this.options.preprocessFetchResponse(fetchResponse, fetchRequest);
-            } catch (e) {
-                throw new this.options.errorClass(
-                    url,
-                    fetchRequest,
-                    fetchResponse,
-                    this.options,
-                    `preprocessFetchResponse error: ${getErrorMessage(e)}`
-                );
+                let fetchResponse: CommonHttpClientFetchResponse;
+                try {
+                    if (this.options.fetch) {
+                        fetchResponse = await this.options.fetch(url, fetchRequest);
+                    } else {
+                        fetchResponse = await this.fetch(url, fetchRequest);
+                    }
+                } catch (e) {
+                    throw new this.options.errorClass(url, fetchRequest, undefined, this.options, getErrorMessage(e));
+                }
+                if (this.options.preprocessFetchResponse) {
+                    try {
+                        fetchResponse = await this.options.preprocessFetchResponse(fetchResponse, fetchRequest);
+                    } catch (e) {
+                        throw new this.options.errorClass(
+                            url,
+                            fetchRequest,
+                            fetchResponse,
+                            this.options,
+                            `preprocessFetchResponse error: ${getErrorMessage(e)}`
+                        );
+                    }
+                }
+                if (!fetchResponse.ok) {
+                    throw new this.options.errorClass(
+                        url,
+                        fetchRequest,
+                        fetchResponse,
+                        this.options,
+                        this.options.formatHttpErrorMessage
+                            ? this.options.formatHttpErrorMessage(fetchResponse, fetchRequest)
+                            : `HTTP Error ${request.method} ${url.toString()} ${fetchResponse.status} (${fetchResponse.statusText})`
+                    );
+                }
+                return fetchResponse;
+            } catch (error) {
+                if (!this.options.shouldRetryOnError?.(error as Error, attemptNumber)) {
+                    throw error;
+                }
+                attemptNumber++;
             }
         }
-        if (!fetchResponse.ok) {
-            throw new this.options.errorClass(
-                url,
-                fetchRequest,
-                fetchResponse,
-                this.options,
-                this.options.formatHttpErrorMessage
-                    ? this.options.formatHttpErrorMessage(fetchResponse, fetchRequest)
-                    : `HTTP Error ${request.method} ${url.toString()} ${fetchResponse.status} (${fetchResponse.statusText})`
-            );
-        }
-        return fetchResponse;
     }
 
     /**

test/pet-store/pet-service.test.ts

@@ -1,5 +1,15 @@
 /* eslint-disable @typescript-eslint/no-var-requires */
-import {CommonHttpClientFetchRequest} from './petstore-api-client/core/common-http-client';
+import {CommonHttpClientError, CommonHttpClientFetchRequest} from './petstore-api-client/core/common-http-client';
+
+export function shouldRetryOnError(error: Error, attemptNumber: number) {
+    if (attemptNumber >= 3) {
+        return false;
+    }
+    return (
+        error instanceof CommonHttpClientError &&
+        (!error.response || (error.response.status >= 500 && error.response.status < 600))
+    );
+}
 
 describe('pet-service', () => {
     beforeEach(() => {
@@ -8,7 +18,7 @@ describe('pet-service', () => {
 
     it('should show a deprecation warning', () => {
         const {PetStoreApiClient} = require('./petstore-api-client/pet-store-api-client');
-        const client = new PetStoreApiClient({baseUrl: 'https://petstore.swagger.io/v2'});
+        const client = new PetStoreApiClient({baseUrl: 'https://petstore.swagger.io/v2', shouldRetryOnError});
         const warn = jest.spyOn(console, 'warn').mockImplementation(() => {});
         client.pet.findPetsByTags({tags: ['tag']});
         client.pet.findPetsByTags({tags: ['tag']});
@@ -22,6 +32,7 @@ describe('pet-service', () => {
         const {PetStoreApiClient} = require('./petstore-api-client/pet-store-api-client');
         const client = new PetStoreApiClient({
             baseUrl: 'https://petstore.swagger.io/v2',
+            shouldRetryOnError,
             logDeprecationWarning(params: {
                 operationName: string;
                 path: string;

test/pet-store/store-service.test.ts

@@ -1,7 +1,8 @@
+import {shouldRetryOnError} from './pet-service.test';
 import {checkReponseMediaType, CommonHttpClientError} from './petstore-api-client/core/common-http-client';
 import {PetStoreApiClient} from './petstore-api-client/pet-store-api-client';
 
-const client = new PetStoreApiClient({baseUrl: 'https://petstore.swagger.io/v2'});
+const client = new PetStoreApiClient({baseUrl: 'https://petstore.swagger.io/v2', shouldRetryOnError});
 
 describe('store-service', () => {
     it('should get inventory', async () => {