fix(security): upgrade to agent api

Author: dszakallas

lib/agent/index.js

@@ -69,7 +69,7 @@ function Agent (options) {
   })
 
   this.security = Security.create({
-    collectorApi: this._collectorApi,
+    collectorApi: this._api,
     config: this.config
   })
 

lib/agent/security/security.js

@@ -1,21 +1,21 @@
 var childProcess = require('child_process')
 var fs = require('fs')
-var debug = require('debug')('risingstack/trace')
+var debug = require('debug')('risingstack/trace:agent:security')
 var yaml = require('js-yaml')
 var forEach = require('lodash.foreach')
 var uniq = require('lodash.uniq')
+var inherits = require('util').inherits
+var Agent = require('../agent')
 
 function Security (options) {
-  this.name = 'Security'
   this.collectorApi = options.collectorApi
+  Agent.call(this, 'Security')
+}
 
-  var self = this
+inherits(Security, Agent)
 
-  this.timer = {
-    start: function () { self.sendDependencies() },
-    restart: function () { /* noop */ },
-    end: function () { /* noop */ }
-  }
+Security.prototype.initialize = function () {
+  this.sendDependencies()
 }
 
 Security.prototype.collectSnykFlags = function collectSnykFlags (callback) {
@@ -30,7 +30,7 @@ Security.prototype.collectSnykFlags = function collectSnykFlags (callback) {
     try {
       patch = yaml.safeLoad(data).patch
     } catch (ex) {
-      debug('error collecting snyk flags', ex)
+      debug('#collectSnykFlags', 'error collecting snyk flags', ex)
       callback(null, [])
       return
     }
@@ -50,7 +50,7 @@ Security.prototype.collectSnykFlags = function collectSnykFlags (callback) {
     childProcess.execFile('npm', ['ls'].concat(uniq(packageNames)).concat(['--parseable', '--long']), function (_error, stdout, stderr) {
       if (_error) {
         // ignore
-        debug('`npm ls <package_names> --long --parseable` returned error', _error)
+        debug('#collectSnykFlags', '`npm ls <package_names> --long --parseable` returned error', _error)
       }
 
       var pkgs = stdout.split('\n')
@@ -137,13 +137,13 @@ Security.prototype.sendDependencies = function sendDependencies () {
   var _this = this
   this.collectDependencies(function (error, dependencies) {
     if (error) {
-      debug('error collecting dependencies', error)
+      debug('#sendDependencies', 'error collecting dependencies', error)
       return
     }
 
     _this.collectSnykFlags(function (_error, flags) {
       if (_error) {
-        debug('error collecting snyk flags', _error)
+        debug('#sendDependencies', 'error collecting snyk flags', _error)
         // send dependencies without patches
         _this.collectorApi.sendDependencies(dependencies)
         return

lib/agent/security/security.spec.js

@@ -72,7 +72,7 @@ describe('The Security module', function () {
       collectorApi: collectorApi
     })
 
-    security.timer.start()
+    security.initialize()
 
     expect(fs.readFile).to.have.been.calledWithMatch('.snyk')
     expect(fs.readdir).to.have.been.calledWithMatch('/project/node_modules/vuln')
@@ -130,7 +130,7 @@ describe('The Security module', function () {
       collectorApi: collectorApi
     })
 
-    security.timer.start()
+    security.initialize()
 
     expect(fs.readFile).to.have.been.calledWithMatch('.snyk')
     expect(childProcess.execFile).to.have.been.calledWithMatch('npm', ['ls', '--json', '--production'])
@@ -181,7 +181,7 @@ describe('The Security module', function () {
       collectorApi: collectorApi
     })
 
-    security.timer.start()
+    security.initialize()
 
     expect(fs.readFile).to.have.been.calledWithMatch('.snyk')
     expect(childProcess.execFile).to.have.been.calledWithMatch('npm', ['ls', '--json', '--production'])
@@ -232,7 +232,7 @@ describe('The Security module', function () {
       collectorApi: collectorApi
     })
 
-    security.timer.start()
+    security.initialize()
 
     expect(fs.readFile).to.have.been.calledWithMatch('.snyk')
     expect(childProcess.execFile).to.have.been.calledWithMatch('npm', ['ls', '--json', '--production'])