switch_point 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d470827ada389d47ee22e4956e6a45a42203abbb
-  data.tar.gz: 0b73cf90012e2fb62556830421c220cf01e59b21
+  metadata.gz: c52a7c39b406241e2df69b1d0dfae3a6c45d15d3
+  data.tar.gz: 606dd78b88ad59873c9d7e187c110163899f1ffb
 SHA512:
-  metadata.gz: 62fde9258b6d872a319643c32935cbeda95bf2ce80c56f1ca96a73a2bf519562b51fbdf22feb870be8538418f4c273ec828d1ca2279d4678fb6977a701821cd0
-  data.tar.gz: 296199d722f3dc08deb552f7258796f2d124346cc1268af7302f209f255cb5f8c2ba27a6fcec4ecfffc44c0a6ed7b193768e2d48c03641c26be33fe00345fe3b
+  metadata.gz: 1e9097c7f4e5696728fc57a0f190ccd6a4c65d665f1fbb7cfbc89e67cd77658f288d8a4f16a7360e3e34c103a1fdbb050b132eafc13e077901f1af25f1d8cf75
+  data.tar.gz: 02bcf5bc10f0c2c4a3b7ee04f3d33b1a94edcfc0f1b91ef1ff2251963052983c3d24cdb67f8a80b6e73daae802d1448352eb573a364d41559d228752efe89337

data/CHANGELOG.md

@@ -1,2 +1,6 @@
+## 0.2.0 (2014-05-29)
+- Always send destructive operations to writable connection
+- Fix bug on pooled connections
+
 ## 0.1.0 (2014-05-28)
 - Initial release

data/lib/switch_point.rb

@@ -19,7 +19,7 @@ module SwitchPoint
     end
 
     def readonly!(name)
-      ProxyRepository.find(name).readonly!
+      ProxyRepository.checkout(name).readonly!
     end
 
     def writable_all!
@@ -29,7 +29,7 @@ module SwitchPoint
     end
 
     def writable!(name)
-      ProxyRepository.find(name).writable!
+      ProxyRepository.checkout(name).writable!
     end
   end
   extend ClassMethods
@@ -37,5 +37,12 @@ end
 
 ActiveSupport.on_load(:active_record) do
   require 'switch_point/model'
+  require 'switch_point/connection'
   ActiveRecord::Base.send(:include, SwitchPoint::Model)
+  ActiveRecord::ConnectionAdapters::AbstractAdapter.class_eval do
+    include SwitchPoint::Connection
+    SwitchPoint::Connection::DESTRUCTIVE_METHODS.each do |method_name|
+      alias_method_chain method_name, :switch_point
+    end
+  end
 end

data/lib/switch_point/config.rb

@@ -14,6 +14,10 @@ module SwitchPoint
       "#{mode}_#{database_name(name, mode)}".camelize
     end
 
+    def fetch(name)
+      @switch_points.fetch(name)
+    end
+
     def keys
       @switch_points.keys
     end

data/lib/switch_point/connection.rb

@@ -0,0 +1,41 @@
+require 'switch_point/proxy_repository'
+
+module SwitchPoint
+  module Connection
+    # See ActiveRecord::ConnectionAdapters::QueryCache
+    DESTRUCTIVE_METHODS = [:insert, :update, :delete]
+
+    DESTRUCTIVE_METHODS.each do |method_name|
+      define_method(:"#{method_name}_with_switch_point") do |*args, &block|
+        switch_point = self.pool.instance_variable_get(:@switch_point)
+        parent_method = :"#{method_name}_without_switch_point"
+        if switch_point
+          proxy = ProxyRepository.find(switch_point[:name])
+          case switch_point[:mode]
+          when :readonly
+            Connection.proxy_to_writable(proxy, method_name, *args, &block)
+          when :writable
+            Connection.purge_readonly_query_cache(proxy)
+            send(parent_method, *args, &block)
+          else
+            raise RuntimeError.new("Unknown mode #{switch_point[:mode]} is given with #{name}")
+          end
+        else
+          send(parent_method, *args, &block)
+        end
+      end
+    end
+
+    def self.proxy_to_writable(proxy, method_name, *args, &block)
+      proxy.with_writable do
+        proxy.connection.send(method_name, *args, &block)
+      end
+    end
+
+    def self.purge_readonly_query_cache(proxy)
+      proxy.with_readonly do
+        proxy.connection.clear_query_cache
+      end
+    end
+  end
+end

data/lib/switch_point/model.rb

@@ -5,21 +5,19 @@ module SwitchPoint
     def self.included(model)
       model.singleton_class.class_eval do
         include ClassMethods
-        prepend ConnectionHook
+        alias_method_chain :connection, :switch_point
       end
     end
 
-    module ConnectionHook
-      def connection
+    module ClassMethods
+      def connection_with_switch_point
         if @switch_point_name
           switch_point_proxy.connection
         else
-          super
+          connection_without_switch_point
         end
       end
-    end
 
-    module ClassMethods
       def with_readonly(&block)
         switch_point_proxy.with_readonly(&block)
       end
@@ -28,14 +26,19 @@ module SwitchPoint
         switch_point_proxy.with_writable(&block)
       end
 
-      private
-
       def use_switch_point(name)
+        assert_existing_switch_point!(name)
         @switch_point_name = name
       end
 
+      private
+
+      def assert_existing_switch_point!(name)
+        SwitchPoint.config.fetch(name)
+      end
+
       def switch_point_proxy
-        @switch_point_proxy ||= ProxyRepository.find(@switch_point_name)
+        ProxyRepository.checkout(@switch_point_name)
       end
     end
   end

data/lib/switch_point/proxy.rb

@@ -1,5 +1,3 @@
-require 'switch_point/writable_connection_hook'
-
 module SwitchPoint
   class Proxy
     def initialize(name)
@@ -8,9 +6,8 @@ module SwitchPoint
         model = define_model(SwitchPoint.config.model_name(name, mode))
         @models[mode] = model
         model.establish_connection(SwitchPoint.config.database_name(name, mode))
-        memorize_switch_point_name(name, model.connection)
+        memorize_switch_point(name, mode, model.connection)
       end
-      @models[:writable].connection.extend(WritableConnectionHook)
       @mode = :readonly
     end
 
@@ -20,8 +17,9 @@ module SwitchPoint
       model
     end
 
-    def memorize_switch_point_name(name, connection)
-      connection.instance_variable_set(:@switch_point_name, name)
+    def memorize_switch_point(name, mode, connection)
+      switch_point = { name: name, mode: mode }
+      connection.pool.instance_variable_set(:@switch_point, switch_point)
     end
 
     def readonly!

data/lib/switch_point/proxy_repository.rb

@@ -5,14 +5,22 @@ module SwitchPoint
   class ProxyRepository
     include Singleton
 
+    def self.checkout(name)
+      instance.checkout(name)
+    end
+
     def self.find(name)
       instance.find(name)
     end
 
-    def find(name)
+    def checkout(name)
       proxies[name] ||= Proxy.new(name)
     end
 
+    def find(name)
+      proxies.fetch(name)
+    end
+
     def proxies
       @proxies ||= {}
     end

data/lib/switch_point/version.rb

@@ -1,3 +1,3 @@
 module SwitchPoint
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/spec/spec_helper.rb

@@ -38,10 +38,8 @@ RSpec.configure do |config|
   end
 
   config.after(:each) do
-    Book.delete_all
-    Book.with_writable do
-      Book.delete_all
-    end
+    Book.delete_all # This queries to writable database
+    FileUtils.cp('main_writable.sqlite3', 'main_readonly.sqlite3')
   end
 end
 

data/spec/switch_point/model_spec.rb

@@ -1,4 +1,26 @@
 RSpec.describe SwitchPoint::Model do
+  describe '.use_switch_point' do
+    after do
+      Book.use_switch_point :main
+    end
+
+    it 'changes connection' do
+      expect(Book).to connect_to('main_readonly.sqlite3')
+      Book.use_switch_point :comment
+      expect(Book).to connect_to('comment_readonly.sqlite3')
+    end
+
+    context 'with non-existing switch point name' do
+      it 'raises error' do
+        expect {
+          Class.new(ActiveRecord::Base) do
+            use_switch_point :not_found
+          end
+        }.to raise_error(KeyError)
+      end
+    end
+  end
+
   describe '.connection' do
     it 'returns readonly connection by default' do
       expect(Book).to connect_to('main_readonly.sqlite3')
@@ -8,6 +30,21 @@ RSpec.describe SwitchPoint::Model do
       expect(Note).to connect_to('default.sqlite3')
     end
 
+    it 'sends destructive queries to writable' do
+      Book.create
+      Book.with_readonly { expect(Book.count).to eq(0) }
+      Book.with_writable { expect(Book.count).to eq(1) }
+    end
+
+    it 'works with newly checked-out connection' do
+      Thread.start do
+        expect(Book.connection.pool.connections.size).to be > 1 # Assertion
+        Book.create
+        Book.with_readonly { expect(Book.count).to eq(0) }
+        Book.with_writable { expect(Book.count).to eq(1) }
+      end.join
+    end
+
     context 'without switch_point configuration' do
       it 'returns default connection' do
         expect(Note.connection).to equal(ActiveRecord::Base.connection)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: switch_point
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Kohei Suzuki
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-28 00:00:00.000000000 Z
+date: 2014-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: appraisal
@@ -115,11 +115,11 @@ files:
 - gemfiles/rails_4.1.gemfile
 - lib/switch_point.rb
 - lib/switch_point/config.rb
+- lib/switch_point/connection.rb
 - lib/switch_point/model.rb
 - lib/switch_point/proxy.rb
 - lib/switch_point/proxy_repository.rb
 - lib/switch_point/version.rb
-- lib/switch_point/writable_connection_hook.rb
 - spec/models.rb
 - spec/spec_helper.rb
 - spec/switch_point/model_spec.rb

data/lib/switch_point/writable_connection_hook.rb

@@ -1,17 +0,0 @@
-require 'switch_point/proxy_repository'
-
-module SwitchPoint
-  # Propagate clear_query_cache in writable connection to readonly connection
-  module WritableConnectionHook
-    # See ActiveRecord::ConnectionAdapters::QueryCache
-    [:insert, :update, :delete].each do |method_name|
-      define_method(method_name) do |*args, &block|
-        proxy = ProxyRepository.find(@switch_point_name)
-        proxy.with_readonly do
-          proxy.connection.clear_query_cache
-        end
-        super(*args, &block)
-      end
-    end
-  end
-end