From 11bf3a32e1dc738e6a4b629740197d83a552f61a Mon Sep 17 00:00:00 2001 From: Tim Yung Date: Wed, 2 Oct 2024 02:07:00 -0700 Subject: [PATCH] Animated: Rename `__debouncedOnEnd` to `__notifyAnimationEnd` (#46718) Summary: Pull Request resolved: https://github.com/facebook/react-native/pull/46718 Simple rename of a protected method that should not be called by anyone outside of the `Animation` class and its subclasses, just to make it more intuitive. Changelog: [Internal] Reviewed By: javache Differential Revision: D63572363 fbshipit-source-id: cf68f63a9b361767b9dbfcd73124bcdae7a1806e --- .../Animated/animations/Animation.js | 21 ++++++++++++------- .../Animated/animations/DecayAnimation.js | 4 ++-- .../Animated/animations/SpringAnimation.js | 4 ++-- .../Animated/animations/TimingAnimation.js | 6 +++--- .../__snapshots__/public-api-test.js.snap | 2 +- 5 files changed, 21 insertions(+), 16 deletions(-) diff --git a/packages/react-native/Libraries/Animated/animations/Animation.js b/packages/react-native/Libraries/Animated/animations/Animation.js index 120695bcf08..ba7601c988b 100644 --- a/packages/react-native/Libraries/Animated/animations/Animation.js +++ b/packages/react-native/Libraries/Animated/animations/Animation.js @@ -88,13 +88,6 @@ export default class Animation { throw new Error('This animation type cannot be offloaded to native'); } - // Helper function for subclasses to make sure onEnd is only called once. - __debouncedOnEnd(result: EndResult): void { - const onEnd = this.#onEnd; - this.#onEnd = null; - onEnd && onEnd(result); - } - __findAnimatedPropsNodes(node: AnimatedNode): Array { const result = []; @@ -129,7 +122,7 @@ export default class Animation { animatedValue.__getNativeTag(), config, result => { - this.__debouncedOnEnd(result); + this.__notifyAnimationEnd(result); // When using natively driven animations, once the animation completes, // we need to ensure that the JS side nodes are synced with the updated @@ -163,4 +156,16 @@ export default class Animation { ); } } + + /** + * Notify the completion callback that the animation has ended. The completion + * callback will never be called more than once. + */ + __notifyAnimationEnd(result: EndResult): void { + const callback = this.#onEnd; + if (callback != null) { + this.#onEnd = null; + callback(result); + } + } } diff --git a/packages/react-native/Libraries/Animated/animations/DecayAnimation.js b/packages/react-native/Libraries/Animated/animations/DecayAnimation.js index 3803621d2bb..5d12d0103fb 100644 --- a/packages/react-native/Libraries/Animated/animations/DecayAnimation.js +++ b/packages/react-native/Libraries/Animated/animations/DecayAnimation.js @@ -100,7 +100,7 @@ export default class DecayAnimation extends Animation { this._onUpdate(value); if (Math.abs(this._lastValue - value) < 0.1) { - this.__debouncedOnEnd({finished: true}); + this.__notifyAnimationEnd({finished: true}); return; } @@ -116,6 +116,6 @@ export default class DecayAnimation extends Animation { if (this._animationFrame != null) { global.cancelAnimationFrame(this._animationFrame); } - this.__debouncedOnEnd({finished: false}); + this.__notifyAnimationEnd({finished: false}); } } diff --git a/packages/react-native/Libraries/Animated/animations/SpringAnimation.js b/packages/react-native/Libraries/Animated/animations/SpringAnimation.js index 3967bbc13b0..94be07d774c 100644 --- a/packages/react-native/Libraries/Animated/animations/SpringAnimation.js +++ b/packages/react-native/Libraries/Animated/animations/SpringAnimation.js @@ -354,7 +354,7 @@ export default class SpringAnimation extends Animation { this._onUpdate(this._toValue); } - this.__debouncedOnEnd({finished: true}); + this.__notifyAnimationEnd({finished: true}); return; } // $FlowFixMe[method-unbinding] added when improving typing for this parameters @@ -367,6 +367,6 @@ export default class SpringAnimation extends Animation { if (this._animationFrame != null) { global.cancelAnimationFrame(this._animationFrame); } - this.__debouncedOnEnd({finished: false}); + this.__notifyAnimationEnd({finished: false}); } } diff --git a/packages/react-native/Libraries/Animated/animations/TimingAnimation.js b/packages/react-native/Libraries/Animated/animations/TimingAnimation.js index f751b585c26..4d606e5c6e0 100644 --- a/packages/react-native/Libraries/Animated/animations/TimingAnimation.js +++ b/packages/react-native/Libraries/Animated/animations/TimingAnimation.js @@ -124,7 +124,7 @@ export default class TimingAnimation extends Animation { // not cause intermixed JS and native animations. if (this._duration === 0) { this._onUpdate(this._toValue); - this.__debouncedOnEnd({finished: true}); + this.__notifyAnimationEnd({finished: true}); } else { this._animationFrame = requestAnimationFrame(() => this.onUpdate()); } @@ -147,7 +147,7 @@ export default class TimingAnimation extends Animation { this._fromValue + this._easing(1) * (this._toValue - this._fromValue), ); } - this.__debouncedOnEnd({finished: true}); + this.__notifyAnimationEnd({finished: true}); return; } @@ -168,6 +168,6 @@ export default class TimingAnimation extends Animation { if (this._animationFrame != null) { global.cancelAnimationFrame(this._animationFrame); } - this.__debouncedOnEnd({finished: false}); + this.__notifyAnimationEnd({finished: false}); } } diff --git a/packages/react-native/Libraries/__tests__/__snapshots__/public-api-test.js.snap b/packages/react-native/Libraries/__tests__/__snapshots__/public-api-test.js.snap index 6ef51ca3408..8d2e1f4cc2c 100644 --- a/packages/react-native/Libraries/__tests__/__snapshots__/public-api-test.js.snap +++ b/packages/react-native/Libraries/__tests__/__snapshots__/public-api-test.js.snap @@ -443,9 +443,9 @@ declare export default class Animation { platformConfig: ?PlatformConfig, ... }>; - __debouncedOnEnd(result: EndResult): void; __findAnimatedPropsNodes(node: AnimatedNode): Array; __startAnimationIfNative(animatedValue: AnimatedValue): boolean; + __notifyAnimationEnd(result: EndResult): void; } " `;