sequel-replica-failover 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a338272e19a13d468284cedccabd633eaeb930d6
+  data.tar.gz: bd424f6b11b7eeb0637df0cabfb6e5e7a40d9175
+SHA512:
+  metadata.gz: c07b25a6c843c8614eccdb633b9f6019fb30cb47b2ced0cf189c6f298c3831e1fd75d048408b73e7026d4ef36c69e9104164e660764cd8e5b4cf24622fbca0ef
+  data.tar.gz: 8e87d291618c292d845fa541f4765481432ffc5d69310a23d674e6c4adc17cdd7fed63b59352e7b3dd8b1bd2096c294660b68554805482abd556ba1f768efeac

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sequel-replica-failover.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 TODO: Write your name
+
+MIT License
+
+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,54 @@
+# Automatic read-only failover for Sequel
+
+This provides a NOT-THREADSAFE sharded connection pool for failing over between configured replicas.
+
+The mechanisms it provides are as follows:
+
+1. When a DatabaseDisconnectError or DatabaseConnectError occurs, the pool attempt to make another connection to the
+   :read_only server and retry.
+2. The pool will retry `:pool_retry_count` times afterwhich it will raise the exception that triggered the failover.
+3. The pool will stick to a working connection for `:pool_stick_timeout` (in seconds) after which it will
+   try connecting back to a replica.
+4. Anytime a transaction has been started, the pool will NOT failover.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sequel-replica-failover'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sequel-replica-failover
+
+## Usage
+
+When initializing a Sequel connection, set the pool class:
+
+```ruby
+DB = Sequel.connect({
+                      :adapter => 'postgres',
+                      :user => 'postgres',
+                      :password => 'postgres',
+                      :host => '127.0.0.1',
+                      :database => 'postgres',
+                      :port => 5432,
+                      :pool_class => Sequel::ShardedSingleFailoverConnectionPool,
+                      :pool_retry_count => 10,
+                      :pool_stick_timeout => 30
+                    })
+```
+
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/sequel-replica-failover.rb

@@ -0,0 +1,7 @@
+require 'sequel-replica-failover/version'
+require 'sequel/connection_pool/sharded_single_failover'
+
+module Sequel
+  module ReplicaFailover
+  end
+end

data/lib/sequel-replica-failover/version.rb

@@ -0,0 +1,5 @@
+module Sequel
+  module ReplicaFailover
+    VERSION = '0.0.1'
+  end
+end

data/lib/sequel/connection_pool/sharded_single_failover.rb

@@ -0,0 +1,53 @@
+require 'sequel'
+require 'sequel/connection_pool/sharded_single'
+
+class Sequel::ShardedSingleFailoverConnectionPool < Sequel::ShardedSingleConnectionPool
+  def initialize(db, opts = OPTS)
+    super
+    @pool_stick_timeout = opts[:pool_stick_timeout] || 15
+    @pool_retry_count   = opts[:pool_retry_count]   || 5
+  end
+
+  # Yields the connection to the supplied block for the given server.
+  # This method simulates the ConnectionPool#hold API.
+  def hold(server=:default, &block)
+    if server == :read_only &&
+       @stuck_at &&
+       Time.now.to_i - @stuck_at.to_i >= @pool_stick_timeout
+      unstick(:read_only)
+    end
+
+    super(server, &block)
+  rescue Sequel::DatabaseDisconnectError, Sequel::DatabaseConnectionError
+    if server == :read_only && !@db.in_transaction?(server: :read_only)
+      stick
+
+      if @stuck_times >= @pool_retry_count
+        raise
+      end
+
+      hold(server, &block)
+    else
+      raise
+    end
+  end
+
+  def pool_type
+    :sharded_single_failover
+  end
+
+  private
+
+  def unstick(server)
+    disconnect_server(server)
+    @conns[server] = nil
+    @stuck_at = nil
+    @stuck_times = nil
+  end
+
+  def stick
+    @stuck_at ||= Time.now
+    @stuck_times ||= 0
+    @stuck_times += 1
+  end
+end

data/sequel-replica-failover.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sequel-replica-failover/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sequel-replica-failover"
+  spec.version       = Sequel::ReplicaFailover::VERSION
+  spec.authors       = ["Paul Henry"]
+  spec.email         = ["paul@wanelo.com"]
+  spec.description   = %q{Automatically failover between replicas when they go down.}
+  spec.summary       = %q{Automatically failover when replicas go down.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "sequel", ">= 4.3.0"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "timecop"
+end

data/spec/sequel/connection_pool/sharded_single_failover_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+CONNECTION_POOL_DEFAULTS = {:pool_retry_count => 3,
+                            :pool_stick_timeout => 15,
+                            :pool_timeout=>5,
+                            :pool_sleep_time=>0.001,
+                            :max_connections=>4,
+                            :pool_class => Sequel::ShardedSingleFailoverConnectionPool,
+                            :servers => { :read_only => {} } }
+
+mock_db = lambda do |*a, &b|
+  db = Sequel.mock
+  (class << db; self end).send(:define_method, :connect){|c| b.arity == 1 ? b.call(c) : b.call} if b
+  if b2 = a.shift
+    (class << db; self end).send(:define_method, :disconnect_connection){|c| b2.arity == 1 ? b2.call(c) : b2.call}
+  end
+  db
+end
+
+describe Sequel::ShardedSingleFailoverConnectionPool do
+  describe '#hold' do
+    before do
+      msp = proc { @max_size=3 }
+      @connection_pool = Sequel::ConnectionPool.get_pool(mock_db.call(proc { |c| msp.call }) { :got_connection }, CONNECTION_POOL_DEFAULTS)
+    end
+
+    context 'with read_only server' do
+      context 'when block raises a database connection error' do
+        it 'retries until the a successful connection is made' do
+          call_count = 0
+          proc { @connection_pool.hold(:read_only) { call_count += 1; raise Sequel::DatabaseDisconnectError if call_count == 1 } }.should_not raise_error
+          expect(call_count).to eq(2)
+        end
+
+        it 'only retries N number of times before actually raising the error' do
+          call_count = 0
+          proc { @connection_pool.hold(:read_only) { call_count += 1; raise Sequel::DatabaseDisconnectError } }.should raise_error(Sequel::DatabaseDisconnectError)
+          expect(call_count).to eq(3)
+        end
+
+        it 'sticks for N number of seconds to a working connection' do
+          Timecop.freeze -16 do
+            call_count = 0
+            proc { @connection_pool.hold(:read_only) { call_count += 1; raise Sequel::DatabaseDisconnectError if call_count == 1 } }.should_not raise_error
+            expect(call_count).to eq(2)
+            expect(@connection_pool.size).to eq(1)
+          end
+
+          @connection_pool.should_receive(:make_new).once
+          @connection_pool.hold(:read_only) {}
+        end
+
+        context 'when in a transaction' do
+          it 'raises an exception' do
+            Sequel::Mock::Database.any_instance.should_receive(:in_transaction?).and_return(true)
+            proc { @connection_pool.hold(:read_only) { raise Sequel::DatabaseDisconnectError } }.should raise_error(Sequel::DatabaseDisconnectError)
+          end
+        end
+      end
+    end
+
+    context 'with default or arbritrary server' do
+      it 'does no retry logic and raises error' do
+        call_count = 0
+        proc { @connection_pool.hold { call_count += 1; raise Sequel::DatabaseDisconnectError if call_count == 1 } }.should raise_error(Sequel::DatabaseDisconnectError)
+        expect(call_count).to eq(1)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+require 'sequel-replica-failover'
+require 'timecop'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: sequel-replica-failover
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Paul Henry
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 4.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 4.3.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Automatically failover between replicas when they go down.
+email:
+- paul@wanelo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sequel-replica-failover.rb
+- lib/sequel-replica-failover/version.rb
+- lib/sequel/connection_pool/sharded_single_failover.rb
+- sequel-replica-failover.gemspec
+- spec/sequel/connection_pool/sharded_single_failover_spec.rb
+- spec/spec_helper.rb
+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: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.7
+signing_key: 
+specification_version: 4
+summary: Automatically failover when replicas go down.
+test_files:
+- spec/sequel/connection_pool/sharded_single_failover_spec.rb
+- spec/spec_helper.rb