activerecord_autoreplica 1.3.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: db7ac2cf097115489206cf2c5ff942e644972585
-  data.tar.gz: 7ce126147d70a5f1726d82c4b6e2946d197b25df
+  metadata.gz: a5eb9206cedab199be0c3b122d345ca8c8373c3f
+  data.tar.gz: c1b40dc95b92b655585ead464030f171aca27ee0
 SHA512:
-  metadata.gz: c480d4ad56372e3ab3439ae6bd3cffb63eaed11ac243d9cb6ce4bdf5f5b813648c749243cba44396ab09e930d5412f35179fcbff4a7c9cbac47d4209e097cd77
-  data.tar.gz: cf90d567e36776e7fc277ddd0b18d315e0fdb64ce05a0e1ad471fb0b9adbdf9b6cf3b08ea6f17e90aa5c6310ddd5d9bdc1301ea25c15f62f327fc0621ed67d45
+  metadata.gz: f10210c92a90ba9ed00a26514e360936524996b5be63dddb719173789b15b96cec40d21ada5227252504c3e996cd7e7c8c5af0488873041d4e63e9d1cad9f585
+  data.tar.gz: cb56b501aab0cf34234f81be6d9f8070fb14a542ef96da46d173c6853f678c9fcc9a81dea6e79dc3014df23f237c6df0f106843155885e76432811ef0f431eba

data/.travis.yml

@@ -1,5 +1,4 @@
 gemfile:
-  - gemfiles/Gemfile.rails-3.2.x
   - gemfiles/Gemfile.rails-4.1.x
   - gemfiles/Gemfile.rails-5.0.x
 rvm:

data/Gemfile

@@ -6,7 +6,7 @@ source "http://rubygems.org"
 #   $ BUNDLE_GEMFILE=gemfiles/Gemfile.rails-4.1.x bundle exec rake
 #
 # etc.
-gem 'activerecord', "> 3.0"
+gem 'activerecord', ">= 4"
 
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.

data/README.md

@@ -79,10 +79,8 @@ There are Gemfiles for testing against various versions of ActiveRecord. To run
 
     $ BUNDLE_GEMFILE=gemfiles/Gemfile.rails-5.0.x bundle exec rake
     $ BUNDLE_GEMFILE=gemfiles/Gemfile.rails-4.1.x bundle exec rake
-    $ BUNDLE_GEMFILE=gemfiles/Gemfile.rails-3.2.x bundle exec rake
 
 The library contains a couple of switches that allow it to function in all these Rails versions.
-Rails 3.x support is likely to be dropped in the next major version.
 
 ### Versioning
 

data/Rakefile

@@ -13,7 +13,7 @@ require 'rake'
 
 require 'jeweler'
 Jeweler::Tasks.new do |gem|
-  gem.version = '1.3.1'
+  gem.version = '2.0.0'
   # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
   gem.name = "activerecord_autoreplica"
   gem.homepage = "http://github.com/WeTransfer/activerecord_autoreplica"

data/activerecord_autoreplica.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: activerecord_autoreplica 1.3.1 ruby lib
+# stub: activerecord_autoreplica 2.0.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "activerecord_autoreplica"
-  s.version = "1.3.1"
+  s.version = "2.0.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Julik Tarkhanov"]
-  s.date = "2016-11-21"
+  s.date = "2016-12-06"
   s.description = " Redirect all SELECT queries to a separate connection within a block "
   s.email = "me@julik.nl"
   s.extra_rdoc_files = [
@@ -27,7 +27,6 @@ Gem::Specification.new do |s|
     "README.md",
     "Rakefile",
     "activerecord_autoreplica.gemspec",
-    "gemfiles/Gemfile.rails-3.2.x",
     "gemfiles/Gemfile.rails-4.1.x",
     "gemfiles/Gemfile.rails-5.0.x",
     "lib/activerecord_autoreplica.rb",
@@ -43,7 +42,7 @@ Gem::Specification.new do |s|
     s.specification_version = 4
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<activerecord>, ["> 3.0"])
+      s.add_runtime_dependency(%q<activerecord>, [">= 4"])
       s.add_development_dependency(%q<rake>, ["~> 10.0"])
       s.add_development_dependency(%q<yard>, [">= 0"])
       s.add_development_dependency(%q<sqlite3>, [">= 0"])
@@ -52,7 +51,7 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<bundler>, ["~> 1.0"])
       s.add_development_dependency(%q<jeweler>, [">= 0"])
     else
-      s.add_dependency(%q<activerecord>, ["> 3.0"])
+      s.add_dependency(%q<activerecord>, [">= 4"])
       s.add_dependency(%q<rake>, ["~> 10.0"])
       s.add_dependency(%q<yard>, [">= 0"])
       s.add_dependency(%q<sqlite3>, [">= 0"])
@@ -62,7 +61,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<jeweler>, [">= 0"])
     end
   else
-    s.add_dependency(%q<activerecord>, ["> 3.0"])
+    s.add_dependency(%q<activerecord>, [">= 4"])
     s.add_dependency(%q<rake>, ["~> 10.0"])
     s.add_dependency(%q<yard>, [">= 0"])
     s.add_dependency(%q<sqlite3>, [">= 0"])

data/lib/activerecord_autoreplica.rb

@@ -31,14 +31,8 @@
 #
 # Once the block exits, the original connection handler is reassigned to the AR connection_pool.
 module AutoReplica
-  CONNECTION_SWITCHING_MUTEX = Mutex.new
-  
-  # The first one is used in ActiveRecord 3+, the second one in 4+
-  ConnectionSpecification = begin
-    ActiveRecord::Base::ConnectionSpecification
-  rescue
-    ActiveRecord::ConnectionAdapters::ConnectionSpecification
-  end
+  # Aliased since this class gets renamed sometimes between Rails versions
+  ConnectionSpecification = ActiveRecord::ConnectionAdapters::ConnectionSpecification
 
   # Runs a given block with all SELECT statements being executed against the read slave
   # database.
@@ -70,21 +64,13 @@ module AutoReplica
   end
 
   def self.in_replica_context(handler_params, handler_class=ConnectionHandler)
-    return yield if Thread.current[:autoreplica] # This method should not be reentrant
-
     original_connection_handler = ActiveRecord::Base.connection_handler
     custom_handler = handler_class.new(original_connection_handler, handler_params)
     begin
-      CONNECTION_SWITCHING_MUTEX.synchronize do
-        Thread.current[:autoreplica] = true
-        ActiveRecord::Base.connection_handler = custom_handler
-      end
+      ActiveRecord::Base.connection_handler = custom_handler
       yield
     ensure
-      CONNECTION_SWITCHING_MUTEX.synchronize do
-        Thread.current[:autoreplica] = false
-        ActiveRecord::Base.connection_handler = original_connection_handler
-      end
+      ActiveRecord::Base.connection_handler = original_connection_handler
       custom_handler.finish
     end
   end
@@ -100,16 +86,9 @@ module AutoReplica
     # Overridden method which gets called by ActiveRecord to get a connection related to a specific
     # ActiveRecord::Base subclass.
     def retrieve_connection(for_ar_class)
-      # See which thread is calling us. If it is the thread that initiated the `in_replica_context`
-      # block, we return a wrapper proxy. If it is not, then it is a different thread willing to
-      # use a connection, and we have to give it the original adapter instead
-      if Thread.current[:autoreplica]
-        connection_for_writes = @original_handler.retrieve_connection(for_ar_class)
-        connection_for_reads = @read_pool.connection
-        Adapter.new(connection_for_writes, connection_for_reads)
-      else
-        @original_handler.retrieve_connection(for_ar_class)
-      end
+      connection_for_writes = @original_handler.retrieve_connection(for_ar_class)
+      connection_for_reads = @read_pool.connection
+      Adapter.new(connection_for_writes, connection_for_reads)
     end
 
     def release_read_pool_connection

data/spec/activerecord_autoreplica_spec.rb

@@ -5,11 +5,11 @@ describe AutoReplica do
 
   before :all do
     test_seed_name = SecureRandom.hex(4)
-    ActiveRecord::Base.establish_connection(adapter: 'sqlite3', database: ('master_db_%s.sqlite3' % test_seed_name), pool: 10)
+    ActiveRecord::Base.establish_connection(adapter: 'sqlite3', pool: 10, database: ('master_db_%s.sqlite3' % test_seed_name))
 
     # Setup the master and replica connections
     @master_connection_config = ActiveRecord::Base.connection_config.dup
-    @replica_connection_config = @master_connection_config.merge(database: ('replica_db_%s.sqlite3' % test_seed_name), pool: 10)
+    @replica_connection_config = @master_connection_config.merge(pool: 10, database: ('replica_db_%s.sqlite3' % test_seed_name))
     @replica_connection_config_url = 'sqlite3:/replica_db_%s.sqlite3?pool=10' % test_seed_name
 
     ActiveRecord::Migration.suppress_messages do
@@ -43,7 +43,74 @@ describe AutoReplica do
   class TestThing < ActiveRecord::Base
     self.table_name = 'things'
   end
+  
+  it 'does not contaminate other threads with the replica connection' do
+    ActiveRecord::Base.establish_connection(@master_connection_config)
+    TestThing.create! description: 'In master'
+
+    ActiveRecord::Base.establish_connection(@replica_connection_config)
+    TestThing.create! description: 'In replica'
+
+    ActiveRecord::Base.establish_connection(@master_connection_config)
+    expect(TestThing.first.description).to eq('In master')
+
+    ActiveRecord::Base.establish_connection(@replica_connection_config)
+    expect(TestThing.first.description).to eq('In replica')
+
+    ActiveRecord::Base.establish_connection(@master_connection_config)
+  
+    Thread.abort_on_exception = true
+    failures = 0
+    successes = 0
+    lock = Mutex.new
+  
+    n_threads = 4
+    n_iterations = 68
+    readers_from_slave = (1..4).map do |n|
+      Thread.new do
+        n_iterations.times do
+          sleep(rand / 3.0)
+          described_class.using_read_replica_at(**@replica_connection_config) do
+            description = TestThing.first.description
+            lock.synchronize do
+              if description == 'In replica'
+                successes += 1
+              else
+                failures += 1
+              end
+            end
+          end
+        end
+      end
+    end
+
+    readers_from_master = (1..n_threads).map do |n|
+      Thread.new do
+        n_iterations.times do
+          sleep(rand / 3.0)
+          description = TestThing.first.description
+          lock.synchronize do
+            if description == 'In master'
+              successes += 1
+            else
+              failures += 1
+            end
+          end
+        end
+      end
+    end
+  
+    readers_from_slave.map(&:join)
+    readers_from_master.map(&:join)
 
+    # All the fetches should be correct
+    expect(successes).not_to be_zero
+
+    # There should be no fetches from master in the replica block, and no fetches
+    # from replica without the replica block
+    expect(failures).to eq(0)
+  end
+  
   context 'using_read_replica_at' do
     it 'has no reentrancy problems' do
       id = described_class.using_read_replica_at(@replica_connection_config) do
@@ -97,73 +164,6 @@ describe AutoReplica do
       found_on_master = TestThing.find(id)
       expect(found_on_master.description).to eq('A nice Thing in the master database')
     end
-    
-    it 'does not contaminate other threads with the replica connection' do
-      ActiveRecord::Base.establish_connection(@master_connection_config)
-      TestThing.create! description: 'In master'
-
-      ActiveRecord::Base.establish_connection(@replica_connection_config)
-      TestThing.create! description: 'In replica'
-
-      ActiveRecord::Base.establish_connection(@master_connection_config)
-      expect(TestThing.first.description).to eq('In master')
-
-      ActiveRecord::Base.establish_connection(@replica_connection_config)
-      expect(TestThing.first.description).to eq('In replica')
-
-      ActiveRecord::Base.establish_connection(@master_connection_config)
-      
-      Thread.abort_on_exception = true
-      failures = 0
-      successes = 0
-      lock = Mutex.new
-      
-      n_threads = 4
-      n_iterations = 68
-      readers_from_slave = (1..4).map do |n|
-        Thread.new do
-          n_iterations.times do
-            sleep(rand / 3.0)
-            described_class.using_read_replica_at(**@replica_connection_config) do
-              description = TestThing.first.description
-              lock.synchronize do
-                if description == 'In replica'
-                  successes += 1
-                else
-                  failures += 1
-                end
-              end
-            end
-          end
-        end
-      end
-
-      readers_from_master = (1..n_threads).map do |n|
-        Thread.new do
-          n_iterations.times do
-            sleep(rand / 3.0)
-            description = TestThing.first.description
-            lock.synchronize do
-              if description == 'In master'
-                successes += 1
-              else
-                failures += 1
-              end
-            end
-          end
-        end
-      end
-      
-      readers_from_slave.map(&:join)
-      readers_from_master.map(&:join)
-
-      # All the fetches should be correct
-      expect(successes).not_to be_zero
-
-      # There should be no fetches from master in the replica block, and no fetches
-      # from replica without the replica block
-      expect(failures).to be_zero
-    end
   end
 
   describe AutoReplica::ConnectionHandler do
@@ -175,8 +175,7 @@ describe AutoReplica do
       expect(subject.do_that_thing).to eq(:yes)
     end
 
-    it 'enhances connection_for and returns an instance of the Adapter if the thread-local :autoreplica is set' do
-      Thread.current[:autoreplica] = true
+    it 'enhances connection_for and returns an instance of the Adapter' do
       original_handler = double('ActiveRecord_ConnectionHandler')
       adapter_double = double('ActiveRecord_Adapter')
       connection_double = double('Connection')
@@ -187,19 +186,8 @@ describe AutoReplica do
       subject = AutoReplica::ConnectionHandler.new(original_handler, pool_double)
       connection = subject.retrieve_connection(TestThing)
       expect(connection).to be_kind_of(AutoReplica::Adapter)
-      Thread.current[:autoreplica] = false
     end
 
-    it 'returns the original connection without the wrapper if the thread-local :autoreplica is not set' do
-      Thread.current[:autoreplica] = false
-      original_handler = double('ActiveRecord_ConnectionHandler')
-      pool_double = double('Read replica pool')
-      expect(original_handler).to receive(:retrieve_connection).and_return(:original_connection)
-      subject = AutoReplica::ConnectionHandler.new(original_handler, pool_double)
-      connection = subject.retrieve_connection(TestThing)
-      expect(connection).to eq(:original_connection)
-    end
-    
     it 'releases the the read pool connection when finishing' do
       original_handler = double('ActiveRecord_ConnectionHandler')
       pool_double = double('ConnectionPool')
@@ -237,8 +225,7 @@ describe AutoReplica do
       expect(subject.do_that_thing).to eq(:yes)
     end
 
-    it 'enhances connection_for and returns an instance of the Adapter if the thread-local :autoreplica is set' do
-      Thread.current[:autoreplica] = true
+    it 'enhances connection_for and returns an instance of the Adapter' do
       original_handler = double('ActiveRecord_ConnectionHandler')
       adapter_double = double('ActiveRecord_Adapter')
       expect(original_handler).to receive(:retrieve_connection).with(TestThing) { adapter_double }
@@ -246,7 +233,6 @@ describe AutoReplica do
       subject = AutoReplica::AdHocConnectionHandler.new(original_handler, @replica_connection_config)
       connection = subject.retrieve_connection(TestThing)
       expect(connection).to be_kind_of(AutoReplica::Adapter)
-      Thread.current[:autoreplica] = false
     end
 
     it 'disconnects the read pool when finishing' do

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: activerecord_autoreplica
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Julik Tarkhanov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-21 00:00:00.000000000 Z
+date: 2016-12-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -138,7 +138,6 @@ files:
 - README.md
 - Rakefile
 - activerecord_autoreplica.gemspec
-- gemfiles/Gemfile.rails-3.2.x
 - gemfiles/Gemfile.rails-4.1.x
 - gemfiles/Gemfile.rails-5.0.x
 - lib/activerecord_autoreplica.rb

data/gemfiles/Gemfile.rails-3.2.x

@@ -1,13 +0,0 @@
-source "http://rubygems.org"
-gem 'activerecord', "~> 3"
-
-# Add dependencies to develop your gem here.
-# Include everything needed to run rake, tests, features, etc.
-group :development do
-  gem 'rake', '~> 10.0'
-  gem 'sqlite3'
-  gem "rspec", "~> 2.4"
-  gem "rdoc", "~> 3.12"
-  gem "bundler", "~> 1.0"
-  gem "jeweler", "1.8.4" # The last without Nokogiri
-end