🧪️ TEST: Add diagnostics_channel test cases

package.json

@@ -50,8 +50,8 @@
     "build:esm:test": "cd test/esm && rm -rf node_modules && npm link ../.. && node index.js",
     "build:test": "npm run build && npm run build:cjs:test && npm run build:esm:test",
     "test": "vitest run",
-    "cov": "vitest run --coverage",
-    "ci": "npm run lint && npm run test && npm run build:test",
+    "cov": "vitest run --coverage --no-threads",
+    "ci": "npm run lint && npm run cov && npm run build:test",
     "contributor": "git-contributor",
     "prepack": "npm run build && rm -rf src/*.tsbuildinfo"
   },

src/Response.ts

@@ -17,8 +17,8 @@ export type HttpClientResponseMeta = {
     contentDownload: number;
     waiting: number;
   };
-  // remoteAddress: remoteAddress,
-  // remotePort: remotePort,
+  // remoteAddress: string,
+  // remotePort: number,
   // socketHandledRequests: socketHandledRequests,
   // socketHandledResponses: socketHandledResponses,
 };

test/diagnostics_channel.test.ts

@@ -0,0 +1,132 @@
+import { describe, it, beforeAll, afterAll } from 'vitest';
+import { strict as assert } from 'assert';
+import diagnosticsChannel from 'diagnostics_channel';
+import urllib from '../src';
+import { startServer } from './fixtures/server';
+import { sleep } from './utils';
+
+describe('diagnostics_channel.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 support trace socket info by undici:client:sendHeaders and undici:request:trailers', async () => {
+    const kRequests = Symbol('requests');
+    let lastRequestOpaque: any;
+    let kHandler: any;
+    function onMessage(message: any, name: string) {
+      if (name === 'undici:client:connected') {
+        console.log('%s %j', name, message.connectParams);
+        message.socket[kRequests] = 0;
+        return;
+      }
+      const { request, socket } = message;
+      if (!kHandler) {
+        const symbols = Object.getOwnPropertySymbols(request);
+        for (const symbol of symbols) {
+          if (symbol.description === 'handler') {
+            kHandler = symbol;
+            break;
+          }
+        }
+      }
+      const opaque = request[kHandler].opts.opaque;
+      if (opaque && name === 'undici:client:sendHeaders' && socket) {
+        socket[kRequests]++;
+        opaque.tracer.socket = {
+          localAddress: socket.localAddress,
+          localPort: socket.localPort,
+          remoteAddress: socket.remoteAddress,
+          remotePort: socket.remotePort,
+          remoteFamily: socket.remoteFamily,
+          timeout: socket.timeout,
+          bytesWritten: socket.bytesWritten,
+          bytesRead: socket.bytesRead,
+          requests: socket[kRequests],
+        };
+      }
+      // console.log('%s emit, %s %s, opaque: %j', name, request.method, request.origin, opaque);
+      lastRequestOpaque = opaque;
+      // console.log(request);
+    }
+    diagnosticsChannel.channel('undici:client:connected').subscribe(onMessage);
+    diagnosticsChannel.channel('undici:client:sendHeaders').subscribe(onMessage);
+    diagnosticsChannel.channel('undici:request:trailers').subscribe(onMessage);
+
+    let traceId = `mock-traceid-${Date.now()}`;
+    // _url = 'https://registry.npmmirror.com/';
+    let response = await urllib.request(_url, {
+      method: 'HEAD',
+      dataType: 'json',
+      opaque: {
+        tracer: { traceId },
+      },
+    });
+    assert.equal(response.status, 200);
+    assert(response.url.startsWith(_url));
+    assert(!response.redirected);
+    assert.equal(lastRequestOpaque.tracer.traceId, traceId);
+    assert(lastRequestOpaque.tracer.socket);
+    assert.equal(lastRequestOpaque.tracer.socket.requests, 1);
+
+    // HEAD 请求不会 keepalive
+    // GET 请求会走 keepalive
+    await sleep(1);
+    traceId = `mock-traceid-${Date.now()}`;
+    response = await urllib.request(_url, {
+      method: 'GET',
+      dataType: 'json',
+      opaque: {
+        tracer: { traceId },
+      },
+    });
+    assert.equal(response.status, 200);
+    assert.equal(lastRequestOpaque.tracer.traceId, traceId);
+    assert(lastRequestOpaque.tracer.socket);
+    assert.equal(lastRequestOpaque.tracer.socket.requests, 1);
+
+    await sleep(1);
+    traceId = `mock-traceid-${Date.now()}`;
+    response = await urllib.request(_url, {
+      method: 'GET',
+      dataType: 'json',
+      opaque: {
+        tracer: { traceId },
+      },
+    });
+    assert.equal(response.status, 200);
+    assert.equal(lastRequestOpaque.tracer.traceId, traceId);
+    assert(lastRequestOpaque.tracer.socket);
+    assert.equal(lastRequestOpaque.tracer.socket.requests, 2);
+
+    // socket 复用 1000 次
+    let count = 1000;
+    while (count-- > 0) {
+      await sleep(1);
+      traceId = `mock-traceid-${Date.now()}`;
+      response = await urllib.request(_url, {
+        method: 'GET',
+        dataType: 'json',
+        opaque: {
+          tracer: { traceId },
+        },
+      });
+      assert.equal(response.status, 200);
+      assert.equal(lastRequestOpaque.tracer.traceId, traceId);
+      assert(lastRequestOpaque.tracer.socket);
+      assert.equal(lastRequestOpaque.tracer.socket.requests, 2 + 1000 - count);
+    }
+
+    diagnosticsChannel.channel('undici:client:connected').unsubscribe(onMessage);
+    diagnosticsChannel.channel('undici:client:sendHeaders').unsubscribe(onMessage);
+    diagnosticsChannel.channel('undici:request:trailers').unsubscribe(onMessage);
+  });
+});