makara 0.3.6 → 0.3.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 854be0f8b5615812158cd37511db68cc47310f75
-  data.tar.gz: 8cc3d705dd2d83415a8d4348d9ce2b949d0eb954
+  metadata.gz: d07deed98a5cc668ea6621fe741b4fbbcb210e9b
+  data.tar.gz: 1f849bf4f2eb6a38c5a6253ed64348e9d60e76cd
 SHA512:
-  metadata.gz: 8669c261ead2cce40c1ffa8f319f975d162623071f54290fbed54e1a65159b2698c9eab709159cb6f71858b2d32b20ad9996b8472502c91a8086fdb89c08d31a
-  data.tar.gz: 2089f3e36f9add64c5ecdef2634665fde5aa3a2cc94ab4230f9f8099d9c438f7da057b73406b8c8f9abab8c596424ad4cd0deef627fff7831f0c0ca9f9004233
+  metadata.gz: 837a1140206708c09ca4ba72f3febe76d00ebc9e10161c114f7ca80d6f749476d9b8bd0b5e4505394c9229d80a12c7c973967e1430dd42c2038b4b236c21d531
+  data.tar.gz: 21dca3b441fae6bb6f438566e3e2d5d2fa0acfa7e0637475f26215486277b225805206200b5c3150f6ac79cc17ae8f0bcfd379feb1e090ec25f3d6aee996d1a9

data/CHANGELOG.md

@@ -1,6 +1,27 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
+## v0.3.7.rc - 2016-09-16
+
+[Full Changelog](https://github.com/taskrabbit/makara/compare/v0.3.6...v0.3.7.rc)
+
+Changed
+
+- Fix the hierarchy of the config file [#116](https://github.com/taskrabbit/makara/pull/116) Kevin Bacha
+- "Disable blacklist" parameter [#134](https://github.com/taskrabbit/makara/pull/134) Alex Tonkonozhenko
+- Fixes bug in `without_sticking` [#96](https://github.com/taskrabbit/makara/pull/96) Brian Leonard
+- Always stick inside transactions [#96](https://github.com/taskrabbit/makara/pull/96) Brian Leonard
+- Rails 5 support [#122](https://github.com/taskrabbit/makara/pull/122) Jonny McAllister
+
+## v0.3.6 - 2016-04-21
+
+[Full Changelog](https://github.com/taskrabbit/makara/compare/v0.3.5...v0.3.6)
+
+Changed
+
+- Allow different strategies such as `priority` and `round_robin` for pools [#105](https://github.com/taskrabbit/makara/pull/105) Brian Leonard
+
+
 ## v0.3.5 - 2016-01-08
 
 [Full Changelog](https://github.com/taskrabbit/makara/compare/v0.3.4.rc1...v0.3.5)

data/README.md

@@ -16,8 +16,10 @@ There is a potential performance issue when used alongside certain versions of
 
 ## Installation
 
+Use the current version of the gem from [rubygems](https://rubygems.org/gems/makara) in your `Gemfile`.
+
 ```ruby
-gem 'makara', github: 'taskrabbit/makara', tag: 'v0.3.x'
+gem 'makara'
 ```
 
 ## Basic Usage
@@ -160,6 +162,7 @@ Following the adapter choice is all the standard configurations (host, port, ret
 
 The makara subconfig sets up the proxy with a few of its own options, then provides the connection list. The makara options are:
 * blacklist_duration - the number of seconds a node is blacklisted when a connection failure occurs
+* disable_blacklist - do not blacklist node at any error, useful in case of one master
 * sticky - if a node should be stuck to once it's used during a specific context
 * master_ttl - how long the master context is persisted. generally, this needs to be longer than any replication lag
 * master_strategy - use a different strategy for picking the "current" node: `failover` will try to keep the same one until it is blacklisted. The default is `round_robin` which will cycle through available ones.

data/lib/makara/config_parser.rb

@@ -157,16 +157,16 @@ module Makara
 
 
     def master_configs
-      all_configs.
-        select{|config| config[:role] == 'master' }.
-        map{|config| config.except(:role) }
+      all_configs
+        .select { |config| config[:role] == 'master' }
+        .map { |config| config.except(:role) }
     end
 
 
     def slave_configs
-      all_configs.
-        reject{|config| config[:role] == 'master' }.
-        map{|config| config.except(:role) }
+      all_configs
+        .reject { |config| config[:role] == 'master' }
+        .map { |config| config.except(:role) }
     end
 
 
@@ -175,7 +175,8 @@ module Makara
 
     def all_configs
       @makara_config[:connections].map do |connection|
-        base_config.merge(connection.symbolize_keys)
+        base_config.merge(makara_config.except(:connections))
+                   .merge(connection.symbolize_keys)
       end
     end
 

data/lib/makara/connection_wrapper.rb

@@ -44,7 +44,7 @@ module Makara
     def _makara_blacklist!
       @connection.disconnect! if @connection
       @connection = nil
-      @blacklisted_until = Time.now.to_i + @config[:blacklist_duration]
+      @blacklisted_until = Time.now.to_i + @config[:blacklist_duration] unless @config[:disable_blacklist]
     end
 
     # release the blacklist

data/lib/makara/proxy.rb

@@ -59,10 +59,13 @@ module Makara
     end
 
     def without_sticking
+      before_context = @master_context
+      @master_context = nil
       @skip_sticking = true
       yield
     ensure
       @skip_sticking = false
+      @master_context ||= before_context
     end
 
     def hijacked?
@@ -141,7 +144,7 @@ module Makara
       @master_pool.provide do |con|
         yield con
       end
-    rescue ::Makara::Errors::AllConnectionsBlacklisted, ::Makara::Errors::NoConnectionsAvailable => e
+    rescue ::Makara::Errors::AllConnectionsBlacklisted, ::Makara::Errors::NoConnectionsAvailable
       begin
         @master_pool.disabled = true
         @slave_pool.provide do |con|
@@ -208,6 +211,9 @@ module Makara
         stick_to_master(method_name, args)
         @master_pool
 
+      elsif in_transaction?
+        @master_pool
+
       # yay! use a slave
       else
         @slave_pool
@@ -219,6 +225,13 @@ module Makara
       true
     end
 
+    def in_transaction?
+      if respond_to?(:open_transactions)
+        self.open_transactions > 0
+      else
+        false
+      end
+    end
 
     def hijacked
       @hijacked = true
@@ -256,14 +269,14 @@ module Makara
     def instantiate_connections
       @master_pool = Makara::Pool.new('master', self)
       @config_parser.master_configs.each do |master_config|
-        @master_pool.add master_config.merge(@config_parser.makara_config) do
+        @master_pool.add master_config do
           graceful_connection_for(master_config)
         end
       end
 
       @slave_pool = Makara::Pool.new('slave', self)
       @config_parser.slave_configs.each do |slave_config|
-        @slave_pool.add slave_config.merge(@config_parser.makara_config) do
+        @slave_pool.add slave_config do
           graceful_connection_for(slave_config)
         end
       end

data/lib/makara/railtie.rb

@@ -1,8 +1,9 @@
 module Makara
   class Railtie < ::Rails::Railtie
 
-    config.app_middleware.use 'Makara::Middleware'
-
+    initializer "makara.configure_rails_initialization" do |app|
+      app.middleware.use Makara::Middleware
+    end
 
     initializer "makara.initialize_logger" do |app|
       ActiveRecord::LogSubscriber.log_subscribers.each do |subscriber|

data/lib/makara/version.rb

@@ -3,7 +3,7 @@ module Makara
 
     MAJOR = 0
     MINOR = 3
-    PATCH = 6
+    PATCH = 7
     PRE = nil
 
     def self.to_s

data/spec/active_record/connection_adapters/makara_mysql2_adapter_spec.rb

@@ -10,6 +10,8 @@ describe 'MakaraMysql2Adapter' do
     base
   }
 
+  let(:connection) { ActiveRecord::Base.connection }
+
   before :each do
     ActiveRecord::Base.clear_all_connections!
     change_context
@@ -99,8 +101,6 @@ describe 'MakaraMysql2Adapter' do
 
   context 'with the connection established and schema loaded' do
 
-    let(:connection) { ActiveRecord::Base.connection }
-
     before do
       ActiveRecord::Base.establish_connection(config)
       load(File.dirname(__FILE__) + '/../../support/schema.rb')
@@ -180,4 +180,60 @@ describe 'MakaraMysql2Adapter' do
 
   end
 
+  describe 'transaction support' do
+    shared_examples 'a transaction supporter' do
+      before do
+        ActiveRecord::Base.establish_connection(config)
+        load(File.dirname(__FILE__) + '/../../support/schema.rb')
+        change_context
+
+        connection.slave_pool.connections.each do |slave|
+          # Using method missing to help with back trace, literally
+          # no query should be executed on slave once a transaction is opened
+          expect(slave).to receive(:method_missing).never
+          expect(slave).to receive(:execute).never
+        end
+      end
+
+      context 'when querying through a polymorphic relation' do
+        it 'should respect the transaction' do
+          ActiveRecord::Base.transaction do
+            connection.execute("INSERT INTO users (name) VALUES ('John')")
+            connection.execute('SELECT * FROM users')
+          end
+        end
+      end
+
+      context 'when querying an aggregate' do
+        it 'should respect the transaction' do
+          ActiveRecord::Base.transaction { connection.execute('SELECT COUNT(*) FROM users') }
+        end
+      end
+
+      context 'when querying for a specific record' do
+        it 'should respect the transaction' do
+          ActiveRecord::Base.transaction { connection.execute('SELECT * FROM users WHERE id = 1') }
+        end
+      end
+
+      context 'when executing a query' do
+        it 'should respect the transaction' do
+          ActiveRecord::Base.transaction { connection.execute('SELECT 1') }
+        end
+      end
+    end
+
+    context 'when sticky is true' do
+      before { config['makara']['sticky'] = true }
+
+      it_behaves_like 'a transaction supporter'
+    end
+
+    context 'when sticky is false' do
+      before { config['makara']['sticky'] = false }
+
+      it_behaves_like 'a transaction supporter'
+    end
+  end
+
 end

data/spec/active_record/connection_adapters/makara_postgresql_adapter_spec.rb

@@ -27,6 +27,7 @@ describe 'MakaraPostgreSQLAdapter' do
   context 'with the connection established and schema loaded' do
 
     before do
+          puts config
       ActiveRecord::Base.establish_connection(config)
       load(File.dirname(__FILE__) + '/../../support/schema.rb')
       change_context
@@ -77,45 +78,102 @@ describe 'MakaraPostgreSQLAdapter' do
       expect(con).to receive(:execute).with('UPDATE users SET name = "bob" WHERE id = 1')
       connection.execute('UPDATE users SET name = "bob" WHERE id = 1')
     end
-
   end
 
   context 'without live connections' do
-      it 'should raise errors on read or write' do
-        allow(ActiveRecord::Base).to receive(:postgresql_connection).and_raise(StandardError.new('could not connect to server: Connection refused'))
+    it 'should raise errors on read or write' do
+      allow(ActiveRecord::Base).to receive(:postgresql_connection).and_raise(StandardError.new('could not connect to server: Connection refused'))
 
-        ActiveRecord::Base.establish_connection(config)
-        expect { connection.execute('SELECT * FROM users') }.to raise_error(Makara::Errors::NoConnectionsAvailable)
-        expect { connection.execute('INSERT INTO users (name) VALUES (\'John\')') }.to raise_error(Makara::Errors::NoConnectionsAvailable)
-      end
+      ActiveRecord::Base.establish_connection(config)
+      expect { connection.execute('SELECT * FROM users') }.to raise_error(Makara::Errors::NoConnectionsAvailable)
+      expect { connection.execute('INSERT INTO users (name) VALUES (\'John\')') }.to raise_error(Makara::Errors::NoConnectionsAvailable)
     end
+  end
 
-    context 'with only master connection' do
-      it 'should not raise errors on read and write' do
-        custom_config = config.deep_dup
-        custom_config['makara']['connections'].select{|h| h['role'] == 'slave' }.each{|h| h['port'] = '1'}
+  context 'with only master connection' do
+    it 'should not raise errors on read and write' do
+      custom_config = config.deep_dup
+      custom_config['makara']['connections'].select{|h| h['role'] == 'slave' }.each{|h| h['port'] = '1'}
 
-        ActiveRecord::Base.establish_connection(custom_config)
-        load(File.dirname(__FILE__) + '/../../support/schema.rb')
+      ActiveRecord::Base.establish_connection(custom_config)
+      load(File.dirname(__FILE__) + '/../../support/schema.rb')
 
-        connection.execute('SELECT * FROM users')
-        connection.execute('INSERT INTO users (name) VALUES (\'John\')')
-      end
+      connection.execute('SELECT * FROM users')
+      connection.execute('INSERT INTO users (name) VALUES (\'John\')')
+    end
+  end
+
+  context 'with only slave connection' do
+    it 'should raise error only on write' do
+      ActiveRecord::Base.establish_connection(config)
+      load(File.dirname(__FILE__) + '/../../support/schema.rb')
+      ActiveRecord::Base.clear_all_connections!
+
+      custom_config = config.deep_dup
+      custom_config['makara']['connections'].select{|h| h['role'] == 'master' }.each{|h| h['port'] = '1'}
+
+      ActiveRecord::Base.establish_connection(custom_config)
+
+      connection.execute('SELECT * FROM users')
+      expect { connection.execute('INSERT INTO users (name) VALUES (\'John\')') }.to raise_error(Makara::Errors::NoConnectionsAvailable)
     end
+  end
 
-    context 'with only slave connection' do
-      it 'should raise error only on write' do
+  describe 'transaction support' do
+    shared_examples 'a transaction supporter' do
+      before do
         ActiveRecord::Base.establish_connection(config)
         load(File.dirname(__FILE__) + '/../../support/schema.rb')
-        ActiveRecord::Base.clear_all_connections!
+        change_context
+
+        # Pre-loads the attributes so that schema queries don't hit slave
+        # user = User.create(name: 'hello')
+        connection.slave_pool.connections.each do |slave|
+          # Using method missing to help with back trace, literally
+          # no query should be executed on slave once a transaction is opened
+          expect(slave).to receive(:method_missing).never
+          expect(slave).to receive(:execute).never
+        end
+      end
+
+      context 'when querying through a polymorphic relation' do
+        it 'should respect the transaction' do
+          ActiveRecord::Base.transaction do
+            connection.execute("INSERT INTO users (name) VALUES ('John')")
+            connection.execute('SELECT * FROM users')
+          end
+        end
+      end
 
-        custom_config = config.deep_dup
-        custom_config['makara']['connections'].select{|h| h['role'] == 'master' }.each{|h| h['port'] = '1'}
+      context 'when querying an aggregate' do
+        it 'should respect the transaction' do
+          ActiveRecord::Base.transaction { connection.execute('SELECT COUNT(*) FROM users') }
+        end
+      end
 
-        ActiveRecord::Base.establish_connection(custom_config)
+      context 'when querying for a specific record' do
+        it 'should respect the transaction' do
+          ActiveRecord::Base.transaction { connection.execute('SELECT * FROM users WHERE id = 1') }
+        end
+      end
 
-        connection.execute('SELECT * FROM users')
-        expect { connection.execute('INSERT INTO users (name) VALUES (\'John\')') }.to raise_error(Makara::Errors::NoConnectionsAvailable)
+      context 'when executing a query' do
+        it 'should respect the transaction' do
+          ActiveRecord::Base.transaction { connection.execute('SELECT 1') }
+        end
       end
     end
+
+    context 'when sticky is true' do
+      before { config['makara']['sticky'] = true }
+
+      it_behaves_like 'a transaction supporter'
+    end
+
+    context 'when sticky is false' do
+      before { config['makara']['sticky'] = false }
+
+      it_behaves_like 'a transaction supporter'
+    end
+  end
 end

data/spec/config_parser_spec.rb

@@ -88,15 +88,73 @@ describe Makara::ConfigParser do
     expect(parsera.id).to eq(parserc.id)
   end
 
-  it 'should provide master and slave configs' do
-    parser = described_class.new(config)
-    expect(parser.master_configs).to eq([
-      {:name => 'themaster', :top_level => 'value', :blacklist_duration => 30, :master_ttl => 5, :sticky => true}
-    ])
-    expect(parser.slave_configs).to eq([
-      {:name => 'slave1', :top_level => 'value', :blacklist_duration => 30, :master_ttl => 5, :sticky => true},
-      {:name => 'slave2', :top_level => 'value', :blacklist_duration => 30, :master_ttl => 5, :sticky => true}
-    ])
-  end
+  context 'master and slave configs' do
+    it 'should provide master and slave configs' do
+      parser = described_class.new(config)
+      expect(parser.master_configs).to eq([
+        {
+          :name => 'themaster',
+          :top_level => 'value',
+          :sticky => true,
+          :blacklist_duration => 30,
+          :master_ttl => 5,
+          :sticky => true
+        }
+      ])
+      expect(parser.slave_configs).to eq([
+        {
+          :name => 'slave1',
+          :top_level => 'value',
+          :sticky => true,
+          :blacklist_duration => 30,
+          :master_ttl => 5,
+          :sticky => true
+        },
+        {
+          :name => 'slave2',
+          :top_level => 'value',
+          :sticky => true,
+          :blacklist_duration => 30,
+          :master_ttl => 5,
+          :sticky => true
+        }
+      ])
+    end
+
+    it 'connection configuration should override makara config' do
+      config[:makara][:blacklist_duration] = 123
+      config[:makara][:connections][0][:blacklist_duration] = 456
+      config[:makara][:connections][1][:top_level] = 'slave value'
 
+      parser = described_class.new(config)
+      expect(parser.master_configs).to eq([
+        {
+          :name => 'themaster',
+          :top_level => 'value',
+          :sticky => true,
+          :blacklist_duration => 456,
+          :master_ttl => 5,
+          :sticky => true
+        }
+      ])
+      expect(parser.slave_configs).to eq([
+        {
+          :name => 'slave1',
+          :top_level => 'slave value',
+          :sticky => true,
+          :blacklist_duration => 123,
+          :master_ttl => 5,
+          :sticky => true
+        },
+        {
+          :name => 'slave2',
+          :top_level => 'value',
+          :sticky => true,
+          :blacklist_duration => 123,
+          :master_ttl => 5,
+          :sticky => true
+        }
+      ])
+    end
+  end
 end

data/spec/proxy_spec.rb

@@ -81,15 +81,29 @@ describe Makara::Proxy do
     end
 
     it 'should not stick to master if we are in a without_sticking block' do
+      expect(proxy.master_for?('insert into users values (a,b,c)')).to eq(true)
+
       proxy.without_sticking do
         expect(proxy.master_for?('insert into users values (a,b,c)')).to eq(true)
         expect(proxy.master_for?('select * from users')).to eq(false)
       end
 
+      expect(proxy.master_for?('select * from users')).to eq(true)
       expect(proxy.master_for?('insert into users values (a,b,c)')).to eq(true)
       expect(proxy.master_for?('select * from users')).to eq(true)
     end
 
+    it 'should not stick to master after without_sticking block if there is a write in it' do
+      expect(proxy.master_for?('select * from users')).to eq(false)
+
+      proxy.without_sticking do
+        expect(proxy.master_for?('insert into users values (a,b,c)')).to eq(true)
+        expect(proxy.master_for?('select * from users')).to eq(false)
+      end
+
+      expect(proxy.master_for?('select * from users')).to eq(false)
+    end
+
     # if the context changes we should still use master until the previous context is no longer relevant
     it 'should release master if the context changes and enough time passes' do
       expect(proxy.master_for?('insert into users values (a,b,c)')).to eq(true)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: makara
 version: !ruby/object:Gem::Version
-  version: 0.3.6
+  version: 0.3.7
 platform: ruby
 authors:
 - Mike Nelson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-21 00:00:00.000000000 Z
+date: 2016-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord