switchman 1.16.0 → 2.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 70787591a2f55963ba4b74b816cb11428d1d764e87d3635309d98b423ed842e1
-  data.tar.gz: 5516037d6c39f1215eac8764512d97125dbeaf2cb64aeed234f5a4d55ce18650
+  metadata.gz: c544d2ed8498a6aecf33823f39b304393a65f213f6a68bf04f4d36610ebe3ac2
+  data.tar.gz: be685b315997b103dd13376f5223196f1b66a5be490502aac6bc401408899abc
 SHA512:
-  metadata.gz: bad00cb3a194c18f792c214caa3f47f90ac53b7186ea458775b9562e1bf2b8fa898e6317ca4514722ce3a9e8652061101e15f657556f2c95344c6ecd5284bb34
-  data.tar.gz: '0697c43ffd9934ddfb9d0640295024e1035297ac7f14e9a3018a80f0170e427904924d4efa42892a5cf2f223aa75490c9ccd0da500c7040c4c53da4b04f8d9a7'
+  metadata.gz: fbdd769d90c831e1bbe6dd39def12775537989346daae7dbbab3103a330b89151e9d1c3b9fe216ab9ade75e3c01ee1b1c91062cc622707c3c2697f7dc3239ea8
+  data.tar.gz: 27d32eefa842a76debb1a1fc7875407b4df1398a45a71419c7cc13045fd8705ff5e4af724478a9cb854d517433ae8d16420baa13fc8e7459ab1953e626c0c80a

data/app/models/switchman/shard.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'switchman/database_server'
 require 'switchman/default_shard'
 require 'switchman/environment'
@@ -38,7 +40,10 @@ module Switchman
       end
 
       def default(reload_deprecated = false, reload: false, with_fallback: false)
-        reload = reload_deprecated if reload_deprecated
+        if reload_deprecated
+          reload = reload_deprecated
+          ::ActiveSupport::Deprecation.warn("positional reload parameter to Switchman::Shard.default is deprecated; use `reload: true`")
+        end
         if !@default || reload
           # Have to create a dummy object so that several key methods still work
           # (it's easier to do this in one place here, and just assume that sharding
@@ -351,8 +356,8 @@ module Switchman
           # prune the prior connection unless it happened to be the same
           if previous_shard && shard != previous_shard && !previous_shard.database_server.shareable?
             previous_shard.activate do
-              ::Shackles.activated_environments.each do |env|
-                ::Shackles.activate(env) do
+              ::GuardRail.activated_environments.each do |env|
+                ::GuardRail.activate(env) do
                   if ::ActiveRecord::Base.connected? && ::ActiveRecord::Base.connection.open_transactions == 0
                     ::ActiveRecord::Base.connection_pool.current_pool.disconnect!
                   end
@@ -659,7 +664,7 @@ module Switchman
         case adapter
           when 'mysql', 'mysql2'
             self.activate do
-              ::Shackles.activate(:deploy) do
+              ::GuardRail.activate(:deploy) do
                 drop_statement ||= "DROP DATABASE #{self.name}"
                 Array(drop_statement).each do |stmt|
                   ::ActiveRecord::Base.connection.execute(stmt)
@@ -668,7 +673,7 @@ module Switchman
             end
           when 'postgresql'
             self.activate do
-              ::Shackles.activate(:deploy) do
+              ::GuardRail.activate(:deploy) do
                 # Shut up, Postgres!
                 conn = ::ActiveRecord::Base.connection
                 old_proc = conn.raw_connection.set_notice_processor {}

data/db/migrate/20130328212039_create_switchman_shards.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class CreateSwitchmanShards < ActiveRecord::Migration[4.2]
   def change
     create_table :switchman_shards do |t|

data/db/migrate/20130328224244_create_default_shard.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 class CreateDefaultShard < ActiveRecord::Migration[4.2]
   def up
     unless Switchman::Shard.default.is_a?(Switchman::Shard)
       Switchman::Shard.reset_column_information
       Switchman::Shard.create!(:default => true)
-      Switchman::Shard.default(true)
+      Switchman::Shard.default(reload: true)
     end
   end
 end

data/db/migrate/20161206323434_add_back_default_string_limits_switchman.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class AddBackDefaultStringLimitsSwitchman < ActiveRecord::Migration[4.2]
   def up
     add_string_limit_if_missing :switchman_shards, :name

data/db/migrate/20180828183945_add_default_shard_index.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class AddDefaultShardIndex < ActiveRecord::Migration[4.2]
   def change
     Switchman::Shard.where(default: nil).update_all(default: false)

data/db/migrate/20180828192111_add_timestamps_to_shards.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class AddTimestampsToShards < ActiveRecord::Migration[4.2]
   def change
     add_timestamps :switchman_shards, null: true

data/db/migrate/20190114212900_add_unique_name_indexes.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class AddUniqueNameIndexes < ActiveRecord::Migration[4.2]
   def change
     add_index :switchman_shards, [:database_server_id, :name], unique: true

data/lib/switchman.rb

@@ -1,4 +1,6 @@
-require "shackles"
+# frozen_string_literal: true
+
+require "guard_rail"
 require "switchman/open4"
 require "switchman/engine"
 

data/lib/switchman/action_controller/caching.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Switchman
   module ActionController
     module Caching

data/lib/switchman/active_record/abstract_adapter.rb

@@ -1,11 +1,13 @@
+# frozen_string_literal: true
+
 require 'switchman/sharded_instrumenter'
 
 module Switchman
   module ActiveRecord
     module AbstractAdapter
       module ForeignKeyCheck
-        def add_column(table, name, type, options = {})
-          Engine.foreign_key_check(name, type, options)
+        def add_column(table, name, type, limit: nil, **)
+          Engine.foreign_key_check(name, type, limit: limit)
           super
         end
       end
@@ -27,6 +29,10 @@ module Switchman
         quote_table_name(name)
       end
 
+      def schema_migration
+        ::ActiveRecord::SchemaMigration
+      end
+
       protected
 
       def log(*args, &block)

data/lib/switchman/active_record/association.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Switchman
   module ActiveRecord
     module Association
@@ -75,7 +77,7 @@ module Switchman
       module Association
         if ::Rails.version >= "5.2" and ::Rails.version < "6.0"
           def run(preloader)
-            associated_records_by_owner(preloader).each do |owner, records|
+            associated_records_by_owner.each do |owner, records|
               associate_records_to_owner(owner, records)
             end
           end
@@ -102,6 +104,7 @@ module Switchman
         end
 
         def associated_records_by_owner(preloader = nil)
+          return @associated_records_by_owner if defined?(@associated_records_by_owner)
           owners_map = owners_by_key
 
           if klass.nil? || owners_map.empty?
@@ -149,10 +152,13 @@ module Switchman
             records.flatten!
           end
 
+          # This ivar may look unused, but remember this is an extension of
+          # rails' AR::Associations::Preloader::Association class. It gets used
+          # by that class (and its subclasses).
           @preloaded_records = records
 
           # Each record may have multiple owners, and vice-versa
-          records_by_owner = owners.each_with_object({}) do |owner,h|
+          @associated_records_by_owner = owners.each_with_object({}) do |owner,h|
             h[owner] = []
           end
           records.each do |record|
@@ -161,10 +167,10 @@ module Switchman
 
             owners_map[owner_key.to_s].each do |owner|
               owner.association(reflection.name).set_inverse_instance(record)
-              records_by_owner[owner] << record
+              @associated_records_by_owner[owner] << record
             end
           end
-          records_by_owner
+          @associated_records_by_owner
         end
 
         def owners_by_key

data/lib/switchman/active_record/attribute_methods.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Switchman
   module ActiveRecord
     module AttributeMethods

data/lib/switchman/active_record/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Switchman
   module ActiveRecord
     module Base
@@ -31,20 +33,20 @@ module Switchman
           @integral_id
         end
 
-        def transaction(*args)
+        def transaction(**)
           if self != ::ActiveRecord::Base && current_scope
             current_scope.activate do
               db = Shard.current(shard_category).database_server
-              if ::Shackles.environment != db.shackles_environment
-                db.unshackle { super }
+              if ::GuardRail.environment != db.guard_rail_environment
+                db.unguard { super }
               else
                 super
               end
             end
           else
             db = Shard.current(shard_category).database_server
-            if ::Shackles.environment != db.shackles_environment
-              db.unshackle { super }
+            if ::GuardRail.environment != db.guard_rail_environment
+              db.unguard { super }
             else
               super
             end
@@ -105,12 +107,12 @@ module Switchman
         end
       end
 
-      def save(*args)
+      def save(*, **)
         @shard_set_in_stone = true
         (self.class.current_scope || self.class.default_scoped).shard(shard, :implicit).scoping { super }
       end
 
-      def save!(*args)
+      def save!(*, **)
         @shard_set_in_stone = true
         (self.class.current_scope || self.class.default_scoped).shard(shard, :implicit).scoping { super }
       end
@@ -128,9 +130,9 @@ module Switchman
         result
       end
 
-      def transaction(options={}, &block)
+      def transaction(**kwargs, &block)
         shard.activate(self.class.shard_category) do
-          self.class.transaction(options, &block)
+          self.class.transaction(**kwargs, &block)
         end
       end
 
@@ -157,8 +159,8 @@ module Switchman
 
       def update_columns(*)
         db = Shard.current(self.class.shard_category).database_server
-        if ::Shackles.environment != db.shackles_environment
-          return db.unshackle { super }
+        if ::GuardRail.environment != db.guard_rail_environment
+          return db.unguard { super }
         else
           super
         end

data/lib/switchman/active_record/batches.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Switchman
   module ActiveRecord
     module Batches

data/lib/switchman/active_record/calculations.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Switchman
   module ActiveRecord
     module Calculations

data/lib/switchman/active_record/connection_handler.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'switchman/connection_pool_proxy'
 
 module Switchman
@@ -55,7 +57,7 @@ module Switchman
           Shard.default.remove_instance_variable(:@name) if Shard.default.instance_variable_defined?(:@name)
         end
 
-        @shard_connection_pools ||= { [:master, Shard.default.database_server.shareable? ? ::Rails.env : Shard.default] => pool}
+        @shard_connection_pools ||= { [:primary, Shard.default.database_server.shareable? ? ::Rails.env : Shard.default] => pool}
 
         category = pool.spec.name.to_sym
         proxy = ConnectionPoolProxy.new(category,
@@ -64,13 +66,13 @@ module Switchman
         owner_to_pool[pool.spec.name] = proxy
 
         if first_time
-          if Shard.default.database_server.config[:prefer_slave]
-            Shard.default.database_server.shackle!
+          if Shard.default.database_server.config[:prefer_secondary]
+            Shard.default.database_server.guard!
           end
 
-          if Shard.default.is_a?(DefaultShard) && Shard.default.database_server.config[:slave]
-            Shard.default.database_server.shackle!
-            Shard.default(true)
+          if Shard.default.is_a?(DefaultShard) && Shard.default.database_server.config[:secondary]
+            Shard.default.database_server.guard!
+            Shard.default(reload: true)
           end
         end
 

data/lib/switchman/active_record/connection_pool.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'switchman/errors'
 
 module Switchman

data/lib/switchman/active_record/finder_methods.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Switchman
   module ActiveRecord
     module FinderMethods

data/lib/switchman/active_record/log_subscriber.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Switchman
   module ActiveRecord
     module LogSubscriber

data/lib/switchman/active_record/migration.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Switchman
   module ActiveRecord
     module Migration
@@ -29,7 +31,7 @@ module Switchman
 
     module Migrator
       def generate_migrator_advisory_lock_id
-        shard_name_hash = Zlib.crc32(Shard.current.name)
+        shard_name_hash = Zlib.crc32("#{Shard.current.id}:#{Shard.current.name}")
         ::ActiveRecord::Migrator::MIGRATOR_SALT * shard_name_hash
       end
     end

data/lib/switchman/active_record/model_schema.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Switchman
   module ActiveRecord
     module ModelSchema

data/lib/switchman/active_record/persistence.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module Switchman
   module ActiveRecord
     module Persistence
       # touch reads the id attribute directly, so it's not relative to the current shard
-      def touch(*)
+      def touch(*, **)
         shard.activate(self.class.shard_category) { super }
       end
 

data/lib/switchman/active_record/postgresql_adapter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Switchman
   module ActiveRecord
     module PostgreSQLAdapter
@@ -192,7 +194,7 @@ module Switchman
         end
       end
 
-      def add_index_options(_table_name, _column_name, _options = {})
+      def add_index_options(_table_name, _column_name, **)
         index_name, index_type, index_columns, index_options, algorithm, using = super
         algorithm = nil if DatabaseServer.creating_new_shard && algorithm == "CONCURRENTLY"
         [index_name, index_type, index_columns, index_options, algorithm, using]

data/lib/switchman/active_record/predicate_builder.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Switchman
   module ActiveRecord
     module PredicateBuilder

data/lib/switchman/active_record/query_cache.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Switchman
   module ActiveRecord
     module QueryCache

data/lib/switchman/active_record/query_methods.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Switchman
   module ActiveRecord
     module QueryMethods
@@ -76,6 +78,10 @@ module Switchman
         end
       end
 
+      def or(other)
+        super(other.shard(self.primary_shard))
+      end
+
       private
 
       if ::Rails.version >= '5.2'
@@ -240,92 +246,135 @@ module Switchman
                                binds: nil,
                                dup_binds_on_mutation: false)
         result = predicates.map do |predicate|
-          next predicate unless predicate.is_a?(::Arel::Nodes::Binary)
-          next predicate unless predicate.left.is_a?(::Arel::Attributes::Attribute)
-          relation, column = relation_and_column(predicate.left)
-          next predicate unless (type = transposable_attribute_type(relation, column))
+          transposed, binds = transpose_single_predicate(predicate, source_shard, target_shard, remove_nonlocal_primary_keys,
+                                     binds: binds, dup_binds_on_mutation: dup_binds_on_mutation)
+          transposed
+        end
+        result = [result, binds]
+        result
+      end
+
+      def transpose_single_predicate(predicate,
+                                     source_shard,
+                                     target_shard,
+                                     remove_nonlocal_primary_keys = false,
+                                     binds: nil,
+                                     dup_binds_on_mutation: false)
+        if predicate.is_a?(::Arel::Nodes::Grouping)
+          return predicate, binds unless predicate.expr.is_a?(::Arel::Nodes::Or)
+          # Dang, we have an OR.  OK, that means we have other epxressions below this
+          # level, perhaps many, that may need transposition.
+          # the left side and right side must each be treated as predicate lists and
+          # transformed in kind, if neither of them changes we can just return the grouping as is.
+          # hold on, it's about to get recursive...
+          #
+          # TODO: "binds" is getting passed up and down
+          # this stack purely because of the necessary handling for rails <5.2
+          #  Dropping support for 5.2 means we can remove the "binds" argument from
+          # all of this and yank the conditional below where we monkey with their instance state.
+          or_expr = predicate.expr
+          left_node = or_expr.left
+          right_node = or_expr.right
+          left_predicates = left_node.children
+          right_predicates = right_node.children
+          new_left_predicates, binds = transpose_predicates(left_predicates, source_shard,
+                                                               target_shard, remove_nonlocal_primary_keys,
+                                                               binds: binds, dup_binds_on_mutation: dup_binds_on_mutation)
+          new_right_predicates, binds = transpose_predicates(right_predicates, source_shard,
+                                                               target_shard, remove_nonlocal_primary_keys,
+                                                               binds: binds, dup_binds_on_mutation: dup_binds_on_mutation)
+          if new_left_predicates != left_predicates
+            left_node.instance_variable_set(:@children, new_left_predicates)
+          end
+          if new_right_predicates != right_predicates
+            right_node.instance_variable_set(:@children, new_right_predicates)
+          end
+          return predicate, binds
+        end
+        return predicate, binds unless predicate.is_a?(::Arel::Nodes::Binary)
+        return predicate, binds unless predicate.left.is_a?(::Arel::Attributes::Attribute)
+        relation, column = relation_and_column(predicate.left)
+        return predicate, binds unless (type = transposable_attribute_type(relation, column))
 
-          remove = true if type == :primary &&
-              remove_nonlocal_primary_keys &&
-              predicate.left.relation.model == klass &&
-              predicate.is_a?(::Arel::Nodes::Equality)
+        remove = true if type == :primary &&
+            remove_nonlocal_primary_keys &&
+            predicate.left.relation.model == klass &&
+            predicate.is_a?(::Arel::Nodes::Equality)
 
-          current_source_shard =
-              if source_shard
-                source_shard
-              elsif type == :primary
-                Shard.current(klass.shard_category)
-              elsif type == :foreign
-                source_shard_for_foreign_key(relation, column)
-              end
+        current_source_shard =
+            if source_shard
+              source_shard
+            elsif type == :primary
+              Shard.current(klass.shard_category)
+            elsif type == :foreign
+              source_shard_for_foreign_key(relation, column)
+            end
 
-          if ::Rails.version >= "5.2"
-            new_right_value =
-              case predicate.right
-              when Array
-                predicate.right.map {|val| transpose_predicate_value(val, current_source_shard, target_shard, type, remove) }
-              else
-                transpose_predicate_value(predicate.right, current_source_shard, target_shard, type, remove)
-              end
-          else
-            new_right_value = case predicate.right
+        if ::Rails.version >= "5.2"
+          new_right_value =
+            case predicate.right
             when Array
-              local_ids = []
-              predicate.right.each do |value|
-                local_id = Shard.relative_id_for(value, current_source_shard, target_shard)
-                next unless local_id
-                unless remove && local_id > Shard::IDS_PER_SHARD
-                  if value.is_a?(::Arel::Nodes::Casted)
-                    if local_id == value.val
-                      local_id = value
-                    elsif local_id != value
-                      local_id = value.class.new(local_id, value.attribute)
-                    end
+              predicate.right.map {|val| transpose_predicate_value(val, current_source_shard, target_shard, type, remove) }
+            else
+              transpose_predicate_value(predicate.right, current_source_shard, target_shard, type, remove)
+            end
+        else
+          new_right_value = case predicate.right
+          when Array
+            local_ids = []
+            predicate.right.each do |value|
+              local_id = Shard.relative_id_for(value, current_source_shard, target_shard)
+              next unless local_id
+              unless remove && local_id > Shard::IDS_PER_SHARD
+                if value.is_a?(::Arel::Nodes::Casted)
+                  if local_id == value.val
+                    local_id = value
+                  elsif local_id != value
+                    local_id = value.class.new(local_id, value.attribute)
                   end
-                  local_ids << local_id
                 end
+                local_ids << local_id
               end
-              local_ids
-            when ::Arel::Nodes::BindParam
-              # look for a bind param with a matching column name
-              if binds && bind = binds.detect{|b| b&.name.to_s == predicate.left.name.to_s}
-                # before we mutate, dup
-                if dup_binds_on_mutation
-                  binds = binds.map(&:dup)
-                  dup_binds_on_mutation = false
-                  bind = binds.find { |b| b&.name.to_s == predicate.left.name.to_s }
-                end
-                if bind.value.is_a?(::ActiveRecord::StatementCache::Substitute)
-                  bind.value.sharded = true # mark for transposition later
-                  bind.value.primary = true if type == :primary
-                else
-                  local_id = Shard.relative_id_for(bind.value, current_source_shard, target_shard)
-                  local_id = [] if remove && local_id > Shard::IDS_PER_SHARD
-                  bind.instance_variable_set(:@value, local_id)
-                  bind.instance_variable_set(:@value_for_database, nil)
-                end
+            end
+            local_ids
+          when ::Arel::Nodes::BindParam
+            # look for a bind param with a matching column name
+            if binds && bind = binds.detect{|b| b&.name.to_s == predicate.left.name.to_s}
+              # before we mutate, dup
+              if dup_binds_on_mutation
+                binds = binds.map(&:dup)
+                dup_binds_on_mutation = false
+                bind = binds.find { |b| b&.name.to_s == predicate.left.name.to_s }
+              end
+              if bind.value.is_a?(::ActiveRecord::StatementCache::Substitute)
+                bind.value.sharded = true # mark for transposition later
+                bind.value.primary = true if type == :primary
+              else
+                local_id = Shard.relative_id_for(bind.value, current_source_shard, target_shard)
+                local_id = [] if remove && local_id > Shard::IDS_PER_SHARD
+                bind.instance_variable_set(:@value, local_id)
+                bind.instance_variable_set(:@value_for_database, nil)
               end
-              predicate.right
-            else
-              local_id = Shard.relative_id_for(predicate.right, current_source_shard, target_shard) || predicate.right
-              local_id = [] if remove && local_id.is_a?(Integer) && local_id > Shard::IDS_PER_SHARD
-              local_id
             end
+            predicate.right
+          else
+            local_id = Shard.relative_id_for(predicate.right, current_source_shard, target_shard) || predicate.right
+            local_id = [] if remove && local_id.is_a?(Integer) && local_id > Shard::IDS_PER_SHARD
+            local_id
           end
-          if new_right_value == predicate.right
+        end
+        out_predicate = if new_right_value == predicate.right
+          predicate
+        elsif predicate.right.is_a?(::Arel::Nodes::Casted)
+          if new_right_value == predicate.right.val
             predicate
-          elsif predicate.right.is_a?(::Arel::Nodes::Casted)
-            if new_right_value == predicate.right.val
-              predicate
-            else
-              predicate.class.new(predicate.left, predicate.right.class.new(new_right_value, predicate.right.attribute))
-            end
           else
-            predicate.class.new(predicate.left, new_right_value)
+            predicate.class.new(predicate.left, predicate.right.class.new(new_right_value, predicate.right.attribute))
           end
+        else
+          predicate.class.new(predicate.left, new_right_value)
         end
-        result = [result, binds]
-        result
+        return out_predicate, binds
       end
 
       def transpose_predicate_value(value, current_shard, target_shard, attribute_type, remove_non_local_ids)