Debian Codegraph @

closure-library/closure/goog/messaging/bufferedchannel_test.js

raw
1 // Copyright 2010 The Closure Library Authors. All Rights Reserved.
2 //
3 // Licensed under the Apache License, Version 2.0 (the "License");
4 // you may not use this file except in compliance with the License.
5 // You may obtain a copy of the License at
6 //
7 // http://www.apache.org/licenses/LICENSE-2.0
8 //
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS-IS" BASIS,
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 // See the License for the specific language governing permissions and
13 // limitations under the License.
14
15 goog.provide('goog.messaging.BufferedChannelTest');
16 goog.setTestOnly('goog.messaging.BufferedChannelTest');
17
18 goog.require('goog.debug.Console');
19 goog.require('goog.dom');
20 goog.require('goog.dom.TagName');
21 goog.require('goog.log');
22 goog.require('goog.log.Level');
23 goog.require('goog.messaging.BufferedChannel');
24 goog.require('goog.testing.MockClock');
25 goog.require('goog.testing.MockControl');
26 goog.require('goog.testing.async.MockControl');
27 goog.require('goog.testing.jsunit');
28 goog.require('goog.testing.messaging.MockMessageChannel');
29
30 var clock;
31 var messages = [
32 {serviceName: 'firstService', payload: 'firstPayload'},
33 {serviceName: 'secondService', payload: 'secondPayload'}
34 ];
35 var mockControl;
36 var asyncMockControl;
37
38 function setUpPage() {
39 if (goog.global.console) {
40 new goog.debug.Console().setCapturing(true);
41 }
42 var logger = goog.log.getLogger('goog.messaging');
43 logger.setLevel(goog.log.Level.ALL);
44 goog.log.addHandler(logger, function(logRecord) {
45 var msg = goog.dom.createDom(goog.dom.TagName.DIV);
46 msg.innerHTML = logRecord.getMessage();
47 goog.dom.appendChild(goog.dom.getElement('debug-div'), msg);
48 });
49 clock = new goog.testing.MockClock();
50 mockControl = new goog.testing.MockControl();
51 asyncMockControl = new goog.testing.async.MockControl(mockControl);
52 }
53
54
55 function setUp() {
56 clock.install();
57 }
58
59
60 function tearDown() {
61 clock.uninstall();
62 mockControl.$tearDown();
63 }
64
65
66 function assertMessageArraysEqual(ma1, ma2) {
67 assertEquals('message array lengths differ', ma1.length, ma2.length);
68 for (var i = 0; i < ma1.length; i++) {
69 assertEquals(
70 'message array serviceNames differ', ma1[i].serviceName,
71 ma2[i].serviceName);
72 assertEquals(
73 'message array payloads differ', ma1[i].payload, ma2[i].payload);
74 }
75 }
76
77
78 function testDelegationToWrappedChannel() {
79 var mockChannel = new goog.testing.messaging.MockMessageChannel(mockControl);
80 var channel = new goog.messaging.BufferedChannel(mockChannel);
81
82 channel.registerDefaultService(
83 asyncMockControl.asyncAssertEquals(
84 'default service should be delegated', 'defaultServiceName',
85 'default service payload'));
86 channel.registerService(
87 'normalServiceName',
88 asyncMockControl.asyncAssertEquals(
89 'normal service should be delegated', 'normal service payload'));
90 mockChannel.send(
91 goog.messaging.BufferedChannel.USER_CHANNEL_NAME_ + ':message',
92 'payload');
93
94 mockControl.$replayAll();
95 channel.peerReady_ = true; // Prevent buffering so we delegate send calls.
96 mockChannel.receive(
97 goog.messaging.BufferedChannel.USER_CHANNEL_NAME_ + ':defaultServiceName',
98 'default service payload');
99 mockChannel.receive(
100 goog.messaging.BufferedChannel.USER_CHANNEL_NAME_ + ':normalServiceName',
101 'normal service payload');
102 channel.send('message', 'payload');
103 mockControl.$verifyAll();
104 }
105
106
107 function testOptionalConnectCallbackExecutes() {
108 var mockChannel = new goog.testing.messaging.MockMessageChannel(mockControl);
109 var channel = new goog.messaging.BufferedChannel(mockChannel);
110 var mockConnectCb = mockControl.createFunctionMock('mockConnectCb');
111 mockConnectCb();
112
113 mockControl.$replayAll();
114 channel.connect(mockConnectCb);
115 mockControl.$verifyAll();
116 }
117
118
119 function testSendExceptionsInSendReadyPingStopsTimerAndReraises() {
120 var mockChannel = new goog.testing.messaging.MockMessageChannel(mockControl);
121 var channel = new goog.messaging.BufferedChannel(mockChannel);
122
123 var errorMessage = 'errorMessage';
124 mockChannel
125 .send(
126 goog.messaging.BufferedChannel.CONTROL_CHANNEL_NAME_ + ':' +
127 goog.messaging.BufferedChannel.PEER_READY_SERVICE_NAME_,
128 /* payload */ '')
129 .$throws(Error(errorMessage));
130 channel.timer_.enabled = true;
131
132 mockControl.$replayAll();
133 var exception = assertThrows(function() { channel.sendReadyPing_(); });
134 assertContains(errorMessage, exception.message);
135 assertFalse(channel.timer_.enabled);
136 mockControl.$verifyAll();
137 }
138
139
140 function testPollingIntervalDefaultAndOverride() {
141 var mockChannel = new goog.testing.messaging.MockMessageChannel(mockControl);
142 var channel = new goog.messaging.BufferedChannel(mockChannel);
143
144 assertEquals(
145 goog.messaging.BufferedChannel.DEFAULT_INTERVAL_MILLIS_,
146 channel.timer_.getInterval());
147 var interval = 100;
148 var longIntervalChannel = new goog.messaging.BufferedChannel(
149 new goog.testing.messaging.MockMessageChannel(mockControl), interval);
150 assertEquals(interval, longIntervalChannel.timer_.getInterval());
151 }
152
153
154 function testBidirectionalCommunicationBuffersUntilReadyPingsSucceed() {
155 var mockChannel1 = new goog.testing.messaging.MockMessageChannel(mockControl);
156 var mockChannel2 = new goog.testing.messaging.MockMessageChannel(mockControl);
157 var bufferedChannel1 = new goog.messaging.BufferedChannel(mockChannel1);
158 var bufferedChannel2 = new goog.messaging.BufferedChannel(mockChannel2);
159 mockChannel1
160 .send(
161 goog.messaging.BufferedChannel.CONTROL_CHANNEL_NAME_ +
162 ':setPeerReady_',
163 '')
164 .$does(function() { bufferedChannel2.setPeerReady_(''); });
165 mockChannel2
166 .send(
167 goog.messaging.BufferedChannel.CONTROL_CHANNEL_NAME_ +
168 ':setPeerReady_',
169 '1')
170 .$does(function() { bufferedChannel1.setPeerReady_('1'); });
171 mockChannel1
172 .send(
173 goog.messaging.BufferedChannel.CONTROL_CHANNEL_NAME_ +
174 ':setPeerReady_',
175 '1')
176 .$does(function() { bufferedChannel2.setPeerReady_('1'); });
177 mockChannel1.send(
178 goog.messaging.BufferedChannel.USER_CHANNEL_NAME_ + ':' +
179 messages[0].serviceName,
180 messages[0].payload);
181 mockChannel2.send(
182 goog.messaging.BufferedChannel.USER_CHANNEL_NAME_ + ':' +
183 messages[1].serviceName,
184 messages[1].payload);
185
186 mockControl.$replayAll();
187 bufferedChannel1.send(messages[0].serviceName, messages[0].payload);
188 bufferedChannel2.send(messages[1].serviceName, messages[1].payload);
189 assertMessageArraysEqual([messages[0]], bufferedChannel1.buffer_);
190 assertMessageArraysEqual([messages[1]], bufferedChannel2.buffer_);
191 // First tick causes setPeerReady_ to fire, which in turn flushes the buffers.
192 clock.tick(goog.messaging.BufferedChannel.DEFAULT_INTERVAL_MILLIS_);
193 assertEquals(bufferedChannel1.buffer_, null);
194 assertEquals(bufferedChannel2.buffer_, null);
195 // Now that peers are ready, a second tick causes no more sends.
196 clock.tick(goog.messaging.BufferedChannel.DEFAULT_INTERVAL_MILLIS_);
197 mockControl.$verifyAll();
198 }
199
200
201 function testBidirectionalCommunicationReconnectsAfterOneSideRestarts() {
202 var mockChannel1 = new goog.testing.messaging.MockMessageChannel(mockControl);
203 var mockChannel2 = new goog.testing.messaging.MockMessageChannel(mockControl);
204 var mockChannel3 = new goog.testing.messaging.MockMessageChannel(mockControl);
205 var bufferedChannel1 = new goog.messaging.BufferedChannel(mockChannel1);
206 var bufferedChannel2 = new goog.messaging.BufferedChannel(mockChannel2);
207 var bufferedChannel3 = new goog.messaging.BufferedChannel(mockChannel3);
208
209 // First tick
210 mockChannel1
211 .send(
212 goog.messaging.BufferedChannel.CONTROL_CHANNEL_NAME_ +
213 ':setPeerReady_',
214 '')
215 .$does(function() { bufferedChannel2.setPeerReady_(''); });
216 mockChannel2
217 .send(
218 goog.messaging.BufferedChannel.CONTROL_CHANNEL_NAME_ +
219 ':setPeerReady_',
220 '1')
221 .$does(function() { bufferedChannel1.setPeerReady_('1'); });
222 mockChannel1
223 .send(
224 goog.messaging.BufferedChannel.CONTROL_CHANNEL_NAME_ +
225 ':setPeerReady_',
226 '1')
227 .$does(function() { bufferedChannel2.setPeerReady_('1'); });
228 mockChannel3.send(
229 goog.messaging.BufferedChannel.CONTROL_CHANNEL_NAME_ + ':setPeerReady_',
230 ''); // pretend it's not ready to connect yet
231
232 // Second tick
233 mockChannel3
234 .send(
235 goog.messaging.BufferedChannel.CONTROL_CHANNEL_NAME_ +
236 ':setPeerReady_',
237 '')
238 .$does(function() { bufferedChannel1.setPeerReady_(''); });
239
240 // Third tick
241 mockChannel1
242 .send(
243 goog.messaging.BufferedChannel.CONTROL_CHANNEL_NAME_ +
244 ':setPeerReady_',
245 '1')
246 .$does(function() { bufferedChannel3.setPeerReady_('1'); });
247 mockChannel3
248 .send(
249 goog.messaging.BufferedChannel.CONTROL_CHANNEL_NAME_ +
250 ':setPeerReady_',
251 '1')
252 .$does(function() { bufferedChannel1.setPeerReady_('1'); });
253
254 mockChannel1.send(
255 goog.messaging.BufferedChannel.USER_CHANNEL_NAME_ + ':' +
256 messages[0].serviceName,
257 messages[0].payload);
258 mockChannel3.send(
259 goog.messaging.BufferedChannel.USER_CHANNEL_NAME_ + ':' +
260 messages[1].serviceName,
261 messages[1].payload);
262
263 mockControl.$replayAll();
264 // First tick causes setPeerReady_ to fire, which sets up the connection
265 // between channels 1 and 2.
266 clock.tick(goog.messaging.BufferedChannel.DEFAULT_INTERVAL_MILLIS_);
267 assertTrue(bufferedChannel1.peerReady_);
268 assertTrue(bufferedChannel2.peerReady_);
269 // Now pretend that channel 2 went down and was replaced by channel 3, which
270 // is trying to connect with channel 1.
271 clock.tick(goog.messaging.BufferedChannel.DEFAULT_INTERVAL_MILLIS_);
272 assertTrue(bufferedChannel1.peerReady_);
273 clock.tick(goog.messaging.BufferedChannel.DEFAULT_INTERVAL_MILLIS_);
274 assertTrue(bufferedChannel3.peerReady_);
275 bufferedChannel1.send(messages[0].serviceName, messages[0].payload);
276 bufferedChannel3.send(messages[1].serviceName, messages[1].payload);
277 // All timers stopped, nothing happens on the fourth tick.
278 clock.tick(goog.messaging.BufferedChannel.DEFAULT_INTERVAL_MILLIS_);
279 mockControl.$verifyAll();
280 }