web/video.js
1
0
Fork 0
mirror of https://github.com/videojs/video.js.git synced 2025-02-02 11:34:50 +02:00
Code Releases Activity

revert: revert #7067 so we throw an error for invalid event types (#7719)

Browse Source 
BREAKING CHANGE: Instead of logging an error message, invalid events will now trigger an `Error` which will terminate the call stack.
This commit is contained in:
Alex Barstow 2022-05-16 17:27:23 -04:00 committed by Pat O'Neill
parent c190b21de7
commit f99ace0fba
2 changed files with 12 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
src/js/mixins/evented.js
View File

@ -9,7 +9,6 @@ import * as Fn from '../utils/fn';
import * as Obj from '../utils/obj'; import * as Obj from '../utils/obj';
import EventTarget from '../event-target'; import EventTarget from '../event-target';
import DomData from '../utils/dom-data'; import DomData from '../utils/dom-data';
import log from '../utils/log';
const objName = (obj) => { const objName = (obj) => {
if (typeof obj.name === 'function') { if (typeof obj.name === 'function') {
@ -446,14 +445,8 @@ const EventedMixin = {
const type = event && typeof event !== 'string' ? event.type : event; const type = event && typeof event !== 'string' ? event.type : event;
if (!isValidEventType(type)) { if (!isValidEventType(type)) {
const error = `Invalid event type for ${objName(this)}#trigger; ` + throw new Error(`Invalid event type for ${objName(this)}#trigger; ` +
'must be a non-empty string or object with a type key that has a non-empty value.'; 'must be a non-empty string or object with a type key that has a non-empty value.');
if (event) {
(this.log || log).error(error);
} else {
throw new Error(error);
}
} }
return Events.trigger(this.eventBusEl_, event, hash); return Events.trigger(this.eventBusEl_, event, hash);
} }

41
test/unit/mixins/evented.test.js
View File

@ -1,7 +1,6 @@
/* eslint-env qunit */ /* eslint-env qunit */
import sinon from 'sinon'; import sinon from 'sinon';
import evented from '../../../src/js/mixins/evented'; import evented from '../../../src/js/mixins/evented';
import log from '../../../src/js/utils/log';
import DomData from '../../../src/js/utils/dom-data'; import DomData from '../../../src/js/utils/dom-data';
import * as Dom from '../../../src/js/utils/dom'; import * as Dom from '../../../src/js/utils/dom';
import * as Obj from '../../../src/js/utils/obj'; import * as Obj from '../../../src/js/utils/obj';
@ -67,46 +66,26 @@ QUnit.test('evented() with custom element', function(assert) {
QUnit.test('trigger() errors', function(assert) { QUnit.test('trigger() errors', function(assert) {
class Test {} class Test {}
const targeta = evented({});
const tester = new Test();
const targeta = evented(tester);
const targetb = evented(new Test()); const targetb = evented(new Test());
const targetc = evented(new Test()); const targetc = evented(new Test());
const targetd = evented({});
tester.log = log.createLogger('tester');
sinon.stub(log, 'error');
sinon.stub(tester.log, 'error');
targetc.name_ = 'foo'; targetc.name_ = 'foo';
const createTest = (lg) => (target) => { [targeta, targetb, targetc].forEach((target) => {
const objName = target.name_ || target.constructor.name || typeof target; const objName = target.name_ || target.constructor.name || typeof target;
const triggerError = errors.trigger(objName);
assert.throws(() => target.trigger(), /^Error: Invalid event type/, 'threw an error when tried to trigger without an event'); assert.throws(() => target.trigger(), triggerError, 'expected error');
assert.throws(() => target.trigger(' '), triggerError, 'expected error');
target.trigger(' '); assert.throws(() => target.trigger({}), triggerError, 'expected error');
target.trigger({}); assert.throws(() => target.trigger({type: ''}), triggerError, 'expected error');
target.trigger({type: ''}); assert.throws(() => target.trigger({type: ' '}), triggerError, 'expected error');
target.trigger({type: ' '});
assert.ok(lg.error.called, 'error was called');
assert.equal(lg.error.callCount, 4, 'log.error called 4 times');
assert.ok(lg.error.calledWithMatch(new RegExp(`^Invalid event type for ${objName}#trigger`)), 'error called with expected message');
delete target.eventBusEl_; delete target.eventBusEl_;
assert.throws(() => target.trigger({type: 'foo'}), new RegExp(`^Error: Invalid target for ${objName}#trigger`), 'expected error'); assert.throws(() => target.trigger({type: 'foo'}), errors.target(objName, 'trigger'), 'expected error');
});
lg.error.reset();
};
createTest(targeta.log)(targeta);
[targetb, targetc, targetd].forEach(createTest(log));
targeta.log.error.restore();
log.error.restore();
}); });
QUnit.test('on(), one(), and any() errors', function(assert) { QUnit.test('on(), one(), and any() errors', function(assert) {