feat: Improve UX when Test Replay upload fails due to slow upload

[cacieprins]

• Closes

Additional details

Cypress monitors the upload of a Test Replay recording. If the upload speed drops below 102.4kbps over a period of five seconds, Cypress terminates the upload so that CI pipelines are not unnecessarily slowed. This value is determined by:

• The default chunk size for an fs readStream is 64 kilobytes
• The interval used to determine if an upload stream has stalled is 5 seconds
• 64 kB * 8 = 512kb; 512kbp / 5s = 102.4kbps

This PR changes that behavior such that:

• A non-cryptic error message is displayed, providing recommended workarounds
• App Capture code can provide a default interval value, so this duration can be tweaked without updating the Cypress app
• Users can override the value with an environment variable
• Uncategorized errors that occur when uploading a Test Replay recording will display a formatted error message.

Steps to test

• limit machine bandwidth to lower than ~102kbps and increase the sampling interval to an appropriate amount by setting the CYPRESS_PROTOCOL_UPLOAD_SAMPLING_INTERVAL environment variable. If your bandwidth is set to 56kbps, for example, you should set the sampling interval to at least ten seconds (at 56kbps, it should take just over 9 seconds to transfer 512kb, or 64 kiloBytes)
• the upload will not be cancelled

How has the user experience changed?

A new stream stall error message:

A new uncategorized error message:

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]

cypress    Run #57310

Run Properties:   Passed #57310  •  cf342cfc2c: changelog

Project	cypress
Branch Review	cacie/9143/stream-stall-enhancements
Run status	Passed #57310
Run duration	25m 47s
Commit	cf342cfc2c: changelog
Committer	Cacie Prins
View all properties for this run ↗︎

---

Test results
Failures	0
Flaky	7
Pending	1326
Skipped	0
Passing	29395
View all changes introduced in this branch ↗︎

UI Coverage  44.77%
Untested elements	201
Tested elements	167

Accessibility  91.28%
Failed rules	5 critical   10 serious   2 moderate   2 minor
Failed elements	944

[cypress-bot]

Released in 13.15.0.

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