ar-octopus 0.9.1 → 0.9.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b11a47088e651be24f08e79859ff992113aafa0d
-  data.tar.gz: 9a33b695f7736f5ea3fecf905442eb26743a1c1d
+  metadata.gz: 5bacaaae3374f747c5158b3cf929bc53bb6b37c0
+  data.tar.gz: acef7102fc1a7639b43e3425325a357a682b553d
 SHA512:
-  metadata.gz: 773b9c6d05403653ab26fc992daddfd9ac62d17e965ab0e980f8f052c450c8bde69951471993b03d56bac32c1015bcc42e7395876b91cc2df30a9a3892199778
-  data.tar.gz: f185670274cafadefa2c14390a32cd2e8dbeae2ca59059b0c07cd4f2f93d215c5eefa0ff29783281cc6ff761bc918f3f984dc6ef19b6eb84554dc9056b5370a1
+  metadata.gz: d574b68144683c9ab61ee42e390c579ce41ff4997584eb081277b43df22a2b8ae0c996de227a04cb8832fb2435309b7429d3b630225306a4ff9939f55b5074d5
+  data.tar.gz: a24042265c44af4c6fe61c0681eac8f4848d565bd2b7a454942a4ed62497249abc0fd79c2d949ea28ea8daa01c5b534996e50a051b009246a8f95e0a91a0d315

data/ar-octopus.gemspec

@@ -28,7 +28,7 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency 'appraisal', '>= 0.3.8'
   s.add_development_dependency 'mysql2', '~> 0.3.18'
-  s.add_development_dependency 'pg', '>= 0.11.0'
+  s.add_development_dependency 'pg', '~> 0.18'
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rspec', '>= 3'
   s.add_development_dependency 'rubocop'

data/lib/octopus.rb

@@ -94,6 +94,14 @@ module Octopus
     ActiveRecord::VERSION::MAJOR == 4
   end
 
+  def self.rails40?
+    rails4? && ActiveRecord::VERSION::MINOR == 0
+  end
+
+  def self.rails41_only?
+    rails4? && ActiveRecord::VERSION::MINOR == 1
+  end
+
   def self.rails41?
     rails4? && ActiveRecord::VERSION::MINOR >= 1
   end
@@ -110,6 +118,10 @@ module Octopus
     ActiveRecord::VERSION::MAJOR == 5 && ActiveRecord::VERSION::MINOR == 1
   end
 
+  def self.atleast_rails51?
+    ActiveRecord::VERSION::MAJOR > 5 || (ActiveRecord::VERSION::MAJOR == 5 && ActiveRecord::VERSION::MINOR >= 1)
+  end
+
   attr_writer :logger
 
   def self.logger
@@ -171,6 +183,7 @@ require 'octopus/shard_tracking/attribute'
 require 'octopus/shard_tracking/dynamic'
 
 require 'octopus/model'
+require 'octopus/result_patch'
 require 'octopus/migration'
 require 'octopus/association'
 require 'octopus/collection_association'

data/lib/octopus/association_shard_tracking.rb

@@ -27,7 +27,7 @@ module Octopus
         return unless ::Octopus.enabled?
         return if !self.class.connection.respond_to?(:current_shard) || !self.respond_to?(:current_shard)
 
-        if !record.current_shard.nil? && !current_shard.nil? && record.current_shard != current_shard
+        if !record.current_shard.nil? && !current_shard.nil? && record.current_shard.to_s != current_shard.to_s
           raise MismatchedShards.new(record, current_shard)
         end
 
@@ -45,17 +45,28 @@ module Octopus
     end
 
     def has_and_belongs_to_many(association_id, scope = nil, options = {}, &extension)
+      assign_octopus_opts(scope, options)
+      super
+    end
+
+    def default_octopus_opts(options)
+      options[:before_add] = [ :connection_on_association=, options[:before_add] ].compact.flatten
+      options[:before_remove] = [ :connection_on_association=, options[:before_remove] ].compact.flatten
+    end
+
+    def assign_octopus_opts(scope, options)
       if options == {} && scope.is_a?(Hash)
         default_octopus_opts(scope)
       else
         default_octopus_opts(options)
       end
-      super
     end
 
-    def default_octopus_opts(options)
-      options[:before_add] = [ :connection_on_association=, options[:before_add] ].compact.flatten
-      options[:before_remove] = [ :connection_on_association=, options[:before_remove] ].compact.flatten
+    if Octopus.atleast_rails51?
+      def has_and_belongs_to_many(association_id, scope = nil, **options, &extension)
+        assign_octopus_opts(scope, options)
+        super
+      end
     end
   end
 end

data/lib/octopus/migration.rb

@@ -77,6 +77,9 @@ module Octopus
 
           alias_method :run_without_octopus, :run
           alias_method :run, :run_with_octopus
+
+          alias_method :rollback_without_octopus, :rollback
+          alias_method :rollback, :rollback_with_octopus
         end
       end
 
@@ -145,6 +148,14 @@ module Octopus
         end
       end
 
+      def rollback_with_octopus(migrations_paths, steps = 1)
+        return rollback_without_octopus(migrations_paths, steps) unless connection.is_a?(Octopus::Proxy)
+
+        connection.send_queries_to_multiple_shards(connection.shard_names) do
+          rollback_without_octopus(migrations_paths, steps)
+        end
+      end
+
       private
 
       def connection

data/lib/octopus/model.rb

@@ -43,6 +43,25 @@ If you are trying to scope everything to a specific shard, use Octopus.using ins
         self.current_shard = shard if self.class.allowed_shard?(shard)
       end
 
+      def init_with(coder)
+        current_shard_value = if Octopus.rails40? || Octopus.rails41_only?
+          coder['attributes']['current_shard'] if coder['attributes']['current_shard'].present?
+        else
+          coder['attributes']['current_shard'].value if coder['attributes']['current_shard'].present? && coder['attributes']['current_shard'].value.present?
+        end
+
+        if Octopus.rails40? || Octopus.rails41_only?
+          coder['attributes'].delete('current_shard')
+        else
+          coder['attributes'].send(:attributes).send(:values).delete('current_shard')
+          coder['attributes'].send(:attributes).send(:delegate_hash).delete('current_shard')
+        end
+
+        obj = super
+        obj.current_shard = current_shard_value if current_shard_value.present?
+        obj
+      end
+
       def should_set_current_shard?
         self.respond_to?(:current_shard) && !current_shard.nil?
       end
@@ -86,9 +105,10 @@ If you are trying to scope everything to a specific shard, use Octopus.using ins
       end
 
       def hijack_methods
-        around_save :run_on_shard, :unless => lambda { self.class.custom_octopus_connection }
         after_initialize :set_current_shard
 
+        around_save :run_on_shard, :unless => lambda { self.class.custom_octopus_connection }
+
         class_attribute :custom_octopus_connection
 
         class << self
@@ -132,7 +152,7 @@ If you are trying to scope everything to a specific shard, use Octopus.using ins
 
       def allowed_shard?(shard)
         if custom_octopus_connection
-          allowed_shards && shard && allowed_shards.include?(shard)
+          allowed_shards && shard && (allowed_shards.include?(shard.to_s) || allowed_shards.include?(shard.to_sym))
         else
           true
         end

data/lib/octopus/proxy.rb

@@ -35,19 +35,20 @@ module Octopus
 
     def execute(sql, name = nil)
       conn = select_connection
-      clean_connection_proxy
+      clean_connection_proxy if should_clean_connection_proxy?('execute')
       conn.execute(sql, name)
     end
 
     def insert(arel, name = nil, pk = nil, id_value = nil, sequence_name = nil, binds = [])
       conn = select_connection
-      clean_connection_proxy
+      clean_connection_proxy if should_clean_connection_proxy?('insert')
       conn.insert(arel, name, pk, id_value, sequence_name, binds)
     end
 
     def update(arel, name = nil, binds = [])
       conn = select_connection
-      clean_connection_proxy
+      # Call the legacy should_clean_connection_proxy? method here, emulating an insert.
+      clean_connection_proxy if should_clean_connection_proxy?('insert')
       conn.update(arel, name, binds)
     end
 
@@ -196,7 +197,13 @@ module Octopus
       elsif should_send_queries_to_replicated_databases?(method)
         send_queries_to_selected_slave(method, *args, &block)
       else
-        select_connection.send(method, *args, &block)
+        val = select_connection.send(method, *args, &block)
+
+        if val.instance_of? ActiveRecord::Result
+          val.current_shard = shard_name
+        end
+
+        val
       end
     end
 
@@ -281,7 +288,11 @@ module Octopus
     # while preserving `current_shard`
     def send_queries_to_slave(slave, method, *args, &block)
       using_shard(slave) do
-        select_connection.send(method, *args, &block)
+        val = select_connection.send(method, *args, &block)
+        if val.instance_of? ActiveRecord::Result
+          val.current_shard = slave
+        end
+        val
       end
     end
 

data/lib/octopus/proxy_config.rb

@@ -212,15 +212,15 @@ module Octopus
 
     private
 
-    def connection_pool_for(adapter, config)
+    def connection_pool_for(config, adapter)
       if Octopus.rails4?
-        arg = ActiveRecord::ConnectionAdapters::ConnectionSpecification.new(adapter.dup, config)
+        spec = ActiveRecord::ConnectionAdapters::ConnectionSpecification.new(config.dup, adapter )
       else
         name = adapter["octopus_shard"]
-        arg = ActiveRecord::ConnectionAdapters::ConnectionSpecification.new(name, adapter.dup, config)
+        spec = ActiveRecord::ConnectionAdapters::ConnectionSpecification.new(name, config.dup, adapter)
       end
 
-      ActiveRecord::ConnectionAdapters::ConnectionPool.new(arg)
+      ActiveRecord::ConnectionAdapters::ConnectionPool.new(spec)
     end
 
     def resolve_string_connection(spec)

data/lib/octopus/result_patch.rb

@@ -0,0 +1,19 @@
+module Octopus::ResultPatch
+  attr_accessor :current_shard
+
+  private
+
+  def hash_rows
+    if current_shard.blank?
+      super
+    else
+      foo = super
+      foo.each { |f| f.merge!('current_shard' => current_shard) }
+      foo
+    end
+  end
+end
+
+class ActiveRecord::Result
+  prepend Octopus::ResultPatch
+end

data/lib/octopus/scope_proxy.rb

@@ -46,8 +46,11 @@ module Octopus
     def method_missing(method, *args, &block)
       result = run_on_shard { @klass.send(method, *args, &block) }
       if result.respond_to?(:all)
-        @klass = result
-        return self
+        return ::Octopus::ScopeProxy.new(current_shard, result)
+      end
+
+      if result.respond_to?(:current_shard)
+        result.current_shard = current_shard
       end
 
       result

data/lib/octopus/version.rb

@@ -1,3 +1,3 @@
 module Octopus
-  VERSION = '0.9.1'
+  VERSION = '0.9.2'
 end

data/spec/config/shards.yml

@@ -86,6 +86,18 @@ production_replicated:
       <<: *mysql
 
 
+production_fully_replicated:
+  replicated: true
+  fully_replicated: true
+
+  shards:
+    slave1:
+      database: octopus_shard_2
+      <<: *mysql
+    slave2:
+      database: octopus_shard_3
+      <<: *mysql
+
 replicated_with_one_slave:
   replicated: true
   shards:

data/spec/octopus/association_shard_tracking_spec.rb

@@ -404,6 +404,12 @@ describe Octopus::AssociationShardTracking, :shards => [:brazil, :master, :canad
       end.to raise_error(Octopus::AssociationShardTracking::MismatchedShards)
     end
 
+    it 'should make difference if the shard is a symbol or a string for raising Octopus::AssociationShardTracking::MismatchedShards' do
+      expect do
+        @brazil_client.items << Item.using('brazil').create!(:name => 'New Brazil Item')
+      end.not_to raise_error
+    end
+
     it 'should update the attribute for the item' do
       new_brazil_client = Client.using(:brazil).create!(:name => 'new Client')
       @item_brazil.client = new_brazil_client

data/spec/octopus/migration_spec.rb

@@ -30,6 +30,25 @@ describe Octopus::Migration do
     end
   end
 
+  it "should rollback correctly migrations" do
+    migrations_root = File.expand_path(File.join(File.dirname(__FILE__), '..', 'migrations'))
+
+    ActiveRecord::Migrator.run(:up, migrations_root, 4)
+
+    expect(User.using(:canada).find_by_name('Group')).not_to be_nil
+    expect(User.using(:brazil).find_by_name('Group')).not_to be_nil
+    expect(User.using(:russia).find_by_name('Group')).not_to be_nil
+
+
+    Octopus.using(:canada) do
+      ActiveRecord::Migrator.rollback(migrations_root, 4)
+    end
+
+    expect(User.using(:canada).find_by_name('Group')).to be_nil
+    expect(User.using(:brazil).find_by_name('Group')).to be_nil
+    expect(User.using(:russia).find_by_name('Group')).to be_nil
+  end
+
   it 'should run once per shard' do
     OctopusHelper.migrating_to_version 5 do
       expect(User.using(:canada).where(:name => 'MultipleGroup').size).to eq(1)

data/spec/octopus/model_spec.rb

@@ -63,6 +63,28 @@ describe Octopus::Model do
       expect(User.all).to eq([u1])
     end
 
+    it "should allow the #select method to fetch the correct data when using a block" do
+      canadian_user = User.using(:canada).create!(:name => 'Rafael Pilha')
+
+      Octopus.using('canada') do
+        @all_canadian_user_ids = User.select('id').to_a
+      end
+
+      expect(@all_canadian_user_ids).to eq([canadian_user])
+    end
+
+    it "should allow objects to be fetch using different blocks - GH #306" do
+      canadian_user = User.using(:canada).create!(:name => 'Rafael Pilha')
+
+      Octopus.using(:canada) { @users = User.where('id is not null') }
+      Octopus.using(:canada) { @user = @users.first }
+
+      Octopus.using(:canada) { @user2 = User.where('id is not null').first }
+
+      expect(@user).to eq(canadian_user)
+      expect(@user2).to eq(canadian_user)
+    end
+
     describe 'multiple calls to the same scope' do
       it 'works with nil response' do
         scope = User.using(:canada)
@@ -717,5 +739,16 @@ describe Octopus::Model do
         expect(Cat.replicated).to be true
       end
     end
+
+    it "should work on a fully replicated environment" do
+      OctopusHelper.using_environment :production_fully_replicated do
+        User.using(:slave1).create!(name: 'Thiago')
+        User.using(:slave2).create!(name: 'Thiago')
+
+        replicated_cat = User.find_by_name 'Thiago'
+
+        expect(replicated_cat.current_shard.to_s).to match(/slave/)
+      end
+    end
   end
 end

data/spec/octopus/octopus_spec.rb

@@ -40,7 +40,7 @@ describe Octopus, :shards => [] do
       expect { User.using(:crazy_shard).create!(:name => 'Joaquim') }.to raise_error(RuntimeError)
 
       Octopus.setup do |config|
-        config.shards = { :crazy_shard => { :adapter => 'mysql2', :database => 'octopus_shard_5', :username => 'root', :password => '' } }
+        config.shards = { :crazy_shard => { :adapter => 'mysql2', :database => 'octopus_shard_5', :username => "#{ENV['MYSQL_USER'] || 'root'}", :password => '' } }
       end
 
       expect { User.using(:crazy_shard).create!(:name => 'Joaquim')  }.not_to raise_error

data/spec/octopus/proxy_spec.rb

@@ -30,7 +30,7 @@ describe Octopus::Proxy do
       config = proxy.config
       expect(config[:adapter]).to eq('mysql2')
       expect(config[:database]).to eq('octopus_shard_1')
-      expect(config[:username]).to eq('root')
+      expect(config[:username]).to eq("#{ENV['MYSQL_USER'] || 'root'}")
     end
 
     unless Octopus.rails50? || Octopus.rails51?
@@ -252,6 +252,22 @@ describe Octopus::Proxy do
     end
   end
 
+
+  describe 'cleaning the connection proxy' do
+    it 'should not clean #current_shard from proxy when using a block and calling #execute' do
+      Octopus.using(:canada) do
+        expect(User.connection.current_shard).to eq(:canada)
+
+        connection = User.connection
+
+        result = connection.execute('select * from users limit 1;')
+        result = connection.execute('select * from users limit 1;')
+
+        expect(User.connection.current_shard).to eq(:canada)
+      end
+    end
+  end
+
   describe 'connection reuse' do
     before :each do
       @item_brazil_conn = Item.using(:brazil).new(:name => 'Brazil Item').class.connection.select_connection

data/spec/octopus/relation_proxy_spec.rb

@@ -28,6 +28,26 @@ describe Octopus::RelationProxy do
       expect(not_relation.current_shard).to eq(@relation.current_shard)
     end
 
+    context 'when a new relation is constructed from the original relation' do
+      context 'and a where(...) is used' do
+        it 'does not tamper with the original relation' do
+          relation = Item.using(:canada).where(id: 1)
+          original_sql = relation.to_sql
+          new_relation = relation.where(id: 2)
+          expect(relation.to_sql).to eq(original_sql)
+        end
+      end
+
+      context 'and a where.not(...) is used' do
+        it 'does not tamper with the original relation' do
+          relation = Item.using(:canada).where(id: 1)
+          original_sql = relation.to_sql
+          new_relation = relation.where.not(id: 2)
+          expect(relation.to_sql).to eq(original_sql)
+        end
+      end
+    end
+
     context 'when comparing to other Relation objects' do
       before :each do
         @relation.reset

data/spec/support/database_connection.rb

@@ -1,4 +1,4 @@
 require 'logger'
 
-ActiveRecord::Base.establish_connection(:adapter => 'mysql2', :database => 'octopus_shard_1', :username => 'root', :password => '')
+ActiveRecord::Base.establish_connection(:adapter => 'mysql2', :database => 'octopus_shard_1', :username => "#{ENV['MYSQL_USER'] || 'root'}", :password => '')
 ActiveRecord::Base.logger = Logger.new(File.open('database.log', 'a'))

data/spec/support/database_models.rb

@@ -28,7 +28,7 @@ end
 # This class sets its own connection
 class CustomConnection < ActiveRecord::Base
   self.table_name = 'custom'
-  octopus_establish_connection(:adapter => 'mysql2', :database => 'octopus_shard_2', :username => 'root', :password => '')
+  octopus_establish_connection(:adapter => 'mysql2', :database => 'octopus_shard_2', :username => "#{ENV['MYSQL_USER'] || 'root'}", :password => '')
 end
 
 # This items belongs to a client

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ar-octopus
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.9.2
 platform: ruby
 authors:
 - Thiago Pradi
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-16 00:00:00.000000000 Z
+date: 2018-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -72,16 +72,16 @@ dependencies:
   name: pg
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.11.0
+        version: '0.18'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.11.0
+        version: '0.18'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -199,6 +199,7 @@ files:
 - lib/octopus/proxy_config.rb
 - lib/octopus/railtie.rb
 - lib/octopus/relation_proxy.rb
+- lib/octopus/result_patch.rb
 - lib/octopus/scope_proxy.rb
 - lib/octopus/shard_tracking.rb
 - lib/octopus/shard_tracking/attribute.rb
@@ -344,7 +345,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Easy Database Sharding for ActiveRecord