diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index a184176c..18d9307a 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,30 +1,3 @@
# CONTRIBUTING
-We welcome contributions from everyone!
-
-## Getting Started
-
-Make sure you have NodeJS 0.10 or higher and npm installed.
-
-1. Fork this repository and clone your fork
-1. Install dependencies: `npm install`
-1. Run a development server: `npm start`
-
-### Making Changes
-
-Refer to the [video.js plugin conventions][conventions] for more detail on best practices and tooling for video.js plugin authorship.
-
-When you've made your changes, push your commit(s) to your fork and issue a pull request against the original repository.
-
-### Running Tests
-
-Testing is a crucial part of any software project. For all but the most trivial changes (typos, etc) test cases are expected. Tests are run in actual browsers using [Karma][karma].
-
-- In all available and supported browsers: `npm test`
-- In a specific browser: `npm run test:chrome`, `npm run test:firefox`, etc.
-- While development server is running (`npm start`), navigate to [`http://localhost:9999/test/`][local]
-
-
-[karma]: http://karma-runner.github.io/
-[local]: http://localhost:9999/test/
-[conventions]: https://github.com/videojs/generator-videojs-plugin/blob/master/docs/conventions.md
+See: [docs/developer/index.md](docs/developer/index.md)
diff --git a/docs/developer/getting-started.md b/docs/developer/getting-started.md
index 8663bd30..bd44d9c1 100644
--- a/docs/developer/getting-started.md
+++ b/docs/developer/getting-started.md
@@ -35,7 +35,7 @@ npm run test
### In browser
-Run `./node_modules/.bin/karma start --no-single-run --browsers Chrome test/karma.conf.js` then open `localhost:9876/debug.html`. This can be useful for debugging tests.
+Run `npm start` and a Chrome instance will launch with Karma's debug interface at `localhost:9876`, allowing you to debug tests. Also, a static server will run and allow you to look at examples at `localhost:9999`.
## What's Next
diff --git a/examples/stitched-ad-plugin/app.css b/examples/stitched-ad-plugin/app.css
new file mode 100644
index 00000000..3d7e9b8f
--- /dev/null
+++ b/examples/stitched-ad-plugin/app.css
@@ -0,0 +1,25 @@
+.ad-event {
+ background-color: #ffe400;
+}
+.content-event {
+ background-color: #66a8cc;
+}
+.content-adplugin-event {
+ background-color: #00a866;
+}
+ol {
+ list-style-type: none;
+ padding: 0;
+ font-family: monospace;
+ white-space: pre;
+}
+
+/* cue-text-tracks-example Styles */
+
+.ad-container .vjs-play-progress.vjs-slider-bar {
+ background-color: #ff0000;
+}
+
+.ad-container .vjs-big-play-button {
+ display: none;
+}
diff --git a/examples/stitched-ad-plugin/app.js b/examples/stitched-ad-plugin/app.js
new file mode 100644
index 00000000..fd18764a
--- /dev/null
+++ b/examples/stitched-ad-plugin/app.js
@@ -0,0 +1,99 @@
+(function() {
+ 'use strict';
+ var pad = function(n, x, c) {
+ return (new Array(n).join(c || '0') + x).slice(-n);
+ };
+ var padRight = function(n, x, c) {
+ return (x + (new Array(n).join(c || '0'))).slice(0, n);
+ };
+
+ var player = window.player = videojs('examplePlayer');
+
+ // initalize example ad plugin for this player
+ player.exampleStitchedAds({
+ debug: true
+ });
+
+ var log = document.querySelector('.log');
+ var Html5 = videojs.getTech('Html5');
+
+ var eventList = Html5.Events.concat(Html5.Events.map(function(evt) {
+ return 'ad' + evt;
+ })).concat(Html5.Events.map(function(evt) {
+ return 'content' + evt;
+ })).concat([
+ // events emitted by ad plugin
+ 'adtimeout',
+ 'contentupdate',
+ 'contentplayback',
+ 'readyforpreroll',
+ 'readyforpostroll',
+ // events emitted by third party ad implementors
+ 'adsready',
+ 'adscanceled',
+ 'adplaying',
+ 'adstart', // startLinearAdMode()
+ 'adend', // endLinearAdMode()
+ 'nopreroll',
+ 'nopostroll'
+
+ ]).filter(function(evt) {
+ var events = {
+ progress: 1,
+ timeupdate: 1,
+ suspend: 1,
+ emptied: 1,
+ durationchange: 1,
+ contentprogress: 1,
+ contenttimeupdate: 1,
+ contentsuspend: 1,
+ contentemptied: 1,
+ adprogress: 1,
+ adtimeupdate: 1,
+ adsuspend: 1,
+ ademptied: 1,
+ adabort: 1
+ }
+
+ return !(evt in events);
+ });
+
+ player.on(eventList, function(event) {
+ var d , str, li, evt;
+
+ evt = event.type;
+ li = document.createElement('li');
+
+ d = new Date();
+ d = '' +
+ pad(2, d.getHours()) + ':' +
+ pad(2, d.getMinutes()) + ':' +
+ pad(2, d.getSeconds()) + '.' +
+ pad(3, d.getMilliseconds());
+
+ if (event.type.indexOf('ad') === 0) {
+ li.className = 'ad-event';
+ } else if (event.type.indexOf('content') === 0) {
+ li.className = 'content-event';
+ }
+
+ str = d + ' ' + evt;
+
+ if (evt === 'contentupdate') {
+ str += ' ' + event.oldValue + " -> " + event.newValue;
+ li.className = 'content-adplugin-event';
+ }
+ if (evt === 'contentchanged') {
+ li.className = 'content-adplugin-event';
+ }
+ if (evt === 'contentplayback') {
+ li.className = 'content-adplugin-event';
+ }
+ if (evt === 'adplay') {
+ player.trigger('ads-ad-started');
+ }
+
+ li.innerHTML = str;
+ log.insertBefore(li, log.firstChild);
+ });
+})();
diff --git a/examples/stitched-ad-plugin/index.html b/examples/stitched-ad-plugin/index.html
new file mode 100644
index 00000000..e0609729
--- /dev/null
+++ b/examples/stitched-ad-plugin/index.html
@@ -0,0 +1,38 @@
+
+
+
+ Stitched Ads Example
+ Stitched Ads Example
+
+ This page uses the built files, so you must do a local build before the example will work.
+
+ This is a limited example implementation that puts the player into and out of ad mode for 5 seconds at specific times.
+
+
+
+
+
+
+
+ Events
+
+ Example ad plugin. Example cueTextTracks plugin. Example using modules Example stitched ad plugin. videojs-contrib-ads Unit Tests
-
-
-
-
-
-
-
-
-
-
-
-
diff --git a/test/integration/lib/shared-module-hooks.js b/test/integration/lib/shared-module-hooks.js
index a19d9908..ed997f12 100644
--- a/test/integration/lib/shared-module-hooks.js
+++ b/test/integration/lib/shared-module-hooks.js
@@ -57,7 +57,7 @@ window.sharedModuleHooks = (function(){
return videojs.createTimeRange(0, 0);
};
- this.player.ads();
+ this.player.ads(this.adsOptions);
},
afterEach: function() {
diff --git a/test/integration/test.cancelContentPlay.js b/test/integration/test.cancelContentPlay.js
index 57661146..6697a15d 100644
--- a/test/integration/test.cancelContentPlay.js
+++ b/test/integration/test.cancelContentPlay.js
@@ -20,10 +20,14 @@ const restoreVideojs = function() {
};
// Run custom hooks before sharedModuleHooks, as videojs must be
-// modified before seting up the player and videojs-contrib-ads
+// modified before setting up the player and videojs-contrib-ads
QUnit.module('Cancel Content Play', {
- beforeEach: _.flow(fakeVideojs, sharedHooks.beforeEach),
- afterEach: _.flow(restoreVideojs, sharedHooks.afterEach)
+ beforeEach: _.flow(function() {
+ this.adsOptions = {};
+ }, fakeVideojs, sharedHooks.beforeEach),
+ afterEach: _.flow(function() {
+ this.adsOptions = null;
+ }, restoreVideojs, sharedHooks.afterEach)
});
QUnit.test('pauses to wait for prerolls when the plugin loads BEFORE play', function(assert) {
@@ -42,7 +46,6 @@ QUnit.test('pauses to wait for prerolls when the plugin loads BEFORE play', func
assert.strictEqual(spy.callCount, 2, 'play attempts are paused');
});
-
QUnit.test('pauses to wait for prerolls when the plugin loads AFTER play', function(assert) {
var pauseSpy = sinon.spy(this.player, 'pause');
@@ -133,4 +136,47 @@ QUnit.test('content is resumed after ads if a user initiated play event is cance
this.player.trigger('play');
assert.ok(pauseSpy.callCount, 1, 'pause was not called again');
-});
\ No newline at end of file
+});
+
+// Set up contrib-ads options and run custom hooks before sharedModuleHooks, as
+// videojs must be modified before setting up the player and videojs-contrib-ads
+QUnit.module('Cancel Content Play (w/ Stitched Ads)', {
+ beforeEach: _.flow(function() {
+ this.adsOptions = {
+ stitchedAds: true
+ };
+ }, fakeVideojs, sharedHooks.beforeEach),
+ afterEach: _.flow(function() {
+ this.adsOptions = null;
+ }, restoreVideojs, sharedHooks.afterEach)
+});
+
+QUnit.test('does not pause to wait for prerolls when the plugin loads BEFORE play', function(assert) {
+ var spy = sinon.spy(this.player, 'pause');
+
+ this.player.paused = function() {
+ return false;
+ };
+
+ this.player.trigger('adsready');
+ this.player.trigger('play');
+ this.clock.tick(1);
+ this.player.trigger('play');
+ this.clock.tick(1);
+
+ assert.strictEqual(spy.callCount, 0, 'play attempts are not paused');
+});
+
+QUnit.test('does not pause to wait for prerolls when the plugin loads AFTER play', function(assert) {
+ var pauseSpy = sinon.spy(this.player, 'pause');
+
+ this.player.paused = function() {
+ return false;
+ };
+
+ this.player.trigger('play');
+ this.clock.tick(1);
+ this.player.trigger('play');
+ this.clock.tick(1);
+ assert.equal(pauseSpy.callCount, 0, 'play attempts are not paused');
+});
diff --git a/test/integration/test.stitchedAds.js b/test/integration/test.stitchedAds.js
new file mode 100644
index 00000000..3989ccfe
--- /dev/null
+++ b/test/integration/test.stitchedAds.js
@@ -0,0 +1,137 @@
+/*
+TODO:
+* timeupdate, adtimeupdate, contenttimeupdate
+* loadstart, adloadstart, contentloadstart
+* play, adplay, contentplay
+* loadeddata, adloadeddata, contentloadeddata
+* loadedmetadata, adloadedmetadata, contentloadedmetadata
+*/
+
+import videojs from 'video.js';
+import '../../examples/stitched-ad-plugin/plugin.js';
+
+let originalTestTimeout = QUnit.config.testTimeout;
+
+QUnit.module('Events and Stitched Ads', {
+
+ before() {
+ QUnit.config.testTimeout = 30000;
+ },
+
+ beforeEach() {
+ this.video = document.createElement('video');
+
+ this.fixture = document.querySelector('#qunit-fixture');
+ this.fixture.appendChild(this.video);
+
+ this.player = videojs(this.video);
+ this.player.exampleStitchedAds();
+
+ this.player.src({
+ src: 'http://vjs.zencdn.net/v/oceans.webm',
+ type: 'video/webm'
+ });
+ },
+
+ afterEach() {
+ this.player.dispose();
+ },
+
+ after() {
+ QUnit.config.testTimeout = originalTestTimeout;
+ }
+});
+
+QUnit.test('Stitched Ads', function(assert) {
+ const done = assert.async();
+
+ const seenBeforePreroll = [];
+ const seenDuringPreroll = [];
+ const seenAfterPreroll = [];
+ const seenDuringMidroll = [];
+ const seenAfterMidroll = [];
+ let currentEventLog = seenBeforePreroll;
+
+ let events = [
+ 'suspend',
+ 'abort',
+ 'error',
+ 'emptied',
+ 'stalled',
+ 'canplay',
+ 'canplaythrough',
+ 'waiting',
+ 'seeking',
+ 'durationchange',
+ 'progress',
+ 'pause',
+ 'ratechange',
+ 'volumechange',
+ 'firstplay',
+ 'suspend',
+ 'playing',
+ 'ended'
+ ];
+
+ events = events
+ .concat(events.map(e => 'ad' + e))
+ .concat(events.map(e => 'content' + e));
+
+ const {player} = this;
+
+ player.on('adstart', () => {
+ if (currentEventLog === seenBeforePreroll) {
+ currentEventLog = seenDuringPreroll;
+ } else {
+ currentEventLog = seenDuringMidroll;
+ }
+ });
+
+ player.on('adend', () => {
+ if (currentEventLog === seenDuringPreroll) {
+ currentEventLog = seenAfterPreroll;
+ } else {
+ currentEventLog = seenAfterMidroll;
+ }
+ });
+
+ player.on(events, (e) => currentEventLog.push(e.type));
+
+ player.on(['error', 'aderror'], () => {
+ assert.ok(false, 'no errors');
+ done();
+ });
+
+ player.on('timeupdate', () => {
+ videojs.log(player.currentTime(), player.currentSrc());
+
+ if (player.currentTime() > 21) {
+ seenBeforePreroll.forEach(event => {
+ assert.ok(!/^ad/.test(event), event + ' has no ad prefix before preroll');
+ assert.ok(!/^content/.test(event), event + ' has no content prefix before preroll');
+ });
+
+ seenDuringPreroll.forEach(event => {
+ assert.ok(/^ad/.test(event), event + ' has ad prefix during preroll');
+ });
+
+ seenAfterPreroll.forEach(event => {
+ assert.ok(!/^ad/.test(event), event + ' has no ad prefix after preroll');
+ assert.ok(!/^content/.test(event), event + ' has no content prefix after preroll');
+ });
+
+ seenDuringMidroll.forEach(event => {
+ assert.ok(/^ad/.test(event), event + ' has ad prefix during midroll');
+ });
+
+ seenAfterMidroll.forEach(event => {
+ assert.ok(!/^ad/.test(event), event + ' has no ad prefix after midroll');
+ assert.ok(!/^content/.test(event), event + ' has no content prefix after midroll');
+ });
+
+ done();
+ }
+ });
+
+ player.ready(player.play);
+});
diff --git a/test/karma.conf.js b/test/karma.conf.js
index d7624168..c8fd5eb3 100644
--- a/test/karma.conf.js
+++ b/test/karma.conf.js
@@ -38,15 +38,15 @@ module.exports = function(config) {
'node_modules/es5-shim/es5-shim.js',
'node_modules/sinon/pkg/sinon.js',
'node_modules/video.js/dist/video.js',
- 'dist/videojs-contrib-ads.js',
- 'dist/videojs-contrib-ads.css',
- 'test/integration/lib/shared-module-hooks.js',
- 'test/dist/bundle.js',
+ {pattern: 'dist/videojs-contrib-ads.js', nocache: true},
+ {pattern: 'dist/videojs-contrib-ads.css', nocache: true},
+ {pattern: 'test/integration/lib/shared-module-hooks.js', nocache: true},
+ {pattern: 'test/dist/bundle.js', nocache: true},
// Test Data
{pattern: 'test/integration/lib/inventory.json', included: false, served: true},
{pattern: 'examples/basic-ad-plugin/superclip-low.webm', included: false, served: true},
- {pattern: 'test/integration/lib/testcaption.vtt', included:false, served:true}
+ {pattern: 'test/integration/lib/testcaption.vtt', included: false, served: true}
],
customLaunchers: {
travisChrome: {
diff --git a/test/unit/states/test.StitchedAdRoll.js b/test/unit/states/test.StitchedAdRoll.js
new file mode 100644
index 00000000..00a17319
--- /dev/null
+++ b/test/unit/states/test.StitchedAdRoll.js
@@ -0,0 +1,52 @@
+import {StitchedAdRoll} from '../../../src/states.js';
+import adBreak from '../../../src/adBreak.js';
+
+/*
+ * These tests are intended to be isolated unit tests for one state with all
+ * other modules mocked.
+ */
+QUnit.module('StitchedAdRoll', {
+ beforeEach: function() {
+ this.player = {
+ addClass: () => {},
+ removeClass: () => {},
+ trigger: sinon.spy(),
+ ads: {
+ _inLinearAdMode: true,
+ debug: () => {}
+ }
+ };
+
+ this.adroll = new StitchedAdRoll(this.player);
+
+ this.adBreakStartStub = sinon.stub(adBreak, 'start');
+ this.adBreakEndStub = sinon.stub(adBreak, 'end');
+ },
+
+ afterEach() {
+ this.adBreakStartStub.restore();
+ this.adBreakEndStub.restore();
+ }
+});
+
+QUnit.test('starts an ad break on init', function(assert) {
+ this.adroll.init();
+ assert.equal(this.player.ads.adType, 'stitched', 'ad type is stitched');
+ assert.equal(this.adBreakStartStub.callCount, 1, 'ad break started');
+});
+
+QUnit.test('ends an ad break on endLinearAdMode', function(assert) {
+ this.adroll.init();
+ this.adroll.endLinearAdMode();
+ assert.equal(this.adBreakEndStub.callCount, 1, 'ad break ended');
+});
+
+QUnit.test('adended during ad break leaves linear ad mode and re-triggers ended', function(assert) {
+ sinon.spy(this.adroll, 'endLinearAdMode');
+
+ this.adroll.init();
+ this.adroll.onAdEnded();
+ assert.ok(this.player.trigger.calledOnce, 'the player fired one event');
+ assert.ok(this.player.trigger.calledWith('ended'), 'the event it fired was ended');
+ assert.ok(this.adroll.endLinearAdMode.calledOnce, 'the ad roll called endLinearAdMode');
+});
diff --git a/test/unit/states/test.StitchedContentPlayback.js b/test/unit/states/test.StitchedContentPlayback.js
new file mode 100644
index 00000000..63ebb759
--- /dev/null
+++ b/test/unit/states/test.StitchedContentPlayback.js
@@ -0,0 +1,43 @@
+import {StitchedContentPlayback} from '../../../src/states.js';
+
+/*
+ * These tests are intended to be isolated unit tests for one state with all
+ * other modules mocked.
+ */
+QUnit.module('StitchedContentPlayback', {
+ beforeEach: function() {
+ this.events = [];
+ this.playTriggered = false;
+
+ this.player = {
+ paused: () => false,
+ play: () => {},
+ trigger: (event) => {
+ this.events.push(event);
+ },
+ ads: {
+ debug: () => {},
+ _contentHasEnded: false,
+ _shouldBlockPlay: true
+ }
+ };
+
+ this.stitchedContentPlayback = new StitchedContentPlayback(this.player);
+ this.stitchedContentPlayback.transitionTo = (newState) => {
+ this.newState = newState.name;
+ };
+ }
+});
+
+QUnit.test('transitions to StitchedAdRoll when startLinearAdMode is called', function(assert) {
+ this.stitchedContentPlayback.init();
+ this.stitchedContentPlayback.startLinearAdMode();
+ assert.equal(this.newState, 'StitchedAdRoll', 'transitioned to StitchedAdRoll');
+});
+
+QUnit.test('sets _shouldBlockPlay to false on init', function(assert) {
+ assert.equal(this.player.ads._shouldBlockPlay, true);
+
+ this.stitchedContentPlayback.init();
+ assert.equal(this.player.ads._shouldBlockPlay, false);
+});
diff --git a/test/unit/test.ads.js b/test/unit/test.ads.js
index 119a9624..b3b2f8a4 100644
--- a/test/unit/test.ads.js
+++ b/test/unit/test.ads.js
@@ -1,3 +1,4 @@
+import videojs from 'video.js';
import getAds from '../../src/ads.js';
QUnit.module('Ads Object', {
@@ -47,6 +48,23 @@ QUnit.module('Ads Object', {
assert.equal(this.player.ads.isLive(this.player), false);
});
+ QUnit.test('stitchedAds', function(assert) {
+ assert.notOk(this.player.ads.stitchedAds());
+
+ this.player.ads.settings.stitchedAds = true;
+
+ assert.ok(this.player.ads.stitchedAds());
+
+ sinon.spy(videojs.log, 'warn');
+ this.player.ads.stitchedAds(false);
+
+ assert.ok(videojs.log.warn.calledOnce, 'using as a setter is deprecated');
+ assert.notOk(this.player.ads.stitchedAds());
+ assert.notOk(this.player.ads.settings.stitchedAds);
+
+ videojs.log.warn.restore();
+ });
+
QUnit.test('shouldPlayContentBehindAd', function(assert) {
// liveCuePoints true + finite duration
@@ -125,4 +143,20 @@ QUnit.module('Ads Object', {
videojs.browser.IS_ANDROID = true;
assert.equal(this.player.ads.shouldPlayContentBehindAd(this.player), false);
});
+
+ QUnit.test('shouldTakeSnapshots', function(assert) {
+ this.player.ads.shouldPlayContentBehindAd = () => false;
+ this.player.ads.stitchedAds = () => false;
+
+ assert.ok(this.player.ads.shouldTakeSnapshots());
+
+ this.player.ads.shouldPlayContentBehindAd = () => true;
+
+ assert.notOk(this.player.ads.shouldTakeSnapshots());
+
+ this.player.ads.shouldPlayContentBehindAd = () => false;
+ this.player.ads.stitchedAds = () => true;
+
+ assert.notOk(this.player.ads.shouldTakeSnapshots());
+ });
});
diff --git a/test/unit/test.redispatch.js b/test/unit/test.redispatch.js
index 6861b47d..edf59042 100644
--- a/test/unit/test.redispatch.js
+++ b/test/unit/test.redispatch.js
@@ -118,4 +118,4 @@ QUnit.test('play events in different states', function(assert) {
this.player.ads._playRequested = true;
assert.strictEqual(this.redispatch('play'), 'adplay',
'should be adplay when in an ad break');
-});
\ No newline at end of file
+});