Use win.destroy to destroy Electron windows, log more events

[flotwig]

• Closes Electron browser hangs/errors on apps with window.onbeforeunload alerts #2118

User facing changelog

Fixed a long-standing bug where runs using Electron would sometimes hang at the end if there is an onbeforeload dialog blocking the window from closing.

Additional details

• Before, we used win.close, which is just like clicking X on the window - if an onbeforeload handler is triggered, it will wait for that to be resolved before closed is emitted and the window is really closed
• With this PR...
  • win.destroy is used to kill the window, which is analogous to how we cp.kill chrome's process
  • Child windows will be win.destroyd once the parent closes
  • Added logs for close, responsive, session-end, unresponsive events

How has the user experience changed?

Before

Logs would continue on forever after

After

PR Tasks

• Have tests been added/updated?

[cypress-bot]

Thanks for the contribution! Below are some guidelines Cypress uses when doing PR reviews.

• Please write [WIP] in the title of your Pull Request if your PR is not ready for review - someone will review your PR as soon as the [WIP] is removed.
• Please familiarize yourself with the PR Review Checklist and feel free to make updates on your PR based on these guidelines.

PR Review Checklist

If any of the following requirements can't be met, leave a comment in the review selecting 'Request changes', otherwise 'Approve'.

User Experience

• The feature/bugfix is self-documenting from within the product.
• The change provides the end user with a way to fix their problem (no dead ends).

Functionality

• The code works and performs its intended function with the correct logic.
• Performance has been factored in (for example, the code cleans up after itself to not cause memory leaks).
• The code guards against edge cases and invalid input and has tests to cover it.

Maintainability

• The code is readable (too many nested 'if's are a bad sign).
• Names used for variables, methods, etc, clearly describe their function.
• The code is easy to understood and there are relevant comments explaining.
• New algorithms are documented in the code with link(s) to external docs (flowcharts, w3c, chrome, firefox).
• There are comments containing link(s) to the addressed issue (in tests and code).

Quality

• The change does not reimplement code.
• There's not a module from the ecosystem that should be used instead.
• There is no redundant or duplicate code.
• There are no irrelevant comments left in the code.
• Tests are testing the code’s intended functionality in the best way possible.

Internal

• The original issue has been tagged with a release in ZenHub.

[cypress]

---

Test summary

3483 • 0 • 46 • 0

---

Run details

Project	cypress
Status	Passed
Commit	169b3ed
Started	Nov 7, 2019 6:44 PM
Ended	Nov 7, 2019 6:48 PM
Duration	04:17 💡
OS	Linux Debian - 9.8
Browser	Multiple

View run in Cypress Dashboard ➡️

---

This comment has been generated by cypress-bot as a result of this project's GitHub integration settings. You can manage this integration in this project's settings in the Cypress Dashboard

[jennifer-shehane]

I've confirmed that this properly exits Electron when having a beforeunload handler (tried both types of listeners). It also adds extra logging, which I added screenshots of to the PR description.

[brian-mann]

let's add a few types of driver tests to confirm this works...

1. setting window.unbeforeunload callback
2. using window.addEventListener('beforeunload', (evt) => evt.returnValue = '...)
3. do the same pattern above except do it with child windows by using window.open() from the AUT - which will load in child windows that use the same listener patterns

@flotwig get with @jennifer-shehane - she put together a small sandbox confirming both ways are broken in electron.

[jennifer-shehane]

The situations Brian is mentioning that require coverage in tests:

window.onbeforeunload = function(){
  return 'Are you sure you want to leave?';
};

window.addEventListener('beforeunload', function(){
  return 'Are you sure you want to leave?';
};

[flotwig]

Ok, I think I added the appropriate tests in packages/driver/test/cypress/integration/e2e/abort*. @brian-mann ready for re-review

[brian-mann]

All this looks good except no reason to create all those separate e2e tests in the driver - we can use a single spec file and just cy.visit() the different fixtures... i will fix it now and merge.

I was wrong