with_advisory_lock 0.0.1 → 0.0.2

data/README.md

@@ -66,6 +66,15 @@ The return value of ```with_advisory_lock``` will be the result of the yielded b
 if the lock was able to be acquired and the block yielded, or ```false```, if you provided
 a timeout_seconds value and the lock was not able to be acquired in time.
 
+### Gotchas
+
+**MySQL doesn't support nesting advisory locks.** If you ask for another advisory lock within
+a ```with_advisory_lock``` block, you will be releasing the parent lock.
+
+An warning message will be emitted to the rails logger in this case, because you
+probably didn't mean to lose the first lock. (Raising an exception would be safer. I'm open to
+suggestions on how to handle this dangerous case).
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -80,6 +89,11 @@ And then execute:
 
 ## Changelog
 
+### 0.0.2
+
+* Added warning log message for nested MySQL lock calls
+* Randomized lock wait time, which can help ameliorate lock contention
+
 ### 0.0.1
 
 * First whack

data/lib/with_advisory_lock/base.rb

@@ -22,7 +22,9 @@ module WithAdvisoryLock
             release_lock
           end
         else
-          sleep(0.1)
+          # sleep between 1/20 and ~1/5 of a second.
+          # Randomizing sleep time may help reduce contention.
+          sleep(rand * 0.15 + 0.05)
         end
       end
       false # failed to get lock in time.

data/lib/with_advisory_lock/concern.rb

@@ -18,16 +18,34 @@ module WithAdvisoryLock
     end
 
     module ClassMethods
+
       def with_advisory_lock(lock_name, timeout_seconds=nil, &block)
-        case (connection.adapter_name.downcase)
+        lock_stack = Thread.current[:with_advisory_lock_stack] ||= []
+        impl = case (connection.adapter_name.downcase)
           when "postgresql"
             WithAdvisoryLock::PostgreSQL
           when "mysql", "mysql2"
+            unless lock_stack.empty?
+              wal_log("with_advisory_lock: MySQL doesn't support nested advisory locks, and will now release lock '#{lock_stack.last}'")
+            end
             WithAdvisoryLock::MySQL
           else
             WithAdvisoryLock::Flock
-        end.new(connection, lock_name, timeout_seconds).with_advisory_lock(&block)
+        end
+        lock_stack.push(lock_name)
+        impl.new(connection, lock_name, timeout_seconds).with_advisory_lock(&block)
+      ensure
+        lock_stack.pop
+      end
+
+      def wal_log(msg)
+        if respond_to?(:logger) && logger
+          logger.warn(msg)
+        else
+          $stderr.puts(msg)
+        end
       end
+      private :wal_log
     end
   end
 end

data/lib/with_advisory_lock/version.rb

@@ -1,3 +1,3 @@
 module WithAdvisoryLock
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/test/concern_test.rb

@@ -0,0 +1,11 @@
+require 'minitest_helper'
+
+describe "with_advisory_lock.concern" do
+  it "adds with_advisory_lock to ActiveRecord classes" do
+    assert Tag.respond_to?(:with_advisory_lock)
+  end
+
+  it "adds with_advisory_lock to ActiveRecord instances" do
+    assert Tag.new.respond_to?(:with_advisory_lock)
+  end
+end

data/test/minitest_helper.rb

@@ -12,6 +12,7 @@ ActiveRecord::Migration.verbose = false
 require 'test_models'
 require 'minitest/autorun'
 require 'minitest/great_expectations'
+require 'mocha/setup'
 
 Thread.abort_on_exception = true
 

data/test/mysql_nesting_test.rb

@@ -0,0 +1,11 @@
+require 'minitest_helper'
+
+describe "lock nesting" do
+  it "warns about MySQL releasing advisory locks" do
+    Tag.expects(:wal_log)
+    Tag.with_advisory_lock("first") do
+      Tag.with_advisory_lock("second") do
+      end
+    end
+  end if ENV['DB'] == 'mysql'
+end

data/test/{with_advisory_lock_test.rb → parallelism_test.rb}

@@ -1,14 +1,6 @@
 require 'minitest_helper'
 
-describe "with_advisory_lock" do
-  it "adds with_advisory_lock to ActiveRecord classes" do
-    assert Tag.respond_to?(:with_advisory_lock)
-  end
-
-  it "adds with_advisory_lock to ActiveRecord instances" do
-    assert Tag.new.respond_to?(:with_advisory_lock)
-  end
-
+describe "parallelism" do
   def find_or_create_at_even_second(run_at, with_advisory_lock)
     sleep(run_at - Time.now.to_f)
     ActiveRecord::Base.connection.reconnect!
@@ -36,7 +28,7 @@ describe "with_advisory_lock" do
 
   before :each do
     @iterations = 5
-    @workers = 7
+    @workers = 10
   end
 
   it "parallel threads create multiple duplicate rows" do

data/with_advisory_lock.gemspec

@@ -23,6 +23,7 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'yard'
   gem.add_development_dependency 'minitest'
   gem.add_development_dependency 'minitest-great_expectations'
+  gem.add_development_dependency 'mocha'
   gem.add_development_dependency 'mysql2'
   gem.add_development_dependency 'pg'
   gem.add_development_dependency 'sqlite3'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: with_advisory_lock
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-20 00:00:00.000000000 Z
+date: 2013-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -91,6 +91,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: mysql2
   requirement: !ruby/object:Gem::Requirement
@@ -175,10 +191,12 @@ files:
 - lib/with_advisory_lock/mysql.rb
 - lib/with_advisory_lock/postgresql.rb
 - lib/with_advisory_lock/version.rb
+- test/concern_test.rb
 - test/database.yml
 - test/minitest_helper.rb
+- test/mysql_nesting_test.rb
+- test/parallelism_test.rb
 - test/test_models.rb
-- test/with_advisory_lock_test.rb
 - with_advisory_lock.gemspec
 homepage: ''
 licenses: []
@@ -194,7 +212,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2709177541654258140
+      hash: 1854060024724922654
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -203,7 +221,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2709177541654258140
+      hash: 1854060024724922654
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -211,8 +229,10 @@ signing_key:
 specification_version: 3
 summary: Advisory locking for ActiveRecord
 test_files:
+- test/concern_test.rb
 - test/database.yml
 - test/minitest_helper.rb
+- test/mysql_nesting_test.rb
+- test/parallelism_test.rb
 - test/test_models.rb
-- test/with_advisory_lock_test.rb
 has_rdoc: