follow-redirects 1.3.0 → 1.5.1

package/README.md

@@ -79,6 +79,8 @@ the following per-request options are supported:
 
 - `agents` (default: `undefined`) – sets the `agent` option per protocol, since HTTP and HTTPS use different agents. Example value: `{ http: new http.Agent(), https: new https.Agent() }`
 
+- `trackRedirects` (default: `false`) – whether to store the redirected response details into the `redirects` array on the response object.
+
 
 ### Advanced usage
 By default, `follow-redirects` will use the Node.js default implementations

package/index.js

@@ -21,8 +21,10 @@ var eventHandlers = Object.create(null);
 function RedirectableRequest(options, responseCallback) {
   // Initialize the request
   Writable.call(this);
+  options.headers = options.headers || {};
   this._options = options;
   this._redirectCount = 0;
+  this._redirects = [];
   this._requestBodyLength = 0;
   this._requestBodyBuffers = [];
 
@@ -54,6 +56,64 @@ function RedirectableRequest(options, responseCallback) {
 }
 RedirectableRequest.prototype = Object.create(Writable.prototype);
 
+// Writes buffered data to the current native request
+RedirectableRequest.prototype.write = function (data, encoding, callback) {
+  if (!(typeof data === "string" || typeof data === "object" && ("length" in data))) {
+    throw new Error("data should be a string, Buffer or Uint8Array");
+  }
+  if (this._requestBodyLength + data.length <= this._options.maxBodyLength) {
+    this._requestBodyLength += data.length;
+    this._requestBodyBuffers.push({ data: data, encoding: encoding });
+    this._currentRequest.write(data, encoding, callback);
+  }
+  else {
+    this.emit("error", new Error("Request body larger than maxBodyLength limit"));
+    this.abort();
+  }
+};
+
+// Ends the current native request
+RedirectableRequest.prototype.end = function (data, encoding, callback) {
+  var currentRequest = this._currentRequest;
+  if (!data) {
+    currentRequest.end(null, null, callback);
+  }
+  else {
+    this.write(data, encoding, function () {
+      currentRequest.end(null, null, callback);
+    });
+  }
+};
+
+// Sets a header value on the current native request
+RedirectableRequest.prototype.setHeader = function (name, value) {
+  this._options.headers[name] = value;
+  this._currentRequest.setHeader(name, value);
+};
+
+// Clears a header value on the current native request
+RedirectableRequest.prototype.removeHeader = function (name) {
+  delete this._options.headers[name];
+  this._currentRequest.removeHeader(name);
+};
+
+// Proxy all other public ClientRequest methods
+[
+  "abort", "flushHeaders", "getHeader",
+  "setNoDelay", "setSocketKeepAlive", "setTimeout",
+].forEach(function (method) {
+  RedirectableRequest.prototype[method] = function (a, b) {
+    return this._currentRequest[method](a, b);
+  };
+});
+
+// Proxy all public ClientRequest properties
+["aborted", "connection", "socket"].forEach(function (property) {
+  Object.defineProperty(RedirectableRequest.prototype, property, {
+    get: function () { return this._currentRequest[property]; },
+  });
+});
+
 // Executes the next native request (initial or redirect)
 RedirectableRequest.prototype._performRequest = function () {
   // Load the native protocol
@@ -100,6 +160,15 @@ RedirectableRequest.prototype._performRequest = function () {
 
 // Processes a response from the current native request
 RedirectableRequest.prototype._processResponse = function (response) {
+  // Store the redirected response
+  if (this._options.trackRedirects) {
+    this._redirects.push({
+      url: this._currentUrl,
+      headers: response.headers,
+      statusCode: response.statusCode,
+    });
+  }
+
   // RFC7231§6.4: The 3xx (Redirection) class of status code indicates
   // that further action needs to be taken by the user agent in order to
   // fulfill the request. If a Location header field is provided,
@@ -151,66 +220,18 @@ RedirectableRequest.prototype._processResponse = function (response) {
     Object.assign(this._options, url.parse(redirectUrl));
     this._isRedirect = true;
     this._performRequest();
+
+    // Discard the remainder of the response to avoid waiting for data
+    response.destroy();
   }
   else {
     // The response is not a redirect; return it as-is
     response.responseUrl = this._currentUrl;
+    response.redirects = this._redirects;
     this.emit("response", response);
 
     // Clean up
-    delete this._options;
-    delete this._requestBodyBuffers;
-  }
-};
-
-// Aborts the current native request
-RedirectableRequest.prototype.abort = function () {
-  this._currentRequest.abort();
-};
-
-// Flushes the headers of the current native request
-RedirectableRequest.prototype.flushHeaders = function () {
-  this._currentRequest.flushHeaders();
-};
-
-// Sets the noDelay option of the current native request
-RedirectableRequest.prototype.setNoDelay = function (noDelay) {
-  this._currentRequest.setNoDelay(noDelay);
-};
-
-// Sets the socketKeepAlive option of the current native request
-RedirectableRequest.prototype.setSocketKeepAlive = function (enable, initialDelay) {
-  this._currentRequest.setSocketKeepAlive(enable, initialDelay);
-};
-
-// Sets the timeout option of the current native request
-RedirectableRequest.prototype.setTimeout = function (timeout, callback) {
-  this._currentRequest.setTimeout(timeout, callback);
-};
-
-// Writes buffered data to the current native request
-RedirectableRequest.prototype.write = function (data, encoding, callback) {
-  if (this._requestBodyLength + data.length <= this._options.maxBodyLength) {
-    this._requestBodyLength += data.length;
-    this._requestBodyBuffers.push({ data: data, encoding: encoding });
-    this._currentRequest.write(data, encoding, callback);
-  }
-  else {
-    this.emit("error", new Error("Request body larger than maxBodyLength limit"));
-    this.abort();
-  }
-};
-
-// Ends the current native request
-RedirectableRequest.prototype.end = function (data, encoding, callback) {
-  var currentRequest = this._currentRequest;
-  if (!data) {
-    currentRequest.end(null, null, callback);
-  }
-  else {
-    this.write(data, encoding, function () {
-      currentRequest.end(null, null, callback);
-    });
+    this._requestBodyBuffers = [];
   }
 };
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "follow-redirects",
-  "version": "1.3.0",
+  "version": "1.5.1",
   "description": "HTTP and HTTPS modules that follow redirects.",
   "main": "index.js",
   "engines": {
@@ -47,13 +47,13 @@
     "debug": "^3.1.0"
   },
   "devDependencies": {
-    "bluebird": "^3.4.0",
-    "concat-stream": "^1.5.2",
+    "bluebird": "^3.5.1",
+    "concat-stream": "^1.6.0",
     "coveralls": "^3.0.0",
-    "eslint": "^4.14.0",
-    "express": "^4.13.0",
-    "mocha": "^4.0.1",
-    "nyc": "^11.3.0"
+    "eslint": "^4.19.1",
+    "express": "^4.16.2",
+    "mocha": "^5.0.0",
+    "nyc": "^11.8.0"
   },
   "license": "MIT",
   "nyc": {