add tests for the new guards on POSITIVE_TIME_OPTS

Author: trentm

lib/config.js

@@ -519,12 +519,12 @@ function normalizeBytes (opts) {
 function normalizePositiveTime (opts, logger) {
   for (const key of POSITIVE_TIME_OPTS) {
     if (key in opts) {
-      let val = toSeconds(String(opts[key]))
+      let val = secondsFromTimeStr(String(opts[key]))
       if (val === null) {
         const def = DEFAULTS[key]
         logger.warn('invalid time value "%s" for "%s" config option: using default "%s"',
           opts[key], key, def)
-        val = toSeconds(def)
+        val = secondsFromTimeStr(def)
       }
       opts[key] = val
     }
@@ -533,7 +533,7 @@ function normalizePositiveTime (opts, logger) {
 
 function normalizeTime (opts) {
   for (const key of TIME_OPTS) {
-    if (key in opts) opts[key] = toSeconds(String(opts[key]), true)
+    if (key in opts) opts[key] = secondsFromTimeStr(String(opts[key]), true)
   }
 }
 
@@ -613,7 +613,7 @@ function bytes (input) {
   }
 }
 
-function toSeconds (value, allowNegative) {
+function secondsFromTimeStr (value, allowNegative) {
   let matches
   if (allowNegative) {
     matches = /^(-?\d+)(m|ms|s)?$/.exec(value)
@@ -747,7 +747,7 @@ function getBaseClientConfig (conf, agent) {
     cloudMetadataFetcher: (new CloudMetadata(cloudProvider, conf.logger, conf.serviceName))
   }
 
-  if (conf.errorMessageMaxLength !== undefined) {
+  if (conf.errorMessageMaxLength !== undefined) {O
     // As of v10 of the http client, truncation of error messages will default
     // to `truncateLongFieldsAt` if `truncateErrorMessagesAt` is not specified.
     clientConfig.truncateErrorMessagesAt = conf.errorMessageMaxLength
@@ -762,4 +762,7 @@ module.exports.INTAKE_STRING_MAX_SIZE = INTAKE_STRING_MAX_SIZE
 module.exports.CAPTURE_ERROR_LOG_STACK_TRACES_NEVER = CAPTURE_ERROR_LOG_STACK_TRACES_NEVER
 module.exports.CAPTURE_ERROR_LOG_STACK_TRACES_MESSAGES = CAPTURE_ERROR_LOG_STACK_TRACES_MESSAGES
 module.exports.CAPTURE_ERROR_LOG_STACK_TRACES_ALWAYS = CAPTURE_ERROR_LOG_STACK_TRACES_ALWAYS
+
+// The following are exported for tests.
 module.exports.DEFAULTS = DEFAULTS
+module.exports.secondsFromTimeStr = secondsFromTimeStr

test/config.test.js

@@ -354,14 +354,66 @@ bytesValues.forEach(function (key) {
   })
 })
 
-var timeValues = [
+var POSITIVE_TIME_OPTS = [
   'abortedErrorThreshold',
   'apiRequestTime',
   'metricsInterval',
   'serverTimeout'
 ]
+// Time options allowing negative values.
+var TIME_OPTS = [
+  'spanFramesMinDuration'
+]
+
+POSITIVE_TIME_OPTS.forEach(function (key) {
+  test(key + ' should guard against a negative time', function (t) {
+    var agent = new Agent()
+    var logger = new CaptureLogger()
+    agent.start(Object.assign(
+      {},
+      agentOptsNoopTransport,
+      {
+        [key]: '-1s',
+        logger
+      }
+    ))
+
+    t.strictEqual(agent._conf[key], config.secondsFromTimeStr(config.DEFAULTS[key]),
+      'fell back to default value')
+    const warning = logger.calls[0]
+    t.equal(warning.type, 'warn', 'got a log.warn')
+    t.ok(warning.message.indexOf('-1s') !== -1, 'warning message includes the invalid value')
+    t.ok(warning.message.indexOf(key) !== -1, 'warning message includes the invalid key')
+
+    agent.destroy()
+    t.end()
+  })
+
+  test(key + ' should guard against a bogus non-time', function (t) {
+    var agent = new Agent()
+    var logger = new CaptureLogger()
+    agent.start(Object.assign(
+      {},
+      agentOptsNoopTransport,
+      {
+        [key]: 'bogusvalue',
+        logger
+      }
+    ))
+
+    t.strictEqual(agent._conf[key], config.secondsFromTimeStr(config.DEFAULTS[key]),
+      'fell back to default value')
+    const warning = logger.calls[0]
+    t.equal(warning.type, 'warn', 'got a log.warn')
+    t.ok(warning.message.indexOf('bogusvalue') !== -1, 'warning message includes the invalid value')
+    t.ok(warning.message.indexOf(key) !== -1, 'warning message includes the invalid key')
+
+    agent.destroy()
+    t.end()
+  })
+})
 
-timeValues.forEach(function (key) {
+POSITIVE_TIME_OPTS.concat(TIME_OPTS).forEach(function (key) {
   test(key + ' should convert minutes to seconds', function (t) {
     var agent = new Agent()
     var opts = {}