fix: Unhandled "WebSocket connection closed" when CDP connection is unstable

[cacieprins]

• Closes Error: WebSocket connection closed (in cypress 13.10) #29572

Additional details

When CDP throws certain errors on a command, CriClient enqueues the original command and attempt to reconnect to CDP. When CDP reconnects, CriClient tries to send this command again, after restoring subscriptions and enablements. This bug appears to occur when CDP disconnects immediately after reconnecting while a previously enqueued command is pending.

The fix is to re-enqueue failed commands upon reconnect, and attempt to reconnect again.

This PR includes that fix, as well as some quality of life refactors to CriClient:

• extracts most command queue logic to its own class
• divides state restoration (subscriptions and enablements) from command retries (when a command fails due to being pending when CDP disconnects)
• Removes bespoke retry logic to use a shared async-retry util
• refactors some unit tests for grokability

Steps to test

The original issue is very difficult to reproduce - the fix is expected due to new tests that produce the issue. Typical CI & manual testing is sufficient.

How has the user experience changed?

PR Tasks

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

[cypress]

3 flaky tests on run #56153 ↗︎

0

4677

951

0

3

Details:

Merge branch 'develop' into cacie/fix/ws-disconnected-trampoline
Project: cypress	Commit: 6a4031b7bd
Status: Passed	Duration: 16:26 💡
Started: Jul 15, 2024 7:37 PM	Ended: Jul 15, 2024 7:54 PM

  cypress/e2e/commands/net_stubbing.cy.ts • 3 flaky tests • 5x-driver-webkit

View Output

Test		Artifacts
network stubbing > intercepting request > can delay and throttle a StaticResponse		</td> </tr> <tr> <td colspan="2"> <a href="https://cloud.cypress.io/projects/ypt4pf/runs/56153/overview/c1b89eb6-b805-42fb-9657-00502c5eba47?reviewViewBy=FLAKY&utm_source=github&utm_medium=flaky&utm_campaign=view%20test"> ... > with `resourceType` > can match a proxied image request by resourceType </a> </td> <td> </td> </tr> <tr> <td colspan="2"> <a href="https://cloud.cypress.io/projects/ypt4pf/runs/56153/overview/5ae404ce-0ca6-45cc-9278-4a6b25295354?reviewViewBy=FLAKY&utm_source=github&utm_medium=flaky&utm_campaign=view%20test"> ... > stops waiting when an xhr request is canceled </a> </td> <td> </td> </tr></table> Review all test suite changes for PR #29830 ↗︎

[ryanthemanuel]

How chatty will these logs be? Do we want to make some of them verbose and some of them non-verbose?

[cacieprins]

Not very chatty - commands are only pushed into the command queue when they come in while the websocket connection is unexpectedly disconnected. params might be a larger payload, though, and could benefit from a verbose (or removal, as it's not pertinent to the command queue operations)

[cacieprins]

Addressed in fc52033

[ryanthemanuel]

This looks good. I like that we're iteratively refactoring a lot of this stuff. Nice work!

[cypress-bot]

Released in 13.13.1.

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