dont blow away the default electron options (cypress-io#1993)

brian-mann · web-flow · commit 8aa1922c1372 · 2018-06-20T16:14:52.000-04:00
fixes cypress-io#1992
diff --git a/packages/server/lib/browsers/electron.coffee b/packages/server/lib/browsers/electron.coffee
@@ -126,7 +126,10 @@ module.exports = {
 
         plugins.execute("before:browser:launch", options.browser, options)
         .then (newOptions) ->
-          return newOptions ? options
+          if newOptions
+            _.extend(options, newOptions)
+
+          return options
     .then (options) =>
       @_render(url, projectRoot, options)
       .then (win) =>
diff --git a/packages/server/test/integration/cypress_spec.coffee b/packages/server/test/integration/cypress_spec.coffee
@@ -734,8 +734,11 @@ describe "lib/cypress", ->
         ee.loadURL = ->
         ee.focusOnWebView = ->
         ee.webContents = {
+          setUserAgent: sinon.stub()
           session: {
             clearCache: sinon.stub().yieldsAsync()
+            setProxy: sinon.stub().yieldsAsync()
+            setUserAgent: sinon.stub()
           }
         }
 
@@ -765,14 +768,19 @@ describe "lib/cypress", ->
             @expectExitWith(0)
 
         it "electron", ->
+          write = sinon.stub()
+          videoCapture.start.returns({ write })
+
           cypress.start([
             "--run-project=#{@pluginBrowser}"
             "--browser=electron"
           ])
           .then =>
-            expect(Windows.create).to.be.calledWith(@pluginBrowser, {
+            expect(Windows.create).to.be.calledWithMatch(@pluginBrowser, {
               browser: "electron"
               foo: "bar"
+              onNewWindow: sinon.match.func
+              onPaint: sinon.match.func
             })
 
             @expectExitWith(0)
diff --git a/packages/server/test/unit/browsers/electron_spec.coffee b/packages/server/test/unit/browsers/electron_spec.coffee
@@ -6,6 +6,7 @@ la = require("lazy-ass")
 check = require("check-more-types")
 
 menu = require("#{root}../lib/gui/menu")
+plugins = require("#{root}../lib/plugins")
 Windows = require("#{root}../lib/gui/windows")
 electron = require("#{root}../lib/browsers/electron")
 savedState = require("#{root}../lib/saved_state")
@@ -38,6 +39,9 @@ describe "lib/browsers/electron", ->
   context ".open", ->
     beforeEach ->
       sinon.stub(electron, "_render").resolves(@win)
+      sinon.stub(plugins, "has")
+      sinon.stub(plugins, "execute")
+
       savedState()
       .then (state) =>
         la(check.fn(state.get), "state is missing .get to stub", state)
@@ -74,6 +78,27 @@ describe "lib/browsers/electron", ->
         expect(@automation.use).to.be.called
         expect(@automation.use.lastCall.args[0].onRequest).to.be.a("function")
 
+    it "is noop when before:browser:launch yields null", ->
+      plugins.has.returns(true)
+      plugins.execute.resolves(null)
+
+      electron.open("electron", @url, @options, @automation)
+      .then =>
+        options = electron._render.firstCall.args[2]
+
+        expect(options).to.include.keys("onFocus", "onNewWindow", "onPaint", "onCrashed")
+
+    ## https://github.com/cypress-io/cypress/issues/1992
+    it "it merges in options without removing essential options", ->
+      plugins.has.returns(true)
+      plugins.execute.resolves({foo: "bar"})
+
+      electron.open("electron", @url, @options, @automation)
+      .then =>
+        options = electron._render.firstCall.args[2]
+
+        expect(options).to.include.keys("foo", "onFocus", "onNewWindow", "onPaint", "onCrashed")
+
   context "._launch", ->
     beforeEach ->
       sinon.stub(menu, "set")
