Merge branch 'master' into bugfix-deep-clone-instead-of-stringify-parse

Author: antialias

.travis.yml

@@ -1,9 +1,8 @@
 language: node_js
 node_js:
-  - "0.12"
-  - "0.10"
-  - "0.8"
-  - iojs
+  - "7"
+  - "6"
+  - "4"
 script: "npm test"
 sudo: false
 before_install:

README.md

@@ -38,7 +38,7 @@ Every call to the client follows the same pattern:
 
 ### Credentials
 
-Many requests to the registry can by authenticated, and require credentials
+Many requests to the registry can be authenticated, and require credentials
 for authorization. These credentials always look the same:
 
 * `username` {String}
@@ -53,6 +53,19 @@ for authorization. These credentials always look the same:
 * `alwaysAuth` {Boolean} Whether calls to the target registry are always
   authed.
 
+## Requests
+
+As of `npm-registry-client@8`, all requests are made with an `Accept` header
+of `application/vnd.npm.install-v1+json; q=1.0, application/json; q=0.8, */*`.
+
+This enables filtered document responses to requests for package metadata.
+You know that you got a filtered response if the mime type is set to
+`application/vnd.npm.install-v1+json` and not `application/json`.
+
+This filtering substantially reduces the over all data size.  For example
+for `https://registry.npmjs.org/npm`, the compressed metadata goes from
+410kB to 21kB.
+
 ## API
 
 ### client.access(uri, params, cb)
@@ -125,7 +138,7 @@ Add (or replace) a single dist-tag onto the named package.
 * `cb` {Function}
 
 Set all of the `dist-tags` for the named package at once, creating any
-`dist-tags` that do not already exit. Any `dist-tags` not included in the
+`dist-tags` that do not already exist. Any `dist-tags` not included in the
 `distTags` map will be removed.
 
 ### client.distTags.update(uri, params, cb)
@@ -164,6 +177,8 @@ Remove a single `dist-tag` from the named package.
     the callback quickly, and update the cache the background. Optional
     (default: false).
   * `auth` {Credentials} Optional.
+  * `fullMetadata` {Boolean} If true, don't attempt to fetch filtered
+    ("corgi") registry metadata.  (default: false)
 * `cb` {Function}
 
 Fetches data from the registry via a GET request, saving it in the cache folder
@@ -183,6 +198,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.
@@ -259,6 +288,8 @@ caching logic directly.
   * `etag` {String} The cached ETag. Optional.
   * `lastModified` {String} The cached Last-Modified timestamp. Optional.
   * `follow` {Boolean} Follow 302/301 responses. Optional (default: true).
+  * `streaming` {Boolean} Stream the request body as it comes, handling error
+    responses in a non-streaming way.
   * `auth` {Credentials} Optional.
 * `cb` {Function}
   * `error` {Error | null}
@@ -310,5 +341,17 @@ any):
   Default = `"latest"`
 * `couchToken` {Object} A token for use with
   [couch-login](https://npmjs.org/package/couch-login).
-* `sessionToken` {string} A random identifier for this set of client requests.
+* `sessionToken` {String} A random identifier for this set of client requests.
   Default = 8 random hexadecimal bytes.
+* `maxSockets` {Number} The maximum number of connections that will be open per
+  origin (unique combination of protocol:host:port). Passed to the
+  [httpAgent](https://nodejs.org/api/http.html#http_agent_maxsockets).
+  Default = 50
+* `isFromCI` {Boolean} Identify to severs if this request is coming from CI (for statistics purposes).
+  Default = detected from environment– primarily this is done by looking for
+  the CI environment variable to be set to `true`.  Also accepted are the
+  existence of the `JENKINS_URL`, `bamboo.buildKey` and `TDDIUM` environment
+  variables.
+* `scope` {String} The scope of the project this command is being run for. This is the
+  top level npm module in which a command was run.
+  Default = none

index.js

@@ -2,9 +2,6 @@
 
 module.exports = RegClient
 
-var join = require('path').join
-var fs = require('graceful-fs')
-
 var npmlog
 try {
   npmlog = require('npmlog')
@@ -39,6 +36,7 @@ function RegClient (config) {
   if (typeof this.config.retry.factor !== 'number') this.config.retry.factor = 10
   if (typeof this.config.retry.minTimeout !== 'number') this.config.retry.minTimeout = 10000
   if (typeof this.config.retry.maxTimeout !== 'number') this.config.retry.maxTimeout = 60000
+  if (typeof this.config.maxSockets !== 'number') this.config.maxSockets = 50
 
   this.config.userAgent = this.config.userAgent || 'node/' + process.version
   this.config.defaultTag = this.config.defaultTag || 'latest'
@@ -47,32 +45,30 @@ function RegClient (config) {
   delete this.config.log
 
   var client = this
-  fs.readdirSync(join(__dirname, 'lib')).forEach(function (f) {
-    var entry = join(__dirname, 'lib', f)
-
-    // lib/group-name/operation.js -> client.groupName.operation
-    var stat = fs.statSync(entry)
-    if (stat.isDirectory()) {
-      var groupName = f.replace(/-([a-z])/, 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)
-        client[groupName][name] = require(join(entry, f))
-      })
-      return
-    }
-
-    if (!f.match(/\.js$/)) return
-    var name = f.replace(/\.js$/, '').replace(/-([a-z])/, dashToCamel)
-    client[name] = require(entry)
-  })
-}
-
-function dashToCamel (_, l) {
-  return l.toUpperCase()
+  client.access = require('./lib/access')
+  client.adduser = require('./lib/adduser')
+  client.attempt = require('./lib/attempt')
+  client.authify = require('./lib/authify')
+  client.deprecate = require('./lib/deprecate')
+  client.distTags = Object.create(client)
+  client.distTags.add = require('./lib/dist-tags/add')
+  client.distTags.fetch = require('./lib/dist-tags/fetch')
+  client.distTags.rm = require('./lib/dist-tags/rm')
+  client.distTags.set = require('./lib/dist-tags/set')
+  client.distTags.update = require('./lib/dist-tags/update')
+  client.fetch = require('./lib/fetch')
+  client.get = require('./lib/get')
+  client.initialize = require('./lib/initialize')
+  client.logout = require('./lib/logout')
+  client.org = require('./lib/org')
+  client.ping = require('./lib/ping')
+  client.publish = require('./lib/publish')
+  client.request = require('./lib/request')
+  client.sendAnonymousCLIMetrics = require('./lib/send-anonymous-CLI-metrics')
+  client.star = require('./lib/star')
+  client.stars = require('./lib/stars')
+  client.tag = require('./lib/tag')
+  client.team = require('./lib/team')
+  client.unpublish = require('./lib/unpublish')
+  client.whoami = require('./lib/whoami')
 }

lib/access.js

@@ -102,20 +102,20 @@ function accessAssertions (subcommand, uri, params, cb) {
     'callback': [cb, 'function']
   })
   if (contains([
-    'public', 'restricted', 'grant', 'revoke', 'ls-collaborators'
+    'public', 'restricted'
   ], subcommand)) {
-    typeChecks({ 'package': [params.package, 'string']})
+    typeChecks({ 'package': [params.package, 'string'] })
     assert(!!npa(params.package).scope,
            'access commands are only accessible for scoped packages')
   }
   if (contains(['grant', 'revoke', 'ls-packages'], subcommand)) {
-    typeChecks({ 'scope': [params.scope, 'string']})
+    typeChecks({ 'scope': [params.scope, 'string'] })
   }
   if (contains(['grant', 'revoke'], subcommand)) {
-    typeChecks({ 'team': [params.team, 'string']})
+    typeChecks({ 'team': [params.team, 'string'] })
   }
   if (subcommand === 'grant') {
-    typeChecks({ 'permissions': [params.permissions, 'string']})
+    typeChecks({ 'permissions': [params.permissions, 'string'] })
     assert(params.permissions === 'read-only' ||
            params.permissions === 'read-write',
            'permissions must be either read-only or read-write')
@@ -125,6 +125,7 @@ function accessAssertions (subcommand, uri, params, cb) {
 function typeChecks (specs) {
   Object.keys(specs).forEach(function (key) {
     var checks = specs[key]
+    /* eslint valid-typeof:0 */
     assert(typeof checks[0] === checks[1],
            key + ' is required and must be of type ' + checks[1])
   })

lib/adduser.js

@@ -2,6 +2,7 @@ module.exports = adduser
 
 var url = require('url')
 var assert = require('assert')
+var extend = Object.assign || require('util')._extend
 
 function adduser (uri, params, cb) {
   assert(typeof uri === 'string', 'must pass registry URI to adduser')
@@ -28,7 +29,7 @@ function adduser (uri, params, cb) {
   if (!username) return cb(new Error('No username supplied.'))
   if (!password) return cb(new Error('No password supplied.'))
   if (!email) return cb(new Error('No email address supplied.'))
-  if (!email.match(/^[^@]+@[^\.]+\.[^\.]+/)) {
+  if (!email.match(/^[^@]+@[^.]+\.[^.]+/)) {
     return cb(new Error('Please use a real email address.'))
   }
 
@@ -67,7 +68,7 @@ function adduser (uri, params, cb) {
   }
   this.request(
     uri,
-    options,
+    extend({}, options),
     function (error, data, json, response) {
       if (!error || !response || response.statusCode !== 409) {
         return cb(error, data, json, response)
@@ -110,7 +111,7 @@ function adduser (uri, params, cb) {
       client.log.verbose('adduser', 'back', [error, data, json])
       if (!error) {
         error = new Error(
-          (response && response.statusCode || '') + ' ' +
+          ((response && response.statusCode) || '') + ' ' +
           'Could not create user\n' + JSON.stringify(data)
         )
       }

lib/fetch.js

@@ -18,16 +18,19 @@ function fetch (uri, params, cb) {
     makeRequest.call(client, uri, params, function (er, req) {
       if (er) return cb(er)
 
-      req.on('error', function (er) {
+      req.once('error', retryOnError)
+
+      function retryOnError (er) {
         if (operation.retry(er)) {
           client.log.info('retry', 'will retry, error on last attempt: ' + er)
         } else {
           cb(er)
         }
-      })
+      }
 
       req.on('response', function (res) {
         client.log.http('fetch', '' + res.statusCode, uri)
+        req.removeListener('error', retryOnError)
 
         var er
         var statusCode = res && res.statusCode
@@ -37,6 +40,10 @@ function fetch (uri, params, cb) {
           res.resume()
           if (process.version === 'v0.10.0') unstick(res)
 
+          req.once('error', function (er) {
+            res.emit('error', er)
+          })
+
           return cb(null, res)
           // Only retry on 408, 5xx or no `response`.
         } else if (statusCode === 408) {

lib/initialize.js

@@ -4,16 +4,18 @@ var HttpsAgent = require('https').Agent
 
 var pkg = require('../package.json')
 
-var httpAgent
-var httpsAgent
-
 module.exports = initialize
 
 function initialize (uri, method, accept, headers) {
   if (!this.config.sessionToken) {
     this.config.sessionToken = crypto.randomBytes(8).toString('hex')
     this.log.verbose('request id', this.config.sessionToken)
   }
+  if (this.config.isFromCI == null) {
+    this.config.isFromCI = Boolean(
+      process.env['CI'] === 'true' || process.env['TDDIUM'] ||
+      process.env['JENKINS_URL'] || process.env['bamboo.buildKey'])
+  }
 
   var opts = {
     url: uri,
@@ -24,7 +26,7 @@ function initialize (uri, method, accept, headers) {
     cert: this.config.ssl.certificate,
     key: this.config.ssl.key,
     ca: this.config.ssl.ca,
-    agent: getAgent(uri.protocol, this.config)
+    agent: getAgent.call(this, uri.protocol)
   }
 
   // allow explicit disabling of proxy in environment via CLI
@@ -50,33 +52,39 @@ function initialize (uri, method, accept, headers) {
   if (this.refer) headers.referer = this.refer
 
   headers['npm-session'] = this.config.sessionToken
+  headers['npm-in-ci'] = String(this.config.isFromCI)
   headers['user-agent'] = this.config.userAgent
+  if (this.config.scope) {
+    headers['npm-scope'] = this.config.scope
+  }
 
   return opts
 }
 
-function getAgent (protocol, config) {
+function getAgent (protocol) {
   if (protocol === 'https:') {
-    if (!httpsAgent) {
-      httpsAgent = new HttpsAgent({
+    if (!this.httpsAgent) {
+      this.httpsAgent = new HttpsAgent({
         keepAlive: true,
-        localAddress: config.proxy.localAddress,
-        rejectUnauthorized: config.ssl.strict,
-        ca: config.ssl.ca,
-        cert: config.ssl.certificate,
-        key: config.ssl.key
+        maxSockets: this.config.maxSockets,
+        localAddress: this.config.proxy.localAddress,
+        rejectUnauthorized: this.config.ssl.strict,
+        ca: this.config.ssl.ca,
+        cert: this.config.ssl.certificate,
+        key: this.config.ssl.key
       })
     }
 
-    return httpsAgent
+    return this.httpsAgent
   } else {
-    if (!httpAgent) {
-      httpAgent = new HttpAgent({
+    if (!this.httpAgent) {
+      this.httpAgent = new HttpAgent({
         keepAlive: true,
-        localAddress: config.proxy.localAddress
+        maxSockets: this.config.maxSockets,
+        localAddress: this.config.proxy.localAddress
       })
     }
 
-    return httpAgent
+    return this.httpAgent
   }
 }