slack-ruby-client 0.14.3 → 0.14.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 52a5d3c9923ec690ce3051c29b1dbf352a51ddc767fe97b073e57d1475bc62c0
-  data.tar.gz: 573ca30fa89b54863b445bc4132382f9b2c7d9ec5054e24d0ca8998aed43d1d2
+  metadata.gz: cf802522f0f9aa42f83506227b02fcf37beb861429316f9ae2155d3eedde79d8
+  data.tar.gz: 5a81c7017616999820506cdff2af962ecbb601931f04da9598bdc9767307769b
 SHA512:
-  metadata.gz: 54c5b782b45afb9268adfe9511b622d28d9d1e17db1e3cbdec0ffc6490870ef8ce7c12b9d20f1f580991bae9824e32a803509fca7acd912ad0dd2b9ce193ffb4
-  data.tar.gz: 513a1fe8c32d952a9ac6c5a848e63ccfcd372616434f4aba62e00cdf107dea191c4bfa072acde577ca5df4f7aa29b86225419741a0f203bb73f92e488f443338
+  metadata.gz: e648e70aed991cba05dce9cc9907771d8b13c69ecab9386093460d8d3547e0fc825393d174dee7bddf1fcef15b8f85b496ae9a24cadacc4a7054db775508527a
+  data.tar.gz: e8397379744685f4880c20afdadaf9c19439ea9f4cb0c362e596849416f67f836686626f65af81e5ce933c2eeb9c33117fcb8f64bb6967be4963f6a477f61910

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+### 0.14.4 (2019/7/28)
+
+* [#289](https://github.com/slack-ruby/slack-ruby-client/pull/289): Fix reconnects when ping timers under/overshoot - [@georgyangelov](https://github.com/georgyangelov).
+* [#290](https://github.com/slack-ruby/slack-ruby-client/pull/290): Expose Slack::RealTime::Client.logger accessor publicly - [@jcraigk](https://github.com/jcraigk).
+
 ### 0.14.3 (2019/7/23)
 
 * [#279](https://github.com/slack-ruby/slack-ruby-client/pull/279): Prevent ping worker from dying on unexpected errors - [@dblock](https://github.com/dblock).

data/README.md

@@ -66,7 +66,7 @@ A Ruby client for the Slack [Web](https://api.slack.com/web), [RealTime Messagin
 
 ## Stable Release
 
-You're reading the documentation for the **stable** release of slack-ruby-client, 0.14.3. See [UPGRADING](UPGRADING.md) when upgrading from an older version.
+You're reading the documentation for the **stable** release of slack-ruby-client, 0.14.4. See [UPGRADING](UPGRADING.md) when upgrading from an older version.
 
 ## Installation
 
@@ -374,9 +374,11 @@ See a fully working example in [examples/hi_real_time](examples/hi_real_time/hi.
 ##### `websocket_ping`
 This setting determines how long the socket can be idle before sending a ping message to confirm it's still connected.
 
-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.
+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.
 
-To disable this feature; set `websocket_ping` to 0.
+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.
+
+To disable this feature set `websocket_ping` to 0.
 
 ### Connection Methods
 

data/lib/slack/real_time/client.rb

@@ -19,8 +19,8 @@ module Slack
       attr_accessor :store
       attr_accessor :url
       attr_accessor(*Config::ATTRIBUTES)
+      attr_accessor :logger
 
-      protected :logger, :logger=
       protected :store_class, :store_class=
 
       def initialize(options = {})
@@ -139,6 +139,10 @@ module Slack
         !websocket_ping.nil? && websocket_ping > 0
       end
 
+      def websocket_ping_timer
+        websocket_ping / 2
+      end
+
       def to_s
         if store && store.team
           "id=#{store.team.id}, name=#{store.team.name}, domain=#{store.team.domain}"

data/lib/slack/real_time/concurrency/async.rb

@@ -34,7 +34,7 @@ module Slack
 
                   # 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

data/lib/slack/real_time/concurrency/celluloid.rb

@@ -82,7 +82,7 @@ module Slack
           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

data/lib/slack/real_time/concurrency/eventmachine.rb

@@ -30,7 +30,7 @@ module Slack
             @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

data/lib/slack/version.rb

@@ -1,3 +1,3 @@
 module Slack
-  VERSION = '0.14.3'.freeze
+  VERSION = '0.14.4'.freeze
 end

data/spec/integration/integration_spec.rb

@@ -123,7 +123,7 @@ RSpec.describe 'integration test', skip: (!ENV['SLACK_API_TOKEN'] || !ENV['CONCU
 
   context 'with websocket_ping set' do
     before do
-      client.websocket_ping = 1
+      client.websocket_ping = 5
     end
 
     it 'sends pings' do
@@ -136,18 +136,20 @@ RSpec.describe 'integration test', skip: (!ENV['SLACK_API_TOKEN'] || !ENV['CONCU
 
       start_server
 
-      queue.pop_with_timeout(5)
-      expect(@reply_to).to be 1
+      queue.pop_with_timeout(10)
+      expect(@reply_to).to eq 1
     end
 
     it 'rebuilds the websocket connection when dropped' do
       @reply_to = nil
       client.on :pong do |data|
+        logger.info data
         @reply_to = data.reply_to
         if @reply_to == 1
           client.instance_variable_get(:@socket).close
+          queue.push :close
         else
-          expect(@reply_to).to be 2
+          expect(@reply_to).to eq 2
           queue.push :pong
           client.stop!
         end
@@ -155,8 +157,10 @@ RSpec.describe 'integration test', skip: (!ENV['SLACK_API_TOKEN'] || !ENV['CONCU
 
       start_server
 
-      queue.pop_with_timeout(10)
-      queue.pop_with_timeout(10)
+      4.times do |i|
+        queue.pop_with_timeout(10)
+        client.logger.info "Pop #{i}"
+      end
     end
   end
 

data/spec/slack/real_time/client_spec.rb

@@ -42,6 +42,20 @@ RSpec.describe Slack::RealTime::Client do
       end
     end
   end
+  context 'websocket_ping_timer' do
+    context 'with defaults' do
+      let(:client) { Slack::RealTime::Client.new }
+      it 'defaults to websocket_ping / 2' do
+        expect(client.websocket_ping_timer).to eq 15
+      end
+    end
+    context 'with websocket_ping value changed' do
+      let(:client) { Slack::RealTime::Client.new(websocket_ping: 22) }
+      it 'defaults to websocket_ping / 2' do
+        expect(client.websocket_ping_timer).to eq 11
+      end
+    end
+  end
   context 'client with a full store', vcr: { cassette_name: 'web/rtm_start', allow_playback_repeats: true } do
     let(:client) { Slack::RealTime::Client.new(store_class: Slack::RealTime::Stores::Store) }
     let(:url) { 'wss://ms173.slack-msgs.com/websocket/lqcUiAvrKTP-uuid=' }
@@ -314,6 +328,15 @@ RSpec.describe Slack::RealTime::Client do
         end
       end
     end
+    describe 'logger accessor' do
+      let(:client) { Slack::RealTime::Client.new }
+      it 'exposes public logger' do
+        expect(client.logger).to be_a(::Logger)
+      end
+      it 'exposes public logger=' do
+        expect { client.logger = nil }.not_to raise_error(NoMethodError)
+      end
+    end
   end
   context 'global config' do
     after do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slack-ruby-client
 version: !ruby/object:Gem::Version
-  version: 0.14.3
+  version: 0.14.4
 platform: ruby
 authors:
 - Daniel Doubrovkine
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-23 00:00:00.000000000 Z
+date: 2019-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport