waitForAnimations false does not narrow down element to one at coordinates

[lukeapage]

Current behavior

Say we have the following dom elements:

<div id="outer">
  <div id="inner">content</div>
</div>

and inner is taking up 100% of the outer container.

When calling

cy.get('#outer').click();

Cypress will actually call click on #inner as that is the element at the click point.

But if I do

cy.get('#outer').click({ waitForAnimations: false });

Then the dispatch happens on the outer element.

You can see clearly why in the code here:

cypress/packages/driver/src/cy/actionability.js

Lines 357 to 375 in 0b07e8f

	// if force is true OR waitForAnimations is false
	// then do not perform these additional ensures...
	if ((options.ensure.notAnimating) && (force !== true) && (options.waitForAnimations !== false)) {
	// store the coords that were absolute
	// from the window or from the viewport for sticky elements
	// (see https://github.com/cypress-io/cypress/pull/1478)
	const sticky = !!getStickyEl($el)
	coordsHistory.push(sticky ? coords.fromElViewport : coords.fromElWindow)
	// then we ensure the element isnt animating
	ensureNotAnimating(cy, $el, coordsHistory, options.animationDistanceThreshold)
	// now that we know our element isn't animating its time
	// to figure out if it's being covered by another element.
	// this calculation is relative from the viewport so we
	// only care about fromElViewport coords
	$elAtCoords = options.ensure.notCovered && ensureElIsNotCovered(cy, win, $el, coords.fromElViewport, options, _log, onScroll)

Desired behavior

waitForAnimations: false should only change whether cypress waits for a animation, not whether cypress narrows down the element to fire events on.

Please let me know if you agree with this change in behaviour - I could make a PR that adds a test and changes the line above to continue to be omitted if force: true but to be run regardless of waitForAnimations

[cypress-bot]

The code for this is done in cypress-io/cypress#14373, but has yet to be released.
We'll update this issue and reference the changelog when it's released.

[cypress-bot]

Released in 6.3.0.

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