rails_failover 0.5.9 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8ecac559be38dab0f9581c922e57ac374d7725102ae643a07f15ba0a9d47dd7d
-  data.tar.gz: a7f30fccbf59d7ab9a9f1a227725ea4f8e46b2a9aa10ddc2ac0c97ba873bcf61
+  metadata.gz: dea60f6f50e09e45029bc4f73d89eadefd569935d6855c3542f82aa3e1a01b3f
+  data.tar.gz: 5ccd925be0977242e1f139481b59a3feb3e0a4a9dbf19f8cf21064466fcdbcb4
 SHA512:
-  metadata.gz: 268bdf1584a8082d37b4e863397439df1961a208e771ed7f600f93b78d8125c159855dc98f7655b0dbdd4d51f3e9a554c6ca36122bb3f01fb5a08d878f378680
-  data.tar.gz: 20cc8ea824e636bb051b9f4c7fd2bd9862263592f2eca0bf21a00a24e45f3b4049acd2a0801314e79fd6be05a04a93f2fc1fbda3653a7c6852e36d04d2816a27
+  metadata.gz: d39ff2d6eb505dff92151c884bb7ec3aa608d4bd29c79eea2a0e2e965b8eec6ab787f930128e0d3ffcbbfb1eb2cedccf1a8fa30417eff4d3a2cfea40d536d0a7
+  data.tar.gz: 2b36aa85cff837f80b0876ce7b2af3017c935601ec5c5329f2bab26f5ccb395d8dd50111bee7dbf3ad2bb6e15cb22f2aa18f9fff89b3a101689f1d5036371f7e

data/CHANGELOG.md

@@ -6,6 +6,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.6.0] - 2020-11-09
+- FEATURE: Run failover/fallback callbacks once for each backend
+
+  Previously the failover callback would only fire when the first backend failed, and the fallback callback would only fire when the last backend recovered. Now both failover and fallback callbacks will be triggered for each backend. The key for each backend is also passed to the callbacks for consumption by consuming applications.
+
+- FEATURE: Add primaries_down_count function to failover handlers
+
+  This is intended for consumption by monitoring systems (e.g. the Discourse prometheus exporter) 
+
 ## [0.5.9] - 2020-11-06
 - FIX: Ignore errors from the redis socket shutdown call
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rails_failover (0.5.9)
+    rails_failover (0.6.0)
       activerecord (~> 6.0)
       railties (~> 6.0)
 

data/lib/rails_failover/active_record.rb

@@ -47,16 +47,20 @@ module RailsFailover
       @on_failover_callback = block
     end
 
-    def self.on_failover_callback
-      @on_failover_callback
+    def self.on_failover_callback!(key)
+      @on_failover_callback&.call(key)
+    rescue => e
+      logger.warn("RailsFailover::ActiveRecord.on_failover failed: #{e.class} #{e.message}\n#{e.backtrace.join("\n")}")
     end
 
     def self.on_fallback(&block)
       @on_fallback_callback = block
     end
 
-    def self.on_fallback_callback
-      @on_fallback_callback
+    def self.on_fallback_callback!(key)
+      @on_fallback_callback&.call(key)
+    rescue => e
+      logger.warn("RailsFailover::ActiveRecord.on_fallback failed: #{e.class} #{e.message}\n#{e.backtrace.join("\n")}")
     end
   end
 end

data/lib/rails_failover/active_record/handler.rb

@@ -18,31 +18,19 @@ module RailsFailover
       end
 
       def verify_primary(handler_key)
+        primary_down(handler_key)
+
         mon_synchronize do
-          primary_down(handler_key)
           return if @thread&.alive?
 
           logger.warn "Failover for ActiveRecord has been initiated"
 
-          begin
-            RailsFailover::ActiveRecord.on_failover_callback&.call
-          rescue => e
-            logger.warn("RailsFailover::ActiveRecord.on_failover_callback failed: #{e.class} #{e.message}\n#{e.backtrace.join("\n")}")
-          end
-
           @thread = Thread.new do
             loop do
               initiate_fallback_to_primary
 
               if all_primaries_up
                 logger.warn "Fallback to primary for ActiveRecord has been completed."
-
-                begin
-                  RailsFailover::ActiveRecord.on_fallback_callback&.call
-                rescue => e
-                  logger.warn("RailsFailover::ActiveRecord.on_fallback_callback failed: #{e.class} #{e.message}\n#{e.backtrace.join("\n")}")
-                end
-
                 break
               end
             end
@@ -87,6 +75,12 @@ module RailsFailover
         primaries_down[handler_key]
       end
 
+      def primaries_down_count
+        mon_synchronize do
+          primaries_down.count
+        end
+      end
+
       private
 
       def all_primaries_up
@@ -96,15 +90,19 @@ module RailsFailover
       end
 
       def primary_down(handler_key)
+        already_down = false
         mon_synchronize do
+          already_down = !!primaries_down[handler_key]
           primaries_down[handler_key] = true
         end
+        RailsFailover::ActiveRecord.on_failover_callback!(handler_key) if !already_down
       end
 
       def primary_up(handler_key)
-        mon_synchronize do
-          primaries_down.delete(handler_key)
+        already_up = mon_synchronize do
+          !primaries_down.delete(handler_key)
         end
+        RailsFailover::ActiveRecord.on_fallback_callback!(handler_key) if !already_up
       end
 
       def spec_name

data/lib/rails_failover/redis.rb

@@ -40,16 +40,20 @@ module RailsFailover
       @on_failover_callback = block
     end
 
-    def self.on_failover_callback
-      @on_failover_callback
+    def self.on_failover_callback!(key)
+      @on_failover_callback&.call(key)
+    rescue => e
+      logger.warn("RailsFailover::Redis.on_failover failed: #{e.class} #{e.message}\n#{e.backtrace.join("\n")}")
     end
 
     def self.on_fallback(&block)
       @on_fallback_callback = block
     end
 
-    def self.on_fallback_callback
-      @on_fallback_callback
+    def self.on_fallback_callback!(key)
+      @on_fallback_callback&.call(key)
+    rescue => e
+      logger.warn("RailsFailover::Redis.on_fallback failed: #{e.class} #{e.message}\n#{e.backtrace.join("\n")}")
     end
 
     # For testing

data/lib/rails_failover/redis/handler.rb

@@ -35,12 +35,6 @@ module RailsFailover
 
         logger&.warn "Failover for Redis has been initiated"
 
-        begin
-          RailsFailover::Redis.on_failover_callback&.call
-        rescue => e
-          logger&.warn("RailsFailover::Redis.on_failover_callback failed: #{e.class} #{e.message}\n#{e.backtrace.join("\n")}")
-        end
-
         @thread = Thread.new do
           loop do
             ensure_primary_clients_disconnected
@@ -48,12 +42,6 @@ module RailsFailover
 
             if all_primaries_up
               logger&.warn "Fallback to primary for Redis has been completed."
-
-              begin
-                RailsFailover::Redis.on_fallback_callback&.call
-              rescue => e
-                logger&.warn("RailsFailover::Redis.on_fallback_callback failed: #{e.class} #{e.message}\n#{e.backtrace.join("\n")}")
-              end
               break
             end
           end
@@ -128,6 +116,12 @@ module RailsFailover
         end
       end
 
+      def primaries_down_count
+        mon_synchronize do
+          primaries_down.count
+        end
+      end
+
       private
 
       def all_primaries_up
@@ -135,15 +129,19 @@ module RailsFailover
       end
 
       def primary_up(options)
-        mon_synchronize do
-          primaries_down.delete(options[:id])
+        already_up = mon_synchronize do
+          !primaries_down.delete(options[:id])
         end
+        RailsFailover::Redis.on_fallback_callback!(options[:id]) if !already_up
       end
 
       def primary_down(options)
+        already_down = false
         mon_synchronize do
+          already_down = !!primaries_down[options[:id]]
           primaries_down[options[:id]] = options.dup
         end
+        RailsFailover::Redis.on_failover_callback!(options[:id]) if !already_down
       end
 
       def clients

data/lib/rails_failover/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RailsFailover
-  VERSION = "0.5.9"
+  VERSION = "0.6.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_failover
 version: !ruby/object:Gem::Version
-  version: 0.5.9
+  version: 0.6.0
 platform: ruby
 authors:
 - Alan Tan
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-11-06 00:00:00.000000000 Z
+date: 2020-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord