lita-external 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6b242b5e5003c4c337de082c0d5fb4ae54b2cf8d
-  data.tar.gz: ecce7cc2ffb2b52974c357bc52475cbd82b045d6
+  metadata.gz: a1c2d9d25c29abacfddd161ede9780063507d99f
+  data.tar.gz: fde3992420ea774d4d51f3d741554559818520b5
 SHA512:
-  metadata.gz: 1a28dbd1270f68c5c2dfd043498a8da6b42f6ef9f8b619628ccc8df4c6a838152380748606aaef5d5e3fdcb14372df9edd5ed2ab669c6b9724132e64fca81c79
-  data.tar.gz: 9c50803803e0bbc5fcc620f7ae39778ec8951877a7abfe378d8cadba62775e190311f8ab6651c4ab1cd254af620ad789c20702a673568b4ab03022284123f4cc
+  metadata.gz: 5e39ea973afe6caf81d1db432dbc5bbae5cbfbd45ddf3f0a2c7160bb023aca346c699cefd46bbe71f6bc304ec5cd6f25297655a6616d137865adad278b18258f
+  data.tar.gz: 9b9de40182114352af9239552956afa65fddce072cf7660409aac95aaee6dba6cf11ef850cd07ed44857ab63bcccaebaf05f6f821e77d967ea61db833dc3ee9d

data/README.md

@@ -24,6 +24,55 @@ Or install it yourself as:
 
 TODO: Write usage instructions here
 
+## How it works
+
+### Context
+
+We are are very happy with Lita, and we are using it very extensively. So much that per moment it receive too much traffic and end up being limited by the CPU (parsing JSON webhooks mostly).
+
+When this happen, HTTP and Chat requests start to be queued and Lita becomes unresponsive. So much that a simple ping can sometimes takes minutes.
+
+### Proof of concept
+
+As a PoC I implemented https://github.com/Shopify/lita-external. It's basically an abstract adapter that uses 2 Redis queues as communication mechanism.
+
+Here's what it looks like conceptually:
+
+```
+             +------------+
+             |            +-------------+
+     +------->  Worker 2  |             |
+     |       |            <--------+    |
+     |       +------------+        |    |
+     |                             |    |
++----+--+    +------------+   +----+----v----+    +-------------+    +------------+
+|       |    |            +--->              +---->             |    |  Chat      |
+| Nginx +---->  Worker 1  |   |    Redis     |    |   Master    <---->  Service   |
+|       |    |            <---+              <----+             |    |            |
++-------+    +------------+   +--------------+    +-------------+    +------------+
+
+```
+
+- All the workers accepts HTTP requests
+- Technically, the master also accept HTTP, but we simply don't send anything to it.
+- We can add as many workers as we want, on multiple servers if needed.
+- Incomming chat messages are serialized with `Marshal` and pushed in `lita:messages:inbound`
+- All the workers maintain a `BLPOP` on `lita:messages:inbound`. When they are dispatched a message they process it in a thread pool.
+- When workers need to send a chat message (or change topic or whatever), they push it in `lita:messages:outbound`.
+- The master maintain a `BLPOP` on `lita:messages:outbound`, and simply send them to the chat service.
+
+### Status
+
+Since very recently we are running `lita-external` in production, without any problems so far (again it's very recent).
+
+### Additional benefits
+
+Beyond giving us more CPU capacity and horizontal capacity, it also allow give us:
+
+  - Multi server capability which is not enough but a requirement for high availability of Lita. (It also require Redis failover and master election)
+  - Zero downtime deploys. We can now restart lita without droping HTTP requests. We still have a very small chat downtime when restarting the master but that's more acceptable.
+  
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/lita/adapters/external.rb

@@ -1,3 +1,5 @@
+require 'puma/thread_pool'
+
 module Lita
   module Adapters
     class External < Adapter
@@ -32,7 +34,14 @@ module Lita
             end
           rescue => error
             Lita.logger.error("Inbound message failed: #{error.class}: #{error.message}")
-            Lita.config.robot.error_handler(error)
+            if Lita.config.robot.error_handler
+              case Lita.config.robot.error_handler.arity
+              when 1, -1
+                Lita.config.robot.error_handler.call(error)
+              when 2, -2
+                Lita.config.robot.error_handler.call(error, {})
+              end 
+            end
           end
         end
       end

data/lib/lita/external/robot.rb

@@ -1,6 +1,16 @@
 module Lita
   module External
+    class ::Lita::Robot
+      def run(&block)
+        run_app
+        adapter.run(&block)
+      rescue Interrupt
+        shut_down
+      end
+    end
+
     class Robot < ::Lita::Robot
+      CommandFailed = Class.new(StandardError)
 
       class Ballot
         attr_accessor :veto
@@ -25,8 +35,9 @@ module Lita
 
         trigger(:master_loaded)
 
-        watch_outbound_queue
-        super
+        super do
+          watch_outbound_queue
+        end
       end
 
       def shut_down
@@ -39,24 +50,30 @@ module Lita
           Lita.logger.info("Watching outbound queue")
           until @stopping
             begin
-              if command = External.blocking_redis.blpop('messages:outbound', timeout: 1)
-                process_outbound_command(command.last)
+              if payload = External.blocking_redis.blpop('messages:outbound', timeout: 1)
+                command, args = Marshal.load(payload.last)
+                Lita.logger.debug("Triggering #{command}")
+                begin
+                  adapter.public_send(command, *args)
+                rescue RuntimeError => error
+                  raise CommandFailed, "#{command}(#{args.map(&:inspect).join(', ')}) failed because: #{error.message}"
+                end
               end
             rescue => error
               Lita.logger.error("Outbound message failed: #{error.class}: #{error.message}")
+              Lita.logger.debug { "Outbound message failed: command=#{command} args=#{args.inspect}" }
               if Lita.config.robot.error_handler
-                Lita.config.robot.error_handler.call(error)
+                case Lita.config.robot.error_handler.arity
+                when 1, -1
+                  Lita.config.robot.error_handler.call(error)
+                when 2, -2
+                  Lita.config.robot.error_handler.call(error, {})
+                end 
               end
             end
           end
         end
       end
-
-      def process_outbound_command(payload)
-        command, args = Marshal.load(payload)
-        Lita.logger.debug("Triggering #{command}")
-        adapter.public_send(command, *args)
-      end
     end
   end
 end

data/lib/lita/external/version.rb

@@ -1,5 +1,5 @@
 module Lita
   module External
-    VERSION = "0.1.1"
+    VERSION = "0.1.2"
   end
 end

data/lita-external.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'lita', '~> 4.6'
+  spec.add_dependency 'lita', '>= 4.7'
 
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "rake", "~> 10.0"

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: lita-external
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Jean Boussier
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-11-13 00:00:00.000000000 Z
+date: 2018-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lita
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.6'
+        version: '4.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.6'
+        version: '4.7'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -111,7 +111,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Meta Lita adapter that use a redis queue