test.js 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642
  1. describe('EventEmitter', function tests() {
  2. 'use strict';
  3. var EventEmitter = require('../')
  4. , assume = require('assume');
  5. it('exposes a `prefixed` property', function () {
  6. assume(EventEmitter.prefixed).is.either([false, '~']);
  7. });
  8. it('exposes a module namespace object', function() {
  9. assume(EventEmitter.EventEmitter).equals(EventEmitter);
  10. });
  11. it('inherits when used with `require("util").inherits`', function () {
  12. function Beast() {
  13. EventEmitter.call(this);
  14. }
  15. require('util').inherits(Beast, EventEmitter);
  16. var moop = new Beast()
  17. , meap = new Beast();
  18. assume(moop).is.instanceOf(Beast);
  19. assume(moop).is.instanceOf(EventEmitter);
  20. moop.listeners();
  21. meap.listeners();
  22. moop.on('data', function () {
  23. throw new Error('I should not emit');
  24. });
  25. meap.emit('data', 'rawr');
  26. meap.removeListener('foo');
  27. meap.removeAllListeners();
  28. });
  29. if ('undefined' !== typeof Symbol) it('works with ES6 symbols', function (next) {
  30. var e = new EventEmitter()
  31. , event = Symbol('cows')
  32. , unknown = Symbol('moo');
  33. e.on(event, function foo(arg) {
  34. assume(e.listenerCount(unknown)).equals(0);
  35. assume(e.listeners(unknown)).deep.equals([]);
  36. assume(arg).equals('bar');
  37. function bar(onced) {
  38. assume(e.listenerCount(unknown)).equals(0);
  39. assume(e.listeners(unknown)).deep.equals([]);
  40. assume(onced).equals('foo');
  41. next();
  42. }
  43. e.once(unknown, bar);
  44. assume(e.listenerCount(event)).equals(1);
  45. assume(e.listeners(event)).deep.equals([foo]);
  46. assume(e.listenerCount(unknown)).equals(1);
  47. assume(e.listeners(unknown)).deep.equals([bar]);
  48. e.removeListener(event);
  49. assume(e.listenerCount(event)).equals(0);
  50. assume(e.listeners(event)).deep.equals([]);
  51. assume(e.emit(unknown, 'foo')).equals(true);
  52. });
  53. assume(e.emit(unknown, 'bar')).equals(false);
  54. assume(e.emit(event, 'bar')).equals(true);
  55. });
  56. describe('EventEmitter#emit', function () {
  57. it('should return false when there are not events to emit', function () {
  58. var e = new EventEmitter();
  59. assume(e.emit('foo')).equals(false);
  60. assume(e.emit('bar')).equals(false);
  61. });
  62. it('emits with context', function (done) {
  63. var context = { bar: 'baz' }
  64. , e = new EventEmitter();
  65. e.on('foo', function (bar) {
  66. assume(bar).equals('bar');
  67. assume(this).equals(context);
  68. done();
  69. }, context).emit('foo', 'bar');
  70. });
  71. it('emits with context, multiple arguments (force apply)', function (done) {
  72. var context = { bar: 'baz' }
  73. , e = new EventEmitter();
  74. e.on('foo', function (bar) {
  75. assume(bar).equals('bar');
  76. assume(this).equals(context);
  77. done();
  78. }, context).emit('foo', 'bar', 1, 2, 3, 4, 5, 6, 7, 8, 9, 0);
  79. });
  80. it('can emit the function with multiple arguments', function () {
  81. var e = new EventEmitter();
  82. for (var i = 0; i < 100; i++) {
  83. (function (j) {
  84. for (var i = 0, args = []; i < j; i++) {
  85. args.push(j);
  86. }
  87. e.once('args', function () {
  88. assume(arguments.length).equals(args.length);
  89. });
  90. e.emit.apply(e, ['args'].concat(args));
  91. })(i);
  92. }
  93. });
  94. it('can emit the function with multiple arguments, multiple listeners', function () {
  95. var e = new EventEmitter();
  96. for (var i = 0; i < 100; i++) {
  97. (function (j) {
  98. for (var i = 0, args = []; i < j; i++) {
  99. args.push(j);
  100. }
  101. e.once('args', function () {
  102. assume(arguments.length).equals(args.length);
  103. });
  104. e.once('args', function () {
  105. assume(arguments.length).equals(args.length);
  106. });
  107. e.once('args', function () {
  108. assume(arguments.length).equals(args.length);
  109. });
  110. e.once('args', function () {
  111. assume(arguments.length).equals(args.length);
  112. });
  113. e.emit.apply(e, ['args'].concat(args));
  114. })(i);
  115. }
  116. });
  117. it('emits with context, multiple listeners (force loop)', function () {
  118. var e = new EventEmitter();
  119. e.on('foo', function (bar) {
  120. assume(this).eqls({ foo: 'bar' });
  121. assume(bar).equals('bar');
  122. }, { foo: 'bar' });
  123. e.on('foo', function (bar) {
  124. assume(this).eqls({ bar: 'baz' });
  125. assume(bar).equals('bar');
  126. }, { bar: 'baz' });
  127. e.emit('foo', 'bar');
  128. });
  129. it('emits with different contexts', function () {
  130. var e = new EventEmitter()
  131. , pattern = '';
  132. function writer() {
  133. pattern += this;
  134. }
  135. e.on('write', writer, 'foo');
  136. e.on('write', writer, 'baz');
  137. e.once('write', writer, 'bar');
  138. e.once('write', writer, 'banana');
  139. e.emit('write');
  140. assume(pattern).equals('foobazbarbanana');
  141. });
  142. it('should return true when there are events to emit', function () {
  143. var e = new EventEmitter()
  144. , called = 0;
  145. e.on('foo', function () {
  146. called++;
  147. });
  148. assume(e.emit('foo')).equals(true);
  149. assume(e.emit('foob')).equals(false);
  150. assume(called).equals(1);
  151. });
  152. it('receives the emitted events', function (done) {
  153. var e = new EventEmitter();
  154. e.on('data', function (a, b, c, d, undef) {
  155. assume(a).equals('foo');
  156. assume(b).equals(e);
  157. assume(c).is.instanceOf(Date);
  158. assume(undef).equals(undefined);
  159. assume(arguments.length).equals(3);
  160. done();
  161. });
  162. e.emit('data', 'foo', e, new Date());
  163. });
  164. it('emits to all event listeners', function () {
  165. var e = new EventEmitter()
  166. , pattern = [];
  167. e.on('foo', function () {
  168. pattern.push('foo1');
  169. });
  170. e.on('foo', function () {
  171. pattern.push('foo2');
  172. });
  173. e.emit('foo');
  174. assume(pattern.join(';')).equals('foo1;foo2');
  175. });
  176. (function each(keys) {
  177. var key = keys.shift();
  178. if (!key) return;
  179. it('can store event which is a known property: '+ key, function (next) {
  180. var e = new EventEmitter();
  181. e.on(key, function (k) {
  182. assume(k).equals(key);
  183. next();
  184. }).emit(key, key);
  185. });
  186. each(keys);
  187. })([
  188. 'hasOwnProperty',
  189. 'constructor',
  190. '__proto__',
  191. 'toString',
  192. 'toValue',
  193. 'unwatch',
  194. 'watch'
  195. ]);
  196. });
  197. describe('EventEmitter#listeners', function () {
  198. it('returns an empty array if no listeners are specified', function () {
  199. var e = new EventEmitter();
  200. assume(e.listeners('foo')).is.a('array');
  201. assume(e.listeners('foo').length).equals(0);
  202. });
  203. it('returns an array of function', function () {
  204. var e = new EventEmitter();
  205. function foo() {}
  206. e.on('foo', foo);
  207. assume(e.listeners('foo')).is.a('array');
  208. assume(e.listeners('foo').length).equals(1);
  209. assume(e.listeners('foo')).deep.equals([foo]);
  210. });
  211. it('is not vulnerable to modifications', function () {
  212. var e = new EventEmitter();
  213. function foo() {}
  214. e.on('foo', foo);
  215. assume(e.listeners('foo')).deep.equals([foo]);
  216. e.listeners('foo').length = 0;
  217. assume(e.listeners('foo')).deep.equals([foo]);
  218. });
  219. });
  220. describe('EventEmitter#listenerCount', function () {
  221. it('returns the number of listeners for a given event', function () {
  222. var e = new EventEmitter();
  223. assume(e.listenerCount()).equals(0);
  224. assume(e.listenerCount('foo')).equals(0);
  225. e.on('foo', function () {});
  226. assume(e.listenerCount('foo')).equals(1);
  227. e.on('foo', function () {});
  228. assume(e.listenerCount('foo')).equals(2);
  229. });
  230. });
  231. describe('EventEmitter#on', function () {
  232. it('throws an error if the listener is not a function', function () {
  233. var e = new EventEmitter();
  234. try {
  235. e.on('foo', 'bar');
  236. } catch (ex) {
  237. assume(ex).is.instanceOf(TypeError);
  238. assume(ex.message).equals('The listener must be a function');
  239. return;
  240. }
  241. throw new Error('oops');
  242. });
  243. });
  244. describe('EventEmitter#once', function () {
  245. it('only emits it once', function () {
  246. var e = new EventEmitter()
  247. , calls = 0;
  248. e.once('foo', function () {
  249. calls++;
  250. });
  251. e.emit('foo');
  252. e.emit('foo');
  253. e.emit('foo');
  254. e.emit('foo');
  255. e.emit('foo');
  256. assume(e.listeners('foo').length).equals(0);
  257. assume(calls).equals(1);
  258. });
  259. it('only emits once if emits are nested inside the listener', function () {
  260. var e = new EventEmitter()
  261. , calls = 0;
  262. e.once('foo', function () {
  263. calls++;
  264. e.emit('foo');
  265. });
  266. e.emit('foo');
  267. assume(e.listeners('foo').length).equals(0);
  268. assume(calls).equals(1);
  269. });
  270. it('only emits once for multiple events', function () {
  271. var e = new EventEmitter()
  272. , multi = 0
  273. , foo = 0
  274. , bar = 0;
  275. e.once('foo', function () {
  276. foo++;
  277. });
  278. e.once('foo', function () {
  279. bar++;
  280. });
  281. e.on('foo', function () {
  282. multi++;
  283. });
  284. e.emit('foo');
  285. e.emit('foo');
  286. e.emit('foo');
  287. e.emit('foo');
  288. e.emit('foo');
  289. assume(e.listeners('foo').length).equals(1);
  290. assume(multi).equals(5);
  291. assume(foo).equals(1);
  292. assume(bar).equals(1);
  293. });
  294. it('only emits once with context', function (done) {
  295. var context = { foo: 'bar' }
  296. , e = new EventEmitter();
  297. e.once('foo', function (bar) {
  298. assume(this).equals(context);
  299. assume(bar).equals('bar');
  300. done();
  301. }, context).emit('foo', 'bar');
  302. });
  303. });
  304. describe('EventEmitter#removeListener', function () {
  305. it('removes all listeners when the listener is not specified', function () {
  306. var e = new EventEmitter();
  307. e.on('foo', function () {});
  308. e.on('foo', function () {});
  309. assume(e.removeListener('foo')).equals(e);
  310. assume(e.listeners('foo')).eql([]);
  311. });
  312. it('removes only the listeners matching the specified listener', function () {
  313. var e = new EventEmitter();
  314. function foo() {}
  315. function bar() {}
  316. function baz() {}
  317. e.on('foo', foo);
  318. e.on('bar', bar);
  319. e.on('bar', baz);
  320. assume(e.removeListener('foo', bar)).equals(e);
  321. assume(e.listeners('bar')).eql([bar, baz]);
  322. assume(e.listeners('foo')).eql([foo]);
  323. assume(e._eventsCount).equals(2);
  324. assume(e.removeListener('foo', foo)).equals(e);
  325. assume(e.listeners('bar')).eql([bar, baz]);
  326. assume(e.listeners('foo')).eql([]);
  327. assume(e._eventsCount).equals(1);
  328. assume(e.removeListener('bar', bar)).equals(e);
  329. assume(e.listeners('bar')).eql([baz]);
  330. assume(e._eventsCount).equals(1);
  331. assume(e.removeListener('bar', baz)).equals(e);
  332. assume(e.listeners('bar')).eql([]);
  333. assume(e._eventsCount).equals(0);
  334. e.on('foo', foo);
  335. e.on('foo', foo);
  336. e.on('bar', bar);
  337. assume(e.removeListener('foo', foo)).equals(e);
  338. assume(e.listeners('bar')).eql([bar]);
  339. assume(e.listeners('foo')).eql([]);
  340. assume(e._eventsCount).equals(1);
  341. });
  342. it('removes only the once listeners when using the once flag', function () {
  343. var e = new EventEmitter();
  344. function foo() {}
  345. e.on('foo', foo);
  346. assume(e.removeListener('foo', function () {}, undefined, true)).equals(e);
  347. assume(e.listeners('foo')).eql([foo]);
  348. assume(e._eventsCount).equals(1);
  349. assume(e.removeListener('foo', foo, undefined, true)).equals(e);
  350. assume(e.listeners('foo')).eql([foo]);
  351. assume(e._eventsCount).equals(1);
  352. assume(e.removeListener('foo', foo)).equals(e);
  353. assume(e.listeners('foo')).eql([]);
  354. assume(e._eventsCount).equals(0);
  355. e.once('foo', foo);
  356. e.on('foo', foo);
  357. assume(e.removeListener('foo', function () {}, undefined, true)).equals(e);
  358. assume(e.listeners('foo')).eql([foo, foo]);
  359. assume(e._eventsCount).equals(1);
  360. assume(e.removeListener('foo', foo, undefined, true)).equals(e);
  361. assume(e.listeners('foo')).eql([foo]);
  362. assume(e._eventsCount).equals(1);
  363. e.once('foo', foo);
  364. assume(e.removeListener('foo', foo)).equals(e);
  365. assume(e.listeners('foo')).eql([]);
  366. assume(e._eventsCount).equals(0);
  367. });
  368. it('removes only the listeners matching the correct context', function () {
  369. var context = { foo: 'bar' }
  370. , e = new EventEmitter();
  371. function foo() {}
  372. function bar() {}
  373. e.on('foo', foo, context);
  374. assume(e.removeListener('foo', function () {}, context)).equals(e);
  375. assume(e.listeners('foo')).eql([foo]);
  376. assume(e._eventsCount).equals(1);
  377. assume(e.removeListener('foo', foo, { baz: 'quux' })).equals(e);
  378. assume(e.listeners('foo')).eql([foo]);
  379. assume(e._eventsCount).equals(1);
  380. assume(e.removeListener('foo', foo, context)).equals(e);
  381. assume(e.listeners('foo')).eql([]);
  382. assume(e._eventsCount).equals(0);
  383. e.on('foo', foo, context);
  384. e.on('foo', bar);
  385. assume(e.removeListener('foo', foo, { baz: 'quux' })).equals(e);
  386. assume(e.listeners('foo')).eql([foo, bar]);
  387. assume(e._eventsCount).equals(1);
  388. assume(e.removeListener('foo', foo, context)).equals(e);
  389. assume(e.listeners('foo')).eql([bar]);
  390. assume(e._eventsCount).equals(1);
  391. e.on('foo', bar, context);
  392. assume(e.removeListener('foo', bar)).equals(e);
  393. assume(e.listeners('foo')).eql([]);
  394. assume(e._eventsCount).equals(0);
  395. });
  396. });
  397. describe('EventEmitter#removeAllListeners', function () {
  398. it('removes all events for the specified events', function () {
  399. var e = new EventEmitter();
  400. e.on('foo', function () { throw new Error('oops'); });
  401. e.on('foo', function () { throw new Error('oops'); });
  402. e.on('bar', function () { throw new Error('oops'); });
  403. e.on('aaa', function () { throw new Error('oops'); });
  404. assume(e.removeAllListeners('foo')).equals(e);
  405. assume(e.listeners('foo').length).equals(0);
  406. assume(e.listeners('bar').length).equals(1);
  407. assume(e.listeners('aaa').length).equals(1);
  408. assume(e._eventsCount).equals(2);
  409. assume(e.removeAllListeners('bar')).equals(e);
  410. assume(e._eventsCount).equals(1);
  411. assume(e.removeAllListeners('aaa')).equals(e);
  412. assume(e._eventsCount).equals(0);
  413. assume(e.emit('foo')).equals(false);
  414. assume(e.emit('bar')).equals(false);
  415. assume(e.emit('aaa')).equals(false);
  416. });
  417. it('just nukes the fuck out of everything', function () {
  418. var e = new EventEmitter();
  419. e.on('foo', function () { throw new Error('oops'); });
  420. e.on('foo', function () { throw new Error('oops'); });
  421. e.on('bar', function () { throw new Error('oops'); });
  422. e.on('aaa', function () { throw new Error('oops'); });
  423. assume(e.removeAllListeners()).equals(e);
  424. assume(e.listeners('foo').length).equals(0);
  425. assume(e.listeners('bar').length).equals(0);
  426. assume(e.listeners('aaa').length).equals(0);
  427. assume(e._eventsCount).equals(0);
  428. assume(e.emit('foo')).equals(false);
  429. assume(e.emit('bar')).equals(false);
  430. assume(e.emit('aaa')).equals(false);
  431. });
  432. });
  433. describe('EventEmitter#eventNames', function () {
  434. it('returns an empty array when there are no events', function () {
  435. var e = new EventEmitter();
  436. assume(e.eventNames()).eql([]);
  437. e.on('foo', function () {});
  438. e.removeAllListeners('foo');
  439. assume(e.eventNames()).eql([]);
  440. });
  441. it('returns an array listing the events that have listeners', function () {
  442. var e = new EventEmitter()
  443. , original;
  444. function bar() {}
  445. if (Object.getOwnPropertySymbols) {
  446. //
  447. // Monkey patch `Object.getOwnPropertySymbols()` to increase coverage
  448. // on Node.js > 0.10.
  449. //
  450. original = Object.getOwnPropertySymbols;
  451. Object.getOwnPropertySymbols = undefined;
  452. }
  453. e.on('foo', function () {});
  454. e.on('bar', bar);
  455. try {
  456. assume(e.eventNames()).eql(['foo', 'bar']);
  457. e.removeListener('bar', bar);
  458. assume(e.eventNames()).eql(['foo']);
  459. } catch (ex) {
  460. throw ex;
  461. } finally {
  462. if (original) Object.getOwnPropertySymbols = original;
  463. }
  464. });
  465. it('does not return inherited property identifiers', function () {
  466. var e = new EventEmitter();
  467. function Collection() {}
  468. Collection.prototype.foo = function () {
  469. return 'foo';
  470. };
  471. e._events = new Collection();
  472. assume(e._events.foo()).equal('foo');
  473. assume(e.eventNames()).eql([]);
  474. });
  475. if ('undefined' !== typeof Symbol) it('includes ES6 symbols', function () {
  476. var e = new EventEmitter()
  477. , s = Symbol('s');
  478. function foo() {}
  479. e.on('foo', foo);
  480. e.on(s, function () {});
  481. assume(e.eventNames()).eql(['foo', s]);
  482. e.removeListener('foo', foo);
  483. assume(e.eventNames()).eql([s]);
  484. });
  485. });
  486. });