Merge pull request #289 from georgyangelov/fix-ping-timeout

Fix reconnects when ping timers under/overshoot

Author: dblock

CHANGELOG.md

@@ -1,5 +1,6 @@
 ### 0.14.4 (Next)
 
+* [#289](https://github.com/slack-ruby/slack-ruby-client/pull/289): Fix reconnects when ping timers under/overshoot - [@georgyangelov](https://github.com/georgyangelov).
 * Your contribution here.
 
 ### 0.14.3 (2019/7/23)

README.md

@@ -376,6 +376,8 @@ This setting determines how long the socket can be idle before sending a ping me
 
 It's important to note that if a ping message was sent and no response was received within the amount of time specified in `websocket_ping`; the client will attempt to reestablish it's connection to the message server.
 
+Note that the ping may take between `websocket_ping` and `websocket_ping * 3/2` seconds to actually trigger when there is no activity on the socket. This is because the timer that checks whether to ping is triggered at every `websocket_ping / 2` interval (see [#289](https://github.com/slack-ruby/slack-ruby-client/pull/289) for further explanation).
+
 To disable this feature; set `websocket_ping` to 0.
 
 ### Connection Methods

lib/slack/real_time/concurrency/async.rb

@@ -34,7 +34,7 @@ def start_reactor(client)
 
                   # The timer task will naturally exit after the driver is set to nil.
                   while @restart
-                    subtask.sleep client.websocket_ping
+                    subtask.sleep client.websocket_ping_timer
                     client.run_ping! if @restart
                   end
                 end

lib/slack/real_time/concurrency/celluloid.rb

@@ -82,7 +82,7 @@ def run_client_loop
           def run_ping_loop
             return unless @client.run_ping?
 
-            @ping_timer = every @client.websocket_ping do
+            @ping_timer = every @client.websocket_ping_timer do
               @client.run_ping!
             end
           end

lib/slack/real_time/concurrency/eventmachine.rb

@@ -30,7 +30,7 @@ def start_async(client)
             @thread = ensure_reactor_running
 
             if client.run_ping?
-              EventMachine.add_periodic_timer(client.websocket_ping) do
+              EventMachine.add_periodic_timer client.websocket_ping_timer do
                 client.run_ping!
               end
             end

lib/slack/real_time/config.rb

@@ -33,6 +33,10 @@ def concurrency
         (val = @concurrency).respond_to?(:call) ? val.call : val
       end
 
+      def websocket_ping_timer
+        websocket_ping / 2
+      end
+
       private
 
       def detect_concurrency