switchman 1.5.0 → 1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 41ffbbe209d050d84b5d6d1f62acf5a98af608d6
-  data.tar.gz: 96817a4959ae03d32f11c79fe13774d2d216b8fd
+  metadata.gz: 0c842dbbf4a93a109228a74c3201eb30595cda74
+  data.tar.gz: e817d143e3f256daddee6f7d69b86435735403ca
 SHA512:
-  metadata.gz: 9688a43e68e5b147d051b12e9e5c12743af0b1515ae2cb19ccee552190244d0eedda44714314340b48397deac1f881ef289be2b7c9b181fd71c49a3d1cee0cf0
-  data.tar.gz: c5a3e688a58a8148298ca2538005f52235c0285f8e2d4dc2c5f77c8324f2786718fc6beafce08bd6e4f079bd3b91e2ced9a4a060aa1b6b4d3a57d70a190eb70a
+  metadata.gz: 8bdaa4e4453341ce93909598520ef3dfdaa36c4767e40424d37c3db4a545e08cf9486d52278c319c590182222b0d43a6c5eab224ced77ef889957f7f2da98252
+  data.tar.gz: 1ef120e99fba7d3e63107254c31afa36b13492f39ac37b4998739baf944842da374bda2584cba3c757c7207e51fb61ce0657cf1617c05eef805e38997e0fb497

data/app/models/switchman/shard.rb

@@ -1,653 +1,11 @@
-require 'switchman/database_server'
-require 'switchman/default_shard'
-require 'switchman/environment'
-
-module Switchman
-  class Shard < ::ActiveRecord::Base
-    # ten trillion possible ids per shard. yup.
-    IDS_PER_SHARD = 10_000_000_000_000
-
-    CATEGORIES =
-      {
-          # special cased to mean all other models
-          :default => nil,
-          # special cased to not allow activating a shard other than the default
-          :unsharded => [Shard]
-      }
-    private_constant :CATEGORIES
-    @shard_category = :unsharded
-
-    if defined?(::ProtectedAttributes)
-      attr_accessible :default, :name, :database_server
-    end
-
-    # only allow one default
-    validates_uniqueness_of :default, :if => lambda { |s| s.default? }
-
-    after_save :clear_cache
-
-    scope :primary, -> { where(name: nil).order(:database_server_id, :id).distinct_on(:database_server_id) }
-
-    class << self
-      def categories
-        CATEGORIES.keys
-      end
-
-      def default(reload_deprecated = false, reload: false, with_fallback: false)
-        reload = reload_deprecated if reload_deprecated
-        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
-          # is up and running everywhere else).  This includes for looking up the
-          # default shard itself. This also needs to be a local so that this method
-          # can be re-entrant
-          default = DefaultShard.instance
-
-          # if we already have a default shard in place, and the caller wants
-          # to use it as a fallback, use that instead of the dummy instance
-          if with_fallback && @default
-            default = @default
-          end
-
-          # the first time we need a dummy dummy for re-entrancy to avoid looping on ourselves
-          @default ||= default
-          # forget our current shard activations - it might have "another" default shard serialized there
-          active_shards.clear
-
-          # Now find the actual record, if it exists; rescue the fake default if the table doesn't exist
-          @default = begin
-            Shard.where(default: true).first || default
-          rescue
-            default
-          end
-          activate!(:default => @default)
-        end
-        @default
-      end
-
-      def current(category = :default)
-        active_shards[category] || Shard.default
-      end
-
-      def activate(shards)
-        old_shards = activate!(shards)
-        yield
-      ensure
-        active_shards.merge!(old_shards) if old_shards
-      end
-
-      def activate!(shards)
-        old_shards = nil
-        currently_active_shards = active_shards
-        shards.each do |category, shard|
-          next if category == :unsharded
-          unless currently_active_shards[category] == shard
-            old_shards ||= {}
-            old_shards[category] = currently_active_shards[category]
-            currently_active_shards[category] = shard
-          end
-        end
-        old_shards
-      end
-
-      def lookup(id)
-        id_i = id.to_i
-        return current if id_i == current.id || id == 'self'
-        return default if id_i == default.id || id.nil? || id == 'default'
-        id = id_i
-        raise ArgumentError if id == 0
-
-        unless cached_shards.has_key?(id)
-          cached_shards[id] = Shard.default.activate do
-            # can't simply cache the AR object since Shard has a custom serializer
-            # that calls this method
-            attributes = Switchman.cache.fetch(['shard', id].join('/')) do
-              shard = find_by_id(id)
-              if shard
-                attributes = shard.attributes
-                if ::Rails.version < '4.2'
-                  attributes.each_key do |key|
-                    attributes[key] = attributes[key].unserialize if attributes[key].is_a?(::ActiveRecord::AttributeMethods::Serialization::Attribute)
-                  end
-                end
-                attributes
-              else
-                :nil
-              end
-            end
-            if attributes == :nil
-              nil
-            else
-              shard = Shard.new
-              attributes.each do |attr, value|
-                shard.send(:"#{attr}=", value)
-              end
-              shard.instance_variable_set(:@new_record, false)
-              # connection info doesn't exist in database.yml;
-              # pretend the shard doesn't exist either
-              shard = nil unless shard.database_server
-              shard
-            end
-          end
-        end
-        cached_shards[id]
-      end
-
-      def clear_cache
-        cached_shards.clear
-      end
-
-      # ==== Parameters
-      #
-      # * +shards+ - an array or relation of Shards to iterate over
-      # * +categories+ - an array of categories to activate
-      # * +options+ -
-      #    :parallel - true/false to execute in parallel, or a integer of how many
-      #                sub-processes per database server. Note that parallel
-      #                invocation currently uses forking, so should be used sparingly
-      #                because errors are not raised, and you cannot get results back
-      #    :exception - :ignore, :raise, :defer (wait until the end and raise the first
-      #                error), or a proc
-      def with_each_shard(*args)
-        raise ArgumentError, "wrong number of arguments (#{args.length} for 0...3)" if args.length > 3
-
-        unless default.is_a?(Shard)
-          return Array.wrap(yield)
-        end
-
-        options = args.extract_options!
-        if args.length == 1
-          if Array === args.first && args.first.first.is_a?(Symbol)
-            categories = args.first
-          else
-            scope = args.first
-          end
-        else
-          scope, categories = args
-        end
-
-        parallel = case options[:parallel]
-                     when true
-                       1
-                     when false, nil
-                       0
-                     else
-                       options[:parallel]
-                   end
-        options.delete(:parallel)
-
-        scope ||= Shard.all
-        if ::ActiveRecord::Relation === scope && scope.order_values.empty?
-          scope = scope.order("database_server_id IS NOT NULL, database_server_id, id")
-        end
-
-        if parallel > 0
-          max_procs = determine_max_procs(options.delete(:max_procs), parallel)
-          if ::ActiveRecord::Relation === scope
-            # still need a post-uniq, cause the default database server could be NULL or Rails.env in the db
-            database_servers = scope.reorder('database_server_id').select(:database_server_id).uniq.
-                map(&:database_server).compact.uniq
-            parallel = [(max_procs.to_f / database_servers.count).ceil, parallel].min if max_procs
-
-            scopes = Hash[database_servers.map do |server|
-              server_scope = server.shards.merge(scope)
-              if parallel == 1
-                subscopes = [server_scope]
-              else
-                subscopes = []
-                total = server_scope.count
-                ranges = []
-                server_scope.find_ids_in_ranges(:batch_size => (total.to_f / parallel).ceil) do |min, max|
-                  ranges << [min, max]
-                end
-                # create a half-open range on the last one
-                ranges.last[1] = nil
-                ranges.each do |min, max|
-                  subscope = server_scope.where("id>=?", min)
-                  subscope = subscope.where("id<=?", max) if max
-                  subscopes << subscope
-                end
-              end
-              [server, subscopes]
-            end]
-          else
-            scopes = scope.group_by(&:database_server)
-            if parallel > 1
-              parallel = [(max_procs.to_f / scopes.count).ceil, parallel].min if max_procs
-              scopes = Hash[scopes.map do |(server, shards)|
-                [server, shards.in_groups(parallel, false).compact]
-              end]
-            end
-          end
-
-          fd_to_name_map = {}
-          out_fds = []
-          err_fds = []
-          pids = []
-
-          wait_for_output = lambda do |out_fds, err_fds, fd_to_name_map|
-            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
-
-          exception_pipe = IO.pipe
-          scopes.each do |server, subscopes|
-            if !(::ActiveRecord::Relation === subscopes.first) && subscopes.first.class != Array
-              subscopes = [subscopes]
-            end
-            # only one process; don't bother forking
-            if scopes.length == 1 && subscopes.length == 1
-              exception_pipe.first.close
-              exception_pipe.last.close
-              return with_each_shard(subscopes.first, categories, options) { yield }
-            end
-
-            subscopes.each_with_index do |subscope, idx|
-              if subscopes.length > 1
-                name = "#{server.id} #{idx + 1}"
-              else
-                name = server.id
-              end
-
-              details = Open4.pfork4(lambda do
-                begin
-                  ::ActiveRecord::Base.clear_all_connections!
-                  Switchman.config[:on_fork_proc].try(:call)
-                  $0 = [$0, ARGV, name].flatten.join(' ')
-                  with_each_shard(subscope, categories, options) { yield }
-                rescue Exception => e
-                  exception_pipe.last.write(Marshal.dump(e))
-                  exception_pipe.last.flush
-                  exit 1
-                end
-              end)
-              # don't care about writing to stdin
-              details[1].close
-              out_fds << details[2]
-              err_fds << details[3]
-              pids << details[0]
-              fd_to_name_map[details[2]] = name
-              fd_to_name_map[details[3]] = name
-
-              while max_procs && pids.count >= max_procs
-                while max_procs && out_fds.count >= max_procs
-                  # wait for output if we've hit the max_procs limit
-                  wait_for_output.call(out_fds, err_fds, fd_to_name_map)
-                end
-                pids.delete(Process.wait) # we've gotten all the output from one fd so wait for its child process to exit
-              end
-            end
-          end
-
-          exception_pipe.last.close
-
-          while out_fds.any? || err_fds.any?
-            wait_for_output.call(out_fds, err_fds, fd_to_name_map)
-          end
-          pids.each { |pid| Process.waitpid2(pid) }
-
-          # I'm not sure why, but we have to do this
-          ::ActiveRecord::Base.clear_all_connections!
-          # check for an exception; we only re-raise the first one
-          # (all the sub-processes shared the same pipe, so we only
-          # have to check the one)
-          begin
-            exception = Marshal.load exception_pipe.first
-            raise exception
-          rescue EOFError
-            # No exceptions
-          ensure
-            exception_pipe.first.close
-          end
-          return
-        end
-
-        categories ||= []
-
-        previous_shard = nil
-        close_connections_if_needed = lambda do |shard|
-          # prune the prior connection unless it happened to be the same
-          if previous_shard && shard != previous_shard &&
-            (shard.database_server != previous_shard.database_server || !previous_shard.database_server.shareable?)
-            previous_shard.activate do
-              ::Shackles.activated_environments.each do |env|
-                ::Shackles.activate(env) do
-                  if ::ActiveRecord::Base.connected? && ::ActiveRecord::Base.connection.open_transactions == 0
-                    ::ActiveRecord::Base.connection_pool.current_pool.disconnect!
-                  end
-                end
-              end
-            end
-          end
-        end
-
-        result = []
-        exception = nil
-        scope.each do |shard|
-          # shard references a database server that isn't configured in this environment
-          next unless shard.database_server
-          close_connections_if_needed.call(shard)
-          shard.activate(*categories) do
-            begin
-              result.concat Array.wrap(yield)
-            rescue
-              case options[:exception]
-              when :ignore
-              when :defer
-                exception ||= $!
-              when Proc
-                options[:exception].call
-              when :raise
-                raise
-              else
-                raise
-              end
-            end
-          end
-          previous_shard = shard
-        end
-        close_connections_if_needed.call(Shard.current)
-        raise exception if exception
-        result
-      end
-
-      def partition_by_shard(array, partition_proc = nil)
-        shard_arrays = {}
-        array.each do |object|
-          partition_object = partition_proc ? partition_proc.call(object) : object
-          case partition_object
-            when Shard
-              shard = partition_object
-            when ::ActiveRecord::Base
-              if partition_object.respond_to?(:associated_shards)
-                partition_object.associated_shards.each do |a_shard|
-                  shard_arrays[a_shard] ||= []
-                  shard_arrays[a_shard] << object
-                end
-                next
-              else
-                shard = partition_object.shard
-              end
-            when Integer, /^\d+$/, /^(\d+)~(\d+)$/
-              local_id, shard = Shard.local_id_for(partition_object)
-              local_id ||= partition_object
-              object = local_id if !partition_proc
-          end
-          shard ||= Shard.current
-          shard_arrays[shard] ||= []
-          shard_arrays[shard] << object
-        end
-        # TODO: use with_each_shard (or vice versa) to get
-        # connection management and parallelism benefits
-        shard_arrays.inject([]) do |results, (shard, objects)|
-          results.concat shard.activate { Array.wrap(yield objects) }
-        end
-      end
-
-      # converts an AR object, integral id, string id, or string short-global-id to a
-      # integral id. nil if it can't be interpreted
-      def integral_id_for(any_id)
-        if ::Rails.version >= '4.2' && any_id.is_a?(::Arel::Nodes::Casted)
-          any_id = any_id.val
-        end
-
-        case any_id
-        when ::ActiveRecord::Base
-          any_id.id
-        when /^(\d+)~(\d+)$/
-          local_id = $2.to_i
-          # doesn't make sense to have a double-global id
-          return nil if local_id > IDS_PER_SHARD
-          $1.to_i * IDS_PER_SHARD + local_id
-        when Integer, /^\d+$/
-          any_id.to_i
-        else
-          nil
-        end
-      end
-
-      # takes an id-ish, and returns a local id and the shard it's
-      # local to. [nil, nil] if it can't be interpreted. [id, nil]
-      # if it's already a local ID
-      NIL_NIL_ID = [nil, nil].freeze
-      def local_id_for(any_id)
-        id = integral_id_for(any_id)
-        return NIL_NIL_ID unless id
-        if id < IDS_PER_SHARD
-          [id, nil]
-        elsif shard = lookup(id / IDS_PER_SHARD)
-          [id % IDS_PER_SHARD, shard]
-        else
-          NIL_NIL_ID
-        end
-      end
-
-      # takes an id-ish, and returns an integral id relative to
-      # target_shard. returns any_id itself if it can't be interpreted
-      def relative_id_for(any_id, source_shard, target_shard)
-        local_id, shard = local_id_for(any_id)
-        return any_id unless local_id
-        shard ||= source_shard
-        return local_id if shard == target_shard
-        shard.global_id_for(local_id)
-      end
-
-      # takes an id-ish, and returns a shortened global
-      # string id if global, and itself if local.
-      # returns any_id itself if it can't be interpreted
-      def short_id_for(any_id)
-        local_id, shard = local_id_for(any_id)
-        return any_id unless local_id
-        return local_id unless shard
-        "#{shard.id}~#{local_id}"
-      end
-
-      # takes an id-ish, and returns an integral global id.
-      # returns nil if it can't be interpreted
-      def global_id_for(any_id, source_shard = nil)
-        id = integral_id_for(any_id)
-        return any_id unless id
-        if id >= IDS_PER_SHARD
-          id
-        else
-          source_shard ||= Shard.current
-          source_shard.global_id_for(id)
-        end
-      end
-
-      def shard_for(any_id, source_shard = nil)
-        _, shard = local_id_for(any_id)
-        shard || source_shard || Shard.current
-      end
-
-      # given the provided option, determines whether we need to (and whether
-      # it's possible) to determine a reasonable default.
-      def determine_max_procs(max_procs_input, parallel_input=2)
-        max_procs = nil
-        if max_procs_input
-          max_procs = max_procs_input.to_i
-          max_procs = nil if max_procs == 0
-        else
-          return 1 if parallel_input.nil? || parallel_input < 1
-          cpus = Environment.cpu_count
-          if cpus && cpus > 0
-            max_procs = cpus * parallel_input
-          end
-        end
-
-        return max_procs
-      end
-
-      private
-      # in-process caching
-      def cached_shards
-        @cached_shards ||= {}.compare_by_identity
-      end
-
-      def add_to_cache(shard)
-        cached_shards[shard.id] = shard
-      end
-
-      def remove_from_cache(shard)
-        cached_shards.delete(shard.id)
-      end
-
-      def active_shards
-        Thread.current[:active_shards] ||= {}.compare_by_identity
-      end
-    end
-
-    def name
-      unless instance_variable_defined?(:@name)
-        # protect against re-entrancy
-        @name = nil
-        @name = read_attribute(:name) || default_name
-      end
-      @name
-    end
-
-    def name=(name)
-      write_attribute(:name, @name = name)
-      remove_instance_variable(:@name) if name == nil
-    end
-
-    def database_server
-      @database_server ||= DatabaseServer.find(self.database_server_id)
-    end
-
-    def database_server=(database_server)
-      self.database_server_id = database_server.id
-      @database_server = database_server
-    end
-
-    def primary?
-      self == database_server.primary_shard
-    end
-
-    def description
-      [database_server.id, name].compact.join(':')
-    end
-
-    # Shards are always on the default shard
-    def shard
-      Shard.default
-    end
-
-    def activate(*categories)
-      shards = hashify_categories(categories)
-      Shard.activate(shards) do
-        yield
-      end
-    end
-
-    # for use from console ONLY
-    def activate!(*categories)
-      shards = hashify_categories(categories)
-      Shard.activate!(shards)
-      nil
-    end
-
-    # custom serialization, since shard is self-referential
-    def _dump(depth)
-      self.id.to_s
-    end
-
-    def self._load(str)
-      lookup(str.to_i)
-    end
-
-    def drop_database
-      raise("Cannot drop the database of the default shard") if self.default?
-      return unless read_attribute(:name)
-
-      begin
-        adapter = self.database_server.config[:adapter]
-        sharding_config = Switchman.config || {}
-        drop_statement = sharding_config[adapter].try(:[], :drop_statement)
-        drop_statement ||= sharding_config[:drop_statement]
-        if drop_statement
-          drop_statement = Array(drop_statement).dup.
-              map { |statement| statement.gsub('%{name}', self.name) }
-        end
-
-        case adapter
-          when 'mysql', 'mysql2'
-            self.activate do
-              ::Shackles.activate(:deploy) do
-                drop_statement ||= "DROP DATABASE #{self.name}"
-                Array(drop_statement).each do |stmt|
-                  ::ActiveRecord::Base.connection.execute(stmt)
-                end
-              end
-            end
-          when 'postgresql'
-            self.activate do
-              ::Shackles.activate(:deploy) do
-                # Shut up, Postgres!
-                conn = ::ActiveRecord::Base.connection
-                old_proc = conn.raw_connection.set_notice_processor {}
-                begin
-                  drop_statement ||= "DROP SCHEMA #{self.name} CASCADE"
-                  Array(drop_statement).each do |stmt|
-                    ::ActiveRecord::Base.connection.execute(stmt)
-                  end
-                ensure
-                  conn.raw_connection.set_notice_processor(&old_proc) if old_proc
-                end
-              end
-            end
-          when 'sqlite3'
-            File.delete(self.name) unless self.name == ':memory:'
-        end
-      rescue
-        logger.info "Drop failed: #{$!}"
-      end
-    end
-
-    # takes an id local to this shard, and returns a global id
-    def global_id_for(local_id)
-      return nil unless local_id
-      local_id + self.id * IDS_PER_SHARD
-    end
-
-    # skip global_id.hash
-    def hash
-      id.hash
-    end
-
-    def destroy
-      raise("Cannot destroy the default shard") if self.default?
-      super
-    end
-
-    private
-
-    def clear_cache
-      Shard.default.activate do
-        Switchman.cache.delete(['shard', id].join('/'))
-      end
-    end
-
-    def default_name
-      database_server.shard_name(self)
-    end
-
-    def hashify_categories(categories)
-      if categories.empty?
-        { :default => self }
-      else
-        categories.inject({}) { |h, category| h[category] = self; h }
-      end
-    end
-
-  end
-end
+# ActiveRecord::Base _must_ be loaded prior to the file that defines Shard
+# Because Switchman hooks into ActiveSupport.on_load(:active_record) and
+# reference it again (technically it gets referenced from inside
+# ConnectionHandler#establish_connection, when AR's on_load(:active_record)
+# hook gets called
+ActiveRecord::Base
+# in case it was referenced _before_ the on_load hook is added, then
+# we need to make sure we define the class someone wanted (in which case
+# AR's on_load hook won't be called either yet, and establish_connection
+# will be safe)
+require 'switchman/shard_internal'