follow-redirects 1.4.1 → 1.5.0

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

@@ -24,6 +24,7 @@ function RedirectableRequest(options, responseCallback) {
   options.headers = options.headers || {};
   this._options = options;
   this._redirectCount = 0;
+  this._redirects = [];
   this._requestBodyLength = 0;
   this._requestBodyBuffers = [];
 
@@ -57,6 +58,9 @@ 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 });
@@ -156,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,
@@ -211,6 +224,7 @@ RedirectableRequest.prototype._processResponse = function (response) {
   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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "follow-redirects",
-  "version": "1.4.1",
+  "version": "1.5.0",
   "description": "HTTP and HTTPS modules that follow redirects.",
   "main": "index.js",
   "engines": {
@@ -50,10 +50,10 @@
     "bluebird": "^3.5.1",
     "concat-stream": "^1.6.0",
     "coveralls": "^3.0.0",
-    "eslint": "^4.16.0",
+    "eslint": "^4.19.1",
     "express": "^4.16.2",
     "mocha": "^5.0.0",
-    "nyc": "^11.4.1"
+    "nyc": "^11.8.0"
   },
   "license": "MIT",
   "nyc": {