add missing shared config for clientIpHeader (#5473)

* add missing shared config for clientIpHeader

Author: ida613

packages/datadog-plugin-koa/test/index.spec.js

@@ -25,7 +25,16 @@ describe('Plugin', () => {
       })
 
       describe('without configuration', () => {
-        before(() => agent.load(['koa', 'http'], [{}, { client: false }]))
+        before(() => agent.load(
+          ['koa', 'http'],
+          [{}, { client: false }],
+          {
+            // this is needed to test the client IP header configuration and must be done before loading the tracer
+            // initially since we can't change the tracer config after it's loaded
+            clientIpEnabled: true,
+            clientIpHeader: 'x-custom-client-ip-header'
+          })
+        )
 
         after(() => agent.close({ ritmReset: false }))
 
@@ -216,6 +225,58 @@ describe('Plugin', () => {
           })
         })
 
+        it('should handle client IP header configuration', done => {
+          const app = new Koa()
+
+          app.use(async (ctx) => {
+            ctx.body = ''
+          })
+
+          appListener = app.listen(0, 'localhost', () => {
+            const port = appListener.address().port
+
+            agent
+              .use(traces => {
+                const spans = sort(traces[0])
+                expect(spans[0].meta).to.have.property('http.client_ip', '8.8.8.8')
+              })
+              .then(done)
+              .catch(done)
+
+            axios.get(`http://localhost:${port}/user`, {
+              headers: {
+                'x-custom-client-ip-header': '8.8.8.8'
+              }
+            }).catch(done)
+          })
+        })
+
+        it('should not add client IP tag when header is missing or a different header is used', done => {
+          const app = new Koa()
+
+          app.use(async (ctx) => {
+            ctx.body = ''
+          })
+
+          appListener = app.listen(0, 'localhost', () => {
+            const port = appListener.address().port
+
+            agent
+              .use(traces => {
+                const spans = sort(traces[0])
+                expect(spans[0].meta).to.not.have.property('http.client_ip')
+              })
+              .then(done)
+              .catch(done)
+
+            axios.get(`http://localhost:${port}/user`, {
+              headers: {
+                'x-other-custom-client-ip-header': '8.8.8.8'
+              }
+            }).catch(done)
+          })
+        })
+
         withVersions('koa', 'koa-route', routerVersion => {
           let koaRouter
 

packages/dd-trace/src/plugin_manager.js

@@ -133,6 +133,7 @@ module.exports = class PluginManager {
       dbmPropagationMode,
       dsmEnabled,
       clientIpEnabled,
+      clientIpHeader,
       memcachedCommandEnabled,
       ciVisibilityTestSessionName,
       ciVisAgentlessLogSubmissionEnabled,
@@ -148,6 +149,7 @@ module.exports = class PluginManager {
       site,
       url,
       headers: headerTags || [],
+      clientIpHeader,
       ciVisibilityTestSessionName,
       ciVisAgentlessLogSubmissionEnabled,
       isTestDynamicInstrumentationEnabled,

packages/dd-trace/test/plugins/util/web.spec.js

@@ -206,6 +206,39 @@ describe('plugins/util/web', () => {
         })
       })
 
+      it('should add custom client ip tag to the span when it is configured', () => {
+        req.headers['X-Forwad-For'] = '8.8.8.8'
+
+        config.clientIpEnabled = true
+        config.clientIpHeader = 'X-Forwad-For'
+
+        web.normalizeConfig(config)
+        web.instrument(tracer, config, req, res, 'test.request', span => {
+          const tags = span.context()._tags
+
+          res.end()
+
+          expect(tags).to.include({
+            [HTTP_CLIENT_IP]: '8.8.8.8'
+          })
+        })
+      })
+
+      it('should not add custom client ip tag to the span when it is not configured', () => {
+        req.headers['X-Forwad-For'] = '8.8.8.8'
+
+        config.clientIpEnabled = true
+
+        web.normalizeConfig(config)
+        web.instrument(tracer, config, req, res, 'test.request', span => {
+          const tags = span.context()._tags
+
+          res.end()
+
+          expect(tags).to.not.have.property(HTTP_CLIENT_IP)
+        })
+      })
+
       it('should not add client ip tag to the span when disabled', () => {
         req.headers['x-forwarded-for'] = '8.8.8.8'