activerecord-deadlock_retry 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 97884d7318a921aa4fb0215ef76bda5765bd4870
+  data.tar.gz: 2e0af2a0d9739491aadff728095e386ed794c57c
+SHA512:
+  metadata.gz: 79b0ca54b8c311e423f0352c8f845d20e8dbb7d1e5700751cf3452b36fedf37d6ff4c2e054225f22d554c1a5b22c7d2e933fc976d558bf12ff3a6036aa861587
+  data.tar.gz: a5bc8ba00a65683e863689ebe22dddf535ffaa2d957d982d4d8f919feeaf08c383aeccd0d90d142177f9a0fbb56238c974baf29106f594c666af52c92611aa15

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in activerecord-deadlock_retry.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Helge Rausch
+
+MIT License
+
+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.

data/README.md

@@ -0,0 +1,36 @@
+# ActiveRecord::DeadlockRetry
+
+Retries a transaction when a deadlock exception is returned from the database.
+Currently works with MySQL.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'activerecord-deadlock_retry'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install activerecord-deadlock_retry
+
+## Usage
+
+```ruby
+ActiveRecord::DeadlockRetry.transaction do
+  # Your possibly deadlocking code here
+end
+```
+
+`ActiveRecord::DeadlockRetry.transaction` optionally takes an options hash with
+the following options:
+
+* `:class` - Class `transaction` (or `:method`) is called on. Defaults to
+  `ActiveRecord::Base`.
+* `:method` - Method to call on `:class` (or `ActiveRecord::Base`). Defauls to
+  `transaction`.
+* `:retries` - Number of retries. Defaults to `3`.
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/activerecord-deadlock_retry.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "activerecord-deadlock_retry"
+  spec.version       = "0.0.3"
+  spec.authors       = ["ad2games"]
+  spec.email         = ["devops@ad2games.com"]
+  spec.homepage      = "http://ad2games.com"
+  spec.summary       = %q{Retry deadlocked ActiveRecord transactions}
+  spec.description   = %q{Retry deadlocked ActiveRecord transactions}
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activerecord"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/circle.yml

@@ -0,0 +1,7 @@
+deployment:
+  production:
+    branch: master
+    commands:
+      - gem install geminabox
+      - gem build activerecord-deadlock_retry.gemspec
+      - gem inabox activerecord-deadlock_retry-*.gem --host $GEMINABOX_URL

data/lib/activerecord/deadlock_retry.rb

@@ -0,0 +1,36 @@
+module ActiveRecord
+  class DeadlockRetry
+    LOG_DIR = 'log'
+
+    def self.transaction(opts={}, &block)
+      klass   = opts[:class]   || ActiveRecord::Base
+      method  = opts[:method]  || :transaction
+      retries = opts[:retries] || 5
+      begin
+        klass.send(method, &block)
+      rescue ActiveRecord::StatementInvalid => e
+        if e.message =~ /Deadlock found when trying to get lock/ && retries > 0
+          retries -= 1
+          logger.info("ActiveRecord::DeadlockRetry: retrying transaction after deadlock (#{retries} retries left)")
+          sleep 5
+          retry
+        end
+        raise
+      end
+    end
+
+    def self.logger
+      return @logger if @logger
+      if defined?(Rails)
+        @logger = Rails.logger
+      else
+        Dir.mkdir(LOG_DIR) unless Dir.exist?(LOG_DIR)
+        @logger = Logger.new(File.join(LOG_DIR, 'deadlock_retry.log'))
+      end
+    end
+
+    def self.logger=(logger)
+      @logger = logger
+    end
+  end
+end

data/spec/activerecord_deadlock_retry_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+describe ActiveRecord::DeadlockRetry do
+
+  let(:block) { Proc.new {} }
+
+  it "runs a transaction" do
+    expect(ActiveRecord::Base).to receive(:transaction).with(&block)
+    ActiveRecord::DeadlockRetry.transaction(&block)
+  end
+
+  it "returns from a transaction when there was one deadlock" do
+    expect(ActiveRecord::Base).to receive(:transaction).
+      and_raise(ActiveRecord::StatementInvalid,
+                "Mysql2::Error: Deadlock found when trying to get lock; ...")
+    expect(ActiveRecord::Base).to receive(:transaction)
+    ActiveRecord::DeadlockRetry.transaction(&block)
+  end
+
+  it "raises the error, if all retries were unsuccessful" do
+    expect(ActiveRecord::Base).to receive(:transaction).exactly(6).times.
+      and_raise(ActiveRecord::StatementInvalid,
+                "Mysql2::Error: Deadlock found when trying to get lock; ...")
+    expect {
+      ActiveRecord::DeadlockRetry.transaction(&block)
+    }.to raise_error(ActiveRecord::StatementInvalid)
+  end
+
+  it "accepts a different class then the default" do
+    expect(OtherClass).to receive(:transaction).with(&block)
+    ActiveRecord::DeadlockRetry.transaction(class: OtherClass, &block)
+  end
+
+  it "accepts a different retry count than the default" do
+    expect(ActiveRecord::Base).to receive(:transaction).exactly(7).times.
+      and_raise(ActiveRecord::StatementInvalid,
+                "Mysql2::Error: Deadlock found when trying to get lock; ...")
+    expect {
+      ActiveRecord::DeadlockRetry.transaction(retries: 6, &block)
+    }.to raise_error(ActiveRecord::StatementInvalid)
+  end
+
+  it "accepts a different method than the default" do
+    expect(ActiveRecord::Base).to receive(:foo).with(&block)
+    ActiveRecord::DeadlockRetry.transaction(method: :foo, &block)
+  end
+end
+
+class OtherClass < ActiveRecord::Base
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'bundler/setup'
+require 'rspec'
+require 'active_record'
+require './lib/activerecord/deadlock_retry'

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-deadlock_retry
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- ad2games
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Retry deadlocked ActiveRecord transactions
+email:
+- devops@ad2games.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- activerecord-deadlock_retry.gemspec
+- circle.yml
+- lib/activerecord/deadlock_retry.rb
+- spec/activerecord_deadlock_retry_spec.rb
+- spec/spec_helper.rb
+homepage: http://ad2games.com
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Retry deadlocked ActiveRecord transactions
+test_files:
+- spec/activerecord_deadlock_retry_spec.rb
+- spec/spec_helper.rb