-
Notifications
You must be signed in to change notification settings - Fork 7.5k
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
Fix extra warn logs on already initialized player references #3888
Conversation
There was a problem hiding this 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; | ||
}); |
There was a problem hiding this comment.
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'); |
There was a problem hiding this comment.
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, |
There was a problem hiding this comment.
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. ' + |
There was a problem hiding this comment.
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'); |
There was a problem hiding this comment.
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'); |
There was a problem hiding this comment.
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.
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', |
There was a problem hiding this comment.
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.
Description
Extra warnings were being logged when getting a reference to a player via videojs('player_id').
Requirements Checklist