@trayio/axios 5.15.0 → 5.17.0

package/dist/http/AxiosHttpClient.d.ts

@@ -4,17 +4,18 @@ import { HttpMethod, HttpRequest, HttpResponse } from '@trayio/commons/http/Http
 import FormData = require('form-data');
 import { FileStorage } from '@trayio/commons/file/File';
 type AxiosOptions = {
-    rejectUnauthorized: boolean;
-    followRedirects: boolean;
+    rejectUnauthorized?: boolean;
+    followRedirects?: boolean;
     retries?: number;
     keepAlive?: boolean;
     maxSockets?: number;
+    timeout?: number;
 };
 export declare class AxiosHttpClient implements HttpClient {
     private readonly fileStorage;
-    private readonly axiosOptions;
     private readonly defaultHttpsAgent;
     private readonly axiosInstance;
+    private readonly resolvedOptions;
     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;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;IACjB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;CACpB,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;IAoCF,OAAO,CACN,MAAM,EAAE,UAAU,EAClB,GAAG,EAAE,MAAM,EACX,OAAO,EAAE,WAAW,GAClB,EAAE,CAAC,UAAU,CAAC,KAAK,EAAE,YAAY,CAAC;IA6GrC,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,CAAC,EAAE,OAAO,CAAC;IAC7B,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAWF,qBAAa,eAAgB,YAAW,UAAU;IAMhD,OAAO,CAAC,QAAQ,CAAC,WAAW;IAL7B,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAQ;IAC1C,OAAO,CAAC,QAAQ,CAAC,aAAa,CAA8B;IAC5D,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAuB;gBAGrC,WAAW,GAAE,WAAqC,EACnE,YAAY,GAAE,YAAiB;IAgDhC,OAAO,CACN,MAAM,EAAE,UAAU,EAClB,GAAG,EAAE,MAAM,EACX,OAAO,EAAE,WAAW,GAClB,EAAE,CAAC,UAAU,CAAC,KAAK,EAAE,YAAY,CAAC;IAsHrC,OAAO,CAAC,wBAAwB;IAmBhC,OAAO,CAAC,2BAA2B;IAUnC,YAAY,aAAc,QAAQ,cAAc,OAAO,MAAM,EAAE,MAAM,CAAC,cAKpE;CACF"}

package/dist/http/AxiosHttpClient.js

@@ -39,26 +39,33 @@ const BufferExtensions_1 = require("@trayio/commons/buffer/BufferExtensions");
 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,
-    }) {
+    resolvedOptions;
+    constructor(fileStorage = new NodeFsFileStorage_1.NodeFsFileStorage(), axiosOptions = {}) {
         this.fileStorage = fileStorage;
-        this.axiosOptions = axiosOptions;
+        // Resolve all defaults in one place
+        this.resolvedOptions = {
+            rejectUnauthorized: axiosOptions.rejectUnauthorized ?? false,
+            followRedirects: axiosOptions.followRedirects ?? true,
+            // Validate and clamp retries to 0-10 range, default to 0
+            retries: Math.max(0, Math.min(10, axiosOptions.retries ?? 0)),
+            keepAlive: axiosOptions.keepAlive ?? true,
+            maxSockets: axiosOptions.maxSockets,
+            /*	Default to 0 (no timeout) to match axios default and maintain
+                behavioural backwards compatibility with codebases already using
+                this module.	*/
+            // Users should explicitly set a timeout value (e.g., 30000 for 30s) if they need timeout protection.
+            timeout: axiosOptions.timeout ?? 0,
+        };
         // 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: this.axiosOptions.keepAlive || true,
+            keepAlive: this.resolvedOptions.keepAlive,
             keepAliveMsecs: 42000,
-            rejectUnauthorized: this.axiosOptions.rejectUnauthorized,
-            maxSockets: this.axiosOptions.maxSockets,
+            rejectUnauthorized: this.resolvedOptions.rejectUnauthorized,
+            maxSockets: this.resolvedOptions.maxSockets,
         });
-        // 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
@@ -70,7 +77,7 @@ class AxiosHttpClient {
         this.axiosInstance.defaults.headers.delete = {};
         // Configure retry behavior
         (0, axios_retry_1.default)(this.axiosInstance, {
-            retries,
+            retries: this.resolvedOptions.retries,
             retryDelay: axios_retry_1.exponentialDelay,
             retryCondition: (error) => 
             // Retry on network errors (ECONNREFUSED, ETIMEDOUT, etc.) and 5xx errors
@@ -96,10 +103,10 @@ class AxiosHttpClient {
         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: this.axiosOptions.keepAlive || true,
+            keepAlive: this.resolvedOptions.keepAlive,
             keepAliveMsecs: 42000,
-            rejectUnauthorized: this.axiosOptions.rejectUnauthorized,
-            maxSockets: this.axiosOptions.maxSockets,
+            rejectUnauthorized: this.resolvedOptions.rejectUnauthorized,
+            maxSockets: this.resolvedOptions.maxSockets,
         })));
         if (headers['content-type'] &&
             headers['content-type'].includes(Http_1.HttpContentType.MultipartRequestBody)) {
@@ -121,6 +128,8 @@ class AxiosHttpClient {
                 headers,
                 httpsAgent: axiosHttpsAgent,
                 params: request.queryString,
+                ...(this.resolvedOptions.followRedirects ? {} : { maxRedirects: 0 }),
+                timeout: (0, function_1.pipe)(request.timeout ?? O.none, O.getOrElse(() => this.resolvedOptions.timeout)),
             };
             return (0, Task_1.createTaskEitherFromPromiseWithSimpleError)(() => this.axiosInstance(axiosConfig)
                 .then(this.axiosResponseToHttpResponse)
@@ -134,7 +143,8 @@ class AxiosHttpClient {
             headers,
             httpsAgent: axiosHttpsAgent,
             params: request.queryString,
-            ...(this.axiosOptions.followRedirects ? {} : { maxRedirects: 0 }),
+            ...(this.resolvedOptions.followRedirects ? {} : { maxRedirects: 0 }),
+            timeout: (0, function_1.pipe)(request.timeout ?? O.none, O.getOrElse(() => this.resolvedOptions.timeout)),
         };
         return (0, Task_1.createTaskEitherFromPromiseWithSimpleError)(() => this.axiosInstance(axiosConfig)
             .then(this.axiosResponseToHttpResponse)

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

@@ -28,6 +28,7 @@ var __importDefault = (this && this.__importDefault) || function (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 O = __importStar(require("fp-ts/Option"));
 const E = __importStar(require("fp-ts/Either"));
 const Http_1 = require("@trayio/commons/http/Http");
 const BufferExtensions_1 = require("@trayio/commons/buffer/BufferExtensions");
@@ -196,4 +197,163 @@ describe('AxiosHttpClient Tests', () => {
             }
         });
     });
+    describe('Timeout mechanism', () => {
+        afterEach(() => {
+            nock_1.default.cleanAll();
+        });
+        test('should timeout when request exceeds configured timeout', async () => {
+            const axiosHttpClient = new AxiosHttpClient_1.AxiosHttpClient(new NodeFsFileStorage_1.NodeFsFileStorage(), {
+                rejectUnauthorized: false,
+                followRedirects: true,
+                timeout: 50, // 50ms timeout (smaller = faster test)
+            });
+            const testUrl = 'http://test-timeout.example.com';
+            // Mock a slow response with much larger delay for reliability
+            (0, nock_1.default)(testUrl)
+                .get('/')
+                .delay(500) // 500ms delay >> 50ms timeout (10x margin)
+                .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 due to timeout
+            expect(E.isRight(response)).toBe(true);
+            if (E.isRight(response)) {
+                // AxiosHttpClient converts timeout errors to 500 responses
+                expect(response.right.statusCode).toBe(500);
+            }
+        });
+        test('should use default timeout of 0 (no timeout) when not specified', async () => {
+            const axiosHttpClient = new AxiosHttpClient_1.AxiosHttpClient(new NodeFsFileStorage_1.NodeFsFileStorage(), {
+                rejectUnauthorized: false,
+                followRedirects: true,
+                // timeout not specified, should default to 0 (matching axios default)
+            });
+            // Verify the resolved timeout is 0 (no timeout, matching axios default)
+            // Using bracket notation to access private field in tests (TypeScript allows this for dynamic access)
+            const resolvedTimeout = axiosHttpClient['resolvedOptions'].timeout;
+            expect(resolvedTimeout).toBe(0);
+            const testUrl = 'http://test-default-timeout.example.com';
+            // Also verify it works functionally - request succeeds (no timeout)
+            (0, nock_1.default)(testUrl)
+                .get('/')
+                .delay(50) // Fast response
+                .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 allow custom timeout values', async () => {
+            const axiosHttpClient = new AxiosHttpClient_1.AxiosHttpClient(new NodeFsFileStorage_1.NodeFsFileStorage(), {
+                rejectUnauthorized: false,
+                followRedirects: true,
+                timeout: 5000, // 5 second custom timeout
+            });
+            const testUrl = 'http://test-custom-timeout.example.com';
+            (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 use per-request timeout when provided, overriding constructor timeout', async () => {
+            const axiosHttpClient = new AxiosHttpClient_1.AxiosHttpClient(new NodeFsFileStorage_1.NodeFsFileStorage(), {
+                rejectUnauthorized: false,
+                followRedirects: true,
+                timeout: 5000, // 5 second constructor-level timeout (long)
+            });
+            const testUrl = 'http://test-per-request-timeout.example.com';
+            // Mock a slow response (500ms delay)
+            (0, nock_1.default)(testUrl)
+                .get('/')
+                .delay(500) // 500ms delay
+                .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)),
+                timeout: O.some(50), // 50ms per-request timeout (short) - should override constructor timeout
+            }))();
+            // Should timeout because per-request timeout (50ms) is used instead of constructor timeout (5000ms)
+            expect(E.isRight(response)).toBe(true);
+            if (E.isRight(response)) {
+                // AxiosHttpClient converts timeout errors to 500 responses
+                expect(response.right.statusCode).toBe(500);
+            }
+        });
+        test('should use constructor timeout when per-request timeout is O.none', async () => {
+            const axiosHttpClient = new AxiosHttpClient_1.AxiosHttpClient(new NodeFsFileStorage_1.NodeFsFileStorage(), {
+                rejectUnauthorized: false,
+                followRedirects: true,
+                timeout: 50, // 50ms constructor-level timeout (short)
+            });
+            const testUrl = 'http://test-none-timeout.example.com';
+            // Mock a slow response (500ms delay)
+            (0, nock_1.default)(testUrl)
+                .get('/')
+                .delay(500) // 500ms delay
+                .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)),
+                timeout: O.none, // No per-request timeout - should use constructor timeout (50ms)
+            }))();
+            // Should timeout because constructor timeout (50ms) is used
+            expect(E.isRight(response)).toBe(true);
+            if (E.isRight(response)) {
+                // AxiosHttpClient converts timeout errors to 500 responses
+                expect(response.right.statusCode).toBe(500);
+            }
+        });
+        test('should use constructor timeout when timeout field is omitted (backward compatibility)', async () => {
+            const axiosHttpClient = new AxiosHttpClient_1.AxiosHttpClient(new NodeFsFileStorage_1.NodeFsFileStorage(), {
+                rejectUnauthorized: false,
+                followRedirects: true,
+                timeout: 50, // 50ms constructor-level timeout (short)
+            });
+            const testUrl = 'http://test-omitted-timeout.example.com';
+            // Mock a slow response (500ms delay)
+            (0, nock_1.default)(testUrl)
+                .get('/')
+                .delay(500) // 500ms delay
+                .reply(200, { success: true });
+            // Create request without timeout field (backward compatible with old code)
+            const request = {
+                headers: {},
+                pathParams: {},
+                queryString: {},
+                body: BufferExtensions_1.BufferExtensions.arrayBufferToReadable(new ArrayBuffer(0)),
+                headerOptions: O.none,
+                agent: O.none,
+                clientIp: O.none,
+                // timeout field omitted - should use constructor timeout (50ms)
+            };
+            const response = await axiosHttpClient.execute(Http_1.HttpMethod.Get, testUrl, request)();
+            // Should timeout because constructor timeout (50ms) is used
+            expect(E.isRight(response)).toBe(true);
+            if (E.isRight(response)) {
+                // AxiosHttpClient converts timeout errors to 500 responses
+                expect(response.right.statusCode).toBe(500);
+            }
+        });
+    });
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trayio/axios",
-  "version": "5.15.0",
+  "version": "5.17.0",
   "description": "Axios extensions and implementations",
   "exports": {
     "./*": "./dist/*.js"
@@ -14,7 +14,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@trayio/commons": "5.15.0",
+    "@trayio/commons": "5.17.0",
     "axios": "1.13.5",
     "axios-retry": "4.5.0",
     "form-data": "4.0.4"