fix(test): Use manually started timers

Author: dszakallas

lib/agent/control/control.js

@@ -1,7 +1,11 @@
 var debug = require('debug')('risingstack/trace')
 
+var Timer = require('../timer')
+
 function Control (options) {
   var _this = this
+  this.name = 'Control'
+
   this.collectorApi = options.collectorApi
   this.controlBus = options.controlBus
   this.config = options.config
@@ -10,7 +14,7 @@ function Control (options) {
 
   this.getUpdates()
 
-  this.interval = setInterval(function () {
+  this.timer = new Timer(function () {
     _this.getUpdates()
   }, this.updateInterval)
 }

lib/agent/control/control.spec.js

@@ -1,9 +1,10 @@
 var expect = require('chai').expect
 
 var Control = require('./')
+var Timer = require('../timer')
 
 describe('The Control module', function () {
-  it('interprets commands', function () {
+  it('gets memory-heapdump', function () {
     var collectorApi = {
       getUpdates: function (options, cb) {
         cb(null, {
@@ -16,9 +17,7 @@ describe('The Control module', function () {
     }
 
     var controlBus = {
-      on: function () {
-
-      },
+      on: function () {},
       emit: this.sandbox.spy()
     }
 
@@ -32,4 +31,16 @@ describe('The Control module', function () {
     profiler.getUpdates()
     expect(controlBus.emit).to.be.calledWith('memory-heapdump', undefined)
   })
+  it('should have a timer', function () {
+    var collectorApi = {
+      getUpdates: function () { }
+    }
+    var profiler = Control.create({
+      collectorApi: collectorApi,
+      config: {
+        updateInterval: 1
+      }
+    })
+    expect(profiler.timer).to.be.instanceof(Timer)
+  })
 })

lib/agent/healthcheck/index.js

@@ -1,10 +1,13 @@
+var Timer = require('../timer')
+
 function Healthcheck (options) {
+  this.name = 'Healthcheck'
   var _this = this
-
   this.collectorApi = options.collectorApi
   this.config = options.config
   this.healthcheckInterval = this.config.healthcheckInterval
-  this.interval = setInterval(function () {
+
+  this.timer = new Timer(function () {
     _this.ping()
   }, this.healthcheckInterval)
 }

lib/agent/healthcheck/index.spec.js

@@ -1,6 +1,7 @@
 var expect = require('chai').expect
 
 var Healthcheck = require('./')
+var Timer = require('../timer')
 
 describe('The Healthcheck module', function () {
   it('pings the collector', function () {
@@ -19,4 +20,18 @@ describe('The Healthcheck module', function () {
 
     expect(collectorApi.ping).to.be.called
   })
+
+  it('should have a timer', function () {
+    var collectorApi = {
+      ping: this.sandbox.spy()
+    }
+
+    var healthcheck = Healthcheck.create({
+      collectorApi: collectorApi,
+      config: {
+        healthcheckInterval: 1
+      }
+    })
+    expect(healthcheck.timer).to.be.instanceof(Timer)
+  })
 })

lib/agent/index.js

@@ -15,6 +15,8 @@ var ReservoirSampler = require('./reservoir_sampler')
 var Profiler = require('./profiler')
 var Control = require('./control')
 
+var Timer = require('./timer')
+
 var controlBus = new EventEmitter()
 
 var REQUEST_ID = 'request-id'
@@ -28,13 +30,6 @@ function Agent (options) {
   this.collectorApi = CollectorApi.create(options.config)
   // config
   this.config = options.config
-  this.collectInterval = this.config.collectInterval
-
-  this.totalRequestCount = 0
-  this.mustCollectCount = 0
-
-  // init required variables
-  this.partials = {}
 
   this.apmMetrics = Metrics.apm.create({
     collectorApi: this.collectorApi,
@@ -79,29 +74,66 @@ function Agent (options) {
     controlBus: controlBus
   })
 
+  // TODO: The Tracer agent, to be extracted
+  this.name = 'Tracer'
+
+  this.collectInterval = this.config.collectInterval
+
+  this.totalRequestCount = 0
+  this.mustCollectCount = 0
+
+  // init required variables
+  this.partials = {}
+
+  this.reservoirSampler = new ReservoirSampler(MUST_COLLECT_LIMIT)
+
+  this.timer = new Timer(function () {
+    _this._send()
+  }, this.collectInterval)
+
+  this.tracer = this
+
+  //
+
+  this.agents = [
+    this.tracer,
+    this.apmMetrics,
+    this.healthcheck,
+    this.rpmMetrics,
+    this.externalEdgeMetrics,
+    this.incomingEdgeMetrics,
+    this.memoryProfiler,
+    this.cpuProfiler,
+    this.control
+  ]
+}
+
+Agent.prototype.start = function () {
+  var _this = this
   this.collectorApi.getService(function (err, serviceKey) {
     if (err) {
       return debug(err.message)
     }
     debug('Agent serviceKey is set to: ', serviceKey)
     _this.serviceKey = serviceKey
-    _this.start()
+    _this._startAll()
   })
-
-  this.reservoirSampler = new ReservoirSampler(MUST_COLLECT_LIMIT)
 }
 
-Agent.prototype.start = function () {
-  var _this = this
-  debug('Agent started collecting')
-  this.transactionIntervalId = setInterval(function () {
-    _this._send()
-  }, this.collectInterval)
+Agent.prototype._startAll = function () {
+  this.agents.forEach(function (agent) {
+    debug(agent.name + ' started')
+    if (agent.timer != null) {
+      agent.timer.start()
+    }
+  })
 }
 
-Agent.prototype.stop = function () {
-  debug('Agent stopped collecting')
-  clearInterval(this.transactionIntervalId)
+Agent.prototype._stopAll = function () {
+  this.agents.forEach(function (agent) {
+    debug(agent.name + ' stopped')
+    agent.timer.end()
+  })
 }
 
 Agent.prototype.getServiceKey = function () {

lib/agent/metrics/apm/index.js

@@ -1,10 +1,12 @@
 var os = require('os')
 var gc = require('../../../optionalDependencies/gc-stats')()
 var eventLoopStats = require('../../../optionalDependencies/event-loop-stats')
+var Timer = require('../../timer')
 
 var BYTES_TO_MEGABYTES = 1024 * 1024
 
 function ApmMetrics (options) {
+  this.name = 'Metrics/APM'
   var _this = this
   this.cpuCount = os.cpus().length
   this.pid = process.pid
@@ -18,9 +20,6 @@ function ApmMetrics (options) {
     scavenge: 0,
     marksweep: 0
   }
-  this.interval = setInterval(function () {
-    _this.sendMetrics()
-  }, this.collectInterval)
 
   gc.on('stats', function (stats) {
     // time is in nanoseconds
@@ -39,6 +38,10 @@ function ApmMetrics (options) {
         break
     }
   })
+
+  this.timer = new Timer(function () {
+    _this.sendMetrics()
+  }, this.collectInterval)
 }
 
 ApmMetrics.prototype.sendMetrics = function () {

lib/agent/metrics/apm/index.spec.js

@@ -3,6 +3,7 @@ var os = require('os')
 var eventLoopStats = require('event-loop-stats')
 
 var ApmMetrics = require('./')
+var Timer = require('../../timer')
 
 describe('The ApmMetrics module', function () {
   it('sends metrics', function () {
@@ -100,4 +101,20 @@ describe('The ApmMetrics module', function () {
       utilization: null
     })
   })
+
+  it('should have a timer', function () {
+    var collectorApi = {
+      sendApmMetrics: this.sandbox.spy()
+    }
+
+    var apmMetrics = ApmMetrics.create({
+      collectorApi: collectorApi,
+      config: {
+        collectInterval: 1,
+        isRunningInVm: true
+      }
+    })
+
+    expect(apmMetrics.timer).to.be.instanceof(Timer)
+  })
 })

lib/agent/metrics/externalEdge/index.js

@@ -1,8 +1,10 @@
 var debug = require('debug')('risingstack/trace')
 var flatMap = require('lodash.flatmap')
 var consts = require('../../../consts')
+var Timer = require('../../timer')
 
 function ExternalEdgeMetrics (options) {
+  this.name = 'Metrics/ExternalEdge'
   var _this = this
   this.collectorApi = options.collectorApi
   this.config = options.config
@@ -11,7 +13,7 @@ function ExternalEdgeMetrics (options) {
   // metrics
   this.metrics = {}
 
-  this.interval = setInterval(function () {
+  this.timer = new Timer(function () {
     _this.sendMetrics()
   }, this.collectInterval)
 }

lib/agent/metrics/externalEdge/index.spec.js

@@ -1,6 +1,7 @@
 var expect = require('chai').expect
 
 var ExternalEdgeMetrics = require('./')
+var Timer = require('../../timer')
 
 describe('The ExternalEdgeMetrics module', function () {
   it('discards undefined responseTime values', function () {
@@ -112,4 +113,18 @@ describe('The ExternalEdgeMetrics module', function () {
       data: expectedHostMetrics
     })
   })
+
+  it('should have a timer', function () {
+    var collectorApi = {
+      sendExternalEdgeMetrics: this.sandbox.spy()
+    }
+    var edgeMetrics = ExternalEdgeMetrics.create({
+      collectorApi: collectorApi,
+      config: {
+        collectInterval: 1
+      }
+    })
+
+    expect(edgeMetrics.timer).to.be.instanceof(Timer)
+  })
 })

lib/agent/metrics/incomingEdge/index.js

@@ -1,6 +1,8 @@
 var flatMap = require('lodash.flatmap')
+var Timer = require('../../timer')
 
 function IncomingEdgeMetrics (options) {
+  this.name = 'Metrics/IncomingEdge'
   var _this = this
   this.collectorApi = options.collectorApi
   this.config = options.config
@@ -9,7 +11,7 @@ function IncomingEdgeMetrics (options) {
   // metrics
   this.metrics = {}
 
-  this.interval = setInterval(function () {
+  this.timer = new Timer(function () {
     _this.sendMetrics()
   }, this.collectInterval)
 }