[#371] Add ConfigurationBuilder for flexible config management

Author: feelform

lib/config.js

@@ -297,22 +297,6 @@ const initializeConfig = (initOptions) => {
 
 const clear = () => agentConfig && (agentConfig = null)
 
-let configInstance
-const getConfig2 = () => {
-  if (!configInstance) {
-    configInstance = new ConfigBuilder().build()
-  }
-  return configInstance
-}
-
-const setConfig = (config) => {
-  if (!(config instanceof Config)) {
-    throw new TypeError('config must be an instance of Config')
-  }
-
-  configInstance = config
-}
-
 //https://github.com/sindresorhus/is-docker
 const isContainerEnvironment = () => {
   return hasDockerEnv() || hasDockerCGroup() || (process.env['KUBERNETES_SERVICE_HOST'] && process.env['KUBERNETES_SERVICE_HOST'].length > 0)
@@ -388,8 +372,8 @@ class ConfigBuilder {
       config.container = true
     }
 
-    for (const [key, validation] of Object.entries(configurationValueValidations)) {
-      validation()
+    for (const [key, validation] of Object.entries(valueValidations)) {
+      validation(config)
     }
 
     if (typeof this.agentStartupUserDefinedJson['grpc.service_config'] === 'object') {
@@ -401,6 +385,82 @@ class ConfigBuilder {
   }
 }
 
+const valueValidations = {
+  validateTraceExclusionUrlCacheSize: (config) => {
+    if (typeof config.traceExclusionUrlCacheSize !== 'undefined' && typeof config.traceExclusionUrlPatterns === 'undefined') {
+      delete config.traceExclusionUrlCacheSize
+      log.warn(`You have to set the PINPOINT_TRACE_EXCLUSION_URL_PATTERN, PINPOINT_TRACE_EXCLUSION_URL_CACHE_SIZE or trace-exclusion-url{ pattern: 'pattern', 'cache-size': 100} for using excludsion url cache.`)
+    }
+
+    if (Array.isArray(config.traceExclusionUrlPatterns) && Number.isInteger(config.traceExclusionUrlCacheSize)) {
+      if (config.traceExclusionUrlCacheSize < 100) {
+        config.traceExclusionUrlCacheSize = 100
+      }
+    }
+  },
+  validateIds: (config) => {
+    [{ id: config.agentId, name: 'Agent ID', maxLength: 24, required: true }
+      , { id: config.applicationName, name: 'Application Name', maxLength: 24, required: true }
+      // Java PinpointConstants.AGENT_NAME_MAX_LEN = 255
+      , { id: config.agentName, name: 'Agent Name', maxLength: 255, required: false }
+    ].filter(id => id.id)
+      .filter(id => {
+        if (isNaN(id.maxLength)) {
+          return false
+        }
+
+        if (id.required && typeof id.id !== 'string') {
+          config.enable = false
+          log.warn(`You have to set ${id.name}`)
+          return false
+        }
+
+        if (id.required === false && typeof id.id !== 'string') {
+          return false
+        }
+
+        const maxLength = id.maxLength
+        const idRegex = /^[a-zA-Z0-9\\._\\-]+$/
+
+        if (id.id.length < 1) {
+          config.enable = false
+          log.warn(`You have to set ${id.name}`)
+          return false
+        }
+
+        if (id.id.length > maxLength) {
+          config.enable = false
+          log.warn(`You have to set ${id.name} to less ${maxLength} characters.`)
+          return false
+        }
+
+        if (!idRegex.test(id.id)) {
+          config.enable = false
+          log.warn(`invalidate ${id.name} name with /[a-zA-Z0-9\\._\\-]+/ RegExp`)
+          return false
+        }
+      })
+  }
+}
+
+let configInstance
+const getConfig2 = (json) => {
+  if (!configInstance) {
+    configInstance = new ConfigBuilder(json).build()
+  }
+  return configInstance
+}
+
+const setConfig = (config) => {
+  if (!(config instanceof Config)) {
+    throw new TypeError('config must be an instance of Config')
+  }
+
+  configInstance = config
+}
+
+const clear2 = () => configInstance && (configInstance = null)
+
 module.exports = {
   getConfig,
   clear,
@@ -412,4 +472,5 @@ module.exports = {
   ConfigBuilder,
   getConfig2,
   setConfig,
+  clear2
 }