@trayio/axios 5.9.0 → 5.10.0

package/dist/http/AxiosHttpClient.d.ts

@@ -6,10 +6,13 @@ import { FileStorage } from '@trayio/commons/file/File';
 type AxiosOptions = {
     rejectUnauthorized: boolean;
     followRedirects: boolean;
+    retries?: number;
 };
 export declare class AxiosHttpClient implements HttpClient {
     private readonly fileStorage;
     private readonly axiosOptions;
+    private readonly defaultHttpsAgent;
+    private readonly axiosInstance;
     constructor(fileStorage?: FileStorage, axiosOptions?: AxiosOptions);
     execute(method: HttpMethod, url: string, request: HttpRequest): TE.TaskEither<Error, HttpResponse>;
     private axiosErrorToHttpResponse;

package/dist/http/AxiosHttpClient.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"AxiosHttpClient.d.ts","sourceRoot":"","sources":["../../src/http/AxiosHttpClient.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAEvC,OAAO,EAAE,UAAU,EAAE,MAAM,iCAAiC,CAAC;AAC7D,OAAO,EAEN,UAAU,EACV,WAAW,EAEX,YAAY,EAEZ,MAAM,2BAA2B,CAAC;AAInC,OAAO,QAAQ,GAAG,QAAQ,WAAW,CAAC,CAAC;AACvC,OAAO,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAC;AAMxD,KAAK,YAAY,GAAG;IACnB,kBAAkB,EAAE,OAAO,CAAC;IAC5B,eAAe,EAAE,OAAO,CAAC;CACzB,CAAC;AAEF,qBAAa,eAAgB,YAAW,UAAU;IAEhD,OAAO,CAAC,QAAQ,CAAC,WAAW;IAC5B,OAAO,CAAC,QAAQ,CAAC,YAAY;gBADZ,WAAW,GAAE,WAAqC,EAClD,YAAY,GAAE,YAG9B;IAGF,OAAO,CACN,MAAM,EAAE,UAAU,EAClB,GAAG,EAAE,MAAM,EACX,OAAO,EAAE,WAAW,GAClB,EAAE,CAAC,UAAU,CAAC,KAAK,EAAE,YAAY,CAAC;IAuHrC,OAAO,CAAC,wBAAwB;IAmBhC,OAAO,CAAC,2BAA2B;IAUnC,YAAY,aAAc,QAAQ,cAAc,OAAO,MAAM,EAAE,MAAM,CAAC,cAKpE;CACF"}
+{"version":3,"file":"AxiosHttpClient.d.ts","sourceRoot":"","sources":["../../src/http/AxiosHttpClient.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAEvC,OAAO,EAAE,UAAU,EAAE,MAAM,iCAAiC,CAAC;AAC7D,OAAO,EAEN,UAAU,EACV,WAAW,EAEX,YAAY,EAEZ,MAAM,2BAA2B,CAAC;AAWnC,OAAO,QAAQ,GAAG,QAAQ,WAAW,CAAC,CAAC;AACvC,OAAO,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAC;AAMxD,KAAK,YAAY,GAAG;IACnB,kBAAkB,EAAE,OAAO,CAAC;IAC5B,eAAe,EAAE,OAAO,CAAC;IACzB,OAAO,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,qBAAa,eAAgB,YAAW,UAAU;IAKhD,OAAO,CAAC,QAAQ,CAAC,WAAW;IAC5B,OAAO,CAAC,QAAQ,CAAC,YAAY;IAL9B,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAQ;IAC1C,OAAO,CAAC,QAAQ,CAAC,aAAa,CAA8B;gBAG1C,WAAW,GAAE,WAAqC,EAClD,YAAY,GAAE,YAI9B;IAmCF,OAAO,CACN,MAAM,EAAE,UAAU,EAClB,GAAG,EAAE,MAAM,EACX,OAAO,EAAE,WAAW,GAClB,EAAE,CAAC,UAAU,CAAC,KAAK,EAAE,YAAY,CAAC;IA4GrC,OAAO,CAAC,wBAAwB;IAmBhC,OAAO,CAAC,2BAA2B;IAUnC,YAAY,aAAc,QAAQ,cAAc,OAAO,MAAM,EAAE,MAAM,CAAC,cAKpE;CACF"}

package/dist/http/AxiosHttpClient.js

@@ -31,6 +31,7 @@ const O = __importStar(require("fp-ts/Option"));
 const Http_1 = require("@trayio/commons/http/Http");
 const Task_1 = require("@trayio/commons/task/Task");
 const axios_1 = __importDefault(require("axios"));
+const axios_retry_1 = __importStar(require("axios-retry"));
 const https_1 = require("https");
 const FormData = require("form-data");
 const NodeFsFileStorage_1 = require("@trayio/commons/file/NodeFsFileStorage");
@@ -39,25 +40,44 @@ const function_1 = require("fp-ts/lib/function");
 class AxiosHttpClient {
     fileStorage;
     axiosOptions;
+    defaultHttpsAgent;
+    axiosInstance;
     constructor(fileStorage = new NodeFsFileStorage_1.NodeFsFileStorage(), axiosOptions = {
         rejectUnauthorized: false,
         followRedirects: true,
+        retries: 0,
     }) {
         this.fileStorage = fileStorage;
         this.axiosOptions = axiosOptions;
+        // We need a keep-alive heartbeat shorter than 350 seconds to bypass the idle timeout in AWS NAT/LB servers:
+        // https://repost.aws/knowledge-center/lambda-vpc-timeout
+        this.defaultHttpsAgent = new https_1.Agent({
+            keepAlive: true,
+            keepAliveMsecs: 42000,
+            rejectUnauthorized: this.axiosOptions.rejectUnauthorized,
+        });
+        // Validate and clamp retries to 0-10 range, default to 0
+        const retries = Math.max(0, Math.min(10, this.axiosOptions.retries ?? 0));
+        // Create isolated axios instance
+        this.axiosInstance = axios_1.default.create();
+        // Clear all default headers to ensure no default headers are added
+        this.axiosInstance.defaults.headers.common = {};
+        this.axiosInstance.defaults.headers.get = {};
+        this.axiosInstance.defaults.headers.post = {};
+        this.axiosInstance.defaults.headers.put = {};
+        this.axiosInstance.defaults.headers.patch = {};
+        this.axiosInstance.defaults.headers.delete = {};
+        // Configure retry behavior
+        (0, axios_retry_1.default)(this.axiosInstance, {
+            retries,
+            retryDelay: axios_retry_1.exponentialDelay,
+            retryCondition: (error) => 
+            // Retry on network errors (ECONNREFUSED, ETIMEDOUT, etc.) and 5xx errors
+            axios_retry_1.default.isNetworkOrIdempotentRequestError(error) ||
+                (error.response?.status !== undefined && error.response.status >= 500),
+        });
     }
     execute(method, url, request) {
-        /*
-          Removes default headers so that we control what we send to the server, without this, it sends default content-type and accept headers,
-          the caller of this HttpClient interface is responsible of deciding the values of these headers, axios shouldn't try to be smart
-          and derive these from the body or even set defaults.
-        */
-        axios_1.default.defaults.headers.common = {};
-        axios_1.default.defaults.headers.get = {};
-        axios_1.default.defaults.headers.post = {};
-        axios_1.default.defaults.headers.put = {};
-        axios_1.default.defaults.headers.patch = {};
-        axios_1.default.defaults.headers.delete = {};
         const finalUrl = Object.entries(request.pathParams).reduce((acc, [key, value]) => acc.replace(`:${key}`, encodeURIComponent(value)), url);
         const preserveHeaderCasing = (0, function_1.pipe)(request.headerOptions, O.match(() => false, (headerOptions) => (0, function_1.pipe)(headerOptions.preserveHeaderCasing, O.match(() => false, (preserveCasing) => preserveCasing))));
         const headers = Object.entries(request.headers).reduce((acc, [key, value]) => {
@@ -71,15 +91,14 @@ class AxiosHttpClient {
             };
         }, {});
         let axiosConfig;
-        const httpCertificate = (0, function_1.pipe)(request.agent, O.map((agent) => agent), O.chain((agent) => agent.certificate), O.getOrElse(() => ({})));
-        // We need a keep-alive heartbeat shorter than 350 seconds to bypass the idle timeout in AWS NAT/LB servers:
-        // https://repost.aws/knowledge-center/lambda-vpc-timeout
-        const axiosHttpsAgent = new https_1.Agent({
-            ...httpCertificate,
+        // Use custom certificate if provided, otherwise use the default agent
+        const axiosHttpsAgent = (0, function_1.pipe)(request.agent, O.chain((agent) => agent.certificate), O.match(() => this.defaultHttpsAgent, (certificate) => new https_1.Agent({
+            cert: certificate.cert,
+            key: certificate.key,
             keepAlive: true,
             keepAliveMsecs: 42000,
             rejectUnauthorized: this.axiosOptions.rejectUnauthorized,
-        });
+        })));
         if (headers['content-type'] &&
             headers['content-type'].includes(Http_1.HttpContentType.MultipartRequestBody)) {
             const formData = new FormData();
@@ -101,7 +120,7 @@ class AxiosHttpClient {
                 httpsAgent: axiosHttpsAgent,
                 params: request.queryString,
             };
-            return (0, Task_1.createTaskEitherFromPromiseWithSimpleError)(() => (0, axios_1.default)(axiosConfig)
+            return (0, Task_1.createTaskEitherFromPromiseWithSimpleError)(() => this.axiosInstance(axiosConfig)
                 .then(this.axiosResponseToHttpResponse)
                 .catch(this.axiosErrorToHttpResponse.bind(this)));
         }
@@ -115,7 +134,7 @@ class AxiosHttpClient {
             params: request.queryString,
             ...(this.axiosOptions.followRedirects ? {} : { maxRedirects: 0 }),
         };
-        return (0, Task_1.createTaskEitherFromPromiseWithSimpleError)(() => (0, axios_1.default)(axiosConfig)
+        return (0, Task_1.createTaskEitherFromPromiseWithSimpleError)(() => this.axiosInstance(axiosConfig)
             .then(this.axiosResponseToHttpResponse)
             .catch(this.axiosErrorToHttpResponse.bind(this)));
     }

package/dist/http/AxiosHttpClient.unit.test.js

@@ -1,11 +1,199 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 const HttpClient_abstract_test_1 = require("@trayio/commons/http/HttpClient.abstract.test");
 const NodeFsFileStorage_1 = require("@trayio/commons/file/NodeFsFileStorage");
+const E = __importStar(require("fp-ts/Either"));
+const Http_1 = require("@trayio/commons/http/Http");
+const BufferExtensions_1 = require("@trayio/commons/buffer/BufferExtensions");
+const nock_1 = __importDefault(require("nock"));
 const AxiosHttpClient_1 = require("./AxiosHttpClient");
 describe('AxiosHttpClient Tests', () => {
     (0, HttpClient_abstract_test_1.httpClientTest)(new AxiosHttpClient_1.AxiosHttpClient(new NodeFsFileStorage_1.NodeFsFileStorage(), {
         rejectUnauthorized: false,
         followRedirects: true,
     }));
+    describe('Retry mechanism', () => {
+        afterEach(() => {
+            nock_1.default.cleanAll();
+        });
+        test('should retry on ECONNREFUSED error when retries > 0', async () => {
+            const axiosHttpClient = new AxiosHttpClient_1.AxiosHttpClient(new NodeFsFileStorage_1.NodeFsFileStorage(), {
+                rejectUnauthorized: false,
+                followRedirects: true,
+                retries: 3,
+            });
+            const testUrl = 'http://test-retry.example.com';
+            // First two attempts fail with ECONNREFUSED
+            (0, nock_1.default)(testUrl).get('/').times(2).replyWithError({
+                code: 'ECONNREFUSED',
+                message: 'Connection refused',
+            });
+            // Third attempt succeeds
+            (0, nock_1.default)(testUrl).get('/').reply(200, { success: true });
+            const response = await axiosHttpClient.execute(Http_1.HttpMethod.Get, testUrl, Http_1.HttpRequest.create({
+                headers: {},
+                pathParams: {},
+                queryString: {},
+                body: BufferExtensions_1.BufferExtensions.arrayBufferToReadable(new ArrayBuffer(0)),
+            }))();
+            expect(E.isRight(response)).toBe(true);
+            if (E.isRight(response)) {
+                expect(response.right.statusCode).toBe(200);
+            }
+        });
+        test('should retry on 500 error when retries > 0', async () => {
+            const axiosHttpClient = new AxiosHttpClient_1.AxiosHttpClient(new NodeFsFileStorage_1.NodeFsFileStorage(), {
+                rejectUnauthorized: false,
+                followRedirects: true,
+                retries: 3,
+            });
+            const testUrl = 'http://test-retry-500.example.com';
+            // First two attempts return 500
+            (0, nock_1.default)(testUrl)
+                .get('/')
+                .times(2)
+                .reply(500, { error: 'Internal Server Error' });
+            // Third attempt succeeds
+            (0, nock_1.default)(testUrl).get('/').reply(200, { success: true });
+            const response = await axiosHttpClient.execute(Http_1.HttpMethod.Get, testUrl, Http_1.HttpRequest.create({
+                headers: {},
+                pathParams: {},
+                queryString: {},
+                body: BufferExtensions_1.BufferExtensions.arrayBufferToReadable(new ArrayBuffer(0)),
+            }))();
+            expect(E.isRight(response)).toBe(true);
+            if (E.isRight(response)) {
+                expect(response.right.statusCode).toBe(200);
+            }
+        });
+        test('should NOT retry when retries is 0 (default)', async () => {
+            const axiosHttpClient = new AxiosHttpClient_1.AxiosHttpClient(new NodeFsFileStorage_1.NodeFsFileStorage(), {
+                rejectUnauthorized: false,
+                followRedirects: true,
+                retries: 0,
+            });
+            const testUrl = 'http://test-no-retry.example.com';
+            // First attempt fails
+            (0, nock_1.default)(testUrl).get('/').replyWithError({
+                code: 'ECONNREFUSED',
+                message: 'Connection refused',
+            });
+            // This should not be called
+            (0, nock_1.default)(testUrl).get('/').reply(200, { success: true });
+            const response = await axiosHttpClient.execute(Http_1.HttpMethod.Get, testUrl, Http_1.HttpRequest.create({
+                headers: {},
+                pathParams: {},
+                queryString: {},
+                body: BufferExtensions_1.BufferExtensions.arrayBufferToReadable(new ArrayBuffer(0)),
+            }))();
+            // Should get error response
+            expect(E.isRight(response)).toBe(true);
+            if (E.isRight(response)) {
+                // AxiosHttpClient converts connection errors to 500 responses
+                expect(response.right.statusCode).toBe(500);
+            }
+        });
+        test('should NOT retry when retries is omitted (uses default 0)', async () => {
+            const axiosHttpClient = new AxiosHttpClient_1.AxiosHttpClient(new NodeFsFileStorage_1.NodeFsFileStorage(), {
+                rejectUnauthorized: false,
+                followRedirects: true,
+            });
+            const testUrl = 'http://test-default-no-retry.example.com';
+            // First attempt fails
+            (0, nock_1.default)(testUrl).get('/').replyWithError({
+                code: 'ECONNREFUSED',
+                message: 'Connection refused',
+            });
+            // This should not be called
+            (0, nock_1.default)(testUrl).get('/').reply(200, { success: true });
+            const response = await axiosHttpClient.execute(Http_1.HttpMethod.Get, testUrl, Http_1.HttpRequest.create({
+                headers: {},
+                pathParams: {},
+                queryString: {},
+                body: BufferExtensions_1.BufferExtensions.arrayBufferToReadable(new ArrayBuffer(0)),
+            }))();
+            // Should get error response
+            expect(E.isRight(response)).toBe(true);
+            if (E.isRight(response)) {
+                // AxiosHttpClient converts connection errors to 500 responses
+                expect(response.right.statusCode).toBe(500);
+            }
+        });
+        test('should give up after max retries', async () => {
+            const axiosHttpClient = new AxiosHttpClient_1.AxiosHttpClient(new NodeFsFileStorage_1.NodeFsFileStorage(), {
+                rejectUnauthorized: false,
+                followRedirects: true,
+                retries: 3,
+            });
+            const testUrl = 'http://test-max-retries.example.com';
+            // All attempts fail (initial + 3 retries = 4 total)
+            (0, nock_1.default)(testUrl).get('/').times(4).replyWithError({
+                code: 'ECONNREFUSED',
+                message: 'Connection refused',
+            });
+            const response = await axiosHttpClient.execute(Http_1.HttpMethod.Get, testUrl, Http_1.HttpRequest.create({
+                headers: {},
+                pathParams: {},
+                queryString: {},
+                body: BufferExtensions_1.BufferExtensions.arrayBufferToReadable(new ArrayBuffer(0)),
+            }))();
+            // Should eventually fail
+            expect(E.isRight(response)).toBe(true);
+            if (E.isRight(response)) {
+                // AxiosHttpClient converts connection errors to 500 responses
+                expect(response.right.statusCode).toBe(500);
+            }
+        });
+        test('should clamp retries to max value of 10', async () => {
+            const axiosHttpClient = new AxiosHttpClient_1.AxiosHttpClient(new NodeFsFileStorage_1.NodeFsFileStorage(), {
+                rejectUnauthorized: false,
+                followRedirects: true,
+                retries: 100, // Should be clamped to 10
+            });
+            const testUrl = 'http://test-clamp-retries.example.com';
+            // Fail 2 times, then succeed - verifies retries work with large value
+            (0, nock_1.default)(testUrl).get('/').times(2).replyWithError({
+                code: 'ECONNREFUSED',
+                message: 'Connection refused',
+            });
+            (0, nock_1.default)(testUrl).get('/').reply(200, { success: true });
+            const response = await axiosHttpClient.execute(Http_1.HttpMethod.Get, testUrl, Http_1.HttpRequest.create({
+                headers: {},
+                pathParams: {},
+                queryString: {},
+                body: BufferExtensions_1.BufferExtensions.arrayBufferToReadable(new ArrayBuffer(0)),
+            }))();
+            // Should succeed because retries are enabled (clamped to 10)
+            expect(E.isRight(response)).toBe(true);
+            if (E.isRight(response)) {
+                expect(response.right.statusCode).toBe(200);
+            }
+        });
+    });
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trayio/axios",
-  "version": "5.9.0",
+  "version": "5.10.0",
   "description": "Axios extensions and implementations",
   "exports": {
     "./*": "./dist/*.js"
@@ -14,8 +14,9 @@
     "access": "public"
   },
   "dependencies": {
-    "@trayio/commons": "5.9.0",
+    "@trayio/commons": "5.10.0",
     "axios": "1.12.0",
+    "axios-retry": "4.5.0",
     "form-data": "4.0.4"
   },
   "typesVersions": {