✨[RUM-2158] Allow more flexible proxy URL (#2502)

* ✨Allow more flexible proxy URL * 👌use options parameter
DataDog · Nov 17, 2023 · 4d7e114 · 4d7e114
1 parent 3e9748b
commit 4d7e114
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 2 deletions.
diff --git a/packages/core/src/domain/configuration/configuration.ts b/packages/core/src/domain/configuration/configuration.ts
@@ -32,7 +32,7 @@ export interface InitConfiguration {
   storeContextsAcrossPages?: boolean | undefined
 
   // transport options
-  proxy?: string | undefined
+  proxy?: string | ProxyFn | undefined
   site?: string | undefined
 
   // tag and context options
@@ -49,6 +49,7 @@ export interface InitConfiguration {
   enableExperimentalFeatures?: string[] | undefined
   replica?: ReplicaUserConfiguration | undefined
   datacenter?: string
+  // TODO next major: remove this option and replace usages by proxyFn
   internalAnalyticsSubdomain?: string
 
   telemetryConfigurationSampleRate?: number
@@ -58,6 +59,12 @@ export interface InitConfiguration {
 // for this option.
 type GenericBeforeSendCallback = (event: any, context?: any) => unknown
 
+/**
+ * path: /api/vX/product
+ * parameters: xxx=yyy&zzz=aaa
+ */
+type ProxyFn = (options: { path: string; parameters: string }) => string
+
 interface ReplicaUserConfiguration {
   applicationId?: string
   clientToken: string

diff --git a/packages/core/src/domain/configuration/endpointBuilder.spec.ts b/packages/core/src/domain/configuration/endpointBuilder.spec.ts
@@ -82,6 +82,16 @@ describe('endpointBuilder', () => {
         )
       ).toBeTrue()
     })
+
+    it('should allow to fully control the proxy url', () => {
+      const proxyFn = (options: { path: string; parameters: string }) =>
+        `https://proxy.io/prefix${options.path}/suffix?${options.parameters}`
+      expect(
+        createEndpointBuilder({ ...initConfiguration, proxy: proxyFn }, 'rum', []).build('xhr', DEFAULT_PAYLOAD)
+      ).toMatch(
+        `https://proxy.io/prefix/api/v2/rum/suffix\\?ddsource=(.*)&ddtags=(.*)&dd-api-key=${clientToken}&dd-evp-origin-version=(.*)&dd-evp-origin=browser&dd-request-id=(.*)&batch_time=(.*)`
+      )
+    })
   })
 
   describe('tags', () => {

diff --git a/packages/core/src/domain/configuration/endpointBuilder.ts b/packages/core/src/domain/configuration/endpointBuilder.ts
@@ -41,10 +41,13 @@ function createEndpointUrlWithParametersBuilder(
 ): (parameters: string) => string {
   const path = `/api/v2/${trackType}`
   const proxy = initConfiguration.proxy
-  if (proxy) {
+  if (typeof proxy === 'string') {
     const normalizedProxyUrl = normalizeUrl(proxy)
     return (parameters) => `${normalizedProxyUrl}?ddforward=${encodeURIComponent(`${path}?${parameters}`)}`
   }
+  if (typeof proxy === 'function') {
+    return (parameters) => proxy({ path, parameters })
+  }
   const host = buildEndpointHost(initConfiguration)
   return (parameters) => `https://${host}${path}?${parameters}`
 }