makara 0.3.10 → 0.4.0

data/lib/makara/cookie.rb

@@ -0,0 +1,52 @@
+module Makara
+  module Cookie
+    extend self
+
+    IDENTIFIER = '_mkra_stck'.freeze
+
+    DEFAULT_OPTIONS = {
+      path: "/",
+      http_only: true
+    }
+
+    MAX_AGE_BUFFER = 5
+
+    def fetch(request)
+      parse(request.cookies[IDENTIFIER].to_s)
+    end
+
+    def store(context_data, headers, options = {})
+      unless context_data.nil?
+        Rack::Utils.set_cookie_header! headers, IDENTIFIER, build_cookie(context_data, options)
+      end
+    end
+
+    private
+    # Pairs of {proxy_id}:{timestamp}, separated by "|"
+    # proxy_id1:1518270031.3132212|proxy_id2:1518270030.313232 ..
+    def parse(cookie_string)
+      return {} if cookie_string.empty?
+
+      states = cookie_string.split("|")
+      states.each_with_object({}) do |state, context_data|
+        proxy_id, timestamp = state.split(":")
+        context_data[proxy_id] = timestamp.to_f if proxy_id && timestamp
+      end
+    end
+
+    def build_cookie(context_data, options)
+      cookie = DEFAULT_OPTIONS.merge(options)
+      now = Time.now
+
+      cookie[:max_age] = if context_data.any?
+        (context_data.values.max - now.to_f).ceil + MAX_AGE_BUFFER
+      else
+        0
+      end
+      cookie[:expires] = now + cookie[:max_age]
+      cookie[:value] = context_data.collect { |proxy_id, ttl| "#{proxy_id}:#{ttl}" }.join('|')
+
+      cookie
+    end
+  end
+end

data/lib/makara/error_handler.rb

@@ -25,13 +25,13 @@ module Makara
 
     def gracefully(connection, e)
       err = Makara::Errors::BlacklistConnection.new(connection, e)
-      ::Makara::Logging::Logger.log("[Makara] Gracefully handling: #{err}")
+      ::Makara::Logging::Logger.log("Gracefully handling: #{err}")
       raise err
     end
 
 
     def harshly(e)
-      ::Makara::Logging::Logger.log("[Makara] Harshly handling: #{e}\n#{e.backtrace.join("\n\t")}")
+      ::Makara::Logging::Logger.log("Harshly handling: #{e}\n#{e.backtrace.join("\n\t")}")
       raise e
     end
 

data/lib/makara/logging/logger.rb

@@ -5,7 +5,7 @@ module Makara
       class << self
 
         def log(msg, format = :error)
-          logger.send(format, msg) if logger
+          logger.send(format, "[Makara] #{msg}") if logger
         end
 
         def logger

data/lib/makara/middleware.rb

@@ -1,37 +1,20 @@
 require 'rack'
 
-# Persists the Makara::Context across requests ensuring the same master pool is used on the subsequent request.
-# Simply sets the cookie with the current context and the status code of this request. The next request then sets
-# the Makara::Context's previous context based on the the previous request. If a redirect is encountered the middleware
-# will defer generation of a new context until a non-redirect request occurs.
-
+# Persists the Makara::Context across requests ensuring the same master pool is used on subsequent requests.
 module Makara
   class Middleware
 
-    IDENTIFIER = '_mkra_ctxt'
-
-    DEFAULT_COOKIE = {
-      :path => '/',
-      :http_only => true,
-      :max_age => '5'
-    }
-
     def initialize(app, cookie_options = {})
       @app = app
-      @cookie = DEFAULT_COOKIE.merge(cookie_options)
+      @cookie_options = cookie_options
     end
 
-
     def call(env)
-
       return @app.call(env) if ignore_request?(env)
-
-      Makara::Context.set_previous previous_context(env)
-      Makara::Context.set_current new_context(env)
+      set_current_context(env)
 
       status, headers, body = @app.call(env)
-
-      store_context(status, headers)
+      store_new_context(headers)
 
       [status, headers, body]
     end
@@ -39,6 +22,14 @@ module Makara
 
     protected
 
+    def set_current_context(env)
+      context_data = Makara::Cookie.fetch(Rack::Request.new(env))
+      Makara::Context.set_current(context_data)
+    end
+
+    def store_new_context(headers)
+      Makara::Cookie.store(Makara::Context.next, headers, @cookie_options)
+    end
 
     # ignore asset paths
     # consider allowing a filter proc to be provided in an initializer
@@ -50,59 +41,5 @@ module Makara
       end
       false
     end
-
-
-    # generate a new context based on the request
-    # if the previous request was a redirect, we keep the same context
-    def new_context(env)
-
-      makara_context, makara_status = makara_values(env)
-
-      context = nil
-
-      # if the previous request was a redirect, let's keep that context
-      if makara_status.to_s =~ /^3/ # 300+ redirect
-        context = makara_context
-      end
-
-      context ||= Makara::Context.get_current if env['rack.test']
-      context ||= Makara::Context.generate(env["action_dispatch.request_id"])
-      context
-    end
-
-
-    # pulls the previous context out of the request
-    def previous_context(env)
-      context = makara_values(env).first
-      context ||= Makara::Context.get_previous if env['rack.test']
-      context ||= Makara::Context.generate
-      context
-    end
-
-
-    # retrieve the stored content from the cookie or query
-    # The value contains the hexdigest and status code of the previous
-    # response in the format: $digest--$status
-    def makara_values(env)
-      regex = /#{IDENTIFIER}=([\-a-z0-9A-Z]+)/
-
-      env['HTTP_COOKIE'].to_s =~ regex
-      return $1.split('--') if $1
-
-      env['QUERY_STRING'].to_s =~ regex
-      return $1.split('--') if $1
-
-      [nil, nil]
-    end
-
-
-    # push the current context into the cookie
-    # it should always be for the same path, only
-    # accessible via http and live for a short amount
-    # of time
-    def store_context(status, headers)
-      cookie = @cookie.merge(:value => "#{Makara::Context.get_current}--#{status}")
-      Rack::Utils.set_cookie_header! headers, IDENTIFIER, cookie
-    end
   end
 end

data/lib/makara/pool.rb

@@ -1,7 +1,6 @@
 require 'active_support/core_ext/hash/keys'
 
 # Wraps a collection of similar connections and chooses which one to use
-# Uses the Makara::Context to determine if the connection needs rotation.
 # Provides convenience methods for accessing underlying connections
 
 module Makara
@@ -18,7 +17,6 @@ module Makara
     def initialize(role, proxy)
       @role             = role
       @proxy            = proxy
-      @context          = Makara::Context.get_current
       @connections      = []
       @blacklist_errors = []
       @disabled         = false
@@ -137,16 +135,11 @@ module Makara
     # to be sticky, provide back the current connection assuming it is
     # not blacklisted.
     def next
-      if @proxy.sticky && Makara::Context.get_current == @context
-        con = @strategy.current
-        return con if con
-      end
-
-      con = @strategy.next
-      if con
-        @context = Makara::Context.get_current
+      if @proxy.sticky && @strategy.current
+        @strategy.current
+      else
+        @strategy.next
       end
-      con
     end
   end
 end

data/lib/makara/proxy.rb

@@ -59,22 +59,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)
@@ -201,15 +200,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,28 +242,28 @@ module Makara
     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

data/lib/makara/version.rb

@@ -2,8 +2,8 @@ module Makara
   module VERSION
 
     MAJOR = 0
-    MINOR = 3
-    PATCH = 10
+    MINOR = 4
+    PATCH = 0
     PRE = nil
 
     def self.to_s

data/spec/active_record/connection_adapters/makara_abstract_adapter_spec.rb

@@ -74,10 +74,6 @@ describe ActiveRecord::ConnectionAdapters::MakaraAbstractAdapter do
       end
 
       proxy.execute(sql)
-
-      if should_send_to_all_connections
-        expect(proxy.master_context).to be_nil
-      end
     end
 
   end

data/spec/active_record/connection_adapters/makara_mysql2_adapter_spec.rb

@@ -82,7 +82,7 @@ describe 'MakaraMysql2Adapter' do
         ActiveRecord::Base.connection
 
         load(File.dirname(__FILE__) + '/../../support/schema.rb')
-        Makara::Context.set_current Makara::Context.generate
+        change_context
 
         allow(ActiveRecord::Base).to receive(:mysql2_connection) do |config|
           config[:username] = db_username

data/spec/cache_spec.rb

@@ -2,80 +2,8 @@ require 'spec_helper'
 
 describe Makara::Cache do
 
-  it 'should not require a store be set' do
-    described_class.store = nil
-
-    expect(
-      described_class.send(:store)
-    ).to be_nil
-
-    expect{
-      described_class.read('test')
-    }.not_to raise_error
-  end
-
-  it 'provides a few stores for testing purposes' do
-    described_class.store = :memory
-    described_class.write('test', 'value', 10)
-    expect(described_class.read('test')).to eq('value')
-
+  it 'shows a warning' do
+    expect(Makara::Logging::Logger).to receive(:log).with(/Setting the Makara::Cache\.store won't have any effects/, :warn)
     described_class.store = :noop
-    described_class.write('test', 'value', 10)
-    expect(described_class.read('test')).to be_nil
   end
-
-
-  # this will be used in tests so we have to ensure this works as expected
-  context Makara::Cache::MemoryStore do
-
-    let(:store){ Makara::Cache::MemoryStore.new }
-    let(:data){ store.instance_variable_get('@data') }
-
-    it 'should read and write keys' do
-      expect(store.read('test')).to be_nil
-      store.write('test', 'value')
-      expect(store.read('test')).to eq('value')
-    end
-
-    it 'provides time based expiration' do
-      store.write('test', 'value', :expires_in => 5)
-      expect(store.read('test')).to eq('value')
-
-      Timecop.travel Time.now + 6 do
-        expect(store.read('test')).to be_nil
-      end
-    end
-
-    it 'cleans the data' do
-      store.write('test', 'value', :expires_in => -5)
-      expect(store.read('test')).to be_nil
-      expect(data).not_to have_key('test')
-    end
-
-    it 'has thread-safety' do
-      store = Makara::Cache::MemoryStore.new
-      previous_value = Thread.abort_on_exception
-
-      begin
-        Thread.abort_on_exception = true
-
-        workers = 2.times.map do
-          Thread.new do
-            100.times do |n|
-              store.write(n, 'value', expires_in: 0.5)
-              sleep(0.01)
-            end
-          end
-        end
-
-        expect { workers.map(&:join) }.to_not raise_error
-      ensure
-        Thread.abort_on_exception = previous_value
-      end
-    end
-
-  end
-
-
-
 end

data/spec/config_parser_spec.rb

@@ -79,7 +79,7 @@ describe Makara::ConfigParser do
 
   end
 
-  it 'should provide an id based on the recursively sorted config' do
+  it 'should provide a default proxy id based on the recursively sorted config' do
     parsera = described_class.new(config)
     parserb = described_class.new(config.merge(:other => 'value'))
     parserc = described_class.new(config)
@@ -88,6 +88,26 @@ describe Makara::ConfigParser do
     expect(parsera.id).to eq(parserc.id)
   end
 
+  it 'should use provided proxy id instead of default' do
+    config_with_custom_id = config.dup
+    config_with_custom_id[:makara][:id] = 'my_proxy'
+
+    parser = described_class.new(config_with_custom_id)
+
+    expect(parser.id).to eq('my_proxy')
+  end
+
+  it 'should replace reserved characters and show a warning for provided proxy ids' do
+    config_with_custom_id = config.dup
+    config_with_custom_id[:makara][:id] = "my|proxy|id:with:reserved:characters"
+    warning = "Proxy id 'my|proxy|id:with:reserved:characters' changed to 'myproxyidwithreservedcharacters'"
+    expect(Makara::Logging::Logger).to receive(:log).with(warning, :warn)
+
+    parser = described_class.new(config_with_custom_id)
+
+    expect(parser.id).to eq('myproxyidwithreservedcharacters')
+  end
+
   context 'master and slave configs' do
     it 'should provide master and slave configs' do
       parser = described_class.new(config)