activerecord_autoreplica 1.3.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0dec3a7a02bfdd20f0428bdb405016f3b16d7c12
-  data.tar.gz: c84f381a3f3c1d01f2066aec82597333a7a8d2c8
+  metadata.gz: db7ac2cf097115489206cf2c5ff942e644972585
+  data.tar.gz: 7ce126147d70a5f1726d82c4b6e2946d197b25df
 SHA512:
-  metadata.gz: 9d0de5551b0801a3dd9149111e2610715f27a12619f56fdbb29e3108591c06678e326bb2e7e14836ccc89e6f9ab4fc7eef212d52074bba39b4a37f332e8c852b
-  data.tar.gz: e4efd1d3811ffd76b38acb6707b7dbe57babbcad919da69d49e67746236fc15c58219c5ca2bf0b41745c9501f5326a4c925613f55c636a337f4619f3e8a2c72d
+  metadata.gz: c480d4ad56372e3ab3439ae6bd3cffb63eaed11ac243d9cb6ce4bdf5f5b813648c749243cba44396ab09e930d5412f35179fcbff4a7c9cbac47d4209e097cd77
+  data.tar.gz: cf90d567e36776e7fc277ddd0b18d315e0fdb64ce05a0e1ad471fb0b9adbdf9b6cf3b08ea6f17e90aa5c6310ddd5d9bdc1301ea25c15f62f327fc0621ed67d45

data/README.md

@@ -68,8 +68,7 @@ act accordingly.
 
 The `using_read_replica_at` block will allocate a `ConnectionPool` like the standard `ActiveRecord` connection
 manager does, and the pool is going to be closed and torn down at the end of the block. Since it only uses the basic
-ActiveRecord facilities (including mutexes) it should be threadsafe (but _not_ thread-local since the connection
-handler in ActiveRecord isn't).
+ActiveRecord facilities (including mutexes). It should be threadsafe _and_ thread local.
 
 ### Running the specs
 

data/Rakefile

@@ -13,7 +13,7 @@ require 'rake'
 
 require 'jeweler'
 Jeweler::Tasks.new do |gem|
-  gem.version = '1.3.0'
+  gem.version = '1.3.1'
   # 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.0 ruby lib
+# stub: activerecord_autoreplica 1.3.1 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "activerecord_autoreplica"
-  s.version = "1.3.0"
+  s.version = "1.3.1"
 
   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-07"
+  s.date = "2016-11-21"
   s.description = " Redirect all SELECT queries to a separate connection within a block "
   s.email = "me@julik.nl"
   s.extra_rdoc_files = [

data/lib/activerecord_autoreplica.rb

@@ -31,6 +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
@@ -68,19 +70,22 @@ module AutoReplica
   end
 
   def self.in_replica_context(handler_params, handler_class=ConnectionHandler)
-    return yield if @in_replica_context # This method should not be reentrant
-
-    @in_replica_context = true
+    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
-      ActiveRecord::Base.connection_handler = custom_handler
+      CONNECTION_SWITCHING_MUTEX.synchronize do
+        Thread.current[:autoreplica] = true
+        ActiveRecord::Base.connection_handler = custom_handler
+      end
       yield
     ensure
-      ActiveRecord::Base.connection_handler = original_connection_handler
+      CONNECTION_SWITCHING_MUTEX.synchronize do
+        Thread.current[:autoreplica] = false
+        ActiveRecord::Base.connection_handler = original_connection_handler
+      end
       custom_handler.finish
-      @in_replica_context = false
     end
   end
 
@@ -95,9 +100,16 @@ 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)
-      connection_for_writes = @original_handler.retrieve_connection(for_ar_class)
-      connection_for_reads = @read_pool.connection
-      Adapter.new(connection_for_writes, connection_for_reads)
+      # 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
     end
 
     def release_read_pool_connection

data/spec/activerecord_autoreplica_spec.rb

@@ -5,12 +5,12 @@ 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))
+    ActiveRecord::Base.establish_connection(adapter: 'sqlite3', database: ('master_db_%s.sqlite3' % test_seed_name), pool: 10)
 
     # 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))
-    @replica_connection_config_url = 'sqlite3:/replica_db_%s.sqlite3' % test_seed_name
+    @replica_connection_config = @master_connection_config.merge(database: ('replica_db_%s.sqlite3' % test_seed_name), pool: 10)
+    @replica_connection_config_url = 'sqlite3:/replica_db_%s.sqlite3?pool=10' % test_seed_name
 
     ActiveRecord::Migration.suppress_messages do
       # Create both the master and the replica, with a simple small schema
@@ -97,6 +97,73 @@ 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
@@ -108,7 +175,8 @@ describe AutoReplica do
       expect(subject.do_that_thing).to eq(:yes)
     end
 
-    it 'enhances connection_for and returns an instance of the Adapter' do
+    it 'enhances connection_for and returns an instance of the Adapter if the thread-local :autoreplica is set' do
+      Thread.current[:autoreplica] = true
       original_handler = double('ActiveRecord_ConnectionHandler')
       adapter_double = double('ActiveRecord_Adapter')
       connection_double = double('Connection')
@@ -119,8 +187,19 @@ 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')
@@ -158,7 +237,8 @@ describe AutoReplica do
       expect(subject.do_that_thing).to eq(:yes)
     end
 
-    it 'enhances connection_for and returns an instance of the Adapter' do
+    it 'enhances connection_for and returns an instance of the Adapter if the thread-local :autoreplica is set' do
+      Thread.current[:autoreplica] = true
       original_handler = double('ActiveRecord_ConnectionHandler')
       adapter_double = double('ActiveRecord_Adapter')
       expect(original_handler).to receive(:retrieve_connection).with(TestThing) { adapter_double }
@@ -166,6 +246,7 @@ 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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord_autoreplica
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.3.1
 platform: ruby
 authors:
 - Julik Tarkhanov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-07 00:00:00.000000000 Z
+date: 2016-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord