metrics: Add sendAnonymousCLIMetrics

Fixes: #138
Credit: @lazywithclass
Credit: @iarna
Reviewed-By: @iarna
PR-URL: #139

Author: lazywithclass

README.md

@@ -183,6 +183,20 @@ Publish a package to the registry.
 
 Note that this does not create the tarball from a folder.
 
+### client.sendAnonymousCLIMetrics(uri, params, cb)
+
+- `uri` {String} Base URL for the registry.
+- `params` {Object} Object containing per-request properties.
+  - `metricId` {String} A uuid unique to this dataset.
+  - `metrics` {Object} The metrics to share with the registry, with the following properties:
+    - `from` {Date} When the first data in this report was collected.
+    - `to` {Date} When the last data in this report was collected. Usually right now.
+    - `successfulInstalls` {Number} The number of successful installs in this period.
+    - `failedInstalls` {Number} The number of installs that ended in error in this period.
+- `cb` {Function}
+
+PUT a metrics object to the `/-/npm/anon-metrics/v1/` endpoint on the registry.
+
 ### client.star(uri, params, cb)
 
 * `uri` {String} The complete registry URI for the package to star.

index.js

@@ -54,22 +54,22 @@ function RegClient (config) {
     // lib/group-name/operation.js -> client.groupName.operation
     var stat = fs.statSync(entry)
     if (stat.isDirectory()) {
-      var groupName = f.replace(/-([a-z])/, dashToCamel)
+      var groupName = f.replace(/-([a-z])/gi, dashToCamel)
       fs.readdirSync(entry).forEach(function (f) {
         if (!f.match(/\.js$/)) return
 
         if (!client[groupName]) {
           // keep client.groupName.operation from stomping client.operation
           client[groupName] = Object.create(client)
         }
-        var name = f.replace(/\.js$/, '').replace(/-([a-z])/, dashToCamel)
+        var name = f.replace(/\.js$/, '').replace(/-([a-z])/gi, dashToCamel)
         client[groupName][name] = require(join(entry, f))
       })
       return
     }
 
     if (!f.match(/\.js$/)) return
-    var name = f.replace(/\.js$/, '').replace(/-([a-z])/, dashToCamel)
+    var name = f.replace(/\.js$/, '').replace(/-([a-z])/gi, dashToCamel)
     client[name] = require(entry)
   })
 }

lib/request.js

@@ -42,23 +42,25 @@ function regRequest (uri, params, cb_) {
     return cb(new Error('trying to change user document without writing(?!)'))
   }
 
-  // new users can *not* use auth, because they don't *have* auth yet
-  if (isUserChange) {
-    this.log.verbose('request', 'updating existing user; sending authorization')
-    params.authed = true
-  } else if (isNewUser) {
-    this.log.verbose('request', "new user, so can't send auth")
-    params.authed = false
-  } else if (alwaysAuth) {
-    this.log.verbose('request', 'always-auth set; sending authorization')
-    params.authed = true
-  } else if (isWrite) {
-    this.log.verbose('request', 'sending authorization for write operation')
-    params.authed = true
-  } else {
-    // most of the time we don't want to auth
-    this.log.verbose('request', 'no auth needed')
-    params.authed = false
+  if (params.authed == null) {
+    // new users can *not* use auth, because they don't *have* auth yet
+    if (isUserChange) {
+      this.log.verbose('request', 'updating existing user; sending authorization')
+      params.authed = true
+    } else if (isNewUser) {
+      this.log.verbose('request', "new user, so can't send auth")
+      params.authed = false
+    } else if (alwaysAuth) {
+      this.log.verbose('request', 'always-auth set; sending authorization')
+      params.authed = true
+    } else if (isWrite) {
+      this.log.verbose('request', 'sending authorization for write operation')
+      params.authed = true
+    } else {
+      // most of the time we don't want to auth
+      this.log.verbose('request', 'no auth needed')
+      params.authed = false
+    }
   }
 
   var self = this

lib/send-anonymous-CLI-metrics.js

@@ -0,0 +1,19 @@
+module.exports = send
+
+var assert = require('assert')
+var url = require('url')
+
+function send (registryUrl, params, cb) {
+  assert(typeof registryUrl === 'string', 'must pass registry URI')
+  assert(params && typeof params === 'object', 'must pass params')
+  assert(typeof cb === 'function', 'must pass callback')
+
+  var uri = url.resolve(registryUrl, '-/npm/anon-metrics/v1/' +
+    encodeURIComponent(params.metricId))
+
+  this.request(uri, {
+    method: 'PUT',
+    body: JSON.stringify(params.metrics),
+    authed: false
+  }, cb)
+}

test/lib/server.js

@@ -12,7 +12,6 @@ server._expect = {}
 
 function handler (req, res) {
   req.connection.setTimeout(1000)
-
   // If we got authorization, make sure it's the right password.
   if (req.headers.authorization && req.headers.authorization.match(/^Basic/)) {
     var auth = req.headers.authorization.replace(/^Basic /, '')

test/send-anon-metrics.js

@@ -0,0 +1,79 @@
+var test = require('tap').test
+
+var common = require('./lib/common.js')
+var client = common.freshClient()
+var server = require('./lib/server.js')
+
+function nop () {}
+
+var metricId = 'this-is-a-uuid'
+var from = new Date()
+var to = new Date()
+var metricInfo = {
+  metricId: metricId,
+  metrics: [{
+    from: from.toISOString(),
+    to: to.toISOString(),
+    successfulInstalls: 0,
+    failedInstalls: 1
+  }]
+}
+
+test('sendAnonymousCLIMetrics call contract', function (t) {
+  t.throws(function () {
+    client.sendAnonymousCLIMetrics(undefined, metricInfo, nop)
+  }, 'requires a URI')
+
+  t.throws(function () {
+    client.sendAnonymousCLIMetrics([], metricInfo, nop)
+  }, 'requires URI to be a string')
+
+  t.throws(function () {
+    client.sendAnonymousCLIMetrics(common.registry, undefined, nop)
+  }, 'requires params object')
+
+  t.throws(function () {
+    client.sendAnonymousCLIMetrics(common.registry, '', nop)
+  }, 'params must be object')
+
+  t.throws(function () {
+    client.sendAnonymousCLIMetrics(common.registry, metricInfo, undefined)
+  }, 'requires callback')
+
+  t.throws(function () {
+    client.sendAnonymousCLIMetrics(common.registry, metricInfo, 'callback')
+  }, 'callback must be function')
+
+  t.end()
+})
+
+test('sendAnonymousCLIMetrics', function (t) {
+  server.expect('PUT', '/-/npm/anon-metrics/v1/' + metricId, function (req, res) {
+    t.is(req.method, 'PUT')
+    var b = ''
+    req.setEncoding('utf8')
+    req.on('data', function (d) {
+      b += d
+    })
+
+    req.on('end', function () {
+      var d = JSON.parse(b)
+      t.isDeeply(d, metricInfo.metrics, 'PUT received metrics')
+
+      res.statusCode = 200
+      res.json({})
+    })
+  })
+
+  client.sendAnonymousCLIMetrics(common.registry, metricInfo, function (err, res) {
+    t.ifError(err, 'no errors')
+    t.isDeeply(res, {}, 'result ok')
+    server.close()
+    t.end()
+  })
+})
+
+test('cleanup', function (t) {
+  server.close()
+  t.end()
+})