makara 0.3.9 → 0.5.1

data/lib/makara/proxy.rb

@@ -11,11 +11,11 @@ require 'active_support/core_ext/string/inflections'
 
 module Makara
   class Proxy < ::SimpleDelegator
-
     METHOD_MISSING_SKIP = [ :byebug, :puts ]
 
-    class_attribute :hijack_methods
+    class_attribute :hijack_methods, :control_methods
     self.hijack_methods = []
+    self.control_methods = []
 
     class << self
       def hijack_method(*method_names)
@@ -23,27 +23,44 @@ module Makara
         self.hijack_methods |= method_names
 
         method_names.each do |method_name|
-          define_method method_name do |*args, &block|
+          define_method(method_name) do |*args, &block|
             appropriate_connection(method_name, args) do |con|
               con.send(method_name, *args, &block)
             end
           end
+
+          ruby2_keywords method_name if Module.private_method_defined?(:ruby2_keywords)
         end
       end
 
       def send_to_all(*method_names)
         method_names.each do |method_name|
-          define_method method_name do |*args|
-            send_to_all method_name, *args
+          define_method(method_name) do |*args|
+            send_to_all(method_name, *args)
           end
+
+          ruby2_keywords method_name if Module.private_method_defined?(:ruby2_keywords)
         end
       end
-    end
 
+      def control_method(*method_names)
+        self.control_methods = self.control_methods || []
+        self.control_methods |= method_names
+
+        method_names.each do |method_name|
+          define_method(method_name) do |*args, &block|
+            control&.send(method_name, *args, &block)
+          end
+
+          ruby2_keywords method_name if Module.private_method_defined?(:ruby2_keywords)
+        end
+      end
+    end
 
     attr_reader :error_handler
     attr_reader :sticky
     attr_reader :config_parser
+    attr_reader :control
 
     def initialize(config)
       @config         = config.symbolize_keys
@@ -59,22 +76,21 @@ module Makara
     end
 
     def without_sticking
-      before_context = @master_context
-      @master_context = nil
       @skip_sticking = true
       yield
     ensure
       @skip_sticking = false
-      @master_context ||= before_context
     end
 
     def hijacked?
       @hijacked
     end
 
-    def stick_to_master!(write_to_cache = true)
-      @master_context = Makara::Context.get_current
-      Makara::Context.stick(@master_context, @id, @ttl) if write_to_cache
+    # If persist is true, we stick the proxy to master for subsequent requests
+    # up to master_ttl duration. Otherwise we just stick it for the current request
+    def stick_to_master!(persist = true)
+      stickiness_duration = persist ? @ttl : 0
+      Makara::Context.stick(@id, stickiness_duration)
     end
 
     def strategy_for(role)
@@ -85,6 +101,14 @@ module Makara
       @config_parser.makara_config["#{role}_strategy".to_sym]
     end
 
+    def shard_aware_for(role)
+      @config_parser.makara_config["#{role}_shard_aware".to_sym]
+    end
+
+    def default_shard_for(role)
+      @config_parser.makara_config["#{role}_default_shard".to_sym]
+    end
+
     def strategy_class_for(strategy_name)
       case strategy_name
       when 'round_robin', 'roundrobin', nil, ''
@@ -98,27 +122,25 @@ module Makara
 
     def method_missing(m, *args, &block)
       if METHOD_MISSING_SKIP.include?(m)
-        return super(m, *args, &block)
+        return super
       end
 
       any_connection do |con|
-        if con.respond_to?(m)
-          con.public_send(m, *args, &block)
-        elsif con.respond_to?(m, true)
-          con.__send__(m, *args, &block)
+        if con.respond_to?(m, true)
+          con.send(m, *args, &block)
         else
-          super(m, *args, &block)
+          super
         end
       end
     end
 
-    class_eval <<-RUBY_EVAL, __FILE__, __LINE__ + 1
-      def respond_to#{RUBY_VERSION.to_s =~ /^1.8/ ? nil : '_missing'}?(m, include_private = false)
-        any_connection do |con|
-          con._makara_connection.respond_to?(m, true)
-        end
+    ruby2_keywords :method_missing if Module.private_method_defined?(:ruby2_keywords)
+
+    def respond_to_missing?(m, include_private = false)
+      any_connection do |con|
+        con._makara_connection.respond_to?(m, true)
       end
-    RUBY_EVAL
+    end
 
     def graceful_connection_for(config)
       fake_wrapper = Makara::ConnectionWrapper.new(self, nil, config)
@@ -139,18 +161,25 @@ module Makara
 
     protected
 
-
     def send_to_all(method_name, *args)
       # slave pool must run first to allow for slave-->master failover without running operations on master twice.
       handling_an_all_execution(method_name) do
-        @slave_pool.send_to_all method_name, *args
-        @master_pool.send_to_all method_name, *args
+        @slave_pool.send_to_all(method_name, *args)
+        @master_pool.send_to_all(method_name, *args)
       end
     end
 
+    ruby2_keywords :send_to_all if Module.private_method_defined?(:ruby2_keywords)
+
     def any_connection
-      @master_pool.provide do |con|
-        yield con
+      if @master_pool.disabled
+        @slave_pool.provide do |con|
+          yield con
+        end
+      else
+        @master_pool.provide do |con|
+          yield con
+        end
       end
     rescue ::Makara::Errors::AllConnectionsBlacklisted, ::Makara::Errors::NoConnectionsAvailable
       begin
@@ -176,15 +205,11 @@ module Makara
       end
     end
 
-
     # master or slave
     def appropriate_pool(method_name, args)
-
       # for testing purposes
       pool = _appropriate_pool(method_name, args)
-
       yield pool
-
     rescue ::Makara::Errors::AllConnectionsBlacklisted, ::Makara::Errors::NoConnectionsAvailable => e
       if pool == @master_pool
         @master_pool.connections.each(&:_makara_whitelist!)
@@ -202,15 +227,11 @@ module Makara
         stick_to_master(method_name, args)
         @master_pool
 
-      # in this context, we've already stuck to master
-      elsif Makara::Context.get_current == @master_context
-        @master_pool
-
-      elsif previously_stuck_to_master?
+      elsif stuck_to_master?
 
-        # we're only on master because of the previous context so
-        # behave like we're sticking to master but store the current context
-        stick_to_master(method_name, args, false)
+        # we're on master because we already stuck this proxy in this
+        # request or because we got stuck in previous requests and the
+        # stickiness is still valid
         @master_pool
 
       # all slaves are down (or empty)
@@ -247,29 +268,28 @@ module Makara
       @hijacked = false
     end
 
-
-    def previously_stuck_to_master?
-      @sticky && Makara::Context.previously_stuck?(@id)
+    def stuck_to_master?
+      sticky? && Makara::Context.stuck?(@id)
     end
 
-
-    def stick_to_master(method_name, args, write_to_cache = true)
-      # if we're already stuck to master, don't bother doing it again
-      return if @master_context == Makara::Context.get_current
-
+    def stick_to_master(method_name, args)
       # check to see if we're configured, bypassed, or some custom implementation has input
       return unless should_stick?(method_name, args)
 
       # do the sticking
-      stick_to_master!(write_to_cache)
+      stick_to_master!
     end
 
-
-    # if we are configured to be sticky and we aren't bypassing stickiness
+    # For the generic proxy implementation, we stick if we are sticky,
+    # method and args don't matter
     def should_stick?(method_name, args)
-      @sticky && !@skip_sticking
+      sticky?
     end
 
+    # If we are configured to be sticky and we aren't bypassing stickiness,
+    def sticky?
+      @sticky && !@skip_sticking
+    end
 
     # use the config parser to generate a master and slave pool
     def instantiate_connections
@@ -292,18 +312,18 @@ module Makara
       yield
     rescue ::Makara::Errors::NoConnectionsAvailable => e
       if e.role == 'master'
-        Kernel.raise ::Makara::Errors::NoConnectionsAvailable.new('master and slave')
+        # this means slave connections are good.
+        return
       end
+
       @slave_pool.disabled = true
       yield
     ensure
       @slave_pool.disabled = false
     end
 
-
     def connection_for(config)
       Kernel.raise NotImplementedError
     end
-
   end
 end

data/lib/makara/railtie.rb

@@ -1,15 +1,7 @@
 module Makara
   class Railtie < ::Rails::Railtie
-
     initializer "makara.configure_rails_initialization" do |app|
       app.middleware.use Makara::Middleware
     end
-
-    initializer "makara.initialize_logger" do |app|
-      ActiveRecord::LogSubscriber.log_subscribers.each do |subscriber|
-        subscriber.extend ::Makara::Logging::Subscriber
-      end
-    end
-
   end
 end

data/lib/makara/strategies/abstract.rb

@@ -2,6 +2,7 @@ module Makara
   module Strategies
     class Abstract
       attr_reader :pool
+
       def initialize(pool)
         @pool = pool
         init

data/lib/makara/strategies/priority_failover.rb

@@ -27,6 +27,7 @@ module Makara
         @weighted_connections.each_with_index do |con, index|
           check = safe_value(index)
           next unless check
+
           @current_idx = index
           return check
         end
@@ -41,6 +42,7 @@ module Makara
         con = @weighted_connections[idx]
         return nil unless con
         return nil if con._makara_blacklisted?
+
         con
       end
     end

data/lib/makara/strategies/round_robin.rb

@@ -23,9 +23,11 @@ module Makara
       end
 
       def next
+        return safe_value(0, true) if single_one?
+
         idx = @current_idx
-        begin
 
+        begin
           idx = next_index(idx)
 
           # if we've looped all the way around, return our safe value
@@ -46,7 +48,6 @@ module Makara
         idx
       end
 
-
       # return the connection if it's not blacklisted
       # otherwise return nil
       # optionally, store the position and context we're returning
@@ -62,11 +63,14 @@ module Makara
         con
       end
 
-
       # stub in test mode to ensure consistency
       def should_shuffle?
         true
       end
+
+      def single_one?
+        false
+      end
     end
   end
 end

data/lib/makara/strategies/shard_aware.rb

@@ -0,0 +1,45 @@
+require 'makara/errors/invalid_shard'
+
+module Makara
+  module Strategies
+    class ShardAware < ::Makara::Strategies::Abstract
+      def init
+        @shards = {}
+        @default_shard = pool.default_shard
+      end
+
+      def connection_added(wrapper)
+        id = wrapper._makara_shard_id
+        shard_strategy(id).connection_added(wrapper)
+      end
+
+      def shard_strategy(shard_id)
+        id = shard_id
+        shard_strategy = @shards[id]
+        unless shard_strategy
+          shard_strategy = pool.shard_strategy_class.new(pool)
+          @shards[id] = shard_strategy
+        end
+        shard_strategy
+      end
+
+      def current
+        id = shard_id
+        raise Makara::Errors::InvalidShard.new(pool.role, id) unless id && @shards[id]
+
+        @shards[id].current
+      end
+
+      def next
+        id = shard_id
+        raise Makara::Errors::InvalidShard.new(pool.role, id) unless id && @shards[id]
+
+        @shards[id].next
+      end
+
+      def shard_id
+        Thread.current['makara_shard_id'] || pool.default_shard
+      end
+    end
+  end
+end

data/lib/makara/version.rb

@@ -1,15 +1,13 @@
 module Makara
   module VERSION
-
     MAJOR = 0
-    MINOR = 3
-    PATCH = 9
+    MINOR = 5
+    PATCH = 1
     PRE = nil
 
     def self.to_s
       [MAJOR, MINOR, PATCH, PRE].compact.join('.')
     end
-
   end unless defined?(::Makara::VERSION)
   ::Makara::VERSION
 end

data/makara.gemspec

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 require File.expand_path('../lib/makara/version', __FILE__)
 
 Gem::Specification.new do |gem|
@@ -6,7 +5,11 @@ Gem::Specification.new do |gem|
   gem.email         = ["mike@mikeonrails.com"]
   gem.description   = %q{Read-write split your DB yo}
   gem.summary       = %q{Read-write split your DB yo}
-  gem.homepage      = ""
+  gem.homepage      = "https://github.com/instacart/makara"
+  gem.licenses      = ['MIT']
+  gem.metadata      = {
+    "source_code_uri" => 'https://github.com/instacart/makara'
+  }
 
   gem.files         = `git ls-files`.split($\)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
@@ -15,5 +18,25 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = Makara::VERSION
 
-  gem.add_dependency 'activerecord', '>= 3.0.0'
+  gem.required_ruby_version = ">= 2.5.0"
+
+  gem.add_dependency "activerecord", ">= 5.2.0"
+
+  gem.add_development_dependency "rack"
+  gem.add_development_dependency "rake", "~> 13.0"
+  gem.add_development_dependency "rspec", "~> 3.9"
+  gem.add_development_dependency "timecop"
+  gem.add_development_dependency "rubocop", "~> 1.9.1"
+
+  if RUBY_ENGINE == "jruby"
+    gem.add_development_dependency "activerecord-jdbcmysql-adapter"
+    gem.add_development_dependency "activerecord-jdbcpostgresql-adapter"
+    gem.add_development_dependency "ruby-debug"
+  else
+    gem.add_development_dependency "activerecord-postgis-adapter"
+    gem.add_development_dependency "pry-byebug"
+    gem.add_development_dependency "mysql2"
+    gem.add_development_dependency "pg"
+    gem.add_development_dependency "rgeo"
+  end
 end