bigrails-redis 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff3e8766a94faf3c2465bd623e81753dfff98b37a309147561e891aa928d8007
-  data.tar.gz: 667363a9f9648ff88c42b3f78306d84fc56e1cdeba0875de33c9d270a237de2f
+  metadata.gz: c4fad4c4ad81fa365e20f3d168ea4ddd8043b121d88e7d46ccc875e139e7049c
+  data.tar.gz: ac86f0f454a81a3b040562c98dc74036c0b96f714b501dfd65a8df224870071f
 SHA512:
-  metadata.gz: 1f2514a61324b4900b2dc412e44d816c6772b9b9ea747e69ee1cfae20c9cf20a6f6468683a21125fc93f178522573ec6fef1daeb94d83ee8a9773dee3ac6310a
-  data.tar.gz: 684f353daaba4c3cff2d79d3bc9a2db97df582212b6b75949be6893c2e5220d4e3653036180a423454d803351b1280a20213cb7153c178ae7c85536c97e1f715
+  metadata.gz: d130159d4ae34ac9c432dd554a7222fe0f2eb118f71ae1c6bc427a29cab4a1e5ed5b7f83c0410fe99a8977e685105567fba5387b9f04a8ac45ee67f6228a75b5
+  data.tar.gz: fe6b41f256a94205d9913a8faa00234b9ab105ce520875b3bccc6929274081788158da37a128efa0d91a38cba307c661a9e357d0fe7a8d596244db77c4d51799

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
 
@@ -89,14 +89,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/registry.rb

@@ -1,13 +1,14 @@
 # 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
@@ -38,11 +39,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.quit }
+          else
+            connection.quit
+          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
@@ -61,18 +80,10 @@ module BigRails
       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.4.0"
   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.4.0
 platform: ruby
 authors:
 - Ngan Pham
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-03-19 00:00:00.000000000 Z
+date: 2022-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -24,20 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '6'
-- !ruby/object:Gem::Dependency
-  name: redis
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.0'
 description:
 email:
 - ngan@users.noreply.github.com