replica_pools 2.1.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0f5c202965abf750f17e9d72c0b46e18b0fc4eee
-  data.tar.gz: 912c2ff07bc4903903b64075e1a47341a58381ed
+  metadata.gz: ccf84c0499a86c7e36948d178c8fb150fc71003b
+  data.tar.gz: 93bc95a40cd6a411ea255bc3fc94e2e8860add71
 SHA512:
-  metadata.gz: e6741659d20dfef95958423f7fd52c7368072a3181daa98526b36e5a00868cd793064c53540e6182faa3c048e6ef5697afa45757c411067ece9b8139d3a00679
-  data.tar.gz: 11c4329fad66878b81ac76cac6b3a2dc729d90d35a4665dc2167ba3d31fecdc595ea5385e15209e71d1a9b8c9f2b0975c2ac57fc64ba3004b95a951dd47c899c
+  metadata.gz: 947621a358c1034cc8a45b70e1f56d1a58126552c700ec18f3e636cfbd80f44eeb9c3288ad3cc78f142a52a3a9df7668cc746f14ba71cd242596998d96bd3182
+  data.tar.gz: 4cc0aab455a96d11d2c56fb17e3af40ec8ae33502bf1a70064c71c9e26a043f41ea7ab47937923735408827bb358cb766d5e8dadedeefe57b1206df8ba44e302

data/README.md

@@ -160,24 +160,37 @@ Here's one way to accomplish that:
       end
     end
 
+## Disabling Leader
+
+To disable queries to the leader database -- for instance, in a production
+console -- set the disable_leader configuration to false. This will raise
+a ReplicaPools::LeaderDisabled error:
+
+  ReplicaPools.config.disable_leader = false
+
 ## Running specs
 
-If you haven't already, install the rspec gem, then set up your database
-with a test database and a read_only user.
+Tests are run against MySQL 5.6 using docker-compose. 🐋
 
-To match spec/config/database.yml, you can run:
+To get set up, first run:
 
-    rake bootstrap
+```bash
+$ docker-compose up
+$ bundle install
+$ bundle exec rake bootstrap
+```
 
-From the plugin directory, run:
+Then you can run tests with:
 
-    rspec spec
+```bash
+$ bundle exec rake spec
+```
 
 ## Authors
 
 Author: Dan Drabik, Lance Ivy
 
-Copyright (c) 2012-2013, Kickstarter
+Copyright (c) 2012-2018, Kickstarter
 
 Released under the MIT license
 

data/lib/replica_pools.rb

@@ -11,6 +11,12 @@ require 'replica_pools/engine' if defined? Rails
 ActiveRecord::Base.send :include, ReplicaPools::ActiveRecordExtensions
 
 module ReplicaPools
+  class LeaderDisabled < StandardError
+    def to_s
+      "Leader database has been disabled. Re-enable with ReplicaPools.config.disable_leader = false."
+    end
+  end
+
   class << self
 
     def config
@@ -45,6 +51,7 @@ module ReplicaPools
     end
 
     def with_leader
+      raise LeaderDisabled.new if ReplicaPools.config.disable_leader
       proxy.with_leader{ yield }
     end
 

data/lib/replica_pools/active_record_extensions.rb

@@ -5,7 +5,11 @@ module ReplicaPools
     end
 
     def reload(options = nil)
-      self.class.connection_proxy.with_leader { super }
+      if ReplicaPools.config.disable_leader
+        super
+      else
+        self.class.connection_proxy.with_leader { super }
+      end
     end
 
     module ClassMethods

data/lib/replica_pools/config.rb

@@ -9,6 +9,10 @@ module ReplicaPools
     # Defaults to false.
     attr_accessor :defaults_to_leader
 
+    # When true, the leader database will not be selectable.
+    # Defaults to false.
+    attr_accessor :disable_leader
+
     # The list of methods considered safe to send to a readonly connection.
     # Defaults are based on Rails version.
     attr_accessor :safe_methods
@@ -16,6 +20,7 @@ module ReplicaPools
     def initialize
       @environment        = 'development'
       @defaults_to_leader = false
+      @disable_leader     = false
       @safe_methods       = []
     end
   end

data/lib/replica_pools/connection_proxy.rb

@@ -55,13 +55,17 @@ module ReplicaPools
     end
 
     def with_leader
+      raise LeaderDisabled.new if ReplicaPools.config.disable_leader
+
       last_conn = self.current
       self.current = leader
       self.leader_depth += 1
       yield
     ensure
-      self.leader_depth = [leader_depth - 1, 0].max
-      self.current = last_conn
+      if last_conn
+        self.leader_depth = [leader_depth - 1, 0].max
+        self.current = last_conn
+      end
     end
 
     def transaction(*args, &block)
@@ -104,6 +108,7 @@ module ReplicaPools
     end
 
     def route_to(conn, method, *args, &block)
+      raise ReplicaPools::LeaderDisabled.new if ReplicaPools.config.disable_leader && conn == leader
       conn.retrieve_connection.send(method, *args, &block)
     rescue => e
       ReplicaPools.log :error, "Error during ##{method}: #{e}"
@@ -117,7 +122,7 @@ module ReplicaPools
       ReplicaPools.log :error, "Current Connection: #{current}"
       ReplicaPools.log :error, "Current Pool Name: #{current_pool.name}"
       ReplicaPools.log :error, "Current Pool Members: #{current_pool.replicas}"
-      ReplicaPools.log :error, "leader Depth: #{leader_depth}"
+      ReplicaPools.log :error, "Leader Depth: #{leader_depth}"
     end
   end
 end

data/lib/replica_pools/engine.rb

@@ -25,7 +25,11 @@ module ReplicaPools
           [
            :select_all, :select_one, :select_value, :select_values,
            :select_rows, :select, :select_prepared, :verify!, :raw_connection,
-           :active?, :reconnect!, :disconnect!, :reset_runtime, :log
+           :active?, :reconnect!, :disconnect!, :reset_runtime, :log,
+           :lookup_cast_type_from_column, :sanitize_limit,
+           :combine_bind_parameters, :quote_table_name, :quote, :quote_column_names, :quote_table_names,
+           :case_sensitive_comparison, :case_insensitive_comparison,
+           :schema_cache, :cacheable_query, :prepared_statements, :clear_cache!
           ]
         else
           warn "Unsupported ActiveRecord version #{ActiveRecord.version}. Please whitelist the safe methods."

data/lib/replica_pools/version.rb

@@ -1,3 +1,3 @@
 module ReplicaPools
-  VERSION = "2.1.0"
+  VERSION = "2.1.1"
 end

data/spec/connection_proxy_spec.rb

@@ -54,6 +54,19 @@ describe ReplicaPools do
       end
       @proxy.send(:within_leader_block?).should_not be
     end
+
+    context "with leader_disabled=true" do
+      before { ReplicaPools.config.disable_leader = true }
+      after { ReplicaPools.config.disable_leader = false }
+
+      it 'should not execute query, and maintain replica connection' do
+        @executed = false
+        @proxy.current = @proxy.current_replica
+        expect { @proxy.with_leader { @executed = true } }.to raise_error(ReplicaPools::LeaderDisabled)
+        @executed.should eq(false)
+        @proxy.current.name.should eq('ReplicaPools::DefaultDb1')
+      end
+    end
   end
 
   context "transaction" do
@@ -124,6 +137,18 @@ describe ReplicaPools do
     end
   end
 
+  context "with leader_disabled=true" do
+    before { ReplicaPools.config.disable_leader = true }
+    after { ReplicaPools.config.disable_leader = false }
+    it 'should raise an error instead of sending dangerous methods to the leader' do
+      meths = [:insert, :update, :delete, :execute]
+      meths.each do |meth|
+        @default_replica1.stub(meth).and_raise(RuntimeError)
+        expect { @proxy.send(meth, @sql) }.to raise_error(ReplicaPools::LeaderDisabled)
+      end
+    end
+  end
+
   it "should not allow leader depth to get below 0" do
     @proxy.instance_variable_set("@leader_depth", -500)
     @proxy.instance_variable_get("@leader_depth").should == -500
@@ -132,7 +157,9 @@ describe ReplicaPools do
   end
 
   it 'should pre-generate safe methods' do
-    @proxy.should respond_to(:select_value)
+    ReplicaPools.config.safe_methods.each do |m|
+      @proxy.should respond_to(m)
+    end
   end
 
   it 'should dynamically generate unsafe methods' do
@@ -158,6 +185,20 @@ describe ReplicaPools do
     foo.reload
   end
 
+  context "with leader_disabled=true" do
+    after { ReplicaPools.config.disable_leader = false }
+
+    it 'should reload models from a replica' do
+      foo = TestModel.create!
+      ReplicaPools.config.disable_leader = true
+      foo = TestModel.last
+      @leader.should_not_receive(:select_all)
+      @default_replica1.should_receive(:select_all).and_return(ActiveRecord::Result.new(["id"], ["1"]))
+      @default_replica2.should_not_receive(:select_all)
+      foo.reload
+    end
+  end
+
   context "with_pool" do
 
     it "should switch to the named pool" do

data/spec/slave_pools_spec.rb

@@ -22,6 +22,16 @@ describe ReplicaPools do
     ReplicaPools.with_leader
   end
 
+  describe 'with leader disabled' do
+    before { ReplicaPools.config.disable_leader = true }
+    after { ReplicaPools.config.disable_leader = false }
+
+    it 'should delegate with_leader call to connection proxy' do
+      @proxy.should_receive(:with_leader).exactly(0)
+      expect { ReplicaPools.with_leader }.to raise_error(ReplicaPools::LeaderDisabled)
+    end
+  end
+
   it 'should delegate current call to connection proxy' do
     @proxy.should_receive(:current).exactly(1)
     ReplicaPools.current

data/spec/spec_helper.rb

@@ -11,8 +11,7 @@ end
 require 'active_record'
 spec_dir = File.dirname(__FILE__)
 ActiveRecord::Base.logger = Logger.new(spec_dir + "/debug.log")
-ActiveRecord::Base.configurations = YAML::load(File.open(spec_dir + '/config/database.yml'))
-
+ActiveRecord::Base.configurations = YAML::load(ERB.new(File.read(spec_dir + '/config/database.yml')).result)
 ActiveRecord::Base.establish_connection :test
 ActiveRecord::Migration.verbose = false
 ActiveRecord::Migration.create_table(:test_models, :force => true) {}
@@ -41,4 +40,12 @@ end
 
 RSpec.configure do |c|
   c.include ReplicaPools::Testing
+
+  # This gem mostly uses the old deprecated shoulda syntax. Support both versions for now.
+  c.expect_with :rspec do |c|
+    c.syntax = [:expect, :should]
+  end
+  c.mock_with :rspec do |c|
+    c.syntax = [:expect, :should]
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: replica_pools
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.1.1
 platform: ruby
 authors:
 - Dan Drabik
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-17 00:00:00.000000000 Z
+date: 2018-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -31,14 +31,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.11
+        version: 0.4.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.11
+        version: 0.4.4
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -139,14 +139,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '1.2'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.2
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Connection proxy for ActiveRecord for leader / replica setups.
 test_files:
-- spec/config/test_model.rb
-- spec/connection_proxy_spec.rb
+- spec/spec_helper.rb
 - spec/pool_spec.rb
-- spec/query_cache_spec.rb
 - spec/slave_pools_spec.rb
-- spec/spec_helper.rb
+- spec/config/test_model.rb
+- spec/query_cache_spec.rb
+- spec/connection_proxy_spec.rb