cachext 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dcf7bc76ec3652f1cd422829ce48eab33dcca9fa
-  data.tar.gz: c0b1da10550b40c1b8a3b177ad3af8db1e6e1a6d
+  metadata.gz: efbd13ef3c2d5d01d835978b0344adfb772a01f1
+  data.tar.gz: a134b132ea3aa34818e3063374ae6f3c2f608db5
 SHA512:
-  metadata.gz: baedf859f3f071c3f8d55d3dce7f23017bc220eb66a9c4c1d38f0eb4b07d1cd463aec1d158b83f0d277be26ccfdcaf167630122ab002b32ea0348080758d3103
-  data.tar.gz: 70b82bbbec5dcca57cf5a5b2d894b13c17f359fb5a195f3918836a0998a8b1f812c83650c3c428d0821adbf80329ebe101901f8749e8d9dc2ba5b811d49d28a2
+  metadata.gz: 9879eebaa0620bc3719e97f96ec2eb2cd4b5ee56c7673f56b906e8c5d4657e3dd15e0f54051621e831e1d57706d36b3ec24ec7c786cc5718b1553d8421ce6c23
+  data.tar.gz: 27a8916181d7f7e10e2fae4eda9e3372be97d9fa854cda833cee8d50a9d14aee7fbcc259e1e9f75ad634f46e8e2eb3f489c4cfa04401cdab881fd853bdf59d11

data/cachext.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "activesupport"
+  spec.add_dependency "activesupport", "~> 4.2"
   spec.add_dependency "redis"
   spec.add_dependency "redis-namespace"
   spec.add_dependency "redlock"
@@ -31,4 +31,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "pry"
   spec.add_development_dependency "thread"
+  spec.add_development_dependency "timecop"
 end

data/lib/cachext.rb

@@ -2,6 +2,7 @@ require "cachext/version"
 require "faraday/error"
 
 module Cachext
+  autoload :Breaker, "cachext/breaker"
   autoload :Client, "cachext/client"
   autoload :Configuration, "cachext/configuration"
   autoload :Features, "cachext/features"
@@ -40,7 +41,8 @@ module Cachext
 
   def self.flush
     config.cache.clear
-    config.redis.del "cachext:*"
+    keys = config.redis.keys("cachext:*")
+    config.redis.del(*keys) if keys.length > 0
   end
 
   def self.multi klass, ids, options = {}, &block
@@ -49,5 +51,6 @@ module Cachext
 
   def self.configure &block
     @config = Configuration.setup(&block)
+    @client = Client.new @config
   end
 end

data/lib/cachext/breaker.rb

@@ -0,0 +1,90 @@
+require "thread"
+
+module Cachext
+  class Breaker
+    attr_reader :config
+
+    def initialize(config)
+      @config = config
+    end
+
+    def for(key)
+      WithKey.new(config, key)
+    end
+
+    class WithKey
+      attr_reader :config, :key
+
+      def initialize(config, key)
+        @config = config
+        @key = key
+      end
+
+      def increment_failure
+        redis.pipelined do
+          redis.set key_str(:last_failure), Time.now.to_f
+          redis.incr key_str(:monitor)
+        end
+      end
+
+      def check_health
+        if half_open?
+          if health_check >= config.failure_threshold
+            reset!
+          else
+            increment_health_check
+          end
+        end
+      end
+
+      def reset!
+        redis.del key_str(:monitor),
+                  key_str(:health_check),
+                  key_str(:last_failure)
+      end
+
+      def open?
+        state == :open
+      end
+
+      def half_open?
+        state == :half_open
+      end
+
+      def state
+        if (lf = last_failure) && (lf + config.breaker_timeout < Time.now.to_f)
+          :half_open
+        elsif monitor >= config.failure_threshold
+          :open
+        else
+          :close
+        end
+      end
+
+      def monitor
+        redis.get(key_str(:monitor)).to_i
+      end
+
+      def last_failure
+        lf = redis.get key_str(:last_failure)
+        lf.nil? ? nil : lf.to_f
+      end
+
+      def health_check
+        redis.get(key_str(:health_check)).to_i
+      end
+
+      def increment_health_check
+        redis.incr key_str(:health_check)
+      end
+
+      def key_str(name)
+        "#{name}:#{key.raw.map(&:to_s).join(":")}"
+      end
+
+      def redis
+        config.lock_redis
+      end
+    end
+  end
+end

data/lib/cachext/client.rb

@@ -5,6 +5,7 @@ module Cachext
     prepend Features::DebugLogging
     prepend Features::Lock
     prepend Features::Backup
+    prepend Features::CircuitBreaker
     prepend Features::Default
 
     def initialize config
@@ -45,7 +46,7 @@ module Cachext
     end
 
     def read key, options
-      key.read
+      key.read if options.cache?
     end
 
     def write key, fresh, options

data/lib/cachext/configuration.rb

@@ -13,7 +13,9 @@ module Cachext
                   :not_found_errors,   # array of errors where we delete the backup and reraise
                   :max_lock_wait,      # time in seconds to wait for a lock
                   :debug,              # output debug messages to STDERR
-                  :heartbeat_expires   # time in seconds for process heardbeat to expire
+                  :heartbeat_expires,  # time in seconds for process heardbeat to expire
+                  :failure_threshold,  # Number of tries before tripping circuit breaker
+                  :breaker_timeout     # time in seconds to wait before switching breaker to half-open
 
     MissingConfiguration = Class.new(StandardError)
 
@@ -47,6 +49,7 @@ module Cachext
       self.max_lock_wait = 5
       self.debug = ENV['CACHEXT_DEBUG'] == "true"
       self.heartbeat_expires = 2
+      self.failure_threshold = 3
       @debug_mutex = Mutex.new
     end
 

data/lib/cachext/features.rb

@@ -1,6 +1,7 @@
 module Cachext
   module Features
     autoload :Backup, "cachext/features/backup"
+    autoload :CircuitBreaker, "cachext/features/circuit_breaker"
     autoload :DebugLogging, "cachext/features/debug_logging"
     autoload :Default, "cachext/features/default"
     autoload :Lock, "cachext/features/lock"

data/lib/cachext/features/circuit_breaker.rb

@@ -0,0 +1,27 @@
+module Cachext
+  module Features
+    module CircuitBreaker
+      attr_reader :breaker
+
+      def initialize config
+        super
+        @breaker = Breaker.new(config)
+      end
+
+      def read key, options
+        circuit = breaker.for(key)
+        if circuit.open?
+          key.read_backup
+        else
+          circuit.check_health
+          super
+        end
+      end
+
+      def handle_error key, options, error
+        breaker.for(key).increment_failure
+        super
+      end
+    end
+  end
+end

data/lib/cachext/features/lock.rb

@@ -39,7 +39,7 @@ module Cachext
 
         block.call
       ensure
-        @config.lock_manager.unlock @lock_info
+        @config.lock_manager.unlock @lock_info if @lock_info
         done = true
       end
 
@@ -54,7 +54,7 @@ module Cachext
       end
 
       def wait_for_lock key, start_time
-        sleep rand
+        sleep rand(0..(@config.max_lock_wait / 2))
         if Time.now - start_time > @config.max_lock_wait
           raise TimeoutWaitingForLock
         end

data/lib/cachext/options.rb

@@ -14,7 +14,8 @@ module Cachext
                    errors: config.default_errors,
                    reraise_errors: true,
                    not_found_error: config.not_found_errors,
-                   heartbeat_expires: config.heartbeat_expires
+                   heartbeat_expires: config.heartbeat_expires,
+                   cache: true
 
       @expires_in = expires_in
       @default = default
@@ -22,6 +23,11 @@ module Cachext
       @reraise_errors = reraise_errors
       @not_found_error = not_found_error
       @heartbeat_expires = heartbeat_expires
+      @cache = cache
+    end
+
+    def cache?
+      @cache
     end
   end
 end

data/lib/cachext/version.rb

@@ -1,3 +1,3 @@
 module Cachext
-  VERSION = "0.3.2"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: cachext
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Donald Plummer
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-03-11 00:00:00.000000000 Z
+date: 2016-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.2'
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
@@ -164,6 +164,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Don't calculate the cached value twice at the same time. Use a backup
   of the data if the service is down.
 email:
@@ -183,10 +197,12 @@ files:
 - bin/setup
 - cachext.gemspec
 - lib/cachext.rb
+- lib/cachext/breaker.rb
 - lib/cachext/client.rb
 - lib/cachext/configuration.rb
 - lib/cachext/features.rb
 - lib/cachext/features/backup.rb
+- lib/cachext/features/circuit_breaker.rb
 - lib/cachext/features/debug_logging.rb
 - lib/cachext/features/default.rb
 - lib/cachext/features/lock.rb