feat: add processError option

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)
+- [processError](openapi_client.CommonHttpClientOptions.md#processerror)
 - [shouldRetryOnError](openapi_client.CommonHttpClientOptions.md#shouldretryonerror)
 
 ### Methods
@@ -208,6 +209,28 @@ Preprocess the request before sending it.
 
 ___
 
+### processError
+
+• `Optional` **processError**: (`error`: `Error`) => `Error`
+
+#### Type declaration
+
+▸ (`error`): `Error`
+
+Process the error before throwing it. Can be used to add additional information to the error.
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `error` | `Error` |
+
+##### Returns
+
+`Error`
+
+___
+
 ### shouldRetryOnError
 
 • `Optional` **shouldRetryOnError**: (`error`: `Error`, `attemptNumber`: `number`) => `boolean` \| `Promise`\<`boolean`\>

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

@@ -75,6 +75,10 @@ export interface CommonHttpClientOptions {
      * Determine whether to retry on error.
      */
     shouldRetryOnError?: (error: Error, attemptNumber: number) => boolean | Promise<boolean>;
+    /**
+     * Process the error before throwing it. Can be used to add additional information to the error.
+     */
+    processError?: (error: Error) => Error;
 }
 
 /**
@@ -770,9 +774,23 @@ export class CommonHttpClient {
     }
 
     /**
-     * Perform a request.
+     * Request wrapper. It performs the request and handles errors.
      */
     public async request(request: CommonHttpClientRequest): Promise<CommonHttpClientFetchResponse> {
+        try {
+            return await this.performRequest(request);
+        } catch (e) {
+            if (this.options.processError) {
+                throw this.options.processError(e instanceof Error ? e : new Error(String(e)));
+            }
+            throw e;
+        }
+    }
+
+    /**
+     * Perform a request.
+     */
+    protected async performRequest(request: CommonHttpClientRequest): Promise<CommonHttpClientFetchResponse> {
         this.logDeprecationWarningIfNecessary(request);
         try {
             request = await this.preprocessRequest(request);

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

@@ -38,25 +38,26 @@ describe('store-service', () => {
             fail('Unexpected media type.');
         }
     });
-    it('should get and delete the placed order', async () => {
+    it('should process errors', async () => {
         const orderId = 123123123;
-        await client.store.placeOrder({
-            order: {
-                id: orderId,
-                petId: 123,
-                quantity: 1,
-                shipDate: '2021-09-01T00:00:00.000Z',
-                status: 'placed',
-                complete: true
-            }
+        const processError = (error: Error) => {
+            error.message = `Processed error: ${error.message}`;
+            return error;
+        };
+        const client = new PetStoreApiClient({
+            baseUrl: 'https://petstore.swagger.io/v2',
+            shouldRetryOnError,
+            processError
         });
-        const orderResponse = await client.store.getOrderById({orderId});
-        if (checkReponseMediaType(orderResponse, 'application/json')) {
-            expect(orderResponse.body.petId).toEqual(123);
-        } else {
-            throw new Error('Unexpected media type.');
+        try {
+            await client.store.getOrderById({orderId});
+        } catch (error) {
+            if (!(error instanceof CommonHttpClientError)) {
+                fail('Unexpected error type.');
+            }
+            expect((error as CommonHttpClientError).response?.status).toEqual(404);
+            expect(error.message).toContain('Processed error:');
         }
-        await client.store.deleteOrder({orderId});
     });
     it('should fail in case of non-existing orders', async () => {
         try {