vendor/plugins/deadlock_retry/lib/deadlock_retry.rb

   1 # Copyright (c) 2005 Jamis Buck
   2 #
   3 # Permission is hereby granted, free of charge, to any person obtaining
   4 # a copy of this software and associated documentation files (the
   5 # "Software"), to deal in the Software without restriction, including
   6 # without limitation the rights to use, copy, modify, merge, publish,
   7 # distribute, sublicense, and/or sell copies of the Software, and to
   8 # permit persons to whom the Software is furnished to do so, subject to
   9 # the following conditions:
  10 #
  11 # The above copyright notice and this permission notice shall be
  12 # included in all copies or substantial portions of the Software.
  13 #
  14 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  15 # EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  16 # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  17 # NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  18 # LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  19 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  20 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  21 module DeadlockRetry
  22   def self.append_features(base)
  23     super
  24     base.extend(ClassMethods)
  25     base.class_eval do
  26       class <<self
  27         alias_method :transaction_without_deadlock_handling, :transaction
  28         alias_method :transaction, :transaction_with_deadlock_handling
  29       end
  30     end
  31   end
  32
  33   module ClassMethods
  34     DEADLOCK_ERROR_MESSAGES = [
  35       "Deadlock found when trying to get lock",
  36       "Lock wait timeout exceeded",
  37       "deadlock detected"
  38     ]
  39
  40     MAXIMUM_RETRIES_ON_DEADLOCK = 3
  41
  42     def transaction_with_deadlock_handling(*objects, &block)
  43       retry_count = 0
  44
  45       begin
  46         transaction_without_deadlock_handling(*objects, &block)
  47       rescue ActiveRecord::StatementInvalid => error
  48         raise unless connection.open_transactions.zero?
  49         if DEADLOCK_ERROR_MESSAGES.any? { |msg| error.message =~ /#{Regexp.escape(msg)}/ }
  50           raise if retry_count >= MAXIMUM_RETRIES_ON_DEADLOCK
  51           retry_count += 1
  52           logger.info "Deadlock detected on retry #{retry_count}, restarting transaction"
  53           retry
  54         else
  55           raise
  56         end
  57       end
  58     end
  59   end
  60 end