Use win.destroy to destroy Electron windows, log more events (#5603)

* Use win.destroy to destroy windows, log more events * fix test * Add tests for onbeforeunload, beforeunload exiting successfully * add window.open beforeunload tests * beforeunload, not beforeload * just destroy those child windows
cypress-io · Nov 7, 2019 · f5b0909 · f5b0909 · cypress-bot · Nov 7, 2019
1 parent 9aeadbd
commit f5b0909
Show file tree

Hide file tree

Showing 8 changed files with 46 additions and 3 deletions.
diff --git a/packages/driver/test/cypress/fixtures/blocking_beforeunload_event.html b/packages/driver/test/cypress/fixtures/blocking_beforeunload_event.html
@@ -0,0 +1,9 @@
+<!DOCTYPE html>
+
+<script>
+  window.addEventListener('beforeunload', function (e) {
+    e.preventDefault();
+    e.returnValue = 'Dialog';
+    return;
+  })
+</script>
diff --git a/packages/driver/test/cypress/fixtures/blocking_onbeforeunload.html b/packages/driver/test/cypress/fixtures/blocking_onbeforeunload.html
@@ -0,0 +1,9 @@
+<!DOCTYPE html>
+
+<script>
+  window.onbeforeunload = function (e) {
+    e.preventDefault();
+    e.returnValue = 'Dialog';
+    return;
+  }
+</script>
diff --git a/packages/driver/test/cypress/integration/e2e/abort_beforeunload_event_child_spec.ts b/packages/driver/test/cypress/integration/e2e/abort_beforeunload_event_child_spec.ts
@@ -0,0 +1,3 @@
+it('will exit even if an beforeload event dialog is present in a child window', function () {
+  cy.window().invoke('open', '/fixtures/blocking_beforeunload_event.html')
+})
diff --git a/packages/driver/test/cypress/integration/e2e/abort_beforeunload_event_spec.ts b/packages/driver/test/cypress/integration/e2e/abort_beforeunload_event_spec.ts
@@ -0,0 +1,3 @@
+it('will exit even if an beforeload event dialog is present', function () {
+  cy.visit('/fixtures/blocking_beforeunload_event.html')
+})
diff --git a/packages/driver/test/cypress/integration/e2e/abort_onbeforeunload_child_spec.ts b/packages/driver/test/cypress/integration/e2e/abort_onbeforeunload_child_spec.ts
@@ -0,0 +1,3 @@
+it('will exit even if an onbeforeunload dialog is present in a child window', function () {
+  cy.window().invoke('open', '/fixtures/blocking_onbeforeunload.html')
+})
diff --git a/packages/driver/test/cypress/integration/e2e/abort_onbeforeunload_spec.ts b/packages/driver/test/cypress/integration/e2e/abort_onbeforeunload_spec.ts
@@ -0,0 +1,3 @@
+it('will exit even if an onbeforeunload dialog is present', function () {
+  cy.visit('/fixtures/blocking_onbeforeunload.html')
+})
diff --git a/packages/server/lib/browsers/electron.coffee b/packages/server/lib/browsers/electron.coffee
@@ -11,6 +11,15 @@ plugins       = require("../plugins")
 savedState    = require("../saved_state")
 profileCleaner = require("../util/profile_cleaner")
 
+## additional events that are nice to know about to be logged
+## https://electronjs.org/docs/api/browser-window#instance-events
+ELECTRON_DEBUG_EVENTS = [
+  'close'
+  'responsive',
+  'session-end'
+  'unresponsive'
+]
+
 tryToCall = (win, method) ->
   try
     if not win.isDestroyed()
@@ -61,7 +70,7 @@ module.exports = {
           ## close child on parent close
           _win.on "close", ->
             if not child.isDestroyed()
-              child.close()
+              child.destroy()
     }
 
     _.defaultsDeep({}, options, defaults)
@@ -99,6 +108,10 @@ module.exports = {
     if options.show
       menu.set({withDevTools: true})
 
+    ELECTRON_DEBUG_EVENTS.forEach (e) ->
+      win.on e, ->
+        debug("%s fired on the BrowserWindow %o", e, { browserWindowUrl: url })
+
     Promise.try =>
       @_attachDebugger(win.webContents)
     .then =>
@@ -226,7 +239,7 @@ module.exports = {
 
         return _.extend events, {
           browserWindow:      win
-          kill:               -> tryToCall(win, "close")
+          kill:               -> tryToCall(win, "destroy")
           removeAllListeners: -> tryToCall(win, "removeAllListeners")
         }
 }
diff --git a/packages/server/test/integration/cypress_spec.coffee b/packages/server/test/integration/cypress_spec.coffee
@@ -784,7 +784,7 @@ describe "lib/cypress", ->
           # like calling client.close() if available to let the
           # browser free any resources
           ee.emit("exit")
-        ee.close = ->
+        ee.destroy = ->
           ee.emit("closed")
         ee.isDestroyed = -> false
         ee.loadURL = ->