📝 Add host rewrite docs and specs.

http-party · Nov 24, 2014 · add8133 · add8133
1 parent daf66a7
commit add8133
Show file tree

Hide file tree

Showing 3 changed files with 54 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -325,6 +325,7 @@ proxyServer.listen(8015);
  *  **secure**: true/false, if you want to verify the SSL Certs
  *  **xfwd**: true/false, adds x-forward headers
  *  **toProxy**: passes the absolute URL as the `path` (useful for proxying to proxies)
+ *  **hostRewrite**: rewrites the location hostname on (301/302/307/308) redirects.
 
 If you are using the `proxyServer.listen` method, the following options are also applicable:
 

diff --git a/lib/http-proxy.js b/lib/http-proxy.js
@@ -41,6 +41,7 @@ module.exports.createProxyServer =
    *    prependPath: <true/false, Default: true - specify whether you want to prepend the target's path to the proxy path>
    *    localAddress : <Local interface string to bind for outgoing connections>
    *    changeOrigin: <true/false, Default: false - changes the origin of the host header to the target URL>
+   *    hostRewrite: rewrites the location hostname on (301/302/307/308) redirects, Default: null.
    *  }
    *
    *  NOTE: `options.ws` and `options.ssl` are optional.

diff --git a/test/lib-http-proxy-passes-web-outgoing-test.js b/test/lib-http-proxy-passes-web-outgoing-test.js
@@ -2,6 +2,58 @@ var httpProxy = require('../lib/http-proxy/passes/web-outgoing'),
     expect = require('expect.js');
 
 describe('lib/http-proxy/passes/web-outgoing.js', function () {
+  describe('#setRedirectHostRewrite', function () {
+    context('rewrites location host to option', function() {
+      beforeEach(function() {
+        this.proxyRes = {
+          statusCode: 301,
+          headers: {
+            location: "http://f.com/"
+          }
+        };
+
+        this.options = {
+          hostRewrite: "x.com"
+        };
+      });
+
+      it('on 301', function() {
+        this.proxyRes.statusCode = 301;
+        httpProxy.setRedirectHostRewrite({}, {}, this.proxyRes, this.options);
+        expect(this.proxyRes.headers.location).to.eql('http://'+this.options.hostRewrite+'/');
+      });
+
+      it('on 302', function() {
+        this.proxyRes.statusCode = 302;
+        httpProxy.setRedirectHostRewrite({}, {}, this.proxyRes, this.options);
+        expect(this.proxyRes.headers.location).to.eql('http://'+this.options.hostRewrite+'/');
+      });
+
+      it('on 307', function() {
+        this.proxyRes.statusCode = 307;
+        httpProxy.setRedirectHostRewrite({}, {}, this.proxyRes, this.options);
+        expect(this.proxyRes.headers.location).to.eql('http://'+this.options.hostRewrite+'/');
+      });
+
+      it('on 308', function() {
+        this.proxyRes.statusCode = 308;
+        httpProxy.setRedirectHostRewrite({}, {}, this.proxyRes, this.options);
+        expect(this.proxyRes.headers.location).to.eql('http://'+this.options.hostRewrite+'/');
+      });
+
+      it('not on 200', function() {
+        this.proxyRes.statusCode = 200;
+        httpProxy.setRedirectHostRewrite({}, {}, this.proxyRes, this.options);
+        expect(this.proxyRes.headers.location).to.eql('http://f.com/');
+      });
+
+      it('not when hostRewrite is unset', function() {
+        httpProxy.setRedirectHostRewrite({}, {}, this.proxyRes, {});
+        expect(this.proxyRes.headers.location).to.eql('http://f.com/');
+      });
+    });
+  });
+
   describe('#setConnection', function () {
     it('set the right connection with 1.0 - `close`', function() {
       var proxyRes = { headers: {} };