activerecord-turntable 3.0.0 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6cfc2457a7b8212bbeef4d49d4b84b8b40877396
-  data.tar.gz: ed7b1f0e36e61aa3104ec0bebd1cd4d67e31dcdb
+  metadata.gz: 65f26f1f0d729de81434f01e9bcaaff91ed996e7
+  data.tar.gz: 789697728baf93d532fdd47b711473debe693437
 SHA512:
-  metadata.gz: ba0296ccb842d6f10069cc875a2aacd0bd2bd7b3b3766cd7fc3701b795c16c3f05f64531b279a1cac2a13649dac832ce932c7ba3478326aaf03f1698f5757e46
-  data.tar.gz: 497202d000a232456c5c786ec1202920773069a684760d2c3bcb9eb3e6e55c761d19ff1fb64ac6f3f333401ebc31a1b527b7cb299d603ab22b52413f9376e9ba
+  metadata.gz: 4ba8a9f58defbc75afc069b299d5bd27e3a7688bf176f86b7f5670a56bd129bae4d7e0988ef04d78edea863105be3445e5b07f68f306ee24e427b90c03dc842d
+  data.tar.gz: '08c739c86e694240129f47c0f7dcd039107f2ca8630356796695c4e7faa13a8784da4d61b54be5804def5f6b7e041f55c02218ee4e64bca4260d8a3ac4338e08'

data/.travis.yml

@@ -5,13 +5,16 @@ cache:
   bundler: true
 
 rvm:
-  - 2.2.6
-  - 2.3.3
-  - 2.4.0
+  - 2.2.7
+  - 2.3.4
+  - 2.4.1
   - ruby-head
 
 gemfile:
-  - gemfiles/rails5_0.gemfile
+  - gemfiles/rails5_0_0.gemfile
+  - gemfiles/rails5_0_1.gemfile
+  - gemfiles/rails5_0_2.gemfile
+  - gemfiles/rails5_0_3.gemfile
   - gemfiles/rails_edge.gemfile
 
 env:
@@ -27,6 +30,17 @@ script:
   - bundle exec rake $BUILD_TASK
 
 matrix:
+  exclude:
+    - rvm: ruby-head
+    - gemfile: gemfiles/rails_edge.gemfile
+    - rvm: 2.3.4
+  include:
+    - rvm: ruby-head
+      gemfile: gemfiles/rails_edge.gemfile
+    - rvm: 2.4.1
+      gemfile: gemfiles/rails_edge.gemfile
+    - rvm: 2.3.4
+      gemfile: gemfiles/rails5_0_3.gemfile
   allow_failures:
     - rvm: ruby-head
     - gemfile: gemfiles/rails_edge.gemfile

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+## activerecord-turntable 3.0.1 ##
+
+### Minor Changes
+
+* Restore LogSubscriber log format to the same as 2.x
+
+### Bugfixes
+
+* Fix ActiveRecord 5.0.x compatibilities
+  * Fixes SchemaDumper fails dumping sequence tables on v5.0.0
+  * Follow AbstractAdapter#log implementation changes on v5.0.3
+  * Fix QueryCache to work with v5.0.1 or later
+
 ## activerecord-turntable 3.0.0 ##
 
 ### Bugfixes

data/Rakefile

@@ -148,6 +148,26 @@ namespace :turntable do
         File.open("test/cases/helper.rb", "a") do |f|
           f << "require '#{File.expand_path("spec/activerecord_helper", __dir__)}'"
         end
+
+        # FIXME: Disable a part of tests about internal metadata and validations on 5.0.x because it randomly fails.
+        if ActiveRecord.gem_version.release < Gem::Version.new("5.1.0")
+          File.open("test/cases/migration_test.rb", "a") do |f|
+            f << <<-EOS
+              class MigrationTest
+                undef :test_migration_sets_internal_metadata_even_when_fully_migrated,
+                      :test_internal_metadata_stores_environment
+              end
+            EOS
+          end
+
+          File.open("test/cases/validations_test.rb", "a") do |f|
+            f << <<-EOS
+              class ValidationsTest
+                undef :test_numericality_validation_with_mutation
+              end
+            EOS
+          end
+        end
       end
 
       task :db => :rails do

data/gemfiles/rails5_0_0.gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+gem "activerecord", "5.0.0"
+gem "activesupport", "5.0.0"
+
+gemspec :path => '../'

data/gemfiles/rails5_0_2.gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+gem "activerecord", "5.0.2"
+gem "activesupport", "5.0.2"
+
+gemspec :path => '../'

data/gemfiles/rails5_0_3.gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+gem "activerecord", "5.0.3"
+gem "activesupport", "5.0.3"
+
+gemspec :path => '../'

data/lib/active_record/turntable.rb

@@ -28,7 +28,6 @@ module ActiveRecord::Turntable
     autoload :Migration
     autoload :Mixer
     autoload :PoolProxy
-    autoload :QueryCache
     autoload :Shard
     autoload :ShardingCondition
     autoload :SeqShard

data/lib/active_record/turntable/active_record_ext.rb

@@ -16,6 +16,7 @@ module ActiveRecord::Turntable
       autoload :AssociationPreloader
       autoload :Association
       autoload :LockingOptimistic
+      autoload :QueryCache
     end
 
     included do
@@ -31,6 +32,7 @@ module ActiveRecord::Turntable
       ActiveRecord::ConnectionAdapters::ConnectionHandler.prepend(ConnectionHandlerExtension)
       ActiveRecord::Associations::Preloader::Association.prepend(AssociationPreloader)
       ActiveRecord::Associations::Association.prepend(Association)
+      ActiveRecord::QueryCache.prepend(QueryCache)
       require "active_record/turntable/active_record_ext/fixtures"
       require "active_record/turntable/active_record_ext/migration_proxy"
       require "active_record/turntable/active_record_ext/activerecord_import_ext"

data/lib/active_record/turntable/active_record_ext/abstract_adapter.rb

@@ -15,17 +15,33 @@ module ActiveRecord::Turntable
 
       # @note override for append current shard name
       # rubocop:disable Style/HashSyntax, Style/MultilineMethodCallBraceLayout
-      def log(sql, name = "SQL", binds = [], statement_name = nil)
-        @instrumenter.instrument(
-          "sql.active_record",
-          :sql                  => sql,
-          :name                 => name,
-          :connection_id        => object_id,
-          :statement_name       => statement_name,
-          :binds                => binds,
-          :turntable_shard_name => turntable_shard_name) { yield }
-      rescue => e
-        raise translate_exception_class(e, sql)
+      if ActiveRecord::Turntable::Util.ar_version_equals_or_later?("5.0.3")
+        def log(sql, name = "SQL", binds = [], type_casted_binds = [], statement_name = nil)
+          @instrumenter.instrument(
+            "sql.active_record",
+            sql:                  sql,
+            name:                 name,
+            binds:                binds,
+            type_casted_binds:    type_casted_binds,
+            statement_name:       statement_name,
+            connection_id:        object_id,
+            turntable_shard_name: turntable_shard_name) { yield }
+        rescue => e
+          raise translate_exception_class(e, sql)
+        end
+      else
+        def log(sql, name = "SQL", binds = [], statement_name = nil)
+          @instrumenter.instrument(
+            "sql.active_record",
+            :sql                  => sql,
+            :name                 => name,
+            :connection_id        => object_id,
+            :statement_name       => statement_name,
+            :binds                => binds,
+            :turntable_shard_name => turntable_shard_name) { yield }
+        rescue => e
+          raise translate_exception_class(e, sql)
+        end
       end
       # rubocop:enable Style/HashSyntax, Style/MultilineMethodCallBraceLayout
 

data/lib/active_record/turntable/active_record_ext/log_subscriber.rb

@@ -5,17 +5,34 @@ module ActiveRecord::Turntable
     module LogSubscriber
       # @note prepend to add shard name logging
       def sql(event)
+        self.class.runtime += event.duration
+        return unless logger.debug?
+
         payload = event.payload
 
-        if self.class::IGNORE_PAYLOAD_NAMES.include?(payload[:name])
-          self.class.runtime += event.duration
-          return
-        end
+        return if ActiveRecord::LogSubscriber::IGNORE_PAYLOAD_NAMES.include?(payload[:name])
+
+        name  = "#{payload[:name]} (#{event.duration.round(1)}ms)"
+        name  = "#{name} [Shard: #{payload[:turntable_shard_name]}]" if payload[:turntable_shard_name]
+        name  = "CACHE #{name}" if payload[:cached]
+        sql   = payload[:sql]
+        binds = nil
 
-        if payload[:turntable_shard_name]
-          payload[:name] = "#{payload[:name]} [Shard: #{payload[:turntable_shard_name]}]"
+        unless (payload[:binds] || []).empty?
+          if Util.ar_version_equals_or_later?("5.0.3")
+            casted_params = type_casted_binds(payload[:binds], payload[:type_casted_binds])
+            binds = "  " + payload[:binds].zip(casted_params).map { |attr, value|
+              render_bind(attr, value)
+            }.inspect
+          else
+            binds = "  " + payload[:binds].map { |attr| render_bind(attr) }.inspect
+          end
         end
-        super
+
+        name = colorize_payload_name(name, payload[:name])
+        sql  = color(sql, sql_color(sql), true)
+
+        debug "  #{name}  #{sql}#{binds}"
       end
     end
   end

data/lib/active_record/turntable/active_record_ext/query_cache.rb

@@ -0,0 +1,76 @@
+module ActiveRecord::Turntable
+  module ActiveRecordExt
+    module QueryCache
+      def self.prepended(klass)
+        class << klass
+          if Util.ar_version_equals_or_later?("5.0.1")
+            prepend(ClassMethods::AR5_0_1)
+          else
+            prepend(ClassMethods::AR5_0)
+          end
+        end
+      end
+
+      module ClassMethods
+        module AR5_0
+          def run
+            result = super
+
+            pools = ActiveRecord::Base.turntable_connections.values
+            pools.each do |k|
+              k.connection.enable_query_cache!
+            end
+
+            result
+          end
+
+          def complete(state)
+            enabled, _connection_id = state
+            super
+
+            klasses = ActiveRecord::Base.turntable_connections.values
+            klasses.each do |k|
+              k.connection.clear_query_cache
+              k.connection.disable_query_cache! unless enabled
+            end
+          end
+        end
+
+        module AR5_0_1
+          def run
+            result = super
+
+            pools = ActiveRecord::Base.turntable_connections.values
+            pools.each do |pool|
+              pool.enable_query_cache!
+            end
+
+            [*result, pools]
+          end
+
+          def complete(state)
+            caching_pool, caching_was_enabled, connection_id, turntable_pools = state
+            super([caching_pool, caching_was_enabled, connection_id])
+
+            turntable_pools.each do |pool|
+              pool.disable_query_cache! unless caching_was_enabled
+            end
+          end
+        end
+      end
+
+      def self.install_turntable_executor_hooks(executor = ActiveSupport::Executor)
+        return if Util.ar_version_equals_or_later?("5.0.1")
+
+        executor.to_complete do
+          klasses = ActiveRecord::Base.turntable_connection_classes
+          klasses.each do |k|
+            unless k.connected? && k.connection.transaction_open?
+              k.clear_active_connections!
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/active_record/turntable/active_record_ext/schema_dumper.rb

@@ -20,7 +20,12 @@ module ActiveRecord::Turntable
 
             table_options = @connection.table_options(table)
             if table_options.present?
-              tbl.print ", #{format_options(table_options)}"
+              options = respond_to?(:format_options) ? format_options(table_options) : table_options.inspect
+              tbl.print ", options: #{options}"
+            end
+
+            if comment = @connection.table_comment(table).presence
+              tbl.print ", comment: #{comment.inspect}"
             end
             tbl.puts
 

data/lib/active_record/turntable/connection_proxy.rb

@@ -1,4 +1,5 @@
 require "active_record/turntable/connection_proxy/mixable"
+
 module ActiveRecord::Turntable
   class ConnectionProxy
     include Mixable
@@ -24,35 +25,61 @@ module ActiveRecord::Turntable
     delegate :create_table, :rename_table, :drop_table, :add_column, :remove_colomn,
              :change_column, :change_column_default, :rename_column, :add_index,
              :remove_index, :initialize_schema_information,
-             :dump_schema_information, :execute_ignore_duplicate, to: :master_connection
+             :dump_schema_information, :execute_ignore_duplicate,
+             :query_cache_enabled, to: :master_connection
 
     def transaction(options = {}, &block)
       connection.transaction(options, &block)
     end
 
     def cache
+      old = query_cache_enabled
       enable_query_cache!
       yield
     ensure
-      clear_query_cache
+      unless old
+        disable_query_cache!
+        clear_query_cache
+      end
+    end
+
+    def uncached
+      old = query_cache_enabled
+      disable_query_cache!
+      yield
+    ensure
+      enable_query_cache! if old
     end
 
     def enable_query_cache!
+      master_connection.enable_query_cache!
+
       klass.turntable_connections.each do |_k, v|
         v.connection.enable_query_cache!
       end
     end
 
+    def disable_query_cache!
+      master_connection.disable_query_cache!
+
+      klass.turntable_connections.each do |_k, v|
+        v.connection.disable_query_cache!
+      end
+    end
+
     def clear_query_cache_if_needed(method)
       clear_query_cache if CLEAR_CACHE_METHODS.include?(method)
     end
 
     def clear_query_cache
+      master_connection.clear_query_cache
+
       klass.turntable_connections.each do |_k, v|
         v.connection.clear_query_cache
       end
     end
 
+
     # rubocop:disable Style/MethodMissing
     def method_missing(method, *args, &block)
       clear_query_cache_if_needed(method)

data/lib/active_record/turntable/migration.rb

@@ -104,30 +104,33 @@ module ActiveRecord::Turntable::Migration
 
     module ClassMethods
       def up(migrations_paths, target_version = nil)
-        super
+        result = super
 
         ActiveRecord::Tasks::DatabaseTasks.each_current_turntable_cluster_connected(current_environment) do |name, configuration|
           puts "[turntable] *** Migrating database: #{configuration['database']}(Shard: #{name})"
           super(migrations_paths, target_version)
         end
+        result
       end
 
       def down(migrations_paths, target_version = nil, &block)
-        super
+        result = super
 
         ActiveRecord::Tasks::DatabaseTasks.each_current_turntable_cluster_connected(current_environment) do |name, configuration|
           puts "[turntable] *** Migrating database: #{configuration['database']}(Shard: #{name})"
           super(migrations_paths, target_version, &block)
         end
+        result
       end
 
       def run(*args)
-        super
+        result = super
 
         ActiveRecord::Tasks::DatabaseTasks.each_current_turntable_cluster_connected(current_environment) do |name, configuration|
           puts "[turntable] *** Migrating database: #{configuration['database']}(Shard: #{name})"
           super(*args)
         end
+        result
       end
     end
   end

data/lib/active_record/turntable/railtie.rb

@@ -24,9 +24,9 @@ module ActiveRecord::Turntable
     end
 
     # set QueryCache executor hooks for turntable clusters
-    initializer "active_record.set_executor_hooks" do
+    initializer "turntable.set_executor_hooks" do
       ActiveSupport.on_load(:active_record) do
-        ActiveRecord::Turntable::QueryCache.install_executor_hooks
+        ActiveRecord::Turntable::ActiveRecordExt::QueryCache.install_turntable_executor_hooks
       end
     end
   end

data/lib/active_record/turntable/version.rb

@@ -1,5 +1,5 @@
 module ActiveRecord
   module Turntable
-    VERSION = "3.0.0".freeze
+    VERSION = "3.0.1".freeze
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-turntable
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.0.1
 platform: ruby
 authors:
 - gussan
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-25 00:00:00.000000000 Z
+date: 2017-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -509,7 +509,10 @@ files:
 - README.md
 - Rakefile
 - activerecord-turntable.gemspec
-- gemfiles/rails5_0.gemfile
+- gemfiles/rails5_0_0.gemfile
+- gemfiles/rails5_0_1.gemfile
+- gemfiles/rails5_0_2.gemfile
+- gemfiles/rails5_0_3.gemfile
 - gemfiles/rails_edge.gemfile
 - lib/active_record/turntable.rb
 - lib/active_record/turntable/active_record_ext.rb
@@ -527,6 +530,7 @@ files:
 - lib/active_record/turntable/active_record_ext/log_subscriber.rb
 - lib/active_record/turntable/active_record_ext/migration_proxy.rb
 - lib/active_record/turntable/active_record_ext/persistence.rb
+- lib/active_record/turntable/active_record_ext/query_cache.rb
 - lib/active_record/turntable/active_record_ext/relation.rb
 - lib/active_record/turntable/active_record_ext/schema_dumper.rb
 - lib/active_record/turntable/active_record_ext/sequencer.rb
@@ -555,7 +559,6 @@ files:
 - lib/active_record/turntable/mixer/fader/update_shards_merge_result.rb
 - lib/active_record/turntable/plugin.rb
 - lib/active_record/turntable/pool_proxy.rb
-- lib/active_record/turntable/query_cache.rb
 - lib/active_record/turntable/railtie.rb
 - lib/active_record/turntable/railties/databases.rake
 - lib/active_record/turntable/seq_shard.rb
@@ -592,7 +595,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: activerecord-turntable
-rubygems_version: 2.5.2
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: ActiveRecord sharding extension

data/lib/active_record/turntable/query_cache.rb

@@ -1,41 +0,0 @@
-require "rack/body_proxy"
-require "active_record/query_cache"
-
-module ActiveRecord
-  module Turntable
-    class QueryCache < ActiveRecord::QueryCache
-      def self.run
-        klasses = ActiveRecord::Base.turntable_connections.values
-        enables = klasses.map do |k|
-          enabled = k.connection.query_cache_enabled
-          k.connection.enable_query_cache!
-
-          enabled
-        end
-
-        enables.all?
-      end
-
-      def self.complete(enabled)
-        klasses = ActiveRecord::Base.turntable_connections.values
-        klasses.each do |k|
-          k.connection.clear_query_cache
-          k.connection.disable_query_cache! unless enabled
-        end
-      end
-
-      def self.install_executor_hooks(executor = ActiveSupport::Executor)
-        executor.register_hook(self)
-
-        executor.to_complete do
-          klasses = ActiveRecord::Base.turntable_connection_classes
-          klasses.each do |k|
-            unless k.connected? && k.connection.transaction_open?
-              k.clear_active_connections!
-            end
-          end
-        end
-      end
-    end
-  end
-end