with_advisory_lock 0.0.1

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,23 @@
+language: ruby
+
+rvm:
+  - 1.8.7
+  - 1.9.3
+
+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
+
+script: bundle exec rake
+
+before_script:
+  - mysql -e 'create database with_advisory_lock_test'
+  - psql -c 'create database with_advisory_lock_test' -U postgres
+

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Matthew McEachen
+
+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,85 @@
+# 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.
+[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!).
+
+## What's an "Advisory Lock"?
+
+An advisory lock is a [mutex](http://en.wikipedia.org/wiki/Mutual_exclusion) used to ensure no two
+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:
+
+```ruby
+User.with_advisory_lock(lock_name) do
+  do_something_that_needs_locking
+end
+```
+
+### What happens
+
+1. The thread will wait indefinitely until the lock is acquired.
+2. While inside the block, you will exclusively own the advisory lock.
+3. The lock will be released after your block ends, even if an exception is raised in the block.
+
+### Lock wait timeouts
+
+The second parameter for ```with_advisory_lock``` is ```timeout_seconds```, and defaults to ```nil```,
+which means wait indefinitely for the lock.
+
+If a non-nil value is provided, the block may not be invoked.
+
+The return value of ```with_advisory_lock``` will be the result of the yielded block,
+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.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+``` ruby
+gem 'with_advisory_lock'
+```
+
+And then execute:
+
+    $ bundle
+
+## Changelog
+
+### 0.0.1
+
+* First whack

data/Rakefile

@@ -0,0 +1,17 @@
+require "bundler/gem_tasks"
+
+require 'yard'
+YARD::Rake::YardocTask.new do |t|
+  t.files = ['lib/**/*.rb', 'README.md']
+end
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs.push "lib"
+  t.libs.push "test"
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+task :default => :test

data/lib/with_advisory_lock.rb

@@ -0,0 +1,5 @@
+require 'with_advisory_lock/concern'
+
+ActiveSupport.on_load :active_record do
+  ActiveRecord::Base.send :include, WithAdvisoryLock::Concern
+end

data/lib/with_advisory_lock/base.rb

@@ -0,0 +1,31 @@
+module WithAdvisoryLock
+  class Base
+    attr_reader :connection, :lock_name, :timeout_seconds
+
+    def initialize(connection, lock_name, timeout_seconds)
+      @connection = connection
+      @lock_name = lock_name
+      @timeout_seconds = timeout_seconds
+    end
+
+    def quoted_lock_name
+      connection.quote(lock_name)
+    end
+
+    def with_advisory_lock(&block)
+      give_up_at = Time.now + @timeout_seconds if @timeout_seconds
+      while @timeout_seconds.nil? || Time.now < give_up_at do
+        if try_lock
+          begin
+            return yield
+          ensure
+            release_lock
+          end
+        else
+          sleep(0.1)
+        end
+      end
+      false # failed to get lock in time.
+    end
+  end
+end

data/lib/with_advisory_lock/concern.rb

@@ -0,0 +1,33 @@
+# Tried desperately to monkeypatch the polymorphic connection object,
+# but rails autoloading is too clever by half. Pull requests are welcome.
+
+# Think of this module as a hipster, using "case" ironically.
+
+require 'with_advisory_lock/base'
+require 'with_advisory_lock/mysql'
+require 'with_advisory_lock/postgresql'
+require 'with_advisory_lock/flock'
+require 'active_support/concern'
+
+module WithAdvisoryLock
+  module Concern
+    extend ActiveSupport::Concern
+
+    def with_advisory_lock(lock_name, timeout_seconds=nil, &block)
+      self.class.with_advisory_lock(lock_name, timeout_seconds, &block)
+    end
+
+    module ClassMethods
+      def with_advisory_lock(lock_name, timeout_seconds=nil, &block)
+        case (connection.adapter_name.downcase)
+          when "postgresql"
+            WithAdvisoryLock::PostgreSQL
+          when "mysql", "mysql2"
+            WithAdvisoryLock::MySQL
+          else
+            WithAdvisoryLock::Flock
+        end.new(connection, lock_name, timeout_seconds).with_advisory_lock(&block)
+      end
+    end
+  end
+end

data/lib/with_advisory_lock/flock.rb

@@ -0,0 +1,30 @@
+require 'fileutils'
+
+module WithAdvisoryLock
+  class Flock < Base
+
+    def filename
+      @filename ||= begin
+        safe = @lock_name.gsub(/[^a-z0-9]/i, '')
+        fn = ".lock-#{safe}-#{@lock_name.to_s.hash}"
+        # Let the user specify a directory besides CWD.
+        ENV['FLOCK_DIR'] ? File.expand_path(fn, ENV['FLOCK_DIR']) : fn
+      end
+    end
+
+    def file_io
+      @file_io ||= begin
+        FileUtils.touch(filename)
+        File.open(filename, 'r+')
+      end
+    end
+
+    def try_lock
+      0 == file_io.flock(File::LOCK_EX|File::LOCK_NB)
+    end
+
+    def release_lock
+      0 == file_io.flock(File::LOCK_UN)
+    end
+  end
+end

data/lib/with_advisory_lock/mysql.rb

@@ -0,0 +1,22 @@
+module WithAdvisoryLock
+  class MySQL < Base
+
+    # See http://dev.mysql.com/doc/refman/5.0/en/miscellaneous-functions.html#function_get-lock
+
+    def try_lock
+      # Returns 1 if the lock was obtained successfully,
+      # 0 if the attempt timed out (for example, because another client has
+      # previously locked the name), or NULL if an error occurred
+      # (such as running out of memory or the thread was killed with mysqladmin kill).
+      1 == connection.select_value("SELECT GET_LOCK(#{quoted_lock_name}, 0)")
+    end
+
+    def release_lock
+      # Returns 1 if the lock was released,
+      # 0 if the lock was not established by this thread (
+      # in which case the lock is not released), and
+      # NULL if the named lock did not exist.
+      1 == connection.select_value("SELECT RELEASE_LOCK(#{quoted_lock_name})")
+    end
+  end
+end

data/lib/with_advisory_lock/postgresql.rb

@@ -0,0 +1,26 @@
+module WithAdvisoryLock
+  class PostgreSQL < Base
+
+    # See http://www.postgresql.org/docs/9.1/static/functions-admin.html#FUNCTIONS-ADVISORY-LOCKS
+
+    def try_lock
+      # pg_try_advisory_lock will either obtain the lock immediately
+      # and return true, or return false if the lock cannot be acquired immediately
+      "t" == connection.select_value("SELECT pg_try_advisory_lock(#{numeric_lock})")
+    end
+
+    def release_lock
+      "t" == connection.select_value("SELECT pg_advisory_unlock(#{numeric_lock})")
+    end
+
+    def numeric_lock
+      @numeric_lock ||= begin
+        if lock_name.is_a? Numeric
+          lock_name.to_i
+        else
+          lock_name.to_s.hash
+        end
+      end
+    end
+  end
+end

data/lib/with_advisory_lock/version.rb

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

data/test/database.yml

@@ -0,0 +1,17 @@
+sqlite:
+  adapter: <%= "jdbc" if defined? JRUBY_VERSION %>sqlite3
+  database: test/sqlite3.db
+  timeout: 500
+  pool: 50
+pg:
+  adapter: postgresql
+  username: postgres
+  database: with_advisory_lock_test
+  min_messages: ERROR
+  pool: 50
+mysql:
+  adapter: mysql2
+  host: localhost
+  username: root
+  database: with_advisory_lock_test
+  pool: 50

data/test/minitest_helper.rb

@@ -0,0 +1,29 @@
+require 'erb'
+require 'active_record'
+require 'with_advisory_lock'
+require 'database_cleaner'
+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")
+ActiveRecord::Migration.verbose = false
+
+require 'test_models'
+require 'minitest/autorun'
+require 'minitest/great_expectations'
+
+Thread.abort_on_exception = true
+
+DatabaseCleaner.strategy = :deletion
+class MiniTest::Spec
+  before do
+    ENV['FLOCK_DIR'] = Dir.mktmpdir
+    DatabaseCleaner.start
+  end
+  after do
+    FileUtils.remove_entry_secure ENV['FLOCK_DIR']
+    DatabaseCleaner.clean
+  end
+end
+

data/test/test_models.rb

@@ -0,0 +1,24 @@
+ActiveRecord::Schema.define(:version => 0) do
+  create_table "tags", :force => true do |t|
+    t.string "name"
+  end
+  create_table "tag_audits", :id => false, :force => true do |t|
+    t.string "tag_name"
+  end
+  create_table "labels", :id => false, :force => true do |t|
+    t.string "name"
+  end
+end
+
+class Tag < ActiveRecord::Base
+  after_save do
+    TagAudit.create { |ea| ea.tag_name = name }
+    Label.create { |ea| ea.name = name }
+  end
+end
+
+class TagAudit < ActiveRecord::Base
+end
+
+class Label < ActiveRecord::Base
+end

data/test/with_advisory_lock_test.rb

@@ -0,0 +1,97 @@
+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
+
+  def find_or_create_at_even_second(run_at, with_advisory_lock)
+    sleep(run_at - Time.now.to_f)
+    ActiveRecord::Base.connection.reconnect!
+    name = run_at.to_s
+    task = lambda { Tag.find_by_name(name) || Tag.create!(:name => name) }
+    if with_advisory_lock
+      Tag.with_advisory_lock(name, nil, &task)
+    else
+      task.call
+    end
+  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)
+        end
+      end
+    end
+    threads.each { |ea| ea.join }
+    puts "Created #{Tag.all.size} (lock = #{with_advisory_lock})"
+  end
+
+  before :each do
+    @iterations = 5
+    @workers = 7
+  end
+
+  it "parallel threads create multiple duplicate rows" do
+    run_workers(with_advisory_lock = false)
+    if Tag.connection.adapter_name == "SQLite" && RUBY_VERSION == "1.9.3"
+      oper = :== # sqlite doesn't run in parallel.
+    else
+      oper = :> # Everything else should create duplicate rows.
+    end
+    Tag.all.size.must_be oper, @iterations # <- any duplicated rows will make me happy.
+    TagAudit.all.size.must_be oper, @iterations # <- any duplicated rows will make me happy.
+    Label.all.size.must_be oper, @iterations # <- any duplicated rows will make me happy.
+  end
+
+  it "parallel threads with_advisory_lock don't create multiple duplicate rows" do
+    run_workers(with_advisory_lock = true)
+    Tag.all.size.must_equal @iterations # <- any duplicated rows will NOT make me happy.
+    TagAudit.all.size.must_equal @iterations # <- any duplicated rows will NOT make me happy.
+    Label.all.size.must_equal @iterations # <- any duplicated rows will NOT make me happy.
+  end
+
+  it "returns false if the lock wasn't acquirable" do
+    t1_acquired_lock = false
+    t1_return_value = nil
+    t1 = Thread.new do
+      ActiveRecord::Base.connection.reconnect!
+      t1_return_value = Label.with_advisory_lock("testing 1,2,3") do
+        t1_acquired_lock = true
+        sleep(0.3)
+        "boom"
+      end
+    end
+
+    # Make sure the lock is acquired:
+    sleep(0.1)
+
+    # Now try to acquire the lock impatiently:
+    t2_acquired_lock = false
+    t2_return_value = nil
+    t2 = Thread.new do
+      ActiveRecord::Base.connection.reconnect!
+      t2_return_value = Label.with_advisory_lock("testing 1,2,3", 0.1) do
+        t2_acquired_lock = true
+        "not expected"
+      end
+    end
+
+    # Wait for them to finish:
+    t1.join
+    t2.join
+
+    t1_acquired_lock.must_be_true
+    t1_return_value.must_equal "boom"
+
+    t2_acquired_lock.must_be_false
+    t2_return_value.must_be_false
+  end
+end

data/with_advisory_lock.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'with_advisory_lock/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "with_advisory_lock"
+  gem.version       = WithAdvisoryLock::VERSION
+  gem.authors       = ["Matthew McEachen"]
+  gem.email         = ["matthew+github@mceachen.org"]
+  gem.description   = %q{Advisory locking for ActiveRecord}
+  gem.summary       = gem.description
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^test/})
+  gem.require_paths = %w(lib)
+
+  gem.add_runtime_dependency 'activerecord', '>= 3.0.0'
+
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'yard'
+  gem.add_development_dependency 'minitest'
+  gem.add_development_dependency 'minitest-great_expectations'
+  gem.add_development_dependency 'mysql2'
+  gem.add_development_dependency 'pg'
+  gem.add_development_dependency 'sqlite3'
+  gem.add_development_dependency 'database_cleaner'
+end

metadata

@@ -0,0 +1,218 @@
+--- !ruby/object:Gem::Specification
+name: with_advisory_lock
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Matthew McEachen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: yard
+  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: minitest
+  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: minitest-great_expectations
+  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
+    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: pg
+  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: sqlite3
+  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: database_cleaner
+  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'
+description: Advisory locking for ActiveRecord
+email:
+- matthew+github@mceachen.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/with_advisory_lock.rb
+- lib/with_advisory_lock/base.rb
+- lib/with_advisory_lock/concern.rb
+- lib/with_advisory_lock/flock.rb
+- lib/with_advisory_lock/mysql.rb
+- lib/with_advisory_lock/postgresql.rb
+- lib/with_advisory_lock/version.rb
+- test/database.yml
+- test/minitest_helper.rb
+- test/test_models.rb
+- test/with_advisory_lock_test.rb
+- with_advisory_lock.gemspec
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2709177541654258140
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2709177541654258140
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Advisory locking for ActiveRecord
+test_files:
+- test/database.yml
+- test/minitest_helper.rb
+- test/test_models.rb
+- test/with_advisory_lock_test.rb
+has_rdoc: