Merge pull request #75 from dblock/async

Use async-websocket instead of celluloid-io.

Author: dblock

.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2018-08-22 08:29:35 -0400 using RuboCop version 0.58.2.
+# on 2018-09-08 18:09:56 -0400 using RuboCop version 0.58.2.
 # 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
@@ -16,6 +16,11 @@ Layout/IndentHeredoc:
     - 'sample_apps/sample_app_activerecord/commands/help.rb'
     - 'sample_apps/sample_app_mongoid/commands/help.rb'
 
+# Offense count: 1
+Lint/HandleExceptions:
+  Exclude:
+    - 'lib/slack-ruby-bot-server/ping.rb'
+
 # Offense count: 3
 # Configuration parameters: Blacklist.
 # Blacklist: (?-mix:(^|\s)(EO[A-Z]{1}|END)(\s|$))

CHANGELOG.md

@@ -1,7 +1,8 @@
 ### Changelog
 
-#### 0.7.1 (Next)
+#### 0.8.0 (Next)
 
+* [#75](https://github.com/slack-ruby/slack-ruby-bot-server/pull/75): Default to `async-websocket` instead of `celluloid-io` - [@dblock](https://github.com/dblock).
 * Your contribution here.
 
 #### 0.7.0 (8/22/2018)

UPGRADING.md

@@ -1,6 +1,14 @@
 Upgrading Slack-Ruby-Bot-Server
 ===============================
 
+### Upgrading to >= 0.8.0
+
+### Different Asynchronous I/O Library
+
+The library now uses [async-websocket](https://github.com/socketry/async-websocket) instead of [celluloid-io](https://github.com/celluloid/celluloid-io). If your application is built on Celluloid you may need to make changes and use `Async::Reactor.run` and the likes.
+
+See [#75](https://github.com/slack-ruby/slack-ruby-bot-server/pull/75) for more information.
+
 ### Upgrading to >= 0.7.0
 
 #### New Ping Worker

lib/slack-ruby-bot-server.rb

@@ -1,4 +1,4 @@
-require 'celluloid/current'
+require 'async/websocket'
 
 require 'grape-swagger'
 require 'slack-ruby-bot'

lib/slack-ruby-bot-server/ping.rb

@@ -1,7 +1,7 @@
+require 'active_support/core_ext/string/filters'
+
 module SlackRubyBotServer
   class Ping
-    include Celluloid
-
     attr_reader :client
     attr_reader :options
     attr_reader :error_count
@@ -13,26 +13,41 @@ def initialize(client, options = {})
     end
 
     def start!
-      every ping_interval do
-        check!
+      ::Async::Reactor.run do |task|
+        run(task)
       end
     end
 
     private
 
+    def run(task)
+      logger.debug "PING: #{owner}, every #{ping_interval} second(s)"
+      loop do
+        task.sleep ping_interval
+        break unless check!
+      end
+      logger.debug "PING: #{owner}, done."
+    rescue StandardError => e
+      logger.error e
+      raise e
+    end
+
     def check!
       if online?
         @error_count = 0
+        true
       else
         down!
       end
     rescue StandardError => e
       case e.message
       when 'account_inactive', 'invalid_auth' then
         logger.warn "Error pinging team #{owner.id}: #{e.message}, terminating."
-        terminate
+        false
       else
-        logger.warn "Error pinging team #{owner.id}: #{e.message}."
+        message = e.message.truncate(24, separator: "\n", omission: '...')
+        logger.warn "Error pinging team #{owner.id}: #{message}."
+        true
       end
     end
 
@@ -51,14 +66,22 @@ def presence
     def down!
       logger.warn "DOWN: #{owner}, #{retries_left} #{retries_left == 1 ? 'retry' : 'retries'} left"
       @error_count += 1
-      return if retries_left?
+      return true if retries_left?
       restart!
+      false
     end
 
     def restart!
       logger.warn "RESTART: #{owner}"
-      driver.emit(:close, WebSocket::Driver::CloseEvent.new(1001, 'bot offline')) if driver
-      terminate
+      begin
+        connection.close
+      rescue Async::Wrapper::Cancelled
+        # ignore, from connection.close
+      end
+      driver.close
+      driver.emit(:close, WebSocket::Driver::CloseEvent.new(1001, 'bot offline'))
+    rescue StandardError => e
+      logger.warn "Error restarting team #{owner.id}: #{e.message}."
     end
 
     def ping_interval
@@ -85,6 +108,10 @@ def driver
       socket.instance_variable_get(:@driver) if socket
     end
 
+    def connection
+      driver.instance_variable_get(:@socket) if driver
+    end
+
     def logger
       @logger ||= begin
         STDOUT.sync = true

lib/slack-ruby-bot-server/version.rb

@@ -1,3 +1,3 @@
 module SlackRubyBotServer
-  VERSION = '0.7.1'.freeze
+  VERSION = '0.8.0'.freeze
 end

sample_apps/sample_app_activerecord/config.ru

@@ -7,12 +7,6 @@ require 'yaml'
 
 ActiveRecord::Base.establish_connection(YAML.load_file('config/postgresql.yml')[ENV['RACK_ENV']])
 
-if ENV['RACK_ENV'] == 'development'
-  puts 'Loading NewRelic in developer mode ...'
-  require 'new_relic/rack/developer_mode'
-  use NewRelic::Rack::DeveloperMode
-end
-
 NewRelic::Agent.manual_start
 
 SlackRubyBotServer::App.instance.prepare!

sample_apps/sample_app_mongoid/config.ru

@@ -6,12 +6,6 @@ require_relative 'commands'
 
 Mongoid.load!(File.expand_path('config/mongoid.yml', __dir__), ENV['RACK_ENV'])
 
-if ENV['RACK_ENV'] == 'development'
-  puts 'Loading NewRelic in developer mode ...'
-  require 'new_relic/rack/developer_mode'
-  use NewRelic::Rack::DeveloperMode
-end
-
 NewRelic::Agent.manual_start
 
 SlackRubyBotServer::App.instance.prepare!

slack-ruby-bot-server.gemspec

@@ -14,7 +14,7 @@ Gem::Specification.new do |spec|
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec)/}) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'celluloid-io'
+  spec.add_dependency 'async-websocket'
   spec.add_dependency 'foreman'
   spec.add_dependency 'grape'
   spec.add_dependency 'grape-roar', '>= 0.4.0'

spec/slack-ruby-bot-server/ping_spec.rb

@@ -12,7 +12,7 @@
 
   context 'with defaults' do
     before do
-      allow(subject.wrapped_object).to receive(:every).and_yield
+      allow_any_instance_of(Async::Task).to receive(:sleep)
     end
 
     it 'defaults retry count' do
@@ -28,14 +28,14 @@
     end
 
     it 'checks for connection' do
-      expect(subject.wrapped_object).to receive(:check!)
+      expect(subject).to receive(:check!).and_return(false)
       subject.start!
     end
 
     context 'after a failed check' do
       before do
-        allow(subject.wrapped_object).to receive(:online?).and_return(false)
-        subject.start!
+        allow(subject).to receive(:online?).and_return(false)
+        subject.send(:check!)
       end
 
       it 'decrements retries left' do
@@ -48,8 +48,8 @@
 
       context 'after a successful check' do
         before do
-          allow(subject.wrapped_object).to receive(:online?).and_return(true)
-          subject.start!
+          allow(subject).to receive(:online?).and_return(true)
+          subject.send(:check!)
         end
 
         it 're-increments retries left' do
@@ -63,15 +63,14 @@
     end
 
     it 'terminates the ping worker after account_inactive' do
-      allow(subject.wrapped_object).to receive(:online?).and_raise('account_inactive')
-      expect(subject.wrapped_object).to receive(:terminate)
+      allow(subject).to receive(:online?).and_raise('account_inactive')
       subject.start!
     end
 
     it 'terminates after a number of retries' do
-      allow(subject.wrapped_object).to receive(:online?).and_return(false)
-      expect(subject.wrapped_object).to receive(:terminate)
-      3.times { subject.start! }
+      allow(subject).to receive(:online?).and_return(false)
+      expect(subject).to receive(:check!).exactly(3).times.and_call_original
+      subject.start!
     end
   end
 
@@ -80,8 +79,9 @@
       let(:options) { { ping: { ping_interval: 42 } } }
 
       it 'is used' do
+        expect_any_instance_of(Async::Task).to receive(:sleep).with(42)
         expect(subject.send(:ping_interval)).to eq 42
-        expect(subject.wrapped_object).to receive(:every).with(42)
+        expect(subject).to receive(:check!).and_return(false)
         subject.start!
       end
     end