Merge pull request #1158 from DataDog/benoit/cache-proxy-agents

⚡️ [RUM-2721] cache proxy agents
DataDog · Jan 17, 2024 · 847c061 · 847c061
2 parents 4effb36 + 571ee4e
commit 847c061
Show file tree

Hide file tree

Showing 2 changed files with 31 additions and 16 deletions.
diff --git a/src/helpers/__tests__/utils.test.ts b/src/helpers/__tests__/utils.test.ts
@@ -102,22 +102,25 @@ describe('utils', () => {
 
     describe('proxy configuration', () => {
       test('should have a ProxyAgent by default', async () => {
-        jest.spyOn(axios, 'create').mockImplementation((() => (args: AxiosRequestConfig) => args.httpsAgent) as any)
-        const requestOptions = {
-          apiKey: 'apiKey',
-          appKey: 'applicationKey',
-          baseUrl: 'http://fake-base.url/',
-        }
-        const request = ciUtils.getRequestBuilder(requestOptions)
-        const fakeEndpoint = fakeEndpointBuilder(request)
-        const httpsAgent = await fakeEndpoint()
+        const httpsAgent = await getHttpAgentForProxyOptions()
         expect(httpsAgent).toBeDefined()
         expect(httpsAgent).toBeInstanceOf(ProxyAgent)
       })
 
       test('should add proxy configuration when explicitly defined', async () => {
+        const httpsAgent = await getHttpAgentForProxyOptions({protocol: 'http', host: '1.2.3.4', port: 1234})
+        expect(httpsAgent).toBeDefined()
+        expect((httpsAgent as any).getProxyForUrl()).toBe('http://1.2.3.4:1234')
+      })
+
+      test('should re-use the same proxy agent for the same proxy options', async () => {
+        const httpsAgent1 = await getHttpAgentForProxyOptions({protocol: 'http', host: '1.2.3.4', port: 1234})
+        const httpsAgent2 = await getHttpAgentForProxyOptions({protocol: 'http', host: '1.2.3.4', port: 1234})
+        expect(httpsAgent1).toBe(httpsAgent2)
+      })
+
+      const getHttpAgentForProxyOptions = async (proxyOpts?: ciUtils.ProxyConfiguration) => {
         jest.spyOn(axios, 'create').mockImplementation((() => (args: AxiosRequestConfig) => args.httpsAgent) as any)
-        const proxyOpts: ciUtils.ProxyConfiguration = {protocol: 'http', host: '1.2.3.4', port: 1234}
         const requestOptions = {
           apiKey: 'apiKey',
           appKey: 'applicationKey',
@@ -126,10 +129,9 @@ describe('utils', () => {
         }
         const request = ciUtils.getRequestBuilder(requestOptions)
         const fakeEndpoint = fakeEndpointBuilder(request)
-        const httpsAgent = await fakeEndpoint()
-        expect(httpsAgent).toBeDefined()
-        expect((httpsAgent as any).getProxyForUrl()).toBe('http://1.2.3.4:1234')
-      })
+
+        return fakeEndpoint()
+      }
     })
 
     test('should accept overrideUrl', async () => {

diff --git a/src/helpers/utils.ts b/src/helpers/utils.ts
@@ -209,9 +209,22 @@ export const getRequestBuilder = (options: RequestOptions) => {
   return (args: AxiosRequestConfig) => axios.create(baseConfiguration)(overrideArgs(args))
 }
 
+const proxyAgentCache = new Map<string, ProxyAgent>()
+
 export const getProxyAgent = (proxyOpts?: ProxyConfiguration): ProxyAgent => {
   const proxyUrlFromConfiguration = getProxyUrl(proxyOpts)
-  if (!proxyOpts || proxyUrlFromConfiguration === '') {
+
+  let proxyAgent = proxyAgentCache.get(proxyUrlFromConfiguration)
+  if (!proxyAgent) {
+    proxyAgent = createProxyAgentForUrl(proxyUrlFromConfiguration)
+    proxyAgentCache.set(proxyUrlFromConfiguration, proxyAgent)
+  }
+
+  return proxyAgent
+}
+
+const createProxyAgentForUrl = (proxyUrl: string) => {
+  if (!proxyUrl) {
     // Let the default proxy agent discover environment variables.
     return new ProxyAgent()
   }
@@ -223,7 +236,7 @@ export const getProxyAgent = (proxyOpts?: ProxyConfiguration): ProxyAgent => {
         return ''
       }
 
-      return proxyUrlFromConfiguration
+      return proxyUrl
     },
   })
 }