feat: debug instead of console logs

- renaming the `debugger` module so it's not a reserved keyword
- using `debug` module instead of `console.log` so we get an idea of performance impact
- refactored some code to make it clearer
- starting to remove `JSON.stringify` from error logs
- adding a debug print after transmitting events

lib/ast.js

@@ -1,5 +1,6 @@
 var fs = require('fs');
 var acorn = require('acorn');
+var debug = require('debug')('snyk:nodejs');
 
 function findAllVulnerableFunctionsInScriptPath(
   scriptPath, vulnerableFunctionNames) {
@@ -58,7 +59,8 @@ function findAllVulnerableFunctionsInScriptPath(
       };
     });
   } catch (error) {
-    console.log(JSON.stringify(error));
+    debug(`Error finding vulnerable methods ${vulnerableFunctionNames}` +
+      ` in script path ${scriptPath}: ${error}`);
   }
   return decleardFunctions;
 };

lib/debugger.js → lib/debugger-wrapper.js

@@ -1,4 +1,6 @@
+var debug = require('debug')('snyk:nodejs:inspector');
 var inspector = require('inspector');
+
 var vulnMgmt = require('./vuln-mgmt');
 var moduleUtils = require('./moduleUtils');
 var transmitter = require('./transmitter');
@@ -34,7 +36,7 @@ function start() {
         vulnMgmt.getVulnerableMethodsLocations(moduleInfo, scriptPath);
       Object.keys(vulnerableMethods).forEach((methodName) => {
         var methodLocation = vulnerableMethods[methodName];
-        setBreakpointsOnVulnearbleMethods(
+        setBreakpointsOnVulnerableMethods(
           script.params.url, moduleInfo, methodName, methodLocation);
       });
     }
@@ -43,13 +45,14 @@ function start() {
     try {
       handleDebuggerPausedEvent(message.params);
     } catch (error) {
-      console.log(JSON.stringify(error));
+      debug('Error handling debugger paused event: ' +
+        `${JSON.stringify(message)}, ${error}`);
     }
   });
   session.post('Debugger.enable');
   session.post('Debugger.setBreakpointsActive', {active: true});
 
-  function setBreakpointsOnVulnearbleMethods(
+  function setBreakpointsOnVulnerableMethods(
     moduleUrl, moduleInfo, methodName, methodLocation) {
     session.post('Debugger.setBreakpointByUrl',
       {
@@ -63,22 +66,19 @@ function start() {
             methodName,
             moduleInfo,
           };
-          var message = {
-            methodName,
-            moduleInfo,
-            message: 'Added breakpoint',
-          };
-          console.log(JSON.stringify(message));
+          debug(`Successfully set a breakpoint on method ${methodName}` +
+            ` in module ${moduleInfo.name}`);
         } else {
-          var errorMessage = {
+          const errorEvent = {
             methodName,
             moduleInfo,
             error,
-            message: 'Failed to set breakpoint',
+            message: 'Failed setting a breakpoint',
           };
-          console.log(JSON.stringify(errorMessage));
-          transmitter.addEvent( {
-            error: errorMessage,
+          debug(`Failed setting a breakpoint on method ${methodName} ` +
+            ` in module ${moduleInfo.name}: ${error}`);
+          transmitter.addEvent({
+            error: errorEvent,
             timestamp: (new Date()).toISOString(),
           });
         }

lib/index.js

@@ -1,12 +1,15 @@
-var debug = require('./debugger');
+var debug = require('debug')('snyk:nodejs-agent');
+
 var transmitter = require('./transmitter');
+var debuggerWrapper = require('./debugger-wrapper');
+
 
 function start(config) {
   try {
     transmitter.start(config);
-    debug.start();
+    debuggerWrapper.start();
   } catch (error) {
-    console.log(JSON.stringify(error));
+    debug('Generic error while starting snyk-nodejs-agent:', error);
   };
 }
 

lib/transmitter.js

@@ -1,14 +1,15 @@
+var debug = require('debug')('snyk:nodejs:transmitter');
 var needle = require('needle');
 
 const DEFAULT_BEACON_BASE_URL = 'https://homebase.snyk.io';
 const DEFAULT_BEACON_URL_PATH = '/api/v1/beacon';
-const DEFAULT_BEACON_INTERVAL_MS = 60000; // 60 seconds
+const DEFAULT_BEACON_INTERVAL_MS = 60 * 1000;
 
 var eventsToSend = [];
 function start({
-  projectId, // mandatory
-  url = DEFAULT_BEACON_BASE_URL + DEFAULT_BEACON_URL_PATH,
-  beaconIntervalMs = DEFAULT_BEACON_INTERVAL_MS,
+  projectId,
+  url=DEFAULT_BEACON_BASE_URL + DEFAULT_BEACON_URL_PATH,
+  beaconIntervalMs=DEFAULT_BEACON_INTERVAL_MS,
 }) {
   if (!projectId) {
     throw new Error('No projectId defined in configuration');
@@ -22,17 +23,14 @@ function start({
   function transmitData() {
     if (eventsToSend.length) {
       needle.post(url, {projectId, eventsToSend}, {json: true});
+      debug(eventsToSend.length, 'events transmitted.');
     }
   }
 }
 
 function addEvent(event) {
   eventsToSend.push(event);
-  var message = {
-    event,
-    message: 'Event was added',
-  };
-  console.log(JSON.stringify(message));
+  debug(`Event added to transmission queue: ${JSON.stringify(event)}`);
 }
 
 module.exports = {start,addEvent};

lib/vuln-mgmt.js

@@ -1,6 +1,8 @@
 var fs = require('fs');
 var path = require('path');
+var debug = require('debug')('snyk:nodejs-agent');
 var semver = require('semver');
+
 var ast = require('./ast');
 
 const METHODS_METATDATA_FILE = path.join(__dirname, '../methods.json');
@@ -13,9 +15,7 @@ function loadVulnerabiltiesMetadata() {
   if (!exists) {
     vulnerabiltiesMetadata = require(METHODS_METATDATA_FILE);
   } else {
-    console.log(JSON.stringify(
-      {message: 'Using app defined method.json to load vulnerabilties'})
-    );
+    debug('Using app defined method.json to load vulnerabilties');
     vulnerabiltiesMetadata = require(appMetadataFilePath);
   }
   return vulnerabiltiesMetadata;

package.json

@@ -27,6 +27,7 @@
   },
   "dependencies": {
     "acorn": "^5.7.1",
+    "debug": "^4.0.1",
     "needle": "^2.2.1",
     "semver": "^5.5.1"
   },

test/debugger.test.js

@@ -2,7 +2,7 @@ const test = require('tap').test;
 const sinon = require('sinon');
 var inspector = require('inspector');
 const EventEmitter = require('events');
-var dbg = require('../lib/debugger');
+var dbg = require('../lib/debugger-wrapper');
 var vulnMgmt = require('../lib/vuln-mgmt');
 var moduleUtils = require('../lib/moduleUtils');
 var transmitter = require('../lib/transmitter');