-
Notifications
You must be signed in to change notification settings - Fork 3.4k
perf: improve performance of pinning snapshots during hover / pin #32951
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: develop
Are you sure you want to change the base?
Conversation
…tions (used for snapshots)
| @@ -0,0 +1,137 @@ | |||
| import { AutIframe } from './aut-iframe' | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think these are in an optimal form for unit tests, but it doesn't seem we have vitest or any other convention here but Cypress tests. I'd like to have a test for this, so welcome to if there's a better way to do this.
| @@ -0,0 +1,58 @@ | |||
| import { getElementDimensions } from './dimensions' | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Another 'unit' test
| const style = `border: none !important; margin: 0 !important; padding: 0 !important; position: absolute; top: ${top}px; left: ${left}px; width: ${width}px; height: ${height}px; background-color: black; z-index: 2147483647;` | ||
|
|
||
| const div = document.createElement('div') | ||
|
|
||
| div.className = '__cypress-blackout' | ||
| div.style.cssText = style | ||
| $body.append(div) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Probably not helpful much, but looked into this function a bit for the blackout of screenshots.
|
|
||
| const getElementDimensions = ($el: JQuery<HTMLElement>) => { | ||
| const el: HTMLElement = $el.get(0) | ||
|
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should consolidate these but I didn't want to get distracted with this.
Additional details
Improves performance of hovering or pinning a command to highlight elements within a snapshot. The improvements would be most evident when the command queries A LOT of elements. There are a few strategies employed here:
getComputedStylesSteps to test
How has the user experience changed?
Before
When hovering/clicking to pin a snapshot that targets 3,000 elements completely locks up the UI for 15+ seconds. You cannot hover or pin any other snapshots during this time - or see any highlights.
Screen.Recording.2025-11-14.at.12.42.00.PM.mov
After
When hovering/clicking to pin a snapshot that targets 3,000 element - highlights and pinning shows up within 2 seconds (although ALL of the elements are not done highlighting). You can see when all of the elements finish highlighting in my video where the console.log logs when it's complete.
Screen.Recording.2025-11-14.at.12.38.48.PM.mov
You can click and hover around fairly quickly (feels a little laggy) since the previous batch of highlighting now cancels when you go to highlight other snapshots.
Screen.Recording.2025-11-14.at.12.48.46.PM.mov
PR Tasks
cypress-documentation?type definitions?Note
Speeds up Command Log snapshot highlighting by caching getComputedStyle results, batching DOM operations/positioning, and canceling in-flight highlight work; adds tests and minor refactors.
packages/app/src/runner):AutIframe.highlightEl: batch-create highlight layers off-DOM, append viaDocumentFragment, then batch-position withrequestAnimationFrame; add cancelation via_currentHighlightingId.dimensions.ts: cache a singlegetComputedStylecall; returndisplay,transform,zIndex, andoffsetWidth/Height; optimizesetOffset._addElementBoxModelLayers: accept precomputed dimensions, avoid extra style reads; store positions as data attrs; use sharedINT32_MAX.restoreDom/removeHighlightsoptimized to reduce redundant lookups and batch removals.packages/driver/src/dom):dimensions.ts: cache computed styles (padding/border/margin) in one pass.blackout.ts: build blackout div via native DOM and compact style string.getComputedStylecall and no redundant calls when dimensions provided (aut-iframe.cy.tsx,dimensions.cy.tsx).cli/CHANGELOG.mdnoting improved Command Log snapshot highlighting performance.Written by Cursor Bugbot for commit c761e8f. This will update automatically on new commits. Configure here.