switchman 1.13.3 → 2.2.0

data/lib/switchman/engine.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Switchman
   class Engine < ::Rails::Engine
     isolate_namespace Switchman
@@ -87,13 +89,13 @@ module Switchman
         require "switchman/arel"
         require "switchman/call_super"
         require "switchman/rails"
-        require "switchman/shackles/relation"
-        require_dependency "switchman/shard_internal"
+        require "switchman/guard_rail/relation"
+        require_dependency "switchman/shard"
         require "switchman/standard_error"
 
         ::StandardError.include(StandardError)
 
-        include ActiveRecord::Base
+        prepend ActiveRecord::Base
         include ActiveRecord::AttributeMethods
         include ActiveRecord::Persistence
         singleton_class.prepend ActiveRecord::ModelSchema::ClassMethods
@@ -118,15 +120,11 @@ module Switchman
         ::ActiveRecord::ConnectionAdapters::ConnectionHandler.prepend(ActiveRecord::ConnectionHandler)
         ::ActiveRecord::ConnectionAdapters::ConnectionPool.prepend(ActiveRecord::ConnectionPool)
         ::ActiveRecord::ConnectionAdapters::AbstractAdapter.prepend(ActiveRecord::QueryCache)
-        # when we call super in Switchman::ActiveRecord::QueryCache#select_all,
-        # we want it to find the definition from
-        # ActiveRecord::ConnectionAdapters::DatabaseStatements, not
-        # ActiveRecord::ConnectionAdapters::QueryCache
-        ::ActiveRecord::ConnectionAdapters::QueryCache.send(:remove_method, :select_all) if ::Rails.version < '5.0.1'
 
         ::ActiveRecord::LogSubscriber.prepend(ActiveRecord::LogSubscriber)
         ::ActiveRecord::Migration.prepend(ActiveRecord::Migration)
         ::ActiveRecord::Migration::Compatibility::V5_0.prepend(ActiveRecord::Migration::Compatibility::V5_0)
+        ::ActiveRecord::MigrationContext.prepend(ActiveRecord::MigrationContext) if ::Rails.version >= '5.2'
         ::ActiveRecord::Migrator.prepend(ActiveRecord::Migrator)
 
         ::ActiveRecord::Reflection::AbstractReflection.include(ActiveRecord::Reflection::AbstractReflection)
@@ -137,13 +135,14 @@ module Switchman
         ::ActiveRecord::Relation.prepend(ActiveRecord::Calculations)
         ::ActiveRecord::Relation.include(ActiveRecord::FinderMethods)
         ::ActiveRecord::Relation.include(ActiveRecord::QueryMethods)
-        ::ActiveRecord::Relation.prepend(Shackles::Relation)
+        ::ActiveRecord::Relation.prepend(GuardRail::Relation)
         ::ActiveRecord::Relation.prepend(ActiveRecord::Relation)
         ::ActiveRecord::Relation.include(ActiveRecord::SpawnMethods)
         ::ActiveRecord::Relation.include(CallSuper)
 
         ::ActiveRecord::Relation::WhereClauseFactory.prepend(ActiveRecord::WhereClauseFactory)
         ::ActiveRecord::PredicateBuilder::AssociationQueryValue.prepend(ActiveRecord::PredicateBuilder::AssociationQueryValue)
+        ::ActiveRecord::PredicateBuilder::PolymorphicArrayValue.prepend(ActiveRecord::PredicateBuilder::AssociationQueryValue)
         ::ActiveRecord::TypeCaster::Map.include(ActiveRecord::TypeCaster::Map)
         ::ActiveRecord::TypeCaster::Connection.include(ActiveRecord::TypeCaster::Connection)
 
@@ -154,8 +153,8 @@ module Switchman
       end
     end
 
-    def self.foreign_key_check(name, type, options)
-      if name.to_s =~ /_id\z/ && type.to_s == 'integer' && options[:limit].to_i < 8
+    def self.foreign_key_check(name, type, limit: nil)
+      if name.to_s =~ /_id\z/ && type.to_s == 'integer' && limit.to_i < 8
         puts "WARNING: All foreign keys need to be 8-byte integers. #{name} looks like a foreign key. If so, please add the option: `:limit => 8`"
       end
     end
@@ -173,6 +172,12 @@ module Switchman
           require "switchman/active_record/postgresql_adapter"
           ::ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.prepend(ActiveRecord::PostgreSQLAdapter)
         end
+
+        # If Switchman::Shard wasn't loaded as of when ActiveRecord::Base initialized
+        # establish a connection here instead
+        if !Shard.instance_variable_get(:@default)
+          ::ActiveRecord::Base.establish_connection
+        end
       end
     end
 
@@ -183,15 +188,15 @@ module Switchman
       end
     end
 
-    initializer 'switchman.extend_shackles', :before => "switchman.extend_ar" do
+    initializer 'switchman.extend_guard_rail', :before => "switchman.extend_ar" do
       ::ActiveSupport.on_load(:active_record) do
-        require "switchman/shackles"
+        require "switchman/guard_rail"
 
-        ::Shackles.singleton_class.prepend(Shackles::ClassMethods)
+        ::GuardRail.singleton_class.prepend(GuardRail::ClassMethods)
       end
     end
 
-    initializer 'switchman.extend_controller', :after => "shackles.extend_ar" do
+    initializer 'switchman.extend_controller', :after => "guard_rail.extend_ar" do
       ::ActiveSupport.on_load(:action_controller) do
         require "switchman/action_controller/caching"
 

data/lib/switchman/environment.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'etc'
 
 module Switchman

data/lib/switchman/errors.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Switchman
   class NonExistentShardError < RuntimeError; end
   class ParallelShardExecError < RuntimeError; end

data/lib/switchman/{shackles → guard_rail}/relation.rb

@@ -1,11 +1,13 @@
+# frozen_string_literal: true
+
 module Switchman
-  module Shackles
+  module GuardRail
     module Relation
       def exec_queries(*args)
         if self.lock_value
           db = Shard.current(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 }
           end
         end
         super
@@ -15,8 +17,8 @@ module Switchman
         class_eval <<-RUBY, __FILE__, __LINE__ + 1
           def #{method}(*args)
             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

data/lib/switchman/{shackles.rb → guard_rail.rb}

@@ -1,17 +1,19 @@
+# frozen_string_literal: true
+
 module Switchman
-  module Shackles
+  module GuardRail
     module ClassMethods
       def self.prepended(klass)
         klass.send(:remove_method, :ensure_handler)
       end
 
       # drops the save_handler and ensure_handler calls from the vanilla
-      # Shackles' implementation.
+      # GuardRail' implementation.
       def activate!(environment)
-        environment ||= :master
+        environment ||= :primary
         activated_environments << environment
         old_environment = self.environment
-        Thread.current[:shackles_environment] = environment
+        Thread.current[:guard_rail_environment] = environment
         old_environment
       end
 

data/lib/switchman/open4.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'open4'
 
 # This fixes a bug with exception handling,

data/lib/switchman/r_spec_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "switchman/test_helper"
 
 module Switchman
@@ -65,7 +67,7 @@ module Switchman
             (@@shard3.drop_database if @@shard3) rescue nil
             @@shard1 = @@shard2 = @@shard3 = nil
             Shard.delete_all
-            Shard.default(true)
+            Shard.default(reload: true)
             next
           end
         end
@@ -73,7 +75,7 @@ module Switchman
         # in the db before then
         Shard.delete_all
         Switchman.cache.delete("default_shard")
-        Shard.default(true)
+        Shard.default(reload: true)
         puts "Done!"
 
         at_exit do
@@ -102,7 +104,7 @@ module Switchman
         dup.id = @@default_shard.id
         dup.save!
         Switchman.cache.delete("default_shard")
-        Shard.default(true)
+        Shard.default(reload: true)
         dup = @@shard1.dup
         dup.id = @@shard1.id
         dup.save!
@@ -121,8 +123,8 @@ module Switchman
       klass.before do
         raise "Sharding did not set up correctly" if @@sharding_failed
         Shard.clear_cache
-        if ::Rails.version >= '5.1' ? use_transactional_tests : (use_transactional_tests || use_transactional_fixtures)
-          Shard.default(true)
+        if use_transactional_tests
+          Shard.default(reload: true)
           @shard1 = Shard.find(@shard1.id)
           @shard2 = Shard.find(@shard2.id)
           shards = [@shard2]
@@ -137,7 +139,7 @@ module Switchman
 
       klass.after do
         next if @@sharding_failed
-        if ::Rails.version >= '5.1' ? use_transactional_tests : (use_transactional_tests || use_transactional_fixtures)
+        if use_transactional_tests
           shards = [@shard2]
           shards << @shard1 unless @shard1.database_server == Shard.default.database_server
           shards.each do |shard|
@@ -151,7 +153,7 @@ module Switchman
       klass.after(:all) do
         Shard.connection.update("TRUNCATE #{Shard.quoted_table_name} CASCADE")
         Switchman.cache.delete("default_shard")
-        Shard.default(true)
+        Shard.default(reload: true)
       end
     end
   end

data/lib/switchman/rails.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Switchman::Rails
   module ClassMethods
     def self.prepended(klass)

data/lib/switchman/schema_cache.rb

@@ -1,16 +1,26 @@
+# frozen_string_literal: true
+
 module Switchman
   class SchemaCache < ::ActiveRecord::ConnectionAdapters::SchemaCache
     delegate :connection, to: :pool
     attr_reader :pool
 
+    SHARED_IVS = %i{@columns @columns_hash @primary_keys @data_sources @indexes}.freeze
+
     def initialize(pool)
       @pool = pool
       super(nil)
     end
 
     def copy_values(other_cache)
+      SHARED_IVS.each do |iv|
+        instance_variable_get(iv).replace(other_cache.instance_variable_get(iv))
+      end
+    end
+
+    def copy_references(other_cache)
       # use the same cached values but still fall back to the correct pool
-      [:@columns, :@columns_hash, :@primary_keys, :@data_sources].each do |iv|
+      SHARED_IVS.each do |iv|
         instance_variable_set(iv, other_cache.instance_variable_get(iv))
       end
     end

data/lib/switchman/sharded_instrumenter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Switchman
   class ShardedInstrumenter < ::SimpleDelegator
     def initialize(instrumenter, shard_host)
@@ -14,7 +16,7 @@ module Switchman
         payload[:shard] = {
           database_server_id: shard.database_server.id,
           id: shard.id,
-          env: shard.database_server.shackles_environment
+          env: shard.database_server.guard_rail_environment
         }
       end
       super name, payload

data/lib/switchman/standard_error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Switchman
   module StandardError
     def initialize(*args)
@@ -6,7 +8,7 @@ module Switchman
     end
 
     def current_shard(category = :primary)
-      @active_shards[category] || Shard.default
+      @active_shards&.[](category) || Shard.default
     end
   end
 end

data/lib/switchman/test_helper.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 module Switchman
   module TestHelper
     class << self
       def recreate_persistent_test_shards(dont_create: false)
         # recreate the default shard (it got buhleted)
-        ::Shackles.activate(:deploy) { Switchman.cache.clear }
-        if Shard.default(true).is_a?(DefaultShard)
+        ::GuardRail.activate(:deploy) { Switchman.cache.clear }
+        if Shard.default(reload: true).is_a?(DefaultShard)
           begin
             Shard.create!(default: true)
           rescue
@@ -12,17 +14,11 @@ module Switchman
             # database doesn't exist yet, presumably cause we're creating it right now
             return [nil, nil]
           end
-          Shard.default(true)
+          Shard.default(reload: true)
         end
 
-        # can't auto-create a new shard on the default shard's db server if the
-        # default shard is split across multiple db servers
-        if ::ActiveRecord::Base.connection_handler.connection_pool_list.length > 1
-          server1 = DatabaseServer.create(Shard.default.database_server.config)
-        else
-          server1 = Shard.default.database_server
-        end
-        server2 = DatabaseServer.create(Shard.default.database_server.config)
+        server1 = Shard.default.database_server
+        server2 = DatabaseServer.create(Shard.default.database_server.config.merge(server2: true))
 
         if server1 == Shard.default.database_server && server1.config[:shard1] && server1.config[:shard2]
           # look for the shards in the db already

data/lib/switchman/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Switchman
-  VERSION = "1.13.3"
+  VERSION = "2.2.0"
 end

data/lib/switchman.rb

@@ -1,4 +1,6 @@
-require "shackles"
+# frozen_string_literal: true
+
+require "guard_rail"
 require "switchman/open4"
 require "switchman/engine"
 
@@ -15,4 +17,6 @@ module Switchman
   def self.cache=(cache)
     @cache = cache
   end
+
+  class OrderOnMultiShardQuery < RuntimeError; end
 end

data/lib/tasks/switchman.rake

@@ -20,7 +20,12 @@ module Switchman
         open = servers.delete('open')
 
         servers = servers.map { |server| DatabaseServer.find(server) }.compact
-        servers.concat(DatabaseServer.all.select { |server| server.config[:open] }) if open
+        if open
+          open_servers = DatabaseServer.all.select { |server| server.config[:open] }
+          servers.concat(open_servers)
+          servers << DatabaseServer.find(nil) if open_servers.empty?
+          servers.uniq!
+        end
         servers = DatabaseServer.all - servers if negative
       end
 
@@ -41,6 +46,7 @@ module Switchman
     end
 
     def self.options
+      # we still pass through both of these options for back-compat purposes
       { parallel: ENV['PARALLEL'].to_i, max_procs: ENV['MAX_PARALLEL_PROCS'] }
     end
 
@@ -59,16 +65,26 @@ module Switchman
           TestHelper.recreate_persistent_test_shards(dont_create: true)
         end
 
-        ::Shackles.activate(:deploy) do
-          Shard.default.database_server.unshackle do
+        ::GuardRail.activate(:deploy) do
+          Shard.default.database_server.unguard do
             begin
               categories = categories.call if categories.respond_to?(:call)
               Shard.with_each_shard(scope, categories, options) do
                 shard = Shard.current
                 puts "#{shard.id}: #{shard.description}"
                 ::ActiveRecord::Base.connection_pool.spec.config[:shard_name] = Shard.current.name
-                ::ActiveRecord::Base.configurations[::Rails.env] = ::ActiveRecord::Base.connection_pool.spec.config.stringify_keys
-                shard.database_server.unshackle do
+                if ::Rails.version < '6.0'
+                  ::ActiveRecord::Base.configurations[::Rails.env] = ::ActiveRecord::Base.connection_pool.spec.config.stringify_keys
+                else
+                  # Adopted from the deprecated code that currently lives in rails proper
+                  remaining_configs = ::ActiveRecord::Base.configurations.configurations.reject { |db_config| db_config.env_name == ::Rails.env }
+                  new_config = ::ActiveRecord::DatabaseConfigurations.new(::Rails.env =>
+                    ::ActiveRecord::Base.connection_pool.spec.config.stringify_keys).configurations
+                  new_configs = remaining_configs + new_config
+      
+                  ::ActiveRecord::Base.configurations = new_configs
+                end
+                shard.database_server.unguard do
                   old_actions.each { |action| action.call(*task_args) }
                 end
                 nil
@@ -195,9 +211,7 @@ module Switchman
       @filter_database_servers_chain ||= ->(servers) { servers }
     end
   end
-end
 
-module Switchman
   module ActiveRecord
     module PostgreSQLDatabaseTasks
       def structure_dump(filename, extra_flags=nil)
@@ -205,16 +219,9 @@ module Switchman
         args = ['-s', '-x', '-O', '-f', filename]
         args.concat(Array(extra_flags)) if extra_flags
         search_path = configuration['schema_search_path']
-        if configuration['use_qualified_names']
-          shard = Shard.current.name
-          serialized_search_path = shard
-          args << "--schema=#{Shellwords.escape(shard)}"
-        elsif !search_path.blank?
-          args << search_path.split(',').map do |part|
-            "--schema=#{part.strip}"
-          end.join(' ')
-          serialized_search_path = connection.schema_search_path
-        end
+        shard = Shard.current.name
+        serialized_search_path = shard
+        args << "--schema=#{Shellwords.escape(shard)}"
 
         args << configuration['database']
         run_cmd('pg_dump', args, 'dumping')

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: switchman
 version: !ruby/object:Gem::Version
-  version: 1.13.3
+  version: 2.2.0
 platform: ruby
 authors:
 - Cody Cutrer
 - James Williams
 - Jacob Fugal
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-05-14 00:00:00.000000000 Z
+date: 2021-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -18,54 +18,54 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.3'
+        version: '6.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.3'
+        version: '6.1'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.3'
+        version: '6.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.3'
+        version: '6.1'
 - !ruby/object:Gem::Dependency
-  name: shackles
+  name: guardrail
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: open4
   requirement: !ruby/object:Gem::Requirement
@@ -108,6 +108,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement
@@ -126,16 +140,30 @@ dependencies:
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.5.2
+        version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: rspec-mocks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.5.2
+        version: '3.5'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -173,7 +201,6 @@ extra_rdoc_files: []
 files:
 - Rakefile
 - app/models/switchman/shard.rb
-- app/models/switchman/shard_internal.rb
 - db/migrate/20130328212039_create_switchman_shards.rb
 - db/migrate/20130328224244_create_default_shard.rb
 - db/migrate/20161206323434_add_back_default_string_limits_switchman.rb
@@ -215,12 +242,12 @@ files:
 - lib/switchman/engine.rb
 - lib/switchman/environment.rb
 - lib/switchman/errors.rb
+- lib/switchman/guard_rail.rb
+- lib/switchman/guard_rail/relation.rb
 - lib/switchman/open4.rb
 - lib/switchman/r_spec_helper.rb
 - lib/switchman/rails.rb
 - lib/switchman/schema_cache.rb
-- lib/switchman/shackles.rb
-- lib/switchman/shackles/relation.rb
 - lib/switchman/sharded_instrumenter.rb
 - lib/switchman/standard_error.rb
 - lib/switchman/test_helper.rb
@@ -230,7 +257,7 @@ homepage: http://www.instructure.com/
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -238,15 +265,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.2.24
+signing_key:
 specification_version: 4
-summary: Rails 4 sharding magic
+summary: Rails sharding magic
 test_files: []