transaction_retry 1.0.2 → 1.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d1df0fe99befc0a42b9592bb8754bcbc2292eca74213bfad5d114e6840215e70
+  data.tar.gz: 4222a52c9ec709bdf073407ed5d68d90d79d9fcbee91b8830568b262c0210533
+SHA512:
+  metadata.gz: d0cc9e6240e23876803a76f25f073af9870fa62ea32729a994eefb4895a03fe40a85036c1202a1f6da4a780491a487837d0d60df25ed6473ba88351e723ddfac
+  data.tar.gz: f832595233174a12720025a595e94546ee61c9b4a15836d72f9183fb41f86635c683614329831efb7895b583521ddf49203e2f34027a4ce26fa07d93451cfaa8

data/README.md

@@ -24,6 +24,24 @@ If you have a standalone ActiveRecord-based project you'll need to call:
 
 __after__ connecting to the database.
 
+## Database deadlock and serialization errors that are retried
+
+#### MySQL
+
+ * Deadlock found when trying to get lock
+ * Lock wait timeout exceeded
+
+#### PostgreSQL
+
+ * deadlock detected
+ * could not serialize access
+
+#### SQLite
+
+ * The database file is locked
+ * A table in the database is locked
+ * Database lock protocol error
+
 ## Configuration
 
 You can optionally configure transaction_retry gem in your config/initializers/transaction_retry.rb (or anywhere else):

data/lib/transaction_retry.rb

@@ -38,4 +38,12 @@ module TransactionRetry
     @@wait_times = array_of_seconds
   end
 
+  def self.fuzz
+    @@fuzz ||= true
+  end
+
+  def self.fuzz=( val )
+    @@fuzz = val
+  end
+
 end

data/lib/transaction_retry/active_record/base.rb

@@ -19,15 +19,32 @@ module TransactionRetry
         def transaction_with_retry(*objects, &block)
           retry_count = 0
 
+          opts = if objects.last.is_a? Hash
+            objects.last
+          else
+            {}
+          end
+
+          retry_on = opts.delete(:retry_on)
+          max_retries = opts.delete(:max_retries) || TransactionRetry.max_retries
+
           begin
             transaction_without_retry(*objects, &block)
-          rescue ::ActiveRecord::TransactionIsolationConflict
-            raise if retry_count >= TransactionRetry.max_retries
+          rescue *[::ActiveRecord::TransactionIsolationConflict, *retry_on]
+            raise if retry_count >= max_retries
             raise if tr_in_nested_transaction?
             
             retry_count += 1
             postfix = { 1 => 'st', 2 => 'nd', 3 => 'rd' }[retry_count] || 'th'
-            logger.warn "Transaction isolation conflict detected. Retrying for the #{retry_count}-#{postfix} time..." if logger
+
+            type_s = case $!
+            when ::ActiveRecord::TransactionIsolationConflict
+              "Transaction isolation conflict"
+            else
+              $!.class.name
+            end
+
+            logger.warn "#{type_s} detected. Retrying for the #{retry_count}-#{postfix} time..." if logger
             tr_exponential_pause( retry_count )
             retry
           end
@@ -40,6 +57,13 @@ module TransactionRetry
           # An ugly tr_ prefix is used to minimize the risk of method clash in the future.
           def tr_exponential_pause( count )
             seconds = TransactionRetry.wait_times[count-1] || 32
+
+            if TransactionRetry.fuzz
+              fuzz_factor = [seconds * 0.25, 1].max
+
+              seconds += rand * (fuzz_factor * 2) - fuzz_factor
+            end
+
             sleep( seconds ) if seconds > 0
           end
         

data/lib/transaction_retry/version.rb

@@ -1,3 +1,3 @@
 module TransactionRetry
-  VERSION = "1.0.2"
+  VERSION = "1.0.3"
 end

data/test/integration/active_record/base/transaction_with_retry_test.rb

@@ -3,6 +3,8 @@
 require 'test_helper'
 
 class TransactionWithRetryTest < MiniTest::Unit::TestCase
+  class CustomError < StandardError
+  end
 
   def setup
     @original_max_retries = TransactionRetry.max_retries
@@ -48,6 +50,38 @@ class TransactionWithRetryTest < MiniTest::Unit::TestCase
     QueuedJob.first.destroy
   end
 
+  def test_does_not_retry_on_unknown_error
+    first_run = true
+
+    assert_raises( CustomError ) do
+      ActiveRecord::Base.transaction do
+        if first_run
+          first_run = false
+          message = "Deadlock found when trying to get lock"
+          raise CustomError, "random error"
+        end
+        QueuedJob.create!( :job => 'is cool!' )
+      end
+    end
+    assert_equal( 0, QueuedJob.count )
+  end
+
+  def test_retries_on_custom_error
+    first_run = true
+
+    ActiveRecord::Base.transaction(retry_on: CustomError) do
+      if first_run
+        first_run = false
+        message = "Deadlock found when trying to get lock"
+        raise CustomError, "random error"
+      end
+      QueuedJob.create!( :job => 'is cool!' )
+    end
+    assert_equal( 1, QueuedJob.count )
+    
+    QueuedJob.first.destroy
+  end
+
   def test_does_not_retry_transaction_more_than_max_retries_times
     TransactionRetry.max_retries = 1
     run = 0
@@ -61,6 +95,20 @@ class TransactionWithRetryTest < MiniTest::Unit::TestCase
     end
     
     assert_equal( 2, run )  # normal run + one retry
+
+    TransactionRetry.max_retries = 3
+
+    run = 0
+
+    assert_raises( ActiveRecord::TransactionIsolationConflict ) do
+      ActiveRecord::Base.transaction(max_retries: 1) do
+        run += 1
+        message = "Deadlock found when trying to get lock"
+        raise ActiveRecord::TransactionIsolationConflict.new( ActiveRecord::StatementInvalid.new( message ), message )
+      end
+    end
+    
+    assert_equal( 2, run )  # normal run + one retry
   end
 
   def test_does_not_retry_nested_transaction

metadata

@@ -1,38 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: transaction_retry
 version: !ruby/object:Gem::Version
-  version: 1.0.2
-  prerelease: 
+  version: 1.0.3
 platform: ruby
 authors:
 - Piotr 'Qertoip' Włodarek
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-08 00:00:00.000000000 Z
+date: 2018-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &9671100 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.11
   type: :runtime
   prerelease: false
-  version_requirements: *9671100
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.11
 - !ruby/object:Gem::Dependency
   name: transaction_isolation
-  requirement: &9688920 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.2
   type: :runtime
   prerelease: false
-  version_requirements: *9688920
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.2
 description: Retries database transaction on deadlock and transaction serialization
   errors. Supports MySQL, PostgreSQL and SQLite (as long as you are using new drivers
   mysql2, pg, sqlite3).
@@ -42,7 +47,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - LICENSE
 - README.md
@@ -65,27 +70,36 @@ files:
 - transaction_retry.gemspec
 homepage: https://github.com/qertoip/transaction_retry
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.15
+rubygems_version: 2.7.6
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Retries database transaction on deadlock and transaction serialization errors.
   Supports MySQL, PostgreSQL and SQLite.
-test_files: []
+test_files:
+- test/db/all.rb
+- test/db/db.rb
+- test/db/migrations.rb
+- test/db/queued_job.rb
+- test/integration/active_record/base/transaction_with_retry_test.rb
+- test/library_setup.rb
+- test/log/.gitkeep
+- test/test_console.rb
+- test/test_helper.rb
+- test/test_runner.rb