feat(rewrite): Allow addtional HTML rewrite rules through server + pr…

…oxy modes to help with #514
BrowserSync · Mar 21, 2015 · 76ae686 · 76ae686
1 parent 2371d22
commit 76ae686
Show file tree

Hide file tree

Showing 6 changed files with 129 additions and 9 deletions.
diff --git a/lib/default-config.js b/lib/default-config.js
@@ -163,6 +163,12 @@ module.exports = {
         }
     },
 
+    /**
+     * @property rewriteRules
+     * @default false
+     */
+    rewriteRules: false,
+
     /**
      * @property tunnel
      * @type String|Boolean

diff --git a/lib/server/proxy-server.js b/lib/server/proxy-server.js
@@ -35,9 +35,14 @@ function getOptions (bs, scripts) {
     var options  = bs.options;
 
     var snippetOptions = options.get("snippetOptions").toJS();
+    var rewrites = [snippetUtils.getRegex(options.get("snippet"), options.get("snippetOptions"))];
+
+    if (bs.options.get("rewriteRules")) {
+        rewrites = rewrites.concat(bs.options.get("rewriteRules").toJS());
+    }
 
     var out = {
-        rules:       snippetUtils.getRegex(options.get("snippet"), options.get("snippetOptions")),
+        rules:       rewrites,
         whitelist:   snippetOptions.whitelist,
         blacklist:   snippetOptions.blacklist,
         middleware:  options.get("middleware").push(getPluginMiddleware(bs, scripts)),

diff --git a/lib/server/static-server.js b/lib/server/static-server.js
@@ -43,7 +43,8 @@ module.exports = function createServer (bs, scripts) {
     app.use(
         snippetUtils.getSnippetMiddleware(
             options.get("snippet"),
-            options.get("snippetOptions")
+            options.get("snippetOptions"),
+            options.get("rewriteRules")
         )
     );
 

diff --git a/lib/snippet.js b/lib/snippet.js
@@ -46,14 +46,13 @@ var utils = {
             fn: fn
         };
     },
-    /**
-     * @param {String} snippet
-     * @param {Object} [options]
-     * @returns {Function}
-     */
-    getSnippetMiddleware: function (snippet, options) {
+    getSnippetMiddleware: function (snippet, options, rewriteRules) {
+        var rules = [utils.getRegex(snippet, options)];
+        if (rewriteRules) {
+            rules = rules.concat(rewriteRules.toJS());
+        }
         return lrSnippet({
-            rules: [utils.getRegex(snippet, options)],
+            rules: rules,
             blacklist: options.get("blacklist").toJS(),
             whitelist: options.get("whitelist").toJS()
         });

diff --git a/test/specs/e2e/proxy/e2e.proxy.rewrite.rules.js b/test/specs/e2e/proxy/e2e.proxy.rewrite.rules.js
@@ -0,0 +1,59 @@
+"use strict";
+
+var browserSync = require("../../../../index");
+
+var connect = require("connect");
+var serveStatic = require("serve-static");
+var request = require("supertest");
+var assert = require("chai").assert;
+
+describe("E2E proxy test with rewrite rules", function () {
+
+    var instance, server, options;
+
+    before(function (done) {
+
+        browserSync.reset();
+
+        var app = connect();
+        app.use(serveStatic("./test/fixtures"));
+        server = app.listen();
+        var proxytarget = "http://localhost:" + server.address().port;
+
+        var config = {
+            proxy:     proxytarget,
+            logLevel: "silent",
+            open:      false,
+            rewriteRules: [
+                {
+                    match: /Forms/g,
+                    fn: function () {
+                        return "Shane's forms";
+                    }
+                }
+            ]
+        };
+
+        instance = browserSync.init([], config, function (err, bs) {
+            options = bs.options;
+            done();
+        }).instance;
+    });
+
+    after(function () {
+        instance.cleanup();
+        server.close();
+    });
+
+    it("serves files with HTML rewritten", function (done) {
+
+        request(instance.server)
+            .get("/index.html")
+            .set("accept", "text/html")
+            .expect(200)
+            .end(function (err, res) {
+                assert.include(res.text, "Shane's forms");
+                done();
+            });
+    });
+});
diff --git a/test/specs/e2e/server/e2e.server.rewrite.rules.js b/test/specs/e2e/server/e2e.server.rewrite.rules.js
@@ -0,0 +1,50 @@
+"use strict";
+
+var browserSync = require("../../../../index");
+
+var request = require("supertest");
+var assert  = require("chai").assert;
+
+describe("E2E server test with rewrite rules", function () {
+
+    var instance;
+
+    before(function (done) {
+
+        browserSync.reset();
+
+        var config = {
+            server: {
+                baseDir: "test/fixtures"
+            },
+            rewriteRules: [
+                {
+                    match: /Forms/g,
+                    fn: function () {
+                        return "Shane's forms";
+                    }
+                }
+            ],
+            logLevel: "silent",
+            open: false
+        };
+
+        instance = browserSync.init(config, done).instance;
+    });
+
+    after(function () {
+        instance.cleanup();
+    });
+
+    it("serves files with HTML rewritten", function (done) {
+
+        request(instance.server)
+            .get("/index.html")
+            .set("accept", "text/html")
+            .expect(200)
+            .end(function (err, res) {
+                assert.include(res.text, "Shane's forms");
+                done();
+            });
+    });
+});