aboutsummaryrefslogtreecommitdiff
path: root/contexts/data/lib/closure-library/closure/goog/pubsub/pubsub_test.html
blob: d2bd52b989e6c44b52eb2ad4ee3890bf6c2199aa (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
<!DOCTYPE html>
<html>
<!--
Copyright 2007 The Closure Library Authors. All Rights Reserved.

Use of this source code is governed by the Apache License, Version 2.0.
See the COPYING file for details.
-->
<!--
-->
<head>
<meta http-equiv="X-UA-Compatible" content="IE=edge">
  <title>Closure Unit Tests - goog.pubsub.PubSub</title>
  <script src="../base.js"></script>
  <script>
    goog.require('goog.array');
    goog.require('goog.pubsub.PubSub');
    goog.require('goog.testing.jsunit');
  </script>
</head>
<body>
  <script>
    var pubsub;

    function setUp() {
      pubsub = new goog.pubsub.PubSub();
    }

    function tearDown() {
      pubsub.dispose();
    }

    function testConstructor() {
      assertNotNull('PubSub instance must not be null', pubsub);
      assertTrue('PubSub instance must have the expected type',
          pubsub instanceof goog.pubsub.PubSub);
    }

    function testDispose() {
      assertFalse('PubSub instance must not have been disposed of',
          pubsub.isDisposed());
      pubsub.dispose();
      assertTrue('PubSub instance must have been disposed of',
          pubsub.isDisposed());
    }

    function testSubscribeUnsubscribe() {
      function foo1() {
      }
      function bar1() {
      }
      function foo2() {
      }
      function bar2() {
      }

      assertEquals('Topic "foo" must not have any subscribers', 0,
          pubsub.getCount('foo'));
      assertEquals('Topic "bar" must not have any subscribers', 0,
          pubsub.getCount('bar'));

      pubsub.subscribe("foo", foo1);
      assertEquals('Topic "foo" must have 1 subscriber', 1,
          pubsub.getCount('foo'));
      assertEquals('Topic "bar" must not have any subscribers', 0,
          pubsub.getCount('bar'));

      pubsub.subscribe("bar", bar1);
      assertEquals('Topic "foo" must have 1 subscriber', 1,
          pubsub.getCount('foo'));
      assertEquals('Topic "bar" must have 1 subscriber', 1,
          pubsub.getCount('bar'));

      pubsub.subscribe("foo", foo2);
      assertEquals('Topic "foo" must have 2 subscribers', 2,
          pubsub.getCount('foo'));
      assertEquals('Topic "bar" must have 1 subscriber', 1,
          pubsub.getCount('bar'));

      pubsub.subscribe("bar", bar2);
      assertEquals('Topic "foo" must have 2 subscribers', 2,
          pubsub.getCount('foo'));
      assertEquals('Topic "bar" must have 2 subscribers', 2,
          pubsub.getCount('bar'));

      assertTrue(pubsub.unsubscribe("foo", foo1));
      assertEquals('Topic "foo" must have 1 subscriber', 1,
          pubsub.getCount('foo'));
      assertEquals('Topic "bar" must have 2 subscribers', 2,
          pubsub.getCount('bar'));

      assertTrue(pubsub.unsubscribe("foo", foo2));
      assertEquals('Topic "foo" must have no subscribers', 0,
          pubsub.getCount('foo'));
      assertEquals('Topic "bar" must have 2 subscribers', 2,
          pubsub.getCount('bar'));

      assertTrue(pubsub.unsubscribe("bar", bar1));
      assertEquals('Topic "foo" must have no subscribers', 0,
          pubsub.getCount('foo'));
      assertEquals('Topic "bar" must have 1 subscriber', 1,
          pubsub.getCount('bar'));

      assertTrue(pubsub.unsubscribe("bar", bar2));
      assertEquals('Topic "foo" must have no subscribers', 0,
          pubsub.getCount('foo'));
      assertEquals('Topic "bar" must have no subscribers', 0,
          pubsub.getCount('bar'));

      assertFalse('Unsubscribing a nonexistent topic must return false',
          pubsub.unsubscribe("baz", foo1));

      assertFalse('Unsubscribing a nonexistent function must return false',
          pubsub.unsubscribe("foo", function() {}));
    }

    function testSubscribeUnsubscribeWithContext() {
      function foo() {
      }
      function bar() {
      }

      var contextA = {};
      var contextB = {};

      assertEquals('Topic "X" must not have any subscribers', 0,
          pubsub.getCount('X'));

      pubsub.subscribe('X', foo, contextA);
      assertEquals('Topic "X" must have 1 subscriber', 1,
          pubsub.getCount('X'));

      pubsub.subscribe('X', bar);
      assertEquals('Topic "X" must have 2 subscribers', 2,
          pubsub.getCount('X'));

      pubsub.subscribe('X', bar, contextB);
      assertEquals('Topic "X" must have 3 subscribers', 3,
          pubsub.getCount('X'));

      assertFalse('Unknown function/context combination return false',
          pubsub.unsubscribe('X', foo, contextB));

      assertTrue(pubsub.unsubscribe('X', foo, contextA));
      assertEquals('Topic "X" must have 2 subscribers', 2,
          pubsub.getCount('X'));

      assertTrue(pubsub.unsubscribe('X', bar));
      assertEquals('Topic "X" must have 1 subscriber', 1,
          pubsub.getCount('X'));

      assertTrue(pubsub.unsubscribe('X', bar, contextB));
      assertEquals('Topic "X" must have no subscribers', 0,
          pubsub.getCount('X'));
    }

    function testSubscribeOnce() {
      var called, context;

      called = false;
      pubsub.subscribeOnce('someTopic', function() {
        called = true;
      });
      assertEquals('Topic must have one subscriber', 1,
          pubsub.getCount('someTopic'));
      assertFalse('Subscriber must not have been called yet', called);

      pubsub.publish('someTopic');
      assertEquals('Topic must have no subscribers', 0,
          pubsub.getCount('someTopic'));
      assertTrue('Subscriber must have been called', called);

      context = {called: false};
      pubsub.subscribeOnce('someTopic', function() {
        this.called = true;
      }, context);
      assertEquals('Topic must have one subscriber', 1,
          pubsub.getCount('someTopic'));
      assertFalse('Subscriber must not have been called yet', context.called);

      pubsub.publish('someTopic');
      assertEquals('Topic must have no subscribers', 0,
          pubsub.getCount('someTopic'));
      assertTrue('Subscriber must have been called', context.called);

      context = {called: false, value: 0};
      pubsub.subscribeOnce('someTopic', function(value) {
        this.called = true;
        this.value = value;
      }, context);
      assertEquals('Topic must have one subscriber', 1,
          pubsub.getCount('someTopic'));
      assertFalse('Subscriber must not have been called yet', context.called);
      assertEquals('Value must have expected value', 0, context.value);

      pubsub.publish('someTopic', 17);
      assertEquals('Topic must have no subscribers', 0,
          pubsub.getCount('someTopic'));
      assertTrue('Subscriber must have been called', context.called);
      assertEquals('Value must have been updated', 17, context.value);
    }

    function testSubscribeOnce_boundFn() {
      var context = {called: false, value: 0};

      function subscriber(value) {
        this.called = true;
        this.value = value;
      }

      pubsub.subscribeOnce('someTopic', goog.bind(subscriber, context));
      assertEquals('Topic must have one subscriber', 1,
          pubsub.getCount('someTopic'));
      assertFalse('Subscriber must not have been called yet', context.called);
      assertEquals('Value must have expected value', 0, context.value);

      pubsub.publish('someTopic', 17);
      assertEquals('Topic must have no subscribers', 0,
          pubsub.getCount('someTopic'));
      assertTrue('Subscriber must have been called', context.called);
      assertEquals('Value must have been updated', 17, context.value);
    }

    function testSubscribeOnce_partialFn() {
      var called = false;
      var value = 0;

      function subscriber(hasBeenCalled, newValue) {
        called = hasBeenCalled;
        value = newValue;
      }

      pubsub.subscribeOnce('someTopic', goog.partial(subscriber, true));
      assertEquals('Topic must have one subscriber', 1,
          pubsub.getCount('someTopic'));
      assertFalse('Subscriber must not have been called yet', called);
      assertEquals('Value must have expected value', 0, value);

      pubsub.publish('someTopic', 17);
      assertEquals('Topic must have no subscribers', 0,
          pubsub.getCount('someTopic'));
      assertTrue('Subscriber must have been called', called);
      assertEquals('Value must have been updated', 17, value);
    }

    function testSelfResubscribe() {
      var value = null;

      function resubscribe(iteration, newValue) {
        pubsub.subscribeOnce('someTopic',
            goog.partial(resubscribe, iteration + 1));
        value = newValue + ':' + iteration;
      }

      pubsub.subscribeOnce('someTopic', goog.partial(resubscribe, 0));
      assertEquals('Topic must have 1 subscriber', 1,
          pubsub.getCount('someTopic'));
      assertNull('Value must be null', value);

      pubsub.publish('someTopic', 'foo');
      assertEquals('Topic must have 1 subscriber', 1,
          pubsub.getCount('someTopic'));
      assertEquals('Pubsub must not have any pending unsubscribe keys', 0,
          pubsub.pendingKeys_.length);
      assertEquals('Value be as expected', 'foo:0', value);

      pubsub.publish('someTopic', 'bar');
      assertEquals('Topic must have 1 subscriber', 1,
          pubsub.getCount('someTopic'));
      assertEquals('Pubsub must not have any pending unsubscribe keys', 0,
          pubsub.pendingKeys_.length);
      assertEquals('Value be as expected', 'bar:1', value);

      pubsub.publish('someTopic', 'baz');
      assertEquals('Topic must have 1 subscriber', 1,
          pubsub.getCount('someTopic'));
      assertEquals('Pubsub must not have any pending unsubscribe keys', 0,
          pubsub.pendingKeys_.length);
      assertEquals('Value be as expected', 'baz:2', value);
    }

    function testUnsubscribeByKey() {
      var key1, key2, key3;

      key1 = pubsub.subscribe('X', function() {});
      key2 = pubsub.subscribe('Y', function() {});

      assertEquals('Topic "X" must have 1 subscriber', 1,
          pubsub.getCount('X'));
      assertEquals('Topic "Y" must have 1 subscriber', 1,
          pubsub.getCount('Y'));
      assertNotEquals('Subscription keys must be distinct', key1, key2);

      pubsub.unsubscribeByKey(key1);
      assertEquals('Topic "X" must have no subscribers', 0,
          pubsub.getCount('X'));
      assertEquals('Topic "Y" must have 1 subscriber', 1,
          pubsub.getCount('Y'));

      key3 = pubsub.subscribe('X', function() {});
      assertEquals('Topic "X" must have 1 subscriber', 1,
          pubsub.getCount('X'));
      assertEquals('Topic "Y" must have 1 subscriber', 1,
          pubsub.getCount('Y'));
      assertNotEquals('Subscription keys must be distinct', key1, key3);
      assertNotEquals('Subscription keys must be distinct', key2, key3);

      pubsub.unsubscribeByKey(key1); // Obsolete key; should be no-op.
      assertEquals('Topic "X" must have 1 subscriber', 1,
          pubsub.getCount('X'));
      assertEquals('Topic "Y" must have 1 subscriber', 1,
          pubsub.getCount('Y'));

      pubsub.unsubscribeByKey(key2);
      assertEquals('Topic "X" must have 1 subscriber', 1,
          pubsub.getCount('X'));
      assertEquals('Topic "Y" must have no subscribers', 0,
          pubsub.getCount('Y'));

      pubsub.unsubscribeByKey(key3);
      assertEquals('Topic "X" must have no subscribers', 0,
          pubsub.getCount('X'));
      assertEquals('Topic "Y" must have no subscribers', 0,
          pubsub.getCount('Y'));
    }

    function testSubscribeUnsubscribeMultiple() {
      function foo() {
      }
      function bar() {
      }

      var context = {};

      assertEquals('Pubsub channel must not have any subscribers', 0,
          pubsub.getCount());

      assertEquals('Topic "X" must not have any subscribers', 0,
          pubsub.getCount('X'));
      assertEquals('Topic "Y" must not have any subscribers', 0,
          pubsub.getCount('Y'));
      assertEquals('Topic "Z" must not have any subscribers', 0,
          pubsub.getCount('Z'));

      goog.array.forEach(['X', 'Y', 'Z'], function(topic) {
        pubsub.subscribe(topic, foo);
      });
      assertEquals('Topic "X" must have 1 subscriber', 1,
          pubsub.getCount('X'));
      assertEquals('Topic "Y" must have 1 subscriber', 1,
          pubsub.getCount('Y'));
      assertEquals('Topic "Z" must have 1 subscriber', 1,
          pubsub.getCount('Z'));

      goog.array.forEach(['X', 'Y', 'Z'], function(topic) {
        pubsub.subscribe(topic, bar, context);
      });
      assertEquals('Topic "X" must have 2 subscribers', 2,
          pubsub.getCount('X'));
      assertEquals('Topic "Y" must have 2 subscribers', 2,
          pubsub.getCount('Y'));
      assertEquals('Topic "Z" must have 2 subscribers', 2,
          pubsub.getCount('Z'));

      assertEquals('Pubsub channel must have a total of 6 subscribers', 6,
          pubsub.getCount());

      goog.array.forEach(['X', 'Y', 'Z'], function(topic) {
        pubsub.unsubscribe(topic, foo);
      });
      assertEquals('Topic "X" must have 1 subscriber', 1,
          pubsub.getCount('X'));
      assertEquals('Topic "Y" must have 1 subscriber', 1,
          pubsub.getCount('Y'));
      assertEquals('Topic "Z" must have 1 subscriber', 1,
          pubsub.getCount('Z'));

      goog.array.forEach(['X', 'Y', 'Z'], function(topic) {
        pubsub.unsubscribe(topic, bar, context);
      });
      assertEquals('Topic "X" must not have any subscribers', 0,
          pubsub.getCount('X'));
      assertEquals('Topic "Y" must not have any subscribers', 0,
          pubsub.getCount('Y'));
      assertEquals('Topic "Z" must not have any subscribers', 0,
          pubsub.getCount('Z'));

      assertEquals('Pubsub channel must not have any subscribers', 0,
          pubsub.getCount());
    }

    function testPublish() {
      var context = {};
      var fooCalled = false;
      var barCalled = false;

      function foo(x, y) {
        fooCalled = true;
        assertEquals('x must have expected value', 'x', x);
        assertEquals('y must have expected value', 'y', y);
      }

      function bar(x, y) {
        barCalled = true;
        assertEquals('Context must have expected value', context, this);
        assertEquals('x must have expected value', 'x', x);
        assertEquals('y must have expected value', 'y', y);
      }

      pubsub.subscribe('someTopic', foo);
      pubsub.subscribe('someTopic', bar, context);

      assertTrue(pubsub.publish('someTopic', 'x', 'y'));
      assertTrue('foo() must have been called', fooCalled);
      assertTrue('bar() must have been called', barCalled);

      fooCalled = false;
      barCalled = false;
      assertTrue(pubsub.unsubscribe('someTopic', foo));

      assertTrue(pubsub.publish('someTopic', 'x', 'y'));
      assertFalse('foo() must not have been called', fooCalled);
      assertTrue('bar() must have been called', barCalled);

      fooCalled = false;
      barCalled = false;
      pubsub.subscribe('differentTopic', foo);

      assertTrue(pubsub.publish('someTopic', 'x', 'y'));
      assertFalse('foo() must not have been called', fooCalled);
      assertTrue('bar() must have been called', barCalled);
    }

    function testPublishEmptyTopic() {
      var fooCalled = false;
      function foo() {
        fooCalled = true;
      }

      assertFalse('Publishing to nonexistent topic must return false',
          pubsub.publish('someTopic'));

      pubsub.subscribe('someTopic', foo);
      assertTrue('Publishing to topic with subscriber must return true',
          pubsub.publish('someTopic'));
      assertTrue('Foo must have been called', fooCalled);

      pubsub.unsubscribe('someTopic', foo);
      fooCalled = false;
      assertFalse('Publishing to topic without subscribers must return false',
          pubsub.publish('someTopic'));
      assertFalse('Foo must nothave been called', fooCalled);
    }

    function testSubscribeWhilePublishing() {
      // It's OK for a subscriber to add a new subscriber to its own topic,
      // but the newly added subscriber shouldn't be called until the next
      // publish cycle.

      var firstCalled = false;
      var secondCalled = false;

      pubsub.subscribe('someTopic', function() {
        pubsub.subscribe('someTopic', function() {
          secondCalled = true;
        });
        firstCalled = true;
      });
      assertEquals('Topic must have one subscriber', 1,
          pubsub.getCount('someTopic'));
      assertFalse('No subscriber must have been called yet',
          firstCalled || secondCalled);

      pubsub.publish('someTopic');
      assertEquals('Topic must have two subscribers', 2,
          pubsub.getCount('someTopic'));
      assertTrue('The first subscriber must have been called',
          firstCalled);
      assertFalse('The second subscriber must not have been called yet',
          secondCalled);

      pubsub.publish('someTopic');
      assertEquals('Topic must have three subscribers', 3,
          pubsub.getCount('someTopic'));
      assertTrue('The first subscriber must have been called',
          firstCalled);
      assertTrue('The second subscriber must also have been called',
          secondCalled);
    }

    function testUnsubscribeWhilePublishing() {
      // It's OK for a subscriber to unsubscribe another subscriber from its
      // own topic, but the subscriber in question won't actually be removed
      // until after publishing is complete.

      var firstCalled = false;
      var secondCalled = false;
      var thirdCalled = false;

      function first() {
        assertFalse('unsubscribe() must return false during publishing',
            pubsub.unsubscribe('X', second));
        assertEquals('Topic "X" must still have 3 subscribers', 3,
            pubsub.getCount('X'));
        firstCalled = true;
      }
      pubsub.subscribe('X', first);

      function second() {
        assertEquals('Topic "X" must still have 3 subscribers', 3,
            pubsub.getCount('X'));
        secondCalled = true;
      }
      pubsub.subscribe('X', second);

      function third() {
        assertFalse('unsubscribe() must return false during publishing',
            pubsub.unsubscribe('X', first));
        assertEquals('Topic "X" must still have 3 subscribers', 3,
            pubsub.getCount('X'));
        thirdCalled = true;
      }
      pubsub.subscribe('X', third);

      assertEquals('Topic "X" must have 3 subscribers', 3,
          pubsub.getCount('X'));
      assertFalse('No subscribers must have been called yet',
          firstCalled || secondCalled || thirdCalled);

      assertTrue(pubsub.publish('X'));
      assertTrue('First function must have been called', firstCalled);
      assertTrue('Second function must have been called', secondCalled);
      assertTrue('Third function must have been called', thirdCalled);
      assertEquals('Topic "X" must have 1 subscriber after publishing', 1,
          pubsub.getCount('X'));
      assertEquals('PubSub must not have any subscriptions pending removal', 0,
          pubsub.pendingKeys_.length);
    }

    function testUnsubscribeSelfWhilePublishing() {
      // It's OK for a subscriber to unsubscribe itself, but it won't actually
      // be removed until after publishing is complete.

      var selfDestructCalled = false;

      function selfDestruct() {
        assertFalse('unsubscribe() must return false during publishing',
            pubsub.unsubscribe('someTopic', arguments.callee));
        assertEquals('Topic must still have 1 subscriber', 1,
            pubsub.getCount('someTopic'));
        selfDestructCalled = true;
      }

      pubsub.subscribe('someTopic', selfDestruct);
      assertEquals('Topic must have 1 subscriber', 1,
          pubsub.getCount('someTopic'));
      assertFalse('selfDestruct() must not have been called yet',
          selfDestructCalled);

      pubsub.publish('someTopic');
      assertTrue('selfDestruct() must have been called', selfDestructCalled);
      assertEquals('Topic must have no subscribers after publishing', 0,
          pubsub.getCount('someTopic'));
      assertEquals('PubSub must not have any subscriptions pending removal', 0,
          pubsub.pendingKeys_.length);
    }

    function testPublishReturnValue() {
      pubsub.subscribe('X', function() {
        pubsub.unsubscribe('X', arguments.callee);
      });
      assertTrue('publish() must return true even if the only subscriber ' +
          'removes itself during publishing', pubsub.publish('X'));
    }

    function testNestedPublish() {
      var x1 = false;
      var x2 = false;
      var y1 = false;
      var y2 = false;

      pubsub.subscribe('X', function() {
        pubsub.publish('Y');
        pubsub.unsubscribe('X', arguments.callee);
        x1 = true;
      });

      pubsub.subscribe('X', function() {
        x2 = true;
      });

      pubsub.subscribe('Y', function() {
        pubsub.unsubscribe('Y', arguments.callee);
        y1 = true;
      });

      pubsub.subscribe('Y', function() {
        y2 = true;
      });

      pubsub.publish('X');

      assertTrue('x1 must be true', x1);
      assertTrue('x2 must be true', x2);
      assertTrue('y1 must be true', y1);
      assertTrue('y2 must be true', y2);
    }

    function testClear() {
      function fn() {
      }

      goog.array.forEach(['W', 'X', 'Y', 'Z'], function(topic) {
        pubsub.subscribe(topic, fn);
      });
      assertEquals('Pubsub channel must have 4 subscribers', 4,
          pubsub.getCount());

      pubsub.clear('W');
      assertEquals('Pubsub channel must have 3 subscribers', 3,
          pubsub.getCount());

      goog.array.forEach(['X', 'Y'], function(topic) {
        pubsub.clear(topic);
      });
      assertEquals('Pubsub channel must have 1 subscriber', 1,
          pubsub.getCount());

      pubsub.clear();
      assertEquals('Pubsub channel must have no subscribers', 0,
          pubsub.getCount());
    }
  </script>
</body>
</html>