routemaster-drain 2.5.2 → 2.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0e5b1d310a24d14ffe3335b5c63c40de0fdc9757
-  data.tar.gz: e7ee5a5854c5cf4cb4fa8af9ffaaadf6bb620289
+  metadata.gz: 8c1bac015db93c186bc55017d7da1eb6534dc550
+  data.tar.gz: d92592efc2519f971cad96b05bb20d830ec8de82
 SHA512:
-  metadata.gz: 3e72b8ba79a1e267735fc66972218ece1a9f612ce726aa68ee4787022e25c693f8d31edb726871d581d0f9a38390dfd02098c08fc0e3f5308e75f8502dfe3ffe
-  data.tar.gz: 7c9e07067f21c1d2720fafed636d552b6981b0b2fe77a38ea489d59b431d7eeb6bac7b8f3192cb534539b68a4143c3dc2263ee26379da6cc359c056f13ff0917
+  metadata.gz: 624d4c43c9482d39eb91b3b14fa6972f31f33ab8597b0bf1c5d98a31ec2753d67f5345e3fe4f56c81eb4ebdc0e39a6d0b0db4c322e266291949a26cbb0e86bf5
+  data.tar.gz: 368f7edb6b89b17d32ff5ce94bfe0d089d0cebb9269123fe6fd89b6f1d8871319a3c28e491206dd663fb071effa670bf5a09b878882ca69f5b5b31645bbe8aef

data/.travis.yml

@@ -3,8 +3,8 @@ cache: bundler
 services:
   - redis-server
 rvm:
-  - 2.2.5
-  - 2.3.1
+  - 2.2.6
+  - 2.3.3
   - 2.4.0
   - ruby-head
 gemfile:

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+### 2.5.3 (2017-06-12)
+
+Features
+
+- Allow to supply pre-initialized (distributed) Redis client objects to connect
+  to the Drain Redis and the Cache Redis (#52)
+
 ### 2.5.2 (2017-05-11)
 
 Bug fixes

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    routemaster-drain (2.5.2)
+    routemaster-drain (2.5.3)
       addressable
       concurrent-ruby
       faraday (>= 0.9.0)

data/README.md

@@ -36,7 +36,7 @@ Add this line to your application's Gemfile:
 
     gem 'routemaster-drain'
 
-**Configuration**
+### Configuration
 
 This gem is configured through the environment, making 12factor compliance
 easier.
@@ -66,6 +66,17 @@ Optional:
 - `ROUTEMASTER_CACHE_TIMEOUT`: if using the cache, how long before Faraday will timeout fetching the resource. Defaults to 1 second.
 - `ROUTEMASTER_CACHE_VERIFY_SSL`: if using the cache, whether to verify SSL when fetching the resource. Defaults to false.
 
+Alternatively, it's possible to configure the gem to use pre-initialized Redis clients for the Cache Redis, the Drain Redis, or both.
+
+The clients are expected to be instances of `Redis::Distributed`. When configured, the pre-built clients take precendence and the gem won't try to estabilish its own private connection to the Redis instances supplied in the ENV variables. This is helpful if you want to re-use connections in order to reduce the number of connected clients to your Redis servers.
+
+```ruby
+Routemaster::RedisBroker.instance.inject(
+  drain_redis: a_redis_object,
+  cache_redis: another_redis_object
+)
+```
+
 ## Illustrated use cases
 
 
@@ -177,7 +188,7 @@ cache as events are received.
 For this purpose, use `Routemaster::Drain::Caching`:
 
 ```ruby
-require 'routemaster/drain/machine'
+require 'routemaster/drain/caching'
 $app = Routemaster::Drain::Caching.new
 ```
 
@@ -188,7 +199,7 @@ And mount it as usual:
 map('/events') { run $app }
 ```
 
-You can still attach a listenenr if you want the incoming events. Typically,
+You can still attach a listener if you want the incoming events. Typically,
 what you'll want is the cache:
 
 ```ruby
@@ -206,18 +217,35 @@ whenever the drain gets notified about a change on that widget.
 Note that `Cache#fget` is a future, so you can efficiently query many resources
 and have any `HTTP GET` requests (and cache queries) happen in parallel.
 
+Resources are fetched through jobs. By default it uses Resque but can be changed
+to use Sidekiq.
+
+```
+ROUTEMASTER_QUEUE_ADAPTER=sidekiq
+```
+
+Finally do not forget the corresponding backend:
+```
+# config/initializers/...
+
+require 'routemaster/jobs/backends/sidekiq'
+# or
+require 'routemaster/jobs/backends/resque'
+```
+
+
 See
 [rubydoc](http://rubydoc.info/github/deliveroo/routemaster-drain/Routemaster/Cache)
 for more details on `Cache`.
 
 ### Expire Cache data for all notified resources
 
-You may wish to maintain a coherent cache but don't need the cache to be warmed
+You may wish to maintain a coherent cache, but don't need the cache to be warmed
 before you process incoming events. In that case, use the cache as detailed above
-but swap the `Caching` drain out for `CachingBusting`
+but swap the `Caching` drain out for `CacheBusting`
 
 ```ruby
-require 'routemaster/drain/machine'
+require 'routemaster/drain/caching_busting'
 $app = Routemaster::Drain::CachingBusting.new
 ```
 

data/gemfiles/rails_3.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    routemaster-drain (2.5.2)
+    routemaster-drain (2.5.3)
       addressable
       concurrent-ruby
       faraday (>= 0.9.0)

data/gemfiles/rails_4.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    routemaster-drain (2.5.2)
+    routemaster-drain (2.5.3)
       addressable
       concurrent-ruby
       faraday (>= 0.9.0)

data/gemfiles/rails_5.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    routemaster-drain (2.5.2)
+    routemaster-drain (2.5.3)
       addressable
       concurrent-ruby
       faraday (>= 0.9.0)

data/lib/routemaster/config.rb

@@ -25,11 +25,11 @@ module Routemaster
     end
 
     def drain_redis
-      RedisBroker.instance.get(:drain_redis, urls: ENV.fetch('ROUTEMASTER_DRAIN_REDIS').split(','))
+      RedisBroker.instance.get(:drain_redis, urls: ENV.fetch('ROUTEMASTER_DRAIN_REDIS', '').split(','))
     end
 
     def cache_redis
-      RedisBroker.instance.get(:cache_redis, urls: ENV.fetch('ROUTEMASTER_CACHE_REDIS').split(','))
+      RedisBroker.instance.get(:cache_redis, urls: ENV.fetch('ROUTEMASTER_CACHE_REDIS', '').split(','))
     end
 
     #

data/lib/routemaster/drain.rb

@@ -1,5 +1,5 @@
 module Routemaster
   module Drain
-    VERSION = '2.5.2'
+    VERSION = '2.5.3'
   end
 end

data/lib/routemaster/middleware/siphon.rb

@@ -2,7 +2,7 @@ module Routemaster
   module Middleware
     # Filters out events based on their topic and passes them to a handling class
     #
-    # `use Middleware::Siphon, 'some_topic' => SomeTopicHandler`
+    # `use Middleware::Siphon, 'siphon_events' => {'some_topic' => SomeTopicHandler`}
     #
     #  Topic handlers are initialized with the full event payload and must respond to `#call`
     class Siphon

data/lib/routemaster/redis_broker.rb

@@ -7,6 +7,8 @@ module Routemaster
   class RedisBroker
     include Singleton
 
+    DEFAULT_NAMESPACE = 'rm'.freeze
+
     def initialize
       @_connections = {}
       _cleanup
@@ -16,7 +18,7 @@ module Routemaster
       _check_for_fork
       @_connections[name] ||= begin
                                 parsed_url = URI.parse(urls.first)
-                                namespace = parsed_url.path.split('/')[2] || 'rm'
+                                namespace = parsed_url.path.split('/')[2] || DEFAULT_NAMESPACE
                                 Redis::Namespace.new(namespace, redis: Redis::Distributed.new(urls))
                               end
     end
@@ -25,18 +27,42 @@ module Routemaster
       _cleanup
     end
 
+    # Allow to inject pre-built Redis clients
+    #
+    # Before storing a new connection, ensures that any previously
+    # set client is properly closed.
+    #
+    def inject(clients={})
+      @_injected_clients = true
+      clients.each_pair do |name, client|
+        _close_if_present(@_connections[name])
+        @_connections[name] = Redis::Namespace.new(DEFAULT_NAMESPACE, redis: client)
+      end
+    end
+
     private
 
+    # Do not clean up if the clients are injected by the host application.
+    # In that case connections should be managed the server or worker processes.
+    #
     def _check_for_fork
-      _cleanup unless Process.pid == @_pid
+      return if @_injected_clients
+      return if Process.pid == @_pid
+      _cleanup
     end
 
     def _cleanup
       @_pid = Process.pid
-      @_connections.each_value.map(&:redis).each(&:quit)
+      @_connections.each_value { |conn| _close_if_present(conn) }
       @_connections = {}
     end
 
+    def _close_if_present(connection)
+      if connection.respond_to?(:redis)
+        connection.redis.quit
+      end
+    end
+
   end
 end
 

data/spec/routemaster/redis_broker_spec.rb

@@ -4,10 +4,9 @@ require_relative '../../lib/routemaster/redis_broker'
 
 describe Routemaster::RedisBroker do
   subject { Class.new(Routemaster::RedisBroker).instance }
+  let(:urls)   { ['redis://localhost/12'] }
 
   describe "#get" do
-    let(:urls)   { ['redis://localhost/12'] }
-
     context "setting up a redis namespace" do
       let(:redis)           { instance_double(Redis, id: 1) }
       let(:redis_namespace) { instance_double(Redis::Namespace) }
@@ -53,4 +52,29 @@ describe Routemaster::RedisBroker do
       end
     end
   end
+
+  describe "#inject_clients" do
+    let(:drain_client) { instance_double(Redis) }
+    let(:cache_client) { instance_double(Redis) }
+
+    before do
+      # Reset the singleton
+      Routemaster::RedisBroker.instance_exec { @singleton__instance__ = nil }
+
+      subject.inject(drain_client: drain_client, cache_client: cache_client)
+    end
+
+    it "sets stores the provided clients for later use" do
+      drain = subject.get(:drain_client, urls: urls)
+      expect(drain).to be_a(Redis::Namespace)
+      expect(drain.namespace).to eql 'rm'
+      expect(drain.redis).to eql drain_client
+      
+
+      cache = subject.get(:cache_client, urls: urls)
+      expect(cache).to be_a(Redis::Namespace)
+      expect(cache.namespace).to eql 'rm'
+      expect(cache.redis).to eql cache_client
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: routemaster-drain
 version: !ruby/object:Gem::Version
-  version: 2.5.2
+  version: 2.5.3
 platform: ruby
 authors:
 - Julien Letessier
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-11 00:00:00.000000000 Z
+date: 2017-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable