mperham-deadlock_retry 1.0.0

data/CHANGELOG

@@ -0,0 +1,7 @@
+deadlock_retry changes
+
+== v1.0 - (2009-02-07)
+
+* Add INNODB status logging for debugging deadlock issues.
+* Clean up so the code will run as a gem plugin. 
+* Small fix for ActiveRecord 2.1.x compatibility.

data/README

@@ -0,0 +1,20 @@
+= Deadlock Retry
+
+Deadlock retry allows the database adapter (currently only tested with the
+MySQLAdapter) to retry transactions that fall into deadlock. It will retry
+such transactions three times before finally failing.
+
+This capability is automatically added to ActiveRecord. No code changes or otherwise are required.
+
+== Installation
+
+Add it to your Rails application by installing the gem:
+
+  sudo gem install mperham-deadlock_retry
+
+and including a reference to it in your application's config/environment.rb:
+
+  config.gem 'mperham-deadlock_retry', :lib => 'deadlock_retry', :source => 'http://gems.github.com'
+
+
+Copyright (c) 2005 Jamis Buck, released under the MIT license

data/Rakefile

@@ -0,0 +1,25 @@
+require 'rake'
+require 'rake/testtask'
+
+desc "Default task"
+task :default => [ :test ]
+
+Rake::TestTask.new do |t|
+  t.test_files = Dir["test/**/*_test.rb"]
+  t.verbose = true
+end
+
+begin
+  require 'jeweler'
+
+  Jeweler::Tasks.new do |s|
+    s.name = "deadlock_retry"
+    s.email = "mperham@gmail.com"
+    s.homepage = "http://github.com/mperham/deadlock_retry"
+    s.description = s.summary = "Provides automatical deadlock retry and logging functionality for ActiveRecord and MySQL"
+    s.authors = ["Jamis Buck", "Mike Perham"]
+    s.files =  FileList['README', 'Rakefile', 'version.yml', "{lib,test}/**/*", 'CHANGELOG']
+  end
+rescue LoadError
+  # Jeweler, or one of its dependencies, is not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com
+end

data/lib/deadlock_retry.rb

@@ -0,0 +1,83 @@
+# Copyright (c) 2005 Jamis Buck
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+module DeadlockRetry
+
+  def self.included(base)
+    base.extend(ClassMethods)
+    base.class_eval do
+      class << self
+        alias_method_chain :transaction, :deadlock_handling
+      end
+    end
+  end
+
+  module ClassMethods
+    DEADLOCK_ERROR_MESSAGES = [
+      "Deadlock found when trying to get lock",
+      "Lock wait timeout exceeded"
+    ]
+
+    MAXIMUM_RETRIES_ON_DEADLOCK = 3
+
+    def transaction_with_deadlock_handling(*objects, &block)
+      retry_count = 0
+
+      begin
+        transaction_without_deadlock_handling(*objects, &block)
+      rescue ActiveRecord::StatementInvalid => error
+        raise if in_nested_transaction?
+        if DEADLOCK_ERROR_MESSAGES.any? { |msg| error.message =~ /#{Regexp.escape(msg)}/ }
+          raise if retry_count >= MAXIMUM_RETRIES_ON_DEADLOCK
+          retry_count += 1
+          logger.info "Deadlock detected on retry #{retry_count}, restarting transaction"
+          log_innodb_status
+          retry
+        else
+          raise
+        end
+      end
+    end
+
+    private
+
+    def in_nested_transaction?
+      cn = connection
+      # open_transactions was added in 2.2's connection pooling changes.
+      cn.respond_to?(:open_transactions) && cn.open_transactions != 0
+    end
+
+    def log_innodb_status
+      # show innodb status is the only way to get visiblity into why
+      # the transaction deadlocked.  log it.
+      lines = connection.select_value("show innodb status")
+      logger.warn "INNODB Status follows:"
+      lines.each_line do |line|
+        logger.warn line
+      end
+    rescue Exception => e
+      # Access denied, ignore
+      logger.warn "Cannot log innodb status: #{e.message}"
+    end
+
+  end
+end
+
+ActiveRecord::Base.send(:include, DeadlockRetry)

data/test/deadlock_retry_test.rb

@@ -0,0 +1,89 @@
+require 'rubygems'
+
+# Change the version if you want to test a different version of ActiveRecord
+gem 'activerecord', '2.2.2'
+require 'active_record'
+require 'active_record/version'
+puts "Testing ActiveRecord #{ActiveRecord::VERSION::STRING}"
+
+require 'test/unit'
+require "#{File.dirname(__FILE__)}/../lib/deadlock_retry"
+
+class MockModel
+  @@open_transactions = 0
+
+  def self.transaction(*objects)
+    @@open_transactions += 1
+    yield
+  ensure
+    @@open_transactions -= 1
+  end
+
+  def self.open_transactions
+    @@open_transactions
+  end
+
+  def self.connection
+    self
+  end
+
+  def self.logger
+    @logger ||= Logger.new(nil)
+  end
+
+  include DeadlockRetry
+end
+
+class DeadlockRetryTest < Test::Unit::TestCase
+  DEADLOCK_ERROR = "MySQL::Error: Deadlock found when trying to get lock"
+  TIMEOUT_ERROR = "MySQL::Error: Lock wait timeout exceeded"
+
+  def test_no_errors
+    assert_equal :success, MockModel.transaction { :success }
+  end
+
+  def test_no_errors_with_deadlock
+    errors = [ DEADLOCK_ERROR ] * 3
+    assert_equal :success, MockModel.transaction { raise ActiveRecord::StatementInvalid, errors.shift unless errors.empty?; :success }
+    assert errors.empty?
+  end
+
+  def test_no_errors_with_lock_timeout
+    errors = [ TIMEOUT_ERROR ] * 3
+    assert_equal :success, MockModel.transaction { raise ActiveRecord::StatementInvalid, errors.shift unless errors.empty?; :success }
+    assert errors.empty?
+  end
+
+  def test_error_if_limit_exceeded
+    assert_raise(ActiveRecord::StatementInvalid) do
+      MockModel.transaction { raise ActiveRecord::StatementInvalid, DEADLOCK_ERROR }
+    end
+  end
+
+  def test_error_if_unrecognized_error
+    assert_raise(ActiveRecord::StatementInvalid) do
+      MockModel.transaction { raise ActiveRecord::StatementInvalid, "Something else" }
+    end
+  end
+
+  def test_included_by_default
+    assert ActiveRecord::Base.respond_to?(:transaction_with_deadlock_handling)
+  end
+
+  def test_error_in_nested_transaction_should_retry_outermost_transaction
+    tries = 0
+    errors = 0
+
+    MockModel.transaction do
+      tries += 1
+      MockModel.transaction do
+        MockModel.transaction do
+          errors += 1
+          raise ActiveRecord::StatementInvalid, "MySQL::Error: Lock wait timeout exceeded" unless errors > 3
+        end
+      end
+    end
+  
+    assert_equal 4, tries
+  end
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification 
+name: mperham-deadlock_retry
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Jamis Buck
+- Mike Perham
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-02-07 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: Provides automatical deadlock retry and logging functionality for ActiveRecord and MySQL
+email: mperham@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README
+- Rakefile
+- version.yml
+- lib/deadlock_retry.rb
+- test/deadlock_retry_test.rb
+- CHANGELOG
+has_rdoc: true
+homepage: http://github.com/mperham/deadlock_retry
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Provides automatical deadlock retry and logging functionality for ActiveRecord and MySQL
+test_files: []
+