Add readTimeout

lib/httpBlock.ts

@@ -103,6 +103,10 @@ export interface DescriptHttpBlockDescription<
     servername?: DescriptHttpBlockDescriptionCallback<DescriptRequestOptions['servername'], Params, Context>;
     timeout?: DescriptHttpBlockDescriptionCallback<DescriptRequestOptions['timeout'], Params, Context>;
 
+    // Отдельный таймаут на чтение ответа. Если не указан, то используется общий таймаут.
+    // Если указан, то после получения первого байта из ответа общий таймаут сбрасывается и выставляется новый только на чтение.
+    readTimeout?: DescriptHttpBlockDescriptionCallback<DescriptRequestOptions['readTimeout'], Params, Context>;
+
     query?: HttpQuery<Params, Context> | Array<HttpQuery<Params, Context>>;
 
     headers?: HttpHeaders<Params, Context> | Array<HttpHeaders<Params, Context>>;
@@ -134,6 +138,7 @@ const EVALUABLE_PROPS: Array<keyof Pick<DescriptRequestOptions, 'agent' |
   'pfx' |
   'port' |
   'protocol' |
+  'readTimeout' |
   'rejectUnauthorized' |
   'secureProtocol' |
   'servername' |
@@ -154,6 +159,7 @@ const EVALUABLE_PROPS: Array<keyof Pick<DescriptRequestOptions, 'agent' |
     'pfx',
     'port',
     'protocol',
+    'readTimeout',
     'rejectUnauthorized',
     'secureProtocol',
     'servername',

lib/request.ts

@@ -74,6 +74,7 @@ export interface DescriptRequestOptions {
         name: string;
     };
 
+    readTimeout?: number;
     timeout?: number;
 
     bodyCompress?: ZlibOptions;
@@ -135,6 +136,7 @@ export class RequestOptions {
     isError: DescriptRequestOptions['isError'];
     isRetryAllowed: DescriptRequestOptions['isRetryAllowed'];
     maxRetries: number;
+    readTimeout: DescriptRequestOptions['readTimeout'];
     retries: number;
     retryTimeout: number;
     timeout: DescriptRequestOptions['timeout'];
@@ -159,6 +161,7 @@ export class RequestOptions {
         this.retries = options.retries || 0;
 
         this.timeout = options.timeout;
+        this.readTimeout = options.readTimeout;
         this.bodyCompress = options.bodyCompress;
 
         this.httpOptions = {};
@@ -293,7 +296,7 @@ class DescriptRequest {
     logger: LoggerInterface<LoggerEvent>;
     cancel: Cancel;
     timestamps: EventTimestamps;
-    hTimeout: number | null;
+    hTimeout: NodeJS.Timeout | null;
     req?: http.ClientRequest;
     isResolved: boolean;
 
@@ -466,8 +469,9 @@ class DescriptRequest {
         this.doFail(error);
     }
 
-    setTimeout() {
-        if ((this.options.timeout || 0) > 0) {
+    setTimeout(customTimeout?: number) {
+        const timeout = customTimeout || this.options.timeout || 0;
+        if (timeout > 0) {
             this.hTimeout = setTimeout(() => {
                 let error;
                 if (!this.timestamps.tcpConnection) {
@@ -480,7 +484,7 @@ class DescriptRequest {
 
                 this.doCancel(error);
 
-            }, this.options.timeout) as unknown as number;
+            }, timeout);
         }
     }
 
@@ -500,6 +504,13 @@ class DescriptRequest {
     async requestHandler(res: http.IncomingMessage): Promise<DescriptHttpResult> {
         res.once('readable', () => {
             this.timestamps.firstByte = Date.now();
+
+            // Если есть отдельный таймаут на чтение, то после получения первого байта,
+            // нужно сбросить общий таймаут и создать новый.
+            if (this.options.readTimeout) {
+                this.clearTimeout();
+                this.setTimeout(this.options.readTimeout);
+            }
         });
 
         const unzipped = decompressResponse(res);

tests/request.test.ts

@@ -715,6 +715,48 @@ describe('request', () => {
                 }
             });
 
+            it('200, timeout, readTimeout, slow response', async() => {
+                const path = getPath();
+
+                fake.add(path, async(req: http.IncomingMessage, res: http.ServerResponse) => {
+                    res.statusCode = 200;
+                    res.write('Привет!');
+                    await waitForValue(null, 100);
+                    res.end();
+                });
+
+                const result = await doRequest({
+                    pathname: path,
+                    timeout: 50,
+                    readTimeout: 150,
+                });
+                expect(result.body?.toString()).toBe('Привет!');
+            });
+
+            it('200, timeout, readTimeout, incomplete response', async() => {
+                const path = getPath();
+
+                fake.add(path, async(req: http.IncomingMessage, res: http.ServerResponse) => {
+                    res.statusCode = 200;
+                    res.write('Привет!');
+                    await waitForValue(null, 100);
+                    res.end();
+                });
+
+                expect.assertions(2);
+                try {
+                    await doRequest({
+                        pathname: path,
+                        timeout: 50,
+                        readTimeout: 90,
+                    });
+
+                } catch (error) {
+                    expect(de.isError(error)).toBe(true);
+                    expect(error.error.id).toBe(de.ERROR_ID.REQUEST_TIMEOUT);
+                }
+            });
+
         });
 
         describe('content-encoding', () => {