Files
shaka-player/test/ads_integration.js
T
2026-03-09 13:34:59 +01:00

314 lines
10 KiB
JavaScript

/*! @license
* Shaka Player
* Copyright 2016 Google LLC
* SPDX-License-Identifier: Apache-2.0
*/
describe('Ads', () => {
const Util = shaka.test.Util;
/** @type {!jasmine.Spy} */
let onErrorSpy;
/** @type {!jasmine.Spy} */
let onAdErrorSpy;
/** @type {!HTMLVideoElement} */
let video;
/** @type {!HTMLElement} */
let adContainer;
/** @type {shaka.Player} */
let player;
/** @type {shaka.extern.IAdManager} */
let adManager;
/** @type {!shaka.util.EventManager} */
let eventManager;
let compiledShaka;
/** @type {!shaka.test.Waiter} */
let waiter;
beforeAll(async () => {
video = shaka.test.UiUtils.createVideoElement();
document.body.appendChild(video);
adContainer =
/** @type {!HTMLElement} */ (document.createElement('div'));
adContainer.style.position = 'absolute';
adContainer.style.top = '0px';
adContainer.style.left = '0px';
adContainer.style.width = '600px';
adContainer.style.height = '400px';
document.body.appendChild(adContainer);
compiledShaka =
await shaka.test.Loader.loadShaka(getClientArg('uncompiled'));
});
beforeEach(async () => {
await shaka.test.TestScheme.createManifests(compiledShaka, '_compiled');
player = new compiledShaka.Player();
adManager = player.getAdManager();
await player.attach(video);
// Disable stall detection, which can interfere with playback tests.
player.configure('streaming.stallEnabled', false);
// Grab event manager from the uncompiled library:
eventManager = new shaka.util.EventManager();
waiter = new shaka.test.Waiter(eventManager);
waiter.setPlayer(player);
onErrorSpy = jasmine.createSpy('onError');
onErrorSpy.and.callFake((event) => {
fail(event.detail);
});
eventManager.listen(player, 'error', Util.spyFunc(onErrorSpy));
onAdErrorSpy = jasmine.createSpy('onAdError');
onAdErrorSpy.and.callFake((event) => {
if (!event['originalEvent']) {
fail(event);
return;
}
if (event['originalEvent'] instanceof shaka.util.Error) {
fail(event['originalEvent']);
return;
}
const imaEvent =
/** @type {!google.ima.AdErrorEvent} */ (event['originalEvent']);
fail(imaEvent.getError());
});
eventManager.listen(adManager, shaka.ads.Utils.AD_ERROR,
Util.spyFunc(onAdErrorSpy));
});
afterEach(async () => {
eventManager.release();
await player.destroy();
});
afterAll(() => {
document.body.removeChild(video);
document.body.removeChild(adContainer);
});
describe('support HLS Interstitials', () => {
/**
* @return {!Promise}
*/
async function runAssetUriTest() {
goog.asserts.assert(adManager, 'Must have adManager');
await player.load('/base/test/test/assets/hls-interstitial/main.m3u8');
video.play();
expect(player.isLive()).toBe(false);
expect(adManager.getCurrentAd()).toBeNull();
// Wait a maximum of 10 seconds before the ad starts playing.
await waiter.timeoutAfter(10)
.waitForEvent(adManager, shaka.ads.Utils.AD_STARTED);
expect(adManager.getCurrentAd()).not.toBeNull();
await waiter.timeoutAfter(20)
.waitForEvent(adManager, shaka.ads.Utils.AD_STOPPED);
expect(adManager.getCurrentAd()).toBeNull();
await shaka.test.Util.delay(1);
expect(video.currentTime).toBeLessThanOrEqual(3);
// Wait a maximum of 10 seconds before the ad starts playing.
await waiter.timeoutAfter(10)
.waitForEvent(adManager, shaka.ads.Utils.AD_STARTED);
expect(adManager.getCurrentAd()).not.toBeNull();
await waiter.timeoutAfter(20)
.waitForEvent(adManager, shaka.ads.Utils.AD_STOPPED);
expect(adManager.getCurrentAd()).toBeNull();
// Play for 10 seconds, but stop early if the video ends. If it takes
// longer than 30 seconds, fail the test.
await waiter.waitUntilPlayheadReachesOrFailOnTimeout(video, 10, 30);
await player.unload();
}
it('with support for multiple media elements', async () => {
if (!player.getConfiguration().ads.supportsMultipleMediaElements) {
pending('Platform without support for multiple media elements.');
}
player.configure('ads.supportsMultipleMediaElements', true);
adManager.setContainers(adContainer, adContainer);
await runAssetUriTest();
});
it('without support for multiple media elements', async () => {
player.configure('ads.supportsMultipleMediaElements', false);
adManager.setContainers(adContainer, adContainer);
await runAssetUriTest();
});
it('using the main media element', async () => {
await runAssetUriTest();
});
describe('with X-ASSET-LIST', () => {
/**
* @return {!Promise}
*/
async function runAssetListTest() {
// Investigate and fix.
if (deviceDetected.getDeviceName() === 'Tizen' &&
deviceDetected.getVersion() === 3) {
pending('Tizen 3 doesn\'t work with 2 ads in the same position.');
}
goog.asserts.assert(adManager, 'Must have adManager');
await player.load('/base/test/test/assets/hls-interstitial/list.m3u8');
video.play();
expect(player.isLive()).toBe(false);
// Wait a maximum of 10 seconds before the ad starts playing.
await waiter.timeoutAfter(10)
.waitForEvent(adManager, shaka.ads.Utils.AD_BREAK_STARTED);
await waiter.timeoutAfter(60)
.waitForEvent(adManager, shaka.ads.Utils.AD_BREAK_ENDED);
// Play for 2 seconds, but stop early if the video ends. If it takes
// longer than 10 seconds, fail the test.
await waiter.waitUntilPlayheadReachesOrFailOnTimeout(video, 2, 10);
const stats = adManager.getStats();
expect(stats.started).toBe(2);
expect(stats.playedCompletely).toBe(2);
await player.unload();
}
it('with support for multiple media elements', async () => {
if (!player.getConfiguration().ads.supportsMultipleMediaElements) {
pending('Platform without support for multiple media elements.');
}
player.configure('ads.supportsMultipleMediaElements', true);
adManager.setContainers(adContainer, adContainer);
await runAssetListTest();
});
it('without support for multiple media elements', async () => {
player.configure('ads.supportsMultipleMediaElements', false);
adManager.setContainers(adContainer, adContainer);
await runAssetListTest();
});
it('using the main media element', async () => {
await runAssetListTest();
});
});
});
describe('support MPD Alternate', () => {
/** @type {string} */
const streamUri = '/base/test/test/assets/dash-mpd-alternate/dash.mpd';
it('without support for multiple media elements', async () => {
player.configure('ads.supportsMultipleMediaElements', false);
adManager.setContainers(adContainer, adContainer);
await player.load(streamUri);
video.play();
expect(player.isLive()).toBe(false);
// Wait a maximum of 10 seconds before the ad starts playing.
await waiter.timeoutAfter(10)
.waitForEvent(adManager, shaka.ads.Utils.AD_STARTED);
await waiter.timeoutAfter(10)
.waitForEvent(adManager, shaka.ads.Utils.AD_FIRST_QUARTILE);
await waiter.timeoutAfter(10)
.waitForEvent(adManager, shaka.ads.Utils.AD_MIDPOINT);
await waiter.timeoutAfter(10)
.waitForEvent(adManager, shaka.ads.Utils.AD_THIRD_QUARTILE);
await waiter.timeoutAfter(20)
.waitForEvent(adManager, shaka.ads.Utils.AD_STOPPED);
// Play for 5 seconds, but stop early if the video ends. If it takes
// longer than 30 seconds, fail the test.
await waiter.waitUntilPlayheadReachesOrFailOnTimeout(video, 5, 30);
await player.unload();
});
});
describe('support SVTA2053-2', () => {
it('HLS', async () => {
/** @type {string} */
const streamUri = '/base/test/test/assets/hls-svta-2053-2/main.m3u8';
await player.load(streamUri);
video.play();
expect(player.isLive()).toBe(false);
goog.asserts.assert(adManager, 'adManager must be non-null');
// Wait a maximum of 10 seconds before the ad starts playing.
await waiter.timeoutAfter(10)
.waitForEvent(adManager, shaka.ads.Utils.AD_STARTED);
await waiter.timeoutAfter(10)
.waitForEvent(adManager, shaka.ads.Utils.AD_FIRST_QUARTILE);
await waiter.timeoutAfter(10)
.waitForEvent(adManager, shaka.ads.Utils.AD_MIDPOINT);
await waiter.timeoutAfter(10)
.waitForEvent(adManager, shaka.ads.Utils.AD_THIRD_QUARTILE);
await waiter.timeoutAfter(20)
.waitForEvent(adManager, shaka.ads.Utils.AD_COMPLETE);
// Play for 5 seconds, but stop early if the video ends. If it takes
// longer than 30 seconds, fail the test.
await waiter.waitUntilPlayheadReachesOrFailOnTimeout(video, 5, 30);
await player.unload();
});
it('DASH', async () => {
/** @type {string} */
const streamUri = '/base/test/test/assets/dash-svta-2053-2/dash.mpd';
await player.load(streamUri);
video.play();
expect(player.isLive()).toBe(false);
goog.asserts.assert(adManager, 'adManager must be non-null');
// Wait a maximum of 10 seconds before the ad starts playing.
await waiter.timeoutAfter(10)
.waitForEvent(adManager, shaka.ads.Utils.AD_STARTED);
await waiter.timeoutAfter(10)
.waitForEvent(adManager, shaka.ads.Utils.AD_FIRST_QUARTILE);
await waiter.timeoutAfter(10)
.waitForEvent(adManager, shaka.ads.Utils.AD_MIDPOINT);
await waiter.timeoutAfter(10)
.waitForEvent(adManager, shaka.ads.Utils.AD_THIRD_QUARTILE);
await waiter.timeoutAfter(20)
.waitForEvent(adManager, shaka.ads.Utils.AD_COMPLETE);
// Play for 5 seconds, but stop early if the video ends. If it takes
// longer than 30 seconds, fail the test.
await waiter.waitUntilPlayheadReachesOrFailOnTimeout(video, 5, 30);
await player.unload();
});
});
});