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

Conversation

gesinger
Copy link
Contributor

@gesinger gesinger commented Dec 23, 2016

Description

Extra warnings were being logged when getting a reference to a player via videojs('player_id').

Requirements Checklist

  • Feature implemented / Bug fixed
  • If necessary, more likely in a feature request than a bug fix
    • Change has been verified in an actual browser (Chome, Firefox, IE)
    • Unit Tests updated or fixed
    • Docs/guides updated
    • Example created (starter template on JSBin)
  • Reviewed by Two Core Contributors

Copy link
Member

@gkatsev gkatsev left a comment

Choose a reason for hiding this comment

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

Thanks! Totally didn't realize this caused issues.

Also, I have some comments about the test :D

'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.


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 ===


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)


assert.ok(player, 'created player from tag');
assert.ok(player.id() === 'test_vid_id');
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 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.

@gesinger
Copy link
Contributor Author

Updated. Thanks for the review @gkatsev !

@@ -45,6 +46,44 @@ 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.

@gkatsev gkatsev merged commit b7c384e into videojs:master Dec 23, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants