chore: use setWindowOpenHandler over 'new-window' event as it has bee…

[AtofStryker]

…n deprecated in Electron v13 and removed in Electron v22

• Closes Fix electron deprecated new-window event #24775

Additional details

In order to upgrade Electron past v21, Cypress needs to replace the deprecated new-window event handler for the preferred setWindowOpenHandler. The new-window event was deprecated in Electron v13 and was removed in v22. This PR maintains that functionality with the new preferred method.

Steps to test

How has the user experience changed?

open-new-window.mp4

UX should not change here, as windows can still be opened (in this case with modifyObstructiveCode: false). Cypress, when receiving the window open event wishes to create the child window off the parent in order to decorate the window with necessary events. Because of this, we want to deny opening the new window. We were previously doing this by leveraging e.preventDefault() and setting newGuest on the event. The same functionality is now accomplished with action: 'deny'.

Please see Electron PRs and Documentation for more info:

• https://github.com/electron/electron/blob/v21.0.0/docs/api/web-contents.md#event-new-window-deprecated
• https://github.com/electron/electron/blob/v21.0.0/docs/api/web-contents.md#contentssetwindowopenhandlerhandler
• chore: remove deprecated 'new-window' event electron/electron#34526

PR Tasks

• Have tests been added/updated?
• Has a PR for user-facing changes been opened in cypress-documentation?
• Have API changes been updated in the type definitions?

[cypress]

5 flaky tests on run #48698 ↗︎

0

4444

944

0

5

Details:

chore: use setWindowOpenHandler over 'new-window' event as it has been deprecate...
Project: cypress	Commit: 29fd60e08b
Status: Passed	Duration: 14:17 💡
Started: Jul 10, 2023 7:20 PM	Ended: Jul 10, 2023 7:35 PM

  commands/net_stubbing.cy.ts • 2 flaky tests • 5x-driver-webkit

View Output Video

Test		Artifacts
... > with `times` > only uses each handler N times		Output Video
... > stops waiting when an xhr request is canceled		Output Video

  cypress/cypress.cy.js • 3 flaky tests • 5x-driver-webkit

View Output Video

Test		Artifacts
... > correctly returns currentRetry		Output Video
... > correctly returns currentRetry		Output Video
... > correctly returns currentRetry		Output Video

_{This comment has been generated by cypress-bot as a result of this project's GitHub integration settings.}

[cypress-bot]

Released in 12.17.2.

This comment thread has been locked. If you are still experiencing this issue after upgrading to
Cypress v12.17.2, please open a new issue.