Real time server with lifecycle registration.

dblock · dblock · commit ab251cea7bcf · 2020-11-14T17:31:13.000-05:00
diff --git a/.rubocop_todo.yml b/.rubocop_todo.yml
@@ -1,14 +1,26 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2020-10-14 08:19:11 -0400 using RuboCop version 0.81.0.
+# on 2020-11-14 17:11:37 -0500 using RuboCop version 0.81.0.
 # 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
 # versions of RuboCop, may require this file to be generated again.
 
 # Offense count: 1
+Lint/AmbiguousOperator:
+  Exclude:
+    - 'spec/slack-ruby-bot-server-rtm/lifecycle_spec.rb'
+
+# Offense count: 1
+# Configuration parameters: IgnoreImplicitReferences.
+Lint/ShadowedArgument:
+  Exclude:
+    - 'lib/slack-ruby-bot-server-rtm/lifecycle.rb'
+
+# Offense count: 2
 # Configuration parameters: ExpectMatchingDefinition, Regex, IgnoreExecutableScripts, AllowedAcronyms.
 # AllowedAcronyms: CLI, DSL, ACL, API, ASCII, CPU, CSS, DNS, EOF, GUID, HTML, HTTP, HTTPS, ID, IP, JSON, LHS, QPS, RAM, RHS, RPC, SLA, SMTP, SQL, SSH, TCP, TLS, TTL, UDP, UI, UID, UUID, URI, URL, UTF8, VM, XML, XMPP, XSRF, XSS
 Naming/FileName:
   Exclude:
     - 'lib/slack-ruby-bot-server-rtm.rb'
+    - 'lib/slack-ruby-bot-server-rtm/ext/slack-ruby-bot.rb'
diff --git a/Gemfile b/Gemfile
@@ -19,6 +19,8 @@ else
   warn "Invalid ENV['DATABASE_ADAPTER']: #{ENV['DATABASE_ADAPTER']}."
 end
 
+gem 'slack-ruby-bot-server', github: 'dblock/slack-ruby-bot-server', branch: 'extract-rtm'
+
 gemspec
 
 group :development, :test do
@@ -36,5 +38,5 @@ group :development, :test do
 end
 
 group :test do
-  gem 'slack-ruby-danger', '~> 0.1.0', require: false
+  gem 'slack-ruby-danger', '~> 0.2.0', require: false
 end
diff --git a/README.md b/README.md
@@ -4,7 +4,7 @@ Slack Ruby Bot Server RealTime (RTM) Extension
 [![Gem Version](https://badge.fury.io/rb/slack-ruby-bot-server-rtm.svg)](https://badge.fury.io/rb/slack-ruby-bot-server-rtm)
 [![Build Status](https://travis-ci.org/slack-ruby/slack-ruby-bot-server-rtm.svg?branch=master)](https://travis-ci.org/slack-ruby/slack-ruby-bot-server-rtm)
 
-An extension to [slack-ruby-bot-server](https://github.com/slack-ruby/slack-ruby-bot-server) that makes it easy to handle Slack RTM bots.
+An extension to [slack-ruby-bot-server](https://github.com/slack-ruby/slack-ruby-bot-server) that makes it easy to implement Slack RTM bots.
 
 ### Sample
 
diff --git a/lib/slack-ruby-bot-server-rtm.rb b/lib/slack-ruby-bot-server-rtm.rb
@@ -1,6 +1,10 @@
 # frozen_string_literal: true
 
+require 'slack-ruby-bot'
 require 'slack-ruby-bot-server'
 
 require_relative 'slack-ruby-bot-server-rtm/version'
+require_relative 'slack-ruby-bot-server-rtm/server'
 require_relative 'slack-ruby-bot-server-rtm/config'
+require_relative 'slack-ruby-bot-server-rtm/ext'
+require_relative 'slack-ruby-bot-server-rtm/lifecycle'
diff --git a/lib/slack-ruby-bot-server-rtm/config.rb b/lib/slack-ruby-bot-server-rtm/config.rb
@@ -5,42 +5,13 @@ module RealTime
     module Config
       extend self
 
-      ATTRIBUTES = %i[
-        callbacks
-      ].freeze
-
-      attr_accessor(*Config::ATTRIBUTES)
+      attr_accessor :server_class
 
       def reset!
-        self.callbacks = Hash.new { |h, k| h[k] = [] }
-      end
-
-      def on(type, *values, &block)
-        value_key = values.compact.join('/') if values.any?
-        key = [type.to_s, value_key].compact.join('/')
-        callbacks[key] << block
+        self.server_class = SlackRubyBotServer::RealTime::Server
       end
 
-      def run_callbacks(type, value, args)
-        callbacks = []
-
-        keys = ([type.to_s] + Array(value)).compact
-
-        # more specific callbacks first
-        while keys.any?
-          callbacks += self.callbacks[keys.join('/')]
-          keys.pop
-        end
-
-        return nil unless callbacks&.any?
-
-        callbacks.each do |c|
-          rc = c.call(args || value)
-          return rc if rc
-        end
-
-        nil
-      end
+      reset!
     end
 
     class << self
diff --git a/lib/slack-ruby-bot-server-rtm/ext.rb b/lib/slack-ruby-bot-server-rtm/ext.rb
@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative 'ext/slack-ruby-bot'
diff --git a/lib/slack-ruby-bot-server-rtm/ext/slack-ruby-bot.rb b/lib/slack-ruby-bot-server-rtm/ext/slack-ruby-bot.rb
@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require_relative 'slack-ruby-bot/client'
+require_relative 'slack-ruby-bot/commands/base'
diff --git a/lib/slack-ruby-bot-server-rtm/ext/slack-ruby-bot/client.rb b/lib/slack-ruby-bot-server-rtm/ext/slack-ruby-bot/client.rb
@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module SlackRubyBot
+  class Client
+    # keep track of the team that the client is connected to
+    attr_accessor :owner
+  end
+end
+
+SlackRubyBot::Client.logger.level = Logger::WARN
+
+Slack::RealTime::Client.configure do |config|
+  config.store_class = Slack::RealTime::Stores::Starter
+end
diff --git a/lib/slack-ruby-bot-server-rtm/ext/slack-ruby-bot/commands/base.rb b/lib/slack-ruby-bot-server-rtm/ext/slack-ruby-bot/commands/base.rb
@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module SlackRubyBot
+  module Commands
+    class Base
+      class << self
+        alias _invoke invoke
+
+        def invoke(client, data)
+          _invoke client, data
+        rescue StandardError => e
+          logger.info "#{name.demodulize.upcase}: #{client.owner}, #{e.class}: #{e}"
+          logger.debug e.backtrace.join("\n")
+          client.say(channel: data.channel, text: e.message)
+          true
+        end
+      end
+    end
+  end
+end
diff --git a/lib/slack-ruby-bot-server-rtm/lifecycle.rb b/lib/slack-ruby-bot-server-rtm/lifecycle.rb
@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+SlackRubyBotServer::Config.service_class.instance.on :starting do |team, _error, options|
+  SlackRubyBotServer::Config.service_class.instance.logger.info "Starting real-time team #{team}."
+  options = { team: team }
+  server = SlackRubyBotServer::RealTime::Config.server_class.new(options)
+  SlackRubyBotServer::RealTime::Server.start_server! team, server
+end
+
+SlackRubyBotServer::Config.service_class.instance.on :restarting do |team, _error, options|
+  SlackRubyBotServer::Config.service_class.instance.logger.info "Restarting real-time team #{team}."
+  SlackRubyBotServer::RealTime::Server.start_server! team, server, options[:wait]
+end
+
+SlackRubyBotServer::Config.service_class.instance.on :stopped do |team, _error, _options|
+  SlackRubyBotServer::Config.service_class.instance.logger.info "Stopping real-time team #{team}."
+  begin
+    team.server&.stop!
+  ensure
+    team.server = nil
+  end
+end
+
+SlackRubyBotServer::Config.service_class.instance.on :deactivated do |team, _error, _options|
+  SlackRubyBotServer::Config.service_class.instance.logger.info "De-activating real-time team #{team}."
+  team.server = nil
+end
diff --git a/lib/slack-ruby-bot-server-rtm/server.rb b/lib/slack-ruby-bot-server-rtm/server.rb
@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require_relative 'ext/slack-ruby-bot/client'
+
+module SlackRubyBotServer
+  module RealTime
+    class Server < ::SlackRubyBot::Server
+      attr_accessor :team
+
+      def initialize(attrs = {})
+        attrs = attrs.dup
+        @team = attrs.delete(:team)
+        raise 'Missing team' unless @team
+
+        attrs[:token] = @team.token
+        super(attrs)
+        open!
+      end
+
+      def self.start_server!(team, server, wait = 1)
+        team.server = server
+        server.start_async
+      rescue StandardError => e
+        SlackRubyBotServer::Config.service_class.instance.run_callbacks :error, team, e
+        case e.message
+        when 'account_inactive', 'invalid_auth' then
+          SlackRubyBotServer::Config.logger.error "#{team.name}: #{e.message}, team will be deactivated."
+          SlackRubyBotServer::RealTime::Service.instance.deactivate! team
+          elsef
+          wait = e.retry_after if e.is_a?(Slack::Web::Api::Errors::TooManyRequestsError)
+          SlackRubyBotServer::Config.logger.error "#{team.name}: #{e.message}, restarting in #{wait} second(s)."
+          sleep(wait)
+          start_server! team, server, [wait * 2, 60].min
+        end
+      end
+
+      def restart!(_wait = 1)
+        # when an integration is disabled, a live socket is closed, which causes the default behavior of the client to restart
+        # it would keep retrying without checking for account_inactive or such, we want to restart via service which will disable an inactive team
+        logger.info "#{team.name}: socket closed, restarting ..."
+        SlackRubyBotServer::RealTime::Service.instance.restart! team
+        open!
+      end
+
+      private
+
+      def open!
+        client.owner = team
+      end
+    end
+  end
+end
diff --git a/slack-ruby-bot-server-rtm.gemspec b/slack-ruby-bot-server-rtm.gemspec
@@ -18,5 +18,5 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'async-websocket', '~> 0.8.0'
   spec.add_dependency 'slack-ruby-bot', '>= 0.12.0'
-  spec.add_dependency 'slack-ruby-bot-server', '>= 0.12.0'
+  spec.add_dependency 'slack-ruby-bot-server', '>= 1.0.0'
 end
diff --git a/spec/slack-ruby-bot-server-rtm/config_spec.rb b/spec/slack-ruby-bot-server-rtm/config_spec.rb
diff --git a/spec/slack-ruby-bot-server-rtm/lifecycle_spec.rb b/spec/slack-ruby-bot-server-rtm/lifecycle_spec.rb
@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe SlackRubyBotServer::Config do
+  let(:team) { Fabricate(:team) }
+  context 'with defaults' do
+    let(:server) { SlackRubyBotServer::RealTime::Server.new(team: team) }
+    let(:services) { SlackRubyBotServer::Service.instance.instance_variable_get(:@services) }
+    before do
+      allow(SlackRubyBotServer::RealTime::Server).to receive(:new).with(team: team).and_return(server)
+      allow(server).to receive(:stop!)
+    end
+    it 'starts a team' do
+      expect(server).to receive(:start_async)
+      SlackRubyBotServer::Service.instance.start!(team)
+    end
+    context 'started team' do
+      before do
+        allow(server).to receive(:start_async)
+        SlackRubyBotServer::Service.instance.start!(team)
+      end
+      it 'assigns team server' do
+        expect(team.server).to_not be nil
+      end
+      it 'removes team server' do
+        SlackRubyBotServer::Service.instance.stop!(team)
+        expect(team.server).to be nil
+      end
+      it 'deactivates a team' do
+        SlackRubyBotServer::Service.instance.deactivate!(team)
+        expect(team.server).to be nil
+      end
+    end
+  end
+  context 'overriding server_class' do
+    let(:server_class) do
+      Class.new(SlackRubyBotServer::RealTime::Server) do
+        attr_reader :called
+
+        def initialize(options = {})
+          @called = true
+          super
+        end
+      end
+    end
+    before do
+      SlackRubyBotServer::RealTime.configure do |config|
+        config.server_class = server_class
+      end
+    end
+    after do
+      SlackRubyBotServer::RealTime.config.reset!
+    end
+    it 'creates an instance of server class' do
+      expect(server_class).to receive(:new).with(team: team).and_call_original
+      allow_any_instance_of(server_class).to receive(:start_async)
+      allow_any_instance_of(server_class).to receive(:stop!)
+      SlackRubyBotServer::Service.instance.start!(team)
+      SlackRubyBotServer::Service.instance.stop!(team)
+    end
+  end
+end
diff --git a/spec/slack-ruby-bot-server-rtm/server_spec.rb b/spec/slack-ruby-bot-server-rtm/server_spec.rb
@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe SlackRubyBotServer::RealTime::Server do
+  let(:logger) { subject.send :logger }
+  let(:team) { Team.new(token: 'token') }
+  context 'with options' do
+    subject do
+      SlackRubyBotServer::RealTime::Server.new(
+        team: team,
+        aliases: %w[foo bar]
+      )
+    end
+    before do
+      allow(subject).to receive(:sleep)
+      allow(logger).to receive(:error)
+    end
+    it 'sets token' do
+      expect(subject.send(:client).token).to eq 'token'
+    end
+    it 'sets aliases' do
+      expect(subject.send(:client).aliases).to eq %w[foo bar]
+      expect(subject.send(:client).names).to include 'foo'
+    end
+  end
+end
diff --git a/spec/slack-ruby-bot-server-rtm/version_spec.rb b/spec/slack-ruby-bot-server-rtm/version_spec.rb

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# frozen_string_literal: true`
	`2`	`+`
	`3`	`+require_relative 'ext/slack-ruby-bot'`