Enable proxy.ws option from the CLI

Author: shakyShane

lib/cli/opts.start.json

@@ -10,6 +10,7 @@
     "https":            "Enable SSL for local development",
     "directory":        "Show a directory listing for the server",
     "proxy":            "Proxy an existing server",
+    "ws":               "Proxy mode only - enable websocket proxying",
     "xip":              "Use xip.io domain routing",
     "tunnel":           "Use a public URL",
     "open":             "Choose which URL is auto-opened (local, external or tunnel)",

lib/default-config.js

@@ -71,6 +71,7 @@ module.exports = {
      * @property proxy
      * @type String|Object|Boolean
      * @param {String} [target]
+     * @param {Boolean} [ws] - Enable websocket proxying
      * @param {Function|Array} [middleware]
      * @param {Function} [reqHeaders]
      * @param {Array} [proxyRes]

lib/options.js

@@ -15,6 +15,7 @@ module.exports.update = function (options) {
         setMode(item);
         setScheme(item);
         setStartPath(item);
+        setProxyWs(item);
         setServerOpts(item);
         setNamespace(item);
         fixSnippetOptions(item);
@@ -27,6 +28,17 @@ module.exports.update = function (options) {
     });
 };
 
+/**
+ * Move top-level ws options to proxy.ws
+ * This is to allow it to be set from the CLI
+ * @param item
+ */
+function setProxyWs(item) {
+    if (item.get("ws") && item.get("mode") === "proxy") {
+        item.setIn(["proxy", "ws"], true);
+    }
+}
+
 /**
  * @param item
  */

test/specs/e2e/cli/e2e.cli.proxy.ws.js

@@ -0,0 +1,49 @@
+"use strict";
+
+var path        = require("path");
+//var request     = require("supertest");
+var assert      = require("chai").assert;
+var connect     = require("connect");
+var browserSync = require(path.resolve("./"));
+var serveStatic = require("serve-static");
+
+var pkg     = require(path.resolve("package.json"));
+var cli     = require(path.resolve(pkg.bin));
+
+describe("E2E CLI proxy + websockets test", function () {
+
+    var instance, server;
+
+    before(function (done) {
+
+        browserSync.reset();
+        var app = connect();
+        app.use(serveStatic("./test/fixtures"));
+        server = app.listen();
+        var proxytarget = "http://localhost:" + server.address().port;
+
+        cli({
+            cli: {
+                input: ["start"],
+                flags: {
+                    proxy: proxytarget,
+                    open: false,
+                    online: false,
+                    logLevel: "silent",
+                    ws: true
+                }
+            },
+            cb: function (err, bs) {
+                instance = bs;
+                done();
+            }
+        });
+    });
+    after(function () {
+        server.close();
+        instance.cleanup();
+    });
+    it("Adds the proxy.ws options", function () {
+        assert.equal(instance.options.getIn(["proxy", "ws"]), true);
+    });
+});