Merge pull request #35 from videojs/hotfix/snapshot-scope

Handle snapshots directly before and after ad playback

Author: dmlap

package.json

@@ -1,5 +1,10 @@
 {
   "name": "videojs-contrib-ads",
+  "description": "A framework that provides common functionality needed by video advertisement libraries working with video.js.",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/videojs/videojs-contrib-ads.git"
+  },
   "version": "0.2.1",
   "author": {
     "name": "Brightcove"

src/videojs.ads.js

@@ -296,7 +296,6 @@ var
               },
               'play': function() {
                 this.state = 'ads-ready?';
-                this.snapshot = getPlayerSnapshot(player);
                 cancelContentPlay(player);
 
                 // remove the poster so it doesn't flash between videos
@@ -314,13 +313,6 @@ var
           },
           'preroll?': {
             enter: function() {
-              
-              // capture current player state snapshot (playing, currentTime, src)
-              this.snapshot = getPlayerSnapshot(player);
-
-              // remove the poster so it doesn't flash between videos
-              removeNativePoster(player);
-              
               // change class to show that we're waiting on ads
               player.el().className += ' vjs-ad-loading';
 
@@ -379,9 +371,6 @@ var
             }
           },
           'ad-timeout-playback': {
-            enter: function() {
-              restorePlayerSnapshot(player, this.snapshot);
-            },
             events: {
               'adsready': function() {
                 if (player.paused()) {
@@ -400,19 +389,27 @@ var
             }
           },
           'ad-playback': {
+            enter: function() {
+              // capture current player state snapshot (playing, currentTime, src)
+              this.snapshot = getPlayerSnapshot(player);
+
+              // remove the poster so it doesn't flash between videos
+              removeNativePoster(player);
+            },
+            leave: function() {
+              removeClass(player.el(), 'vjs-ad-playing');
+              restorePlayerSnapshot(player, this.snapshot);
+            },
             events: {
               'adend': function() {
                 this.state = 'content-playback';
-                removeClass(player.el(), 'vjs-ad-playing');
-                restorePlayerSnapshot(player, this.snapshot);
               }
             }
           },
           'content-playback': {
             events: {
               'adstart': function() {
                 this.state = 'ad-playback';
-                this.snapshot = getPlayerSnapshot(player);
                 player.el().className += ' vjs-ad-playing';
 
                 // remove the poster so it doesn't flash between videos

test/videojs.ads.test.js

@@ -238,6 +238,7 @@ test('removes the poster attribute so it does not flash between videos', functio
 
   player.trigger('adsready');
   player.trigger('play');
+  player.trigger('adstart');
 
   equal(video.poster, '', 'poster is removed');
 });
@@ -455,8 +456,10 @@ test('only restores the player snapshot if the src changed', function() {
     }
     srcModified = true;
   };
-  player.currentTime = function() {
-    currentTimeModified = true;
+  player.currentTime = function(time) {
+    if (time !== undefined) {
+      currentTimeModified = true;
+    }
   };
 
   // with a separate video display or server-side ad insertion, ads play but
@@ -582,15 +585,41 @@ test('snapshot does not resume after multiple post-rolls', function() {
   player.trigger('ended');
   //trigger a lots o post-rolls
   player.trigger('adstart');
-  player.src('//exampe.com/ad1.mp4');
+  player.src('http://example.com/ad1.mp4');
   player.trigger('loadstart');
   player.trigger('adend');
   player.trigger('adstart');
-  player.src('//exampe.com/ad2.mp4');
+  player.src('http://example.com/ad2.mp4');
   player.trigger('loadstart');
   player.trigger('adend');
 
   equal(player.ads.state, 'content-playback', 'Player should be in content-playback state after a post-roll');
   ok(!playCalled, 'content playback should not resume');
 
 });
+
+test('changing the source and then timing out does not restore a snapshot', function() {
+  player.paused = function() {
+    return false;
+  };
+  // load and play the initial video
+  player.src('http://example.com/movie.mp4');
+  player.trigger('loadstart');
+  player.trigger('play');
+  player.trigger('adsready');
+  // preroll
+  player.trigger('adstart');
+  player.trigger('adend');
+
+  // change the content and timeout the new ad response
+  player.src('http://example.com/movie2.mp4');
+  player.trigger('loadstart');
+  player.trigger('adtimeout');
+
+  equal(player.ads.state,
+        'ad-timeout-playback',
+        'playing the new content video after the ad timeout');
+  equal('http://example.com/movie2.mp4',
+        player.currentSrc(),
+        'playing the second video');
+});