makara 0.3.9 → 0.5.1

data/spec/active_record/connection_adapters/makara_abstract_adapter_error_handling_spec.rb

@@ -2,7 +2,6 @@ require 'spec_helper'
 require 'active_record/connection_adapters/makara_abstract_adapter'
 
 describe ActiveRecord::ConnectionAdapters::MakaraAbstractAdapter::ErrorHandler do
-
   let(:handler){ described_class.new }
   let(:proxy) { FakeAdapter.new(config(1,1)) }
   let(:connection){ proxy.master_pool.connections.first }
@@ -60,9 +59,8 @@ describe ActiveRecord::ConnectionAdapters::MakaraAbstractAdapter::ErrorHandler d
   end
 
   describe 'custom errors' do
-
     let(:config_path) { File.join(File.expand_path('../../../', __FILE__), 'support', 'mysql2_database_with_custom_errors.yml') }
-    let(:config) { YAML.load_file(config_path)['test'] }
+    let(:config) { YAML.load(ERB.new(File.read(config_path)).result)['test'] }
     let(:handler){ described_class.new }
     let(:proxy) { FakeAdapter.new(config) }
     let(:connection){ proxy.master_pool.connections.first }
@@ -85,8 +83,5 @@ describe ActiveRecord::ConnectionAdapters::MakaraAbstractAdapter::ErrorHandler d
         end
       }.to raise_error(Makara::Errors::BlacklistConnection)
     end
-
   end
-
-
 end

data/spec/active_record/connection_adapters/makara_abstract_adapter_spec.rb

@@ -2,7 +2,6 @@ require 'spec_helper'
 require 'active_record/connection_adapters/makara_abstract_adapter'
 
 describe ActiveRecord::ConnectionAdapters::MakaraAbstractAdapter do
-
   let(:klass){ FakeAdapter }
 
   {
@@ -27,17 +26,23 @@ describe ActiveRecord::ConnectionAdapters::MakaraAbstractAdapter do
     '    select * from users for update' => true,
     'select * from users lock in share mode' => true,
     'select * from users where name = "for update"' => false,
-    'select * from users where name = "lock in share mode"' => false
+    'select * from users where name = "lock in share mode"' => false,
+    'select nextval(\'users_id_seq\')' => true,
+    'select currval(\'users_id_seq\')' => true,
+    'select lastval()' => true,
+    'with fence as (select * from users) select * from fence' => false,
+    'with fence as (select * from felines) insert to cats' => true,
+    'select get_lock(\'foo\', 0)' => true,
+    'select release_lock(\'foo\')' => true,
+    'select pg_advisory_lock(12345)' => true,
+    'select pg_advisory_unlock(12345)' => true
   }.each do |sql, should_go_to_master|
-
     it "determines that \"#{sql}\" #{should_go_to_master ? 'requires' : 'does not require'} master" do
       proxy = klass.new(config(1,1))
       expect(proxy.master_for?(sql)).to eq(should_go_to_master)
     end
-
   end
 
-
   {
     "SET @@things" => true,
     "INSERT INTO wisdom ('The truth will set you free.')" => false,
@@ -52,7 +57,6 @@ describe ActiveRecord::ConnectionAdapters::MakaraAbstractAdapter do
         max_treats IS NULL
     } => false
   }.each do |sql, should_send_to_all_connections|
-
     it "determines that \"#{sql}\" #{should_send_to_all_connections ? 'should' : 'should not'} be sent to all underlying connections" do
       proxy = klass.new(config(1,1))
       proxy.master_pool.connections.each{|con| expect(con).to receive(:execute).with(sql).once}
@@ -65,12 +69,7 @@ describe ActiveRecord::ConnectionAdapters::MakaraAbstractAdapter do
       end
 
       proxy.execute(sql)
-
-      if should_send_to_all_connections
-        expect(proxy.master_context).to be_nil
-      end
     end
-
   end
 
   {
@@ -103,12 +102,9 @@ describe ActiveRecord::ConnectionAdapters::MakaraAbstractAdapter do
         max_treats IS NULL
     } => true
   }.each do |sql,should_stick|
-
     it "should #{should_stick ? 'stick' : 'not stick'} to master if handling sql like \"#{sql}\"" do
       proxy = klass.new(config(0,0))
       expect(proxy.would_stick?(sql)).to eq(should_stick)
     end
-
   end
-
 end

data/spec/active_record/connection_adapters/makara_mysql2_adapter_spec.rb

@@ -2,12 +2,10 @@ require 'spec_helper'
 require 'active_record/connection_adapters/mysql2_adapter'
 
 describe 'MakaraMysql2Adapter' do
-
-  let(:db_username){ ENV['TRAVIS'] ? 'travis' : 'root' }
-
   let(:config){
-    base = YAML.load_file(File.expand_path('spec/support/mysql2_database.yml'))['test']
-    base
+    file = File.expand_path('spec/support/mysql2_database.yml')
+    hash = YAML.load(ERB.new(File.read(file)).result)
+    hash['test']
   }
 
   let(:connection) { ActiveRecord::Base.connection }
@@ -18,7 +16,6 @@ describe 'MakaraMysql2Adapter' do
   end
 
   context "unconnected" do
-
     it 'should allow a connection to be established' do
       establish_connection(config)
       expect(ActiveRecord::Base.connection).to be_instance_of(ActiveRecord::ConnectionAdapters::MakaraMysql2Adapter)
@@ -56,7 +53,6 @@ describe 'MakaraMysql2Adapter' do
       expect{
         connection.execute('SET @t1 = 1')
       }.to raise_error(Makara::Errors::NoConnectionsAvailable)
-
     end
 
     context "unconnect afterwards" do
@@ -82,10 +78,9 @@ describe 'MakaraMysql2Adapter' do
         ActiveRecord::Base.connection
 
         load(File.dirname(__FILE__) + '/../../support/schema.rb')
-        Makara::Context.set_current Makara::Context.generate
+        change_context
 
-        allow(ActiveRecord::Base).to receive(:mysql2_connection) do |config|
-          config[:username] = db_username
+        allow(ActiveRecord::Base).to receive(:mysql2_connection) do
           original_method.call(config)
         end
 
@@ -102,18 +97,15 @@ describe 'MakaraMysql2Adapter' do
         ActiveRecord::Base.remove_connection
       end
     end
-
   end
 
   context 'with the connection established and schema loaded' do
-
     before do
       establish_connection(config)
       load(File.dirname(__FILE__) + '/../../support/schema.rb')
       change_context
     end
 
-
     it 'should have one master and two slaves' do
       expect(connection.master_pool.connection_count).to eq(1)
       expect(connection.slave_pool.connection_count).to eq(2)
@@ -150,7 +142,7 @@ describe 'MakaraMysql2Adapter' do
 
     it 'should send reads to the slave' do
       # ensure the next connection will be the first one
-      connection.slave_pool.strategy.instance_variable_set('@current_idx', connection.slave_pool.connections.length)
+      allow_any_instance_of(Makara::Strategies::RoundRobin).to receive(:single_one?){ true }
 
       con = connection.slave_pool.connections.first
       expect(con).to receive(:execute).with('SELECT * FROM users').once
@@ -158,6 +150,18 @@ describe 'MakaraMysql2Adapter' do
       connection.execute('SELECT * FROM users')
     end
 
+    it 'should send exists? to slave' do
+      allow_any_instance_of(Makara::Strategies::RoundRobin).to receive(:single_one?){ true }
+      Test::User.exists? # flush other (schema) things that need to happen
+
+      con = connection.slave_pool.connections.first
+      expect(con).to receive(:exec_query) do |query|
+        expect(query).to match(/SELECT\s+1\s*(AS one)?\s+FROM .?users.?\s+LIMIT\s+.?1/)
+      end.once.and_call_original
+
+      Test::User.exists?
+    end
+
     it 'should send writes to master' do
       con = connection.master_pool.connections.first
       expect(con).to receive(:execute).with('UPDATE users SET name = "bob" WHERE id = 1')
@@ -183,7 +187,6 @@ describe 'MakaraMysql2Adapter' do
         }.to raise_error(Makara::Errors::AllConnectionsBlacklisted)
       end
     end
-
   end
 
   describe 'transaction support' do
@@ -241,5 +244,4 @@ describe 'MakaraMysql2Adapter' do
       it_behaves_like 'a transaction supporter'
     end
   end
-
 end

data/spec/active_record/connection_adapters/makara_postgis_adapter_spec.rb

@@ -1,5 +1,9 @@
 # RGeo doesn't play well with JRuby and to avoid complicated test setup
 # we're only testing ActiveRecord version ~> 4.2
+
+require 'active_record'
+
+# TODO: test this in AR 5+ ?
 if RUBY_ENGINE == 'ruby' &&
     ActiveRecord::VERSION::MAJOR == 4 &&
     ActiveRecord::VERSION::MINOR >= 2
@@ -10,12 +14,8 @@ if RUBY_ENGINE == 'ruby' &&
   require 'active_record/connection_adapters/postgis_adapter'
 
   describe 'MakaraPostgisAdapter' do
-    let(:db_username){ ENV['TRAVIS'] ? 'postgres' : `whoami`.chomp }
-
     let(:config) do
-      base = YAML.load_file(File.expand_path('spec/support/postgis_database.yml'))['test']
-      base['username'] = db_username
-      base
+      YAML.load_file(File.expand_path('spec/support/postgis_database.yml'))['test']
     end
 
     let(:connection) { ActiveRecord::Base.connection }
@@ -83,10 +83,7 @@ if RUBY_ENGINE == 'ruby' &&
 
       it 'should send reads to the slave' do
         # ensure the next connection will be the first one
-        connection.slave_pool
-                  .strategy
-                  .instance_variable_set('@current_idx',
-                                         connection.slave_pool.connections.length)
+        allow_any_instance_of(Makara::Strategies::RoundRobin).to receive(:single_one?){ true }
 
         con = connection.slave_pool.connections.first
         expect(con).to receive(:execute).with('SELECT * FROM users').once

data/spec/active_record/connection_adapters/makara_postgresql_adapter_spec.rb

@@ -1,14 +1,10 @@
 require 'spec_helper'
 require 'active_record/connection_adapters/postgresql_adapter'
+require 'active_record/errors'
 
 describe 'MakaraPostgreSQLAdapter' do
-
-  let(:db_username){ ENV['TRAVIS'] ? 'postgres' : `whoami`.chomp }
-
   let(:config) do
-    base = YAML.load_file(File.expand_path('spec/support/postgresql_database.yml'))['test']
-    base['username'] = db_username
-    base
+    YAML.load_file(File.expand_path('spec/support/postgresql_database.yml'))['test']
   end
 
   let(:connection) { ActiveRecord::Base.connection }
@@ -18,21 +14,18 @@ describe 'MakaraPostgreSQLAdapter' do
     change_context
   end
 
-
   it 'should allow a connection to be established' do
     establish_connection(config)
     expect(ActiveRecord::Base.connection).to be_instance_of(ActiveRecord::ConnectionAdapters::MakaraPostgreSQLAdapter)
   end
 
   context 'with the connection established and schema loaded' do
-
     before do
       establish_connection(config)
       load(File.dirname(__FILE__) + '/../../support/schema.rb')
       change_context
     end
 
-
     it 'should have one master and two slaves' do
       expect(connection.master_pool.connection_count).to eq(1)
       expect(connection.slave_pool.connection_count).to eq(2)
@@ -64,7 +57,7 @@ describe 'MakaraPostgreSQLAdapter' do
 
     it 'should send reads to the slave' do
       # ensure the next connection will be the first one
-      connection.slave_pool.strategy.instance_variable_set('@current_idx', connection.slave_pool.connections.length)
+      allow_any_instance_of(Makara::Strategies::RoundRobin).to receive(:single_one?){ true }
 
       con = connection.slave_pool.connections.first
       expect(con).to receive(:execute).with('SELECT * FROM users').once
@@ -72,6 +65,19 @@ describe 'MakaraPostgreSQLAdapter' do
       connection.execute('SELECT * FROM users')
     end
 
+    it 'should send exists? to slave' do
+      allow_any_instance_of(Makara::Strategies::RoundRobin).to receive(:single_one?){ true }
+      Test::User.exists? # flush other (schema) things that need to happen
+
+      con = connection.slave_pool.connections.first
+
+      expect(con).to receive(:exec_query) do |query|
+        expect(query).to match(/SELECT\s+1\s*(AS one)?\s+FROM .?users.?\s+LIMIT\s+.?1/)
+      end.once.and_call_original
+
+      Test::User.exists?
+    end
+
     it 'should send writes to master' do
       con = connection.master_pool.connections.first
       expect(con).to receive(:execute).with('UPDATE users SET name = "bob" WHERE id = 1')
@@ -175,4 +181,58 @@ describe 'MakaraPostgreSQLAdapter' do
       it_behaves_like 'a transaction supporter'
     end
   end
+
+  context 'with two activerecord connection pools' do
+    before :each do
+      class Model1 < ActiveRecord::Base
+      end
+
+      class Model2 < ActiveRecord::Base
+      end
+
+      Model1.establish_connection(config)
+      Model2.establish_connection(config)
+    end
+
+    it 'should not leak raw connection into activerecord pool' do
+      # checkout a connection from Model1 pool and remove from the pool
+      conn = Model1.connection_pool.checkout
+      Model1.connection_pool.remove(conn)
+
+      # assign the connection to Model2 pool
+      conn.pool=Model2.connection_pool
+
+      # now close the connection to return it back to the pool
+      conn.close
+
+      # checkout the connection and make sure it is still a makara proxy
+      expect(Model2.connection).to eq(conn)
+    end
+
+    it 'should be able to steal the connection from a different thread' do
+      conn = Model1.connection_pool.checkout
+      conn.steal!
+      expect(conn.owner).to eq(Thread.current)
+      # steal! is not thread safe. it should be done while holding connection pool's mutex
+      t = Thread.new { conn.steal! }
+      t.join
+      expect(conn.owner).to eq(t)
+    end
+
+    it 'should not be able to expire the connection from same thread' do
+      conn = Model2.connection_pool.checkout
+      # expire is not thread safe. it should be done while holding connection pool's mutex
+      expect {
+        t = Thread.new { conn.expire }
+        t.join
+      }.to raise_error(ActiveRecord::ActiveRecordError)
+    end
+
+    it 'should be able to checkin connection back into activerecord pool' do
+      conn = Model1.connection_pool.checkout
+      Model1.connection_pool.checkin(conn)
+      # checkout the connection again and make sure it is same connection
+      expect(Model1.connection).to eq(conn)
+    end
+  end
 end

data/spec/cache_spec.rb

@@ -1,59 +1,8 @@
 require 'spec_helper'
 
 describe Makara::Cache do
-
-  it 'should not require a store be set' do
-    described_class.store = nil
-
-    expect(
-      described_class.send(:store)
-    ).to be_nil
-
-    expect{
-      described_class.read('test')
-    }.not_to raise_error
-  end
-
-  it 'provides a few stores for testing purposes' do
-    described_class.store = :memory
-    described_class.write('test', 'value', 10)
-    expect(described_class.read('test')).to eq('value')
-
+  it 'shows a warning' do
+    expect(Makara::Logging::Logger).to receive(:log).with(/Setting the Makara::Cache\.store won't have any effects/, :warn)
     described_class.store = :noop
-    described_class.write('test', 'value', 10)
-    expect(described_class.read('test')).to be_nil
-  end
-
-
-  # this will be used in tests so we have to ensure this works as expected
-  context Makara::Cache::MemoryStore do
-
-    let(:store){ Makara::Cache::MemoryStore.new }
-    let(:data){ store.instance_variable_get('@data') }
-
-    it 'should read and write keys' do
-      expect(store.read('test')).to be_nil
-      store.write('test', 'value')
-      expect(store.read('test')).to eq('value')
-    end
-
-    it 'provides time based expiration' do
-      store.write('test', 'value', :expires_in => 5)
-      expect(store.read('test')).to eq('value')
-
-      Timecop.travel Time.now + 6 do
-        expect(store.read('test')).to be_nil
-      end
-    end
-
-    it 'cleans the data' do
-      store.write('test', 'value', :expires_in => -5)
-      expect(store.read('test')).to be_nil
-      expect(data).not_to have_key('test')
-    end
-
   end
-
-
-
 end

data/spec/config_parser_spec.rb

@@ -1,21 +1,20 @@
 require 'spec_helper'
 
 describe Makara::ConfigParser do
-
   let(:config){
     {
-      :top_level => 'value',
-      :makara => {
-        :connections => [
+      top_level: 'value',
+      makara: {
+        connections: [
           {
-            :role => 'master',
-            :name => 'themaster'
+            role: 'master',
+            name: 'themaster'
           },
           {
-            :name => 'slave1'
+            name: 'slave1'
           },
           {
-            :name => 'slave2'
+            name: 'slave2'
           }
         ]
       }
@@ -25,27 +24,27 @@ describe Makara::ConfigParser do
   context '::merge_and_resolve_default_url_config' do
     let(:config_without_url) do
       {
-        :master_ttl => 5,
-        :blacklist_duration => 30,
-        :sticky => true,
-        :adapter => 'mysql2_makara',
-        :encoding => 'utf8',
-        :host => 'localhost',
-        :database => 'db_name',
-        :username => 'db_username',
-        :password => 'db_password',
-        :port =>     3306
+        master_ttl: 5,
+        blacklist_duration: 30,
+        sticky: true,
+        adapter: 'mysql2_makara',
+        encoding: 'utf8',
+        host: 'localhost',
+        database: 'db_name',
+        username: 'db_username',
+        password: 'db_password',
+        port: 3306
       }
     end
 
     let(:config_with_url) do
       {
-        :master_ttl => 5,
-        :blacklist_duration => 30,
-        :sticky => true,
-        :adapter => 'mysql2_makara',
-        :encoding => 'utf8',
-        :url => 'mysql2://db_username:db_password@localhost:3306/db_name'
+        master_ttl: 5,
+        blacklist_duration: 30,
+        sticky: true,
+        adapter: 'mysql2_makara',
+        encoding: 'utf8',
+        url: 'mysql2://db_username:db_password@localhost:3306/db_name'
       }
     end
 
@@ -76,44 +75,63 @@ describe Makara::ConfigParser do
         ENV['DATABASE_URL'] = database_url
       end
     end
-
   end
 
-  it 'should provide an id based on the recursively sorted config' do
+  it 'should provide a default proxy id based on the recursively sorted config' do
     parsera = described_class.new(config)
-    parserb = described_class.new(config.merge(:other => 'value'))
+    parserb = described_class.new(config.merge(other: 'value'))
     parserc = described_class.new(config)
 
     expect(parsera.id).not_to eq(parserb.id)
     expect(parsera.id).to eq(parserc.id)
   end
 
+  it 'should use provided proxy id instead of default' do
+    config_with_custom_id = config.dup
+    config_with_custom_id[:makara][:id] = 'my_proxy'
+
+    parser = described_class.new(config_with_custom_id)
+
+    expect(parser.id).to eq('my_proxy')
+  end
+
+  it 'should replace reserved characters and show a warning for provided proxy ids' do
+    config_with_custom_id = config.dup
+    config_with_custom_id[:makara][:id] = "my|proxy|id:with:reserved:characters"
+    warning = "Proxy id 'my|proxy|id:with:reserved:characters' changed to 'myproxyidwithreservedcharacters'"
+    expect(Makara::Logging::Logger).to receive(:log).with(warning, :warn)
+
+    parser = described_class.new(config_with_custom_id)
+
+    expect(parser.id).to eq('myproxyidwithreservedcharacters')
+  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
+          name: 'themaster',
+          top_level: 'value',
+          sticky: true,
+          blacklist_duration: 30,
+          master_ttl: 5
         }
       ])
       expect(parser.slave_configs).to eq([
         {
-          :name => 'slave1',
-          :top_level => 'value',
-          :sticky => true,
-          :blacklist_duration => 30,
-          :master_ttl => 5
+          name: 'slave1',
+          top_level: 'value',
+          sticky: true,
+          blacklist_duration: 30,
+          master_ttl: 5
         },
         {
-          :name => 'slave2',
-          :top_level => 'value',
-          :sticky => true,
-          :blacklist_duration => 30,
-          :master_ttl => 5
+          name: 'slave2',
+          top_level: 'value',
+          sticky: true,
+          blacklist_duration: 30,
+          master_ttl: 5
         }
       ])
     end
@@ -126,27 +144,27 @@ describe Makara::ConfigParser do
       parser = described_class.new(config)
       expect(parser.master_configs).to eq([
         {
-          :name => 'themaster',
-          :top_level => 'value',
-          :sticky => true,
-          :blacklist_duration => 456,
-          :master_ttl => 5
+          name: 'themaster',
+          top_level: 'value',
+          sticky: true,
+          blacklist_duration: 456,
+          master_ttl: 5
         }
       ])
       expect(parser.slave_configs).to eq([
         {
-          :name => 'slave1',
-          :top_level => 'slave value',
-          :sticky => true,
-          :blacklist_duration => 123,
-          :master_ttl => 5
+          name: 'slave1',
+          top_level: 'slave value',
+          sticky: true,
+          blacklist_duration: 123,
+          master_ttl: 5
         },
         {
-          :name => 'slave2',
-          :top_level => 'value',
-          :sticky => true,
-          :blacklist_duration => 123,
-          :master_ttl => 5
+          name: 'slave2',
+          top_level: 'value',
+          sticky: true,
+          blacklist_duration: 123,
+          master_ttl: 5
         }
       ])
     end