rails_failover 0.1.0 → 0.5.1

data/lib/rails_failover/version.rb

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

data/lib/redis/patches/client.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'redis'
+
+# See https://github.com/redis/redis-rb/pull/908
+class Redis::Client
+  def disconnect
+    if connected?
+      result = connection.disconnect
+      @connector.on_disconnect(self)
+      result
+    end
+  end
+end
+
+class Redis::Client::Connector
+  def on_disconnect(client)
+  end
+end

data/makefile

@@ -1,31 +1,21 @@
-PORT               := 6381
-PID_PATH           := /tmp/redis.pid
-SOCKET_PATH        := /tmp/redis.sock
-DBFILENAME         := master.rdb
-replica_port         := 6382
-REPLICA_PID_PATH     := /tmp/redis_replica.pid
-REPLICA_SOCKET_PATH  := /tmp/redis_replica.sock
-REPLICA_DBFILENAME   := replica.rdb
+include postgresql.mk
+include redis.mk
 
-default:
-	@make -s all
+all: redis
 
-all: start test stop
+active_record: teardown_dummy_rails_server setup_dummy_rails_server test_active_record
 
-test:
-	bundle exec rspec
+test_active_record:
+	@ACTIVE_RECORD=1 bundle exec rspec --tag type:active_record ${RSPEC_PATH}
 
-start: start_master start_replica
-stop: stop_replica stop_master
+setup_dummy_rails_server:
+	@cd spec/support/dummy_app && bundle install --quiet --without test --without development && yarn install && RAILS_ENV=production $(BUNDLER_BIN) exec rails db:create db:migrate db:seed
 
-stop_master:
-	@redis-cli -p ${PORT} shutdown
+start_dummy_rails_server:
+	@cd spec/support/dummy_app && BUNDLE_GEMFILE=Gemfile UNICORN_WORKERS=5 SECRET_KEY_BASE=somekey bundle exec unicorn -c config/unicorn.conf.rb -D -E production
 
-start_master:
-	@redis-server --daemonize yes --pidfile ${PID_PATH} --port ${PORT} --unixsocket ${SOCKET_PATH} --dbfilename ${DBFILENAME} --logfile /dev/null
+stop_dummy_rails_server:
+	@kill -TERM $(shell cat spec/support/dummy_app/tmp/pids/unicorn.pid)
 
-stop_replica:
-	@redis-cli -p ${replica_port} shutdown
-
-start_replica:
-	@redis-server --daemonize yes --pidfile ${REPLICA_PID_PATH} --port ${replica_port} --unixsocket ${REPLICA_SOCKET_PATH} --replicaof 127.0.0.1 ${PORT} --dbfilename ${REPLICA_DBFILENAME} --logfile /dev/null
+teardown_dummy_rails_server:
+	@cd spec/support/dummy_app && DISABLE_DATABASE_ENVIRONMENT_CHECK=1 RAILS_ENV=production $(BUNDLER_BIN) exec rails db:drop

data/postgresql.mk

@@ -0,0 +1,54 @@
+PG_BIN_DIR               := $(shell pg_config --bindir)
+PWD                      := $(shell pwd)
+PG_PRIMARY_DIR           := $(PWD)/tmp/primary
+PG_PRIMARY_DATA_DIR      := $(PG_PRIMARY_DIR)/data
+PG_PRIMARY_RUN_DIR       := $(PG_PRIMARY_DIR)/run
+PG_REPLICA_DIR           := $(PWD)/tmp/replica
+PG_REPLICA_DATA_DIR      := $(PG_REPLICA_DIR)/data
+PG_REPLICA_RUN_DIR       := $(PG_REPLICA_DIR)/run
+PG_PRIMARY_PORT          := 5434
+PG_REPLICA_PORT          := 5435
+PG_REPLICATION_USER      := replication
+PG_REPLICATION_PASSWORD  := password
+PG_REPLICATION_SLOT_NAME := replication
+
+setup_pg: init_primary start_pg_primary setup_primary init_replica stop_pg_primary
+
+setup_primary:
+	@$(PG_BIN_DIR)/psql -p $(PG_PRIMARY_PORT) -h $(PG_PRIMARY_RUN_DIR) -d postgres -c "CREATE USER $(PG_REPLICATION_USER) WITH REPLICATION ENCRYPTED PASSWORD '$(PG_REPLICATION_PASSWORD)';"
+	@$(PG_BIN_DIR)/psql -p $(PG_PRIMARY_PORT) -h $(PG_PRIMARY_RUN_DIR) -d postgres -c "SELECT * FROM pg_create_physical_replication_slot('$(PG_REPLICATION_SLOT_NAME)');"
+	@$(PG_BIN_DIR)/psql -p $(PG_PRIMARY_PORT) -h $(PG_PRIMARY_RUN_DIR) -d postgres -c "CREATE USER test;"
+	@$(PG_BIN_DIR)/psql -p $(PG_PRIMARY_PORT) -h $(PG_PRIMARY_RUN_DIR) -d postgres -c "CREATE DATABASE test;"
+
+start_pg: start_pg_primary start_pg_replica
+
+stop_pg: stop_pg_replica stop_pg_primary
+
+init_primary:
+	@mkdir -p $(PG_PRIMARY_DATA_DIR)
+	@mkdir -p $(PG_PRIMARY_RUN_DIR)
+	@$(PG_BIN_DIR)/initdb -E UTF8 -D $(PG_PRIMARY_DATA_DIR)
+
+init_replica:
+	@mkdir -p $(PG_REPLICA_DATA_DIR)
+	@mkdir -p $(PG_REPLICA_RUN_DIR)
+	@PGPASSWORD=$(PG_REPLICATION_PASSWORD) $(PG_BIN_DIR)/pg_basebackup -D $(PG_REPLICA_DATA_DIR) -X stream -h $(PG_PRIMARY_RUN_DIR) -p $(PG_PRIMARY_PORT) -U $(PG_REPLICATION_USER) -w -R
+	@chmod 0700 $(PG_REPLICA_DATA_DIR)
+
+start_pg_primary:
+	@$(PG_BIN_DIR)/pg_ctl --silent --log /dev/null -w -D $(PG_PRIMARY_DATA_DIR) -o "-p $(PG_PRIMARY_PORT)" -o "-k $(PG_PRIMARY_RUN_DIR)" start
+
+start_pg_replica:
+	@$(PG_BIN_DIR)/pg_ctl --silent --log /dev/null -w -D $(PG_REPLICA_DATA_DIR) -o "-p $(PG_REPLICA_PORT)" -o "-k $(PG_REPLICA_RUN_DIR)" start
+
+restart_pg_primary:
+	@$(PG_BIN_DIR)/pg_ctl --silent --log /dev/null -w -D $(PG_PRIMARY_DATA_DIR) -o "-p $(PG_PRIMARY_PORT)" -o "-k $(PG_PRIMARY_RUN_DIR)" restart
+
+stop_pg_primary:
+	@$(PG_BIN_DIR)/pg_ctl --silent --log /dev/null -w -D $(PG_PRIMARY_DATA_DIR) -o "-p $(PG_PRIMARY_PORT)" -o "-k $(PG_PRIMARY_RUN_DIR)" stop
+
+stop_pg_replica:
+	@$(PG_BIN_DIR)/pg_ctl --silent --log /dev/null -w -D $(PG_REPLICA_DATA_DIR) -o "-p $(PG_REPLICA_PORT)" -o "-k $(PG_REPLICA_RUN_DIR)" stop
+
+cleanup_pg:
+	@rm -rf $(PG_PRIMARY_DIR) $(PG_REPLICA_DIR)

data/rails_failover.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Alan Tan"]
   spec.email         = ["tgx@discourse.org"]
 
-  spec.summary       = %q{Failover for PostgreSQL and Redis}
+  spec.summary       = %q{Failover for ActiveRecord and Redis}
   spec.license       = "MIT"
   spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
 
@@ -21,5 +21,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency('redis', '~> 4')
+  ["activerecord", "railties"].each do |gem_name|
+    spec.add_dependency gem_name, "~> 6.0"
+  end
 end

data/redis.mk

@@ -0,0 +1,28 @@
+REDIS_PORT                 := 6381
+REDIS_PID_PATH             := /tmp/redis.pid
+REDIS_SOCKET_PATH          := /tmp/redis.sock
+REDIS_DBFILENAME           := primary.rdb
+REDIS_REPLICA_PORT         := 6382
+REDIS_REPLICA_PID_PATH     := /tmp/redis_replica.pid
+REDIS_REPLICA_SOCKET_PATH  := /tmp/redis_replica.sock
+REDIS_REPLICA_DBFILENAME   := replica.rdb
+
+redis: start_redis test_redis stop_redis
+
+test_redis:
+	@REDIS=1 bundle exec rspec --tag type:redis ${RSPEC_PATH}
+
+start_redis: start_redis_primary start_redis_replica
+stop_redis: stop_redis_replica stop_redis_primary
+
+stop_redis_primary:
+	@redis-cli -p ${REDIS_PORT} shutdown
+
+start_redis_primary:
+	@redis-server --daemonize yes --pidfile ${REDIS_PID_PATH} --port ${REDIS_PORT} --unixsocket ${REDIS_SOCKET_PATH} --dbfilename ${REDIS_DBFILENAME} --logfile /dev/null
+
+stop_redis_replica:
+	@redis-cli -p ${REDIS_REPLICA_PORT} shutdown
+
+start_redis_replica:
+	@redis-server --daemonize yes --pidfile ${REDIS_REPLICA_PID_PATH} --port ${REDIS_REPLICA_PORT} --unixsocket ${REDIS_REPLICA_SOCKET_PATH} --slaveof 127.0.0.1 ${REDIS_PORT} --dbfilename ${REDIS_REPLICA_DBFILENAME} --logfile /dev/null

metadata

@@ -1,29 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: rails_failover
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Alan Tan
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-20 00:00:00.000000000 Z
+date: 2020-06-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: redis
+  name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
 description: 
 email:
 - tgx@discourse.org
@@ -42,14 +56,22 @@ files:
 - README.md
 - Rakefile
 - bin/console
+- bin/rspec
 - bin/setup
 - lib/rails_failover.rb
+- lib/rails_failover/active_record.rb
+- lib/rails_failover/active_record/handler.rb
+- lib/rails_failover/active_record/middleware.rb
+- lib/rails_failover/active_record/railtie.rb
 - lib/rails_failover/redis.rb
 - lib/rails_failover/redis/connector.rb
-- lib/rails_failover/redis/fallback_handler.rb
+- lib/rails_failover/redis/handler.rb
 - lib/rails_failover/version.rb
+- lib/redis/patches/client.rb
 - makefile
+- postgresql.mk
 - rails_failover.gemspec
+- redis.mk
 homepage: 
 licenses:
 - MIT
@@ -69,8 +91,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
-summary: Failover for PostgreSQL and Redis
+summary: Failover for ActiveRecord and Redis
 test_files: []

data/lib/rails_failover/redis/fallback_handler.rb

@@ -1,95 +0,0 @@
-# frozen_string_literal: true
-require 'monitor'
-require 'singleton'
-
-module RailsFailover
-  class Redis
-    class FallbackHandler
-      include Singleton
-      include MonitorMixin
-
-      MASTER_ROLE_STATUS = "role:master"
-      MASTER_LOADED_STATUS = "loading:0"
-
-      def initialize
-        @master = true
-        @clients = []
-
-        super() # Monitor#initialize
-      end
-
-      def verify_master(options)
-        mon_synchronize do
-          return if @thread&.alive?
-
-          RailsFailover::Redis.master_down_callbacks.each { |callback| callback.call }
-
-          @thread = Thread.new do
-            loop do
-              thread = Thread.new { initiate_fallback_to_master(options) }
-              thread.join
-              break if mon_synchronize { @master }
-              sleep (RailsFailover::Redis.verify_master_frequency_seconds + (Time.now.to_i % RailsFailover::Redis.verify_master_frequency_seconds))
-            ensure
-              thread.kill
-            end
-          end
-        end
-      end
-
-      def initiate_fallback_to_master(options)
-        info = nil
-
-        begin
-          master_client = ::Redis::Client.new(options.dup)
-          log "#{log_prefix}: Checking connection to master server..."
-          info = master_client.call([:info])
-        rescue => e
-          log "#{log_prefix}: Connection to Master server failed with '#{e.message}'"
-        ensure
-          master_client&.disconnect
-        end
-
-        if info && info.include?(MASTER_LOADED_STATUS) && info.include?(MASTER_ROLE_STATUS)
-          self.master = true
-          log "#{log_prefix}: Master server is active, disconnecting clients from replica"
-          disconnect_clients
-          RailsFailover::Redis.master_up_callbacks.each { |callback| callback.call }
-        end
-      end
-
-      def register_client(client)
-        mon_synchronize do
-          @clients << client
-        end
-      end
-
-      def master
-        mon_synchronize { @master }
-      end
-
-      def master=(args)
-        mon_synchronize { @master = args }
-      end
-
-      private
-
-      def disconnect_clients
-        mon_synchronize do
-          @clients.each(&:disconnect)
-          @clients.clear
-        end
-      end
-
-      def log(message)
-        if logger = RailsFailover::Redis.logger
-          logger.warn(message)
-        end
-      end
-
-      def log_prefix
-        "#{self.class}"
-      end
-    end
-  end
-end