Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix extra warn logs on already initialized player references #3888

Merged
merged 3 commits into from
Dec 23, 2016
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/js/video.js
Original file line number Diff line number Diff line change
Expand Up @@ -65,8 +65,6 @@ if (typeof HTMLVideoElement === 'undefined' &&
function videojs(id, options, ready) {
let tag;

options = options || {};

// Allow for element or ID to be passed in
// String ID
if (typeof id === 'string') {
Expand Down Expand Up @@ -111,6 +109,8 @@ function videojs(id, options, ready) {
return tag.player || Player.players[tag.playerId];
}

options = options || {};

videojs.hooks('beforesetup').forEach(function(hookFunction) {
const opts = hookFunction(tag, mergeOptions(options));

Expand Down
37 changes: 37 additions & 0 deletions test/unit/video.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
import videojs from '../../src/js/video.js';
import TestHelpers from './test-helpers.js';
import * as Dom from '../../src/js/utils/dom.js';
import log from '../../src/js/utils/log.js';
import document from 'global/document';

QUnit.module('video.js');
Expand Down Expand Up @@ -45,6 +46,42 @@ QUnit.test('should return a video player instance', function(assert) {
player2.dispose();
});

QUnit.test('should log about already initalized players if options already passed',
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we'd ultimately want this test to use sinon.spy(log, 'warn') instead and to use the TestHelpers.makePlayer() function to create a mock player, but I don't think it should stop the PR from going in since there is time-sensitivity here.

function(assert) {
const origWarnLog = log.warn;
const fixture = document.getElementById('qunit-fixture');
const warnLogs = [];

log.warn = (args) => {
warnLogs.push(args);
};

fixture.innerHTML += '<video id="test_vid_id"></video>';

const player = videojs('test_vid_id', { techOrder: ['techFaker'] });

assert.ok(player, 'created player from tag');
assert.ok(player.id() === 'test_vid_id');
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

assert.equal instead and don't forget a message.

assert.ok(!warnLogs.length, 'no warn logs');
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe better to do an equals check with with length and 0?


const playerAgain = videojs('test_vid_id');

assert.ok(player === playerAgain, 'did not create a second player from same tag');
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

assert.equal would be preferred over ok and ===

assert.ok(!warnLogs.length, 'no warn logs');

const playerAgainWithOptions = videojs('test_vid_id', { techOrder: ['techFaker'] });

assert.ok(player === playerAgainWithOptions,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

again assert.equal.

'did not create a second player from same tag');
assert.equal(warnLogs.length, 1, 'logged a warning');
assert.equal(warnLogs[0],
'Player "test_vid_id" is already initialised. ' +
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you can keep this string on one line (for now)

'Options will not be applied.',
'logged the right message');

log.warn = origWarnLog;
});
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

player needs to be disposed.


QUnit.test('should return a video player instance from el html5 tech', function(assert) {
const fixture = document.getElementById('qunit-fixture');

Expand Down