Blame view

static/js/angular-websocket.js 12 KB
7ef9e631f   Andrew Buss   allow static dir
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
  (function() {
    'use strict';
  
    var noop = angular.noop;
    var objectFreeze  = (Object.freeze) ? Object.freeze : noop;
    var objectDefineProperty = Object.defineProperty;
    var isString   = angular.isString;
    var isFunction = angular.isFunction;
    var isDefined  = angular.isDefined;
    var isObject   = angular.isObject;
    var isArray    = angular.isArray;
    var forEach    = angular.forEach;
    var arraySlice = Array.prototype.slice;
    // ie8 wat
    if (!Array.prototype.indexOf) {
      Array.prototype.indexOf = function(elt /*, from*/) {
        var len = this.length >>> 0;
        var from = Number(arguments[1]) || 0;
        from = (from < 0) ? Math.ceil(from) : Math.floor(from);
        if (from < 0) {
          from += len;
        }
  
        for (; from < len; from++) {
          if (from in this && this[from] === elt) { return from; }
        }
        return -1;
      };
    }
  
    // $WebSocketProvider.$inject = ['$rootScope', '$q', '$timeout', '$websocketBackend'];
    function $WebSocketProvider($rootScope, $q, $timeout, $websocketBackend) {
  
      function $WebSocket(url, protocols, options) {
        if (!options && isObject(protocols) && !isArray(protocols)) {
          options = protocols;
          protocols = undefined;
        }
  
        this.protocols = protocols;
        this.url = url || 'Missing URL';
        this.ssl = /(wss)/i.test(this.url);
  
        // this.binaryType = '';
        // this.extensions = '';
        // this.bufferedAmount = 0;
        // this.trasnmitting = false;
        // this.buffer = [];
  
        // TODO: refactor options to use isDefined
        this.scope                       = options && options.scope                      || $rootScope;
        this.rootScopeFailover           = options && options.rootScopeFailover          && true;
        this.useApplyAsync               = options && options.useApplyAsync              || false;
        this.initialTimeout              = options && options.initialTimeout             || 500; // 500ms
        this.maxTimeout                  = options && options.maxTimeout                 || 5 * 60 * 1000; // 5 minutes
        this.reconnectIfNotNormalClose   = options && options.reconnectIfNotNormalClose  || false;
  
        this._reconnectAttempts = 0;
        this.sendQueue          = [];
        this.onOpenCallbacks    = [];
        this.onMessageCallbacks = [];
        this.onErrorCallbacks   = [];
        this.onCloseCallbacks   = [];
  
        objectFreeze(this._readyStateConstants);
  
        if (url) {
          this._connect();
        } else {
          this._setInternalState(0);
        }
  
      }
  
  
      $WebSocket.prototype._readyStateConstants = {
        'CONNECTING': 0,
        'OPEN': 1,
        'CLOSING': 2,
        'CLOSED': 3,
        'RECONNECT_ABORTED': 4
      };
  
      $WebSocket.prototype._normalCloseCode = 1000;
  
      $WebSocket.prototype._reconnectableStatusCodes = [
        4000
      ];
  
      $WebSocket.prototype.safeDigest = function safeDigest(autoApply) {
        if (autoApply && !this.scope.$$phase) {
          this.scope.$digest();
        }
      };
  
      $WebSocket.prototype.bindToScope = function bindToScope(scope) {
        var self = this;
        if (scope) {
          this.scope = scope;
          if (this.rootScopeFailover) {
            this.scope.$on('$destroy', function() {
              self.scope = $rootScope;
            });
          }
        }
        return self;
      };
  
      $WebSocket.prototype._connect = function _connect(force) {
        if (force || !this.socket || this.socket.readyState !== this._readyStateConstants.OPEN) {
          this.socket = $websocketBackend.create(this.url, this.protocols);
          this.socket.onmessage = angular.bind(this, this._onMessageHandler);
          this.socket.onopen  = angular.bind(this, this._onOpenHandler);
          this.socket.onerror = angular.bind(this, this._onErrorHandler);
          this.socket.onclose = angular.bind(this, this._onCloseHandler);
        }
      };
  
      $WebSocket.prototype.fireQueue = function fireQueue() {
        while (this.sendQueue.length && this.socket.readyState === this._readyStateConstants.OPEN) {
          var data = this.sendQueue.shift();
  
          this.socket.send(
            isString(data.message) ? data.message : JSON.stringify(data.message)
          );
          data.deferred.resolve();
        }
      };
  
      $WebSocket.prototype.notifyOpenCallbacks = function notifyOpenCallbacks(event) {
        for (var i = 0; i < this.onOpenCallbacks.length; i++) {
          this.onOpenCallbacks[i].call(this, event);
        }
      };
  
      $WebSocket.prototype.notifyCloseCallbacks = function notifyCloseCallbacks(event) {
        for (var i = 0; i < this.onCloseCallbacks.length; i++) {
          this.onCloseCallbacks[i].call(this, event);
        }
      };
  
      $WebSocket.prototype.notifyErrorCallbacks = function notifyErrorCallbacks(event) {
        for (var i = 0; i < this.onErrorCallbacks.length; i++) {
          this.onErrorCallbacks[i].call(this, event);
        }
      };
  
      $WebSocket.prototype.onOpen = function onOpen(cb) {
        this.onOpenCallbacks.push(cb);
        return this;
      };
  
      $WebSocket.prototype.onClose = function onClose(cb) {
        this.onCloseCallbacks.push(cb);
        return this;
      };
  
      $WebSocket.prototype.onError = function onError(cb) {
        this.onErrorCallbacks.push(cb);
        return this;
      };
  
  
      $WebSocket.prototype.onMessage = function onMessage(callback, options) {
        if (!isFunction(callback)) {
          throw new Error('Callback must be a function');
        }
  
        if (options && isDefined(options.filter) && !isString(options.filter) && !(options.filter instanceof RegExp)) {
          throw new Error('Pattern must be a string or regular expression');
        }
  
        this.onMessageCallbacks.push({
          fn: callback,
          pattern: options ? options.filter : undefined,
          autoApply: options ? options.autoApply : true
        });
        return this;
      };
  
      $WebSocket.prototype._onOpenHandler = function _onOpenHandler(event) {
        this._reconnectAttempts = 0;
        this.notifyOpenCallbacks(event);
        this.fireQueue();
      };
  
      $WebSocket.prototype._onCloseHandler = function _onCloseHandler(event) {
        this.notifyCloseCallbacks(event);
        if ((this.reconnectIfNotNormalClose && event.code !== this._normalCloseCode) || this._reconnectableStatusCodes.indexOf(event.code) > -1) {
          this.reconnect();
        }
      };
  
      $WebSocket.prototype._onErrorHandler = function _onErrorHandler(event) {
        this.notifyErrorCallbacks(event);
      };
  
      $WebSocket.prototype._onMessageHandler = function _onMessageHandler(message) {
        var pattern;
        var self = this;
        var currentCallback;
        for (var i = 0; i < self.onMessageCallbacks.length; i++) {
          currentCallback = self.onMessageCallbacks[i];
          pattern = currentCallback.pattern;
          if (pattern) {
            if (isString(pattern) && message.data === pattern) {
              applyAsyncOrDigest(currentCallback.fn, currentCallback.autoApply, message);
            }
            else if (pattern instanceof RegExp && pattern.exec(message.data)) {
              applyAsyncOrDigest(currentCallback.fn, currentCallback.autoApply, message);
            }
          }
          else {
            applyAsyncOrDigest(currentCallback.fn, currentCallback.autoApply, message);
          }
        }
  
        function applyAsyncOrDigest(callback, autoApply, args) {
          args = arraySlice.call(arguments, 2);
          if (self.useApplyAsync) {
            self.scope.$applyAsync(function() {
              callback.apply(self, args);
            });
          } else {
            callback.apply(self, args);
            self.safeDigest(autoApply);
          }
        }
  
      };
  
      $WebSocket.prototype.close = function close(force) {
        if (force || !this.socket.bufferedAmount) {
          this.socket.close();
        }
        return this;
      };
  
      $WebSocket.prototype.send = function send(data) {
        var deferred = $q.defer();
        var self = this;
        var promise = cancelableify(deferred.promise);
  
        if (self.readyState === self._readyStateConstants.RECONNECT_ABORTED) {
          deferred.reject('Socket connection has been closed');
        }
        else {
          self.sendQueue.push({
            message: data,
            deferred: deferred
          });
          self.fireQueue();
        }
  
        // Credit goes to @btford
        function cancelableify(promise) {
          promise.cancel = cancel;
          var then = promise.then;
          promise.then = function() {
            var newPromise = then.apply(this, arguments);
            return cancelableify(newPromise);
          };
          return promise;
        }
  
        function cancel(reason) {
          self.sendQueue.splice(self.sendQueue.indexOf(data), 1);
          deferred.reject(reason);
          return self;
        }
  
        if ($websocketBackend.isMocked && $websocketBackend.isMocked() &&
                $websocketBackend.isConnected(this.url)) {
          this._onMessageHandler($websocketBackend.mockSend());
        }
  
        return promise;
      };
  
      $WebSocket.prototype.reconnect = function reconnect() {
        this.close();
  
        var backoffDelay = this._getBackoffDelay(++this._reconnectAttempts);
  
        var backoffDelaySeconds = backoffDelay / 1000;
        console.log('Reconnecting in ' + backoffDelaySeconds + ' seconds');
  
        $timeout(angular.bind(this, this._connect), backoffDelay);
  
        return this;
      };
      // Exponential Backoff Formula by Prof. Douglas Thain
      // http://dthain.blogspot.co.uk/2009/02/exponential-backoff-in-distributed.html
      $WebSocket.prototype._getBackoffDelay = function _getBackoffDelay(attempt) {
        var R = Math.random() + 1;
        var T = this.initialTimeout;
        var F = 2;
        var N = attempt;
        var M = this.maxTimeout;
  
        return Math.floor(Math.min(R * T * Math.pow(F, N), M));
      };
  
      $WebSocket.prototype._setInternalState = function _setInternalState(state) {
        if (Math.floor(state) !== state || state < 0 || state > 4) {
          throw new Error('state must be an integer between 0 and 4, got: ' + state);
        }
  
        // ie8 wat
        if (!objectDefineProperty) {
          this.readyState = state || this.socket.readyState;
        }
        this._internalConnectionState = state;
  
  
        forEach(this.sendQueue, function(pending) {
          pending.deferred.reject('Message cancelled due to closed socket connection');
        });
      };
  
      // Read only .readyState
      if (objectDefineProperty) {
        objectDefineProperty($WebSocket.prototype, 'readyState', {
          get: function() {
            return this._internalConnectionState || this.socket.readyState;
          },
          set: function() {
            throw new Error('The readyState property is read-only');
          }
        });
      }
  
      return function(url, protocols) {
        return new $WebSocket(url, protocols);
      };
    }
  
    // $WebSocketBackendProvider.$inject = ['$window', '$log'];
    function $WebSocketBackendProvider($window, $log) {
      this.create = function create(url, protocols) {
        var match = /wss?:\/\//.exec(url);
        var Socket, ws;
        if (!match) {
          throw new Error('Invalid url provided');
        }
  
        // CommonJS
        if (typeof exports === 'object' && require) {
          try {
            ws = require('ws');
            Socket = (ws.Client || ws.client || ws);
          } catch(e) {}
        }
  
        // Browser
        Socket = Socket || $window.WebSocket || $window.MozWebSocket;
  
        if (protocols) {
          return new Socket(url, protocols);
        }
  
        return new Socket(url);
      };
      this.createWebSocketBackend = function createWebSocketBackend(url, protocols) {
        $log.warn('Deprecated: Please use .create(url, protocols)');
        return this.create(url, protocols);
      };
    }
  
    angular.module('ngWebSocket', [])
    .factory('$websocket', ['$rootScope', '$q', '$timeout', '$websocketBackend', $WebSocketProvider])
    .factory('WebSocket',  ['$rootScope', '$q', '$timeout', 'WebsocketBackend',  $WebSocketProvider])
    .service('$websocketBackend', ['$window', '$log', $WebSocketBackendProvider])
    .service('WebSocketBackend',  ['$window', '$log', $WebSocketBackendProvider]);
  
  
    angular.module('angular-websocket', ['ngWebSocket']);
  
    if (typeof module === 'object' && typeof define !== 'function') {
      module.exports = angular.module('ngWebSocket');
    }
  }());