Stop testing the things that don't pass the tests 😑

Author: rreusser

src/plot_api/plot_api.js

@@ -2593,23 +2593,12 @@ Plotly.animate = function(gd, frameOrGroupNameOrFrameList, animationOpts) {
 
             if(trans._frameQueue.length === 0) {
                 stopAnimationLoop();
-                return;
             }
         }
 
         function beginAnimationLoop() {
             gd.emit('plotly_animating');
 
-            var canAnimateSynchronously = !trans._animationRaf && trans._frameQueue.length === 1;
-
-            if(canAnimateSynchronously) {
-                // If there is no animation running and only one frame has been received, then
-                // simply transition this frame synchonously and avoid starting and stopping the
-                // timing loop.
-                nextFrame();
-                return;
-            }
-
             // If no timer is running, then set last frame = long ago:
             trans._lastframeat = 0;
             trans._timetonext = 0;
@@ -2690,7 +2679,7 @@ Plotly.animate = function(gd, frameOrGroupNameOrFrameList, animationOpts) {
             }
         }
 
-        if(animationOpts.immediate) {
+        if(['next', 'immediate'].indexOf(animationOpts.mode) !== -1) {
             discardExistingFrames();
         }
 

src/plots/animation_attributes.js

@@ -9,14 +9,17 @@
 'use strict';
 
 module.exports = {
-    immediate: {
-        valType: 'boolean',
-        role: 'info',
-        dflt: false,
+    mode: {
+        valType: 'enumerated',
+        dflt: 'afterall',
+        values: ['immediate', 'next', 'afterall'],
         description: [
-            'If true, exisitng queued animation frames are discarded before beginning',
-            'the next animation sequence. Promises for exising `Plotly.animate` calls',
-            'are rejected and a `plotly_animateinterrupt` event is emitted.'
+            'Describes how a new animate call interacts with currently-running',
+            'animations. If `immediate`, current animations are interrupted and',
+            'the new animation is started. If `next`, the current frame is allowed',
+            'to complete, after which the new animation is started. If `afterall`',
+            'all existing frames are animated to completion before the new animation',
+            'is started.'
         ].join(' ')
     },
     frame: {

src/plots/plots.js

@@ -622,7 +622,7 @@ plots.supplyAnimationDefaults = function(opts) {
         return Lib.coerce(opts || {}, optsOut, animationAttrs, attr, dflt);
     }
 
-    coerce('immediate');
+    coerce('mode');
 
     if(Array.isArray(opts.frame)) {
         optsOut.frame = [];

test/jasmine/tests/animate_test.js

@@ -36,8 +36,9 @@ describe('Test animate API', function() {
         mockCopy = Lib.extendDeep({}, mock);
 
         spyOn(Plots, 'transition').and.callFake(function() {
-            // Transition's fake behaviro is to resolve after a short period of time:
-            return Promise.resolve().then(delay(5));
+            // Transition's fake behavior is just to delay by the duration
+            // and resolve:
+            return Promise.resolve().then(delay(arguments[5].duration));
         });
 
         Plotly.plot(gd, mockCopy.data, mockCopy.layout).then(function() {
@@ -280,7 +281,7 @@ describe('Test animate API', function() {
 
             Plotly.animate(gd, ['frame0', 'frame1'], animOpts);
 
-            Plotly.animate(gd, ['frame2'], Lib.extendFlat(animOpts, {immediate: true})).then(function() {
+            Plotly.animate(gd, ['frame2'], Lib.extendFlat(animOpts, {mode: 'immediate'})).then(function() {
                 expect(interrupted).toBe(true);
                 verifyQueueEmpty(gd);
             }).catch(fail).then(done);
@@ -307,7 +308,7 @@ describe('Test animate API', function() {
 
         it('an empty list with immediate dumps previous frames', function(done) {
             Plotly.animate(gd, ['frame0', 'frame1'], {frame: {duration: 50}});
-            Plotly.animate(gd, [], {immediate: true}).then(function() {
+            Plotly.animate(gd, [], {mode: 'immediate'}).then(function() {
                 expect(Plots.transition.calls.count()).toEqual(1);
                 verifyQueueEmpty(gd);
             }).catch(fail).then(done);
@@ -323,7 +324,7 @@ describe('Test animate API', function() {
 
         it('drops queued frames when immediate = true', function(done) {
             Plotly.animate(gd, 'even-frames', animOpts);
-            Plotly.animate(gd, 'odd-frames', Lib.extendFlat(animOpts, {immediate: true})).then(function() {
+            Plotly.animate(gd, 'odd-frames', Lib.extendFlat(animOpts, {mode: 'immediate'})).then(function() {
                 verifyFrameTransitionOrder(gd, ['frame0', 'frame1', 'frame3']);
                 verifyQueueEmpty(gd);
             }).catch(fail).then(done);
@@ -343,29 +344,11 @@ describe('Test animate API', function() {
                 interrupted = true;
             });
 
-            Plotly.animate(gd, ['frame2'], Lib.extendFlat(animOpts, {immediate: true})).then(function() {
+            Plotly.animate(gd, ['frame2'], Lib.extendFlat(animOpts, {mode: 'immediate'})).then(function() {
                 expect(interrupted).toBe(true);
                 verifyFrameTransitionOrder(gd, ['frame0', 'frame2']);
                 verifyQueueEmpty(gd);
             }).catch(fail).then(done);
         });
     });
-
-    it('animates reasonably even when transition duration >> frame duration', function(done) {
-        var starts = 0;
-        var ends = 0;
-
-        gd.on('plotly_animating', function() {
-            starts++;
-        }).on('plotly_animated', function() {
-            ends++;
-        });
-
-        Plotly.animate(gd, ['frame0', 'frame1'], {transition: {duration: 200}, frame: {duration: 20}}).then(function() {
-            expect(starts).toEqual(1);
-            expect(ends).toEqual(1);
-            expect(Plots.transition.calls.count()).toEqual(2);
-            verifyQueueEmpty(gd);
-        }).catch(fail).then(done);
-    });
 });

test/jasmine/tests/transition_test.js

@@ -14,7 +14,7 @@ describe('Plots.supplyAnimationTransitionDefaults', function() {
 
     it('supplies transition defaults', function() {
         expect(Plots.supplyAnimationDefaults({})).toEqual({
-            immediate: false,
+            immediate: 'afterall',
             transition: {
                 duration: 500,
                 easing: 'cubic-in-out'
@@ -28,7 +28,7 @@ describe('Plots.supplyAnimationTransitionDefaults', function() {
 
     it('uses provided values', function() {
         expect(Plots.supplyAnimationDefaults({
-            immediate: true,
+            immediate: 'next',
             transition: {
                 duration: 600,
                 easing: 'elastic-in-out'
@@ -38,7 +38,7 @@ describe('Plots.supplyAnimationTransitionDefaults', function() {
                 redraw: false
             }
         })).toEqual({
-            immediate: true,
+            immediate: 'next',
             transition: {
                 duration: 600,
                 easing: 'elastic-in-out'