switchman 3.0.12 → 3.0.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a1e19102ef71895fd381f6da856f98b71a44102fbbc08b9738f510c18fe198ed
-  data.tar.gz: acf67d407d42a2d32c617696f66000d358f4fbfbc7b12077e32945c07553853f
+  metadata.gz: d009eac65601ef2687150f472d14824f5d55976102257a381a2b7da4e9859131
+  data.tar.gz: 37f505b1911705b84053e6c2949f544e0975a1ee4ce99df1db33c53ce5c1df46
 SHA512:
-  metadata.gz: 9fad637185836ac6f213b6bd61870fd3390a0f10f66d74fcb0c913977e6c5d394cfee57ceab430800dc0b96a43508f131864b1aad4fb037bea861166fed30dd5
-  data.tar.gz: 6f3592f8ed5a920a9e556fd0a888ac59ce17ca144f85a3d78077f6a3ab036ec385f7e7070b08fd0db9de93fd54f408315837fc97e118229259e43147b017aae7
+  metadata.gz: 05c8ac0cec905fd3922c2271fa2e41dd0ba64890b433cdee1a15ad1255a74827d96fa79bd7f569c51cdd01e92965adc2889e534e63eaa72fae200ece912970d8
+  data.tar.gz: f363145f950678a22893653bc6bfd34230c2e650e68151ebdf65ce7174cc14c79fc1dcfb16a1da4f1f4d264f7eae3a16f8766a27696e4659b58ca924d0ce9513

data/app/models/switchman/shard.rb

@@ -125,8 +125,7 @@ module Switchman
       # * +classes+ - an array of classes to activate
       #    parallel: - true/false to execute in parallel, or an integer of how many
       #                sub-processes. Note that parallel invocation currently uses
-      #                forking, so should be used sparingly because you cannot get
-      #                results back
+      #                forking.
       #    exception: - :ignore, :raise, :defer (wait until the end and raise the first
       #                error), or a proc
       def with_each_shard(*args, parallel: false, exception: :raise, &block)
@@ -159,137 +158,47 @@ module Switchman
             return if database_servers.count.zero?
 
             scopes = database_servers.to_h do |server|
-              [server, server.shards.merge(scope)]
+              [server, scope.merge(server.shards)]
             end
           else
             scopes = scope.group_by(&:database_server)
           end
 
-          exception_pipes = []
-          pids = []
-          out_fds = []
-          err_fds = []
-          pid_to_name_map = {}
-          fd_to_name_map = {}
-          errors = []
-
-          wait_for_output = lambda do
-            ready, = IO.select(out_fds + err_fds)
-            ready.each do |fd|
-              if fd.eof?
-                fd.close
-                out_fds.delete(fd)
-                err_fds.delete(fd)
-                next
-              end
-              line = fd.readline
-              puts "#{fd_to_name_map[fd]}: #{line}"
-            end
-          end
-
-          # only one process; don't bother forking
-          return with_each_shard(scopes.first.last, classes, exception: exception, &block) if scopes.length == 1
-
           # clear connections prior to forking (no more queries will be executed in the parent,
           # and we want them gone so that we don't accidentally use them post-fork doing something
           # silly like dealloc'ing prepared statements)
           ::ActiveRecord::Base.clear_all_connections!
 
-          scopes.each do |server, subscope|
+          parent_process_name = `ps -ocommand= -p#{Process.pid}`.slice(/#{$0}.*/)
+          ret = ::Parallel.map(scopes, in_processes: scopes.length > 1 ? parallel : 0) do |server, subscope|
             name = server.id
-
-            exception_pipe = IO.pipe
-            exception_pipes << exception_pipe
-            pid, io_in, io_out, io_err = Open4.pfork4(lambda do
-              Switchman.config[:on_fork_proc]&.call
-
-              # set a pretty name for the process title, up to 128 characters
-              # (we don't actually know the limit, depending on how the process
-              # was started)
-              # first, simplify the binary name by stripping directories,
-              # then truncate arguments as necessary
-              bin = File.basename($0) # Process.argv0 doesn't work on Ruby 2.5 (https://bugs.ruby-lang.org/issues/15887)
-              max_length = 128 - bin.length - name.length - 3
-              args = ARGV.join(' ')
-              args = args[0..max_length] if max_length >= 0
-              new_title = [bin, args, name].join(' ')
+            # rubocop:disable Style/GlobalStdStream
+            $stdout = Parallel::PrefixingIO.new(name, STDOUT)
+            $stderr = Parallel::PrefixingIO.new(name, STDERR)
+            # rubocop:enable Style/GlobalStdStream
+            begin
+              max_length = 128 - name.length - 3
+              short_parent_name = parent_process_name[0..max_length] if max_length >= 0
+              new_title = [short_parent_name, name].join(' ')
               Process.setproctitle(new_title)
-
+              Switchman.config[:on_fork_proc]&.call
               with_each_shard(subscope, classes, exception: exception, &block)
-              exception_pipe.last.close
-            rescue Exception => e # rubocop:disable Lint/RescueException
-              begin
-                dumped = Marshal.dump(e)
-                dumped = nil if dumped.length > 64 * 1024
-              rescue
-                dumped = nil
-              end
-
-              if dumped.nil?
-                # couldn't dump the exception; create a copy with just
-                # the message and the backtrace
-                e2 = e.class.new(e.message)
-                backtrace = e.backtrace
-                # truncate excessively long backtraces
-                backtrace = backtrace[0...25] + ['...'] + backtrace[-25..] if backtrace.length > 50
-                e2.set_backtrace(backtrace)
-                e2.instance_variable_set(:@active_shards, e.instance_variable_get(:@active_shards))
-                dumped = Marshal.dump(e2)
-              end
-              exception_pipe.last.set_encoding(dumped.encoding)
-              exception_pipe.last.write(dumped)
-              exception_pipe.last.flush
-              exception_pipe.last.close
-              exit! 1
-            end)
-            exception_pipe.last.close
-            pids << pid
-            io_in.close # don't care about writing to stdin
-            out_fds << io_out
-            err_fds << io_err
-            pid_to_name_map[pid] = name
-            fd_to_name_map[io_out] = name
-            fd_to_name_map[io_err] = name
-
-            while pids.count >= parallel
-              while out_fds.count >= parallel
-                # wait for output if we've hit the parallel limit
-                wait_for_output.call
-              end
-              # we've gotten all the output from one fd so wait for its child process to exit
-              found_pid, status = Process.wait2
-              pids.delete(found_pid)
-              errors << pid_to_name_map[found_pid] if status.exitstatus != 0
+            rescue => e
+              logger.error e.full_message
+              Parallel::QuietExceptionWrapper.new(name, ::Parallel::ExceptionWrapper.new(e))
             end
-            # we've gotten all the output from one fd so wait for its child process to exit
-            found_pid, status = Process.wait2
-            pids.delete(found_pid)
-            errors << pid_to_name_map[found_pid] if status.exitstatus != 0
-          end
-
-          wait_for_output.call while out_fds.any? || err_fds.any?
-          pids.each do |pid|
-            _, status = Process.waitpid2(pid)
-            errors << pid_to_name_map[pid] if status.exitstatus != 0
-          end
-
-          # check for an exception; we only re-raise the first one
-          exception_pipes.each do |exception_pipe|
-            serialized_exception = exception_pipe.first.read
-            next if serialized_exception.empty?
-
-            ex = Marshal.load(serialized_exception) # rubocop:disable Security/MarshalLoad
-            raise ex
-          ensure
-            exception_pipe.first.close
-          end
+          end.flatten
 
+          errors = ret.select { |val| val.is_a?(Parallel::QuietExceptionWrapper) }
           unless errors.empty?
+            raise errors.first.exception if errors.length == 1
+
             raise ParallelShardExecError,
-                  "The following subprocesses did not exit cleanly: #{errors.sort.join(', ')}"
+                  "The following database server(s) did not finish processing cleanly: #{errors.map(&:name).sort.join(', ')}",
+                  cause: errors.first.exception
           end
 
-          return
+          return ret
         end
 
         classes ||= []

data/lib/switchman/active_record/database_configurations.rb

@@ -3,6 +3,20 @@
 module Switchman
   module ActiveRecord
     module DatabaseConfigurations
+      # key difference: For each env name, ensure only one writable config is returned
+      # since all should point to the same data, even if multiple are writable
+      # (Picks 'primary' since it is guaranteed to exist and switchman handles activating
+      # deploy through other means)
+      def configs_for(include_replicas: false, name: nil, **)
+        res = super
+        if name && !include_replicas
+          return nil unless name.end_with?('primary')
+        elsif !include_replicas
+          return res.select { |config| config.name.end_with?('primary') }
+        end
+        res
+      end
+
       private
 
       # key difference: assumes a hybrid two-tier structure; each third tier

data/lib/switchman/parallel.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require 'parallel'
+
+module Switchman
+  module Parallel
+    module UndumpableException
+      def initialize(original)
+        super
+        @active_shards = original.instance_variable_get(:@active_shards)
+        current_shard
+      end
+    end
+
+    class QuietExceptionWrapper
+      attr_accessor :name
+
+      def initialize(name, wrapper)
+        @name = name
+        @wrapper = wrapper
+      end
+
+      def exception
+        @wrapper.exception
+      end
+    end
+
+    class PrefixingIO
+      delegate_missing_to :@original_io
+
+      def initialize(prefix, original_io)
+        @prefix = prefix
+        @original_io = original_io
+      end
+
+      def puts(*args)
+        args.flatten.each { |arg| @original_io.puts "#{@prefix}: #{arg}" }
+      end
+    end
+  end
+end
+
+::Parallel::UndumpableException.prepend(::Switchman::Parallel::UndumpableException)

data/lib/switchman/r_spec_helper.rb

@@ -70,7 +70,10 @@ module Switchman
         Shard.default(reload: true)
         puts 'Done!'
 
+        main_pid = Process.pid
         at_exit do
+          next unless main_pid == Process.pid
+
           # preserve rspec's exit status
           status = $!.is_a?(::SystemExit) ? $!.status : nil
           puts 'Tearing down sharding for all specs'

data/lib/switchman/standard_error.rb

@@ -6,13 +6,14 @@ module Switchman
       super
       # These seem to get themselves into a bad state if we try to lookup shards while processing
       return if is_a?(IO::EAGAINWaitReadable)
+
       return if Thread.current[:switchman_error_handler]
 
       begin
         Thread.current[:switchman_error_handler] = true
 
         begin
-          @active_shards = Shard.active_shards if defined?(Shard)
+          @active_shards ||= Shard.active_shards if defined?(Shard)
         rescue
           # If we hit an error really early in boot, activerecord may not be initialized yet
         end

data/lib/switchman/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Switchman
-  VERSION = '3.0.12'
+  VERSION = '3.0.15'
 end

data/lib/switchman.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require 'guard_rail'
-require 'switchman/open4'
+require 'switchman/parallel'
 require 'switchman/engine'
 
 module Switchman

data/lib/tasks/switchman.rake

@@ -1,5 +1,16 @@
 # frozen_string_literal: true
 
+# In rails 7.0+ if you have only 1 db in the env it doesn't try to do explicit activation
+# (and for rails purposes we only have one db per env because each database server is a separate env)
+if Rails.version < '7.0'
+  task_prefix = ::Rake::Task.task_defined?('app:db:migrate') ? 'app:db' : 'db'
+  ::Rake::Task["#{task_prefix}:migrate"].clear_actions.enhance do
+    ::ActiveRecord::Tasks::DatabaseTasks.migrate
+    # Ensure this doesn't blow up when running inside the dummy app
+    Rake::Task["#{task_prefix}:_dump"].invoke
+  end
+end
+
 module Switchman
   module Rake
     def self.filter_database_servers(&block)
@@ -35,9 +46,9 @@ module Switchman
 
       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)
-        scope = scope.where(conditions)
+        database_server_ids = servers.map(&:id)
+        database_server_ids << nil if servers.include?(Shard.default.database_server)
+        scope = scope.where(database_server_id: database_server_ids)
       end
 
       scope = shard_scope(scope, shard) if shard
@@ -50,9 +61,7 @@ module Switchman
     end
 
     # classes - 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.
+    # task.
     def self.shardify_task(task_name, classes: [::ActiveRecord::Base])
       old_task = ::Rake::Task[task_name]
       old_actions = old_task.actions.dup
@@ -77,10 +86,8 @@ module Switchman
               nil
             end
           rescue => e
-            puts "Exception from #{e.current_shard.id}: #{e.current_shard.description}" if options[:parallel] != 0
+            warn "Exception from #{e.current_shard.id}: #{e.current_shard.description}:\n#{e.full_message}" if options[:parallel] != 0
             raise
-
-            # ::ActiveRecord::Base.configurations = old_configurations
           end
         end
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: switchman
 version: !ruby/object:Gem::Version
-  version: 3.0.12
+  version: 3.0.15
 platform: ruby
 authors:
 - Cody Cutrer
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-22 00:00:00.000000000 Z
+date: 2022-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -47,19 +47,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 3.0.0
 - !ruby/object:Gem::Dependency
-  name: open4
+  name: parallel
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: '1.22'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: '1.22'
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
@@ -287,7 +287,7 @@ files:
 - lib/switchman/errors.rb
 - lib/switchman/guard_rail.rb
 - lib/switchman/guard_rail/relation.rb
-- lib/switchman/open4.rb
+- lib/switchman/parallel.rb
 - lib/switchman/r_spec_helper.rb
 - lib/switchman/rails.rb
 - lib/switchman/sharded_instrumenter.rb

data/lib/switchman/open4.rb

@@ -1,80 +0,0 @@
-# frozen_string_literal: true
-
-require 'open4'
-
-# This fixes a bug with exception handling,
-# see https://github.com/ahoward/open4/pull/30
-module Open4
-  def self.do_popen(b = nil, exception_propagation_at = nil, closefds=false, &cmd)
-    pw, pr, pe, ps = IO.pipe, IO.pipe, IO.pipe, IO.pipe
-
-    verbose = $VERBOSE
-    begin
-      $VERBOSE = nil
-
-      cid = fork {
-        if closefds
-          exlist = [0, 1, 2] | [pw,pr,pe,ps].map{|p| [p.first.fileno, p.last.fileno] }.flatten
-          ObjectSpace.each_object(IO){|io|
-            io.close if (not io.closed?) and (not exlist.include? io.fileno) rescue nil
-          }
-        end
-
-        pw.last.close
-        STDIN.reopen pw.first
-        pw.first.close
-
-        pr.first.close
-        STDOUT.reopen pr.last
-        pr.last.close
-
-        pe.first.close
-        STDERR.reopen pe.last
-        pe.last.close
-
-        STDOUT.sync = STDERR.sync = true
-
-        begin
-          cmd.call(ps)
-        rescue Exception => e
-          begin
-            Marshal.dump(e, ps.last)
-            ps.last.flush
-          rescue Errno::EPIPE
-            raise e
-          end
-        ensure
-          ps.last.close unless ps.last.closed?
-        end
-
-        exit!
-      }
-    ensure
-      $VERBOSE = verbose
-    end
-
-    [ pw.first, pr.last, pe.last, ps.last ].each { |fd| fd.close }
-
-    Open4.propagate_exception cid, ps.first if exception_propagation_at == :init
-
-    pw.last.sync = true
-
-    pi = [ pw.last, pr.first, pe.first ]
-
-    begin
-      return [cid, *pi] unless b
-
-      begin
-        b.call(cid, *pi)
-      ensure
-        pi.each { |fd| fd.close unless fd.closed? }
-      end
-
-      Open4.propagate_exception cid, ps.first if exception_propagation_at == :block
-
-      Process.waitpid2(cid).last
-    ensure
-      ps.first.close unless ps.first.closed?
-    end
-  end
-end