makara 0.4.1 → 0.5.1

data/lib/active_record/connection_adapters/makara_jdbcmysql_adapter.rb

@@ -2,24 +2,10 @@ require 'active_record/connection_adapters/makara_abstract_adapter'
 require 'active_record/connection_adapters/jdbcmysql_adapter'
 require 'active_record/connection_adapters/makara_mysql2_adapter'
 
-if ActiveRecord::VERSION::MAJOR >= 4
-
-  module ActiveRecord
-    module ConnectionHandling
-      def makara_jdbcmysql_connection(config)
-        makara_mysql2_connection(config)
-      end
-    end
-  end
-
-else
-
-  module ActiveRecord
-    class Base
-      def self.makara_jdbcmysql_connection(config)
-        self.makara_mysql2_connection(config)
-      end
+module ActiveRecord
+  module ConnectionHandling
+    def makara_jdbcmysql_connection(config)
+      makara_mysql2_connection(config)
     end
   end
-
 end

data/lib/active_record/connection_adapters/makara_jdbcpostgresql_adapter.rb

@@ -2,24 +2,10 @@ require 'active_record/connection_adapters/makara_abstract_adapter'
 require 'active_record/connection_adapters/jdbcpostgresql_adapter'
 require 'active_record/connection_adapters/makara_postgresql_adapter'
 
-if ActiveRecord::VERSION::MAJOR >= 4
-
-  module ActiveRecord
-    module ConnectionHandling
-      def makara_jdbcpostgresql_connection(config)
-        makara_postgresql_connection(config)
-      end
-    end
-  end
-
-else
-
-  module ActiveRecord
-    class Base
-      def self.makara_jdbcpostgresql_connection(config)
-        self.makara_postgresql_connection(config)
-      end
+module ActiveRecord
+  module ConnectionHandling
+    def makara_jdbcpostgresql_connection(config)
+      makara_postgresql_connection(config)
     end
   end
-
 end

data/lib/active_record/connection_adapters/makara_mysql2_adapter.rb

@@ -1,32 +1,17 @@
 require 'active_record/connection_adapters/makara_abstract_adapter'
 require 'active_record/connection_adapters/mysql2_adapter'
 
-if ActiveRecord::VERSION::MAJOR >= 4
-
-  module ActiveRecord
-    module ConnectionHandling
-      def makara_mysql2_connection(config)
-        ActiveRecord::ConnectionAdapters::MakaraMysql2Adapter.new(config)
-      end
-    end
-  end
-
-else
-
-  module ActiveRecord
-    class Base
-      def self.makara_mysql2_connection(config)
-        ActiveRecord::ConnectionAdapters::MakaraMysql2Adapter.new(config)
-      end
+module ActiveRecord
+  module ConnectionHandling
+    def makara_mysql2_connection(config)
+      ActiveRecord::ConnectionAdapters::MakaraMysql2Adapter.new(config)
     end
   end
-
 end
 
 module ActiveRecord
   module ConnectionAdapters
     class MakaraMysql2Adapter < ActiveRecord::ConnectionAdapters::MakaraAbstractAdapter
-
       class << self
         def visitor_for(*args)
           ActiveRecord::ConnectionAdapters::Mysql2Adapter.visitor_for(*args)
@@ -38,7 +23,6 @@ module ActiveRecord
       def active_record_connection_for(config)
         ::ActiveRecord::Base.mysql2_connection(config)
       end
-
     end
   end
 end

data/lib/active_record/connection_adapters/makara_postgis_adapter.rb

@@ -1,29 +1,14 @@
 require 'active_record/connection_adapters/makara_abstract_adapter'
 require 'active_record/connection_adapters/postgis_adapter'
 
-if ActiveRecord::VERSION::MAJOR >= 4
-
-  module ActiveRecord
-    module ConnectionHandling
-      def makara_postgis_connection(config)
-        ActiveRecord::ConnectionAdapters::MakaraPostgisAdapter.new(config)
-      end
-    end
-  end
-
-else
-
-  module ActiveRecord
-    class Base
-      def self.makara_postgis_connection(config)
-        ActiveRecord::ConnectionAdapters::MakaraPostgisAdapter.new(config)
-      end
+module ActiveRecord
+  module ConnectionHandling
+    def makara_postgis_connection(config)
+      ActiveRecord::ConnectionAdapters::MakaraPostgisAdapter.new(config)
     end
   end
-
 end
 
-
 module ActiveRecord
   module ConnectionAdapters
     class MakaraPostgisAdapter < ActiveRecord::ConnectionAdapters::MakaraAbstractAdapter

data/lib/active_record/connection_adapters/makara_postgresql_adapter.rb

@@ -1,32 +1,17 @@
 require 'active_record/connection_adapters/makara_abstract_adapter'
 require 'active_record/connection_adapters/postgresql_adapter'
 
-if ActiveRecord::VERSION::MAJOR >= 4
-
-  module ActiveRecord
-    module ConnectionHandling
-      def makara_postgresql_connection(config)
-        ActiveRecord::ConnectionAdapters::MakaraPostgreSQLAdapter.new(config)
-      end
-    end
-  end
-
-else
-
-  module ActiveRecord
-    class Base
-      def self.makara_postgresql_connection(config)
-        ActiveRecord::ConnectionAdapters::MakaraPostgreSQLAdapter.new(config)
-      end
+module ActiveRecord
+  module ConnectionHandling
+    def makara_postgresql_connection(config)
+      ActiveRecord::ConnectionAdapters::MakaraPostgreSQLAdapter.new(config)
     end
   end
-
 end
 
 module ActiveRecord
   module ConnectionAdapters
     class MakaraPostgreSQLAdapter < ActiveRecord::ConnectionAdapters::MakaraAbstractAdapter
-
       class << self
         def visitor_for(*args)
           ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.visitor_for(*args)
@@ -38,7 +23,6 @@ module ActiveRecord
       def active_record_connection_for(config)
         ::ActiveRecord::Base.postgresql_connection(config)
       end
-
     end
   end
 end

data/lib/active_record/connection_adapters/mysql2_makara_adapter.rb

@@ -1,32 +1,17 @@
 require 'active_record/connection_adapters/makara_abstract_adapter'
 require 'active_record/connection_adapters/mysql2_adapter'
 
-if ActiveRecord::VERSION::MAJOR >= 4
-
-  module ActiveRecord
-    module ConnectionHandling
-      def mysql2_makara_connection(config)
-        ActiveRecord::ConnectionAdapters::MakaraMysql2Adapter.new(config)
-      end
-    end
-  end
-
-else
-
-  module ActiveRecord
-    class Base
-      def self.mysql2_makara_connection(config)
-        ActiveRecord::ConnectionAdapters::MakaraMysql2Adapter.new(config)
-      end
+module ActiveRecord
+  module ConnectionHandling
+    def mysql2_makara_connection(config)
+      ActiveRecord::ConnectionAdapters::MakaraMysql2Adapter.new(config)
     end
   end
-
 end
 
 module ActiveRecord
   module ConnectionAdapters
     class MakaraMysql2Adapter < ActiveRecord::ConnectionAdapters::MakaraAbstractAdapter
-
       class << self
         def visitor_for(*args)
           ActiveRecord::ConnectionAdapters::Mysql2Adapter.visitor_for(*args)
@@ -38,7 +23,6 @@ module ActiveRecord
       def active_record_connection_for(config)
         ::ActiveRecord::Base.mysql2_connection(config)
       end
-
     end
   end
 end

data/lib/active_record/connection_adapters/postgresql_makara_adapter.rb

@@ -1,32 +1,17 @@
 require 'active_record/connection_adapters/makara_abstract_adapter'
 require 'active_record/connection_adapters/postgresql_adapter'
 
-if ActiveRecord::VERSION::MAJOR >= 4
-
-  module ActiveRecord
-    module ConnectionHandling
-      def postgresql_makara_connection(config)
-        ActiveRecord::ConnectionAdapters::MakaraPostgreSQLAdapter.new(config)
-      end
-    end
-  end
-
-else
-
-  module ActiveRecord
-    class Base
-      def self.postgresql_makara_connection(config)
-        ActiveRecord::ConnectionAdapters::MakaraPostgreSQLAdapter.new(config)
-      end
+module ActiveRecord
+  module ConnectionHandling
+    def postgresql_makara_connection(config)
+      ActiveRecord::ConnectionAdapters::MakaraPostgreSQLAdapter.new(config)
     end
   end
-
 end
 
 module ActiveRecord
   module ConnectionAdapters
     class MakaraPostgreSQLAdapter < ActiveRecord::ConnectionAdapters::MakaraAbstractAdapter
-
       class << self
         def visitor_for(*args)
           ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.visitor_for(*args)
@@ -38,7 +23,6 @@ module ActiveRecord
       def active_record_connection_for(config)
         ::ActiveRecord::Base.postgresql_connection(config)
       end
-
     end
   end
 end

data/lib/makara/cache.rb

@@ -1,8 +1,6 @@
 module Makara
   module Cache
-
     class << self
-
       def store=(store)
         Makara::Logging::Logger.log deprecation_warning, :warn
       end

data/lib/makara/config_parser.rb

@@ -1,6 +1,7 @@
 require 'digest/md5'
 require 'active_support/core_ext/hash/keys'
 require 'active_support/core_ext/hash/except'
+require 'cgi'
 
 # Convenience methods to grab subconfigs out of the primary configuration.
 # Provides a way to generate a consistent ID based on a unique config.
@@ -19,11 +20,10 @@ require 'active_support/core_ext/hash/except'
 
 module Makara
   class ConfigParser
-
     DEFAULTS = {
-      :master_ttl => 5,
-      :blacklist_duration => 30,
-      :sticky => true
+      master_ttl: 5,
+      blacklist_duration: 30,
+      sticky: true
     }
 
     # ConnectionUrlResolver is borrowed from Rails 4-2 since its location and implementation
@@ -32,7 +32,6 @@ module Makara
     #
     # Expands a connection string into a hash.
     class ConnectionUrlResolver # :nodoc:
-
       # == Example
       #
       #   url = "postgresql://foo:bar@localhost:9000/foo_test?pool=5&timeout=3000"
@@ -49,6 +48,7 @@ module Makara
       #   }
       def initialize(url)
         raise "Database URL cannot be empty" if url.blank?
+
         @uri     = URI.parse(url)
         @adapter = @uri.scheme.tr('-', '_')
         @adapter = "postgresql" if @adapter == "postgres"
@@ -63,7 +63,7 @@ module Makara
       # Converts the given URL to a full connection hash.
       def to_hash
         config = raw_config.reject { |_,value| value.blank? }
-        config.map { |key,value| config[key] = URI.unescape(value) if value.is_a? String }
+        config.map { |key,value| config[key] = CGI.unescape(value) if value.is_a? String }
         config
       end
 
@@ -130,6 +130,7 @@ module Makara
         Makara::Logging::Logger.log "Please rename DATABASE_URL to use in the database.yml", :warn
       end
       return config unless config.key?(:url)
+
       url = config[:url]
       url_config = ConnectionUrlResolver.new(url).to_hash
       url_config = url_config.symbolize_keys
@@ -147,7 +148,6 @@ module Makara
       @id = sanitize_id(@makara_config[:id])
     end
 
-
     def id
       @id ||= begin
         sorted = recursive_sort(@config)
@@ -155,24 +155,20 @@ module Makara
       end
     end
 
-
     def master_configs
       all_configs
         .select { |config| config[:role] == 'master' }
         .map { |config| config.except(:role) }
     end
 
-
     def slave_configs
       all_configs
         .reject { |config| config[:role] == 'master' }
         .map { |config| config.except(:role) }
     end
 
-
     protected
 
-
     def all_configs
       @makara_config[:connections].map do |connection|
         base_config.merge(makara_config.except(:connections))
@@ -180,12 +176,10 @@ module Makara
       end
     end
 
-
     def base_config
       @base_config ||= DEFAULTS.merge(@config).except(:makara)
     end
 
-
     def recursive_sort(thing)
       return thing.to_s unless thing.include?(Enumerable)
 
@@ -194,10 +188,8 @@ module Makara
       end
 
       thing.sort_by(&:to_s)
-
     end
 
-
     def sanitize_id(id)
       return if id.nil? || id.empty?
 

data/lib/makara/connection_wrapper.rb

@@ -7,7 +7,6 @@ require 'active_support/core_ext/hash/keys'
 
 module Makara
   class ConnectionWrapper
-
     attr_accessor :initial_error, :config
 
     # invalid queries caused by connections switching that needs to be replaced
@@ -16,7 +15,7 @@ module Makara
     def initialize(proxy, connection, config)
       @config = config.symbolize_keys
       @connection = connection
-      @proxy  = proxy
+      @proxy = proxy
 
       if connection.nil?
         _makara_blacklist!
@@ -35,11 +34,19 @@ module Makara
       @config[:name]
     end
 
+    def _makara_shard_id
+      @config[:shard_id]
+    end
+
     # has this node been blacklisted?
     def _makara_blacklisted?
       @blacklisted_until.present? && @blacklisted_until.to_i > Time.now.to_i
     end
 
+    def _makara_in_transaction?
+      @connection && @connection.open_transactions > 0
+    end
+
     # blacklist this node for @config[:blacklist_duration] seconds
     def _makara_blacklist!
       @connection.disconnect! if @connection
@@ -95,28 +102,21 @@ module Makara
 
     # we want to forward all private methods, since we could have kicked out from a private scenario
     def method_missing(m, *args, &block)
-      if _makara_connection.respond_to?(m)
-        _makara_connection.public_send(m, *args, &block)
-      else # probably private method
-        _makara_connection.__send__(m, *args, &block)
-      end
+      _makara_connection.send(m, *args, &block)
     end
 
+    ruby2_keywords :method_missing if Module.private_method_defined?(:ruby2_keywords)
 
-    class_eval <<-RUBY_EVAL, __FILE__, __LINE__ + 1
-      def respond_to#{RUBY_VERSION.to_s =~ /^1.8/ ? nil : '_missing'}?(m, include_private = false)
-        _makara_connection.respond_to?(m, true)
-      end
-    RUBY_EVAL
-
+    def respond_to_missing?(m, include_private = false)
+      _makara_connection.respond_to?(m, true)
+    end
 
     protected
 
     # once the underlying connection is present we must evaluate extra functionality into it.
     # all extra functionality is in the format of _makara*
     def _makara_decorate_connection(con)
-
-      extension = %Q{
+      extension = <<~RUBY
         # the proxy object controlling this connection
         def _makara
           @_makara
@@ -140,31 +140,52 @@ module Makara
         def _makara_name
           #{@config[:name].inspect}
         end
-      }
+      RUBY
+
+      args = RUBY_VERSION >= "3.0.0" ? "..." : "*args, &block"
 
       # Each method the Makara::Proxy needs to hijack should be redefined in the underlying connection.
       # The new definition should allow for the proxy to intercept the invocation if required.
       @proxy.class.hijack_methods.each do |meth|
-        extension << %Q{
-          def #{meth}(*args, &block)
+        method_call = RUBY_VERSION >= "3.0.0" ? "public_send(#{meth.inspect}, ...)" : "#{meth}(*args, &block)"
+
+        extension << <<~RUBY
+          def #{meth}(#{args})
             _makara_hijack do |proxy|
               if proxy
-                proxy.#{meth}(*args, &block)
+                proxy.#{method_call}
               else
                 super
               end
             end
           end
-        }
+        RUBY
+      end
+
+      # Control methods must always be passed to the
+      # Makara::Proxy control object for handling (typically
+      # related to ActiveRecord connection pool management)
+      @proxy.class.control_methods.each do |meth|
+        method_call = RUBY_VERSION >= "3.0.0" ? "public_send(#{meth.inspect}, ...)" : "#{meth}(*args=args, block)"
+
+        extension << <<~RUBY
+          def #{meth}(#{args})
+            proxy = _makara
+            if proxy
+              proxy.control.#{method_call}
+            else
+              super # Only if we are not wrapped any longer
+            end
+          end
+        RUBY
       end
 
       # extend the instance
-      con.instance_eval(extension)
+      con.instance_eval(extension, __FILE__, __LINE__ + 1)
       # set the makara context
       con._makara = @proxy
 
       con._makara
     end
-
   end
 end

data/lib/makara/context.rb

@@ -123,6 +123,7 @@ module Makara
       end
 
       protected
+
       def current
         fetch(:makara_current_context) { new({}) }
       end

data/lib/makara/cookie.rb

@@ -22,6 +22,7 @@ module Makara
     end
 
     private
+
     # Pairs of {proxy_id}:{timestamp}, separated by "|"
     # proxy_id1:1518270031.3132212|proxy_id2:1518270030.313232 ..
     def parse(cookie_string)

data/lib/makara/error_handler.rb

@@ -4,36 +4,27 @@
 
 module Makara
   class ErrorHandler
-
-
     def handle(connection)
       yield
-
     rescue Exception => e
-
       if e.is_a?(Makara::Errors::MakaraError)
         harshly(e)
       else
         gracefully(connection, e)
       end
-
     end
 
-
     protected
 
-
     def gracefully(connection, e)
       err = Makara::Errors::BlacklistConnection.new(connection, e)
       ::Makara::Logging::Logger.log("Gracefully handling: #{err}")
       raise err
     end
 
-
     def harshly(e)
       ::Makara::Logging::Logger.log("Harshly handling: #{e}\n#{e.backtrace.join("\n\t")}")
       raise e
     end
-
   end
 end

data/lib/makara/errors/all_connections_blacklisted.rb

@@ -1,13 +1,11 @@
 module Makara
   module Errors
     class AllConnectionsBlacklisted < MakaraError
-
       def initialize(pool, errors)
         errors = [*errors]
         messages = errors.empty? ? 'No error details' : errors.map(&:message).join(' -> ')
         super "[Makara/#{pool.role}] All connections are blacklisted -> " + messages
       end
-
     end
   end
 end

data/lib/makara/errors/blacklist_connection.rb

@@ -1,14 +1,12 @@
 module Makara
   module Errors
     class BlacklistConnection < MakaraError
-
       attr_reader :original_error
 
       def initialize(connection, error)
         @original_error = error
         super "[Makara/#{connection._makara_name}] #{error.message}"
       end
-
     end
   end
 end

data/lib/makara/errors/blacklisted_while_in_transaction.rb

@@ -0,0 +1,12 @@
+module Makara
+  module Errors
+    class BlacklistedWhileInTransaction < MakaraError
+      attr_reader :role
+
+      def initialize(role)
+        @role = role
+        super "[Makara] Blacklisted while in transaction in the #{role} pool"
+      end
+    end
+  end
+end

data/lib/makara/errors/invalid_shard.rb

@@ -0,0 +1,14 @@
+module Makara
+  module Errors
+    class InvalidShard < MakaraError
+      attr_reader :role
+      attr_reader :shard_id
+
+      def initialize(role, shard_id)
+        @role = role
+        @shard_id = shard_id
+        super "[Makara] Invalid shard_id #{shard_id} for the #{role} pool"
+      end
+    end
+  end
+end

data/lib/makara/errors/makara_error.rb

@@ -1,7 +1,6 @@
 module Makara
   module Errors
     class MakaraError < ::ActiveRecord::ActiveRecordError
-
     end
   end
 end

data/lib/makara/errors/no_connections_available.rb

@@ -1,14 +1,12 @@
 module Makara
   module Errors
     class NoConnectionsAvailable < MakaraError
-
       attr_reader :role
 
       def initialize(role)
         @role = role
         super "[Makara] No connections are available in the #{role} pool"
       end
-
     end
   end
 end

data/lib/makara/logging/logger.rb

@@ -1,9 +1,7 @@
 module Makara
   module Logging
     class Logger
-
       class << self
-
         def log(msg, format = :error)
           logger.send(format, "[Makara] #{msg}") if logger
         end
@@ -15,9 +13,7 @@ module Makara
         def logger=(l)
           @logger = l
         end
-
       end
-
     end
   end
 end