Fix: updating remote config manager to send process_tags as an array (#7180)

* updating remote config manager to use tagsArray and test to expect an array

* removing serialize function and corresponding tests since it is no longer used.

Author: crysmags

integration-tests/remote_config.spec.js

@@ -56,22 +56,17 @@ describe('Remote config client id', () => {
 
           const processTags = client.client_tracer.process_tags
 
-          // Verify process_tags is an object
-          assert.strictEqual(typeof processTags, 'object')
+          // Verify process_tags is an array of strings
+          assert.ok(Array.isArray(processTags), 'process_tags should be an array')
 
           // Verify required process tags are present
-          assert.ok('entrypoint.basedir' in processTags)
-          assert.ok('entrypoint.name' in processTags)
-          assert.ok('entrypoint.type' in processTags)
-          assert.ok('entrypoint.workdir' in processTags)
+          assert.ok(processTags.some(tag => tag.startsWith('entrypoint.basedir:')))
+          assert.ok(processTags.some(tag => tag.startsWith('entrypoint.name:')))
+          assert.ok(processTags.some(tag => tag.startsWith('entrypoint.type:')))
+          assert.ok(processTags.some(tag => tag.startsWith('entrypoint.workdir:')))
 
           // Verify entrypoint.type has the expected value
-          assert.strictEqual(processTags['entrypoint.type'], 'script')
-
-          // Verify values are strings (not undefined)
-          assert.strictEqual(typeof processTags['entrypoint.name'], 'string')
-          assert.strictEqual(typeof processTags['entrypoint.workdir'], 'string')
-          assert.strictEqual(typeof processTags['entrypoint.basedir'], 'string')
+          assert.ok(processTags.some(tag => tag === 'entrypoint.type:script'))
           done()
         } catch (err) {
           done(err)

packages/dd-trace/src/process-tags/index.js

@@ -35,19 +35,24 @@ function getProcessTags () {
     ['package.json.name', pkg.name || undefined]
   ]
 
-  const serialized = serialize(tags)
+  const tagsArray = []
+  const tagsObject = {}
 
-  const tagsObject = tags.reduce((acc, [key, value]) => {
+  for (const [key, value] of tags) {
     if (value !== undefined) {
-      acc[key] = value
+      const sanitizedValue = sanitize(value)
+      tagsArray.push(`${key}:${sanitizedValue}`)
+      tagsObject[key] = sanitizedValue
     }
-    return acc
-  }, {})
+  }
+
+  const serialized = tagsArray.join(',')
 
   return {
     tags,
     serialized,
-    tagsObject
+    tagsObject,
+    tagsArray
   }
 }
 
@@ -64,17 +69,6 @@ module.exports.CRASH_TRACKING_FIELD_NAME = 'process_tags'
 
 // TODO: CLIENT_TRACE_STATISTICS_FIELD_NAME process_tags
 
-function serialize (tags) {
-  const intermediary = []
-  for (const [name, value] of tags) {
-    if (value === undefined) continue
-    intermediary.push(`${name}:${sanitize(value)}`)
-  }
-  return intermediary.join(',')
-}
-
-module.exports.serialize = serialize
-
 /**
  * Sanitize a process tag value
  *

packages/dd-trace/src/remote_config/manager.js

@@ -89,7 +89,7 @@ class RemoteConfigManager extends EventEmitter {
           app_version: config.version,
           extra_services: [],
           tags: Object.entries(tags).map((pair) => pair.join(':')),
-          [processTags.REMOTE_CONFIG_FIELD_NAME]: processTags.tagsObject
+          [processTags.REMOTE_CONFIG_FIELD_NAME]: processTags.tagsArray
         },
         capabilities: DEFAULT_CAPABILITY // updated by `updateCapabilities()`
       },

packages/dd-trace/test/process-tags.spec.js

@@ -9,7 +9,7 @@ require('./setup/core')
 
 describe('process-tags', () => {
   const processTags = require('../src/process-tags')
-  const { serialize, sanitize } = require('../src/process-tags')
+  const { sanitize } = require('../src/process-tags')
 
   describe('field name constants', () => {
     it('should define field names for different subsystems', () => {
@@ -125,88 +125,6 @@ describe('process-tags', () => {
     })
   })
 
-  describe('serialize', () => {
-    it('should serialize tags as name:value pairs joined by commas', () => {
-      const tags = [
-        ['tag1', 'value1'],
-        ['tag2', 'value2'],
-        ['tag3', 'value3']
-      ]
-
-      const result = serialize(tags)
-
-      assert.strictEqual(result, 'tag1:value1,tag2:value2,tag3:value3')
-    })
-
-    it('should filter out tags with undefined values', () => {
-      const tags = [
-        ['tag1', 'value1'],
-        ['tag2', undefined],
-        ['tag3', 'value3'],
-        ['tag4', undefined]
-      ]
-
-      const result = serialize(tags)
-
-      assert.strictEqual(result, 'tag1:value1,tag3:value3')
-      assert.doesNotMatch(result, /undefined/)
-    })
-
-    it('should sanitize tag values', () => {
-      const tags = [
-        ['tag1', 'Value With Spaces'],
-        ['tag2', 'UPPERCASE'],
-        ['tag3', 'special@chars!']
-      ]
-
-      const result = serialize(tags)
-
-      assert.strictEqual(result, 'tag1:value_with_spaces,tag2:uppercase,tag3:special_chars_')
-    })
-
-    it('should return empty string when all values are undefined', () => {
-      const tags = [
-        ['tag1', undefined],
-        ['tag2', undefined]
-      ]
-
-      const result = serialize(tags)
-
-      assert.strictEqual(result, '')
-    })
-
-    it('should handle empty tags array', () => {
-      const result = serialize([])
-
-      assert.strictEqual(result, '')
-    })
-
-    it('should handle numeric values', () => {
-      const tags = [
-        ['tag1', 123],
-        ['tag2', 456]
-      ]
-
-      const result = serialize(tags)
-
-      assert.strictEqual(result, 'tag1:123,tag2:456')
-    })
-
-    it('should handle mixed defined and undefined values', () => {
-      const tags = [
-        ['tag1', 'value1'],
-        ['tag2', undefined],
-        ['tag3', 'value3'],
-        ['tag4', undefined],
-        ['tag5', 'value5']
-      ]
-
-      const result = serialize(tags)
-
-      assert.strictEqual(result, 'tag1:value1,tag3:value3,tag5:value5')
-    })
-  })
-
   describe('sanitize', () => {
     it('should convert to lowercase', () => {
       assert.strictEqual(sanitize('UPPERCASE'), 'uppercase')

packages/dd-trace/test/remote_config/manager.spec.js

@@ -132,16 +132,16 @@ describe('RemoteConfigManager', () => {
     const clientTracer = rc.state.client.client_tracer
 
     assert.ok(clientTracer.process_tags, 'process_tags should exist')
-    assert.strictEqual(typeof clientTracer.process_tags, 'object')
+    assert.ok(Array.isArray(clientTracer.process_tags), 'process_tags should be an array')
 
     // Verify expected process tag keys are present
-    assert.ok('entrypoint.basedir' in clientTracer.process_tags)
-    assert.ok('entrypoint.name' in clientTracer.process_tags)
-    assert.ok('entrypoint.type' in clientTracer.process_tags)
-    assert.ok('entrypoint.workdir' in clientTracer.process_tags)
+    assert.ok(clientTracer.process_tags.some(tag => tag.startsWith('entrypoint.basedir:')))
+    assert.ok(clientTracer.process_tags.some(tag => tag.startsWith('entrypoint.name:')))
+    assert.ok(clientTracer.process_tags.some(tag => tag.startsWith('entrypoint.type:')))
+    assert.ok(clientTracer.process_tags.some(tag => tag.startsWith('entrypoint.workdir:')))
 
     // Verify entrypoint.type has expected value
-    assert.strictEqual(clientTracer.process_tags['entrypoint.type'], 'script')
+    assert.ok(clientTracer.process_tags.some(tag => tag === 'entrypoint.type:script'))
   })
 
   it('should add git metadata to tags if present', () => {