| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353 |
- /**
- * @license Copyright (c) 2003-2020, CKSource - Frederico Knabben. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
- import { default as EmitterMixin, _getEmitterListenedTo, _getEmitterId, _setEmitterId } from '../src/emittermixin';
- import EventInfo from '../src/eventinfo';
- import { expectToThrowCKEditorError } from './_utils/utils';
- import CKEditorError from '../src/ckeditorerror';
- describe( 'EmitterMixin', () => {
- let emitter, listener;
- beforeEach( () => {
- emitter = getEmitterInstance();
- listener = getEmitterInstance();
- } );
- describe( 'fire', () => {
- it( 'should execute callbacks in the right order without priority', () => {
- const spy1 = sinon.spy().named( 1 );
- const spy2 = sinon.spy().named( 2 );
- const spy3 = sinon.spy().named( 3 );
- emitter.on( 'test', spy1 );
- emitter.on( 'test', spy2 );
- emitter.on( 'test', spy3 );
- emitter.fire( 'test' );
- sinon.assert.callOrder( spy1, spy2, spy3 );
- } );
- it( 'should execute callbacks in the right order with priority defined', () => {
- const spy1 = sinon.spy().named( 1 );
- const spy2 = sinon.spy().named( 2 );
- const spy3 = sinon.spy().named( 3 );
- const spy4 = sinon.spy().named( 4 );
- const spy5 = sinon.spy().named( 5 );
- emitter.on( 'test', spy2, { priority: 'high' } );
- emitter.on( 'test', spy3 ); // Defaults to 'normal'.
- emitter.on( 'test', spy4, { priority: 'low' } );
- emitter.on( 'test', spy1, { priority: 'highest' } );
- emitter.on( 'test', spy5, { priority: 'lowest' } );
- emitter.fire( 'test' );
- sinon.assert.callOrder( spy1, spy2, spy3, spy4, spy5 );
- } );
- it( 'should pass arguments to callbacks', () => {
- const spy1 = sinon.spy();
- const spy2 = sinon.spy();
- emitter.on( 'test', spy1 );
- emitter.on( 'test', spy2 );
- emitter.fire( 'test', 1, 'b', true );
- sinon.assert.calledWithExactly( spy1, sinon.match.instanceOf( EventInfo ), 1, 'b', true );
- sinon.assert.calledWithExactly( spy2, sinon.match.instanceOf( EventInfo ), 1, 'b', true );
- } );
- it( 'should fire the right event', () => {
- const spy1 = sinon.spy();
- const spy2 = sinon.spy();
- emitter.on( '1', spy1 );
- emitter.on( '2', spy2 );
- emitter.fire( '2' );
- sinon.assert.notCalled( spy1 );
- sinon.assert.called( spy2 );
- } );
- it( 'should execute callbacks many times', () => {
- const spy = sinon.spy();
- emitter.on( 'test', spy );
- emitter.fire( 'test' );
- emitter.fire( 'test' );
- emitter.fire( 'test' );
- sinon.assert.calledThrice( spy );
- } );
- it( 'should do nothing for a non listened event', () => {
- emitter.fire( 'test' );
- } );
- it( 'should accept the same callback many times', () => {
- const spy = sinon.spy();
- emitter.on( 'test', spy );
- emitter.on( 'test', spy );
- emitter.on( 'test', spy );
- emitter.fire( 'test' );
- sinon.assert.calledThrice( spy );
- } );
- it( 'should not fire callbacks for an event that were added while firing that event', () => {
- const spy = sinon.spy();
- emitter.on( 'test', () => {
- emitter.on( 'test', spy );
- } );
- emitter.fire( 'test' );
- sinon.assert.notCalled( spy );
- } );
- it( 'should correctly fire callbacks for namespaced events', () => {
- const spyFoo = sinon.spy();
- const spyBar = sinon.spy();
- const spyAbc = sinon.spy();
- const spyFoo2 = sinon.spy();
- // Mess up with callbacks order to check whether they are called in adding order.
- emitter.on( 'foo', spyFoo );
- emitter.on( 'foo:bar:abc', spyAbc );
- emitter.on( 'foo:bar', spyBar );
- // This tests whether generic callbacks are also added to specific callbacks lists.
- emitter.on( 'foo', spyFoo2 );
- // All four callbacks should be fired.
- emitter.fire( 'foo:bar:abc' );
- sinon.assert.callOrder( spyFoo, spyAbc, spyBar, spyFoo2 );
- sinon.assert.calledOnce( spyFoo );
- sinon.assert.calledOnce( spyAbc );
- sinon.assert.calledOnce( spyBar );
- sinon.assert.calledOnce( spyFoo2 );
- // Only callbacks for foo and foo:bar event should be called.
- emitter.fire( 'foo:bar' );
- sinon.assert.calledOnce( spyAbc );
- sinon.assert.calledTwice( spyFoo );
- sinon.assert.calledTwice( spyBar );
- sinon.assert.calledTwice( spyFoo2 );
- // Only callback for foo should be called as foo:abc has not been registered.
- // Still, foo is a valid, existing namespace.
- emitter.fire( 'foo:abc' );
- sinon.assert.calledOnce( spyAbc );
- sinon.assert.calledTwice( spyBar );
- sinon.assert.calledThrice( spyFoo );
- sinon.assert.calledThrice( spyFoo2 );
- } );
- it( 'should rethrow the CKEditorError error', () => {
- emitter.on( 'test', () => {
- // eslint-disable-next-line ckeditor5-rules/ckeditor-error-message
- throw new CKEditorError( 'foo', null );
- } );
- expectToThrowCKEditorError( () => {
- emitter.fire( 'test' );
- }, /foo/, null );
- } );
- it( 'should rethrow the native errors as they are in the dubug=true mode', () => {
- const error = new TypeError( 'foo' );
- emitter.on( 'test', () => {
- throw error;
- } );
- expect( () => {
- emitter.fire( 'test' );
- } ).to.throw( TypeError, /foo/ );
- } );
- describe( 'return value', () => {
- it( 'is undefined by default', () => {
- expect( emitter.fire( 'foo' ) ).to.be.undefined;
- } );
- it( 'is undefined if none of the listeners modified EventInfo#return', () => {
- emitter.on( 'foo', () => {} );
- expect( emitter.fire( 'foo' ) ).to.be.undefined;
- } );
- it( 'equals EventInfo#return\'s value', () => {
- emitter.on( 'foo', evt => {
- evt.return = 1;
- } );
- expect( emitter.fire( 'foo' ) ).to.equal( 1 );
- } );
- it( 'equals EventInfo#return\'s value even if the event was stopped', () => {
- emitter.on( 'foo', evt => {
- evt.return = 1;
- } );
- emitter.on( 'foo', evt => {
- evt.stop();
- } );
- expect( emitter.fire( 'foo' ) ).to.equal( 1 );
- } );
- it( 'equals EventInfo#return\'s value when it was set in a namespaced event', () => {
- emitter.on( 'foo', evt => {
- evt.return = 1;
- } );
- expect( emitter.fire( 'foo:bar' ) ).to.equal( 1 );
- } );
- // Rationale – delegation keeps the listeners of the two objects separate.
- // E.g. the emitterB's listeners will always be executed before emitterA's ones.
- // Hence, values should not be shared either.
- it( 'is not affected by listeners executed on emitter to which the event was delegated', () => {
- const emitterA = getEmitterInstance();
- const emitterB = getEmitterInstance();
- emitterB.delegate( 'foo' ).to( emitterA );
- emitterA.on( 'foo', evt => {
- evt.return = 1;
- } );
- expect( emitterB.fire( 'foo' ) ).to.be.undefined;
- } );
- it( 'equals the value set by the last callback', () => {
- emitter.on( 'foo', evt => {
- evt.return = 1;
- } );
- emitter.on( 'foo', evt => {
- evt.return = 2;
- }, { priority: 'high' } );
- expect( emitter.fire( 'foo' ) ).to.equal( 1 );
- } );
- } );
- } );
- describe( 'on', () => {
- it( 'should stop()', () => {
- const spy1 = sinon.spy();
- const spy2 = sinon.spy();
- const spy3 = sinon.spy( event => {
- event.stop();
- } );
- emitter.on( 'test', spy1 );
- emitter.on( 'test', spy2 );
- emitter.on( 'test', spy3 );
- emitter.on( 'test', sinon.stub().throws() );
- emitter.on( 'test', sinon.stub().throws() );
- emitter.fire( 'test' );
- sinon.assert.called( spy1 );
- sinon.assert.called( spy2 );
- sinon.assert.called( spy3 );
- } );
- it( 'should take a callback off()', () => {
- const spy1 = sinon.spy();
- const spy2 = sinon.spy( event => {
- event.off();
- } );
- const spy3 = sinon.spy();
- emitter.on( 'test', spy1 );
- emitter.on( 'test', spy2 );
- emitter.on( 'test', spy3 );
- emitter.fire( 'test' );
- emitter.fire( 'test' );
- sinon.assert.calledTwice( spy1 );
- sinon.assert.calledOnce( spy2 );
- sinon.assert.calledTwice( spy3 );
- } );
- it( 'should take the callback off() even after stop()', () => {
- const spy1 = sinon.spy( event => {
- event.stop();
- event.off();
- } );
- const spy2 = sinon.spy();
- emitter.on( 'test', spy1 );
- emitter.on( 'test', spy2 );
- emitter.fire( 'test' );
- emitter.fire( 'test' );
- sinon.assert.calledOnce( spy1 );
- sinon.assert.calledOnce( spy2 );
- } );
- } );
- describe( 'once', () => {
- it( 'should be called just once for general event', () => {
- const spy1 = sinon.spy();
- const spy2 = sinon.spy();
- const spy3 = sinon.spy();
- emitter.on( 'test', spy1 );
- emitter.once( 'test', spy2 );
- emitter.on( 'test', spy3 );
- emitter.fire( 'test' );
- emitter.fire( 'test' );
- sinon.assert.calledTwice( spy1 );
- sinon.assert.calledOnce( spy2 );
- sinon.assert.calledTwice( spy3 );
- } );
- it( 'should be called just once for namespaced event', () => {
- const spy1 = sinon.spy();
- const spy2 = sinon.spy();
- const spy3 = sinon.spy();
- emitter.on( 'foo:bar', spy1 );
- emitter.once( 'foo:bar', spy2 );
- emitter.on( 'foo:bar', spy3 );
- emitter.fire( 'foo:bar' );
- emitter.fire( 'foo:bar' );
- sinon.assert.calledTwice( spy1 );
- sinon.assert.calledOnce( spy2 );
- sinon.assert.calledTwice( spy3 );
- } );
- it( 'should have proper arguments', () => {
- const spy = sinon.spy();
- emitter.once( 'test', spy );
- emitter.fire( 'test', 1, 2, 3 );
- sinon.assert.calledWithExactly( spy, sinon.match.instanceOf( EventInfo ), 1, 2, 3 );
- } );
- it( 'should be removed also when fired through namespaced event', () => {
- const spy = sinon.spy();
- emitter.once( 'foo', spy );
- emitter.fire( 'foo:bar' );
- emitter.fire( 'foo' );
- sinon.assert.calledOnce( spy );
- } );
- it( 'should be called only once and have infinite loop protection', () => {
- const spy = sinon.spy();
- emitter.once( 'foo', () => {
- spy();
- emitter.fire( 'foo' );
- } );
- emitter.fire( 'foo' );
- sinon.assert.calledOnce( spy );
- } );
- } );
- describe( 'off', () => {
- it( 'should get callbacks off()', () => {
- const spy1 = sinon.spy();
- const spy2 = sinon.spy();
- const spy3 = sinon.spy();
- emitter.on( 'test', spy1 );
- emitter.on( 'test', spy2 );
- emitter.on( 'test', spy3 );
- emitter.fire( 'test' );
- emitter.off( 'test', spy2 );
- emitter.fire( 'test' );
- emitter.fire( 'test' );
- sinon.assert.calledThrice( spy1 );
- sinon.assert.calledOnce( spy2 );
- sinon.assert.calledThrice( spy3 );
- } );
- it( 'should remove all callbacks for event', () => {
- const spy1 = sinon.spy();
- const spy2 = sinon.spy();
- emitter.on( 'test', spy1 );
- emitter.on( 'test', spy2 );
- emitter.fire( 'test' );
- emitter.off( 'test' );
- emitter.fire( 'test' );
- emitter.fire( 'test' );
- sinon.assert.calledOnce( spy1 );
- sinon.assert.calledOnce( spy2 );
- } );
- it( 'should not fail with unknown events', () => {
- emitter.off( 'foo', () => {} );
- emitter.off( 'foo:bar', () => {} );
- emitter.off( 'foo' );
- emitter.off( 'foo:bar' );
- } );
- it( 'should remove all entries for the same callback', () => {
- const spy1 = sinon.spy().named( 1 );
- const spy2 = sinon.spy().named( 2 );
- emitter.on( 'test', spy1 );
- emitter.on( 'test', spy2 );
- emitter.on( 'test', spy1 );
- emitter.on( 'test', spy2 );
- emitter.fire( 'test' );
- emitter.off( 'test', spy1 );
- emitter.fire( 'test' );
- sinon.assert.callCount( spy1, 2 );
- sinon.assert.callCount( spy2, 4 );
- } );
- it( 'should not remove all namespaced entries when removing namespace inner group', () => {
- const spy1 = sinon.spy().named( 'foo' );
- const spy2 = sinon.spy().named( 'foo:bar' );
- const spy3 = sinon.spy().named( 'foo:bar:baz' );
- const spy4 = sinon.spy().named( 'foo:bar:baz:abc' );
- emitter.on( 'foo', spy1 );
- emitter.on( 'foo:bar', spy2 );
- emitter.on( 'foo:bar:baz', spy3 );
- emitter.on( 'foo:bar:baz:abc', spy4 );
- emitter.fire( 'foo:bar:baz:abc' );
- sinon.assert.calledOnce( spy1 );
- sinon.assert.calledOnce( spy2 );
- sinon.assert.calledOnce( spy3 );
- sinon.assert.calledOnce( spy4 );
- emitter.off( 'foo:bar' );
- emitter.fire( 'foo:bar:baz:abc' );
- sinon.assert.calledTwice( spy1 );
- sinon.assert.calledOnce( spy2 );
- sinon.assert.calledTwice( spy3 );
- sinon.assert.calledTwice( spy4 );
- } );
- it( 'should properly remove callbacks for namespaced events', () => {
- const spyFoo = sinon.spy();
- const spyAbc = sinon.spy();
- const spyBar = sinon.spy();
- const spyFoo2 = sinon.spy();
- emitter.on( 'foo', spyFoo );
- emitter.on( 'foo:bar:abc', spyAbc );
- emitter.on( 'foo:bar', spyBar );
- emitter.on( 'foo', spyFoo2 );
- emitter.off( 'foo', spyFoo );
- emitter.fire( 'foo:bar:abc' );
- sinon.assert.calledOnce( spyAbc );
- sinon.assert.calledOnce( spyBar );
- sinon.assert.calledOnce( spyFoo2 );
- sinon.assert.notCalled( spyFoo );
- emitter.fire( 'foo:bar' );
- sinon.assert.notCalled( spyFoo );
- sinon.assert.calledOnce( spyAbc );
- sinon.assert.calledTwice( spyBar );
- sinon.assert.calledTwice( spyFoo2 );
- emitter.fire( 'foo' );
- sinon.assert.notCalled( spyFoo );
- sinon.assert.calledOnce( spyAbc );
- sinon.assert.calledTwice( spyBar );
- sinon.assert.calledThrice( spyFoo2 );
- } );
- } );
- describe( 'listenTo', () => {
- it( 'should properly register callbacks', () => {
- const spy = sinon.spy();
- listener.listenTo( emitter, 'test', spy );
- emitter.fire( 'test' );
- sinon.assert.called( spy );
- } );
- it( 'should correctly listen to namespaced events', () => {
- const spyFoo = sinon.spy();
- const spyBar = sinon.spy();
- const spyBaz = sinon.spy();
- listener.listenTo( emitter, 'foo', spyFoo );
- listener.listenTo( emitter, 'foo:bar', spyBar );
- listener.listenTo( emitter, 'foo:bar:baz', spyBaz );
- emitter.fire( 'foo:bar:baz' );
- sinon.assert.calledOnce( spyFoo );
- sinon.assert.calledOnce( spyBar );
- sinon.assert.calledOnce( spyBaz );
- emitter.fire( 'foo:bar' );
- sinon.assert.calledTwice( spyFoo );
- sinon.assert.calledTwice( spyBar );
- sinon.assert.calledOnce( spyBaz );
- emitter.fire( 'foo' );
- sinon.assert.calledThrice( spyFoo );
- sinon.assert.calledTwice( spyBar );
- sinon.assert.calledOnce( spyBaz );
- } );
- } );
- describe( 'stopListening', () => {
- it( 'should stop listening to given event callback', () => {
- const spy1 = sinon.spy();
- const spy2 = sinon.spy();
- listener.listenTo( emitter, 'event1', spy1 );
- listener.listenTo( emitter, 'event2', spy2 );
- emitter.fire( 'event1' );
- emitter.fire( 'event2' );
- listener.stopListening( emitter, 'event1', spy1 );
- emitter.fire( 'event1' );
- emitter.fire( 'event2' );
- sinon.assert.calledOnce( spy1 );
- sinon.assert.calledTwice( spy2 );
- } );
- it( 'should stop listening to given event', () => {
- const spy1a = sinon.spy();
- const spy1b = sinon.spy();
- const spy2 = sinon.spy();
- listener.listenTo( emitter, 'event1', spy1a );
- listener.listenTo( emitter, 'event1', spy1b );
- listener.listenTo( emitter, 'event2', spy2 );
- emitter.fire( 'event1' );
- emitter.fire( 'event2' );
- listener.stopListening( emitter, 'event1' );
- emitter.fire( 'event1' );
- emitter.fire( 'event2' );
- sinon.assert.calledOnce( spy1a );
- sinon.assert.calledOnce( spy1b );
- sinon.assert.calledTwice( spy2 );
- } );
- it( 'should stop listening to all events from given emitter', () => {
- const spy1 = sinon.spy();
- const spy2 = sinon.spy();
- const spy3 = sinon.spy();
- const spy4 = sinon.spy();
- listener.listenTo( emitter, 'event1', spy1 );
- listener.listenTo( emitter, 'event2', spy2 );
- listener.listenTo( emitter, 'foo', spy3 );
- listener.listenTo( emitter, 'foo:bar:baz', spy4 );
- emitter.fire( 'event1' );
- emitter.fire( 'event2' );
- emitter.fire( 'foo:bar:baz' );
- listener.stopListening( emitter );
- emitter.fire( 'event1' );
- emitter.fire( 'event2' );
- emitter.fire( 'foo:bar:baz' );
- sinon.assert.calledOnce( spy1 );
- sinon.assert.calledOnce( spy2 );
- sinon.assert.calledOnce( spy3 );
- sinon.assert.calledOnce( spy4 );
- } );
- it( 'should stop listening to everything', () => {
- const spy1 = sinon.spy();
- const spy2 = sinon.spy();
- const spy3 = sinon.spy();
- const spy4 = sinon.spy();
- const emitter1 = getEmitterInstance();
- const emitter2 = getEmitterInstance();
- listener.listenTo( emitter1, 'event1', spy1 );
- listener.listenTo( emitter2, 'event2', spy2 );
- listener.listenTo( emitter1, 'foo', spy3 );
- listener.listenTo( emitter1, 'foo:bar:baz', spy4 );
- emitter1.fire( 'event1' );
- emitter2.fire( 'event2' );
- emitter1.fire( 'foo' );
- emitter1.fire( 'foo:bar' );
- emitter1.fire( 'foo:bar:baz' );
- listener.stopListening();
- emitter1.fire( 'event1' );
- emitter2.fire( 'event2' );
- emitter1.fire( 'foo' );
- emitter1.fire( 'foo:bar' );
- emitter1.fire( 'foo:bar:baz' );
- sinon.assert.calledOnce( spy1 );
- sinon.assert.calledOnce( spy2 );
- sinon.assert.calledThrice( spy3 );
- sinon.assert.calledOnce( spy4 );
- } );
- it( 'should not stop other emitters when a non-listened emitter is provided', () => {
- const spy = sinon.spy();
- const emitter1 = getEmitterInstance();
- const emitter2 = getEmitterInstance();
- listener.listenTo( emitter1, 'test', spy );
- listener.stopListening( emitter2 );
- emitter1.fire( 'test' );
- sinon.assert.called( spy );
- } );
- it( 'should correctly stop listening to namespaced events', () => {
- const spyFoo = sinon.spy();
- const spyBar = sinon.spy();
- const spyBaz = sinon.spy();
- listener.listenTo( emitter, 'foo', spyFoo );
- listener.listenTo( emitter, 'foo:bar', spyBar );
- listener.listenTo( emitter, 'foo:bar:baz', spyBaz );
- listener.stopListening( emitter, 'foo' );
- emitter.fire( 'foo:bar:baz' );
- sinon.assert.notCalled( spyFoo );
- sinon.assert.calledOnce( spyBar );
- sinon.assert.calledOnce( spyBaz );
- } );
- it( 'should correctly stop listening to namespaced events when removing specialised event', () => {
- const spyFoo = sinon.spy();
- const spyBar = sinon.spy();
- const spyBaz = sinon.spy();
- listener.listenTo( emitter, 'foo', spyFoo );
- listener.listenTo( emitter, 'foo:bar', spyBar );
- listener.listenTo( emitter, 'foo:bar:baz', spyBaz );
- listener.stopListening( emitter, 'foo:bar' );
- emitter.fire( 'foo:bar:baz' );
- sinon.assert.calledOnce( spyFoo );
- sinon.assert.notCalled( spyBar );
- sinon.assert.calledOnce( spyBaz );
- } );
- it( 'should not fail with unknown events', () => {
- listener.stopListening( emitter, 'foo', () => {} );
- listener.stopListening( emitter, 'foo:bar', () => {} );
- listener.stopListening( emitter, 'foo' );
- listener.stopListening( emitter, 'foo:bar' );
- } );
- it( 'should not fail with unknown emitter', () => {
- listener.listenTo( emitter, 'foo:bar', () => {} );
- listener.stopListening( {}, 'foo', () => {} );
- listener.stopListening( {}, 'foo:bar', () => {} );
- listener.stopListening( {}, 'foo' );
- listener.stopListening( {}, 'foo:bar' );
- listener.stopListening( {} );
- } );
- it( 'should not fail with unknown callbacks', () => {
- const spy = sinon.spy();
- listener.listenTo( emitter, 'foo', spy );
- listener.stopListening( emitter, 'foo', () => {} );
- emitter.fire( 'foo' );
- sinon.assert.calledOnce( spy );
- } );
- } );
- describe( 'delegate', () => {
- it( 'should chain for a single event', () => {
- const emitter = getEmitterInstance();
- expect( emitter.delegate( 'foo' ) ).to.contain.keys( 'to' );
- } );
- it( 'should chain for multiple events', () => {
- const emitter = getEmitterInstance();
- expect( emitter.delegate( 'foo', 'bar' ) ).to.contain.keys( 'to' );
- } );
- describe( 'to', () => {
- it( 'forwards an event to another emitter', done => {
- const emitterA = getEmitterInstance();
- const emitterB = getEmitterInstance();
- const dataA = {};
- const dataB = {};
- emitterB.delegate( 'foo' ).to( emitterA );
- emitterA.on( 'foo', ( ...args ) => {
- assertDelegated( args, {
- expectedSource: emitterB,
- expectedName: 'foo',
- expectedPath: [ emitterB, emitterA ],
- expectedData: [ dataA, dataB ]
- } );
- done();
- } );
- emitterB.fire( 'foo', dataA, dataB );
- } );
- it( 'forwards multiple events to another emitter', () => {
- const emitterA = getEmitterInstance();
- const emitterB = getEmitterInstance();
- const spyFoo = sinon.spy();
- const spyBar = sinon.spy();
- const spyBaz = sinon.spy();
- const dataA = {};
- const dataB = {};
- emitterB.delegate( 'foo', 'bar', 'baz' ).to( emitterA );
- emitterA.on( 'foo', spyFoo );
- emitterA.on( 'bar', spyBar );
- emitterA.on( 'baz', spyBaz );
- emitterB.fire( 'foo', dataA, dataB );
- sinon.assert.calledOnce( spyFoo );
- sinon.assert.notCalled( spyBar );
- sinon.assert.notCalled( spyBaz );
- assertDelegated( spyFoo.args[ 0 ], {
- expectedSource: emitterB,
- expectedName: 'foo',
- expectedPath: [ emitterB, emitterA ],
- expectedData: [ dataA, dataB ]
- } );
- emitterB.fire( 'bar' );
- sinon.assert.calledOnce( spyFoo );
- sinon.assert.calledOnce( spyBar );
- sinon.assert.notCalled( spyBaz );
- assertDelegated( spyBar.args[ 0 ], {
- expectedSource: emitterB,
- expectedName: 'bar',
- expectedPath: [ emitterB, emitterA ],
- expectedData: []
- } );
- emitterB.fire( 'baz' );
- sinon.assert.calledOnce( spyFoo );
- sinon.assert.calledOnce( spyBar );
- sinon.assert.calledOnce( spyBaz );
- assertDelegated( spyBaz.args[ 0 ], {
- expectedSource: emitterB,
- expectedName: 'baz',
- expectedPath: [ emitterB, emitterA ],
- expectedData: []
- } );
- emitterB.fire( 'not-delegated' );
- sinon.assert.calledOnce( spyFoo );
- sinon.assert.calledOnce( spyBar );
- sinon.assert.calledOnce( spyBaz );
- } );
- it( 'does not forward events which are not supposed to be delegated', () => {
- const emitterA = getEmitterInstance();
- const emitterB = getEmitterInstance();
- const spyFoo = sinon.spy();
- const spyBar = sinon.spy();
- const spyBaz = sinon.spy();
- emitterB.delegate( 'foo', 'bar', 'baz' ).to( emitterA );
- emitterA.on( 'foo', spyFoo );
- emitterA.on( 'bar', spyBar );
- emitterA.on( 'baz', spyBaz );
- emitterB.fire( 'foo' );
- emitterB.fire( 'bar' );
- emitterB.fire( 'baz' );
- emitterB.fire( 'not-delegated' );
- sinon.assert.callOrder( spyFoo, spyBar, spyBaz );
- sinon.assert.callCount( spyFoo, 1 );
- sinon.assert.callCount( spyBar, 1 );
- sinon.assert.callCount( spyBaz, 1 );
- } );
- it( 'supports deep chain event delegation', done => {
- const emitterA = getEmitterInstance();
- const emitterB = getEmitterInstance();
- const emitterC = getEmitterInstance();
- const data = {};
- emitterC.delegate( 'foo' ).to( emitterB );
- emitterB.delegate( 'foo' ).to( emitterA );
- emitterA.on( 'foo', ( ...args ) => {
- assertDelegated( args, {
- expectedSource: emitterC,
- expectedName: 'foo',
- expectedPath: [ emitterC, emitterB, emitterA ],
- expectedData: [ data ]
- } );
- done();
- } );
- emitterC.fire( 'foo', data );
- } );
- it( 'preserves path in event delegation', done => {
- const data = {};
- const emitterA = getEmitterInstance();
- const emitterB = getEmitterInstance();
- const emitterC = getEmitterInstance();
- const emitterD = getEmitterInstance();
- emitterB.delegate( 'foo' ).to( emitterA );
- emitterB.delegate( 'foo' ).to( emitterC );
- emitterB.delegate( 'foo' ).to( emitterD );
- emitterD.on( 'foo', ( ...args ) => {
- assertDelegated( args, {
- expectedSource: emitterB,
- expectedName: 'foo',
- expectedPath: [ emitterB, emitterD ],
- expectedData: [ data ]
- } );
- done();
- } );
- emitterB.fire( 'foo', data );
- emitterC.fire( 'foo', data );
- } );
- it( 'executes callbacks first, then delegates further', () => {
- const emitterA = getEmitterInstance();
- const emitterB = getEmitterInstance();
- const spyA = sinon.spy();
- const spyB = sinon.spy();
- emitterB.delegate( 'foo' ).to( emitterA );
- emitterA.on( 'foo', spyA );
- emitterB.on( 'foo', spyB );
- emitterB.fire( 'foo' );
- sinon.assert.callOrder( spyB, spyA );
- } );
- it( 'supports delegation under a different name', () => {
- const emitterA = getEmitterInstance();
- const emitterB = getEmitterInstance();
- const emitterC = getEmitterInstance();
- const emitterD = getEmitterInstance();
- const spyAFoo = sinon.spy();
- const spyABar = sinon.spy();
- const spyCBaz = sinon.spy();
- const spyDFoo = sinon.spy();
- emitterB.delegate( 'foo' ).to( emitterA, 'bar' );
- emitterB.delegate( 'foo' ).to( emitterC, name => name + '-baz' );
- emitterB.delegate( 'foo' ).to( emitterD );
- emitterA.on( 'foo', spyAFoo );
- emitterA.on( 'bar', spyABar );
- emitterC.on( 'foo-baz', spyCBaz );
- emitterD.on( 'foo', spyDFoo );
- emitterB.fire( 'foo' );
- sinon.assert.calledOnce( spyABar );
- sinon.assert.calledOnce( spyCBaz );
- sinon.assert.calledOnce( spyDFoo );
- sinon.assert.notCalled( spyAFoo );
- } );
- it( 'supports delegation under a different name with multiple events', () => {
- const emitterA = getEmitterInstance();
- const emitterB = getEmitterInstance();
- const spyAFoo = sinon.spy();
- const spyABar = sinon.spy();
- const spyABaz = sinon.spy();
- const spyAQux = sinon.spy();
- emitterB.delegate( 'foo', 'bar', 'baz' ).to( emitterA, 'qux' );
- emitterA.on( 'foo', spyAFoo );
- emitterA.on( 'bar', spyABar );
- emitterA.on( 'baz', spyABaz );
- emitterA.on( 'qux', spyAQux );
- emitterB.fire( 'foo' );
- emitterB.fire( 'baz' );
- emitterB.fire( 'bar' );
- sinon.assert.notCalled( spyAFoo );
- sinon.assert.notCalled( spyABar );
- sinon.assert.notCalled( spyABaz );
- sinon.assert.calledThrice( spyAQux );
- } );
- it( 'supports delegation with multiple events, each under a different name', () => {
- const emitterA = getEmitterInstance();
- const emitterB = getEmitterInstance();
- const spyAFoo = sinon.spy();
- const spyABar = sinon.spy();
- const spyABaz = sinon.spy();
- const spyAFooQux = sinon.spy();
- const spyABarQux = sinon.spy();
- const spyABazQux = sinon.spy();
- emitterB.delegate( 'foo', 'bar', 'baz' ).to( emitterA, name => name + '-qux' );
- emitterA.on( 'foo', spyAFoo );
- emitterA.on( 'bar', spyABar );
- emitterA.on( 'baz', spyABaz );
- emitterA.on( 'foo-qux', spyAFooQux );
- emitterA.on( 'bar-qux', spyABarQux );
- emitterA.on( 'baz-qux', spyABazQux );
- emitterB.fire( 'foo' );
- emitterB.fire( 'baz' );
- emitterB.fire( 'bar' );
- sinon.assert.notCalled( spyAFoo );
- sinon.assert.notCalled( spyABar );
- sinon.assert.notCalled( spyABaz );
- sinon.assert.calledOnce( spyAFooQux );
- sinon.assert.calledOnce( spyABarQux );
- sinon.assert.calledOnce( spyABazQux );
- sinon.assert.callOrder( spyAFooQux, spyABazQux, spyABarQux );
- } );
- it( 'preserves path in delegation under a different name', done => {
- const data = {};
- const emitterA = getEmitterInstance();
- const emitterB = getEmitterInstance();
- const emitterC = getEmitterInstance();
- const emitterD = getEmitterInstance();
- emitterB.delegate( 'foo' ).to( emitterA, 'bar' );
- emitterB.delegate( 'foo' ).to( emitterC, 'baz' );
- emitterB.delegate( 'foo' ).to( emitterD );
- emitterD.on( 'foo', ( ...args ) => {
- assertDelegated( args, {
- expectedSource: emitterB,
- expectedName: 'foo',
- expectedPath: [ emitterB, emitterD ],
- expectedData: [ data ]
- } );
- done();
- } );
- emitterB.fire( 'foo', data );
- } );
- it( 'supports delegation of all events', () => {
- const emitterA = getEmitterInstance();
- const emitterB = getEmitterInstance();
- const spyAFoo = sinon.spy();
- const spyABar = sinon.spy();
- const spyABaz = sinon.spy();
- emitterB.delegate( '*' ).to( emitterA );
- emitterA.on( 'foo', spyAFoo );
- emitterA.on( 'bar', spyABar );
- emitterA.on( 'baz', spyABaz );
- emitterB.fire( 'foo' );
- emitterB.fire( 'baz' );
- emitterB.fire( 'bar' );
- sinon.assert.callOrder( spyAFoo, spyABaz, spyABar );
- } );
- it( 'supports delegation of all events under different names', () => {
- const emitterA = getEmitterInstance();
- const emitterB = getEmitterInstance();
- const spyAFoo = sinon.spy();
- const spyABar = sinon.spy();
- const spyABaz = sinon.spy();
- const spyAFooDel = sinon.spy();
- const spyABarDel = sinon.spy();
- const spyABazDel = sinon.spy();
- emitterB.delegate( '*' ).to( emitterA, name => name + '-delegated' );
- emitterA.on( 'foo', spyAFoo );
- emitterA.on( 'bar', spyABar );
- emitterA.on( 'baz', spyABaz );
- emitterA.on( 'foo-delegated', spyAFooDel );
- emitterA.on( 'bar-delegated', spyABarDel );
- emitterA.on( 'baz-delegated', spyABazDel );
- emitterB.fire( 'foo' );
- emitterB.fire( 'baz' );
- emitterB.fire( 'bar' );
- sinon.assert.notCalled( spyAFoo );
- sinon.assert.notCalled( spyABar );
- sinon.assert.notCalled( spyABaz );
- sinon.assert.callOrder( spyAFooDel, spyABazDel, spyABarDel );
- } );
- } );
- } );
- describe( 'stopDelegating', () => {
- it( 'passes if no delegation was set', () => {
- expect( () => {
- getEmitterInstance().stopDelegating();
- } ).to.not.throw();
- } );
- it( 'stops delegating all events to all emitters', () => {
- const emitterA = getEmitterInstance();
- const emitterB = getEmitterInstance();
- const emitterC = getEmitterInstance();
- const spyFoo = sinon.spy();
- const spyBar = sinon.spy();
- emitterA.delegate( 'foo' ).to( emitterB );
- emitterA.delegate( 'bar' ).to( emitterC );
- emitterB.on( 'foo', spyFoo );
- emitterC.on( 'bar', spyBar );
- emitterA.fire( 'foo' );
- emitterA.fire( 'bar' );
- sinon.assert.callOrder( spyFoo, spyBar );
- emitterA.stopDelegating();
- emitterA.fire( 'foo' );
- emitterA.fire( 'bar' );
- sinon.assert.callOrder( spyFoo, spyBar );
- } );
- it( 'stops delegating a specific event to all emitters', () => {
- const emitterA = getEmitterInstance();
- const emitterB = getEmitterInstance();
- const emitterC = getEmitterInstance();
- const spyFooB = sinon.spy();
- const spyFooC = sinon.spy();
- const spyBarC = sinon.spy();
- emitterA.delegate( 'foo' ).to( emitterB );
- emitterA.delegate( 'foo' ).to( emitterC );
- emitterA.delegate( 'bar' ).to( emitterC );
- emitterB.on( 'foo', spyFooB );
- emitterC.on( 'foo', spyFooC );
- emitterC.on( 'bar', spyBarC );
- emitterA.fire( 'foo' );
- emitterA.fire( 'bar' );
- sinon.assert.callOrder( spyFooB, spyFooC, spyBarC );
- emitterA.stopDelegating( 'foo' );
- emitterA.fire( 'foo' );
- emitterA.fire( 'bar' );
- sinon.assert.callOrder( spyFooB, spyFooC, spyBarC, spyBarC );
- } );
- it( 'stops delegating a specific event to a specific emitter', () => {
- const emitterA = getEmitterInstance();
- const emitterB = getEmitterInstance();
- const emitterC = getEmitterInstance();
- const spyFooB = sinon.spy();
- const spyFooC = sinon.spy();
- emitterA.delegate( 'foo' ).to( emitterB );
- emitterA.delegate( 'foo' ).to( emitterC );
- emitterB.on( 'foo', spyFooB );
- emitterC.on( 'foo', spyFooC );
- emitterA.fire( 'foo' );
- sinon.assert.callOrder( spyFooB, spyFooC );
- emitterA.stopDelegating( 'foo', emitterC );
- emitterA.fire( 'foo' );
- sinon.assert.callOrder( spyFooB, spyFooC, spyFooB );
- } );
- it( 'stops delegating a specific event under a different name to a specific emitter', () => {
- const emitterA = getEmitterInstance();
- const emitterB = getEmitterInstance();
- const emitterC = getEmitterInstance();
- const spyFooB = sinon.spy();
- const spyFooC = sinon.spy();
- emitterA.delegate( 'foo' ).to( emitterB );
- emitterA.delegate( 'foo' ).to( emitterC, 'bar' );
- emitterB.on( 'foo', spyFooB );
- emitterC.on( 'bar', spyFooC );
- emitterA.fire( 'foo' );
- sinon.assert.callOrder( spyFooB, spyFooC );
- emitterA.stopDelegating( 'foo', emitterC );
- emitterA.fire( 'foo' );
- sinon.assert.callOrder( spyFooB, spyFooC, spyFooB );
- } );
- it( 'stops delegating all ("*")', () => {
- const emitterA = getEmitterInstance();
- const emitterB = getEmitterInstance();
- const emitterC = getEmitterInstance();
- const spyAFoo = sinon.spy();
- const spyABar = sinon.spy();
- const spyCFoo = sinon.spy();
- const spyCBar = sinon.spy();
- emitterB.delegate( '*' ).to( emitterA );
- emitterB.delegate( '*' ).to( emitterC );
- emitterA.on( 'foo', spyAFoo );
- emitterA.on( 'bar', spyABar );
- emitterC.on( 'foo', spyCFoo );
- emitterC.on( 'bar', spyCBar );
- emitterB.fire( 'foo' );
- emitterB.fire( 'bar' );
- sinon.assert.calledOnce( spyAFoo );
- sinon.assert.calledOnce( spyABar );
- sinon.assert.calledOnce( spyCFoo );
- sinon.assert.calledOnce( spyCBar );
- emitterB.stopDelegating( '*' );
- emitterB.fire( 'foo' );
- emitterB.fire( 'bar' );
- sinon.assert.calledOnce( spyAFoo );
- sinon.assert.calledOnce( spyABar );
- sinon.assert.calledOnce( spyCFoo );
- sinon.assert.calledOnce( spyCBar );
- } );
- it( 'stops delegating all ("*") to a specific emitter', () => {
- const emitterA = getEmitterInstance();
- const emitterB = getEmitterInstance();
- const emitterC = getEmitterInstance();
- const spyAFoo = sinon.spy();
- const spyABar = sinon.spy();
- const spyCFoo = sinon.spy();
- const spyCBar = sinon.spy();
- emitterB.delegate( '*' ).to( emitterA );
- emitterB.delegate( 'foo' ).to( emitterC );
- emitterA.on( 'foo', spyAFoo );
- emitterA.on( 'bar', spyABar );
- emitterC.on( 'foo', spyCFoo );
- emitterC.on( 'bar', spyCBar );
- emitterB.fire( 'foo' );
- emitterB.fire( 'bar' );
- sinon.assert.calledOnce( spyAFoo );
- sinon.assert.calledOnce( spyABar );
- sinon.assert.calledOnce( spyCFoo );
- sinon.assert.notCalled( spyCBar );
- emitterB.stopDelegating( '*', emitterA );
- emitterB.fire( 'foo' );
- emitterB.fire( 'bar' );
- sinon.assert.calledOnce( spyAFoo );
- sinon.assert.calledOnce( spyABar );
- sinon.assert.calledTwice( spyCFoo );
- sinon.assert.notCalled( spyCBar );
- } );
- it( 'passes when stopping delegation of a specific event which has never been delegated', () => {
- const emitterA = getEmitterInstance();
- const emitterB = getEmitterInstance();
- expect( () => {
- emitterA.stopDelegating( 'bar' );
- emitterA.stopDelegating( 'bar', emitterB );
- } ).to.not.throw();
- } );
- it( 'passes when stopping delegation of a specific event to an emitter which wasn\'t a destination', () => {
- const emitterA = getEmitterInstance();
- const emitterB = getEmitterInstance();
- const emitterC = getEmitterInstance();
- emitterA.delegate( 'foo' ).to( emitterB );
- expect( () => {
- emitterA.stopDelegating( 'foo', emitterC );
- } ).to.not.throw();
- } );
- it( 'passes when stopping delegation of a specific event to a specific emitter which has never been delegated', () => {
- const emitterA = getEmitterInstance();
- const emitterB = getEmitterInstance();
- const emitterC = getEmitterInstance();
- emitterA.delegate( 'foo' ).to( emitterB );
- expect( () => {
- emitterA.stopDelegating( 'bar', emitterC );
- } ).to.not.throw();
- } );
- } );
- function assertDelegated( evtArgs, { expectedName, expectedSource, expectedPath, expectedData } ) {
- const evtInfo = evtArgs[ 0 ];
- expect( evtInfo.name ).to.equal( expectedName );
- expect( evtInfo.source ).to.equal( expectedSource );
- expect( evtInfo.path ).to.deep.equal( expectedPath );
- expect( evtArgs.slice( 1 ) ).to.deep.equal( expectedData );
- }
- } );
- describe( 'emitter id', () => {
- let emitter;
- beforeEach( () => {
- emitter = getEmitterInstance();
- } );
- it( 'should be undefined before it is set', () => {
- expect( _getEmitterId( emitter ) ).to.be.undefined;
- } );
- it( 'should be settable but only once', () => {
- _setEmitterId( emitter, 'abc' );
- expect( _getEmitterId( emitter ) ).to.equal( 'abc' );
- _setEmitterId( emitter, 'xyz' );
- expect( _getEmitterId( emitter ) ).to.equal( 'abc' );
- } );
- } );
- describe( '_getEmitterListenedTo', () => {
- let emitter, listener;
- beforeEach( () => {
- emitter = getEmitterInstance();
- listener = getEmitterInstance();
- } );
- it( 'should return null if listener do not listen to emitter with given id', () => {
- expect( _getEmitterListenedTo( listener, 'abc' ) ).to.be.null;
- } );
- it( 'should return emitter with given id', () => {
- listener.listenTo( emitter, 'eventName', () => {} );
- const emitterId = _getEmitterId( emitter );
- expect( _getEmitterListenedTo( listener, emitterId ) ).to.equal( emitter );
- } );
- } );
- function getEmitterInstance() {
- return Object.create( EmitterMixin );
- }
|