bigrails-redis 0.3.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff3e8766a94faf3c2465bd623e81753dfff98b37a309147561e891aa928d8007
-  data.tar.gz: 667363a9f9648ff88c42b3f78306d84fc56e1cdeba0875de33c9d270a237de2f
+  metadata.gz: 8a2638608a5a80ec36cf93efccc3b761d9d1b976b0529dc407901f42c4269f7d
+  data.tar.gz: 677a8e2fbd028515253f3fac94a29b0cde604053cda39521fcc1efe6354e0020
 SHA512:
-  metadata.gz: 1f2514a61324b4900b2dc412e44d816c6772b9b9ea747e69ee1cfae20c9cf20a6f6468683a21125fc93f178522573ec6fef1daeb94d83ee8a9773dee3ac6310a
-  data.tar.gz: 684f353daaba4c3cff2d79d3bc9a2db97df582212b6b75949be6893c2e5220d4e3653036180a423454d803351b1280a20213cb7153c178ae7c85536c97e1f715
+  metadata.gz: 41ea96f64d5f57dcb9f058420e007dc2e84a106ea9d7232402483c16105f3b42a6f96c33f4a2514c20cf961ee44a1b8bbad8790124c9c93ffa94a042e5d6137e
+  data.tar.gz: 561b0610a79041b670f4b11036ea0ee0c1fbad843580726f1e694f3c9695b5b93df6b02cf59cd222060cdf152dad7e0ff9300e8372ec568211e4fc829c99f2e7

data/README.md

@@ -1,6 +1,6 @@
 # BigRails::Redis [![Ruby](https://github.com/BigRails/bigrails-redis/actions/workflows/main.yml/badge.svg)](https://github.com/BigRails/bigrails-redis/actions/workflows/main.yml)
 
-A simple Redis connection manager for Rails applications with distributed and [ConnectionPool](https://github.com/mperham/connection_pool) support.
+A simple Redis connection manager for Rails applications with the need to manage multiple redis connections. It supports distributed and [ConnectionPool](https://github.com/mperham/connection_pool) out of the box.
 
 ## Installation
 
@@ -18,9 +18,15 @@ Create a redis configuration file:
 
 The configuration file (`config/redis.rb`) is just a plain Ruby file that will be evaluated when a connection is requested. Use the `connection` DSL method to declare your connections. The method will yield a block and you're expected to return a configuration hash.
 
-A configuration hash, by default, is passed to `ActiveSupport::Cache::RedisCacheStore.build_redis(...)`. This is a Rails supplied helper which allows for more options than demostrated above. You'll want to [check out its source](https://github.com/rails/rails/blob/main/activesupport/lib/active_support/cache/redis_cache_store.rb#L77-L100) to get a better idea of what it supports.
+The configuration hash is passed to the default `Builder`. You can customize the builder with your own object/proc that responds to `#call`.
 
 ```ruby
+# Change the default builder.
+Rails.application.redis.builder = ->(options) {
+  # options is the hash returned from the connection block.
+  Redis.new(...)
+}
+
 # Simple hardcoded example.
 connection(:default) do
   {
@@ -89,14 +95,22 @@ If you request a wrapped connection for a non-pooled connection, it'll just retu
 
 ### Verifying Connections
 
-This library also allows you to verify connections on demand. If you want, perform the verification in a startup health check to make sure all your connections are valid. It will perform a simple [`PING` command](https://redis.io/commands/PING). An error will be raised if the connection bad.
+This library also allows you to verify connections on demand. If you want, perform the verification in a startup health check to make sure all your connections are valid. It will perform a simple [`PING` command](https://redis.io/commands/PING) and clsoe the connection if it was originally closed. This is to help reduce the number of connections you actually need open. An error will be raised if the connection is bad.
 
 ```ruby
 # Verify all connections:
 Rails.application.redis.verify!
 
-# Verify a single connection:
-Rails.application.redis.verify!(:foobar)
+# Verify specific connections:
+Rails.application.redis.verify!(:foobar, :sidekiq)
+```
+
+### Disconnect Connections
+
+You can disconnect all connections with a single call. This is useful for "before fork" hooks.
+
+```ruby
+Rails.application.redis.disconnect
 ```
 
 ## Development

data/lib/big_rails/redis/builder.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require "redis"
+
+module BigRails
+  module Redis
+    class Builder
+      class << self
+        def call(options)
+          config = Configuration.new(options)
+
+          if config.pool_options.any?
+            ensure_connection_pool_added!
+
+            ::ConnectionPool.new(config.pool_options) { build(config) }
+          else
+            build(config)
+          end
+        end
+
+        private
+
+        def build(config)
+          if config.urls.size > 1
+            build_redis_distributed_client(urls: config.urls, **config.redis_options)
+          else
+            build_redis_client(url: config.urls.first, **config.redis_options)
+          end
+        end
+
+        def build_redis_distributed_client(urls:, **redis_options)
+          ::Redis::Distributed.new([], redis_options).tap do |dist|
+            urls.each { |u| dist.add_node(url: u) }
+          end
+        end
+
+        def build_redis_client(url:, **redis_options)
+          ::Redis.new(redis_options.merge(url: url))
+        end
+
+        def ensure_connection_pool_added!
+          require "connection_pool"
+        rescue LoadError => e
+          warn "You don't have connection_pool installed in your application. Please add it to your Gemfile and run bundle install"
+          raise
+        end
+      end
+    end
+  end
+end

data/lib/big_rails/redis/configuration.rb

@@ -5,24 +5,15 @@ module BigRails
     class Configuration
       attr_reader :redis_options
       attr_reader :pool_options
+      attr_reader :urls
 
       def initialize(redis_options)
         @redis_options = redis_options
+        @urls = Array(redis_options.delete(:url))
         @pool_options ||= {}.tap do |pool_options|
           pool_options[:size] = redis_options.delete(:pool_size) if redis_options[:pool_size]
           pool_options[:timeout] = redis_options.delete(:pool_timeout) if redis_options[:pool_timeout]
         end
-
-        ensure_connection_pool_added! if pool_options.any?
-      end
-
-      private
-
-      def ensure_connection_pool_added!
-        require "connection_pool"
-      rescue LoadError => e
-        warn "You don't have connection_pool installed in your application. Please add it to your Gemfile and run bundle install"
-        raise e
       end
     end
   end

data/lib/big_rails/redis/configuration_dsl.rb

@@ -28,7 +28,7 @@ module BigRails
           raise ArgumentError, "connection named '#{name}' already registered"
         end
 
-        @__configurations[name.to_s] = Configuration.new(yield)
+        @__configurations[name.to_s] = yield
       end
     end
   end

data/lib/big_rails/redis/registry.rb

@@ -1,23 +1,19 @@
 # frozen_string_literal: true
 
-require "redis"
-
 module BigRails
   module Redis
     class Registry
       class UnknownConnection < StandardError
       end
+      class VerificationError < StandardError
+      end
 
       attr_accessor :builder
 
       def initialize
         @connections = {}
         @wrapped_connections = {}
-
-        # Default redis builder.
-        @builder = ->(config) {
-          ActiveSupport::Cache::RedisCacheStore.build_redis(**config.redis_options)
-        }
+        @builder = Builder
       end
 
       def for(name, wrapped: false)
@@ -38,11 +34,29 @@ module BigRails
         configurations.keys.map { |name| self.for(name) }.each(&block)
       end
 
-      def verify!(name = nil)
-        if name
-          verify_connection(self.for(name))
-        else
-          each { |connection| verify_connection(connection) }
+      def disconnect
+        each do |connection|
+          if connection.is_a?(::ConnectionPool)
+            connection.reload { |conn| conn.close }
+          else
+            connection.close
+          end
+        end
+      end
+
+      def verify!(*names)
+        names.map! { |name| validate_name(name) }
+        names = configurations.keys if names.empty?
+        names.each do |name|
+          self.for(name).with do |connection|
+            next if connection.connected?
+
+            begin
+              connection.quit
+            rescue
+              raise VerificationError, "verification for '#{name}' failed"
+            end
+          end
         end
 
         true
@@ -52,27 +66,14 @@ module BigRails
 
       def build_connection(name)
         config = configurations.fetch(name)
-
-        if config.pool_options.any?
-          ::ConnectionPool.new(config.pool_options) { builder.call(config) }
-        else
-          builder.call(config)
-        end
+        builder.call(config)
       end
 
       def build_wrapped_connection(connection)
-        if connection.is_a?(::Redis)
-          connection
-        else
+        if connection.is_a?(::ConnectionPool)
           ::ConnectionPool.wrap(pool: connection)
-        end
-      end
-
-      def verify_connection(connection)
-        connection.with do |conn|
-          connected = conn.connected?
-          conn.ping
-          conn.quit unless connected
+        else
+          connection
         end
       end
 

data/lib/big_rails/redis/version.rb

@@ -2,6 +2,6 @@
 
 module BigRails
   module Redis
-    VERSION = "0.3.0"
+    VERSION = "0.6.0"
   end
 end

data/lib/big_rails/redis.rb

@@ -8,8 +8,9 @@ module BigRails
     extend ActiveSupport::Autoload
 
     autoload :ApplicationExtension
-    autoload :ConfigurationDsl
+    autoload :Builder
     autoload :Configuration
+    autoload :ConfigurationDsl
     autoload :Registry
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bigrails-redis
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Ngan Pham
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-03-19 00:00:00.000000000 Z
+date: 2022-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -28,16 +28,16 @@ dependencies:
   name: redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '4'
 description:
 email:
 - ngan@users.noreply.github.com
@@ -48,6 +48,7 @@ files:
 - README.md
 - lib/big_rails/redis.rb
 - lib/big_rails/redis/application_extension.rb
+- lib/big_rails/redis/builder.rb
 - lib/big_rails/redis/configuration.rb
 - lib/big_rails/redis/configuration_dsl.rb
 - lib/big_rails/redis/railtie.rb