📦 NEW: Support options.timing = true

src/HttpClient.ts

@@ -144,6 +144,7 @@ export class HttpClient extends EventEmitter {
       keepAliveSocket: true,
       requestUrls: [],
       timing: {
+        waiting: 0,
         contentDownload: 0,
       },
     };
@@ -309,6 +310,10 @@ export class HttpClient extends EventEmitter {
 
       requestOptions.headers = headers;
       const response = await undiciRequest(requestUrl, requestOptions);
+      if (args.timing) {
+        res.timing.waiting = performanceTime(requestStartTime);
+      }
+
       const context = response.context as { history: URL[] };
       let lastUrl = '';
       if (context?.history) {
@@ -378,7 +383,10 @@ export class HttpClient extends EventEmitter {
           }
         }
       }
-      res.rt = res.timing.contentDownload = performanceTime(requestStartTime);
+      res.rt = performanceTime(requestStartTime);
+      if (args.timing) {
+        res.timing.contentDownload = res.rt;
+      }
 
       const clientResponse: HttpClientResponse = {
         data,
@@ -417,7 +425,10 @@ export class HttpClient extends EventEmitter {
       if (res.requestUrls.length === 0) {
         res.requestUrls.push(requestUrl.href);
       }
-      res.rt = res.timing.contentDownload = performanceTime(requestStartTime);
+      res.rt = performanceTime(requestStartTime);
+      if (args.timing) {
+        res.timing.contentDownload = res.rt;
+      }
       throw err;
     }
   }

src/Request.ts

@@ -119,9 +119,14 @@ export type RequestOptions = {
    * Alias to compressed
    * */
   gzip?: boolean;
-  /** Enable timing or not, default is false. */
+  /**
+   * @deprecated
+   * Enable timing or not, default is false.
+   * */
   timing?: boolean;
   /**
+   * @deprecated
+   * Not support on HTTPS
    * Custom DNS lookup function, default is dns.lookup.
    * Require node >= 4.0.0(for http protocol) and node >=8(for https protocol)
    */

src/Response.ts

@@ -15,6 +15,7 @@ export type HttpClientResponseMeta = {
    */
   timing: {
     contentDownload: number;
+    waiting: number;
   };
   // remoteAddress: remoteAddress,
   // remotePort: remotePort,

src/index.ts

@@ -14,4 +14,3 @@ export { HttpClient } from './HttpClient';
 export default {
   request,
 };
-

test/options.timing.test.ts

@@ -0,0 +1,54 @@
+import { strict as assert } from 'assert';
+import urllib from '../src';
+import { HttpClientResponseMeta } from '../src/Response';
+import { startServer } from './fixtures/server';
+
+describe('options.timing.test.ts', () => {
+  let close: any;
+  let _url: string;
+  beforeAll(async () => {
+    const { closeServer, url } = await startServer();
+    close = closeServer;
+    _url = url;
+  });
+
+  afterAll(async () => {
+    await close();
+  });
+
+  it('should timing = true work', async () => {
+    const response = await urllib.request(`${_url}?content-encoding=gzip`, {
+      dataType: 'json',
+      timing: true,
+    });
+    assert.equal(response.status, 200);
+    const res = response.res as HttpClientResponseMeta;
+    assert(res.timing.waiting > 0);
+    assert(res.timing.contentDownload > 0);
+    assert(res.timing.contentDownload > res.timing.waiting);
+    assert.equal(res.timing.contentDownload, res.rt);
+  });
+
+  it('should timing = false work', async () => {
+    const response = await urllib.request(`${_url}?content-encoding=gzip`, {
+      dataType: 'json',
+      timing: false,
+    });
+    assert.equal(response.status, 200);
+    const res = response.res as HttpClientResponseMeta;
+    assert.equal(res.timing.waiting, 0);
+    assert.equal(res.timing.contentDownload, 0);
+    assert(res.rt > 0);
+  });
+
+  it('should timing default to false', async () => {
+    const response = await urllib.request(`${_url}?content-encoding=gzip`, {
+      dataType: 'json',
+    });
+    assert.equal(response.status, 200);
+    const res = response.res as HttpClientResponseMeta;
+    assert.equal(res.timing.waiting, 0);
+    assert.equal(res.timing.contentDownload, 0);
+    assert(res.rt > 0);
+  });
+});