switchman 1.5.21 → 2.1.5

data/lib/switchman/test_helper.rb

@@ -1,9 +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)
-        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
@@ -11,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.5.21"
+  VERSION = "2.1.5"
 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,13 +20,18 @@ 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
 
       servers = filter_database_servers_chain.call(servers)
 
-      scope = base_scope.order("database_server_id IS NOT NULL, database_server_id, id")
+      scope = base_scope.order(::Arel.sql("database_server_id IS NOT NULL, database_server_id, id"))
       if servers != DatabaseServer.all
         conditions = ["database_server_id IN (?)", servers.map(&:id)]
         conditions.first << " OR database_server_id IS NULL" if servers.include?(Shard.default.database_server)
@@ -44,7 +49,11 @@ module Switchman
       { parallel: ENV['PARALLEL'].to_i, max_procs: ENV['MAX_PARALLEL_PROCS'] }
     end
 
-    def self.shardify_task(task_name)
+    # categories - an array or proc, to activate as the current shard during the
+    # task. tasks which modify the schema may want to pass all categories in
+    # so that schema updates for non-default tables happen against all shards.
+    # this is handled automatically for the default migration tasks, below.
+    def self.shardify_task(task_name, categories: [:primary])
       old_task = ::Rake::Task[task_name]
       old_actions = old_task.actions.dup
       old_task.actions.clear
@@ -55,27 +64,42 @@ module Switchman
           TestHelper.recreate_persistent_test_shards(dont_create: true)
         end
 
-        ::Shackles.activate(:deploy) do
-          begin
-            Shard.with_each_shard(scope, Shard.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
-                old_actions.each { |action| action.call(*task_args) }
+        ::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
+                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
               end
-              nil
+            rescue => e
+              puts "Exception from #{e.current_shard.id}: #{e.current_shard.description}" if options[:parallel] != 0
+              raise
             end
-          rescue => e
-            puts "Exception from #{e.current_shard.id}: #{e.current_shard.description}" if options[:parallel] != 0
-            raise
           end
         end
       end
     end
 
-    %w{db:migrate db:migrate:up db:migrate:down db:rollback}.each { |task_name| shardify_task(task_name) }
+    %w{db:migrate db:migrate:up db:migrate:down db:rollback}.each do |task_name|
+      shardify_task(task_name, categories: ->{ Shard.categories })
+    end
 
     private
 
@@ -186,64 +210,21 @@ module Switchman
       @filter_database_servers_chain ||= ->(servers) { servers }
     end
   end
-end
 
-module Switchman
   module ActiveRecord
     module PostgreSQLDatabaseTasks
-      if ::Rails.version < '4.2'
-        def structure_dump(filename)
-          set_psql_env
-          search_path = configuration['schema_search_path']
-          unless search_path.blank?
-            search_path = search_path.split(",").map{|search_path_part| "--schema=#{Shellwords.escape(search_path_part.strip)}" }.join(" ")
-            serialized_search_path = ::ActiveRecord::Base.connection.schema_search_path
-          end
-          if configuration['use_qualified_names']
-            shard = Shard.current.name
-            serialized_search_path = shard
-            search_path = "--schema=#{Shellwords.escape(shard)}"
-          end
-
-          command = "pg_dump -s -x -O -f #{Shellwords.escape(filename)} #{search_path} #{Shellwords.escape(configuration['database'])}"
-          raise 'Error dumping database' unless Kernel.system(command)
-
-          File.open(filename, "a") { |f| f << "SET search_path TO #{serialized_search_path};\n\n" }
-        end
-      else
-        def structure_dump(filename)
-          set_psql_env
-          args = ['-s', '-x', '-O', '-f', filename]
-          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
-
-          args << configuration['database']
-          run_cmd('pg_dump', args, 'dumping')
-          File.open(filename, "a") { |f| f << "SET search_path TO #{serialized_search_path};\n\n" }
-        end
-
-        if ::Rails.version < '4.2.5'
-          # These methods are backported from rails 4.2.5 to work with the above
-          def run_cmd(cmd, args, action)
-            fail run_cmd_error(cmd, args, action) unless Kernel.system(cmd, *args)
-          end
-
-          def run_cmd_error(cmd, args, action)
-            msg = "failed to execute:\n"
-            msg << "#{cmd} #{args.join(' ')}\n\n"
-            msg << "Please check the output above for any errors and make sure that `#{cmd}` is installed in your PATH and has proper permissions.\n\n"
-            msg
-          end
-        end
+      def structure_dump(filename, extra_flags=nil)
+        set_psql_env
+        args = ['-s', '-x', '-O', '-f', filename]
+        args.concat(Array(extra_flags)) if extra_flags
+        search_path = configuration['schema_search_path']
+        shard = Shard.current.name
+        serialized_search_path = shard
+        args << "--schema=#{Shellwords.escape(shard)}"
+
+        args << configuration['database']
+        run_cmd('pg_dump', args, 'dumping')
+        File.open(filename, "a") { |f| f << "SET search_path TO #{serialized_search_path};\n\n" }
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: switchman
 version: !ruby/object:Gem::Version
-  version: 1.5.21
+  version: 2.1.5
 platform: ruby
 authors:
 - Cody Cutrer
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-09 00:00:00.000000000 Z
+date: 2021-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -18,82 +18,110 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
-    - - "<="
+        version: '5.1'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 5.0.0.beta3
+        version: '6.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
-    - - "<="
+        version: '5.1'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 5.0.0.beta3
+        version: '6.1'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
-    - - "<="
+        version: '5.1'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 5.0.0.beta3
+        version: '6.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
-    - - "<="
+        version: '5.1'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 5.0.0.beta3
+        version: '6.1'
 - !ruby/object:Gem::Dependency
-  name: shackles
+  name: guardrail
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: open4
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.3.0
 - !ruby/object:Gem::Dependency
-  name: mysql2
+  name: appraisal
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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: 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
@@ -112,44 +140,58 @@ dependencies:
   name: rspec-rails
   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'
+- !ruby/object:Gem::Dependency
+  name: rspec-mocks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: '3.5'
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0.15'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0.15'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
 description: Sharding
 email:
 - cody@instructure.com
@@ -159,9 +201,12 @@ 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
+- db/migrate/20180828183945_add_default_shard_index.rb
+- db/migrate/20180828192111_add_timestamps_to_shards.rb
+- db/migrate/20190114212900_add_unique_name_indexes.rb
 - lib/switchman.rb
 - lib/switchman/action_controller/caching.rb
 - lib/switchman/active_record/abstract_adapter.rb
@@ -174,6 +219,7 @@ files:
 - lib/switchman/active_record/connection_pool.rb
 - lib/switchman/active_record/finder_methods.rb
 - lib/switchman/active_record/log_subscriber.rb
+- lib/switchman/active_record/migration.rb
 - lib/switchman/active_record/model_schema.rb
 - lib/switchman/active_record/persistence.rb
 - lib/switchman/active_record/postgresql_adapter.rb
@@ -189,18 +235,19 @@ files:
 - lib/switchman/active_record/where_clause_factory.rb
 - lib/switchman/active_support/cache.rb
 - lib/switchman/arel.rb
+- lib/switchman/call_super.rb
 - lib/switchman/connection_pool_proxy.rb
 - lib/switchman/database_server.rb
 - lib/switchman/default_shard.rb
 - 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
@@ -218,16 +265,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.0'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.4
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: Rails 4 sharding magic
+summary: Rails sharding magic
 test_files: []