with_advisory_lock 0.0.2 → 0.0.3

data/.travis.yml

@@ -7,13 +7,7 @@ rvm:
 env:
   - DB=sqlite
   - DB=mysql
-  - DB=pg
-
-# 1.8.7 and sqlite fails: "SQL statements in progress: rollback transaction"
-matrix:
-  exclude:
-    - rvm: 1.8.7
-      env: DB=sqlite
+  - DB=postgresql
 
 script: bundle exec rake
 

data/README.md

@@ -1,6 +1,6 @@
 # with_advisory_lock [![Build Status](https://api.travis-ci.org/mceachen/with_advisory_lock.png?branch=master)](https://travis-ci.org/mceachen/with_advisory_lock)
 
-Adds advisory locking to ActiveRecord 3.x.
+Adds advisory locking to ActiveRecord 3.2.x.
 [MySQL](http://dev.mysql.com/doc/refman/5.0/en/miscellaneous-functions.html#function_get-lock)
 and [PostgreSQL](http://www.postgresql.org/docs/9.1/static/functions-admin.html#FUNCTIONS-ADVISORY-LOCKS)
 are supported natively. SQLite resorts to file locking (which won't span hosts, of course!).
@@ -11,34 +11,6 @@ An advisory lock is a [mutex](http://en.wikipedia.org/wiki/Mutual_exclusion) use
 processes run some process at the same time. When the advisory lock is powered by your database
 server, as long as it isn't SQLite, your mutex spans hosts.
 
-Advisory locks ignore database transaction boundaries.
-
-## Lock Types
-
-First off, know that there are **lots** of different kinds of locks available to you. You want the
-finest-grain lock that ensures correctness. If you choose a lock that is too coarse, you are
-unnecessarily blocking other processes.
-
-### Row-level locks
-Whether [optimistic](http://api.rubyonrails.org/classes/ActiveRecord/Locking/Optimistic.html)
-or [pessimistic](http://api.rubyonrails.org/classes/ActiveRecord/Locking/Pessimistic.html),
-row-level locks prevent concurrent modification to a given model.
-
-**If you're building a
-[CRUD](http://en.wikipedia.org/wiki/Create,_read,_update_and_delete) application, this will be your
-most commonly used lock.**
-
-### Advisory locks
-
-These are named mutexes that are inherently "application level"—it is up to the application
-to acquire, run a critical code section, and release the advisory lock.
-
-### Table-level locks
-
-Provided through something like the [monogamy](https://github.com/mceachen/monogamy)
-gem, these prevent concurrent access to **any instance of a model**. You probably don't want these,
-and they can be a source of [deadlocks](http://en.wikipedia.org/wiki/Deadlock).
-
 ## Usage
 
 Where ```User``` is an ActiveRecord model, and ```lock_name``` is some string:
@@ -66,14 +38,20 @@ 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
+### Transactions and Advisory Locks
+
+Advisory locks with MySQL and PostgreSQL ignore database transaction boundaries.
+
+You will want to wrap your block within a transaction to ensure consistency.
 
-**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.
+### MySQL doesn't support nesting
 
-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).
+With MySQL, if you ask for another advisory lock within a ```with_advisory_lock``` block,
+you will be releasing the parent lock (!!!).
+
+A warning message will be emitted to the Rails logger in this case, because you
+probably didn't mean to lose your first lock. *Raising an exception would be safer. I'm open to
+suggestions on how to handle this dangerous case!*
 
 ## Installation
 
@@ -87,8 +65,40 @@ And then execute:
 
     $ bundle
 
+## Lock Types
+
+
+First off, know that there are **lots** of different kinds of locks available to you. **Pick the
+finest-grain lock that ensures correctness.** If you choose a lock that is too coarse, you are
+unnecessarily blocking other processes.
+
+### Advisory locks
+These are named mutexes that are inherently "application level"—it is up to the application
+to acquire, run a critical code section, and release the advisory lock.
+
+### Row-level locks
+Whether [optimistic](http://api.rubyonrails.org/classes/ActiveRecord/Locking/Optimistic.html)
+or [pessimistic](http://api.rubyonrails.org/classes/ActiveRecord/Locking/Pessimistic.html),
+row-level locks prevent concurrent modification to a given model.
+
+**If you're building a
+[CRUD](http://en.wikipedia.org/wiki/Create,_read,_update_and_delete) application, this will be your
+most commonly used lock.**
+
+### Table-level locks
+
+Provided through something like the [monogamy](https://github.com/mceachen/monogamy)
+gem, these prevent concurrent access to **any instance of a model**. Their coarseness means they
+aren't going to be commonly applicable, and they can be a source of
+[deadlocks](http://en.wikipedia.org/wiki/Deadlock).
+
 ## Changelog
 
+### 0.0.3
+
+* Fought with ActiveRecord 3.0.x and 3.1.x. You don't want them if you use threads—they fail
+  predictably.
+
 ### 0.0.2
 
 * Added warning log message for nested MySQL lock calls

data/lib/with_advisory_lock/version.rb

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

data/test/database.yml

@@ -1,9 +1,9 @@
 sqlite:
   adapter: <%= "jdbc" if defined? JRUBY_VERSION %>sqlite3
-  database: test/sqlite3.db
+  database: test/sqlite.db
   timeout: 500
   pool: 50
-pg:
+postgresql:
   adapter: postgresql
   username: postgres
   database: with_advisory_lock_test

data/test/minitest_helper.rb

@@ -6,7 +6,12 @@ require 'tmpdir'
 
 db_config = File.expand_path("database.yml", File.dirname(__FILE__))
 ActiveRecord::Base.configurations = YAML::load(ERB.new(IO.read(db_config)).result)
-ActiveRecord::Base.establish_connection(ENV["DB"] || "sqlite")
+
+def env_db
+  ENV["DB"] || "sqlite3"
+end
+
+ActiveRecord::Base.establish_connection(env_db)
 ActiveRecord::Migration.verbose = false
 
 require 'test_models'
@@ -23,8 +28,8 @@ class MiniTest::Spec
     DatabaseCleaner.start
   end
   after do
-    FileUtils.remove_entry_secure ENV['FLOCK_DIR']
     DatabaseCleaner.clean
+    FileUtils.remove_entry_secure ENV['FLOCK_DIR']
   end
 end
 

data/test/mysql_nesting_test.rb

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

data/test/parallelism_test.rb

@@ -1,34 +1,40 @@
 require 'minitest_helper'
 
 describe "parallelism" do
-  def find_or_create_at_even_second(run_at, with_advisory_lock)
-    sleep(run_at - Time.now.to_f)
+  def find_or_create_at(run_at, with_advisory_lock)
     ActiveRecord::Base.connection.reconnect!
+    sleep(run_at - Time.now.to_f)
     name = run_at.to_s
-    task = lambda { Tag.find_by_name(name) || Tag.create!(:name => name) }
+    task = lambda do
+      Tag.transaction do
+        Tag.find_by_name(name) || Tag.create(:name => name)
+      end
+    end
     if with_advisory_lock
       Tag.with_advisory_lock(name, nil, &task)
     else
       task.call
     end
+    ActiveRecord::Base.connection.close
   end
 
   def run_workers(with_advisory_lock)
-    start_time = Time.now.to_i + 2
-    threads = @workers.times.collect do
-      Thread.new do
-        @iterations.times do |ea|
-          find_or_create_at_even_second(start_time + (ea * 2), with_advisory_lock)
+    skip if env_db == "sqlite"
+    @iterations.times do
+      time = (Time.now.to_i + 2).to_f
+      threads = @workers.times.collect do
+        Thread.new do
+          find_or_create_at(time, with_advisory_lock)
         end
       end
+      threads.each { |ea| ea.join }
     end
-    threads.each { |ea| ea.join }
     puts "Created #{Tag.all.size} (lock = #{with_advisory_lock})"
   end
 
   before :each do
     @iterations = 5
-    @workers = 10
+    @workers = 5
   end
 
   it "parallel threads create multiple duplicate rows" do

data/test/simplest_test.rb

@@ -0,0 +1,29 @@
+require 'minitest_helper'
+
+describe "simplest" do
+  it "should prevent threads from accessing a resource concurrently" do
+    times = ActiveSupport::OrderedHash.new
+    ActiveRecord::Base.connection_pool.disconnect!
+    t1 = Thread.new do
+      ActiveRecord::Base.connection.reconnect!
+      ActiveRecord::Base.with_advisory_lock("simplest test") do
+        times[:t1_acquire] = Time.now
+        sleep 0.5
+      end
+      times[:t1_release] = Time.now
+    end
+    sleep 0.1
+    t2 = Thread.new do
+      ActiveRecord::Base.connection.reconnect!
+      ActiveRecord::Base.with_advisory_lock("simplest test") do
+        times[:t2_acquire] = Time.now
+        sleep 1
+      end
+      times[:t2_release] = Time.now
+    end
+    t1.join
+    t2.join
+    times.keys.must_equal [:t1_acquire, :t1_release, :t2_acquire, :t2_release]
+    times[:t2_acquire].must_be :>, times[:t1_release]
+  end
+end

data/tests.sh

@@ -0,0 +1,13 @@
+#!/bin/sh -e
+export BUNDLE_GEMFILE RMI DB
+
+for RMI in 1.8.7-p370 1.9.3-p327
+do
+  rbenv local $RMI
+  bundle --quiet
+  for DB in sqlite mysql postgresql
+  do
+    echo $DB $BUNDLE_GEMFILE `ruby -v`
+    bundle exec rake
+  done
+done

data/with_advisory_lock.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^test/})
   gem.require_paths = %w(lib)
 
-  gem.add_runtime_dependency 'activerecord', '>= 3.0.0'
+  gem.add_runtime_dependency 'activerecord', '>= 3.2.0'
 
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'yard'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: with_advisory_lock
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-22 00:00:00.000000000 Z
+date: 2013-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -18,7 +18,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 3.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 3.2.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -196,7 +196,9 @@ files:
 - test/minitest_helper.rb
 - test/mysql_nesting_test.rb
 - test/parallelism_test.rb
+- test/simplest_test.rb
 - test/test_models.rb
+- tests.sh
 - with_advisory_lock.gemspec
 homepage: ''
 licenses: []
@@ -212,7 +214,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1854060024724922654
+      hash: 1855409000394633980
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -221,7 +223,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1854060024724922654
+      hash: 1855409000394633980
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -234,5 +236,6 @@ test_files:
 - test/minitest_helper.rb
 - test/mysql_nesting_test.rb
 - test/parallelism_test.rb
+- test/simplest_test.rb
 - test/test_models.rb
 has_rdoc: