superagent 4.0.0-alpha.1 → 4.0.0-beta.5

package/lib/node/index.js

@@ -15,7 +15,6 @@ let methods = require('methods');
 const Stream = require('stream');
 const utils = require('../utils');
 const unzip = require('./unzip').unzip;
-const extend = require('extend');
 const mime = require('mime');
 const https = require('https');
 const http = require('http');
@@ -26,6 +25,12 @@ const util = require('util');
 const pkg = require('../../package.json');
 const RequestBase = require('../request-base');
 const CookieJar = require('cookiejar');
+let http2;
+try {
+  http2 = require('./http2wrapper');
+  console.warn('superagent: Enable experimental feature http2');
+} catch (_) {
+}
 
 function request(method, url) {
   // callback
@@ -81,6 +86,7 @@ mime.define({
 exports.protocols = {
   'http:': http,
   'https:': https,
+  'http2:': http2,
 };
 
 /**
@@ -144,6 +150,7 @@ function _initHeaders(req) {
 function Request(method, url) {
   Stream.call(this);
   if ('string' != typeof url) url = format(url);
+  this._enableHttp2 = !!process.env.HTTP2_TEST; // internal only
   this._agent = false;
   this._formData = null;
   this.method = method;
@@ -168,6 +175,43 @@ function Request(method, url) {
 util.inherits(Request, Stream);
 RequestBase(Request.prototype);
 
+/**
+ * Enable or Disable http2.
+ *
+ * Enable http2.
+ *
+ * ``` js
+ * request.get('http://localhost/')
+ *   .http2()
+ *   .end(callback);
+ *
+ * request.get('http://localhost/')
+ *   .http2(true)
+ *   .end(callback);
+ * ```
+ *
+ * Disable http2.
+ *
+ * ``` js
+ * request = request.http2();
+ * request.get('http://localhost/')
+ *   .http2(false)
+ *   .end(callback);
+ * ```
+ *
+ * @param {Boolean} enable
+ * @return {Request} for chaining
+ * @api public
+ */
+
+Request.prototype.http2 = function(bool){
+  if (exports.protocols['http2:'] === undefined){
+    throw new Error('superagent: does not support http2');
+  }
+  this._enableHttp2 = bool === undefined ? true : bool;
+  return this;
+}
+
 /**
  * Queue the given `file` as an attachment to the specified `field`,
  * with optional `options` (or filename).
@@ -319,7 +363,7 @@ Request.prototype.query = function(val){
   if ('string' == typeof val) {
     this._query.push(val);
   } else {
-    extend(this.qs, val);
+    Object.assign(this.qs, val);
   }
   return this;
 };
@@ -504,7 +548,7 @@ Request.prototype.auth = function(user, pass, options){
     options = { type: 'basic' };
   }
 
-  const encoder = string => new Buffer(string).toString('base64');
+  const encoder = string => new Buffer.from(string).toString('base64');
 
   return this._auth(user, pass, options, encoder);
 };
@@ -649,7 +693,7 @@ Request.prototype.request = function(){
   }
 
   // initiate request
-  const mod = exports.protocols[url.protocol];
+  const mod = this._enableHttp2 ? exports.protocols['http2:'].setProtocol(url.protocol) : exports.protocols[url.protocol];
 
   // request
   const req = (this.req = mod.request(options));
@@ -695,10 +739,10 @@ Request.prototype.request = function(){
 
   // add cookies
   if (this.cookies) {
-    if(this.header.hasOwnProperty('cookie')) {
+    if(this._header.hasOwnProperty('cookie')) {
       // merge
       const tmpJar = new CookieJar.CookieJar();
-      tmpJar.setCookies(this.header.cookie.split(';'));
+      tmpJar.setCookies(this._header.cookie.split(';'));
       tmpJar.setCookies(this.cookies.split(';'));
       req.setHeader('Cookie',tmpJar.getCookies(CookieJar.CookieAccessInfo.All).toValueString());
     } else {
@@ -789,6 +833,11 @@ Request.prototype._emitResponse = function(body, files) {
     response.body = body;
   }
   response.files = files;
+  if (this._endCalled) {
+    response.pipe = function() {
+      throw Error("end() has already been called, so it's too late to start piping");
+    }
+  }
   this.emit('response', response);
   return response;
 };
@@ -798,8 +847,8 @@ Request.prototype.end = function(fn) {
   debug('%s %s', this.method, this.url);
 
   if (this._endCalled) {
-    console.warn(
-      'Warning: .end() was called twice. This is not supported in superagent'
+    throw Error(
+      '.end() was called twice. This is not supported in superagent'
     );
   }
   this._endCalled = true;
@@ -807,7 +856,7 @@ Request.prototype.end = function(fn) {
   // store callback
   this._callback = fn || noop;
 
-  return this._end();
+  this._end();
 };
 
 Request.prototype._end = function() {
@@ -815,7 +864,6 @@ Request.prototype._end = function() {
 
   let data = this._data;
   const req = this.req;
-  let buffer = this._buffer;
   const method = this.method;
 
   this._setTimeouts();
@@ -827,7 +875,7 @@ Request.prototype._end = function() {
       let contentType = req.getHeader('Content-Type');
       // Parse out just the content type from the header (ignore the charset)
       if (contentType) contentType = contentType.split(';')[0];
-      let serialize = exports.serialize[contentType];
+      let serialize = this._serializer || exports.serialize[contentType];
       if (!serialize && isJSON(contentType)) {
         serialize = exports.serialize['application/json'];
       }
@@ -857,7 +905,6 @@ Request.prototype._end = function() {
     const type = mime.split('/')[0];
     const multipart = 'multipart' == type;
     const redirect = isRedirect(res.statusCode);
-    let parser = this._parser;
     const responseType = this._responseType;
 
     this.res = res;
@@ -878,10 +925,19 @@ Request.prototype._end = function() {
       unzip(req, res);
     }
 
+    let buffer = this._buffer;
     if (buffer === undefined && mime in exports.buffer){
       buffer = !!exports.buffer[mime];
     }
 
+    let parser = this._parser;
+    if (undefined === buffer) {
+      if (parser) {
+        console.warn("A custom superagent parser has been set, but buffering strategy for the parser hasn't been configured. Call `req.buffer(true or false)` or set `superagent.buffer[mime] = true or false`");
+        buffer = true;
+      }
+    }
+
     if (!parser) {
       if (responseType) {
         parser = exports.parse.image; // It's actually a generic Buffer
@@ -905,6 +961,9 @@ Request.prototype._end = function() {
         buffer = (buffer !== false);
       } else if (buffer) {
         parser = exports.parse.text;
+      } else if (undefined === buffer) {
+        parser = exports.parse.image; // It's actually a generic Buffer
+        buffer = true;
       }
     }
 
@@ -913,6 +972,7 @@ Request.prototype._end = function() {
       buffer = true;
     }
 
+    this._resBuffered = buffer;
     let parserHandlesEnd = false;
     if (buffer) {
       // Protectiona against zip bombs and other nuisance
@@ -1059,8 +1119,6 @@ Request.prototype._end = function() {
   } else {
     req.end(data);
   }
-
-  return this;
 };
 
 /**

package/lib/node/response.js

@@ -36,7 +36,7 @@ function Response(req) {
   this.text = res.text;
   this.body = res.body !== undefined ? res.body : {};
   this.files = res.files || {};
-  this.buffered = 'string' == typeof this.text;
+  this.buffered = req._resBuffered;
   this.header = this.headers = res.headers;
   this._setStatusProperties(res.statusCode);
   this._setHeaderProperties(this.header);

package/lib/node/unzip.js

@@ -59,9 +59,9 @@ exports.unzip = (req, res) => {
   const _on = res.on;
   res.on = function(type, fn) {
     if ('data' == type || 'end' == type) {
-      stream.on(type, fn);
+      stream.on(type, fn.bind(res));
     } else if ('error' == type) {
-      stream.on(type, fn);
+      stream.on(type, fn.bind(res));
       _on.call(res, type, fn);
     } else {
       _on.call(res, type, fn);

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "superagent",
-  "version": "4.0.0-alpha.1",
+  "version": "4.0.0-beta.5",
   "description": "elegant & feature rich browser / node HTTP with a fluent API",
   "scripts": {
     "prepare": "make all",
-    "test": "make test"
+    "test": "make test",
+    "test-http2": "make test-node-http2"
   },
   "keywords": [
     "http",
@@ -25,15 +26,14 @@
   },
   "dependencies": {
     "component-emitter": "^1.2.0",
-    "cookiejar": "^2.1.0",
-    "debug": "^3.1.0",
-    "extend": "^3.0.0",
+    "cookiejar": "^2.1.2",
+    "debug": "^4.0.0",
     "form-data": "^2.3.2",
     "formidable": "^1.2.0",
     "methods": "^1.1.1",
     "mime": "^2.0.3",
     "qs": "^6.5.1",
-    "readable-stream": "^2.3.5"
+    "readable-stream": "^3.0.3"
   },
   "devDependencies": {
     "Base64": "^1.0.1",
@@ -46,12 +46,12 @@
     "cookie-parser": "^1.4.3",
     "express": "^4.16.3",
     "express-session": "^1.15.6",
-    "marked": "^0.3.19",
+    "marked": "^0.5.0",
     "mocha": "^3.5.3",
     "multer": "^1.3.0",
     "should": "^13.2.0",
     "should-http": "^0.1.1",
-    "zuul": "^3.11.1"
+    "zuul": "^3.12.0"
   },
   "browser": {
     "./lib/node/index.js": "./lib/client.js",

package/superagent.js

@@ -1799,7 +1799,7 @@ Request.prototype.end = function (fn) {
   // querystring
   this._finalizeQueryString();
 
-  return this._end();
+  this._end();
 };
 
 Request.prototype._end = function () {
@@ -1901,7 +1901,6 @@ 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 () {