fix: screenshot() times out when the main Cypress tab is not focused #29038
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Passing run #54404 ↗︎
Details:
Review all test suite changes for PR #29038 ↗︎ |
|||||||||||||||
…Front in headless mode
ryanthemanuel
approved these changes
Mar 7, 2024
AtofStryker
approved these changes
Mar 7, 2024
| sanitizeScreenshotDimensions: true, | ||
| snapshot: true, | ||
| expectedExitCode: 1, | ||
| browser: '!webkit', |
There was a problem hiding this comment.
I only run into the issue in chrome. firefox and electron both seem to work as expected prior to the fix.
Suggested change
| browser: '!webkit', | |
| browser: 'chrome', |
There was a problem hiding this comment.
could also be good to just exercise the behavior since it is a change to CDP automation itself and make sure the behavior doesn't regress in those browsers for whatever reason
|
Released in This comment thread has been locked. If you are still experiencing this issue after upgrading to |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
cypress run#5016Additional details
When the Renderer for a given Chromium tab is paused, CDP commands that query that renderer hang until the renderer is unpaused. Unfortunately, this causes issues with
cy.screenshot()in both run and open mode, if the main Cypress tab becomes unfocused. This happens when an anchor is clicked within a test that has atargetof_blank, among other scenarios. To keep tests running, we timeout on capturing a screenshot after 30 seconds.When in
runmode, this causes issues when a test assertion fails after a new tab has been opened. By default, Cypress takes a screenshot when an assertion fails. If this screenshot times out, the original assertion failure is replaced by the screenshot timeout error.To fix this, we now attempt to activate the main Cypress tab in Chromium browsers before taking a screenshot. First, we request the extension to activate the main tab. This can fail if the Cypress extension has been disabled. As a last resort, the
Page.bringToFrontcommand is issued to CDP. This is less desirable, as it causes the browser to steal focus.Steps to test
See:
./system-tests/projects/config-screenshot-on-failure-enabled. To test with the extension disabled, modify./system-tests/test/issue_5016_spec.jsand pass bothnoExit: trueandheaded: true. Once the test completes, disable the extension inchrome://extensions/and reload the main Cypress tab.How has the user experience changed?
PR Tasks
cypress-documentation? Adds section to cy.screenshot() about Chromium tab activation behavior cypress-documentation#5735type definitions?