Allow any node-http-proxy options to be passed through via proxyOptions - re: BrowserSync/browser-sync#430

shakyShane · shakyShane · commit f6188910aa36 · 2015-05-03T20:54:17.000+01:00
diff --git a/cli.js b/cli.js
@@ -13,7 +13,7 @@ var https  = require("https");
  */
 if (!module.parent) {
     handleCli(meow({
-        help: fs.readFileSync(__dirname + "/help.txt", "utf8")
+        help: fs.readFileSync(path.join(__dirname, "/help.txt"), "utf8")
     }));
 }
 
diff --git a/lib/config.js b/lib/config.js
@@ -48,7 +48,18 @@ var defaults = Immutable.fromJS({
     /**
      *
      */
-    middleware: []
+    middleware: [],
+    /**
+     * Proxy Options.
+     */
+    proxyOptions: {
+        xfwd: false,
+        headers: {},
+        target: "",
+        // secure: false - This forces http-proxy to set rejectUnauthorized: false which allows self-signed certs
+        // which we are fine with considering this is a development tool, not to be used in production. :)
+        secure:  false
+    }
 });
 
 /**
diff --git a/lib/server.js b/lib/server.js
@@ -15,12 +15,10 @@ module.exports = function (config) {
     /**
      * Proxy server for final requests
      */
-    var proxy = httpProxy.createProxyServer({
-        target:  config.get("target"),
-        headers: config.get("reqHeaders")(config.toJS()),
-        secure:  false // What? This forces http-proxy to set rejectUnauthorized: false which allows self-signed certs
-                       // We are fine with this, considering this is a development tool, not to be used in production. :)
-    });
+    var proxy = httpProxy.createProxyServer(config.get('proxyOptions').merge({
+        target: config.get("target"),
+        headers: config.get("reqHeaders")(config.toJS())
+    }).toJS());
 
     /**
      * Proxy errors out to user errHandler
@@ -96,4 +94,4 @@ module.exports = function (config) {
     }
 
     return app;
-};
+};
diff --git a/test/src/server/proxyOptions.js b/test/src/server/proxyOptions.js
@@ -0,0 +1,54 @@
+var foxy      = require("../../../index");
+var connect   = require("connect");
+var sinon     = require("sinon");
+var http      = require("http");
+var assert    = require("chai").assert;
+
+var output = `
+<!doctype html>
+<html lang="en-US">
+<head>
+    <meta charset="UTF-8">
+    <title></title>
+</head>
+<body>
+    Hi there
+</body>
+</html>
+`;
+
+describe("Adding node-http-proxy options through configuration", () => {
+
+    it("should add xfwd headers if true in options", done => {
+        let config, app, server, proxyServer, port;
+        let path = "/templates/page1.html";
+        config = {
+            proxyOptions: {
+                xfwd: true
+            }
+        };
+        app = connect();
+        app.use(path, (req, res) => {
+            assert.equal(req.headers["x-forwarded-port"], port);
+            assert.ok(req.headers["x-forwarded-for"]);
+            res.end(output);
+        });
+        server = http.createServer(app).listen();
+        proxyServer = foxy(`http://localhost:${server.address().port}`, config).listen();
+        port = proxyServer.address().port;
+        let options = {
+            hostname: "localhost",
+            method: "GET",
+            headers: {
+                accept: "text/html"
+            },
+            port,
+            path
+        };
+        http.get(options, (res) => {
+            res.on("data", () => done());
+            server.close();
+        });
+    });
+});
+

Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@ var https = require("https");`
`13`	`13`	`*/`
`14`	`14`	`if (!module.parent) {`
`15`	`15`	`handleCli(meow({`
`16`		`- help: fs.readFileSync(__dirname + "/help.txt", "utf8")`
	`16`	`+ help: fs.readFileSync(path.join(__dirname, "/help.txt"), "utf8")`
`17`	`17`	`}));`
`18`	`18`	`}`
`19`	`19`