feat: update http/https/socks agents

Author: zkochan

network/agent/agent.spec.ts

@@ -5,7 +5,6 @@ jest.mock('agentkeepalive', () => {
   MockHttp['HttpsAgent'] = mockHttpAgent('https')
   return MockHttp
 })
-jest.mock('https-proxy-agent', () => mockHttpAgent('https-proxy'))
 
 function mockHttpAgent (type: string) {
   return function Agent (opts: any) { // eslint-disable-line @typescript-eslint/no-explicit-any
@@ -55,8 +54,9 @@ test('all expected options passed down to proxy agent', () => {
     noProxy: 'qar.com, bar.com',
     ...OPTS,
   }
-  expect((getAgent('https://foo.com/bar', opts) as any).proxy).toEqual({
-    ALPNProtocols: ['http 1.1'],
+  const agent = (getAgent('https://foo.com/bar', opts) as any)
+  expect(agent.connectOpts).toEqual({
+    ALPNProtocols: ['http/1.1'],
     auth: 'user:pass',
     ca: 'ca',
     cert: 'cert',
@@ -65,10 +65,10 @@ test('all expected options passed down to proxy agent', () => {
     localAddress: 'localAddress',
     maxSockets: 5,
     port: 1234,
-    protocol: 'https:',
     rejectUnauthorized: true,
     timeout: 6,
   })
+  expect(agent.proxy.protocol).toEqual('https:')
 })
 
 test("don't use a proxy when the URL is in noProxy", () => {
@@ -225,4 +225,4 @@ test('select correct client certificates when host has a path and the cert conta
     timeout: 0,
     __type: 'https',
   })
-})
+})

network/proxy-agent/proxy-agent.spec.ts

@@ -1,5 +1,5 @@
 import { getProxyAgent } from './proxy-agent';
-import SocksProxyAgent from 'socks-proxy-agent'
+import { SocksProxyAgent } from 'socks-proxy-agent'
 
 jest.mock('agentkeepalive', () => {
   const MockHttp = mockHttpAgent('http')
@@ -33,8 +33,9 @@ test('all expected options passed down to proxy agent', () => {
     noProxy: 'qar.com, bar.com',
     ...OPTS,
   }
-  expect((getProxyAgent('https://foo.com/bar', opts) as any).proxy).toEqual({
-    ALPNProtocols: ['http 1.1'],
+  const agent = (getProxyAgent('https://foo.com/bar', opts) as any)
+  expect(agent.connectOpts).toEqual({
+    ALPNProtocols: ['http/1.1'],
     auth: 'user:pass',
     ca: 'ca',
     cert: 'cert',
@@ -43,10 +44,10 @@ test('all expected options passed down to proxy agent', () => {
     localAddress: 'localAddress',
     maxSockets: 5,
     port: 1234,
-    protocol: 'https:',
     rejectUnauthorized: true,
     timeout: 6,
   })
+  expect(agent.proxy.protocol).toEqual('https:')
 })
 
 test('a socks proxy', () => {
@@ -68,8 +69,9 @@ test('proxy credentials are decoded', () => {
     httpsProxy: `https://${encodeURIComponent('use@!r')}:${encodeURIComponent('p#as*s')}@my.proxy:1234/foo`,
     ...OPTS,
   }
-  expect((getProxyAgent('https://foo.com/bar', opts) as any).proxy).toEqual({
-    ALPNProtocols: ['http 1.1'],
+  const agent = (getProxyAgent('https://foo.com/bar', opts) as any)
+  expect(agent.connectOpts).toEqual({
+    ALPNProtocols: ['http/1.1'],
     auth: 'use@!r:p#as*s',
     ca: 'ca',
     cert: 'cert',
@@ -78,10 +80,11 @@ test('proxy credentials are decoded', () => {
     localAddress: 'localAddress',
     maxSockets: 5,
     port: 1234,
-    protocol: 'https:',
+    // protocol: 'https:',
     rejectUnauthorized: true,
     timeout: 6,
   })
+  expect(agent.proxy.protocol).toEqual('https:')
 })
 
 test('proxy credentials are decoded', () => {

network/proxy-agent/proxy-agent.ts

@@ -1,7 +1,7 @@
 import { PnpmError } from '@pnpm/error'
-import HttpsProxyAgent from 'https-proxy-agent/dist/agent'
-import createHttpProxyAgent from 'http-proxy-agent'
-import createSocksProxyAgent from 'socks-proxy-agent'
+import { HttpsProxyAgent } from 'https-proxy-agent'
+import { HttpProxyAgent } from 'http-proxy-agent'
+import { SocksProxyAgent } from 'socks-proxy-agent'
 import LRU from 'lru-cache'
 
 const DEFAULT_MAX_SOCKETS = 50
@@ -115,13 +115,9 @@ function getProxy (
     auth: getAuth(proxyUrl),
     ca: opts.ca,
     cert: opts.cert,
-    host: proxyUrl.hostname,
     key: opts.key,
     localAddress: opts.localAddress,
     maxSockets: opts.maxSockets ?? DEFAULT_MAX_SOCKETS,
-    path: proxyUrl.pathname,
-    port: proxyUrl.port,
-    protocol: proxyUrl.protocol,
     rejectUnauthorized: opts.strictSsl,
     timeout:
       typeof opts.timeout !== 'number' || opts.timeout === 0
@@ -131,13 +127,13 @@ function getProxy (
 
   if (proxyUrl.protocol === 'http:' || proxyUrl.protocol === 'https:') {
     if (!isHttps) {
-      return createHttpProxyAgent(popts)
+      return new HttpProxyAgent(proxyUrl, popts)
     } else {
-      return new PatchedHttpsProxyAgent(popts)
+      return new PatchedHttpsProxyAgent(proxyUrl, popts)
     }
   }
   if (proxyUrl.protocol?.startsWith('socks')) {
-    return createSocksProxyAgent(popts)
+    return new SocksProxyAgent(proxyUrl, popts)
   }
   return undefined
 }
@@ -156,14 +152,14 @@ function getAuth (user: { username?: string, password?: string }) {
 const extraOpts = Symbol('extra agent opts')
 
 // This is a workaround for this issue: https://github.com/TooTallNate/node-https-proxy-agent/issues/89
-class PatchedHttpsProxyAgent extends HttpsProxyAgent {
-  constructor (opts: any) {
-    super(opts)
+class PatchedHttpsProxyAgent<Uri extends string> extends HttpsProxyAgent<Uri> {
+  constructor (proxyUrl: Uri | URL, opts: any) {
+    super(proxyUrl, opts)
 
     this[extraOpts] = opts
   }
 
-  callback (req: any, opts: any) {
-    return super.callback(req, { ...this[extraOpts], ...opts })
+  connect (req: any, opts: any) {
+    return super.connect(req, { ...this[extraOpts], ...opts })
   }
 }