Merge pull request #1225 from BrowserSync/rewrites

fix run-time middleware assignment - fixes #1223

Author: shakyShane

crossbow.yaml

@@ -0,0 +1,16 @@
+tasks:
+  unit:
+    - '@npm mocha test/specs/api/** --recursive'
+    - '@npm mocha test/specs/cli/** --recursive'
+    - '@npm mocha test/specs/commands/** --recursive'
+    - '@npm mocha test/specs/e2e/** --recursive'
+    - '@npm mocha test/specs/files/** --recursive'
+    - '@npm mocha test/specs/hooks/** --recursive'
+    - '@npm mocha test/specs/http-protocol/** --recursive'
+    - '@npm mocha test/specs/instances/** --recursive'
+    - '@npm mocha test/specs/logger/** --recursive'
+    - '@npm mocha test/specs/options/** --recursive'
+    - '@npm mocha test/specs/plugins/** --recursive'
+    - '@npm mocha test/specs/resp-mod/** --recursive'
+    - '@npm mocha test/specs/server/** --recursive'
+    - '@npm mocha test/specs/utils/** --recursive'

lib/async-tasks.js

@@ -33,14 +33,6 @@ module.exports = [
         step: "Merging middlewares from core + plugins",
         fn: async.mergeMiddlewares
     },
-    {
-        step: "Setting the rewrite rules given in initial options",
-        fn: async.setUserRewriteRules
-    },
-    {
-        step: "Setting the rewrite rules middleware for snippet",
-        fn: async.setRewriteRules
-    },
     {
         step: "Starting the Server",
         fn: async.startServer
@@ -53,10 +45,6 @@ module.exports = [
         step: "Starting the web-socket server",
         fn: async.startSockets
     },
-    {
-        step: "Adding the HTTP protocol",
-        fn: async.addHttpProtocol
-    },
     {
         step: "Starting the UI",
         fn: async.startUi

lib/async.js

@@ -186,61 +186,16 @@ module.exports = {
             }
         });
     },
-    /**
-     * If any rewrite rules were given in the options
-     * save them in their raw state as they will
-     * be live updated inside resp-modifier/foxy
-     * @param bs
-     * @param done
-     */
-    setUserRewriteRules: function (bs, done) {
-        var userRules = bs.options.get("rewriteRules");
-        done(null, {
-            instance: {
-                rewriteRules: userRules ? userRules.toJS() : []
-            }
-        });
-    },
-    /**
-     * Set the built-in rewrite rules
-     * @param bs
-     * @param done
-     */
-    setRewriteRules: function (bs, done) {
-        var snippetUtils = require("./snippet").utils;
-        done(null, {
-            instance: {
-                snippetMw: snippetUtils.getSnippetMiddleware(
-                    bs.options.get("snippet"),
-                    bs.options.get("snippetOptions"),
-                    bs.rewriteRules
-                )
-            }
-        });
-    },
     /**
      * @param {BrowserSync} bs
      * @param {Function} done
      */
     startServer: function (bs, done) {
 
-        var clientJs = bs.pluginManager.hook("client:js", {
-            port: bs.options.get("port"),
-            options: bs.options
-        });
-
-        var server = bs.pluginManager.get("server")(
-            bs,
-            bs.pluginManager.get("client:script")(
-                bs.options.toJS(),
-                clientJs,
-                "middleware"
-            )
-        );
+        var server = bs.pluginManager.get("server")(bs);
 
         done(null, {
             instance: {
-                clientJs: clientJs,
                 server: server.server,
                 app: server.app
             }
@@ -301,27 +256,6 @@ module.exports = {
             }
         });
     },
-    /**
-     * @param bs
-     * @param done
-     */
-    addHttpProtocol: function (bs, done) {
-
-        /**
-         * Add a middleware to listen to http
-         * requests in the BrowserSync http protocol namespace
-         */
-        bs.addMiddleware(
-            require("./config").httpProtocol.path,
-            require("./http-protocol").middleware(bs),
-            {
-                override: true,
-                id: "Browsersync HTTP Protocol"
-            }
-        );
-
-        done();
-    },
     /**
      *
      * @param {BrowserSync} bs

lib/browser-sync.js

@@ -420,10 +420,14 @@ BrowserSync.prototype.addMiddleware = function (route, handle, opts) {
     };
 
     if (opts.override) {
-        return bs.app.stack.unshift(entry);
+        entry.override = true;
     }
 
-    bs._addMiddlewareToStack(entry);
+    bs.options = bs.options.update("middleware", function (mw) {
+        return mw.concat(entry);
+    });
+
+    bs.resetMiddlewareStack();
 };
 
 /**
@@ -439,15 +443,13 @@ BrowserSync.prototype.removeMiddleware = function (id) {
         return;
     }
 
-    bs.app.stack = bs.app.stack.filter(function (item) {
-        if (!item.id) {
-            return true;
-        }
-
-        return item.id !== id;
+    bs.options = bs.options.update("middleware", function (mw) {
+        return mw.filter(function (mw) {
+            return mw.id !== id;
+        });
     });
 
-    return bs.app;
+    bs.resetMiddlewareStack();
 };
 
 /**
@@ -586,41 +588,46 @@ BrowserSync.prototype.setMany = function (fn, opts) {
     return this.options;
 };
 
-/**
- * Remove a rewrite rule by id
- */
-BrowserSync.prototype.removeRewriteRule = function (id) {
+BrowserSync.prototype.addRewriteRule = function (rule) {
     var bs = this;
 
-    bs.setRewriteRules(bs.rewriteRules.filter(fn));
+    bs.options = bs.options.update("rewriteRules", function (rules) {
+        return rules.concat(rule);
+    });
 
-    function fn (item) {
-        if (item.id) {
-            return item.id !== id;
-        }
-        return true;
-    }
+    bs.resetMiddlewareStack();
 };
 
-/**
- * Add a new rewrite rule to the stack
- * @param {Object} rule
- */
-BrowserSync.prototype.addRewriteRule = function (rule) {
+BrowserSync.prototype.removeRewriteRule = function (id) {
+    var bs = this;
+    bs.options = bs.options.update("rewriteRules", function (rules) {
+        return rules.filter(function (rule) {
+            return rule.id !== id;
+        });
+    });
+
+    bs.resetMiddlewareStack();
+};
+
+BrowserSync.prototype.setRewriteRules = function (rules) {
     var bs = this;
+    bs.options = bs.options.update("rewriteRules", function (_) {
+        return rules;
+    });
 
-    bs.setRewriteRules(bs.rewriteRules.concat(rule));
+    bs.resetMiddlewareStack();
 };
 
 /**
- * Completely replace all rules
- * @param {Array} rules
+ * Add a new rewrite rule to the stack
+ * @param {Object} rule
  */
-BrowserSync.prototype.setRewriteRules = function (rules) {
+BrowserSync.prototype.resetMiddlewareStack = function () {
+
     var bs = this;
+    var middlewares = require("./server/utils").getMiddlewares(bs, bs.options);
 
-    bs.rewriteRules = rules;
-    bs.snippetMw.opts.rules = rules;
+    bs.app.stack = middlewares;
 };
 
 /**

lib/default-config.js

@@ -216,10 +216,10 @@ module.exports = {
      * Add additional HTML rewriting rules.
      * @property rewriteRules
      * @since 2.4.0
-     * @type Array|Boolean
+     * @type Array
      * @default false
      */
-    rewriteRules: false,
+    rewriteRules: [],
 
     /**
      * @property tunnel

lib/file-watcher.js

@@ -2,7 +2,7 @@
 
 var _ = require("../lodash.custom");
 var utils = require("./utils");
-var Rx = require("rx/dist/rx.all.js");
+var Rx = require("rx");
 
 /**
  * Plugin interface

lib/server/index.js

@@ -7,13 +7,13 @@ var _ = require("../../lodash.custom");
  * Browsersync server
  * Three available modes: Snippet, Server or Proxy
  */
-module.exports.plugin = function (bs, scripts) {
+module.exports.plugin = function (bs) {
 
     var debug   = bs.debug;
     var proxy   = bs.options.get("proxy");
     var type    = bs.options.get("mode");
 
-    var bsServer = createServer(bs, scripts);
+    var bsServer = createServer(bs);
 
     if (type === "server" || type === "snippet") {
         debug("Static Server running ({magenta:%s}) ...", bs.options.get("scheme"));
@@ -72,24 +72,23 @@ module.exports.plugin = function (bs, scripts) {
 /**
  * Launch the server for serving the client JS plus static files
  * @param {BrowserSync} bs
- * @param {String} clientScripts
  * @returns {{staticServer: (http.Server), proxyServer: (http.Server)}}
  */
-function createServer (bs, clientScripts) {
+function createServer (bs) {
 
     var proxy   = bs.options.get("proxy");
     var server  = bs.options.get("server");
 
     if (!proxy && !server) {
-        return require("./snippet-server")(bs, clientScripts);
+        return require("./snippet-server")(bs);
     }
 
     if (proxy) {
-        return require("./proxy-server")(bs, clientScripts);
+        return require("./proxy-server")(bs);
     }
 
     if (server) {
-        return require("./static-server")(bs, clientScripts);
+        return require("./static-server")(bs);
     }
 }
 

lib/server/proxy-server.js

@@ -64,32 +64,27 @@ var ProxyOption = Immutable.Record({
  * @param {String} scripts
  * @returns {*}
  */
-module.exports = function createProxyServer (bs, scripts) {
+module.exports = function createProxyServer (bs) {
 
     var opt         = new ProxyOption().mergeDeep(bs.options.get("proxy"));
     var proxy       = httpProxy.createProxyServer(opt.get("proxyOptions").set("target", opt.get("target")).toJS());
     var target      = opt.get("target");
     var proxyReq    = getProxyReqFunctions(opt.get("proxyReq"), opt, bs);
     var proxyRes    = getProxyResFunctions(opt.get("proxyRes"), opt);
     var proxyResWs  = opt.get("proxyReqWs");
-
-    /**
-     * Add the proxy middleware to any given by the user
-     */
-    var middlewareAdded = bs.options
-        .update("middleware", function (mw) {
-            return mw.concat({
-                id: "Browsersync Proxy",
-                route: opt.get("route"),
-                handle: function (req, res) {
-                    proxy.web(req, res, {
-                        target: target
-                    });
-                }
-            })
+    bs.options      = bs.options.update("middleware", function (mw) {
+        return mw.concat({
+            id: "Browsersync Proxy",
+            route: opt.get("route"),
+            handle: function (req, res) {
+                proxy.web(req, res, {
+                    target: target
+                });
+            }
         });
+    });
 
-    var app  = utils.getBaseApp(bs, middlewareAdded, scripts);
+    var app  = utils.getBaseApp(bs);
 
     /**
      * @type {*|{server, app}}

lib/server/static-server.js

@@ -12,7 +12,7 @@ var serveIndex   = require("serve-index");
  * @param scripts
  * @returns {*}
  */
-module.exports = function createServer (bs, scripts) {
+module.exports = function createServer (bs) {
 
     var options            = bs.options;
     var server             = options.get("server");
@@ -21,7 +21,7 @@ module.exports = function createServer (bs, scripts) {
 
     var _serveStatic = 0;
     var _routes = 0;
-    var middlewareAdded = bs.options
+    bs.options = bs.options
         /**
          * Add directory Middleware if given in server.directory
          */
@@ -70,7 +70,7 @@ module.exports = function createServer (bs, scripts) {
             }));
         });
 
-    var app = serverUtils.getBaseApp(bs, middlewareAdded, scripts);
+    var app = serverUtils.getBaseApp(bs);
 
     /**
      * Finally, return the server + App