slave_pools 1.0.0.rc4 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d874a3eed928f50de0897109c923c87a142b8530
-  data.tar.gz: 525dd736b487ef2c1c7d025742363ac2e8bbcdf5
+  metadata.gz: c0fd6bf772d8b4651a9c582e9e04c079d7fdc788
+  data.tar.gz: 61e8af6660ecb8de50e5160dfba7a90ee3162935
 SHA512:
-  metadata.gz: 6671beaae7b1d6e997b973c15ae8d795c9a8cf5c11b2f2e2c374cd6881270bea3b1211f61ff94e204f99c92ee8f40fc0edc478f9ee36f5aafdd6a1ca2baabf49
-  data.tar.gz: 54ab55daf2d791f86c5f3d707c6bf98c4c6d5d7113b84a7ef75fa4164f6b06e61f267cee8115dfabc78f109c6f9b25d07249bceb0754533dd962c1181680d43b
+  metadata.gz: b1063bfd67d77804819728d33e1c13d11daa65c295e1647ee7a2af4acdf115810ec777545964c085feb4b6c86cae78312699c2ff7a11621d37f766eac3407389
+  data.tar.gz: bf754bf16417db1effd756db76bd536a745eb82e6275bb842926888a5f8b2f2e945e55d7db37d12f94a5f1576fe849d0856d09fac1a8836ed59901bfade12626

data/README.md

@@ -88,6 +88,17 @@ Add a `config/initializers/slave_pools.rb` if you want to change config settings
 
     SlavePools.config.defaults_to_master = true
 
+#### Configure Errors to not replay on master
+
+Some errors you may not want to replay on master, e.g. queries that timeout.
+
+This can be configured by updating the no_replay_on_master with a hash of errors and the corresponding messages that should not be replayed, e.g.:
+
+    SlavePools.config.no_replay_on_master = {
+      'Mysql2::Error' => ['Timeout waiting for a response from the last query', 'other error message that you don't want to replay'],
+      'TimeoutError' => ['some message']
+    }
+
 ## Usage
 
 Toggle to next replica:

data/lib/slave_pools/config.rb

@@ -13,10 +13,16 @@ module SlavePools
     # Defaults are based on Rails version.
     attr_accessor :safe_methods
 
+    # enter a list of errors/messages that shouldn't fall back to master
+    # of the form {'ErrorClass' => ['message regex1', 'message regex 2'], }
+    # Defaults are {'Mysql2::Error' => ['Timeout waiting for a response from the last query']}.
+    attr_accessor :no_replay_on_master
+
     def initialize
       @environment        = 'development'
       @defaults_to_master = false
       @safe_methods       = []
+      @no_replay_on_master = {}
     end
   end
 end

data/lib/slave_pools/connection_proxy.rb

@@ -121,11 +121,14 @@ module SlavePools
     end
 
     # decides whether to replay query against master based on the
-    # exception raised. this could become more sophisticated.
+    # exception and message.
+    # These can be adjusted by setting SlavePools.configs.no_replay_on_master.
     def safe_to_replay(e)
-      # don't replay queries that time out. we don't have the time, and they
-      # could be dangerous.
-      ! e.message.match(/Timeout waiting for a response from the last query/)
+      return true unless flagged_messages_for_error = SlavePools.config.no_replay_on_master[e.class.to_s]
+
+      return false if flagged_messages_for_error.any? {|m| e.message.match(m)}
+
+      true
     end
 
     private

data/lib/slave_pools/engine.rb

@@ -21,6 +21,9 @@ module SlavePools
         else
           warn "Unsupported ActiveRecord version #{ActiveRecord.version}. Please whitelist the safe methods."
         end
+      SlavePools.config.no_replay_on_master = {
+        'Mysql2::Error' => ['Timeout waiting for a response from the last query']
+      }
     end
 
     config.after_initialize do

data/lib/slave_pools/version.rb

@@ -1,3 +1,3 @@
 module SlavePools
-  VERSION = "1.0.0.rc4"
+  VERSION = "1.1.0"
 end

data/spec/connection_proxy_spec.rb

@@ -143,25 +143,20 @@ describe SlavePools do
     @proxy.should respond_to(:unsafe)
   end
 
-  it 'should NOT rescue a non Mysql2::Error' do
-    @default_slave1.should_receive(:select_all).once.and_raise(RuntimeError.new('some error'))
-    @default_slave2.should_not_receive(:select_all)
-    @master.should_not_receive(:select_all)
-    lambda { @proxy.select_all(@sql) }.should raise_error
-  end
-
-  it 'should rescue a Mysql::Error fall back to the master' do
-    @default_slave1.should_receive(:select_all).once.and_raise(Mysql2::Error.new('connection error'))
+  it 'should rescue an error not flagged as no replay' do
+    SlavePools.config.no_replay_on_master = {'Mysql2::Error' => ['random message']}
+    @default_slave1.should_receive(:select_all).once.and_raise(Mysql2::Error.new('Timeout waiting for a response'))
     @default_slave2.should_not_receive(:select_all)
     @master.should_receive(:select_all).and_return(true)
     lambda { @proxy.select_all(@sql) }.should_not raise_error
   end
 
-  it 'should re-raise a Mysql::Error from a query timeout and not fall back to master' do
-    @default_slave1.should_receive(:select_all).once.and_raise(Mysql2::Error.new('Timeout waiting for a response from the last query. (waited 5 seconds)'))
+  it 'should re-raise a Error that is flagged as no replay' do
+    SlavePools.config.no_replay_on_master = {'ArgumentError' => ['random message']}
+    @default_slave1.should_receive(:select_all).once.and_raise(ArgumentError.new('random message'))
     @default_slave2.should_not_receive(:select_all)
     @master.should_not_receive(:select_all)
-    lambda { @proxy.select_all(@sql) }.should raise_error
+    lambda { @proxy.select_all(@sql) }.should raise_error(ArgumentError)
   end
 
   it 'should reload models from the master' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: slave_pools
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc4
+  version: 1.1.0
 platform: ruby
 authors:
 - Dan Drabik
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-05 00:00:00.000000000 Z
+date: 2014-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -139,7 +139,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '1.2'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: Connection proxy for ActiveRecord for master / replica setups.