switch_connection 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3a610610ba7b802579bd70c8b25df8f8bba50299
-  data.tar.gz: c796e8855c8f3472629390723cd8c0c6c00559ea
+  metadata.gz: 2dd39f7531c598f9ee00e870eb8b9606f81efbfb
+  data.tar.gz: 72326d1c52afa768c11fbf6bd2eea5cd0f622f13
 SHA512:
-  metadata.gz: b3a4ad59a79b047914a09d125bae342993ab7b619cd48c23a2d7b0c53ade3be1d1d74948ae011a91741247b10729a611d5f1494e538945a641f196c9f4476958
-  data.tar.gz: 3d2fa748e38c0dc9536d9d41d0699868d387556df4d7730ba19e621a79a69e05d593f7b4810ed8e5f9d6dbdeb933fb4d4a0f765cb94b2025ceeaccc67543aca6
+  metadata.gz: 7eeda4512dbf50f26561a22616393e92be166f99883af4674a22d994f0e35437c80727125471d1c844c25746386653ea473d1ae801f19b82ebc5226feb5bb8fb
+  data.tar.gz: bf5a1af2576ac103032ec55d91687b1a0bf25c45b465369c8fd0124f14ccc48647adc06371ffca313f9e1074220405589c8b923bcd2e756963b562a29721cd0a

data/.rubocop.yml

@@ -7,14 +7,8 @@ AllCops:
     - "gemfiles/**/*"
     - "vendor/**/*"
 
-Performance/RedundantBlockCall:
-  Enabled: false
-
-Layout/AlignParameters:
-  Enabled: false
-
 LineLength:
-  Max: 100
+  Max: 120
 
 Metrics:
   Enabled: false

data/.travis.yml

@@ -3,6 +3,7 @@ rvm:
   - 2.3.7
   - 2.4.4
   - 2.5.1
+  - 2.6.5
   - ruby-head
 gemfile:
   - gemfiles/rails_3.2.gemfile
@@ -20,3 +21,21 @@ matrix:
   allow_failures:
     - rvm: ruby-head
     - gemfile: gemfiles/rails_edge.gemfile
+    - rvm: 2.4.4
+      gemfile: gemfiles/rails_3.2.gemfile
+    - rvm: 2.4.4
+      gemfile: gemfiles/rails_4.0.gemfile
+    - rvm: 2.4.4
+      gemfile: gemfiles/rails_4.1.gemfile
+    - rvm: 2.5.1
+      gemfile: gemfiles/rails_3.2.gemfile
+    - rvm: 2.5.1
+      gemfile: gemfiles/rails_4.0.gemfile
+    - rvm: 2.5.1
+      gemfile: gemfiles/rails_4.1.gemfile
+    - rvm: 2.6.5
+      gemfile: gemfiles/rails_3.2.gemfile
+    - rvm: 2.6.5
+      gemfile: gemfiles/rails_4.0.gemfile
+    - rvm: 2.6.5
+      gemfile: gemfiles/rails_4.1.gemfile

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 1.1.0
+- Add auto send read query to slave https://github.com/phamvanhung2e123/switch_point/pull/5
+
 ## 1.0.0 (2019-07-31)
 - Multi slaves support
 - Connect to master by default

data/README.md

@@ -1,10 +1,10 @@
 # SwitchConnection
-[![Gem Version](https://badge.fury.io/rb/switch_point.svg)](http://badge.fury.io/rb/switch_point)
-[![Build Status](https://travis-ci.org/phamvanhung2e123/switch_point.svg?branch=master)](https://travis-ci.org/phamvannhung22123/switch_point)
-[![Coverage Status](https://img.shields.io/coveralls/phamvanhung2e123/switch_point.svg?branch=master)](https://coveralls.io/r/phamvannhung2e123/switch_point?branch=master)
-[![Code Climate](https://codeclimate.com/github/phamvanhung2e123/switch_point/badges/gpa.svg)](https://codeclimate.com/github/phamvannhung2e123/switch_point)
+[![Gem Version](https://badge.fury.io/rb/switch_connection.svg)](https://badge.fury.io/rb/switch_connection)
+[![Build Status](https://travis-ci.org/phamvanhung2e123/switch_point.svg?branch=master)](https://travis-ci.org/phamvanhung2e123/switch_point)
+[![Coverage Status](https://img.shields.io/coveralls/phamvanhung2e123/switch_point.svg?branch=master)](https://coveralls.io/r/phamvanhung2e123/switch_point?branch=master)
+[![Code Climate](https://codeclimate.com/github/phamvanhung2e123/switch_point/badges/gpa.svg)](https://codeclimate.com/github/phamvanhung2e123/switch_point)
 
-Switching database connection between slave one and writable one. Fork from `switch_point` gem.
+Switching database connection between multiple slave and writable one. Fork from `switch_point` gem.
 Original Version: https://github.com/eagletmt/switch_point.
 
 ## Installation
@@ -72,22 +72,26 @@ end
 
 ### Switching connections
 
+- Write query automatically go master database, read query automatically go to slave database.
 ```ruby
-Article.with_slave { Article.first } # Read from db-blog-slave
-Category.with_slave { Category.first } # Also read from db-blog-slave
-Comment.with_slave { Comment.first } # Read from db-comment-slave
-
-Article.with_slave do
-  article = Article.first  # Read from db-blog-slave
-  article.title = 'new title'
-  Article.with_master do
-    article.save!  # Write to db-blog-master
-    article.reload  # Read from db-blog-master
-    Category.first  # Read from db-blog-master
-  end
-end
+article = Article.find(1) # read query go to slave
+article.name = "hoge"
+article.save # write query go to master
 ```
 
+- Use with_master to force query go to master database.
+```ruby
+Article.with_master do
+  article.save! # Write to master db
+  Article.first # Read from master db
+end
+```
+- Force query to master database.
+```ruby
+Article.with_master { Article.all }
+Article.with_master { Article.find(1) }
+Article.with_master { Article.where(name: "foobar").to_a }
+```
 - with_switch_point
 ```ruby
 Book.with_switch_point(:main) { Book.count  }
@@ -95,45 +99,10 @@ Book.with_switch_point(:main) { Book.count  }
 
 Note that Article and Category shares their connections.
 
-## Notes
-
-### auto_master
-`auto_master` by default.
-
-When `auto_master` is enabled, destructive queries is sent to writable connection even in slave mode.
-But it does NOT work well on transactions.
-
-Suppose `after_save` callback is set to User model. When `User.create` is called, it proceeds as follows.
-
-1. BEGIN TRANSACTION is sent to READONLY connection.
-2. switch_point switches the connection to WRITABLE.
-3. INSERT statement is sent to WRITABLE connection.
-4. switch_point reset the connection to READONLY.
-5. after_save callback is called.
-    - At this point, the connection is READONLY and in a transaction.
-6. COMMIT TRANSACTION is sent to READONLY connection.
-
-### connection-related methods of model
-Model has several connection-related methods: `connection_handler`, `connection_pool`, `connected?` and so on.
-Since only `connection` method is monkey-patched, other connection-related methods doesn't work properly.
-If you'd like to use those methods, send it to `Model.switch_point_proxy.model_for_connection`.
-
-## Internals
-There's a proxy which holds two connections: slave one and writable one.
-A proxy has a thread-local state indicating the current mode: slave or writable.
-
-Each ActiveRecord model refers to a proxy.
-`ActiveRecord::Base.connection` is hooked and delegated to the referred proxy.
-
-When the writable connection is requested to execute destructive query, the slave connection clears its query cache.
-
-![switch_point](https://gyazo.wanko.cc/switch_point.svg)
-
 ### Special case: ActiveRecord::Base.connection
 Basically, each connection managed by a proxy isn't shared between proxies.
 But there's one exception: ActiveRecord::Base.
 
-
 ## Contributing
 
 1. Fork it ( https://github.com/phamvanmhung2e123/switch_point/fork )

data/lib/switch_connection.rb

@@ -62,5 +62,7 @@ module SwitchConnection
 end
 ActiveSupport.on_load(:active_record) do
   require 'switch_connection/model'
+  require 'switch_connection/connection_routing'
   ActiveRecord::Base.include(SwitchConnection::Model)
+  ActiveRecord::Relation.prepend(SwitchConnection::Relation::MonkeyPatch)
 end

data/lib/switch_connection/connection_routing.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+# This Module is for MonkeyPatch ActiveRecord::Relation
+module SwitchConnection
+  module Relation
+    module MonkeyPatch
+      def calculate(*args, &block)
+        if @klass.switch_point_proxy && !lock_value && @klass.connection.open_transactions.zero?
+          @klass.with_slave do
+            super
+          end
+        else
+          super
+        end
+      end
+
+      def exists?(*args, &block)
+        if @klass.switch_point_proxy && !lock_value && @klass.connection.open_transactions.zero?
+          @klass.with_slave do
+            super
+          end
+        else
+          super
+        end
+      end
+
+      def pluck(*args, &block)
+        if @klass.switch_point_proxy && !lock_value && @klass.connection.open_transactions.zero?
+          @klass.with_slave do
+            super
+          end
+        else
+          super
+        end
+      end
+    end
+  end
+end

data/lib/switch_connection/model.rb

@@ -10,6 +10,25 @@ module SwitchConnection
       model.singleton_class.class_eval do
         include ClassMethods
         prepend MonkeyPatch
+        def find_by_sql(*args, &block)
+          if switch_point_proxy && connection.open_transactions.zero?
+            with_slave do
+              super
+            end
+          else
+            super
+          end
+        end
+
+        def count_by_sql(*args, &block)
+          if switch_point_proxy && connection.open_transactions.zero?
+            with_slave do
+              super
+            end
+          else
+            super
+          end
+        end
       end
     end
 
@@ -29,12 +48,18 @@ module SwitchConnection
       self.class.transaction_with(*models, &block)
     end
 
+    def reload(*args, &block)
+      self.class.with_master do
+        super(*args, &block)
+      end
+    end
+
     module ClassMethods
       def with_slave(&block)
         if switch_point_proxy
           switch_point_proxy.with_slave(&block)
         else
-          raise UnconfiguredError.new("#{name} isn't configured to use switch_point")
+          yield
         end
       end
 
@@ -42,7 +67,7 @@ module SwitchConnection
         if switch_point_proxy
           switch_point_proxy.with_master(&block)
         else
-          raise UnconfiguredError.new("#{name} isn't configured to use switch_point")
+          yield
         end
       end
 
@@ -117,7 +142,7 @@ module SwitchConnection
       def connection
         if switch_point_proxy
           connection = switch_point_proxy.connection
-          connection.connection_name = switch_point_name
+          connection.connection_name = "#{switch_point_name} #{switch_point_proxy.mode}"
           connection
         else
           super

data/lib/switch_connection/proxy.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require 'switch_connection/error'
-
 module SwitchConnection
   class Proxy
     attr_reader :initial_name
@@ -65,6 +64,18 @@ module SwitchConnection
       thread_local_mode || @global_mode
     end
 
+    def switch_connection_level=(level)
+      Thread.current[:"switch_point_#{@current_name}_level"] = level
+    end
+
+    def switch_connection_level
+      Thread.current[:"switch_point_#{@current_name}_level"] || 0
+    end
+
+    def switch_top_level_connection?
+      switch_connection_level.zero?
+    end
+
     def slave!
       if thread_local_mode
         self.thread_local_mode = :slave
@@ -99,14 +110,21 @@ module SwitchConnection
 
     def with_mode(new_mode, &block)
       unless AVAILABLE_MODES.include?(new_mode)
+        self.switch_connection_level += 1
         raise ArgumentError.new("Unknown mode: #{new_mode}")
       end
 
       saved_mode = thread_local_mode
-      self.thread_local_mode = new_mode
+      if new_mode == :slave && switch_top_level_connection?
+        self.thread_local_mode = :slave
+      elsif new_mode == :master
+        self.thread_local_mode = :master
+      end
+      self.switch_connection_level += 1
       block.call
     ensure
       self.thread_local_mode = saved_mode
+      self.switch_connection_level -= 1
     end
 
     def switch_name(new_name, &block)

data/lib/switch_connection/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SwitchConnection
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

data/spec/models.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'pry'
 SwitchConnection.configure do |config|
   config.define_switch_point :main,
                              slaves: [:main_slave],
@@ -139,3 +140,30 @@ ActiveRecord::Base.connection # Create connection
     end
   end
 end
+
+module SwitchConnection
+  module LogSubscriber
+    def self.included(base)
+      base.send(:attr_accessor, :connection_name)
+      base.send(:alias_method, :sql_without_connection_name, :sql)
+      base.send(:alias_method, :sql, :sql_with_connection_name)
+
+      base.send(:alias_method, :debug_without_connection_name, :debug)
+      base.send(:alias_method, :debug, :debug_with_connection_name)
+    end
+
+    def sql_with_connection_name(event)
+      self.connection_name = event.payload[:connection_name]
+      sql_without_connection_name(event)
+    end
+
+    def debug_with_connection_name(msg)
+      conn = connection_name ? color("  [#{connection_name}]", ActiveSupport::LogSubscriber::BLUE, true) : ''
+      debug_without_connection_name(conn + msg)
+    end
+  end
+end
+
+ActiveRecord::LogSubscriber.include(SwitchConnection::LogSubscriber)
+require 'logger'
+ActiveRecord::Base.logger = Logger.new STDOUT

data/spec/switch_connection/connection_routing_spec.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+require 'pry'
+require 'logger'
+
+RSpec.describe SwitchConnection::Relation::MonkeyPatch do
+  before do
+    Book.create
+  end
+
+  let(:first_id_in_master_db) { Book.with_master { Book.first.id } }
+  describe '.pluck' do
+    subject { Book.pluck(:id) }
+    context 'when connect to master' do
+      it 'id is found' do
+        Book.with_master { is_expected.to eq([first_id_in_master_db]) }
+        expect(Book.with_master { Book.pluck(:id) }).to eq [first_id_in_master_db]
+      end
+    end
+
+    context 'when connect to slave' do
+      it 'id is not found' do
+        is_expected.to eq([])
+      end
+    end
+
+    context 'when thread safe' do
+      it 'work with thread save' do
+        Thread.start do
+          Book.with_master { expect(Book.pluck(:id)).to eq([first_id_in_master_db]) }
+          expect(Book.with_master { Book.pluck(:id) }).to eq [first_id_in_master_db]
+          expect(Book.pluck(:id)).to eq([])
+        end.join
+      end
+    end
+  end
+
+  describe '.exists?' do
+    subject { Book.where(id: first_id_in_master_db).exists? }
+
+    context 'when connect to master' do
+      it 'id is exist' do
+        Book.with_master { is_expected.to eq true }
+        expect(Book.with_master { Book.where(id: first_id_in_master_db).exists? }).to eq true
+      end
+    end
+
+    context 'when connect to slave' do
+      it 'id is not exist' do
+        is_expected.to eq false
+      end
+    end
+
+    context 'when in multi thread' do
+      it 'thread safe' do
+        Thread.start do
+          Book.with_master { expect(Book.where(id: first_id_in_master_db).exists?).to eq true }
+          expect(Book.with_master { Book.where(id: first_id_in_master_db).exists? }).to eq true
+          expect(Book.where(id: first_id_in_master_db).exists?).to eq false
+        end.join
+      end
+    end
+  end
+
+  describe '.calculate' do
+    subject { Book.where(id: first_id_in_master_db).count }
+
+    context 'when connect to master' do
+      it 'id is exist' do
+        Book.with_master { is_expected.to eq 1 }
+        expect(Book.with_master { Book.where(id: first_id_in_master_db).count }).to eq 1
+      end
+    end
+
+    context 'when connect to slave' do
+      it 'id is not exist' do
+        is_expected.to eq 0
+      end
+    end
+
+    context 'when in multi thread' do
+      it 'thread safe' do
+        Thread.start do
+          Book.with_master { expect(Book.where(id: first_id_in_master_db).count).to eq 1 }
+          expect(Book.with_master { Book.where(id: first_id_in_master_db).count }).to eq 1
+          expect(Book.where(id: first_id_in_master_db).count).to eq 0
+        end.join
+      end
+    end
+  end
+end

data/spec/switch_connection/model_spec.rb

@@ -198,12 +198,6 @@ RSpec.describe SwitchConnection::Model do
       end
     end
 
-    context 'without use_switch_point' do
-      it 'raises error' do
-        expect { Note.with_master { :bypass } }.to raise_error(SwitchConnection::UnconfiguredError)
-      end
-    end
-
     it 'affects thread-locally' do
       Book.with_slave do
         expect(Book).to connect_to('main_slave.sqlite3')
@@ -399,4 +393,75 @@ RSpec.describe SwitchConnection::Model do
       expect { book.transaction_with(Book3) {} }.to raise_error(SwitchConnection::Error)
     end
   end
+
+  describe '.find_by_sql' do
+    before do
+      Book.create
+    end
+
+    context 'when call find_by_sql from slave' do
+      it 'empty array' do
+        expect(Book.find_by_sql('SELECT * FROM books')).to eq([])
+      end
+    end
+
+    context 'when call find_by_sql from master' do
+      it 'not empty array' do
+        expect(Book.with_master { Book.find_by_sql('SELECT * FROM books') }).not_to eq([])
+      end
+    end
+  end
+
+  describe '.count_of_sql' do
+    before do
+      Book.create
+    end
+
+    context 'when count from slave' do
+      it 'return 0' do
+        expect(Book.count_by_sql('select count(*) from books')).to eq(0)
+      end
+    end
+
+    context 'when count from master' do
+      it 'return 1' do
+        Book.with_master { expect(Book.count_by_sql('select count(*) from books')).to eq(1) }
+        expect(Book.with_master { Book.count_by_sql('select count(*) from books') }).to eq(1)
+      end
+    end
+  end
+
+  describe '.cache' do
+    before do
+      Book.create
+    end
+
+    context 'when call count' do
+      it 'return 0' do
+        Book.cache {
+          expect(Book.count).to eq 0
+          expect(Book.count).to eq 0
+          expect(Book.with_master { Book.count }).to eq 1
+          expect(Book.with_master { Book.count }).to eq 1
+        }
+      end
+    end
+  end
+
+  describe '.uncached' do
+    before do
+      Book.create
+    end
+
+    context 'when call count' do
+      it 'return 0' do
+        Book.uncached {
+          expect(Book.count).to eq 0
+          expect(Book.count).to eq 0
+          expect(Book.with_master { Book.count }).to eq 1
+          expect(Book.with_master { Book.count }).to eq 1
+        }
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: switch_connection
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Kohei Suzuki
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-31 00:00:00.000000000 Z
+date: 2020-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: appraisal
@@ -224,6 +224,7 @@ files:
 - gemfiles/rails_edge.gemfile
 - lib/switch_connection.rb
 - lib/switch_connection/config.rb
+- lib/switch_connection/connection_routing.rb
 - lib/switch_connection/error.rb
 - lib/switch_connection/model.rb
 - lib/switch_connection/proxy.rb
@@ -231,6 +232,7 @@ files:
 - lib/switch_connection/version.rb
 - spec/models.rb
 - spec/spec_helper.rb
+- spec/switch_connection/connection_routing_spec.rb
 - spec/switch_connection/model_spec.rb
 - spec/switch_connection_spec.rb
 - switch_connection.gemspec
@@ -261,5 +263,6 @@ summary: Switching database connection between readonly one and writable one.
 test_files:
 - spec/models.rb
 - spec/spec_helper.rb
+- spec/switch_connection/connection_routing_spec.rb
 - spec/switch_connection/model_spec.rb
 - spec/switch_connection_spec.rb