urllib 3.20.0 → 3.22.0

package/src/diagnosticsChannel.ts

@@ -35,9 +35,25 @@ function formatSocket(socket: Socket) {
     localPort: socket[symbols.kSocketLocalPort],
     remoteAddress: socket.remoteAddress,
     remotePort: socket.remotePort,
+    attemptedAddresses: socket.autoSelectFamilyAttemptedAddresses,
+    connecting: socket.connecting,
   };
 }
 
+// make sure error contains socket info
+const kDestroy = Symbol('kDestroy');
+Socket.prototype[kDestroy] = Socket.prototype.destroy;
+Socket.prototype.destroy = function(err?: any) {
+  if (err) {
+    Object.defineProperty(err, symbols.kErrorSocket, {
+      // don't show on console log
+      enumerable: false,
+      value: this,
+    });
+  }
+  return this[kDestroy](err);
+};
+
 export function initDiagnosticsChannel() {
   // makre sure init global DiagnosticsChannel once
   if (initedDiagnosticsChannel) return;
@@ -67,10 +83,37 @@ export function initDiagnosticsChannel() {
   });
 
   // diagnosticsChannel.channel('undici:client:beforeConnect')
-  // diagnosticsChannel.channel('undici:client:connectError')
+
+  subscribe('undici:client:connectError', (message, name) => {
+    const { error, connectParams } = message as DiagnosticsChannel.ClientConnectErrorMessage & { error: any };
+    let { socket } = message as DiagnosticsChannel.ClientConnectErrorMessage;
+    if (!socket && error[symbols.kErrorSocket]) {
+      socket = error[symbols.kErrorSocket];
+    }
+    if (socket) {
+      socket[symbols.kSocketId] = globalId('UndiciSocket');
+      socket[symbols.kSocketConnectErrorTime] = new Date();
+      socket[symbols.kHandledRequests] = 0;
+      socket[symbols.kHandledResponses] = 0;
+      // copy local address to symbol, avoid them be reset after request error throw
+      if (socket.localAddress) {
+        socket[symbols.kSocketLocalAddress] = socket.localAddress;
+        socket[symbols.kSocketLocalPort] = socket.localPort;
+      }
+      socket[symbols.kSocketConnectProtocol] = connectParams.protocol;
+      socket[symbols.kSocketConnectHost] = connectParams.host;
+      socket[symbols.kSocketConnectPort] = connectParams.port;
+      debug('[%s] Socket#%d connectError, connectParams: %o, error: %s, (sock: %o)',
+        name, socket[symbols.kSocketId], connectParams, (error as Error).message, formatSocket(socket));
+    } else {
+      debug('[%s] connectError, connectParams: %o, error: %o',
+        name, connectParams, error);
+    }
+  });
+
   // This message is published after a connection is established.
   subscribe('undici:client:connected', (message, name) => {
-    const { socket } = message as DiagnosticsChannel.ClientConnectedMessage;
+    const { socket, connectParams } = message as DiagnosticsChannel.ClientConnectedMessage;
     socket[symbols.kSocketId] = globalId('UndiciSocket');
     socket[symbols.kSocketStartTime] = performance.now();
     socket[symbols.kSocketConnectedTime] = new Date();
@@ -79,6 +122,9 @@ export function initDiagnosticsChannel() {
     // copy local address to symbol, avoid them be reset after request error throw
     socket[symbols.kSocketLocalAddress] = socket.localAddress;
     socket[symbols.kSocketLocalPort] = socket.localPort;
+    socket[symbols.kSocketConnectProtocol] = connectParams.protocol;
+    socket[symbols.kSocketConnectHost] = connectParams.host;
+    socket[symbols.kSocketConnectPort] = connectParams.port;
     debug('[%s] Socket#%d connected (sock: %o)', name, socket[symbols.kSocketId], formatSocket(socket));
   });
 

package/src/index.ts

@@ -2,25 +2,29 @@ import LRU from 'ylru';
 import { HttpClient, HEADER_USER_AGENT } from './HttpClient.js';
 import { RequestOptions, RequestURL } from './Request.js';
 
-let httpclient: HttpClient;
-const domainSocketHttpclients = new LRU(50);
+let httpClient: HttpClient;
+const domainSocketHttpClients = new LRU(50);
+
+export function getDefaultHttpClient(): HttpClient {
+  if (!httpClient) {
+    httpClient = new HttpClient();
+  }
+  return httpClient;
+}
 
 export async function request<T = any>(url: RequestURL, options?: RequestOptions) {
   if (options?.socketPath) {
-    let domainSocketHttpclient = domainSocketHttpclients.get<HttpClient>(options.socketPath);
+    let domainSocketHttpclient = domainSocketHttpClients.get<HttpClient>(options.socketPath);
     if (!domainSocketHttpclient) {
       domainSocketHttpclient = new HttpClient({
         connect: { socketPath: options.socketPath },
       });
-      domainSocketHttpclients.set(options.socketPath, domainSocketHttpclient);
+      domainSocketHttpClients.set(options.socketPath, domainSocketHttpclient);
     }
     return await domainSocketHttpclient.request<T>(url, options);
   }
 
-  if (!httpclient) {
-    httpclient = new HttpClient({});
-  }
-  return await httpclient.request<T>(url, options);
+  return await getDefaultHttpClient().request<T>(url, options);
 }
 
 // export curl method is keep compatible with urllib.curl()
@@ -36,12 +40,12 @@ export {
   MockAgent, ProxyAgent, Agent, Dispatcher,
   setGlobalDispatcher, getGlobalDispatcher,
 } from 'undici';
-// HttpClient2 is keep compatible with urlib@2 HttpClient2
+// HttpClient2 is keep compatible with urllib@2 HttpClient2
 export {
   HttpClient, HttpClient as HttpClient2, HEADER_USER_AGENT as USER_AGENT,
   RequestDiagnosticsMessage, ResponseDiagnosticsMessage,
 } from './HttpClient.js';
-// RequestOptions2 is keep compatible with urlib@2 RequestOptions2
+// RequestOptions2 is keep compatible with urllib@2 RequestOptions2
 export {
   RequestOptions, RequestOptions as RequestOptions2, RequestURL, HttpMethod,
   FixJSONCtlCharsHandler, FixJSONCtlChars,
@@ -53,6 +57,7 @@ export {
 export {
   IncomingHttpHeaders,
 } from './IncomingHttpHeaders.js';
+export * from './HttpClientError.js';
 
 export default {
   request,

package/src/symbols.ts

@@ -2,9 +2,13 @@ export default {
   kSocketId: Symbol('socket id'),
   kSocketStartTime: Symbol('socket start time'),
   kSocketConnectedTime: Symbol('socket connected time'),
+  kSocketConnectErrorTime: Symbol('socket connectError time'),
   kSocketRequestEndTime: Symbol('socket request end time'),
   kSocketLocalAddress: Symbol('socket local address'),
   kSocketLocalPort: Symbol('socket local port'),
+  kSocketConnectHost: Symbol('socket connect params: host'),
+  kSocketConnectPort: Symbol('socket connect params: port'),
+  kSocketConnectProtocol: Symbol('socket connect params: protocol'),
   kHandledRequests: Symbol('handled requests per socket'),
   kHandledResponses: Symbol('handled responses per socket'),
   kRequestSocket: Symbol('request on the socket'),
@@ -13,4 +17,5 @@ export default {
   kEnableRequestTiming: Symbol('enable request timing or not'),
   kRequestTiming: Symbol('request timing'),
   kRequestOriginalOpaque: Symbol('request original opaque'),
+  kErrorSocket: Symbol('socket of error'),
 };