Reconnect to CDP on WebSocket failure

[flotwig]

• Closes WebSocket is not open: readyState 3 (CLOSED) error when watching test files #5685

User facing changelog

• Fixed an issue where using Chromium-family browsers could cause Cypress to throw a "WebSocket is not open: readyState 3" error under certain conditions.

Additional details

• added reconnection logic for the CRI
• commands received while not connected will be enqueued and sent when reconnected
• subscribed events will be re-subscribed on reconnection
• there are 2 triggers for reconnection:
  • when the CRI fires a "disconnect" event (supposedly this works, but i could not observe it in my testing)

    cypress/packages/server/lib/browsers/cri-client.ts

    Lines 190 to 191 in 7383782

    	// @see https://github.com/cyrus-and/chrome-remote-interface/issues/72
    	cri._notifier.on('disconnect', reconnect)

  • when a CDP command fails with a "WebSocket is not open..." error
• reconnection should only take 1 attempt - if it fails, a project-level error is thrown, instructing the user to try again

PR Tasks

• Have tests been added/updated?
• Has the original issue been tagged with a release in ZenHub?
• [na] Has a PR for user-facing changes been opened in cypress-documentation?
• [na] Have API changes been updated in the type definitions?
• [na] Have new configuration options been added to the cypress.schema.json?

[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

6944 • 0 • 97 • 0

---

Run details

Project	cypress
Status	Passed
Commit	7b20847
Started	Feb 24, 2020 4:54 PM
Ended	Feb 24, 2020 5:00 PM
Duration	06:00 💡
OS	Linux Debian - 9.11
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]

Good news, I can reproduce this 100% of the time after I put my mac to sleep.

Bad news, I can't get Cypress running locally so I cannot check this PR #6542

[chrisbreiding]

I verified this is functionally working on MacOS. Like Jennifer, I was also able to reliably reproduce this issue on develop by putting my computer to sleep. No longer had the issue when trying out this PR.

[adilbagi123]

@flotwig I still see this issue frequently after Cypress runs few tests- WebSocket is already in CLOSING or CLOSED state. Cypress version - 4.1.0, Windows, Chrome 80

[flotwig]

@adilbagi123 that error message won't be detected by this patch, can you please open a new issue with the full error message? Thanks!