activerecord-mysql-reconnect 0.3.0 → 0.3.1

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NDdmZDFhNjRlZDc1YWRhY2I0NmFhZTViZDA4MjEzN2RkMTJlMTRiZQ==
+    YmEzYzliYTU5N2ZmYjFkZGJjMGM0NmY3Yjc0NzhkYjhmM2YwZDBkNg==
   data.tar.gz: !binary |-
-    ZWEwZGEwNGNmYTExNjA5MmRkYjcxOWZjYjMxMjk0ZjBjYTI3NzJhYw==
+    MzgwZjEzNmVjMmQwZTlhMDY4ZGU5MDY0MjZiNzJhODViMzBlMjYyYg==
 SHA512:
   metadata.gz: !binary |-
-    YTE2ZTU2OTMxNTk4MzYyY2FiMzdlZWFhMDBlMjE1ZDlhMDBmYjk4OTQyN2Ji
-    MDc1YzhmNjQ4ZGU5MWJmMWNlZDYzZTNlMTRjNTgwMjNmZTJmY2RhMDQxMzRi
-    ODhjYmM1NmIyZTZmNGQzY2QyZDEyYzY3NjE2YmI5NmM4YTI5MzU=
+    Yjk2YWZlZDZiMDE0MzQ5ZWZkZjFjNDJkZjM2OTQxNDEwMWI0NjA5Zjg4NzRm
+    MjM4OWU3ZjdhNjY3MDkyMDMwYjIxNzVjZGM1Mzk1MGQ5NWQzMzI2NTFmMTg2
+    OTNmZDljMDViZmIyNmM5NDU0N2M2NWE0M2NmZTllNWFjOWJiMTk=
   data.tar.gz: !binary |-
-    YzNhOTRmMTZiZTU0MmM4NTdiM2FkMDI2Y2QzZDkyMTA3ZTgwOGM4MjM5ZGY3
-    YjcwZGUxNDE0ODE4MDkxNzM3Yzg2MWNmMmZjNDBmYWI0NTYyZDAzYmI1NjI2
-    ZGI4YzIwZTZiNWU3Y2VmYjljNmIxMzhlYjJlYzlkNDg5NjRlYTM=
+    ZmFkYWY5YmJkOThhYzBhN2JmOGZlOTM3NDM4Mzg1OGE2ZDJjYTU5YzVjZDcz
+    YWEzMDZlZDJiMThmM2QwYzcwMDg0YmZhZDA4YjEwNDA5YWE0ZmUxNTc4NGFk
+    NWU3OWM1ZTZiOTYzYTFlNjNkZjNhZDA1ZWJjNDZjMWFkZjRiNTc=

data/ChangeLog

@@ -1,3 +1,7 @@
+activerecord-mysql-reconnect 0.3.1 (January 9, 2014)
+
+	* Retry mode is added
+
 activerecord-mysql-reconnect 0.3.0 (January 9, 2014)
 
 	* Retry is disabled by default

data/README.md

@@ -91,11 +91,17 @@ MyApp::Application.configure do
   config.active_record.enable_retry = true
   config.active_record.execution_tries = 10 # times
   config.active_record.execution_retry_wait = 1.5 # sec
-  config.active_record.retry_read_only = false # default: true
+  config.active_record.retry_mode = :rw # default: `:r`, valid values: `:r`, `:rw`, `:force`
   ...
 ene
 ```
 
+## Retry mode
+
+* `:r`      Retry only SELECT / SHOW / SET
+* `:rw`     Retry in all SQL, but does not retry if `Lost connection` has happened in write SQL
+* `:force`  Retry in all SQL
+
 ## Running tests on local
 
 ```sh

data/lib/activerecord/mysql/reconnect.rb

@@ -46,6 +46,9 @@ module Activerecord::Mysql::Reconnect
 
   READ_SQL_REGEXP = /\A\s*(?:SELECT|SHOW|SET)\b/i
 
+  RETRY_MODES = [:r, :rw, :force]
+  DEFAULT_RETRY_MODE = :r
+
   class << self
     def execution_tries
       ActiveRecord::Base.execution_tries || DEFAULT_EXECUTION_TRIES
@@ -59,8 +62,16 @@ module Activerecord::Mysql::Reconnect
       !!ActiveRecord::Base.enable_retry
     end
 
-    def retry_read_only
-      !!ActiveRecord::Base.retry_read_only
+    def retry_mode=(v)
+      unless RETRY_MODES.include?(v)
+        raise "Invalid retry_mode. Please set one of the following: #{RETRY_MODES.map {|i| i.inspect }.join(', ')}"
+      end
+
+      @activerecord_mysql_reconnect_retry_mode = v
+    end
+
+    def retry_mode
+      @activerecord_mysql_reconnect_retry_mode || DEFAULT_RETRY_MODE
     end
 
     def retryable(opts)
@@ -145,8 +156,8 @@ module Activerecord::Mysql::Reconnect
     end
 
     def should_handle?(e, opts = {})
-      sql       = opts[:sql]
-      read_only = opts[:read_only]
+      sql        = opts[:sql]
+      retry_mode = opts[:retry_mode]
 
       if without_retry?
         return false
@@ -161,7 +172,11 @@ module Activerecord::Mysql::Reconnect
       end
 
       if sql and READ_SQL_REGEXP !~ sql
-        if read_only or Regexp.union(HANDLE_R_ERROR_MESSAGES) =~ e.message
+        if retry_mode == :r
+          return false
+        end
+
+        if retry_mode != :force and Regexp.union(HANDLE_R_ERROR_MESSAGES) =~ e.message
           return false
         end
       end

data/lib/activerecord/mysql/reconnect/abstract_mysql_adapter_ext.rb

@@ -37,7 +37,7 @@ class ActiveRecord::ConnectionAdapters::AbstractMysqlAdapter
         sql_names = merge_transaction(sql, name)
       },
       :sql => sql,
-      :read_only => Activerecord::Mysql::Reconnect.retry_read_only,
+      :retry_mode => Activerecord::Mysql::Reconnect.retry_mode,
       :connection => @connection
     )
   end

data/lib/activerecord/mysql/reconnect/base_ext.rb

@@ -2,9 +2,19 @@ class ActiveRecord::Base
   class_attribute :execution_tries,      :instance_accessor => false
   class_attribute :execution_retry_wait, :instance_accessor => false
   class_attribute :enable_retry,         :instance_accessor => false
-  class_attribute :retry_read_only,      :instance_accessor => false, :default => true
+
+  RETRY_MODES = [:r, :rw, :force]
+  DEFAULT_RETRY_MODE = :r
 
   class << self
+    def retry_mode=(v)
+       Activerecord::Mysql::Reconnect.retry_mode = v
+    end
+
+    def retry_mode
+       Activerecord::Mysql::Reconnect.retry_mode
+    end
+
     def without_retry
       Activerecord::Mysql::Reconnect.without_retry do
         yield

data/lib/activerecord/mysql/reconnect/version.rb

@@ -1,7 +1,7 @@
 module Activerecord
   module Mysql
     module Reconnect
-      VERSION = '0.3.0'
+      VERSION = '0.3.1'
     end
   end
 end

data/spec/activerecord-mysql-reconnect_spec.rb

@@ -243,10 +243,16 @@ describe 'activerecord-mysql-reconnect' do
   end
 
   it 'lost connection' do
+    sql = "INSERT INTO `employees` (`birth_date`, `emp_no`, `first_name`, `hire_date`, `last_name`) VALUES ('2014-01-09 03:22:25', 1, '' + sleep(15) + '', '2014-01-09 03:22:25', 'Tiger')"
+
+    expect {
+      ActiveRecord::Base.connection.execute(sql)
+    }.to_not raise_error
+
     mysql2_error('Lost connection to MySQL server during query') do
       expect {
         th = thread_run {|do_stop|
-          ActiveRecord::Base.connection.execute("INTO `employees` (`birth_date`, `emp_no`, `first_name`, `hire_date`, `last_name`) VALUES ('2014-01-09 03:22:25', 1, '' + sleep(15) + '', '2014-01-09 03:22:25', 'Tiger')")
+          ActiveRecord::Base.connection.execute(sql)
         }
 
         mysql_restart
@@ -254,4 +260,25 @@ describe 'activerecord-mysql-reconnect' do
       }.to raise_error(ActiveRecord::StatementInvalid)
     end
   end
+
+  it 'force retry' do
+    sql = "INSERT INTO `employees` (`birth_date`, `emp_no`, `first_name`, `hire_date`, `last_name`) VALUES ('2014-01-09 03:22:25', 1, '' + sleep(15) + '', '2014-01-09 03:22:25', 'Tiger')"
+
+    expect {
+      ActiveRecord::Base.connection.execute(sql)
+    }.to_not raise_error
+
+    mysql2_error('Lost connection to MySQL server during query') do
+      expect {
+        th = thread_run {|do_stop|
+          force_retry do
+            ActiveRecord::Base.connection.execute(sql)
+          end
+        }
+
+        mysql_restart
+        th.join
+      }.to_not raise_error
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -49,11 +49,21 @@ end
 
 def enable_read_only
   begin
-    expect(ActiveRecord::Base.retry_read_only).to be_false
-    ActiveRecord::Base.retry_read_only = true
+    expect(ActiveRecord::Base.retry_mode).to eq(:rw)
+    ActiveRecord::Base.retry_mode = :r
     yield
   ensure
-    ActiveRecord::Base.retry_read_only = false
+    ActiveRecord::Base.retry_mode = :rw
+  end
+end
+
+def force_retry
+  begin
+    expect(ActiveRecord::Base.retry_mode).to eq(:rw)
+    ActiveRecord::Base.retry_mode = :force
+    yield
+  ensure
+    ActiveRecord::Base.retry_mode = :rw
   end
 end
 
@@ -90,6 +100,6 @@ RSpec.configure do |config|
     ActiveRecord::Base.logger.formatter = proc {|_, _, _, message| "#{message}\n" }
     ActiveRecord::Base.enable_retry = true
     ActiveRecord::Base.execution_tries = 10
-    ActiveRecord::Base.retry_read_only = false
+    ActiveRecord::Base.retry_mode = :rw
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-mysql-reconnect
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Genki Sugawara