feat: added option snippet: boolean - fixes #1882

BrowserSync · Jun 24, 2021 · 525fff9 · 525fff9
1 parent f6336ea
commit 525fff9
Show file tree

Hide file tree

Showing 6 changed files with 80 additions and 30 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/browser-sync/lib/async.js b/packages/browser-sync/lib/async.js
@@ -152,7 +152,9 @@ module.exports = {
         done(null, {
             options: {
                 urls: utils.getUrlOptions(bs.options),
-                snippet: connectUtils.scriptTags(bs.options),
+                snippet: connectUtils.enabled(bs.options)
+                    ? connectUtils.scriptTags(bs.options)
+                    : false,
                 scriptPaths: Immutable.fromJS(
                     connectUtils.clientScript(bs.options, true)
                 ),

diff --git a/packages/browser-sync/lib/connect-utils.js b/packages/browser-sync/lib/connect-utils.js
@@ -13,6 +13,18 @@ function getPath(options, relative, port) {
 }
 
 var connectUtils = {
+    /**
+     * Allow users to disable the Browsersync snippet
+     * @param {Immutable.Map} options
+     * @returns {Boolean}
+     */
+    enabled: function(options) {
+        const userValue = options.get("snippet");
+        if (typeof userValue === "boolean") {
+            return userValue
+        }
+        return true
+    },
     /**
      * @param {Immutable.Map} options
      * @returns {String}

diff --git a/packages/browser-sync/lib/server/utils.js b/packages/browser-sync/lib/server/utils.js
@@ -304,12 +304,14 @@ var serverUtils = {
         );
 
         // Snippet
-        rules.push(
-            snippetUtils.getRegex(
-                bs.options.get("snippet"),
-                bs.options.get("snippetOptions")
-            )
-        );
+        if (bs.options.get("snippet")) {
+            rules.push(
+                snippetUtils.getRegex(
+                    bs.options.get("snippet"),
+                    bs.options.get("snippetOptions")
+                )
+            );
+        }
 
         // User
         bs.options.get("rewriteRules").forEach(function(rule) {

diff --git a/packages/browser-sync/package.json b/packages/browser-sync/package.json
@@ -23,6 +23,7 @@
 	"scripts": {
 		"build": "npm run build:server",
 		"build:server": "tsc",
+		"build:watch": "tsc --watch",
 		"env": "node ./test/env.js",
 		"lodash": "lodash include=isUndefined,isFunction,toArray,includes,union,each,isString,merge,isObject,set exports=node",
 		"prepublishOnly": "npm run build",

diff --git a/packages/browser-sync/test/specs/e2e/e2e.options.snippet.js b/packages/browser-sync/test/specs/e2e/e2e.options.snippet.js
@@ -166,8 +166,41 @@ describe("E2E snippet: false", function() {
             .set("accept", "text/html")
             .expect(200)
             .end(function(err, res) {
-                if (res.text.indexOf(instance.options.get("snippet")) > -1) {
-                    return done(new Error("snippet present"));
+                if (res.text.indexOf("__bs_script__") > -1) {
+                    return done(new Error("snippet present when it shouldn't be"));
+                }
+                done();
+            });
+    });
+});
+
+describe("E2E snippet: true", function() {
+    var instance;
+
+    before(function(done) {
+        browserSync.reset();
+        var config = {
+            server: {
+                baseDir: "test/fixtures"
+            },
+            open: false,
+            snippet: true,
+        };
+        instance = browserSync(config, done).instance;
+    });
+
+    after(function() {
+        instance.cleanup();
+    });
+
+    it("does not add the snippet when snippet: false", function(done) {
+        request(instance.server)
+            .get("/iframe.html")
+            .set("accept", "text/html")
+            .expect(200)
+            .end(function(err, res) {
+                if (res.text.indexOf("__bs_script__") === -1) {
+                    return done(new Error("snippet absent when it shouldn't be"));
                 }
                 done();
             });