fix: analytics report includes duration of execution

Mattlk13 · Mar 14, 2018 · 66d658a · 66d658a
1 parent c2399ae
commit 66d658a
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 9 deletions.
diff --git a/cli/index.js b/cli/index.js
@@ -1,19 +1,19 @@
 #!/usr/bin/env node
 
+// require analytics as soon as possible to start measuring execution time
+var analytics = require('../lib/analytics');
 var args = require('./args')(process.argv);
 var debug = require('debug')('snyk');
 var copy = require('./copy');
 var alerts = require('../lib/alerts');
 var sln = require('../lib/sln');
-
 var exitcode = 0;
 
 if (args.options.file && args.options.file.match(/\.sln$/)) {
   sln.updateArgs(args);
 }
 
 var cli = args.method.apply(null, args.options._).then(function (result) {
-  var analytics = require('../lib/analytics');
   var res = analytics({
     command: args.command,
     args: args.options._,
@@ -30,7 +30,6 @@ var cli = args.method.apply(null, args.options._).then(function (result) {
 }).catch(function (error) {
   var spinner = require('../lib/spinner');
   spinner.clearAll();
-  var analytics = require('../lib/analytics');
   var command = 'bad-command';
 
   if (error.code === 'VULNS') {

diff --git a/lib/analytics.js b/lib/analytics.js
@@ -14,6 +14,8 @@ var crypto = require('crypto');
 var uuid = require('uuid');
 
 var metadata = {};
+// analytics module is required at the beginning of the CLI run cycle
+var startTime = Date.now();
 
 function analytics(data) {
   if (!data) {
@@ -41,8 +43,7 @@ function postAnalytics(data) {
     return Promise.resolve();
   }
 
-  // get fingerprint from mac address
-  // snyk version
+  // get snyk version
   return version().then(function (version) {
     data.version = version;
     data.os = osName(os.platform(), os.release());
@@ -58,8 +59,9 @@ function postAnalytics(data) {
     }
 
     data.ci = isCI;
+    data.durationMs = Date.now() - startTime;
 
-    debug(data);
+    debug('analytics', data);
 
     return request({
       body: {
@@ -71,7 +73,7 @@ function postAnalytics(data) {
       headers: headers,
     });
   }).catch(function (error) {
-    debug(error); // this swallows the analytics error
+    debug('analytics', error); // this swallows the analytics error
   });
 }
 
@@ -80,7 +82,7 @@ analytics.reset = function () {
 };
 
 analytics.add = function (key, value) {
-  debug('add', key, value);
+  debug('analytics add', key, value);
   if (metadata[key]) {
     if (!Array.isArray(metadata[key])) {
       metadata[key] = [metadata[key]];

diff --git a/test/analytics.test.js b/test/analytics.test.js
@@ -46,7 +46,7 @@ test('analytics', function (t) {
     args: [],
   }).then(function () {
     var body = spy.lastCall.args[0].body.data;
-    t.deepEqual(Object.keys(body).sort(), ['command', 'os', 'version', 'id', 'ci', 'metadata', 'args', 'nodeVersion'].sort(), 'keys as expected');
+    t.deepEqual(Object.keys(body).sort(), ['command', 'os', 'version', 'id', 'ci', 'metadata', 'args', 'nodeVersion', 'durationMs'].sort(), 'keys as expected');
   });
 });