[#404] Configuration Reconstructing

Author: feelform

lib/config-builder.js

@@ -9,6 +9,7 @@
 const fs = require('fs')
 const path = require('path')
 const { randomBytes } = require('node:crypto')
+const { levels } = require('loglevel')
 
 class Config {
     constructor(config) {
@@ -52,13 +53,12 @@ class ConfigBuilder {
             this.userDefinedJson = this.userDefinedJsonFromFile()
         }
 
-        const config = Object.assign({},
+        const config = mergeConfig(
             this.defaultJson,
             this.userDefinedJson,
             makeEnvironmentConfig(),
             this.agentStartupUserDefinedJson
         )
-
         for (const handler of this.handlers) {
             const changes = handler.handle(config)
             applyConfigChanges(config, changes)
@@ -140,22 +140,37 @@ class ApplicationNameValidator {
 }
 
 function makeEnvironmentConfig() {
-    return {
+    const envConfig = {
         agentId: valueOfString('PINPOINT_AGENT_ID'),
         agentName: valueOfString('PINPOINT_AGENT_NAME'),
         applicationName: valueOfString('PINPOINT_APPLICATION_NAME'),
         applicationServiceType: valueOfNumber('PINPOINT_SERVICE_TYPE'),
-        collector: makeCollectorEnvironmentConfig(),
-        sampling: makeSamplingEnvironmentConfig(),
+        collector: {
+            ip: valueOfString('PINPOINT_COLLECTOR_IP'),
+            spanPort: valueOfNumber('PINPOINT_COLLECTOR_SPAN_PORT'),
+            statPort: valueOfNumber('PINPOINT_COLLECTOR_STAT_PORT'),
+            tcpPort: valueOfNumber('PINPOINT_COLLECTOR_TCP_PORT'),
+        },
+        sampling: {
+            "enable": valueOfBoolean('PINPOINT_SAMPLING'),
+            rate: valueOfNumber('PINPOINT_SAMPLING_RATE')
+        },
         features: {
             container: valueOfBoolean('PINPOINT_CONTAINER'),
             logLevels: makeLogLevelsEnvironmentConfig(),
-            traceExclusionUrl: makeTraceExclusionUrlEnvironmentConfig(),
+            traceExclusionUrl: {
+                patterns: valueOfString('PINPOINT_TRACE_EXCLUSION_URL_PATTERNS'),
+                cacheSize: valueOfNumber('PINPOINT_TRACE_EXCLUSION_URL_CACHE_SIZE')
+            },
             sqlStats: valueOfBoolean('PINPOINT_PROFILER_SQL_STAT')
         },
-        plugins: makePluginsEnvironmentConfig(),
+        plugins: {
+            httpErrorStatusCodes: valueOfString('PINPOINT_HTTP_STATUS_CODE_ERRORS')
+        },
         enable: valueOfBoolean('PINPOINT_ENABLE')
     }
+
+    return pruneUndefined(envConfig)
 }
 
 function valueOfString(envName) {
@@ -173,25 +188,6 @@ function valueOfBoolean(envName) {
     return typeof value === 'string' ? value.toLowerCase() === 'true' : undefined
 }
 
-function makeCollectorEnvironmentConfig() {
-    return {
-        ip: valueOfString('PINPOINT_COLLECTOR_IP'),
-        spanPort: valueOfNumber('PINPOINT_COLLECTOR_SPAN_PORT'),
-        statPort: valueOfNumber('PINPOINT_COLLECTOR_STAT_PORT'),
-        tcpPort: valueOfNumber('PINPOINT_COLLECTOR_TCP_PORT'),
-    }
-}
-
-function makeSamplingEnvironmentConfig() {
-    const samplingEnable = valueOfBoolean('PINPOINT_SAMPLING')
-    if (!samplingEnable) {
-        return
-    }
-
-    return {
-        rate: valueOfNumber('PINPOINT_SAMPLING_RATE')
-    }
-}
 
 function makeLogLevelsEnvironmentConfig() {
     const value = process.env['PINPOINT_LOGGER_LEVELS']
@@ -223,17 +219,60 @@ function makeLogLevelsEnvironmentConfig() {
     return Object.keys(loggerLevels).length > 0 ? loggerLevels : undefined
 }
 
-function makeTraceExclusionUrlEnvironmentConfig() {
-    return {
-        patterns: valueOfString('PINPOINT_TRACE_EXCLUSION_URL_PATTERNS'),
-        cacheSize: valueOfNumber('PINPOINT_TRACE_EXCLUSION_URL_CACHE_SIZE')
+
+function mergeConfig(...sources) {
+    const result = {}
+    for (const source of sources) {
+        mergeObject(result, source)
+    }
+    return result
+}
+
+function mergeObject(target, source) {
+    if (!isPlainObject(source)) {
+        return target
+    }
+
+    for (const [key, value] of Object.entries(source)) {
+        if (value === undefined) {
+            continue
+        }
+
+        if (isPlainObject(value)) {
+            if (!isPlainObject(target[key])) {
+                target[key] = {}
+            }
+            mergeObject(target[key], value)
+        } else {
+            target[key] = value
+        }
     }
+    return target
 }
 
-function makePluginsEnvironmentConfig() {
-    return {
-        httpErrorStatusCodes: valueOfString('PINPOINT_HTTP_STATUS_CODE_ERRORS')
+function pruneUndefined(value) {
+    if (Array.isArray(value)) {
+        return value
+    }
+
+    if (!isPlainObject(value)) {
+        return value
+    }
+
+    const pruned = {}
+    for (const [key, val] of Object.entries(value)) {
+        if (val === undefined) {
+            continue
+        }
+
+        const normalizedVal = pruneUndefined(val)
+        if (isPlainObject(normalizedVal) && Object.keys(normalizedVal).length === 0) {
+            continue
+        }
+
+        pruned[key] = normalizedVal
     }
+    return pruned
 }
 
 module.exports = {

lib/pinpoint-config-default2.json

@@ -8,6 +8,7 @@
         "deadlineMinutes": 10
     },
     "sampling": {
+        "enable": true,
         "rate": 10
     },
     "plugins": {

test/config.test.js

@@ -13,7 +13,6 @@ const { ConfigBuilder } = require('../lib/config-builder')
 test('Agent ID required field', function (t) {
   t.plan(1)
 
-  clear()
   delete process.env.PINPOINT_AGENT_ID
   delete process.env.PINPOINT_APPLICATION_NAME
 
@@ -26,31 +25,32 @@ test('Should be configured with environment variable', function (t) {
 
   const agentId = 'id-from-env'
   process.env.PINPOINT_AGENT_ID = agentId
-  clear()
-  const conf = getConfig()
 
+  const conf = new ConfigBuilder().build()
   t.equal(agentId, conf.agentId)
+
+  delete process.env.PINPOINT_AGENT_ID
 })
 
 test('Should be configured with argument', function (t) {
   t.plan(1)
 
   process.env.PINPOINT_AGENT_ID = 'id-from-env'
-  clear()
-  const conf = getConfig({
-    'agent-id': 'id-from-argument'
-  }, false)
 
-  t.equal('id-from-argument', conf.agentId)
+  const conf = new ConfigBuilder({ 'agentId': 'id-from-argument' }).build()
+  t.equal(conf.agentId, 'id-from-argument')
+
+  delete process.env.PINPOINT_AGENT_ID
 })
 
 test('Should be read from config file', function (t) {
   t.plan(1)
 
-  const testConfig = require('./pinpoint-config-test')
-  const result = readConfigJson(testConfig)
-  log.debug(result)
-  t.ok(result)
+  delete process.env.PINPOINT_COLLECTOR_IP
+
+  const testConfig = require('./pinpoint-config-test2.json')
+  const conf = new ConfigBuilder().setDefaultJson(testConfig).build()
+  t.deepEqual(conf, testConfig)
 })
 
 test('deadline config', (t) => {

test/pinpoint-config-test2.json

@@ -0,0 +1,44 @@
+{
+    "agentId": "node.test.app",
+    "applicationName": "test.application.name",
+    "applicationType": 1400,
+    "collector": {
+        "ip": "localhost",
+        "spanPort": 9993,
+        "statPort": 9992,
+        "tcpPort": 9991,
+        "deadlineMinutes": 10
+    },
+    "sampling": {
+        "enable": true,
+        "rate": 10
+    },
+    "plugins": {
+        "http": {
+            "errorStatusCodes": "5xx,401,403"
+        },
+        "express": true,
+        "koa": true,
+        "mongodb": true,
+        "redis": true,
+        "ioredis": true,
+        "mysql": true,
+        "postgresql": true
+    },
+    "features": {
+        "activeThreadCount": true,
+        "dataSending": true,
+        "statsMonitoring": true,
+        "traceLocationAndFilenameOfCallSite": false,
+        "container": false,
+        "sqlStats": false,
+        "logLevels": {
+            "default-logger": "WARN",
+            "grpcLogger": "SILENT"
+        },
+        "traceExclusionUrl": {
+            "patterns": "",
+            "cacheSize": 100
+        }
+    }
+}