Async handler support for Slack::RealTime::Config and Client

CHANGELOG.md

@@ -14,6 +14,7 @@
 * [#480](https://github.com/slack-ruby-client/pulls/480): Add common message formatting utilities - [@chrisbloom7](https://github.com/chrisbloom7).
 * [#481](https://github.com/slack-ruby-client/pulls/481): Update API from [slack-api-ref@7c22d0b](https://github.com/slack-ruby/slack-api-ref/commit/7c22d0b) - [@slack-ruby-ci-bot](https://github.com/apps/slack-ruby-ci-bot).
 * [#488](https://github.com/slack-ruby-client/pulls/488): Update API from [slack-api-ref@a45def2](https://github.com/slack-ruby/slack-api-ref/commit/a45def2) - [@slack-ruby-ci-bot](https://github.com/apps/slack-ruby-ci-bot).
+* [#486](https://github.com/slack-ruby/slack-ruby-client/pull/486): Async handler support for Slack::RealTime::Config and Client - [@milestruecar](https://github.com/milestruecar).
 * Your contribution here.
 
 ### 2.1.0 (2023/03/17)

README.md

@@ -432,6 +432,7 @@ websocket_proxy | Connect via proxy, include `:origin` and `:headers`.
 start_options   | Options to pass to `rtm.connect`, default is `{ request: { timeout: 180 } }`.
 store_class     | Local store class, default is an in-memory `Slack::RealTime::Stores::Starter`.
 store_options   | Options to initialize the store, default is `{}`.
+async_handlers  | Option to run handlers asynchronously. Valid options are `:all` or `:none`, default is `:none`
 logger          | Optional `Logger` instance that logs RealTime requests and socket data.
 
 Note that the RealTime client uses a Web client to obtain the WebSocket URL via [rtm.connect](https://api.slack.com/methods/rtm.connect). While `token` and `logger` options are passed down from the RealTime client, you may also configure Web client options via `Slack::Web::Client.configure` as described above.

lib/slack/real_time/client.rb

@@ -234,13 +234,25 @@ def dispatch(event)
 
       def run_handlers(type, data)
         handlers = store.class.events[type.to_s]
-        handlers.each do |handler|
-          store.instance_exec(data, self, &handler)
+        case async_handlers
+        when :all
+          Async.run { handlers_loop(handlers, data) }
+        when :none
+          handlers_loop(handlers, data)
+        else
+          raise Config::InvalidAsyncHandlersError,
+            "Invalid value '#{async_handlers.inspect}' for config#async_handlers, must be :all or :none."
         end
       rescue StandardError => e
         logger.error("#{self}##{__method__}") { e }
         false
       end
+
+      def handlers_loop(handlers, data)
+        handlers.each do |handler|
+          store.instance_exec(data, self, &handler)
+        end
+      end
 
       def run_callbacks(type, data)
         callbacks = self.callbacks[type]

lib/slack/real_time/config.rb

@@ -3,6 +3,7 @@ module Slack
   module RealTime
     module Config
       class NoConcurrencyError < StandardError; end
+      class InvalidAsyncHandlersError < StandardError; end
 
       extend self
 
@@ -15,6 +16,7 @@ class NoConcurrencyError < StandardError; end
         store_class
         store_options
         logger
+        async_handlers
       ].freeze
 
       attr_accessor(*Config::ATTRIBUTES - [:concurrency])
@@ -29,6 +31,7 @@ def reset
         self.store_class = Slack::RealTime::Stores::Starter
         self.store_options = {}
         self.logger = nil
+        self.async_handlers = :none
       end
 
       def concurrency

spec/slack/real_time/client_spec.rb

@@ -159,16 +159,30 @@
       end
 
       describe '#run_handlers' do
-        context 'when store has no event hooks' do
+        before do
+          @events = client.store.class.events.dup
+          client.store.class.events.clear
+        end
+
+        after do
+          client.store.class.events.merge!(@events)
+        end
+
+        context 'when config#async_handlers is :all' do
           before do
-            @events = client.store.class.events.dup
-            client.store.class.events.clear
+            client.async_handlers = :all
           end
 
           after do
-            client.store.class.events.merge!(@events)
+            client.async_handlers = :none
           end
 
+          it 'returns an Async::Task' do
+            expect(client.send(:run_handlers, 'example', {})).to be_a Async::Task
+          end
+        end
+
+        context 'when store has no event hooks' do
           it 'returns empty array of handlers' do
             expect(client.send(:run_handlers, 'example', {})).to be_empty
           end