superagent 3.8.1 → 4.0.0-beta.5

package/docs/test.html

@@ -265,7 +265,7 @@
 .post(uri + '/echo')
 .send({ name: 'tobi' })
 .end(function(err, res){
-  assert.equal(null, err);
+  assert.ifError(err)
   res.text.should.equal('{"name":"tobi"}');
   done();
 });</code></pre></dd>
@@ -662,7 +662,7 @@ request
 .get('http://localhost:5000/custom')
 .buffer()
 .end(function(err, res){
-  assert.equal(null, err);
+  assert.ifError(err)
   assert.equal('custom stuff', res.text);
   assert(res.buffered);
   done();
@@ -679,7 +679,7 @@ request
 .send('hello this is dog')
 .buffer(false)
 .end(function(err, res){
-  assert.equal(null, err);
+  assert.ifError(err)
   assert.equal(null, res.text);
   res.body.should.eql({});
   var buf = '';
@@ -734,7 +734,7 @@ done();</code></pre></dd>
 .type('application/x-dog')
 .send('hello this is dog')
 .end(function(err, res){
-  assert.equal(null, err);
+  assert.ifError(err)
   assert.equal(null, res.text);
   res.body.should.eql({});
   var buf = '';
@@ -761,7 +761,7 @@ request
 .send(img)
 .buffer(false)
 .end(function(err, res){
-  assert.equal(null, err);
+  assert.ifError(err)
   assert(!res.buffered);
   assert.equal(res.header['content-length'], Buffer.byteLength(img));
   done();
@@ -774,7 +774,7 @@ request
 .send(img)
 .buffer(true)
 .end(function(err, res){
-  assert.equal(null, err);
+  assert.ifError(err)
   assert(res.buffered);
   assert.equal(res.header['content-length'], img.length);
   done();

package/dump.js

@@ -0,0 +1 @@
+

package/lib/agent-base.js

@@ -3,17 +3,17 @@ function Agent() {
 }
 
 ["use", "on", "once", "set", "query", "type", "accept", "auth", "withCredentials", "sortQuery", "retry", "ok", "redirects",
- "timeout", "buffer", "serialize", "parse", "ca", "key", "pfx", "cert"].forEach(function(fn) {
+ "timeout", "buffer", "serialize", "parse", "ca", "key", "pfx", "cert"].forEach(fn => {
   /** Default setting for all requests from this agent */
-  Agent.prototype[fn] = function(/*varargs*/) {
-    this._defaults.push({fn:fn, arguments:arguments});
+  Agent.prototype[fn] = function(...args) {
+    this._defaults.push({fn, args});
     return this;
   }
 });
 
 Agent.prototype._setDefaults = function(req) {
-    this._defaults.forEach(function(def) {
-      req[def.fn].apply(req, def.arguments);
+    this._defaults.forEach(def => {
+      req[def.fn].apply(req, def.args);
     });
 };
 

package/lib/client.js

@@ -2,7 +2,7 @@
  * Root reference for iframes.
  */
 
-var root;
+let root;
 if (typeof window !== 'undefined') { // Browser window
   root = window;
 } else if (typeof self !== 'undefined') { // Web Worker
@@ -12,11 +12,11 @@ if (typeof window !== 'undefined') { // Browser window
   root = this;
 }
 
-var Emitter = require('component-emitter');
-var RequestBase = require('./request-base');
-var isObject = require('./is-object');
-var ResponseBase = require('./response-base');
-var Agent = require('./agent-base');
+const Emitter = require('component-emitter');
+const RequestBase = require('./request-base');
+const isObject = require('./is-object');
+const ResponseBase = require('./response-base');
+const Agent = require('./agent-base');
 
 /**
  * Noop.
@@ -28,7 +28,7 @@ function noop(){};
  * Expose `request`.
  */
 
-var request = exports = module.exports = function(method, url) {
+const request = exports = module.exports = function(method, url) {
   // callback
   if ('function' == typeof url) {
     return new exports.Request('GET', method).end(url);
@@ -40,7 +40,7 @@ var request = exports = module.exports = function(method, url) {
   }
 
   return new exports.Request(method, url);
-}
+};
 
 exports.Request = Request;
 
@@ -48,7 +48,7 @@ exports.Request = Request;
  * Determine XHR.
  */
 
-request.getXHR = function () {
+request.getXHR = () => {
   if (root.XMLHttpRequest
       && (!root.location || 'file:' != root.location.protocol
           || !root.ActiveXObject)) {
@@ -70,9 +70,9 @@ request.getXHR = function () {
  * @api private
  */
 
-var trim = ''.trim
-  ? function(s) { return s.trim(); }
-  : function(s) { return s.replace(/(^\s*|\s*$)/g, ''); };
+const trim = ''.trim
+  ? s => s.trim()
+  : s => s.replace(/(^\s*|\s*$)/g, '');
 
 /**
  * Serialize the given `obj`.
@@ -84,8 +84,8 @@ var trim = ''.trim
 
 function serialize(obj) {
   if (!isObject(obj)) return obj;
-  var pairs = [];
-  for (var key in obj) {
+  const pairs = [];
+  for (const key in obj) {
     pushEncodedKeyValuePair(pairs, key, obj[key]);
   }
   return pairs.join('&');
@@ -103,12 +103,12 @@ function serialize(obj) {
 function pushEncodedKeyValuePair(pairs, key, val) {
   if (val != null) {
     if (Array.isArray(val)) {
-      val.forEach(function(v) {
+      val.forEach(v => {
         pushEncodedKeyValuePair(pairs, key, v);
       });
     } else if (isObject(val)) {
-      for(var subkey in val) {
-        pushEncodedKeyValuePair(pairs, key + '[' + subkey + ']', val[subkey]);
+      for(const subkey in val) {
+        pushEncodedKeyValuePair(pairs, `${key}[${subkey}]`, val[subkey]);
       }
     } else {
       pairs.push(encodeURIComponent(key)
@@ -134,12 +134,12 @@ request.serializeObject = serialize;
   */
 
 function parseString(str) {
-  var obj = {};
-  var pairs = str.split('&');
-  var pair;
-  var pos;
+  const obj = {};
+  const pairs = str.split('&');
+  let pair;
+  let pos;
 
-  for (var i = 0, len = pairs.length; i < len; ++i) {
+  for (let i = 0, len = pairs.length; i < len; ++i) {
     pair = pairs[i];
     pos = pair.indexOf('=');
     if (pos == -1) {
@@ -186,7 +186,7 @@ request.types = {
 
 request.serialize = {
   'application/x-www-form-urlencoded': serialize,
-  'application/json': JSON.stringify,
+  'application/json': JSON.stringify
 };
 
 /**
@@ -200,7 +200,7 @@ request.serialize = {
 
 request.parse = {
   'application/x-www-form-urlencoded': parseString,
-  'application/json': JSON.parse,
+  'application/json': JSON.parse
 };
 
 /**
@@ -213,14 +213,14 @@ request.parse = {
  */
 
 function parseHeader(str) {
-  var lines = str.split(/\r?\n/);
-  var fields = {};
-  var index;
-  var line;
-  var field;
-  var val;
-
-  for (var i = 0, len = lines.length; i < len; ++i) {
+  const lines = str.split(/\r?\n/);
+  const fields = {};
+  let index;
+  let line;
+  let field;
+  let val;
+
+  for (let i = 0, len = lines.length; i < len; ++i) {
     line = lines[i];
     index = line.indexOf(':');
     if (index === -1) { // could be empty line, just skip it
@@ -243,7 +243,9 @@ function parseHeader(str) {
  */
 
 function isJSON(mime) {
-  return /[\/+]json\b/.test(mime);
+  // should match /json or +json
+  // but not /json-seq
+  return /[\/+]json($|[^-\w])/.test(mime);
 }
 
 /**
@@ -300,7 +302,7 @@ function Response(req) {
      ? this.xhr.responseText
      : null;
   this.statusText = this.req.xhr.statusText;
-  var status = this.xhr.status;
+  let status = this.xhr.status;
   // handle IE9 bug: http://stackoverflow.com/questions/10046972/msie-returns-status-code-of-1223-for-ajax-request
   if (status === 1223) {
     status = 204;
@@ -336,7 +338,7 @@ ResponseBase(Response.prototype);
  */
 
 Response.prototype._parseBody = function(str) {
-  var parse = request.parse[this.type];
+  let parse = request.parse[this.type];
   if (this.req._parser) {
     return this.req._parser(this, str);
   }
@@ -356,12 +358,12 @@ Response.prototype._parseBody = function(str) {
  */
 
 Response.prototype.toError = function(){
-  var req = this.req;
-  var method = req.method;
-  var url = req.url;
+  const req = this.req;
+  const method = req.method;
+  const url = req.url;
 
-  var msg = 'cannot ' + method + ' ' + url + ' (' + this.status + ')';
-  var err = new Error(msg);
+  const msg = `cannot ${method} ${url} (${this.status})`;
+  const err = new Error(msg);
   err.status = this.status;
   err.method = method;
   err.url = url;
@@ -384,15 +386,15 @@ request.Response = Response;
  */
 
 function Request(method, url) {
-  var self = this;
+  const self = this;
   this._query = this._query || [];
   this.method = method;
   this.url = url;
   this.header = {}; // preserves header name case
   this._header = {}; // coerces header names to lowercase
-  this.on('end', function(){
-    var err = null;
-    var res = null;
+  this.on('end', () => {
+    let err = null;
+    let res = null;
 
     try {
       res = new Response(self);
@@ -417,7 +419,7 @@ function Request(method, url) {
 
     self.emit('response', res);
 
-    var new_err;
+    let new_err;
     try {
       if (!self._isResponseOK(res)) {
         new_err = new Error(res.statusText || 'Unsuccessful HTTP response');
@@ -519,7 +521,7 @@ Request.prototype.auth = function(user, pass, options){
     };
   }
 
-  var encoder = function(string) {
+  const encoder = string => {
     if ('function' === typeof btoa) {
       return btoa(string);
     }
@@ -598,7 +600,7 @@ Request.prototype.callback = function(err, res){
     return this._retry();
   }
 
-  var fn = this._callback;
+  const fn = this._callback;
   this.clearTimeout();
 
   if (err) {
@@ -616,7 +618,7 @@ Request.prototype.callback = function(err, res){
  */
 
 Request.prototype.crossDomainError = function(){
-  var err = new Error('Request has been terminated\nPossible causes: the network is offline, Origin is not allowed by Access-Control-Allow-Origin, the page is being unloaded, etc.');
+  const err = new Error('Request has been terminated\nPossible causes: the network is offline, Origin is not allowed by Access-Control-Allow-Origin, the page is being unloaded, etc.');
   err.crossDomain = true;
 
   err.status = this.status;
@@ -633,7 +635,7 @@ Request.prototype.buffer = Request.prototype.ca = Request.prototype.agent = func
 };
 
 // This throws, because it can't send/receive data as expected
-Request.prototype.pipe = Request.prototype.write = function(){
+Request.prototype.pipe = Request.prototype.write = () => {
   throw Error("Streaming is not supported in browser version of superagent");
 };
 
@@ -671,19 +673,21 @@ Request.prototype.end = function(fn){
   // querystring
   this._finalizeQueryString();
 
-  return this._end();
+  this._end();
 };
 
 Request.prototype._end = function() {
-  var self = this;
-  var xhr = (this.xhr = request.getXHR());
-  var data = this._formData || this._data;
+  if (this._aborted) return this.callback(Error("The request has been aborted even before .end() was called"));
+
+  const self = this;
+  const xhr = (this.xhr = request.getXHR());
+  let data = this._formData || this._data;
 
   this._setTimeouts();
 
   // state change
-  xhr.onreadystatechange = function(){
-    var readyState = xhr.readyState;
+  xhr.onreadystatechange = () => {
+    const readyState = xhr.readyState;
     if (readyState >= 2 && self._responseTimeoutTimer) {
       clearTimeout(self._responseTimeoutTimer);
     }
@@ -693,7 +697,7 @@ Request.prototype._end = function() {
 
     // In IE9, reads to any property (e.g. status) off of an aborted XHR will
     // result in the error "Could not complete the operation due to error c00c023f"
-    var status;
+    let status;
     try { status = xhr.status } catch(e) { status = 0; }
 
     if (!status) {
@@ -704,7 +708,7 @@ Request.prototype._end = function() {
   };
 
   // progress
-  var handleProgress = function(direction, e) {
+  const handleProgress = (direction, e) => {
     if (e.total > 0) {
       e.percent = e.loaded / e.total * 100;
     }
@@ -742,8 +746,8 @@ Request.prototype._end = function() {
   // body
   if (!this._formData && 'GET' != this.method && 'HEAD' != this.method && 'string' != typeof data && !this._isHost(data)) {
     // serialize stuff
-    var contentType = this._header['content-type'];
-    var serialize = this._serializer || request.serialize[contentType ? contentType.split(';')[0] : ''];
+    const contentType = this._header['content-type'];
+    let serialize = this._serializer || request.serialize[contentType ? contentType.split(';')[0] : ''];
     if (!serialize && isJSON(contentType)) {
       serialize = request.serialize['application/json'];
     }
@@ -751,7 +755,7 @@ Request.prototype._end = function() {
   }
 
   // set header fields
-  for (var field in this.header) {
+  for (const field in this.header) {
     if (null == this.header[field]) continue;
 
     if (this.header.hasOwnProperty(field))
@@ -768,16 +772,13 @@ Request.prototype._end = function() {
   // IE11 xhr.send(undefined) sends 'undefined' string as POST payload (instead of nothing)
   // We need null here if data is undefined
   xhr.send(typeof data !== 'undefined' ? data : null);
-  return this;
 };
 
-request.agent = function() {
-  return new Agent();
-};
+request.agent = () => new Agent();
 
-["GET", "POST", "OPTIONS", "PATCH", "PUT", "DELETE"].forEach(function(method) {
+["GET", "POST", "OPTIONS", "PATCH", "PUT", "DELETE"].forEach(method => {
   Agent.prototype[method.toLowerCase()] = function(url, fn) {
-    var req = new request.Request(method, url);
+    const req = new request.Request(method, url);
     this._setDefaults(req);
     if (fn) {
       req.end(fn);
@@ -798,8 +799,8 @@ Agent.prototype.del = Agent.prototype['delete'];
  * @api public
  */
 
-request.get = function(url, data, fn) {
-  var req = request('GET', url);
+request.get = (url, data, fn) => {
+  const req = request('GET', url);
   if ('function' == typeof data) (fn = data), (data = null);
   if (data) req.query(data);
   if (fn) req.end(fn);
@@ -816,8 +817,8 @@ request.get = function(url, data, fn) {
  * @api public
  */
 
-request.head = function(url, data, fn) {
-  var req = request('HEAD', url);
+request.head = (url, data, fn) => {
+  const req = request('HEAD', url);
   if ('function' == typeof data) (fn = data), (data = null);
   if (data) req.query(data);
   if (fn) req.end(fn);
@@ -834,8 +835,8 @@ request.head = function(url, data, fn) {
  * @api public
  */
 
-request.options = function(url, data, fn) {
-  var req = request('OPTIONS', url);
+request.options = (url, data, fn) => {
+  const req = request('OPTIONS', url);
   if ('function' == typeof data) (fn = data), (data = null);
   if (data) req.send(data);
   if (fn) req.end(fn);
@@ -853,7 +854,7 @@ request.options = function(url, data, fn) {
  */
 
 function del(url, data, fn) {
-  var req = request('DELETE', url);
+  const req = request('DELETE', url);
   if ('function' == typeof data) (fn = data), (data = null);
   if (data) req.send(data);
   if (fn) req.end(fn);
@@ -873,8 +874,8 @@ request['delete'] = del;
  * @api public
  */
 
-request.patch = function(url, data, fn) {
-  var req = request('PATCH', url);
+request.patch = (url, data, fn) => {
+  const req = request('PATCH', url);
   if ('function' == typeof data) (fn = data), (data = null);
   if (data) req.send(data);
   if (fn) req.end(fn);
@@ -891,8 +892,8 @@ request.patch = function(url, data, fn) {
  * @api public
  */
 
-request.post = function(url, data, fn) {
-  var req = request('POST', url);
+request.post = (url, data, fn) => {
+  const req = request('POST', url);
   if ('function' == typeof data) (fn = data), (data = null);
   if (data) req.send(data);
   if (fn) req.end(fn);
@@ -909,8 +910,8 @@ request.post = function(url, data, fn) {
  * @api public
  */
 
-request.put = function(url, data, fn) {
-  var req = request('PUT', url);
+request.put = (url, data, fn) => {
+  const req = request('PUT', url);
   if ('function' == typeof data) (fn = data), (data = null);
   if (data) req.send(data);
   if (fn) req.end(fn);

package/lib/node/http2wrapper.js

@@ -0,0 +1,188 @@
+'use strict';
+
+const http2 = require('http2');
+const Stream = require('stream');
+const util = require('util');
+const net = require('net');
+const tls = require('tls');
+const parse = require('url').parse;
+
+const {
+  HTTP2_HEADER_PATH,
+  HTTP2_HEADER_STATUS,
+  HTTP2_HEADER_METHOD,
+  HTTP2_HEADER_AUTHORITY,
+  HTTP2_HEADER_HOST,
+  HTTP2_HEADER_SET_COOKIE,
+  NGHTTP2_CANCEL,
+} = http2.constants;
+
+
+function setProtocol(protocol) {
+  return {
+    request: function (options) {
+      return new Request(protocol, options);
+    }
+  }
+}
+
+function Request(protocol, options) {
+  Stream.call(this);
+  const defaultPort = protocol === 'https:' ? 443 : 80;
+  const defaultHost = 'localhost'
+  const port = options.port || defaultPort;
+  const host = options.host || defaultHost;
+
+  delete options.port
+  delete options.host
+
+  this.method = options.method;
+  this.path = options.path;
+  this.protocol = protocol;
+  this.host = host;
+
+  delete options.method
+  delete options.path
+
+  const sessionOptions = Object.assign({}, options);
+  if (options.socketPath) {
+    sessionOptions.socketPath = options.socketPath;
+    sessionOptions.createConnection = this.createUnixConnection.bind(this);
+  }
+
+  this._headers = {};
+
+  const session = http2.connect(`${protocol}//${host}:${port}`, sessionOptions);
+  this.setHeader('host', `${host}:${port}`)
+
+  session.on('error', (err) => this.emit('error', err));
+
+  this.session = session;
+}
+
+/**
+ * Inherit from `Stream` (which inherits from `EventEmitter`).
+ */
+util.inherits(Request, Stream);
+
+Request.prototype.createUnixConnection = function (authority, options) {
+  switch (this.protocol) {
+    case 'http:':
+      return net.connect(options.socketPath);
+    case 'https:':
+      options.ALPNProtocols = ['h2'];
+      options.servername = this.host;
+      options.allowHalfOpen = true;
+      return tls.connect(options.socketPath, options);
+    default:
+      throw new Error('Unsupported protocol', this.protocol);
+  }
+}
+
+Request.prototype.setNoDelay = function (bool) {
+  // We can not use setNoDelay with HTTP/2.
+  // Node 10 limits http2session.socket methods to ones safe to use with HTTP/2.
+  // See also https://nodejs.org/api/http2.html#http2_http2session_socket
+}
+
+Request.prototype.getFrame = function () {
+  if (this.frame) {
+    return this.frame;
+  }
+
+  const method = {
+    [HTTP2_HEADER_PATH]: this.path,
+    [HTTP2_HEADER_METHOD]: this.method,
+  }
+
+  let headers = this.mapToHttp2Header(this._headers);
+
+  headers = Object.assign(headers, method);
+
+  const frame = this.session.request(headers);
+  frame.once('response', (headers, flags) => {
+    headers = this.mapToHttpHeader(headers);
+    frame.headers = headers;
+    frame.status = frame.statusCode = headers[HTTP2_HEADER_STATUS];
+    this.emit('response', frame);
+  });
+
+  this._headerSent = true;
+
+  frame.once('drain', () => this.emit('drain'));
+  frame.on('error', (err) => this.emit('error', err));
+  frame.on('close', () => this.session.close());
+
+  this.frame = frame;
+  return frame;
+}
+
+Request.prototype.mapToHttpHeader = function (headers) {
+  const keys = Object.keys(headers);
+  const http2Headers = {};
+  for (var i = 0; i < keys.length; i++) {
+    let key = keys[i];
+    let value = headers[key];
+    key = key.toLowerCase();
+    switch (key) {
+      case HTTP2_HEADER_SET_COOKIE:
+        value = Array.isArray(value) ? value : [value];
+        break;
+      default:
+        break;
+    }
+    http2Headers[key] = value;
+  }
+  return http2Headers;
+}
+
+Request.prototype.mapToHttp2Header = function (headers) {
+  const keys = Object.keys(headers);
+  const http2Headers = {};
+  for (var i = 0; i < keys.length; i++) {
+    let key = keys[i];
+    let value = headers[key];
+    key = key.toLowerCase();
+    switch (key) {
+      case HTTP2_HEADER_HOST:
+        key = HTTP2_HEADER_AUTHORITY;
+        value = /^http\:\/\/|^https\:\/\//.test(value) ? parse(value).host : value;
+        break;
+      default:
+        break;
+    }
+    http2Headers[key] = value;
+  }
+  return http2Headers;
+}
+
+Request.prototype.setHeader = function (name, value) {
+  this._headers[name.toLowerCase()] = value;
+}
+
+Request.prototype.getHeader = function (name) {
+  return this._headers[name.toLowerCase()];
+}
+
+Request.prototype.write = function (data, encoding) {
+  const frame = this.getFrame();
+  return frame.write(data, encoding);
+};
+
+Request.prototype.pipe = function (stream, options) {
+  const frame = this.getFrame();
+  return frame.pipe(stream, options);
+}
+
+Request.prototype.end = function (data) {
+  const frame = this.getFrame();
+  frame.end(data);
+}
+
+Request.prototype.abort = function (data) {
+  const frame = this.getFrame();
+  frame.close(NGHTTP2_CANCEL);
+  this.session.destroy();
+}
+
+exports.setProtocol = setProtocol;