rails_failover 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 307c740884b5d0f566b0013a076133f2e951cf2c3b24336f83ff8e9510ccf95f
+  data.tar.gz: 8a4cc918de939e67c6665c45416b05a4230f79bef9b9efa9f5520cd880e2c3f2
+SHA512:
+  metadata.gz: ec87d7a536a603645d5b4d1c509f1203156c39b1b2bdeb023629727bf73255b46fda97f3d4bd0e363a01871287cc5571653b1d4a53fc1052759c565dab68d441
+  data.tar.gz: 4b104f60e06dafd0c8c1170c289113fb844bc3b48b6af74c3eedb09fae1814e0cc0421f29949d7f93322e8edf9fa9779a958de3538940f45ce6418bc8a1cfb0c

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+.byebug_history
+
+# Redis database files
+*.rdb

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,5 @@
+inherit_gem:
+  rubocop-discourse: default.yml
+
+Discourse:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.2
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at gxtan1990@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in rails_failover.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"
+
+group :development do
+  gem 'rubocop-discourse'
+  gem 'byebug'
+end

data/Gemfile.lock

@@ -0,0 +1,59 @@
+PATH
+  remote: .
+  specs:
+    rails_failover (0.1.0)
+      redis (~> 4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    byebug (11.1.3)
+    diff-lcs (1.3)
+    parallel (1.19.1)
+    parser (2.7.1.2)
+      ast (~> 2.4.0)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    redis (4.1.4)
+    rexml (3.2.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    rubocop (0.83.0)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      rexml
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-discourse (2.1.2)
+      rubocop (>= 0.69.0)
+      rubocop-rspec (>= 1.39.0)
+    rubocop-rspec (1.39.0)
+      rubocop (>= 0.68.1)
+    ruby-progressbar (1.10.1)
+    unicode-display_width (1.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  byebug
+  rails_failover!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  rubocop-discourse
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Alan Tan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,59 @@
+# RailsFailover
+
+* Automatic failover and recovery for simple master-replica Redis setup
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rails_failover'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install rails_failover
+
+## Usage
+
+### Redis
+
+```
+Redis.new(host: "127.0.0.1", port: 6379, replica_host: "127.0.0.1", replica_port: 6380, connector: RailsFailover::Redis::Connector))
+```
+
+Callbacks can be registered when the master connection is down and when it is up.
+
+
+```
+RailsFailover::Redis.register_master_up_callback do
+  # Switch site to read-only mode
+end
+
+RailsFailover::Redis.register_master_down_callback do
+  # Switch site out of read-only mode
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `make test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rails_failover. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/rails_failover/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the RailsFailover project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/rails_failover/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "rails_failover"
+require 'redis'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/rails_failover.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "rails_failover/version"
+require "rails_failover/redis"
+
+module RailsFailover
+  class Error < StandardError; end
+end

data/lib/rails_failover/redis.rb

@@ -0,0 +1,39 @@
+require_relative 'redis/connector'
+
+module RailsFailover
+  class Redis
+    def self.logger=(logger)
+      @logger = logger
+    end
+
+    def self.logger
+      @logger
+    end
+
+    def self.verify_master_frequency_seconds=(seconds)
+      @verify_master_frequency_seconds = seconds
+    end
+
+    def self.verify_master_frequency_seconds
+      @verify_master_frequency_seconds || 5
+    end
+
+    def self.register_master_down_callback(&block)
+      @master_down_callbacks ||= []
+      @master_down_callbacks.push(block)
+    end
+
+    def self.master_down_callbacks
+      @master_down_callbacks || []
+    end
+
+    def self.register_master_up_callback(&block)
+      @master_up_callbacks ||= []
+      @master_up_callbacks.push(block)
+    end
+
+    def self.master_up_callbacks
+      @master_up_callbacks || []
+    end
+  end
+end

data/lib/rails_failover/redis/connector.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+require_relative 'fallback_handler'
+
+module RailsFailover
+  class Redis
+    class Connector
+      def initialize(options)
+        options[:original_driver] = options[:driver]
+
+        options[:driver] = Class.new(options[:driver]) do
+          def self.connect(options)
+            super(options)
+          rescue Timeout::Error,
+                 SocketError,
+                 Errno::EADDRNOTAVAIL,
+                 Errno::ECONNREFUSED,
+                 Errno::EHOSTDOWN,
+                 Errno::EHOSTUNREACH,
+                 Errno::ENETUNREACH,
+                 Errno::ENOENT,
+                 Errno::ETIMEDOUT,
+                 Errno::EINVAL => e
+
+            FallbackHandler.instance.master = false
+            FallbackHandler.instance.verify_master(options.dup)
+            raise e
+          end
+        end
+
+        options.delete(:connector)
+        @options = options.dup
+        @replica_options = replica_options(options)
+      end
+
+      def resolve
+        FallbackHandler.instance.master ? @options : @replica_options
+      end
+
+      def check(client)
+        FallbackHandler.instance.register_client(client)
+      end
+
+      private
+
+      def replica_options(options)
+        opts = options.dup
+        opts[:host] = opts.delete(:replica_host)
+        opts[:port] = opts.delete(:replica_port)
+        opts[:driver] = opts.delete(:original_driver)
+        opts
+      end
+    end
+  end
+end

data/lib/rails_failover/redis/fallback_handler.rb

@@ -0,0 +1,95 @@
+# 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

data/lib/rails_failover/version.rb

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

data/makefile

@@ -0,0 +1,31 @@
+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
+
+default:
+	@make -s all
+
+all: start test stop
+
+test:
+	bundle exec rspec
+
+start: start_master start_replica
+stop: stop_replica stop_master
+
+stop_master:
+	@redis-cli -p ${PORT} shutdown
+
+start_master:
+	@redis-server --daemonize yes --pidfile ${PID_PATH} --port ${PORT} --unixsocket ${SOCKET_PATH} --dbfilename ${DBFILENAME} --logfile /dev/null
+
+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

data/rails_failover.gemspec

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require_relative 'lib/rails_failover/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rails_failover"
+  spec.version       = RailsFailover::VERSION
+  spec.authors       = ["Alan Tan"]
+  spec.email         = ["tgx@discourse.org"]
+
+  spec.summary       = %q{Failover for PostgreSQL and Redis}
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency('redis', '~> 4')
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: rails_failover
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alan Tan
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-05-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+description: 
+email:
+- tgx@discourse.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rails_failover.rb
+- lib/rails_failover/redis.rb
+- lib/rails_failover/redis/connector.rb
+- lib/rails_failover/redis/fallback_handler.rb
+- lib/rails_failover/version.rb
+- makefile
+- rails_failover.gemspec
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Failover for PostgreSQL and Redis
+test_files: []