fix(paths): Fix regression with absolute/relative paths to scripts/so…

…ckets/https etc - fixes #463
BrowserSync · Feb 19, 2015 · 2386fe1 · 2386fe1
1 parent ab408c6
commit 2386fe1
Show file tree

Hide file tree

Showing 13 changed files with 250 additions and 56 deletions.
diff --git a/lib/async.js b/lib/async.js
@@ -71,16 +71,7 @@ module.exports = {
                     "files:watch",
                     bs.options.get("files"),
                     bs.pluginManager.pluginOptions
-                ),
-                mode:        (function () {
-                    if (bs.options.get("server")) {
-                        return "server";
-                    }
-                    if (bs.options.get("proxy")) {
-                        return "proxy";
-                    }
-                    return "snippet";
-                })()
+                )
             }
         });
     },

diff --git a/lib/browser-sync.js b/lib/browser-sync.js
@@ -73,7 +73,9 @@ BrowserSync.prototype.init = function (options, cb) {
      * Some options are not compatible and will cause us to
      * end the process.
      */
-    utils.verifyConfig(options, bs.cb);
+    if (!utils.verifyConfig(options, bs.cb)) {
+        return;
+    }
 
     /**
      * Save a reference to the original options

diff --git a/lib/config.js b/lib/config.js
@@ -19,5 +19,9 @@ module.exports = {
     template: "/cli-template.js",
     client: {
         shims: "/client/client-shims.js"
+    },
+    errors: {
+        "server+proxy": "Invalid config. You cannot specify both server & proxy options.",
+        "proxy+https":  "Invalid config. You set https: true, but your proxy target doesn't reflect this."
     }
 };
diff --git a/lib/connect-utils.js b/lib/connect-utils.js
@@ -13,7 +13,11 @@ var connectUtils = {
     scriptTags: function (options) {
 
         function getPath(relative, port) {
-            return options.get("scheme") + "://HOST:" + port + relative;
+            if (options.get("mode") === "snippet") {
+                return options.get("scheme") + "://HOST:" + port + relative;
+            } else {
+                return "//HOST:" + port + relative;
+            }
         }
 
         var template = fs.readFileSync(config.templates.scriptTag, "utf-8");
@@ -23,14 +27,15 @@ var connectUtils = {
         var override = false;
 
         if (_.isFunction(options.get("scriptPath"))) {
-            script   = options.get("scriptPath")(scriptPath, options.get("port"), options);
+            var args = getScriptArgs(options, scriptPath);
+            script   = options.get("scriptPath").apply(null, args);
             override = true;
         } else {
             script = getPath(scriptPath, options.get("port"));
         }
 
         if (!override && (options.get("server") || options.get("proxy"))) {
-            script = getPath(scriptPath, options.get("port"));
+            script = scriptPath;
         }
 
         template = template
@@ -64,7 +69,7 @@ var connectUtils = {
     },
     getConnectionUrl: function (options) {
 
-        var protocol   = options.get("scheme") + "://";
+        var protocol   = "";
         var namespace  = options.getIn(["socket", "namespace"]);
         var string     = "'%protocol%' + location.%host% + '%ns%'";
         var socketOpts = connectUtils.resolveSocketOptions(options);
@@ -73,6 +78,10 @@ var connectUtils = {
             return "'%s'".replace("%s", namespace(defaultConfig.socket.namespace, options));
         }
 
+        if (options.get("mode") === "snippet") {
+            protocol = options.get("scheme") + "://";
+        }
+
         return string
             .replace("%protocol%", protocol)
             .replace("%host%",     socketOpts.host)
@@ -124,4 +133,17 @@ var connectUtils = {
     }
 };
 
+/**
+ * @param options
+ * @returns {*[]}
+ */
+function getScriptArgs (options, scriptPath) {
+    var abspath = options.get("scheme") + "://HOST:" + options.get("port") + scriptPath;
+    return [
+        scriptPath,
+        options.get("port"),
+        options.set("absolute", abspath)
+    ];
+}
+
 module.exports = connectUtils;
diff --git a/lib/options.js b/lib/options.js
@@ -12,6 +12,7 @@ module.exports.update = function (options) {
 
     return options.withMutations(function (item) {
 
+        setMode(item);
         setScheme(item);
         setStartPath(item);
         setServerOpts(item);
@@ -33,6 +34,22 @@ module.exports.update = function (options) {
     });
 };
 
+/**
+ * Set the running mode
+ * @param item
+ */
+function setMode (item) {
+    item.set("mode", (function () {
+        if (item.get("server")) {
+            return "server";
+        }
+        if (item.get("proxy")) {
+            return "proxy";
+        }
+        return "snippet";
+    })());
+}
+
 /**
  * @param item
  */

diff --git a/lib/templates/script-tags.tmpl b/lib/templates/script-tags.tmpl
@@ -1,3 +1,3 @@
 <script type='text/javascript' id="__bs_script__">//<![CDATA[
-    document.write("<script async src='%script%'><\/script>".replace(/HOST/g, location.hostname).replace(/PORT/g, location.port));
+    document.write("<script async src='%script%'><\/script>".replace("HOST", location.hostname));
 //]]></script>
diff --git a/lib/utils.js b/lib/utils.js
@@ -292,16 +292,20 @@ var utils = {
      */
     getConfigErrors: function (options) {
 
-        var messages = {
-            "server+proxy": "Invalid config. You cannot specify both server & proxy options."
-        };
+        var messages = require("./config").errors;
 
         var errors = [];
 
         if (options.get("server") && options.get("proxy")) {
             errors.push(messages["server+proxy"]);
         }
 
+        if (options.get("https") && options.get("proxy")) {
+            if (options.getIn(["proxy", "url", "protocol"]) !== "https:") {
+                errors.push([messages["proxy+https"], options.getIn(["proxy", "target"])].join(" "));
+            }
+        }
+
         return errors;
     },
     /**
@@ -311,7 +315,8 @@ var utils = {
     verifyConfig: function (options, cb) {
         var errors = utils.getConfigErrors(options);
         if (errors.length) {
-            return utils.fail(true, errors.join("\n"), cb);
+            utils.fail(true, errors.join("\n"), cb);
+            return false;
         }
         return true;
     },

diff --git a/test/protractor/_run.js b/test/protractor/_run.js
@@ -8,8 +8,10 @@ module.exports = function (logger) {
     return function (config, configFile, cb) {
         browserSync.reset();
         var instance = browserSync(config.bsConfig, function (err, bs) {
-            var url = bs.getOptionIn(["urls", "local"]);
+            var url   = bs.getOptionIn(["urls", "local"]);
+            var uiurl = bs.getOptionIn(["urls", "ui"]);
             process.env["BS_BASE"]        = url;
+            process.env["BS_UI"]          = uiurl;
             process.env["BS_SCRIPT_PATH"] = bs.getOptionIn(["scriptPaths", "path"]);
             logger.info("Testing BrowserSync at %s", url);
 
@@ -28,6 +30,7 @@ module.exports = function (logger) {
 function runTests (config, configFile, bs, cb) {
     var out = "";
     exec("protractor " + configFile, function (err, stdout) {
+        console.log(stdout);
         if (err) {
             doCallback({
                 code: 1,

diff --git a/test/protractor/tests.multi.js b/test/protractor/tests.multi.js
@@ -1,10 +1,23 @@
 "use strict";
 
-var fs = require("fs");
-var path = require("path");
 var connect = require("connect");
-var serveStatic = require("serve-static");
-var http = require("http");
+var utils = require("../../lib/server/utils");
+var Immutable  = require("immutable");
+
+function getApp (bs, options) {
+
+    var html = "<!doctype html><html lang=\"en-US\"><head><meta charset=\"UTF-8\"><title>Browsersync</title></head><body>BS</body></html>";
+    var app = connect();
+
+    app.use("/", function (req, res) {
+        res.setHeader("content-type", "text/html");
+        res.end(html.replace("BS", bs.getOption("snippet")));
+    });
+
+    var appserver = utils.getServer(app, options);
+
+    return appserver;
+}
 
 module.exports = {
     "Proxy Test Laravel App": {
@@ -28,6 +41,13 @@ module.exports = {
             logLevel: "silent"
         }
     },
+    "Secure Proxy": {
+        bsConfig: {
+            proxy: "https://grenade.static:8890",
+            open: false,
+            logLevel: "silent"
+        }
+    },
     "Server": {
         bsConfig: {
             server: "./test/fixtures",
@@ -48,23 +68,35 @@ module.exports = {
             logLevel: "silent"
         },
         before: function (bs, cb) {
-            var filepath = path.resolve(__dirname + "/../fixtures/index.html");
-            var file = fs.readFileSync(filepath, "utf-8");
-            var modded = file.replace("<!-- BrowserSync -->", bs.getOption("snippet"));
-            var app = connect();
-            app.use(serveStatic(path.resolve(__dirname + "/../fixtures")));
-            var server = http.createServer(app).listen();
-            var port = server.address().port;
-            var url = "http://localhost:" + port;
-            process.env["BS_BASE"]        = url;
-            fs.writeFileSync(filepath, modded);
+            var app = getApp(bs, Immutable.Map({scheme: "http"}));
+            app.server.listen();
+            process.env["BS_BASE"] = "http://localhost:" + app.server.address().port;
+            cb();
+        }
+    },
+    "Secure Snippet on Insecure Website": {
+        bsConfig: {
+            logLevel: "silent",
+            https: true
+        },
+        before: function (bs, cb) {
+
+            var app = getApp(bs, Immutable.Map({scheme: "http"}));
+            app.server.listen();
+            process.env["BS_BASE"] = "http://localhost:" + app.server.address().port;
             cb();
+        }
+    },
+    "Secure Snippet on Secure Website": {
+        bsConfig: {
+            logLevel: "silent",
+            https: true
         },
-        after: function (bs, cb) {
-            var filepath = path.resolve(__dirname + "/../fixtures/index.html");
-            var file = fs.readFileSync(filepath, "utf-8");
-            var modded = file.replace(bs.getOption("snippet"), "<!-- BrowserSync -->");
-            fs.writeFileSync(filepath, modded);
+        before: function (bs, cb) {
+
+            var app = getApp(bs, Immutable.Map({scheme: "https"}));
+            app.server.listen();
+            process.env["BS_BASE"] = "https://localhost:" + app.server.address().port;
             cb();
         }
     }

diff --git a/test/protractor/tests/snippet.injection.js b/test/protractor/tests/snippet.injection.js
@@ -4,13 +4,13 @@
  *
  */
 // abstract writing screen shot to a file
-var fs = require("fs");
-var slugify = require("slugify");
-function writeScreenShot(data, filename) {
-    var stream = fs.createWriteStream(filename);
-    stream.write(new Buffer(data, "base64"));
-    stream.end();
-}
+//var fs = require("fs");
+//var slugify = require("slugify");
+//function writeScreenShot(data, filename) {
+//    var stream = fs.createWriteStream(filename);
+//    stream.write(new Buffer(data, "base64"));
+//    stream.end();
+//}
 
 /**
  *
@@ -19,15 +19,17 @@ describe("Section Navigation", function () {
     beforeEach(function () {
         browser.ignoreSynchronization = true;
         browser.get("/");
-        // within a test:
-        browser.takeScreenshot().then(function (png) {
-            writeScreenShot(png, "screenshots/ss_" + slugify(process.env["BS_TEST_NAME"]) + ".png");
-        });
     });
     it("should contain the BS script element", function () {
         expect(element(by.id("__bs_script__")).isPresent()).toBeTruthy();
     });
     it("should contain the BS NOTIFY ELEMENT", function () {
+        //browser.pause();
         expect(element(by.id("__bs_notify__")).isPresent()).toBeTruthy();
     });
+    it("should launch UI", function () {
+        browser.ignoreSynchronization = false;
+        browser.get(process.env["BS_UI"]);
+        expect(element.all(by.css("[bs-heading]")).get(0).isPresent()).toBeTruthy();
+    });
 });
diff --git a/test/protractor/utils.js b/test/protractor/utils.js
@@ -0,0 +1,23 @@
+"use strict";
+
+var utils = require("../../lib/server/utils");
+var connect = require("connect");
+
+module.exports = {
+
+    getApp: function getApp (options) {
+
+        var html = "<!doctype html><html lang=\"en-US\"><head><meta charset=\"UTF-8\"><title>Browsersync</title></head><body>BS</body></html>";
+        var app = connect();
+
+        app.use("/", function (req, res) {
+            res.setHeader("content-type", "text/html");
+            res.end(html);
+        });
+
+        var appserver = utils.getServer(app, options);
+        appserver.html = html;
+
+        return appserver;
+    }
+};