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

chheller · 2018-07-10T15:42:10Z

Current behavior:

When running a test using the Electron browser on a webpage that contains a window.onbeforeunload script and trying to navigate away, Cypress will fail to load the next page. The test will eventually fail after a PageLoadTimeout exception. This occurs when using any kind of navigation such as cy.reload(), cy.visit(), or interacting with an element that contains an href linking to somewhere else.

Test run with Electron 59:

Desired behavior:

Test run with Chrome 67:

Steps to reproduce:

describe('Electron 59 alert prompt bug', function() {
  it('Should navigate away from the page', function() {
    cy.on('window:confirm', function() {
      return true;
    });
    cy.visit('http://localhost:8080/');
    cy.visit('http://localhost:8080/form');
  });
  it('Should reload the page', function() {
    cy.visit('http://localhost:8080/');
    cy.reload();
  });
});

The page under test needs to contain a window.onbeforeunload function which alters the returnValue. To reproduce, I use http-server to serve a barebones HTML file

<!DOCTYPE html>

<script>
  window.onbeforeunload = function (e) {
    e.returnValue = 'Dialog';
    return;
  }
</script>

Versions

Cypress: 3.0.2
MacOS: High Sierra 10.13.5
Browsers: Chrome 67, Electron 59

The text was updated successfully, but these errors were encountered:

marmite22 · 2018-08-21T13:29:29Z

I've just hit this exact same problem. For now I've wrapped my onBeforeUnload binding in a check for cypress which feels a bit dirty.

 if (!window.Cypress) {
    $window.onbeforeunload = function (e) { ... }
}

bimimicah · 2018-10-04T20:09:45Z

I was able to work around the issue with the following code in the test:

cy.window().then((win) =>  {
	win.onbeforeunload = null;
})
cy.visit(<the next page goes here>)

jennifer-shehane · 2018-11-10T00:29:59Z

Reproducible example: cypress-io/cypress-test-tiny#27

brandonb927 · 2018-11-14T17:04:56Z

Just chiming in here to say we have an issue within our tests because Cypress doesn't properly handle the window.onbeforeunload event in Electron w/ Chromium 59, but works perfectly fine using Chrome 70 running the test runner. In our Jenkins env using docker, it also experiences the same issue with the cypress/base:10 image.

My guess is that the version of Chromium used by Electron (59) that ships with Cypress currently (3.1.0) has some major bugs and issues. I see #2559 is acknowledged, any ETA when that might get rolled out? I imagine this would fix a swath of issues being worked around due to an old version of Chromium.

Ya'll doin' great work though, I really appreciate Cypress :)

Cypress: 3.1.0
macOS: 10.14.1
Browsers: Electron 59, Chrome 70

Obi-Dann · 2018-12-07T00:59:11Z

Started encountering this problem in our CI build. For now going to workaround by monkey patching window.addEventListener:

Cypress.on('window:load', function(window) {
    const original = window.addEventListener;
    window.addEventListener = function() {
        if (arguments && arguments[0] === 'beforeunload') {
            return;
        }
        return original.apply(this, arguments);
    };
});

Fonger · 2019-03-16T14:48:12Z

If you're using window.onbeforeunload=function() {...} instead of window.addEventListener('beforeunload', function() {...}, you can use this workaround:

Cypress.on('window:load', function(window) {
  Object.defineProperty(window, 'onbeforeunload', {
    get: function() {},
    set: function() {}
  });
});

fritz-c · 2019-05-23T07:59:58Z

Regarding dannsam's approach, you may want to change 'window:load' to 'window:before:load' if you are adding the beforeunload listener in some code executed on load.

szymach · 2019-06-20T17:41:13Z

Thank you @DanNSam and @fritz-c , your workaround did it for me. I have encountered this issue using the autosave plugin for CKEditor 5, since it tries to make sure the last call was completed or something.

bahmutov · 2019-07-06T22:16:20Z

I have pushed another example https://github.com/cypress-io/cypress-test-tiny/tree/test-unload that shows the problem in Electron 61 (Chrome passes, despite showing an error). The website in question is http://webdriverjsdemo.github.io/leave/

and has the following script

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

The error displayed in the browser console:

This error has docs in https://www.chromestatus.com/feature/5082396709879808 and probably is not disabled in Electron

Funnily, you cannot close the Electron browser in GUI mode - it just keeps showing the error

Running cypress run --headed shows the error that happens on CI - the test keeps running

jennifer-shehane · 2019-11-04T22:03:37Z

There is also a situation where, where after visiting the site above, this will exhibit as a Page Load timeout.

Failing test code below:

describe('page', () => {
  it('works', () => {
    cy.visit('http://webdriverjsdemo.github.io/leave/')
    cy.contains('Go Home')
      .click()
  })

  it('works 2', () => {
    cy.visit('http://webdriverjsdemo.github.io/leave/')
      .contains('Go Home')
      .click()
  })
})

Electron will not display this error in the Console when this is happening also (if you have not manually interacted with the page)

[Intervention] Blocked attempt to show a 'beforeunload' confirmation panel for a frame that never had a user gesture since its load. https://www.chromestatus.com/feature/5082396709879808

Workaround

There are 2 possible workarounds.

Run your tests in Chrome using the --chrome flag during cypress run or choosing Chrome during cypress open.

OR

Add the code below to your support/index.js file. This will prevent the prompts from occurring - and not hang Electron.

Cypress.on('window:before:load', function (win) {
  const original = win.EventTarget.prototype.addEventListener

  win.EventTarget.prototype.addEventListener = function () {
    if (arguments && arguments[0] === 'beforeunload') {
      return
    }
    return original.apply(this, arguments)
  }

  Object.defineProperty(win, 'onbeforeunload', {
    get: function () { },
    set: function () { }
  })
})

- Implements a workaround described here: cypress-io/cypress#2118

k4mr4n · 2023-01-18T18:39:59Z

This worked for me

Cypress.on('window:before:unload', e => {
    e.stopImmediatePropagation()
})

Joelasaur · 2023-02-03T18:04:50Z

This issue is keeping me from using cy.origin(), since when I click the href to navigate to an external site, I can see the browser is loading the page, but cypress is still failing because of the page load timeout error. Unable to post a reproducer since it's proprietary code but here's an excerpt of what I'm doing:

    cy.get('[data-cy="my-external-site"]').click();
    cy.origin('https://my-external-site.com', () => {
      cy.url().should('include', 'my-external-site');
    });

According to the docs, the above code should work, but this page load timeout error is keeping me from using it.

hemaybedead · 2023-05-18T15:45:02Z

Putting the code from workaround number 2 into my beforeEach() block solved this for me.

alecmestroni · 2023-05-29T11:23:48Z

Putting the code from workaround number 2 into my beforeEach() block solved this for me.

Whats the workaround number 2? @hemaybedead

alecmestroni · 2023-05-29T12:20:07Z

The only workaround that worked for me is to extend the 'pageLoadTimeout' to 600000 in cypress.config.js

* Our app registers beforeunload event listener e.g. when editing a native SQL question. * Cypress does not automatically close the browser prompt and does not allow manually * interacting with it (unlike with window.confirm). The test will hang forever with * the prompt displayed and will eventually time out. We need to work around this by * monkey-patching window.addEventListener to ignore beforeunload event handlers. * * @see cypress-io/cypress#2118

) * Update isNavigationAllowed logic to prevent new model creation * Add simple model creation test * Remove identifier * Update comment * Add a test case for saving a new model * Avoid using fetchMock directly in QueryBuilder unit tests * Remove setupCollectionsEndpointsByIds in favor of setupCollectionByIdEndpoint * Add native question test base * Update isNavigationAllowed tests * Make isNavigationAllowed tests pass * Update shouldShowUnsavedChangesWarningForSqlQuery logic to account for new questions * Add a test case to run new native question * Update mock to include individual collection GET endpoint * Add DataSourceSelectors to MockNativeQueryEditor * Update test beforeunload event to reflect new behavior * Use setupCollectionByIdEndpoint instead of modifying setupCollectionsEndpoints * Update failing test * Use serializeCardForUrl * Add a test for native query editing * Do not trigger warning when leaving empty question * Add beforeunload tests for creating new questions * Remove redundant div * Make assertions consistent * Use single resetAllMocks() * Fix post-rebase conflict * Work around Cypress not handling beforeunload-related prompts * Our app registers beforeunload event listener e.g. when editing a native SQL question. * Cypress does not automatically close the browser prompt and does not allow manually * interacting with it (unlike with window.confirm). The test will hang forever with * the prompt displayed and will eventually time out. We need to work around this by * monkey-patching window.addEventListener to ignore beforeunload event handlers. * * @see cypress-io/cypress#2118

adnanerlansyah403 · 2023-12-09T10:21:51Z

Any updates on this issue guys ?, I have got the same issue too and I've already made the thread for this and provide a reproducable code. here's the link, I hope you'll can fix this as fast because this making me frustrating. I can't run the test on chrome's and edge browser and only working on firefox

#28449

jennifer-shehane · 2023-12-13T15:55:32Z

@adnanerlansyah403 No, this hasn't been fixed yet. It's on a list of bugs that we'd like to prioritize fixing though, if we find the time.

kbaala88 · 2023-12-13T15:57:00Z

This is a major blocker for our app automation and reported like 3 years ago. still we hadn’t got the fix. Thanks team !!

…

On Wed, Dec 13, 2023 at 7:55 AM Jennifer Shehane ***@***.***> wrote: @adnanerlansyah403 <https://github.com/adnanerlansyah403> No, this hasn't been fixed yet. It's on a list of bugs that we'd like to prioritize fixing though, if we find the time. — Reply to this email directly, view it on GitHub <#2118 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AONEAZPQ7BVWMDKLXL46AVTYJHFYNAVCNFSM4FJGT5WKU5DIOJSWCZC7NNSXTN2JONZXKZKDN5WW2ZLOOQ5TCOBVGQYTSNBVG44A> . You are receiving this because you commented.Message ID: ***@***.***>

adnanerlansyah403 · 2023-12-14T01:20:45Z

@adnanerlansyah403 No, this hasn't been fixed yet. It's on a list of bugs that we'd like to prioritize fixing though, if we find the time.

Oke, Thank you so much for your assitance. Please notice me or let me know if it's already fixed 🙏

adnanerlansyah403 · 2023-12-25T04:17:04Z

@adnanerlansyah403 No, this hasn't been fixed yet. It's on a list of bugs that we'd like to prioritize fixing though, if we find the time.

Hey @jennifer-shehane sorry, how about now for the issue? Is there any update on this? How to progress in solving the problem?

adnanerlansyah403 · 2024-01-22T01:49:11Z

Please keep it up for this issue, there are bunches of people occurring this.

valscion · 2024-01-22T08:36:55Z

Posting repeatedly on the issue thread will not help you, @adnanerlansyah403. It will only work to annoy people like me who are subscribed to this thread to see if it gets resolved at some point.

Cypress team will prioritize the issues as they see fit. You can add a 👍 reaction to the original issue message to help Cypress team prioritize this issue and see how many people it affects.

If anything, adding more "please fix this" comments serves to make Cypress team less interested in fixing this issue.

Note

I am not associated with Cypress in any way — so these opinions are my own.

jennifer-shehane · 2024-01-22T18:43:03Z

@valscion Commenting certainly doesn't make Cypress less interested in fixing an issue, but for longstanding issues, we do prioritize them based on impact and effort to fix and this is certainly a known issue in our backlog to be prioritized against other work.

There's this other issue with onbeforeunload alerts that's popped up and made this prevelant within Chrome browsers which has put this somewhat on our radar. #28553 But I'm not sure they can both be addressed together or not.

adnanerlansyah403 · 2024-01-23T01:20:35Z

@valscion Commenting certainly doesn't make Cypress less interested in fixing an issue, but for longstanding issues, we do prioritize them based on impact and effort to fix and this is certainly a known issue in our backlog to be prioritized against other work.

There's this other issue with onbeforeunload alerts that's popped up and made this prevelant within Chrome browsers which has put this somewhat on our radar. #28553 But I'm not sure they can both be addressed together or not.

I'm glad this issue is already on the backlog, I hope this can be fixed as soon as possible. And if it's already fixed on the next update of cypress, please notice it too in the description. I appreciate so much for developers cypress for what they're doing to fix the issue like this.

cypress-io/cypress#2118

cypress-io/cypress#2118 Co-authored-by: Nemanja Glumac <31325167+nemanjaglumac@users.noreply.github.com>

cypress-io/cypress#2118

posti85 · 2024-10-07T16:13:31Z

I was facing the same issue. But I think the cause is different from the rest. My app is configured to be PWA, and the service worker was causing issues in the navigations (the cy.visit() call always hang).

More info about the problem and one of its workarounds here: https://www.youtube.com/watch?v=hmbx_f5Nlfs, people are talking about the same issue in this thread: #27501.

The workaround that worked for my was:

cy.intercept('**/registerSW.js', '');

jennifer-shehane added the stage: needs investigating Someone from Cypress needs to look at this label Jul 10, 2018

jennifer-shehane added the browser: electron label Nov 10, 2018

jennifer-shehane changed the title ~~Electron 59 does not handle window navigation alerts~~ Electron browser hangs/errors on apps with window.onbeforeunload alerts Nov 10, 2018

This was referenced Nov 10, 2018

window:confirm event ignored by command line (but not UI) #1432

Closed

Test hangs on Jenkins CI/ locally #2482

Closed

jennifer-shehane added stage: ready for work The issue is reproducible and in scope and removed stage: needs investigating Someone from Cypress needs to look at this labels Nov 10, 2018

jennifer-shehane mentioned this issue Nov 19, 2018

Cypress sometimes hangs trying to run first test in CI (Jenkins) #2294

Closed

jennifer-shehane mentioned this issue Jan 29, 2019

cypress shows "waiting for page to load' forever when alert popped up #3234

Closed

gabrieldutra mentioned this issue Apr 30, 2019

Cypress: Fix Stuck E2E test - create_query_spec getredash/redash#3748

Merged

1 task

julesterrien mentioned this issue May 9, 2019

Page occasionally does not load from cy.visit() #2938

Closed

jennifer-shehane mentioned this issue May 14, 2019

CLI - Browser doesn't close and hangs forever #4182

Closed

jhays-nhaschools mentioned this issue Jun 24, 2019

beforeunload when running Electron #796

Closed

jennifer-shehane mentioned this issue Jul 18, 2019

Cypress v3.3.0 hangs #4247

Closed

jennifer-shehane added the existing workaround label Jul 24, 2019

lots0logs mentioned this issue Jul 27, 2019

headless runner does not exit #491

Closed

flotwig self-assigned this Nov 4, 2019

flotwig mentioned this issue Nov 4, 2019

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

Merged

1 task

cypress-bot bot added stage: work in progress and removed stage: ready for work The issue is reproducible and in scope labels Nov 4, 2019

zifgu added a commit to tapestry-tool/tapestry-wp that referenced this issue Jul 14, 2022

Remove onbeforeunload callback in test

d5a8379

- Implements a workaround described here: cypress-io/cypress#2118

nagash77 added the prevent-stale mark an issue so it is ignored by stale[bot] label Apr 3, 2023

nagash77 added E2E Issue related to end-to-end testing Triaged Issue has been routed to backlog. This is not a commitment to have it prioritized by the team. labels May 18, 2023

jennifer-shehane removed the blocking label Oct 4, 2023

jennifer-shehane mentioned this issue Dec 13, 2023

Page doesn't load after I changed the origin or different url #28449

Closed

nemanjaglumac mentioned this issue Jan 30, 2024

Use Cypress event listener for beforeunload globally metabase/metabase#38264

Merged

nemanjaglumac added a commit to metabase/metabase that referenced this issue Jan 30, 2024

Use Cypress event listener for beforeunload globally (#38264)

0c0e84c

cypress-io/cypress#2118

github-actions bot pushed a commit to metabase/metabase that referenced this issue Jan 30, 2024

Use Cypress event listener for beforeunload globally (#38264)

264eac6

cypress-io/cypress#2118

metabase-bot bot added a commit to metabase/metabase that referenced this issue Jan 30, 2024

Use Cypress event listener for beforeunload globally (#38264) (#38266)

3f58961

cypress-io/cypress#2118 Co-authored-by: Nemanja Glumac <31325167+nemanjaglumac@users.noreply.github.com>

npfitz pushed a commit to metabase/metabase that referenced this issue Feb 5, 2024

Use Cypress event listener for beforeunload globally (#38264)

042d195

cypress-io/cypress#2118

sloansparger pushed a commit to metabase/metabase that referenced this issue Feb 5, 2024

Use Cypress event listener for beforeunload globally (#38264)

d608d0c

cypress-io/cypress#2118

mschile mentioned this issue Mar 7, 2024

test: fix issue with electron in service-worker.cy.js #29089

Merged

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

chheller commented Jul 10, 2018 •

edited by sync-by-unito bot

Loading

marmite22 commented Aug 21, 2018 •

edited by jennifer-shehane

Loading

bimimicah commented Oct 4, 2018 •

edited by jennifer-shehane

Loading

jennifer-shehane commented Nov 10, 2018

brandonb927 commented Nov 14, 2018

Obi-Dann commented Dec 7, 2018 •

edited by jennifer-shehane

Loading

Fonger commented Mar 16, 2019

fritz-c commented May 23, 2019

szymach commented Jun 20, 2019

bahmutov commented Jul 6, 2019

jennifer-shehane commented Nov 4, 2019 •

edited by brian-mann

Loading

k4mr4n commented Jan 18, 2023

Joelasaur commented Feb 3, 2023

hemaybedead commented May 18, 2023

alecmestroni commented May 29, 2023 •

edited

Loading

alecmestroni commented May 29, 2023

adnanerlansyah403 commented Dec 9, 2023

jennifer-shehane commented Dec 13, 2023

kbaala88 commented Dec 13, 2023 via email

adnanerlansyah403 commented Dec 14, 2023

adnanerlansyah403 commented Dec 25, 2023

adnanerlansyah403 commented Jan 22, 2024 •

edited

Loading

valscion commented Jan 22, 2024 •

edited

Loading

jennifer-shehane commented Jan 22, 2024

adnanerlansyah403 commented Jan 23, 2024 •

edited

Loading

posti85 commented Oct 7, 2024 •

edited

Loading

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

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

Comments

chheller commented Jul 10, 2018 • edited by sync-by-unito bot Loading

Current behavior:

Desired behavior:

Steps to reproduce:

Versions

marmite22 commented Aug 21, 2018 • edited by jennifer-shehane Loading

bimimicah commented Oct 4, 2018 • edited by jennifer-shehane Loading

jennifer-shehane commented Nov 10, 2018

brandonb927 commented Nov 14, 2018

Obi-Dann commented Dec 7, 2018 • edited by jennifer-shehane Loading

Fonger commented Mar 16, 2019

fritz-c commented May 23, 2019

szymach commented Jun 20, 2019

bahmutov commented Jul 6, 2019

jennifer-shehane commented Nov 4, 2019 • edited by brian-mann Loading

Workaround

k4mr4n commented Jan 18, 2023

Joelasaur commented Feb 3, 2023

hemaybedead commented May 18, 2023

alecmestroni commented May 29, 2023 • edited Loading

alecmestroni commented May 29, 2023

adnanerlansyah403 commented Dec 9, 2023

jennifer-shehane commented Dec 13, 2023

kbaala88 commented Dec 13, 2023 via email

adnanerlansyah403 commented Dec 14, 2023

adnanerlansyah403 commented Dec 25, 2023

adnanerlansyah403 commented Jan 22, 2024 • edited Loading

valscion commented Jan 22, 2024 • edited Loading

jennifer-shehane commented Jan 22, 2024

adnanerlansyah403 commented Jan 23, 2024 • edited Loading

posti85 commented Oct 7, 2024 • edited Loading

chheller commented Jul 10, 2018 •

edited by sync-by-unito bot

Loading

marmite22 commented Aug 21, 2018 •

edited by jennifer-shehane

Loading

bimimicah commented Oct 4, 2018 •

edited by jennifer-shehane

Loading

Obi-Dann commented Dec 7, 2018 •

edited by jennifer-shehane

Loading

jennifer-shehane commented Nov 4, 2019 •

edited by brian-mann

Loading

alecmestroni commented May 29, 2023 •

edited

Loading

adnanerlansyah403 commented Jan 22, 2024 •

edited

Loading

valscion commented Jan 22, 2024 •

edited

Loading

adnanerlansyah403 commented Jan 23, 2024 •

edited

Loading

posti85 commented Oct 7, 2024 •

edited

Loading