-
Notifications
You must be signed in to change notification settings - Fork 371
/
pusher_connection.js
489 lines (405 loc) · 15.2 KB
/
pusher_connection.js
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
;(function() {
var Pusher = this.Pusher;
var machineTransitions = {
'initialized': ['waiting', 'failed'],
'waiting': ['connecting', 'permanentlyClosed'],
'connecting': ['open', 'permanentlyClosing', 'impermanentlyClosing', 'waiting'],
'open': ['connected', 'permanentlyClosing', 'impermanentlyClosing', 'waiting'],
'connected': ['permanentlyClosing', 'waiting'],
'impermanentlyClosing': ['waiting', 'permanentlyClosing'],
'permanentlyClosing': ['permanentlyClosed'],
'permanentlyClosed': ['waiting'],
'failed': ['permanentlyClosed'],
};
// Amount to add to time between connection attemtpts per failed attempt.
var UNSUCCESSFUL_CONNECTION_ATTEMPT_ADDITIONAL_WAIT = 2000;
var UNSUCCESSFUL_OPEN_ATTEMPT_ADDITIONAL_TIMEOUT = 2000;
var UNSUCCESSFUL_CONNECTED_ATTEMPT_ADDITIONAL_TIMEOUT = 2000;
var MAX_CONNECTION_ATTEMPT_WAIT = 5 * UNSUCCESSFUL_CONNECTION_ATTEMPT_ADDITIONAL_WAIT;
var MAX_OPEN_ATTEMPT_TIMEOUT = 5 * UNSUCCESSFUL_OPEN_ATTEMPT_ADDITIONAL_TIMEOUT;
var MAX_CONNECTED_ATTEMPT_TIMEOUT = 5 * UNSUCCESSFUL_CONNECTED_ATTEMPT_ADDITIONAL_TIMEOUT;
function resetConnectionParameters(connection) {
connection.connectionWait = 0;
if (Pusher.TransportType === 'flash') {
// Flash needs a bit more time
connection.openTimeout = 5000;
} else {
connection.openTimeout = 2000;
}
connection.connectedTimeout = 2000;
connection.connectionSecure = connection.compulsorySecure;
connection.connectionAttempts = 0;
}
function Connection(key, options) {
var self = this;
Pusher.EventsDispatcher.call(this);
this.options = Pusher.Util.extend({encrypted: false}, options);
this.netInfo = new Pusher.NetInfo();
this.netInfo.bind('online', function(){
if (self._machine.is('waiting')) {
self._machine.transition('connecting');
updateState('connecting');
}
});
this.netInfo.bind('offline', function() {
if (self._machine.is('connected')) {
// These are for Chrome 15, which ends up
// having two sockets hanging around.
self.socket.onclose = undefined;
self.socket.onmessage = undefined;
self.socket.onerror = undefined;
self.socket.onopen = undefined;
self.socket.close();
self.socket = undefined;
self._machine.transition('waiting');
}
});
// define the state machine that runs the connection
this._machine = new Pusher.Machine('initialized', machineTransitions, {
initializedPre: function() {
self.compulsorySecure = self.options.encrypted;
self.key = key;
self.socket = null;
self.socket_id = null;
self.state = 'initialized';
},
waitingPre: function() {
if (self.connectionWait > 0) {
self.emit('connecting_in', self.connectionWait);
}
if (self.netInfo.isOnLine() && self.connectionAttempts <= 4) {
updateState('connecting');
} else {
updateState('unavailable');
}
// When in the unavailable state we attempt to connect, but don't
// broadcast that fact
if (self.netInfo.isOnLine()) {
self._waitingTimer = setTimeout(function() {
self._machine.transition('connecting');
}, connectionDelay());
}
},
waitingExit: function() {
clearTimeout(self._waitingTimer);
},
connectingPre: function() {
// Case that a user manages to get to the connecting
// state even when offline.
if (self.netInfo.isOnLine() === false) {
self._machine.transition('waiting');
updateState('unavailable');
return;
}
var url = formatURL(self.key, self.connectionSecure);
Pusher.debug('Connecting', url);
self.socket = new Pusher.Transport(url);
// now that the socket connection attempt has been started,
// set up the callbacks fired by the socket for different outcomes
self.socket.onopen = ws_onopen;
self.socket.onclose = transitionToWaiting;
self.socket.onerror = ws_onError;
// allow time to get ws_onOpen, otherwise close socket and try again
self._connectingTimer = setTimeout(TransitionToImpermanentlyClosing, self.openTimeout);
},
connectingExit: function() {
clearTimeout(self._connectingTimer);
self.socket.onopen = undefined; // unbind to avoid open events that are no longer relevant
},
connectingToWaiting: function() {
updateConnectionParameters();
// FUTURE: update only ssl
},
connectingToImpermanentlyClosing: function() {
updateConnectionParameters();
// FUTURE: update only timeout
},
openPre: function() {
self.socket.onmessage = ws_onMessageOpen;
self.socket.onerror = ws_onError;
self.socket.onclose = transitionToWaiting;
// allow time to get connected-to-Pusher message, otherwise close socket, try again
self._openTimer = setTimeout(TransitionToImpermanentlyClosing, self.connectedTimeout);
},
openExit: function() {
clearTimeout(self._openTimer);
self.socket.onmessage = undefined; // unbind to avoid messages that are no longer relevant
},
openToWaiting: function() {
updateConnectionParameters();
},
openToImpermanentlyClosing: function() {
updateConnectionParameters();
},
connectedPre: function(socket_id) {
self.socket_id = socket_id;
self.socket.onmessage = ws_onMessageConnected;
self.socket.onerror = ws_onError;
self.socket.onclose = transitionToWaiting;
resetConnectionParameters(self);
self.connectedAt = new Date().getTime();
resetActivityCheck();
},
connectedPost: function() {
updateState('connected');
},
connectedExit: function() {
stopActivityCheck();
updateState('disconnected');
},
impermanentlyClosingPost: function() {
if (self.socket) {
self.socket.onclose = transitionToWaiting;
self.socket.close();
}
},
permanentlyClosingPost: function() {
if (self.socket) {
self.socket.onclose = function() {
resetConnectionParameters(self);
self._machine.transition('permanentlyClosed');
};
self.socket.close();
} else {
resetConnectionParameters(self);
self._machine.transition('permanentlyClosed');
}
},
failedPre: function() {
updateState('failed');
Pusher.debug('WebSockets are not available in this browser.');
},
permanentlyClosedPost: function() {
updateState('disconnected');
}
});
/*-----------------------------------------------
-----------------------------------------------*/
function updateConnectionParameters() {
if (self.connectionWait < MAX_CONNECTION_ATTEMPT_WAIT) {
self.connectionWait += UNSUCCESSFUL_CONNECTION_ATTEMPT_ADDITIONAL_WAIT;
}
if (self.openTimeout < MAX_OPEN_ATTEMPT_TIMEOUT) {
self.openTimeout += UNSUCCESSFUL_OPEN_ATTEMPT_ADDITIONAL_TIMEOUT;
}
if (self.connectedTimeout < MAX_CONNECTED_ATTEMPT_TIMEOUT) {
self.connectedTimeout += UNSUCCESSFUL_CONNECTED_ATTEMPT_ADDITIONAL_TIMEOUT;
}
if (self.compulsorySecure !== true) {
self.connectionSecure = !self.connectionSecure;
}
self.connectionAttempts++;
}
function formatURL(key, isSecure) {
var port = Pusher.ws_port;
var protocol = 'ws://';
// Always connect with SSL if the current page has
// been loaded via HTTPS.
//
// FUTURE: Always connect using SSL.
//
if (isSecure || document.location.protocol === 'https:') {
port = Pusher.wss_port;
protocol = 'wss://';
}
var flash = (Pusher.TransportType === "flash") ? "true" : "false";
return protocol + Pusher.host + ':' + port + '/app/' + key + '?protocol=5&client=js'
+ '&version=' + Pusher.VERSION
+ '&flash=' + flash;
}
// callback for close and retry. Used on timeouts.
function TransitionToImpermanentlyClosing() {
self._machine.transition('impermanentlyClosing');
}
function resetActivityCheck() {
if (self._activityTimer) { clearTimeout(self._activityTimer); }
// Send ping after inactivity
self._activityTimer = setTimeout(function() {
self.send_event('pusher:ping', {})
// Wait for pong response
self._activityTimer = setTimeout(function() {
self.socket.close();
}, (self.options.pong_timeout || Pusher.pong_timeout))
}, (self.options.activity_timeout || Pusher.activity_timeout))
}
function stopActivityCheck() {
if (self._activityTimer) { clearTimeout(self._activityTimer); }
}
// Returns the delay before the next connection attempt should be made
//
// This function guards against attempting to connect more frequently than
// once every second
//
function connectionDelay() {
var delay = self.connectionWait;
if (delay === 0) {
if (self.connectedAt) {
var t = 1000;
var connectedFor = new Date().getTime() - self.connectedAt;
if (connectedFor < t) {
delay = t - connectedFor;
}
}
}
return delay;
}
/*-----------------------------------------------
WebSocket Callbacks
-----------------------------------------------*/
// no-op, as we only care when we get pusher:connection_established
function ws_onopen() {
self._machine.transition('open');
};
function handleCloseCode(code, message) {
// first inform the end-developer of this error
self.emit('error', {type: 'PusherError', data: {code: code, message: message}});
if (code === 4000) {
// SSL only app
self.compulsorySecure = true;
self.connectionSecure = true;
self.options.encrypted = true;
TransitionToImpermanentlyClosing();
} else if (code < 4100) {
// Permentently close connection
self._machine.transition('permanentlyClosing')
} else if (code < 4200) {
// Backoff before reconnecting
self.connectionWait = 1000;
self._machine.transition('waiting')
} else if (code < 4300) {
// Reconnect immediately
TransitionToImpermanentlyClosing();
} else {
// Unknown error
self._machine.transition('permanentlyClosing')
}
}
function ws_onMessageOpen(event) {
var params = parseWebSocketEvent(event);
if (params !== undefined) {
if (params.event === 'pusher:connection_established') {
self._machine.transition('connected', params.data.socket_id);
} else if (params.event === 'pusher:error') {
handleCloseCode(params.data.code, params.data.message)
}
}
}
function ws_onMessageConnected(event) {
resetActivityCheck();
var params = parseWebSocketEvent(event);
if (params !== undefined) {
Pusher.debug('Event recd', params);
switch (params.event) {
case 'pusher:error':
self.emit('error', {type: 'PusherError', data: params.data});
break;
case 'pusher:ping':
self.send_event('pusher:pong', {})
break;
}
self.emit('message', params);
}
}
/**
* Parses an event from the WebSocket to get
* the JSON payload that we require
*
* @param {MessageEvent} event The event from the WebSocket.onmessage handler.
**/
function parseWebSocketEvent(event) {
try {
var params = JSON.parse(event.data);
if (typeof params.data === 'string') {
try {
params.data = JSON.parse(params.data);
} catch (e) {
if (!(e instanceof SyntaxError)) {
throw e;
}
}
}
return params;
} catch (e) {
self.emit('error', {type: 'MessageParseError', error: e, data: event.data});
}
}
function transitionToWaiting() {
self._machine.transition('waiting');
}
function ws_onError(error) {
// just emit error to user - socket will already be closed by browser
self.emit('error', { type: 'WebSocketError', error: error });
}
// Updates the public state information exposed by connection
//
// This is distinct from the internal state information used by _machine
// to manage the connection
//
function updateState(newState, data) {
var prevState = self.state;
self.state = newState;
// Only emit when the state changes
if (prevState !== newState) {
Pusher.debug('State changed', prevState + ' -> ' + newState);
self.emit('state_change', {previous: prevState, current: newState});
self.emit(newState, data);
}
}
};
Connection.prototype.connect = function() {
// no WebSockets
if (Pusher.Transport === null || Pusher.Transport === undefined) {
this._machine.transition('failed');
}
// initial open of connection
else if(this._machine.is('initialized')) {
resetConnectionParameters(this);
this._machine.transition('waiting');
}
// user skipping connection wait
else if (this._machine.is('waiting') && this.netInfo.isOnLine() === true) {
this._machine.transition('connecting');
}
// user re-opening connection after closing it
else if(this._machine.is("permanentlyClosed")) {
resetConnectionParameters(this);
this._machine.transition('waiting');
}
};
Connection.prototype.send = function(data) {
if (this._machine.is('connected')) {
// Bug in iOS (reproduced in 5.0.1) Mobile Safari:
// 1. Open page/tab, connect WS, get some data.
// 2. Switch tab or close Mobile Safari and wait for WS connection to get closed (probably by server).
// 3. Switch back to tab or open Mobile Safari and Mobile Safari crashes.
// The problem is that WS tries to send data on closed WS connection before it realises it is closed.
// The timeout means that by the time the send happens, the WS readyState correctly reflects closed state.
var self = this;
setTimeout(function() {
self.socket.send(data);
}, 0);
return true; // only a reflection of fact that WS thinks it is open - could get returned before some lower-level failure.
} else {
return false;
}
};
Connection.prototype.send_event = function(event_name, data, channel) {
var payload = {
event: event_name,
data: data
};
if (channel) payload['channel'] = channel;
Pusher.debug('Event sent', payload);
return this.send(JSON.stringify(payload));
}
Connection.prototype.disconnect = function() {
if (this._machine.is('permanentlyClosed')) return;
if (this._machine.is('waiting') || this._machine.is('failed')) {
this._machine.transition('permanentlyClosed');
} else {
this._machine.transition('permanentlyClosing');
}
};
Pusher.Util.extend(Connection.prototype, Pusher.EventsDispatcher.prototype);
this.Pusher.Connection = Connection;
}).call(this);