transaction_isolation_level 0.1.0

data/.gitignore

@@ -0,0 +1,3 @@
+.DS_Store
+transaction-isolation-level-*.gem
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,15 @@
+source "http://rubygems.org"
+
+# Declare your gem's dependencies in transaction_isolation_level.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use debugger
+# gem 'ruby-debug19', :require => 'ruby-debug'
+# gem 'ruby-debug'

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Will Bryant, Sekuda Ltd
+
+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/Rakefile

@@ -0,0 +1,16 @@
+#!/usr/bin/env rake
+
+require 'bundler/gem_tasks'
+require 'rake'
+require 'rake/testtask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the transaction_isolation_level plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/*_test.rb'
+  t.verbose = true
+end

data/lib/transaction_isolation_level.rb

@@ -0,0 +1,24 @@
+require 'active_record'
+require 'active_record/connection_adapters/abstract/connection_pool'
+
+module ActiveRecord
+  class IncompatibleTransactionIsolationLevel < StandardError; end
+
+  module ConnectionAdapters
+    class ConnectionHandler
+      # ActiveRecord only loads the adapters actually used for connections, so we can't patch their
+      # classes until we know which one will be loaded.  however, the adapter classes are not statically
+      # required; they are only loaded when ActiveRecord::Base#establish_connection retrieves them from
+      # the connection spec.  that has several code paths to handle different arguments but eventually
+      # uses the ConnectionHandler#establish_connection method we override here to load our patches once
+      # ActiveRecord::Base#establish_connection has loaded the class to patch.
+      def establish_connection_with_isolation_level_adapter_patches(*args)
+        require 'transaction_isolation_level/adapter_patches'
+        establish_connection_without_isolation_level_adapter_patches(*args)
+      end
+
+      alias_method :establish_connection_without_isolation_level_adapter_patches, :establish_connection
+      alias_method :establish_connection, :establish_connection_with_isolation_level_adapter_patches
+    end
+  end
+end

data/lib/transaction_isolation_level/adapter_patches.rb

@@ -0,0 +1,113 @@
+module ActiveRecord
+  module ConnectionAdapters
+    module DatabaseStatements
+      ORDER_OF_TRANSACTION_ISOLATION_LEVELS = [:read_uncommitted, :read_committed, :repeatable_read, :serializable]
+
+      def transaction_isolation_level_sql(value)
+        case value
+        when :read_uncommitted then 'ISOLATION LEVEL READ UNCOMMITTED'
+        when :read_committed   then 'ISOLATION LEVEL READ COMMITTED'
+        when :repeatable_read  then 'ISOLATION LEVEL REPEATABLE READ'
+        when :serializable     then 'ISOLATION LEVEL SERIALIZABLE'
+        when nil               then nil
+        else raise "Unknown transaction isolation level: #{value.inspect}"
+        end
+      end
+
+      def transaction_isolation_level_from_sql(value)
+        case value.gsub('-', ' ').upcase
+        when 'READ UNCOMMITTED' then :read_uncommitted
+        when 'READ COMMITTED'   then :read_committed
+        when 'REPEATABLE READ'  then :repeatable_read
+        when 'SERIALIZABLE'     then :serializable
+        else raise "Unknown transaction isolation level: #{value.inspect}"
+        end
+      end
+
+      def transaction_with_isolation_level(options = {})
+        isolation_level = options.delete(:isolation_level)
+        minimum_isolation_level = options.delete(:minimum_isolation_level)
+
+        raise ArgumentError,         "#{isolation_level.inspect} is not a known transaction isolation level" unless         isolation_level.nil? || ORDER_OF_TRANSACTION_ISOLATION_LEVELS.include?(isolation_level)
+        raise ArgumentError, "#{minimum_isolation_level.inspect} is not a known transaction isolation level" unless minimum_isolation_level.nil? || ORDER_OF_TRANSACTION_ISOLATION_LEVELS.include?(minimum_isolation_level)
+
+        if open_transactions == 0
+          @transaction_isolation_level = isolation_level || minimum_isolation_level
+        elsif isolation_level && isolation_level != (@transaction_isolation_level || default_transaction_isolation_level)
+          raise IncompatibleTransactionIsolationLevel, "Asked to use transaction isolation level #{isolation_level}, but the transaction has already begun with isolation level #{@transaction_isolation_level || default_transaction_isolation_level}"
+        end
+        if minimum_isolation_level && ORDER_OF_TRANSACTION_ISOLATION_LEVELS.index(minimum_isolation_level) > ORDER_OF_TRANSACTION_ISOLATION_LEVELS.index(@transaction_isolation_level || default_transaction_isolation_level)
+          raise IncompatibleTransactionIsolationLevel, "Asked to use transaction isolation level at least #{minimum_isolation_level}, but the transaction has already begun with isolation level #{@transaction_isolation_level || default_transaction_isolation_level}"
+        end
+
+        transaction_without_isolation_level(options) { yield }
+      end
+
+      alias_method_chain :transaction, :isolation_level
+    end
+
+    class AbstractAdapter
+      attr_reader :default_transaction_isolation_level, :transaction_isolation_level
+
+      def commit_db_transaction #:nodoc:
+        super
+      ensure
+        @transaction_isolation_level = nil
+      end
+
+      def rollback_db_transaction #:nodoc:
+        super
+      ensure
+        @transaction_isolation_level = nil
+      end
+    end
+
+    PostgreSQLAdapter.class_eval do
+      def begin_db_transaction
+        execute "BEGIN TRANSACTION #{transaction_isolation_level_sql(@transaction_isolation_level)}"
+      end
+
+      def configure_connection_with_isolation_level
+        configure_connection_without_isolation_level
+        if @config[:transaction_isolation_level]
+          @default_transaction_isolation_level = @config[:transaction_isolation_level].to_sym
+          execute "SET SESSION CHARACTERISTICS AS TRANSACTION #{transaction_isolation_level_sql default_transaction_isolation_level}"
+        else
+          @default_transaction_isolation_level = transaction_isolation_level_from_sql(select_value("SELECT current_setting('default_transaction_isolation')"))
+        end
+      end
+
+      alias_method_chain :configure_connection, :isolation_level
+    end if const_defined?(:PostgreSQLAdapter)
+
+    module MysqlAdapterPatches
+      def self.included(base)
+        base.alias_method_chain :begin_db_transaction, :isolation_level
+        base.alias_method_chain :configure_connection, :isolation_level
+      end
+
+      def begin_db_transaction_with_isolation_level
+        execute "SET TRANSACTION #{transaction_isolation_level_sql(@transaction_isolation_level)}" if @transaction_isolation_level # applies only to the next transaction
+        begin_db_transaction_without_isolation_level
+      end
+
+      def configure_connection_with_isolation_level
+        configure_connection_without_isolation_level
+        if @config[:transaction_isolation_level]
+          @default_transaction_isolation_level = @config[:transaction_isolation_level].to_sym
+          execute "SET SESSION TRANSACTION #{transaction_isolation_level_sql default_transaction_isolation_level}"
+        else
+          @default_transaction_isolation_level = transaction_isolation_level_from_sql(select_value("SELECT @@session.tx_isolation"))
+        end
+      end
+    end
+
+    MysqlAdapter.class_eval do
+      include MysqlAdapterPatches
+    end if const_defined?(:MysqlAdapter)
+
+    Mysql2Adapter.class_eval do
+      include MysqlAdapterPatches
+    end if const_defined?(:Mysql2Adapter)
+  end
+end

data/lib/transaction_isolation_level/version.rb

@@ -0,0 +1,3 @@
+module TransactionIsolationLevel
+  VERSION = '0.1.0'
+end

data/test/database.yml

@@ -0,0 +1,11 @@
+postgresql:
+  adapter: postgresql
+  database: transaction_isolation_level_test
+postgresql_set_to_serializable:
+  adapter: postgresql
+  database: transaction_isolation_level_test
+  transaction_isolation_level: serializable
+postgresql_set_to_read_committed:
+  adapter: postgresql
+  database: transaction_isolation_level_test
+  transaction_isolation_level: read_committed

data/test/test_helper.rb

@@ -0,0 +1,9 @@
+require 'test/unit'
+require 'rubygems'
+require 'bundler'
+Bundler.require(:default, :development)
+
+RAILS_ENV = ENV['RAILS_ENV'] || 'postgresql'
+
+database_config = YAML::load(IO.read(File.join(File.dirname(__FILE__), '/database.yml')))
+ActiveRecord::Base.establish_connection(database_config[RAILS_ENV])

data/test/transaction_isolation_level_test.rb

@@ -0,0 +1,186 @@
+require 'test_helper'
+
+class TransactionIsolationLevelTest < ActiveSupport::TestCase
+  def current_isolation_level(connection = ActiveRecord::Base.connection)
+    # we can't implement this for mysql as it does not expose the value set for the transaction (as opposed to the session) -
+    # see http://bugs.mysql.com/bug.php?id=53341.  so currently we can only run tests on postgresql.
+    connection.transaction_isolation_level_from_sql(connection.select_value("SELECT current_setting('transaction_isolation')"))
+  end
+
+  test "it does nothing to queries by default" do
+    default_level = current_isolation_level
+    ActiveRecord::Base.transaction do
+      assert_equal default_level, current_isolation_level
+    end
+  end
+
+  test "it allows the isolation level to be set for the transaction, and it is reset after the transaction" do
+    default_level = current_isolation_level
+    ActiveRecord::Base.transaction(:isolation_level => :read_uncommitted) do
+      assert_equal :read_uncommitted, current_isolation_level
+    end
+    assert_equal default_level, current_isolation_level
+    ActiveRecord::Base.transaction(:isolation_level => :read_committed) do
+      assert_equal :read_committed, current_isolation_level
+    end
+    assert_equal default_level, current_isolation_level
+    ActiveRecord::Base.transaction(:isolation_level => :repeatable_read) do
+      assert_equal :repeatable_read, current_isolation_level
+    end
+    assert_equal default_level, current_isolation_level
+    ActiveRecord::Base.transaction(:isolation_level => :serializable) do
+      assert_equal :serializable, current_isolation_level
+    end
+    assert_equal default_level, current_isolation_level
+  end
+
+  test "raises an error if the requested transaction isolation level is not known" do
+    assert_raises(ArgumentError) do
+      ActiveRecord::Base.transaction(:isolation_level => :serialisable) {}
+    end
+    assert_raises(ArgumentError) do
+      ActiveRecord::Base.transaction(:minimum_isolation_level => :serialisable) {}
+    end
+  end
+
+  test "raises an error if a transaction is already open and the requested transaction isolation level is different to the current level" do
+    ActiveRecord::Base.transaction(:isolation_level => :repeatable_read) do
+      assert_raises(ActiveRecord::IncompatibleTransactionIsolationLevel) do
+        ActiveRecord::Base.transaction(:isolation_level => :read_uncommitted) {}
+      end
+      assert_raises(ActiveRecord::IncompatibleTransactionIsolationLevel) do
+        ActiveRecord::Base.transaction(:isolation_level => :read_committed) {}
+      end
+      assert_nothing_raised do
+        ActiveRecord::Base.transaction(:isolation_level => :repeatable_read) {}
+      end
+      assert_raises(ActiveRecord::IncompatibleTransactionIsolationLevel) do
+        ActiveRecord::Base.transaction(:isolation_level => :serializable) {}
+      end
+    end
+
+    ActiveRecord::Base.transaction(:isolation_level => :read_committed) do
+      assert_raises(ActiveRecord::IncompatibleTransactionIsolationLevel) do
+        ActiveRecord::Base.transaction(:isolation_level => :read_uncommitted) {}
+      end
+      assert_nothing_raised do
+        ActiveRecord::Base.transaction(:isolation_level => :read_committed) {}
+      end
+      assert_raises(ActiveRecord::IncompatibleTransactionIsolationLevel) do
+        ActiveRecord::Base.transaction(:isolation_level => :repeatable_read) {}
+      end
+      assert_raises(ActiveRecord::IncompatibleTransactionIsolationLevel) do
+        ActiveRecord::Base.transaction(:isolation_level => :serializable) {}
+      end
+    end
+
+    default = current_isolation_level
+    ActiveRecord::Base.transaction do
+      assert_raises(ActiveRecord::IncompatibleTransactionIsolationLevel) do
+        ActiveRecord::Base.transaction(:isolation_level => ([:read_committed, :repeatable_read] - [default]).first) {}
+      end
+      assert_nothing_raised do
+        ActiveRecord::Base.transaction(:isolation_level => current_isolation_level) {}
+      end
+    end
+  end
+
+  test "supports requesting a minimum transaction isolation level, in which case an error is raised only if requested transaction isolation level is higher than the actual transaction isolation" do
+    ActiveRecord::Base.transaction(:isolation_level => :repeatable_read) do
+      assert_nothing_raised do
+        ActiveRecord::Base.transaction(:minimum_isolation_level => :read_uncommitted) {}
+        ActiveRecord::Base.transaction(:minimum_isolation_level => :read_committed) {}
+        ActiveRecord::Base.transaction(:minimum_isolation_level => :repeatable_read) {}
+      end
+      assert_raises(ActiveRecord::IncompatibleTransactionIsolationLevel) do
+        ActiveRecord::Base.transaction(:minimum_isolation_level => :serializable) {}
+      end
+    end
+
+    ActiveRecord::Base.transaction(:isolation_level => :read_committed) do
+      assert_nothing_raised do
+        ActiveRecord::Base.transaction(:minimum_isolation_level => :read_uncommitted) {}
+        ActiveRecord::Base.transaction(:minimum_isolation_level => :read_committed) {}
+      end
+      assert_raises(ActiveRecord::IncompatibleTransactionIsolationLevel) do
+        ActiveRecord::Base.transaction(:minimum_isolation_level => :repeatable_read) {}
+        ActiveRecord::Base.transaction(:minimum_isolation_level => :serializable) {}
+      end
+    end
+  end
+
+  class ModelWithConnectionForSerializable < ActiveRecord::Base
+    abstract_class
+  end
+
+  class ModelWithConnectionForReadCommitted < ActiveRecord::Base
+    abstract_class
+  end
+
+  test "it supports setting the transaction_isolation in database.yml" do
+    database_config = YAML::load(IO.read(File.join(File.dirname(__FILE__), '/database.yml')))
+
+    ModelWithConnectionForSerializable.establish_connection(database_config["#{RAILS_ENV}_set_to_serializable"])
+    assert_equal :serializable, current_isolation_level(ModelWithConnectionForSerializable.connection)
+
+    ModelWithConnectionForReadCommitted.establish_connection(database_config["#{RAILS_ENV}_set_to_read_committed"])
+    assert_equal :read_committed, current_isolation_level(ModelWithConnectionForReadCommitted.connection)
+
+    ModelWithConnectionForSerializable.transaction do # will use default isolation level
+      assert_raises(ActiveRecord::IncompatibleTransactionIsolationLevel) do
+        ModelWithConnectionForSerializable.transaction(:isolation_level => :read_uncommitted) {}
+      end
+      assert_raises(ActiveRecord::IncompatibleTransactionIsolationLevel) do
+        ModelWithConnectionForSerializable.transaction(:isolation_level => :read_committed) {}
+      end
+      assert_raises(ActiveRecord::IncompatibleTransactionIsolationLevel) do
+        ModelWithConnectionForSerializable.transaction(:isolation_level => :repeatable_read) {}
+      end
+      assert_nothing_raised do
+        ModelWithConnectionForSerializable.transaction(:isolation_level => :serializable) {}
+        assert_equal :serializable, current_isolation_level(ModelWithConnectionForSerializable.connection)
+      end
+    end
+
+    ModelWithConnectionForReadCommitted.transaction do
+      assert_raises(ActiveRecord::IncompatibleTransactionIsolationLevel) do
+        ModelWithConnectionForReadCommitted.transaction(:isolation_level => :read_uncommitted) {}
+      end
+      assert_nothing_raised do
+        ModelWithConnectionForReadCommitted.transaction(:isolation_level => :read_committed) {}
+        assert_equal :read_committed, current_isolation_level(ModelWithConnectionForReadCommitted.connection)
+      end
+      assert_raises(ActiveRecord::IncompatibleTransactionIsolationLevel) do
+        ModelWithConnectionForReadCommitted.transaction(:isolation_level => :repeatable_read) {}
+      end
+      assert_raises(ActiveRecord::IncompatibleTransactionIsolationLevel) do
+        ModelWithConnectionForReadCommitted.transaction(:isolation_level => :serializable) {}
+      end
+    end
+
+    ModelWithConnectionForSerializable.transaction(:isolation_level => :read_committed) do
+      assert_equal :read_committed, current_isolation_level(ModelWithConnectionForSerializable.connection)
+      assert_nothing_raised do
+        ModelWithConnectionForSerializable.transaction(:isolation_level => :read_committed) {}
+      end
+      assert_raises(ActiveRecord::IncompatibleTransactionIsolationLevel) do
+        ModelWithConnectionForSerializable.transaction(:isolation_level => :repeatable_read) {}
+      end
+      assert_raises(ActiveRecord::IncompatibleTransactionIsolationLevel) do
+        ModelWithConnectionForSerializable.transaction(:isolation_level => :serializable) {}
+      end
+    end
+    ModelWithConnectionForReadCommitted.transaction(:isolation_level => :repeatable_read) do
+      assert_equal :repeatable_read, current_isolation_level(ModelWithConnectionForReadCommitted.connection)
+      assert_nothing_raised do
+        ModelWithConnectionForReadCommitted.transaction(:isolation_level => :repeatable_read) {}
+      end
+      assert_raises(ActiveRecord::IncompatibleTransactionIsolationLevel) do
+        ModelWithConnectionForReadCommitted.transaction(:isolation_level => :read_committed) {}
+      end
+      assert_raises(ActiveRecord::IncompatibleTransactionIsolationLevel) do
+        ModelWithConnectionForReadCommitted.transaction(:isolation_level => :serializable) {}
+      end
+    end
+  end
+end

data/transaction_isolation_level.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/transaction_isolation_level/version', __FILE__)
+
+spec = Gem::Specification.new do |gem|
+  gem.name         = 'transaction_isolation_level'
+  gem.version      = TransactionIsolationLevel::VERSION
+  gem.summary      = "Adds :isolation_level option to ActiveRecord #transaction calls"
+  gem.description  = "Adds :isolation_level option to ActiveRecord #transaction calls, as well as :minimum_isolation_level.  Supports mysql and postgresql."
+  gem.has_rdoc     = false
+  gem.author       = "Will Bryant"
+  gem.email        = "will.bryant@gmail.com"
+  gem.homepage     = "http://github.com/willbryant/transaction_isolation_level"
+  
+  gem.executables  = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files        = `git ls-files`.split("\n")
+  gem.test_files   = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.require_path = "lib"
+  
+  gem.add_dependency "activerecord"
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "pg"
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification 
+name: transaction_isolation_level
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Will Bryant
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-02-26 00:00:00 +13:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: pg
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+description: "Adds :isolation_level option to ActiveRecord #transaction calls, as well as :minimum_isolation_level.  Supports mysql and postgresql."
+email: will.bryant@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- MIT-LICENSE
+- Rakefile
+- lib/transaction_isolation_level.rb
+- lib/transaction_isolation_level/adapter_patches.rb
+- lib/transaction_isolation_level/version.rb
+- test/database.yml
+- test/test_helper.rb
+- test/transaction_isolation_level_test.rb
+- transaction_isolation_level.gemspec
+has_rdoc: false
+homepage: http://github.com/willbryant/transaction_isolation_level
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.3
+signing_key: 
+specification_version: 3
+summary: "Adds :isolation_level option to ActiveRecord #transaction calls"
+test_files: 
+- test/database.yml
+- test/test_helper.rb
+- test/transaction_isolation_level_test.rb