commit ed3a018b7df48f7019226d876fef9b4718a15d07
author Sergei Dryganets <sergey.dryganets@gmail.com> Sat Jun 23 14:00:35 2018 -0700
committer Gabriel Peal <gpeal@users.noreply.github.com> Sat Jun 23 14:00:35 2018 -0700
tree 70402a0f0ae3cc6fa3c3a77104fd0e703799344d
parent cd547e41a623cafd3d7c2918fbb43ff7bc93f642

Fixed danglign choreographer callback. (#775)

**This patch fixes the performance issue.**

I've seen the cases where the previous version of the code was re-adding callbacks to the choreographer in case of cancelation/pause. Now it is designed to make it impossible. It looks like there is a copy of the callbacks stored somewhere in the stack. I've been able to reproduce the problem on Android 6.0 and 7.0.

This issue caused application performance degradation and battery drain in the background for us.

lottie/src/main/java/com/airbnb/lottie/utils/LottieValueAnimator.java

diff --git a/lottie/src/main/java/com/airbnb/lottie/utils/LottieValueAnimator.java b/lottie/src/main/java/com/airbnb/lottie/utils/LottieValueAnimator.java
index 03e7458..ea5986d 100644
--- a/lottie/src/main/java/com/airbnb/lottie/utils/LottieValueAnimator.java
+++ b/lottie/src/main/java/com/airbnb/lottie/utils/LottieValueAnimator.java
@@ -23,7 +23,7 @@
   private float minFrame = Integer.MIN_VALUE;
   private float maxFrame = Integer.MAX_VALUE;
   @Nullable private LottieComposition composition;
-  @VisibleForTesting protected boolean isRunning = false;
+  @VisibleForTesting protected boolean running = false;
 
   public LottieValueAnimator() {
   }
@@ -72,7 +72,7 @@
   }
 
   @Override public boolean isRunning() {
-    return isRunning;
+    return running;
   }
 
   @Override public void doFrame(long frameTimeNanos) {
@@ -193,6 +193,7 @@
   }
 
   public void playAnimation() {
+    running = true;
     notifyStart(isReversed());
     setFrame((int) (isReversed() ? getMaxFrame() : getMinFrame()));
     lastFrameTimeNs = System.nanoTime();
@@ -210,6 +211,7 @@
   }
 
   public void resumeAnimation() {
+    running = true;
     postFrameCallback();
     lastFrameTimeNs = System.nanoTime();
     if (isReversed() && getFrame() == getMinFrame()) {
@@ -243,14 +245,21 @@
   }
 
   protected void postFrameCallback() {
-    removeFrameCallback();
-    Choreographer.getInstance().postFrameCallback(this);
-    isRunning = true;
+    if (isRunning()) {
+      removeFrameCallback(false);
+      Choreographer.getInstance().postFrameCallback(this);
+    }
   }
 
   protected void removeFrameCallback() {
+    this.removeFrameCallback(true);
+  }
+
+  protected void removeFrameCallback(boolean stopRunning) {
     Choreographer.getInstance().removeFrameCallback(this);
-    isRunning = false;
+    if (stopRunning) {
+      running = false;
+    }
   }
 
   private void verifyFrame() {

lottie/src/test/java/com/airbnb/lottie/LottieValueAnimatorUnitTest.java

diff --git a/lottie/src/test/java/com/airbnb/lottie/LottieValueAnimatorUnitTest.java b/lottie/src/test/java/com/airbnb/lottie/LottieValueAnimatorUnitTest.java
index 36b80cd..235a968 100644
--- a/lottie/src/test/java/com/airbnb/lottie/LottieValueAnimatorUnitTest.java
+++ b/lottie/src/test/java/com/airbnb/lottie/LottieValueAnimatorUnitTest.java
@@ -55,11 +55,11 @@
     // Choreographer#postFrameCallback hangs with robolectric.
     return new LottieValueAnimator() {
       @Override public void postFrameCallback() {
-        isRunning = true;
+        running = true;
       }
 
       @Override public void removeFrameCallback() {
-        isRunning = false;
+        running = false;
       }
     };
   }