player-core-loader 4.0.3

package/README.md

@@ -0,0 +1,2 @@
+# player-core-loader
+Player Core Loader

package/constants.js

@@ -0,0 +1,78 @@
+
+function canLoad() {
+    try {
+        return typeof MediaSource !== 'undefined' && MediaSource.isTypeSupported('video/mp4; codecs="avc1.42E01E,mp4a.40.2"');
+    } catch (e) {
+        console.log(e);
+        return false;
+    }
+}
+
+/**
+ * The Spade errors
+ */
+var SPADE_ERRORS = {
+    NOT_SUPPORTED: {
+        spadeEventName: 'video_error',
+        spadeEventData: {
+            video_error_value: 3000,
+            video_error_message: 'Player Core Not Supported',
+            video_error_source: 'player-core-loader'
+        }
+    },
+    SCRIPT_ERROR: {
+        spadeEventName: 'video_error',
+        spadeEventData: {
+            video_error_value: 3001,
+            video_error_message: 'Script Error',
+            video_error_source: 'player-core-loader'
+        }
+    },
+    BAD_RESPONSE: {
+        spadeEventName: 'video_error',
+        spadeEventData: {
+            video_error_value: 3002,
+            video_error_message: 'Bad Response',
+            video_error_source: 'player-core-loader'
+        }
+    },
+    BAD_CONFIG: {
+        spadeEventName: 'video_error',
+        spadeEventData: {
+            video_error_value: 3003,
+            video_error_message: 'Bad Config',
+            video_error_source: 'player-core-loader'
+        }
+    },
+    FAILED_WORKER: {
+        spadeEventName: 'video_error',
+        spadeEventData: {
+            video_error_value: 3004,
+            video_error_message: 'Worker failed to load',
+            video_error_source: 'player-core-loader'
+        }
+    },
+};
+
+var protocol = ('https:' === document.location.protocol ? 'https:' : 'http:')
+
+module.exports = {
+    HOST: {
+        'test': protocol + '//cvp-test.twitch.tv/',
+        'beta': protocol + '//cvp-test.twitch.tv/',
+        'prod': protocol + '//cvp.twitch.tv/',
+        'dev': protocol + '//player-core-web.twitch.tv/'
+    },
+    CLIENT_PATH: 'mediaplayer.min.js',
+    ASMJS_WORKER_PATH: 'worker.min.js',
+    WASM_WORKER_PATH: 'wasmworker.min.js',
+    WASM_BINARY_PATH: 'wasmworker.min.wasm',
+    CLIENT_PATH_DEBUG: 'mediaplayer.js',
+    ASMJS_WORKER_PATH_DEBUG: 'worker.js',
+    WASM_WORKER_PATH_DEBUG: 'wasmworker.js',
+    WASM_BINARY_PATH_DEBUG: 'wasmworker.wasm',
+    SCRIPT_ID: 'TwitchMediaPlayerModule',
+    CAN_LOAD: canLoad(),
+    SPADE_ERRORS: SPADE_ERRORS,
+    DEFAULT_VERSION: '2.0.0',
+};

package/index.d.ts

@@ -0,0 +1,2 @@
+export function loadMediaPlayer(config: object, noInstance: boolean): Promise;
+export function canLoadMediaplayer(): boolean;

package/index.js

@@ -0,0 +1,189 @@
+var Constants = require('./constants');
+var SPADE_ERRORS = Constants.SPADE_ERRORS;
+
+/**
+ * Check if this browser supports PlayerCore 2.0
+ * @returns boolean
+ */
+module.exports.canLoadMediaplayer = function () {
+    return Constants.CAN_LOAD;
+};
+
+
+/**
+ * Load a PlayerCore module.
+ * All calls will return a promise to the same loaded module
+ * @param {object} config Configuration object
+ * @param {string} config.value   Force specific value
+ * @param {boolean} noInstance Boolean to notify loading worker only no instance
+ * @returns Promise to the loaded MediaPlayer module and instance
+ */
+var loadedMediaPlayer = null;
+module.exports.loadMediaPlayer = function (config, noInstance) {
+    if (!Constants.CAN_LOAD) {
+        return Promise.reject(SPADE_ERRORS.NOT_SUPPORTED);
+    }
+
+    if (!config || !config.value) {
+        return Promise.reject(SPADE_ERRORS.BAD_CONFIG);
+    }
+
+    var parsed = parseVersionString(config.value);
+    var useWasm = isWasmSupported() && !config.forceAsmJs;
+    var urlParams = parseUrlParams(document.URL);
+    var useCache = !config.disableCache;
+
+    if (!loadedMediaPlayer) {
+        loadedMediaPlayer = _loadMediaPlayer(parsed.version, urlParams, useWasm, useCache);
+    };
+
+    if (noInstance) { // Do not create instance
+        return loadedMediaPlayer;
+    }
+
+    var settings = urlParams['cvp-settings'] || parsed.settings;
+    var logLevel = config.logLevel || '';
+    var latencyValue = config.latencyValue || '';
+
+    return loadedMediaPlayer.then(function (loaded) {
+        return {
+            mediaPlayerHandle: loaded.client,
+            mediaPlayerInstance: new loaded.client.MediaPlayer({
+                settings: settings,
+                logLevel: logLevel,
+                latencyValue: latencyValue,
+            }, loaded.worker),
+            isWasm: useWasm,
+        };
+    });
+};
+
+/**
+ * Resets the last loaded player core
+ */
+module.exports._reset = function () {
+    loadedMediaPlayer = null;
+    var scriptTag = document.getElementById(Constants.SCRIPT_ID);
+    if (scriptTag) {
+        scriptTag.parentNode.removeChild(scriptTag);
+    }
+};
+
+function _loadMediaPlayer(version, urlParams, useWasm, useCache) {
+    var version = urlParams['cvp-branch'] || urlParams['cvp-ver'] || version;
+
+    var host;
+    if (urlParams['cvp-branch']) {
+        // Branches are only served in 'dev' environment
+        // Disable caching since content for a branch url can change
+        host = Constants.HOST['dev'];
+        useCache = false;
+    } else if (urlParams['cvp-env'] && Constants.HOST[urlParams['cvp-env']]) {
+        host = Constants.HOST[urlParams['cvp-env']];
+    } else {
+        host = Constants.HOST['prod'];
+    }
+
+    var clientPath, workerPath, wasmPath;
+    if (host === Constants.HOST['dev']) {
+        clientPath = Constants.CLIENT_PATH_DEBUG;
+        workerPath = useWasm ? Constants.WASM_WORKER_PATH_DEBUG : Constants.ASMJS_WORKER_PATH_DEBUG;
+        wasmPath  = Constants.WASM_BINARY_PATH_DEBUG;
+    } else {
+        clientPath = Constants.CLIENT_PATH;
+        workerPath = useWasm ? Constants.WASM_WORKER_PATH : Constants.ASMJS_WORKER_PATH;
+        wasmPath  = Constants.WASM_BINARY_PATH;
+    }
+
+    var baseUrl = host + version + '/';
+    var clientUrl = baseUrl + clientPath;
+    var workerUrl = baseUrl + workerPath;
+    var wasmUrl = baseUrl + wasmPath;
+    return loadMediaPlayerModule(clientUrl, workerUrl, wasmUrl, useCache);
+}
+
+/**
+ * Load the script tag
+ * @param {string} clientUrl: url to the client
+ * @param {string} workerUrl: url to the worker
+ * @param {string} wasmUrl: url to the wasm binary
+ * @param {boolean} useCache: Used cached wasm module if available
+ * @returns {object} Loaded client handle and worker
+ */
+function loadMediaPlayerModule(clientUrl, workerUrl, wasmUrl, useCache) {
+    return new Promise(function (resolve, reject) {
+        var existingTag = document.getElementById(Constants.SCRIPT_ID);
+        if (existingTag) {
+            if (
+                existingTag.src === clientUrl &&
+                typeof window.MediaPlayer === 'object' &&
+                typeof window.MediaPlayer.MediaPlayer === 'function'
+            ) {
+                resolve({
+                    client: window.MediaPlayer,
+                    worker: window.MediaPlayer.MediaPlayer.createWorker(workerUrl, wasmUrl, useCache),
+                });
+                return;
+            } else {
+                document.head.removeChild(existingTag);
+            }
+        }
+
+        var scriptTag = document.createElement('script');
+
+        scriptTag.onload = function () {
+            if (typeof window.MediaPlayer === 'object'
+                && typeof window.MediaPlayer.MediaPlayer === 'function') {
+                var client = window.MediaPlayer;
+                try {
+                    resolve({
+                        client: client,
+                        worker: client.MediaPlayer.createWorker(workerUrl, wasmUrl, useCache),
+                    });
+                } catch (e) {
+                    reject(SPADE_ERRORS.FAILED_WORKER)
+                }
+            } else {
+                reject(SPADE_ERRORS.BAD_RESPONSE);
+            }
+        };
+
+        scriptTag.onerror = function (e) {
+            reject(SPADE_ERRORS.SCRIPT_ERROR);
+        };
+
+        scriptTag.src = clientUrl; //last to guarantee handlers run
+        scriptTag.id = Constants.SCRIPT_ID;
+        document.head.appendChild(scriptTag);
+    });
+};
+
+function parseUrlParams(url) {
+    var params = {};
+    var breakPoint = url.indexOf('?');
+    if (breakPoint > -1) {
+        var paramStr = url.slice(breakPoint + 1) || '';
+        var paramItems = paramStr.split('&') || [];
+
+        paramItems.forEach(function (item) {
+            var split = item.split('=') || [];
+            params[split[0]] = split[1];
+        });
+    }
+    return params;
+}
+
+function parseVersionString(versionString) {
+    var parsed = versionString.match(/([^+]+)(?:\+([^+]+))?/);
+    return {
+        version: parsed[1] || Constants.DEFAULT_VERSION,
+        settings: parsed[2] || '',
+    };
+}
+
+function isWasmSupported() {
+    return (
+        typeof WebAssembly === 'object' &&
+        typeof WebAssembly.instantiate === 'function'
+    );
+}

package/jenkins.groovy

@@ -0,0 +1,26 @@
+job {
+        name "video-player-core-loader-status"
+        using 'TEMPLATE-autobuild'
+        
+        wrappers {
+            credentialsBinding {
+                file('COURIERD_PRIVATE_KEY', 'courierd')
+                file('AWS_CONFIG_FILE', 'aws_config')
+                string 'AWS_ACCESS_KEY', 'video-aws-access-key'
+                string 'AWS_SECRET_KEY', 'video-aws-secret-key'
+            }
+        }
+        scm {
+            git {
+                    remote {
+                                github 'video/player-core-loader', 'ssh', 'git-aws.internal.justin.tv'
+                                credentials 'git-aws-read-key'
+                            }
+                            clean true
+                }
+            }
+        steps {
+            // run tests
+            shell 'manta -v -proxy -f manta-test.json'
+        }
+}

package/manta-test.json

@@ -0,0 +1,11 @@
+{
+    "image": "node:latest",
+    "mount": "/manta-build/",
+    "setup": [
+              "apt-get update && apt-get install -y xvfb"
+              ],
+    "build": [
+              "npm install",
+              "node test_runner.js"
+              ]
+}

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "player-core-loader",
+  "version": "4.0.3",
+  "description": "Loader for player-core",
+  "main": "index.js",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org"
+  },
+  "scripts": {
+    "test": "browserify tests/*.js | tape-run --render=\"tap-spec\"",
+    "test-runner": "node test_runner.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git@git-aws.internal.justin.tv:video/player-core-loader.git"
+  },
+  "keywords": [
+    "player-core",
+    "loader",
+    "MediaPlayer"
+  ],
+  "author": "Team Player Core",
+  "license": "UNLICENSED",
+  "dependencies": {},
+  "devDependencies": {
+    "browserify": "^13.1.0",
+    "glob": "^7.1.0",
+    "tap-spec": "^4.1.1",
+    "tape": "^4.6.0",
+    "tape-run": "^2.1.4"
+  }
+}

package/test_runner.js

@@ -0,0 +1,22 @@
+var glob = require('glob');
+var runner = require('tape-run');
+var browserify = require('browserify');
+var tapSpec = require('tap-spec');
+var config = {
+   // browser: 'chrome',
+   // port: 6788
+};
+
+var testFiles;
+if (process.argv.length > 2) {
+    testFiles = process.argv[2];
+} else {
+    testFiles = __dirname + '/tests/*.js';
+}
+var results = glob.sync(testFiles);
+
+var testResults = browserify(results)
+.bundle()
+.pipe(runner(config))
+.pipe(tapSpec())
+.pipe(process.stdout);

package/tests/player-core-loader-test.js

@@ -0,0 +1,185 @@
+WebAssembly = {
+    instantiate: function() {}
+}; // node may not have WebAssembly. So adding mock here
+
+var test = require('tape');
+var Constants = require('../constants');
+var Promise = require('es6-promise');
+var PlayerCoreLoader = require('../index.js');
+
+var TEST_VERSION = '2.5.6';
+
+test('test if loader returns a MediaPlayer handle and the instance', function (t) {
+    t.plan(7);
+    PlayerCoreLoader.loadMediaPlayer({value: TEST_VERSION})
+    .then(function (result) {
+        t.ok(result, 'result should be non null');
+        t.ok(result.isWasm, 'MediaPlayer did not default to wasm');
+        t.equal(typeof result.mediaPlayerHandle, 'object', 'The handle is an object');
+        t.equal(typeof result.mediaPlayerHandle.MediaPlayer, 'function', 'MediaPlayer is a function constructor');
+        t.ok(result.mediaPlayerInstance, 'An instance mediaplayer object should be present');
+
+        var mediaplayerTag = document.getElementById(Constants.SCRIPT_ID);
+        t.ok(mediaplayerTag, 'mediaplayer script tag is non null');
+        t.equal(mediaplayerTag.tagName.toLowerCase(), 'script', 'script tag should be present');
+    })
+    .catch(function (err) {
+        t.fail('MediaPlayer failed to load:',  err);
+    }).then(function () {
+        t.end();
+        PlayerCoreLoader._reset();
+    });
+});
+
+test('test loading an AsmJs MediaPlayer', function (t) {
+    t.plan(7);
+    PlayerCoreLoader.loadMediaPlayer({value: TEST_VERSION, forceAsmJs: true})
+    .then(function (result) {
+        t.ok(result, 'result should be non null');
+        t.ok(!result.isWasm, "Didn't force loading ASM JS version");
+        t.equal(typeof result.mediaPlayerHandle, 'object', 'The handle is an object');
+        t.equal(typeof result.mediaPlayerHandle.MediaPlayer, 'function', 'MediaPlayer is a function constructor');
+        t.ok(result.mediaPlayerInstance, 'An instance mediaplayer object should be present');
+
+        var mediaplayerTag = document.getElementById(Constants.SCRIPT_ID);
+        t.ok(mediaplayerTag, 'mediaplayer script tag is non null');
+        t.equal(mediaplayerTag.tagName.toLowerCase(), 'script', 'script tag should be present');
+    })
+    .catch(function (err) {
+        t.fail('MediaPlayer failed to load:',  err);
+    }).then(function () {
+        t.end();
+        PlayerCoreLoader._reset();
+    });
+});
+
+test('Multiple calls to loadMediaPlayer return the same worker', function (t) {
+    t.plan(4);
+
+    var c1 = PlayerCoreLoader.loadMediaPlayer({value: TEST_VERSION});
+    var c2 = PlayerCoreLoader.loadMediaPlayer({value: TEST_VERSION});
+
+    // test 2 simultaneous loads
+    Promise.all([c1, c2]).then(function (cores) {
+        var core1 = cores[0],
+            core2 = cores[1];
+
+        t.notEqual(core1.mediaPlayerInstance, core2.mediaPlayerInstance, 'The mediaplayer instance should not be equal');
+        t.deepEqual(core1.mediaPlayerInstance._worker, core2.mediaPlayerInstance._worker, "Multiple calls to load() don't return the same worker");
+        PlayerCoreLoader._reset();
+    })
+    // test 2 sequential loads
+    .then(function () {
+        return PlayerCoreLoader.loadMediaPlayer({value: TEST_VERSION}).then(function (core1) {
+            return PlayerCoreLoader.loadMediaPlayer({value: TEST_VERSION}).then(function (core2) {
+                t.notEqual(core1.mediaPlayerInstance, core2.mediaPlayerInstance, 'The mediaplayer instance should not be equal');
+                t.deepEqual(core1.mediaPlayerInstance._worker, core2.mediaPlayerInstance._worker, "Sequential calls to load() don't return the same same worker");
+            });
+        });
+    })
+    .catch(function (e) {
+        t.fail('Player core failed to loadMediaPlayer:', e);
+    }).then(function (err) {
+        t.end();
+        PlayerCoreLoader._reset();
+    });
+});
+
+test('Use the config to try loading a nonexistant MediaPlayer version', function (t) {
+    var config = {value: 'blah'};
+    PlayerCoreLoader.loadMediaPlayer(config)
+    .then(function (result) {
+        t.fail('blah version loaded? Something is wrong');
+    })
+    .catch(function (err) {
+        t.equal(err.spadeEventName, 'video_error', 'Spade event name should be equal');
+        t.ok(err.spadeEventData, 'Spade event data should be non null');
+        var data = err.spadeEventData;
+        t.ok(data.video_error_value, 3001, 'Error code should be 3001');
+        t.ok(data.video_error_message, 'Script Error', 'error msg should be Script Error');
+        t.ok(data.video_error_source, 'player-core-loader', 'Source player core loader');
+        t.pass('There is no version called blah');
+    })
+    .then(function () {
+        t.end();
+        PlayerCoreLoader._reset();
+    });
+});
+
+test('Use the config to try loading a particular MediaPlayer version', function (t) {
+    var config = {value: TEST_VERSION};
+    PlayerCoreLoader.loadMediaPlayer(config)
+    .then(function (result) {
+        t.ok(result, 'result should be non null');
+        t.equal(typeof result.mediaPlayerHandle, 'object', 'The handle is an object');
+        t.equal(typeof result.mediaPlayerHandle.MediaPlayer, 'function', 'MediaPlayer is a function constructor');
+        t.ok(result.mediaPlayerInstance, 'An instance mediaplayer object should be present');
+
+        var mediaPlayerScriptTag = document.getElementById(Constants.SCRIPT_ID);
+        t.ok(mediaPlayerScriptTag, 'mediaPlayer script tag is non null');
+        t.equal(mediaPlayerScriptTag.tagName.toLowerCase(), 'script', 'script tag should be present');
+        t.equal(mediaPlayerScriptTag.src, `http://cvp.twitch.tv/${TEST_VERSION}/mediaplayer.min.js`, 'script src should be correct');
+    })
+    .catch(function () {
+        t.fail('Problem loading version 1.0');
+    })
+    .then(function () {
+        t.end();
+        PlayerCoreLoader._reset();
+    });
+});
+
+test('Use the config to try loading a particular version+settings of MediaPlayer', function (t) {
+    var config = {value: `${TEST_VERSION}+abc`};
+    PlayerCoreLoader.loadMediaPlayer(config)
+    .then(function (result) {
+        t.ok(result, 'result should be non null');
+        t.equal(typeof result.mediaPlayerHandle, 'object', 'The handle is an object');
+        t.equal(typeof result.mediaPlayerHandle.MediaPlayer, 'function', 'MediaPlayer is a function constructor');
+        t.ok(result.mediaPlayerInstance, 'An instance mediaplayer object should be present');
+
+        var mediaPlayerScriptTag = document.getElementById(Constants.SCRIPT_ID);
+        t.ok(mediaPlayerScriptTag, 'mediaplayer script tag is non null');
+        t.equal(mediaPlayerScriptTag.tagName.toLowerCase(), 'script', 'script tag should be present');
+        t.equal(mediaPlayerScriptTag.src, `http://cvp.twitch.tv/${TEST_VERSION}/mediaplayer.min.js`, 'script src should be correct');
+    })
+    .catch(function () {
+        t.fail(`Problem loading the version ${TEST_VERSION}`);
+    })
+    .then(function () {
+        t.end();
+        PlayerCoreLoader._reset();
+    });
+});
+
+test('Test for bad config error while calling loadMediaPlayer', function(t) {
+    var config = {};
+    PlayerCoreLoader.loadMediaPlayer(config)
+    .then(function (result) {
+        t.fail('Loading of Mediaplayer should not succeed')
+    })
+    .catch(function (err) {
+        t.ok(err.spadeEventData.video_error_value, 3003, 'The expected error code is 3003');
+        t.pass('Expected error on loading with an empty');
+    })
+    .then(function() {
+        t.end();
+    })
+    PlayerCoreLoader._reset();
+});
+
+test('Test for worker only load', function(t) {
+    var config = {
+        value: TEST_VERSION
+    };
+    PlayerCoreLoader.loadMediaPlayer(config, true)
+    .then(function (result) {
+        t.ok(result.worker instanceof Worker, 'No instance only worker');
+    })
+    .catch(function() {
+        t.fail('Worker only loading failed');
+    })
+    .then(function() {
+        t.end();
+    })
+});