Include team id, name and domain in log output.

Author: dblock

.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2019-07-20 16:45:38 -0400 using RuboCop version 0.61.1.
+# on 2019-07-21 10:11:39 -0400 using RuboCop version 0.61.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new

CHANGELOG.md

@@ -3,6 +3,7 @@
 * [#279](https://github.com/slack-ruby/slack-ruby-client/pull/279): Prevent ping worker from dying on unexpected errors - [@dblock](https://github.com/dblock).
 * [#281](https://github.com/slack-ruby/slack-ruby-client/pull/281): Added `admin_users_session_reset` to Web API - [@dblock](https://github.com/dblock).
 * [#283](https://github.com/slack-ruby/slack-ruby-client/pull/283): Fail when used with incompatible async-websocket > 0.8.0 - [@dblock](https://github.com/dblock).
+* [#284](https://github.com/slack-ruby/slack-ruby-client/pull/284): Include team id, name and domain in log output - [@dblock](https://github.com/dblock).
 * Your contribution here.
 
 ### 0.14.2 (2019/4/12)

lib/slack/real_time/client.rb

@@ -82,18 +82,18 @@ def config
       def run_loop
         @socket.connect! do |driver|
           driver.on :open do |event|
-            logger.debug("#{self.class}##{__method__}") { event.class.name }
+            logger.debug("#{self}##{__method__}") { event.class.name }
             open(event)
             callback(event, :open)
           end
 
           driver.on :message do |event|
-            logger.debug("#{self.class}##{__method__}") { "#{event.class}, #{event.data}" }
+            logger.debug("#{self}##{__method__}") { "#{event.class}, #{event.data}" }
             dispatch(event)
           end
 
           driver.on :close do |event|
-            logger.debug("#{self.class}##{__method__}") { event.class.name }
+            logger.debug("#{self}##{__method__}") { event.class.name }
             callback(event, :close)
             close(event)
             callback(event, :closed)
@@ -127,20 +127,30 @@ def keep_alive?
       def run_ping!
         return if keep_alive?
 
+        logger.warn(to_s) { 'is offline' }
+
         restart_async
       rescue StandardError => e
         # disregard all ping worker failures, keep pinging
-        logger.debug("#{self.class}##{__method__}") { e }
+        logger.debug("#{self}##{__method__}") { e }
       end
 
       def run_ping?
         !websocket_ping.nil? && websocket_ping > 0
       end
 
+      def to_s
+        if store && store.team
+          "id=#{store.team.id}, name=#{store.team.name}, domain=#{store.team.domain}"
+        else
+          super
+        end
+      end
+
       protected
 
       def restart_async
-        logger.debug("#{self.class}##{__method__}")
+        logger.debug("#{self}##{__method__}")
         @socket.close
         start = web_client.send(rtm_start_method, start_options)
         data = Slack::Messages::Message.new(start)
@@ -186,7 +196,7 @@ def socket_class
       def send_json(data)
         raise ClientNotStartedError unless started?
 
-        logger.debug("#{self.class}##{__method__}") { data }
+        logger.debug("#{self}##{__method__}") { data }
         @socket.send_data(data.to_json)
       end
 
@@ -207,7 +217,7 @@ def callback(event, type)
         end
         true
       rescue StandardError => e
-        logger.error e
+        logger.error("#{self}##{__method__}") { e }
         false
       end
 
@@ -219,11 +229,11 @@ def dispatch(event)
         return false unless type
 
         type = type.to_s
-        logger.debug("#{self.class}##{__method__}") { data.to_s }
+        logger.debug("#{self}##{__method__}") { data.to_s }
         run_handlers(type, data) if @store
         run_callbacks(type, data)
       rescue StandardError => e
-        logger.error e
+        logger.error("#{self}##{__method__}") { e }
         false
       end
 
@@ -235,7 +245,7 @@ def run_handlers(type, data)
           end
         end
       rescue StandardError => e
-        logger.error e
+        logger.error("#{self}##{__method__}") { e }
         false
       end
 
@@ -248,7 +258,7 @@ def run_callbacks(type, data)
         end
         true
       rescue StandardError => e
-        logger.error e
+        logger.error("#{self}##{__method__}") { e }
         false
       end
     end

lib/slack/real_time/concurrency/async.rb

@@ -30,7 +30,7 @@ def start_reactor(client)
 
               if client.run_ping?
                 @ping_task = task.async do |subtask|
-                  subtask.annotate 'client keep-alive'
+                  subtask.annotate "#{client} keep-alive"
 
                   # The timer task will naturally exit after the driver is set to nil.
                   while @restart
@@ -45,7 +45,7 @@ def start_reactor(client)
 
                 @client_task = task.async do |subtask|
                   begin
-                    subtask.annotate 'client run-loop'
+                    subtask.annotate "#{client} run-loop"
                     client.run_loop
                   rescue ::Async::Wrapper::Cancelled => e
                     # Will get restarted by ping worker.

spec/slack/real_time/client_spec.rb

@@ -86,6 +86,9 @@
         it 'sets groups' do
           expect(client.groups.count).to eq 1
         end
+        it 'includes team name in to_s' do
+          expect(client.to_s).to eq "id=#{client.team.id}, name=#{client.team.name}, domain=#{client.team.domain}"
+        end
       end
       it 'uses web client to fetch url' do
         expect(client.web_client).to be_a Slack::Web::Client
@@ -159,6 +162,11 @@
         end
       end
     end
+    describe 'to_s' do
+      it 'defaults to class instance' do
+        expect(client.to_s).to match(/^#<Slack::RealTime::Client:0x\h+>$/)
+      end
+    end
   end
   context 'client with starter store', vcr: { cassette_name: 'web/rtm_connect' } do
     let(:client) { Slack::RealTime::Client.new(store_class: Slack::RealTime::Stores::Starter) }
@@ -199,6 +207,9 @@
         it 'no groups' do
           expect(client.groups).to be_nil
         end
+        it 'includes team name in to_s' do
+          expect(client.to_s).to eq "id=#{client.team.id}, name=#{client.team.name}, domain=#{client.team.domain}"
+        end
       end
       it 'uses web client to fetch url' do
         expect(client.web_client).to be_a Slack::Web::Client
@@ -251,6 +262,11 @@
     it 'team' do
       expect(client.team).to be nil
     end
+    describe 'to_s' do
+      it 'defaults to class instance' do
+        expect(client.to_s).to match(/^#<Slack::RealTime::Client:0x\h+>$/)
+      end
+    end
   end
   context 'client with defaults' do
     let(:client) { Slack::RealTime::Client.new }