fix: only adjust autoscrolling in interactive mode #23053
Merged
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
|
Thanks for taking the time to open a PR!
|
|
Test summary
Run details
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 |
|
Going to add @emilyrohrbough who has been working on the reporter a lot lately for some additional 👀 |
lmiller1990
suggested changes
Sep 12, 2022
lmiller1990
reviewed
Sep 12, 2022
|
Updated with @lmiller1990's much better tests 🙏 |
mike-plummer
approved these changes
Sep 12, 2022
lmiller1990
approved these changes
Sep 13, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
User facing changelog
In run mode, autoscrolling of the command log can no longer become disabled.
Additional details
In the linked issues several users have reported issues with the command log autoscroll becoming disabled in run mode intermittently, or in some cases every time. This is particularly painful when reviewing the video for a failed test, as without autoscrolling, the error message associated with the failure is not visible. This makes debugging a lot harder.
The underlying cause is that for whatever reason, especially when resources are low, the browser sometimes seems to incorrectly detect user scrolling when elements are rapidly being added to the command log and Cypress is autoscrolling, which triggers the
temporarilySetAutoScrolling(false)code that is helpful in open mode, since in open mode it's natural for to manually scroll the reporter while tests are running, and autoscroll would contradict that.Since this has no purpose in run mode (or a very narrow one, when running with the
--headedflag), it seems best to just turn off the scroll handling when we know that any scrolling is not possibly coming from the user.Steps to test
This one is difficult to test manually as we have almost never been able to reproduce it. But users who have tried pre-release binaries implementing the fix report that it works.
How has the user experience changed?
PR Tasks
cypress-documentation?type definitions?