Update deadlock_retry plugin with latest upstream code.
[rails.git] / 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     ]
38
39     MAXIMUM_RETRIES_ON_DEADLOCK = 3
40
41     def transaction_with_deadlock_handling(*objects, &block)
42       retry_count = 0
43
44       begin
45         transaction_without_deadlock_handling(*objects, &block)
46       rescue ActiveRecord::StatementInvalid => error
47         raise unless connection.open_transactions.zero?
48         if DEADLOCK_ERROR_MESSAGES.any? { |msg| error.message =~ /#{Regexp.escape(msg)}/ }
49           raise if retry_count >= MAXIMUM_RETRIES_ON_DEADLOCK
50           retry_count += 1
51           logger.info "Deadlock detected on retry #{retry_count}, restarting transaction"
52           retry
53         else
54           raise
55         end
56       end
57     end
58   end
59 end