Skip to content
This repository was archived by the owner on Apr 12, 2024. It is now read-only.

Commit 22ec93b

Browse files
authored
fix(ngAnimate): allow removal of class that is scheduled to be added with requestAnimationFrame
Also affects the reverse case, adding a class that is scheduled to be removed with rAF. The following case can happen when ngClass updates an element's classes in very quick order in the following way: - First animation adds class "a" - A digest passes, but "a" is not yet added to the element - Second animation adds class "b" - No digest passes, and "a" is still not added to the element, because requestAnimationFrame hasn't been flushed yet - Third animation removes class "a" - the third animation gets merged into the second animation Before this change: - Because the element doesn't have class "a" yet, ngAnimate resolves that it cannot remove class "a". However, the first animation is still running, and finally adds "a" After this change: - ngAnimate reacts to the temporary class "add-a", which indicates that "a" is about to be added and decides that "a" can be removed after all. This is a very rare case where setting the element's class is not fast enough, and subsequent animations operate on incorrect assumptions. "In the wild", this is caused by rapidly updating ngClass, which uses inidvidual addClass and removeClass calls when both operations happen in a single digest. Fixes #14582 PR (#14760)
1 parent 99223a0 commit 22ec93b

File tree

2 files changed

+47
-2
lines changed

2 files changed

+47
-2
lines changed

src/ngAnimate/shared.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -265,10 +265,10 @@ function resolveElementClasses(existing, toAdd, toRemove) {
265265
var prop, allow;
266266
if (val === ADD_CLASS) {
267267
prop = 'addClass';
268-
allow = !existing[klass];
268+
allow = !existing[klass] || existing[klass + REMOVE_CLASS_SUFFIX];
269269
} else if (val === REMOVE_CLASS) {
270270
prop = 'removeClass';
271-
allow = existing[klass];
271+
allow = existing[klass] || existing[klass + ADD_CLASS_SUFFIX];
272272
}
273273
if (allow) {
274274
if (classes[prop].length) {

test/ngAnimate/integrationSpec.js

+45
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,51 @@ describe('ngAnimate integration tests', function() {
5151
expect(doneHandler).toHaveBeenCalled();
5252
}));
5353

54+
it('should remove a class that is currently being added by a running animation when another class is added in before in the same digest',
55+
inject(function($animate, $rootScope, $$rAF, $document, $rootElement) {
56+
57+
jqLite($document[0].body).append($rootElement);
58+
element = jqLite('<div></div>');
59+
$rootElement.append(element);
60+
61+
var runner = $animate.addClass(element, 'red');
62+
63+
$rootScope.$digest();
64+
65+
$animate.addClass(element, 'blue');
66+
$animate.removeClass(element, 'red');
67+
$rootScope.$digest();
68+
69+
$$rAF.flush();
70+
71+
expect(element).not.toHaveClass('red');
72+
expect(element).toHaveClass('blue');
73+
}));
74+
75+
76+
it('should add a class that is currently being removed by a running animation when another class is removed before in the same digest',
77+
inject(function($animate, $rootScope, $$rAF, $document, $rootElement) {
78+
79+
jqLite($document[0].body).append($rootElement);
80+
element = jqLite('<div></div>');
81+
$rootElement.append(element);
82+
element.addClass('red blue');
83+
84+
var runner = $animate.removeClass(element, 'red');
85+
86+
$rootScope.$digest();
87+
88+
$animate.removeClass(element, 'blue');
89+
$animate.addClass(element, 'red');
90+
$rootScope.$digest();
91+
92+
$$rAF.flush();
93+
94+
expect(element).not.toHaveClass('blue');
95+
expect(element).toHaveClass('red');
96+
}));
97+
98+
5499
describe('CSS animations', function() {
55100
if (!browserSupportsCssAnimations()) return;
56101

0 commit comments

Comments
 (0)