follow-redirects 1.6.0 → 1.8.1

package/README.md

@@ -1,11 +1,10 @@
 ## Follow Redirects
 
-Drop-in replacement for Nodes `http` and `https` that automatically follows redirects.
+Drop-in replacement for Node's `http` and `https` modules that automatically follows redirects.
 
 [![npm version](https://img.shields.io/npm/v/follow-redirects.svg)](https://www.npmjs.com/package/follow-redirects)
 [![Build Status](https://travis-ci.org/follow-redirects/follow-redirects.svg?branch=master)](https://travis-ci.org/follow-redirects/follow-redirects)
 [![Coverage Status](https://coveralls.io/repos/follow-redirects/follow-redirects/badge.svg?branch=master)](https://coveralls.io/r/follow-redirects/follow-redirects?branch=master)
-[![Dependency Status](https://david-dm.org/follow-redirects/follow-redirects.svg)](https://david-dm.org/follow-redirects/follow-redirects)
 [![npm downloads](https://img.shields.io/npm/dm/follow-redirects.svg)](https://www.npmjs.com/package/follow-redirects)
 
 `follow-redirects` provides [request](https://nodejs.org/api/http.html#http_http_request_options_callback) and [get](https://nodejs.org/api/http.html#http_http_get_options_callback)
@@ -13,14 +12,13 @@ Drop-in replacement for Nodes `http` and `https` that automatically follows redi
  modules, with the exception that they will seamlessly follow redirects.
 
 ```javascript
-var http = require('follow-redirects').http;
-var https = require('follow-redirects').https;
+const { http, https } = require('follow-redirects');
 
-http.get('http://bit.ly/900913', function (response) {
-  response.on('data', function (chunk) {
+http.get('http://bit.ly/900913', response => {
+  response.on('data', chunk => {
     console.log(chunk);
   });
-}).on('error', function (err) {
+}).on('error', err => {
   console.error(err);
 });
 ```
@@ -32,7 +30,7 @@ If no redirection happened, `responseUrl` is the original request URL.
 https.request({
   host: 'bitly.com',
   path: '/UHfDGO',
-}, function (response) {
+}, response => {
   console.log(response.responseUrl);
   // 'http://duckduckgo.com/robots.txt'
 });
@@ -43,7 +41,7 @@ https.request({
 Global options are set directly on the `follow-redirects` module:
 
 ```javascript
-var followRedirects = require('follow-redirects');
+const followRedirects = require('follow-redirects');
 followRedirects.maxRedirects = 10;
 followRedirects.maxBodyLength = 20 * 1024 * 1024; // 20 MB
 ```
@@ -54,16 +52,22 @@ The following global options are supported:
 
 - `maxBodyLength` (default: 10MB) – sets the maximum size of the request body; if exceeded, an error will be emitted.
 
-
 ### Per-request options
 Per-request options are set by passing an `options` object:
 
 ```javascript
-var url = require('url');
-var followRedirects = require('follow-redirects');
+const url = require('url');
+const { http, https } = require('follow-redirects');
 
-var options = url.parse('http://bit.ly/900913');
+const options = url.parse('http://bit.ly/900913');
 options.maxRedirects = 10;
+options.beforeRedirect = options => {
+  // Use this function to adjust the options upon redirecting,
+  // or to cancel the request by throwing an error
+  if (options.hostname === "example.com") {
+    options.auth = "user:password";
+  }
+};
 http.request(options);
 ```
 
@@ -75,6 +79,8 @@ the following per-request options are supported:
 
 - `maxBodyLength` (default: 10MB) – sets the maximum size of the request body; if exceeded, an error will be emitted.
 
+- `beforeRedirect` (default: `undefined`) – optionally change the request `options` on redirects, or abort the request by throwing an error.
+
 - `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.
@@ -88,7 +94,7 @@ To enable features such as caching and/or intermediate request tracking,
 you might instead want to wrap `follow-redirects` around custom protocol implementations:
 
 ```javascript
-var followRedirects = require('follow-redirects').wrap({
+const { http, https } = require('follow-redirects').wrap({
   http: require('your-custom-http'),
   https: require('your-custom-https'),
 });
@@ -96,42 +102,26 @@ var followRedirects = require('follow-redirects').wrap({
 
 Such custom protocols only need an implementation of the `request` method.
 
-## Browserify Usage
+## Browser Usage
 
-Due to the way `XMLHttpRequest` works, the `browserify` versions of `http` and `https` already follow redirects.
- If you are *only* targeting the browser, then this library has little value for you. If you want to write cross
- platform code for node and the browser, `follow-redirects` provides a great solution for making the native node
- modules behave the same as they do in browserified builds in the browser. To avoid bundling unnecessary code
- you should tell browserify to swap out `follow-redirects` with the standard modules when bundling.
- To make this easier, you need to change how you require the modules:
+Due to the way the browser works,
+the `http` and `https` browser equivalents perform redirects by default.
 
+By requiring `follow-redirects` this way:
 ```javascript
-var http = require('follow-redirects/http');
-var https = require('follow-redirects/https');
+const http = require('follow-redirects/http');
+const https = require('follow-redirects/https');
 ```
+you can easily tell webpack and friends to replace
+`follow-redirect` by the built-in versions:
 
-You can then replace `follow-redirects` in your browserify configuration like so:
-
-```javascript
-"browser": {
+```json
+{
   "follow-redirects/http"  : "http",
   "follow-redirects/https" : "https"
 }
 ```
 
-The `browserify-http` module has not kept pace with node development, and no long behaves identically to the native
- module when running in the browser. If you are experiencing problems, you may want to check out
- [browserify-http-2](https://www.npmjs.com/package/http-browserify-2). It is more actively maintained and
- attempts to address a few of the shortcomings of `browserify-http`. In that case, your browserify config should
- look something like this:
-
-```javascript
-"browser": {
-  "follow-redirects/http"  : "browserify-http-2/http",
-  "follow-redirects/https" : "browserify-http-2/https"
-}
-```
-
 ## Contributing
 
 Pull Requests are always welcome. Please [file an issue](https://github.com/follow-redirects/follow-redirects/issues)
@@ -146,9 +136,9 @@ Pull Requests are always welcome. Please [file an issue](https://github.com/foll
 
 ## Authors
 
+- [Ruben Verborgh](https://ruben.verborgh.org/)
 - Olivier Lalonde (olalonde@gmail.com)
 - James Talmage (james@talmage.io)
-- [Ruben Verborgh](https://ruben.verborgh.org/)
 
 ## License
 

package/index.js

@@ -22,7 +22,7 @@ var eventHandlers = Object.create(null);
 function RedirectableRequest(options, responseCallback) {
   // Initialize the request
   Writable.call(this);
-  options.headers = options.headers || {};
+  this._sanitizeOptions(options);
   this._options = options;
   this._ended = false;
   this._ending = false;
@@ -31,17 +31,6 @@ function RedirectableRequest(options, responseCallback) {
   this._requestBodyLength = 0;
   this._requestBodyBuffers = [];
 
-  // Since http.request treats host as an alias of hostname,
-  // but the url module interprets host as hostname plus port,
-  // eliminate the host property to avoid confusion.
-  if (options.host) {
-    // Use hostname if set, because it has precedence
-    if (!options.hostname) {
-      options.hostname = options.host;
-    }
-    delete options.host;
-  }
-
   // Attach a callback if passed
   if (responseCallback) {
     this.on("response", responseCallback);
@@ -53,18 +42,6 @@ function RedirectableRequest(options, responseCallback) {
     self._processResponse(response);
   };
 
-  // Complete the URL object when necessary
-  if (!options.pathname && options.path) {
-    var searchPos = options.path.indexOf("?");
-    if (searchPos < 0) {
-      options.pathname = options.path;
-    }
-    else {
-      options.pathname = options.path.substring(0, searchPos);
-      options.search = options.path.substring(searchPos);
-    }
-  }
-
   // Perform the first request
   this._performRequest();
 }
@@ -147,10 +124,43 @@ RedirectableRequest.prototype.removeHeader = function (name) {
   this._currentRequest.removeHeader(name);
 };
 
+// Global timeout for all underlying requests
+RedirectableRequest.prototype.setTimeout = function (msecs, callback) {
+  if (callback) {
+    this.once("timeout", callback);
+  }
+
+  if (this.socket) {
+    startTimer(this, msecs);
+  }
+  else {
+    var self = this;
+    this._currentRequest.once("socket", function () {
+      startTimer(self, msecs);
+    });
+  }
+
+  this.once("response", clearTimer);
+  this.once("error", clearTimer);
+
+  return this;
+};
+
+function startTimer(request, msecs) {
+  clearTimeout(request._timeout);
+  request._timeout = setTimeout(function () {
+    request.emit("timeout");
+  }, msecs);
+}
+
+function clearTimer() {
+  clearTimeout(this._timeout);
+}
+
 // Proxy all other public ClientRequest methods
 [
   "abort", "flushHeaders", "getHeader",
-  "setNoDelay", "setSocketKeepAlive", "setTimeout",
+  "setNoDelay", "setSocketKeepAlive",
 ].forEach(function (method) {
   RedirectableRequest.prototype[method] = function (a, b) {
     return this._currentRequest[method](a, b);
@@ -164,6 +174,37 @@ RedirectableRequest.prototype.removeHeader = function (name) {
   });
 });
 
+RedirectableRequest.prototype._sanitizeOptions = function (options) {
+  // Ensure headers are always present
+  if (!options.headers) {
+    options.headers = {};
+  }
+
+  // Since http.request treats host as an alias of hostname,
+  // but the url module interprets host as hostname plus port,
+  // eliminate the host property to avoid confusion.
+  if (options.host) {
+    // Use hostname if set, because it has precedence
+    if (!options.hostname) {
+      options.hostname = options.host;
+    }
+    delete options.host;
+  }
+
+  // Complete the URL object when necessary
+  if (!options.pathname && options.path) {
+    var searchPos = options.path.indexOf("?");
+    if (searchPos < 0) {
+      options.pathname = options.path;
+    }
+    else {
+      options.pathname = options.path.substring(0, searchPos);
+      options.search = options.path.substring(searchPos);
+    }
+  }
+};
+
+
 // Executes the next native request (initial or redirect)
 RedirectableRequest.prototype._performRequest = function () {
   // Load the native protocol
@@ -231,11 +272,12 @@ RedirectableRequest.prototype._performRequest = function () {
 // Processes a response from the current native request
 RedirectableRequest.prototype._processResponse = function (response) {
   // Store the redirected response
+  var statusCode = response.statusCode;
   if (this._options.trackRedirects) {
     this._redirects.push({
       url: this._currentUrl,
       headers: response.headers,
-      statusCode: response.statusCode,
+      statusCode: statusCode,
     });
   }
 
@@ -247,11 +289,13 @@ RedirectableRequest.prototype._processResponse = function (response) {
   // even if the specific status code is not understood.
   var location = response.headers.location;
   if (location && this._options.followRedirects !== false &&
-      response.statusCode >= 300 && response.statusCode < 400) {
+      statusCode >= 300 && statusCode < 400) {
     // Abort the current request
     this._currentRequest.removeAllListeners();
     this._currentRequest.on("error", noop);
     this._currentRequest.abort();
+    // Discard the remainder of the response to avoid waiting for data
+    response.destroy();
 
     // RFC7231§6.4: A client SHOULD detect and intervene
     // in cyclical redirections (i.e., "infinite" redirection loops).
@@ -269,7 +313,7 @@ RedirectableRequest.prototype._processResponse = function (response) {
     // if it performs an automatic redirection to that URI.
     var header;
     var headers = this._options.headers;
-    if (response.statusCode !== 307 && !(this._options.method in SAFE_METHODS)) {
+    if (statusCode !== 307 && !(this._options.method in SAFE_METHODS)) {
       this._options.method = "GET";
       // Drop a possible entity and headers related to it
       this._requestBodyBuffers = [];
@@ -293,11 +337,18 @@ RedirectableRequest.prototype._processResponse = function (response) {
     var redirectUrl = url.resolve(this._currentUrl, location);
     debug("redirecting to", redirectUrl);
     Object.assign(this._options, url.parse(redirectUrl));
+    if (typeof this._options.beforeRedirect === "function") {
+      try {
+        this._options.beforeRedirect.call(null, this._options);
+      }
+      catch (err) {
+        this.emit("error", err);
+        return;
+      }
+      this._sanitizeOptions(this._options);
+    }
     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
@@ -387,7 +438,7 @@ function urlToOptions(urlObject) {
     hash: urlObject.hash,
     search: urlObject.search,
     pathname: urlObject.pathname,
-    path: `${urlObject.pathname}${urlObject.search}`,
+    path: urlObject.pathname + urlObject.search,
     href: urlObject.href,
   };
   if (urlObject.port !== "") {

package/package.json

@@ -1,8 +1,12 @@
 {
   "name": "follow-redirects",
-  "version": "1.6.0",
+  "version": "1.8.1",
   "description": "HTTP and HTTPS modules that follow redirects.",
+  "license": "MIT",
   "main": "index.js",
+  "files": [
+    "*.js"
+  ],
   "engines": {
     "node": ">=4.0"
   },
@@ -33,28 +37,15 @@
     "Olivier Lalonde <olalonde@gmail.com> (http://www.syskall.com)",
     "James Talmage <james@talmage.io>"
   ],
-  "files": [
-    "index.js",
-    "create.js",
-    "http.js",
-    "https.js"
-  ],
   "dependencies": {
-    "debug": "=3.1.0"
+    "debug": "^3.0.0"
   },
   "devDependencies": {
-    "concat-stream": "^1.6.0",
-    "coveralls": "^3.0.2",
-    "eslint": "^4.19.1",
-    "express": "^4.16.2",
-    "mocha": "^5.0.0",
-    "nyc": "^11.8.0"
-  },
-  "license": "MIT",
-  "nyc": {
-    "reporter": [
-      "lcov",
-      "text"
-    ]
+    "concat-stream": "^2.0.0",
+    "eslint": "^5.16.0",
+    "express": "^4.16.4",
+    "lolex": "^3.1.0",
+    "mocha": "^6.0.2",
+    "nyc": "^14.1.1"
   }
 }