makara 0.3.5

data/spec/proxy_spec.rb

@@ -0,0 +1,182 @@
+require 'spec_helper'
+
+describe Makara::Proxy do
+
+  let(:klass){ FakeProxy }
+
+
+  it 'sets up a master and slave pool no matter the number of connections' do
+    proxy = klass.new(config(0, 0))
+    expect(proxy.master_pool).to be_a(Makara::Pool)
+    expect(proxy.slave_pool).to be_a(Makara::Pool)
+
+    proxy = klass.new(config(2, 0))
+    expect(proxy.master_pool).to be_a(Makara::Pool)
+    expect(proxy.slave_pool).to be_a(Makara::Pool)
+
+    proxy = klass.new(config(0, 2))
+    expect(proxy.master_pool).to be_a(Makara::Pool)
+    expect(proxy.slave_pool).to be_a(Makara::Pool)
+
+    proxy = klass.new(config(2, 2))
+    expect(proxy.master_pool).to be_a(Makara::Pool)
+    expect(proxy.slave_pool).to be_a(Makara::Pool)
+  end
+
+
+  it 'instantiates N connections within each pool' do
+    proxy = klass.new(config(1, 2))
+
+    expect(proxy.master_pool.connection_count).to eq(1)
+    expect(proxy.slave_pool.connection_count).to eq(2)
+  end
+
+  it 'should delegate any unknown method to a connection in the master pool' do
+    proxy = klass.new(config(1, 2))
+
+    con = proxy.master_pool.connections.first
+    allow(con).to receive(:irespondtothis){ 'hello!' }
+
+    expect(proxy).to respond_to(:irespondtothis)
+    expect(proxy.irespondtothis).to eq('hello!')
+  end
+
+  it 'should use master if manually forced' do
+    proxy = klass.new(config(1, 2))
+
+    expect(proxy.master_for?('select * from users')).to eq(false)
+
+    proxy.stick_to_master!
+
+    expect(proxy.master_for?('select * from users')).to eq(true)
+  end
+
+
+  context '#appropriate_pool' do
+
+    let(:proxy){ klass.new(config(1,1)) }
+
+    it 'should be sticky by default' do
+      expect(proxy.sticky).to eq(true)
+    end
+
+    it 'should provide the slave pool for a read' do
+      expect(proxy.master_for?('select * from users')).to eq(false)
+    end
+
+    it 'should provide the master pool for a write' do
+      expect(proxy.master_for?('insert into users values (a,b,c)')).to eq(true)
+    end
+
+    # master is used, it should continue being used for the duration of the context
+    it 'should stick to master once used for a sticky operation' do
+      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 if stickiness is disabled' do
+      proxy.sticky = false
+      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
+
+    it 'should not stick to master if we are in a without_sticking block' do
+      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?('insert into users values (a,b,c)')).to eq(true)
+      expect(proxy.master_for?('select * from users')).to eq(true)
+    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)
+      expect(proxy.master_for?('select * from users')).to eq(true)
+
+      change_context
+
+      Timecop.travel Time.now + 10 do
+        expect(proxy.master_for?('select * from users')).to eq(false)
+      end
+    end
+
+    it 'should not release master if the previous context is still relevant' do
+      expect(proxy.master_for?('insert into users values (a,b,c)')).to eq(true)
+      expect(proxy.master_for?('select * from users')).to eq(true)
+
+      roll_context
+
+      proxy.master_for?('select * from users')
+      expect(proxy.master_for?('select * from users')).to eq(true)
+
+      Timecop.travel Time.now + 10 do
+        # cache is expired but context has not changed
+        expect(proxy.master_for?('select * from users')).to eq(true)
+
+        roll_context
+
+        expect(proxy.master_for?('select * from users')).to eq(false)
+      end
+    end
+
+    it 'should release master if context changes enough' do
+      expect(proxy.master_for?('insert into users values (a,b,c)')).to eq(true)
+      roll_context
+      roll_context
+      expect(proxy.master_for?('select * from users')).to eq(false)
+    end
+
+    it 'should use master if all slaves are blacklisted' do
+      allow(proxy.slave_pool).to receive(:completely_blacklisted?){ true }
+      expect(proxy.master_for?('select * from users')).to eq(true)
+    end
+
+    it 'should use master if all slaves become blacklisted as part of the invocation' do
+      allow(proxy.slave_pool).to receive(:next).and_return(nil)
+
+      test = double
+      expect(test).to receive(:blacklisting).once
+      expect(test).to receive(:using_master).once
+
+      proxy.send(:appropriate_pool, :execute, ['select * from users']) do |pool|
+        if pool == proxy.slave_pool
+          test.blacklisting
+          pool.instance_variable_get('@blacklist_errors') << StandardError.new('some connection issue')
+          pool.connections.each(&:_makara_blacklist!)
+          pool.provide
+        else
+          test.using_master
+        end
+      end
+    end
+
+    it 'should raise the error and whitelist all connections if everything is blacklisted (start over)' do
+      proxy.ping
+
+      # weird setup to allow for the correct
+      proxy.slave_pool.connections.each(&:_makara_blacklist!)
+      proxy.slave_pool.instance_variable_get('@blacklist_errors') << StandardError.new('some slave connection issue')
+      proxy.master_pool.connections.each(&:_makara_blacklist!)
+      proxy.master_pool.instance_variable_get('@blacklist_errors') << StandardError.new('some master connection issue')
+
+      allow(proxy).to receive(:_appropriate_pool).and_return(proxy.slave_pool, proxy.master_pool)
+
+      begin
+        proxy.send(:appropriate_pool, :execute, ['select * from users']) do |pool|
+          pool.provide{|c| c }
+        end
+      rescue Makara::Errors::AllConnectionsBlacklisted => e
+        expect(e.message).to eq('[Makara/master] All connections are blacklisted -> some master connection issue -> [Makara/slave] All connections are blacklisted -> some slave connection issue')
+      end
+
+      proxy.slave_pool.connections.each{|con| expect(con._makara_blacklisted?).to eq(false) }
+      proxy.master_pool.connections.each{|con| expect(con._makara_blacklisted?).to eq(false) }
+    end
+
+  end
+
+
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,46 @@
+require 'active_record'
+require 'makara'
+require 'timecop'
+require 'yaml'
+
+begin
+  require 'byebug'
+rescue LoadError
+end
+
+begin
+  require 'ruby-debug'
+rescue LoadError
+end
+
+RSpec.configure do |config|
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  config.order = 'random'
+
+  require "#{File.dirname(__FILE__)}/support/proxy_extensions"
+  require "#{File.dirname(__FILE__)}/support/pool_extensions"
+  require "#{File.dirname(__FILE__)}/support/configurator"
+  require "#{File.dirname(__FILE__)}/support/mock_objects"
+  require "#{File.dirname(__FILE__)}/support/deep_dup"
+
+  config.include Configurator
+
+  config.before :each do
+    Makara::Cache.store = :memory
+    change_context
+    allow_any_instance_of(Makara::Pool).to receive(:should_shuffle?){ false }
+  end
+
+  def change_context
+    Makara::Context.set_previous nil
+    Makara::Context.set_current nil
+  end
+
+  def roll_context
+    Makara::Context.set_previous Makara::Context.get_current
+    Makara::Context.set_current Makara::Context.generate
+  end
+
+end

data/spec/support/configurator.rb

@@ -0,0 +1,13 @@
+module Configurator
+  def config(masters = 1, slaves = 2)
+    connections = []
+    masters.times{ connections << {:role => 'master'} }
+    slaves.times{ connections << {:role => 'slave'} }
+    {
+      :makara => {
+        :blacklist_duration => 30,
+        :connections => connections
+      }
+    }
+  end
+end

data/spec/support/deep_dup.rb

@@ -0,0 +1,12 @@
+unless Hash.respond_to?(:deep_dup)
+  class Hash
+    def deep_dup
+      duplicate = self.dup
+      duplicate.each_pair do |k,v|
+        tv = duplicate[k]
+        duplicate[k] = tv.is_a?(Hash) && v.is_a?(Hash) ? tv.deep_dup : v
+      end
+      duplicate
+    end
+  end
+end

data/spec/support/mock_objects.rb

@@ -0,0 +1,67 @@
+require 'active_record/connection_adapters/makara_abstract_adapter'
+
+class FakeConnection < Struct.new(:config)
+
+  attr_accessor :something
+
+  def ping
+    'ping!'
+  end
+
+  def irespondtothis
+    'hey!'
+  end
+
+  def query(content)
+    []
+  end
+
+  def active?
+    true
+  end
+
+  def disconnect!
+    true
+  end
+end
+
+class FakeDatabaseAdapter < Struct.new(:config)
+
+  def execute(sql, name = nil)
+    []
+  end
+
+  def exec_query(sql, name = 'SQL', binds = [])
+    []
+  end
+
+  def select_rows(sql, name = nil)
+    []
+  end
+
+  def active?
+    true
+  end
+
+end
+
+class FakeProxy < Makara::Proxy
+
+  send_to_all :ping
+  hijack_method :execute
+
+  def connection_for(config)
+    FakeConnection.new(config)
+  end
+
+  def needs_master?(method_name, args)
+    return false if args.first =~ /^select/
+    true
+  end
+end
+
+class FakeAdapter < ::ActiveRecord::ConnectionAdapters::MakaraAbstractAdapter
+  def connection_for(config)
+    FakeDatabaseAdapter.new(config)
+  end
+end

data/spec/support/mysql2_database.yml

@@ -0,0 +1,17 @@
+test:
+  adapter: 'mysql2_makara'
+  database: 'makara_test'
+  username: 'root'
+  password: ''
+
+  connect_timeout: 1
+  read_timeout: 1
+  write_timeout: 2
+
+  makara:
+    blacklist_duration: 2
+    master_ttl: 5
+    connections:
+      - role: master
+      - role: slave
+      - role: slave

data/spec/support/mysql2_database_with_custom_errors.yml

@@ -0,0 +1,17 @@
+test:
+  adapter: 'mysql2_makara'
+  database: 'makara_test'
+  username: 'root'
+  password: ''
+
+  makara:
+    blacklist_duration: 2
+    master_ttl: 5
+    connections:
+      - role: master
+      - role: slave
+      - role: slave
+    connection_error_matchers:
+      - !ruby/regexp '/^ActiveRecord::StatementInvalid: Mysql2::Error: Unknown command1:/'
+      - "/^ActiveRecord::StatementInvalid: Mysql2::Error: Unknown command2:/i"
+      - "ActiveRecord::StatementInvalid: Mysql2::Error: Unknown command3:"

data/spec/support/pool_extensions.rb

@@ -0,0 +1,14 @@
+module PoolExtensions
+
+  def connections
+    @connections
+  end
+
+  def connection_count
+    @connections.length
+  end
+
+end
+
+
+Makara::Pool.send(:include, PoolExtensions)

data/spec/support/postgresql_database.yml

@@ -0,0 +1,13 @@
+test:
+  adapter: 'postgresql_makara'
+  database: 'makara_test'
+  username: 'root'
+  password: ''
+
+  makara:
+    blacklist_duration: 2
+    master_ttl: 5
+    connections:
+      - role: master
+      - role: slave
+      - role: slave

data/spec/support/proxy_extensions.rb

@@ -0,0 +1,33 @@
+module ProxyExtensions
+
+  attr_reader :master_pool, :slave_pool, :master_context, :id
+  
+  def master_for?(sql)
+    pool_for(sql) == master_pool
+  end
+
+  def would_stick?(sql)
+    should_stick?(:execute, [sql])
+  end
+
+  def connection_for(sql)
+    pool_for(sql) do |pool|
+      pool.provide do |connection|
+        connection
+      end
+    end
+  end
+
+  def pool_for(sql)
+    appropriate_pool(:execute, [sql]) do |pool|
+      pool
+    end
+  end
+
+  def sticky=(s)
+    @sticky = s
+  end
+
+end
+
+Makara::Proxy.send(:include, ProxyExtensions)

data/spec/support/schema.rb

@@ -0,0 +1,7 @@
+ActiveRecord::Schema.define(:version => 20130628161227) do
+
+  create_table "users", :force => true do |t|
+    t.string   "name"
+  end
+
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: makara
+version: !ruby/object:Gem::Version
+  version: 0.3.5
+platform: ruby
+authors:
+- Mike Nelson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: Read-write split your DB yo
+email:
+- mike@mikeonrails.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- gemfiles/ar30.gemfile
+- gemfiles/ar31.gemfile
+- gemfiles/ar32.gemfile
+- gemfiles/ar40.gemfile
+- gemfiles/ar41.gemfile
+- gemfiles/ar42.gemfile
+- lib/active_record/connection_adapters/jdbcmysql_makara_adapter.rb
+- lib/active_record/connection_adapters/jdbcpostgresql_makara_adapter.rb
+- lib/active_record/connection_adapters/makara_abstract_adapter.rb
+- lib/active_record/connection_adapters/makara_jdbcmysql_adapter.rb
+- lib/active_record/connection_adapters/makara_jdbcpostgresql_adapter.rb
+- lib/active_record/connection_adapters/makara_mysql2_adapter.rb
+- lib/active_record/connection_adapters/makara_postgresql_adapter.rb
+- lib/active_record/connection_adapters/mysql2_makara_adapter.rb
+- lib/active_record/connection_adapters/postgresql_makara_adapter.rb
+- lib/makara.rb
+- lib/makara/cache.rb
+- lib/makara/cache/memory_store.rb
+- lib/makara/cache/noop_store.rb
+- lib/makara/config_parser.rb
+- lib/makara/connection_wrapper.rb
+- lib/makara/context.rb
+- lib/makara/error_handler.rb
+- lib/makara/errors/all_connections_blacklisted.rb
+- lib/makara/errors/blacklist_connection.rb
+- lib/makara/errors/no_connections_available.rb
+- lib/makara/logging/logger.rb
+- lib/makara/logging/subscriber.rb
+- lib/makara/middleware.rb
+- lib/makara/pool.rb
+- lib/makara/proxy.rb
+- lib/makara/railtie.rb
+- lib/makara/version.rb
+- makara.gemspec
+- spec/active_record/connection_adapters/makara_abstract_adapter_error_handling_spec.rb
+- spec/active_record/connection_adapters/makara_abstract_adapter_spec.rb
+- spec/active_record/connection_adapters/makara_mysql2_adapter_spec.rb
+- spec/active_record/connection_adapters/makara_postgresql_adapter_spec.rb
+- spec/cache_spec.rb
+- spec/config_parser_spec.rb
+- spec/connection_wrapper_spec.rb
+- spec/context_spec.rb
+- spec/middleware_spec.rb
+- spec/pool_spec.rb
+- spec/proxy_spec.rb
+- spec/spec_helper.rb
+- spec/support/configurator.rb
+- spec/support/deep_dup.rb
+- spec/support/mock_objects.rb
+- spec/support/mysql2_database.yml
+- spec/support/mysql2_database_with_custom_errors.yml
+- spec/support/pool_extensions.rb
+- spec/support/postgresql_database.yml
+- spec/support/proxy_extensions.rb
+- spec/support/schema.rb
+homepage: ''
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.1
+signing_key: 
+specification_version: 4
+summary: Read-write split your DB yo
+test_files:
+- spec/active_record/connection_adapters/makara_abstract_adapter_error_handling_spec.rb
+- spec/active_record/connection_adapters/makara_abstract_adapter_spec.rb
+- spec/active_record/connection_adapters/makara_mysql2_adapter_spec.rb
+- spec/active_record/connection_adapters/makara_postgresql_adapter_spec.rb
+- spec/cache_spec.rb
+- spec/config_parser_spec.rb
+- spec/connection_wrapper_spec.rb
+- spec/context_spec.rb
+- spec/middleware_spec.rb
+- spec/pool_spec.rb
+- spec/proxy_spec.rb
+- spec/spec_helper.rb
+- spec/support/configurator.rb
+- spec/support/deep_dup.rb
+- spec/support/mock_objects.rb
+- spec/support/mysql2_database.yml
+- spec/support/mysql2_database_with_custom_errors.yml
+- spec/support/pool_extensions.rb
+- spec/support/postgresql_database.yml
+- spec/support/proxy_extensions.rb
+- spec/support/schema.rb
+has_rdoc: