- support ping function, which send ping message to server every 60s by default if page is visible

 - fix bug: `status()` should query status from `_src` if this is a scoped ws.
 - bump version

Author: zbryikt

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Change Logs
 
+## v0.0.14
+
+ - support `ping` function, which send `ping` message to server every 60s by default if page is visible
+ - fix bug: `status()` should query status from `_src` if this is a scoped ws.
+
+
 ## v0.0.13
 
  - pass `op` parameter from middleware `submit` action to access function for fine-grained access control

README.md

@@ -35,7 +35,11 @@ API (ews):
    - `0`: not connected
    - `1`: connecting
    - `2`: connected
-
+ - `ping(opt)`: periodically ping remote server (heartbeat) to prevent disconnecting.
+   - `opt` is an object with following field:
+     - `now`: default false. if false, ping message is sent after ping interval;
+              otherwise it will be sent immediately.
+ - `unping()`: stop ping.
 
 API (from original WebSocket):
 

dist/index.js

@@ -61,10 +61,51 @@
       canceller: null,
       disconnector: null
     };
+    this._ping = {
+      hdr: null,
+      interval: 60
+    };
     this._s = 0;
     return this;
   };
-  ews.prototype = (ref$ = Object.create(Object.prototype), ref$.addEventListener = function(t, cb, o, fromon){
+  ews.prototype = (ref$ = Object.create(Object.prototype), ref$.unping = function(){
+    var ref$;
+    clearTimeout(this._ping.hdr);
+    document.removeEventListener('visibilitychange', this._ping.check);
+    return ref$ = this._ping, ref$.hdr = null, ref$.running = false, ref$;
+  }, ref$.ping = function(opt){
+    var ref$, this$ = this;
+    opt == null && (opt = {});
+    if (!this._ping.running) {
+      this._ping.isVisible = function(){
+        return this$._ping.visible = document.visibilityState === 'visible';
+      };
+      this._ping.check = function(){
+        if (this$._ping.isVisible()) {
+          return this$.ping({
+            now: true
+          });
+        }
+      };
+      this._ping.running = true;
+      document.addEventListener('visibilitychange', this._ping.check);
+    }
+    if (this._ping.hdr) {
+      clearTimeout(this._ping.hdr);
+    }
+    if (!this._ping.isVisible) {
+      return;
+    }
+    if (opt.now && this.status() === 2) {
+      this.send("ping");
+    }
+    return this._ping.hdr = setTimeout(function(){
+      this$._ping.hdr = null;
+      return this$.ping({
+        now: true
+      });
+    }, 1000 * ((ref$ = this._ping.interval || 60) > 60 ? ref$ : 60));
+  }, ref$.addEventListener = function(t, cb, o, fromon){
     var ref$;
     if (!(t === 'message' || t === 'open' || t === 'close' || t === 'error')) {
       return;
@@ -392,7 +433,9 @@
     }
   };
   ref$.status = function(){
-    return this._s;
+    return this._src
+      ? this._src.status()
+      : this._s;
   };
   ref$.ensure = function(){
     if (this._s === 2) {

dist/index.min.js

@@ -1,6 +1,6 @@
 {
   "name": "@plotdb/ews",
-  "version": "0.0.13",
+  "version": "0.0.14",
   "description": "elastic websocket",
   "main": "dist/index.min.js",
   "browser": "dist/index.min.js",

package-lock.json

@@ -43,12 +43,32 @@ ews = (o = {}) ->
       hdr: null
       canceller: null
       disconnector: null
+    # ping controller
+    _ping: {hdr: null, interval: 60}
     # status. 0: disconnected. 1: connecting. 2: connected.
     _s: 0
   @
 
 # essential websocket APIs
 ews.prototype = Object.create(Object.prototype) <<<
+  unping: ->
+    clearTimeout @_ping.hdr
+    document.removeEventListener \visibilitychange, @_ping.check
+    @_ping <<< hdr: null, running: false
+
+  ping: (opt = {}) ->
+    if !@_ping.running =>
+      @_ping.is-visible = ~> @_ping.visible = (document.visibilityState == \visible)
+      @_ping.check = ~> if @_ping.is-visible! => @ping now: true
+      @_ping.running = true
+      document.addEventListener \visibilitychange, @_ping.check
+    if @_ping.hdr => clearTimeout @_ping.hdr
+    if !@_ping.is-visible => return
+    if opt.now and @status! == 2 => @send("ping")
+    @_ping.hdr = setTimeout (~>
+      @_ping.hdr = null
+      @ping now: true
+    ), (1000 * ((@_ping.interval or 60) >? 60))
 
   # we may add event listener before ws is created.
   # additionally, we may reconnect.
@@ -216,7 +236,7 @@ ews.prototype <<<
     @_s = s
     if s != os => @fire \status, s
 
-  status: -> return @_s
+  status: -> return if @_src => @_src.status! else @_s
   ensure: -> if @_s == 2 => Promise.resolve! else @connect!