cachext 0.4.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e419955af90b08b1ace8f3cf427e0405ae0bb3a3
-  data.tar.gz: 5fd6b8a4944d03bc0250e758f51cba8cacab2e5b
+  metadata.gz: 5da982260e1706152de87d9c872a5afa37867ce1
+  data.tar.gz: 1d079cce845a3f8e0a2af95f86a8be384f8523f6
 SHA512:
-  metadata.gz: a6d23554e9c0ae9a0dbf18c19658e9164f9d580cc40ade0c0e85e67bc69df5e6d5713b959f8c0a68c54812249b6538eef8c96472c56ef16a95ea21c1623961b9
-  data.tar.gz: d34ca43dd664e490f4aae01d4c0e683185a632532445ce45c7495978922bd24fa5910f8d5e64454e2593865cd4d209dedd9e2177aff4d292e6a2ff10575e59c7
+  metadata.gz: de945e54a8b4d22408b645383b57b586122041e96c5d35bf29c7dd23402938474f2f85dec7bd43ce8f08034580de10d7f08c7944915a5d0b723a167a57766983
+  data.tar.gz: c96fcf677dfd5712994c451e5fb5677b195da74ed74d193e2eac59be93ce691db0e8b5e1b5edae46479930734867ae3353d558a2e1babc95aa01dac7e951a2b8

data/README.md

@@ -8,6 +8,7 @@ Extensions to normal Rails caching:
 
 * Lock (inspired by https://github.com/seamusabshere/lock_and_cache)
 * Backup
+* Circuit breaker
 
 ## Quickstart
 
@@ -119,6 +120,19 @@ Cachext.config.error_logger = nil
 
 If set to an object that responds to call, will `call` with any errors caught.
 
+```ruby
+Cachext.config.failure_threshold = 3
+```
+
+Number of tries before tripping circuit breaker.
+
+```ruby
+Cachext.config.breaker_timeout = 60
+```
+
+Time in seconds to wait before switching breaker to half-open.
+
+
 ## Usage
 
 ```ruby
@@ -129,11 +143,14 @@ Available options:
 
 * `expires_in`: override for the `default_expires_in`, in seconds
 * `default`: object or proc that will be used as the default if no backup is found
-* `errors`: override for the `default_errors` to be caught
-* `reraise_errors`: default `true`, if set to `false` NotFound errors will not
-  be raised
-* `not_found_error`: override for `not_found_errors`
-* `heartbeat_expires`: override for `heartbeat_expires`
+* `errors`: override for the `default_errors`: array of errors to catch and not reraise
+* `reraise_errors`: default `true`, if set to `false` NotFound errors will not be raised
+* `not_found_error`: (override) array of errors where we delete the backup and reraise
+* `heartbeat_expires`: (override) time in seconds for process heardbeat to expire
+* `failure_threshold`: (override) Number of tries before tripping circuit breaker
+* `breaker_timeout`: (override) time in seconds to wait before switching breaker to half-open
+* `cache`: use the first-level cache, defaults to true. If set to false, will always call the
+  fallback, but if an error is raised, will use the last known good value.
 
 ```ruby
 Cachext.multi key_base, ids, options, &block

data/cachext.gemspec

@@ -15,17 +15,14 @@ Gem::Specification.new do |spec|
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "activesupport", "~> 4.2"
+  spec.add_dependency "faraday"
   spec.add_dependency "redis"
-  spec.add_dependency "redis-namespace"
   spec.add_dependency "redlock"
-  spec.add_dependency "faraday"
   spec.add_dependency "dalli"
 
+  spec.add_development_dependency "activesupport"
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec"

data/lib/cachext.rb

@@ -1,5 +1,4 @@
 require "cachext/version"
-require "faraday/error"
 
 module Cachext
   autoload :Breaker, "cachext/breaker"
@@ -50,7 +49,12 @@ module Cachext
   end
 
   def self.configure &block
+    @config_block = block
     @config = Configuration.setup(&block)
     @client = Client.new @config
   end
+
+  def self.forked!
+    configure(&@config_block)
+  end
 end

data/lib/cachext/breaker.rb

@@ -21,9 +21,9 @@ module Cachext
       end
 
       def increment_failure
-        redis.pipelined do
-          redis.set key_str(:last_failure), Time.now.to_f
-          redis.incr key_str(:monitor)
+        lock_redis.pipelined do
+          lock_redis.set key_str(:last_failure), Time.now.to_f
+          lock_redis.incr key_str(:monitor)
         end
       end
 
@@ -38,7 +38,7 @@ module Cachext
       end
 
       def reset!
-        redis.del key_str(:monitor),
+        lock_redis.del key_str(:monitor),
                   key_str(:health_check),
                   key_str(:last_failure)
       end
@@ -62,27 +62,27 @@ module Cachext
       end
 
       def monitor
-        redis.get(key_str(:monitor)).to_i
+        lock_redis.get(key_str(:monitor)).to_i
       end
 
       def last_failure
-        lf = redis.get key_str(:last_failure)
+        lf = lock_redis.get key_str(:last_failure)
         lf.nil? ? nil : lf.to_f
       end
 
       def health_check
-        redis.get(key_str(:health_check)).to_i
+        lock_redis.get(key_str(:health_check)).to_i
       end
 
       def increment_health_check
-        redis.incr key_str(:health_check)
+        lock_redis.incr key_str(:health_check)
       end
 
       def key_str(name)
-        "#{name}:#{key.raw.map(&:to_s).join(":")}"
+        "cachext:#{name}:#{key.raw.map(&:to_s).join(":")}"
       end
 
-      def redis
+      def lock_redis
         config.lock_redis
       end
     end

data/lib/cachext/client.rb

@@ -50,7 +50,7 @@ module Cachext
     end
 
     def write key, fresh, options
-      key.write fresh, expires_in: options.expires_in
+      key.write fresh, expires_in: options.expires_in if options.cache?
     end
   end
 end

data/lib/cachext/configuration.rb

@@ -1,6 +1,6 @@
 require "redlock"
-require "redis-namespace"
 require "thread"
+require "faraday/error"
 
 module Cachext
   class Configuration
@@ -59,7 +59,7 @@ module Cachext
     end
 
     def lock_redis
-      @lock_redis ||= Redis::Namespace.new :cachext, redis: redis
+      redis
     end
 
     def log_errors?
@@ -69,7 +69,7 @@ module Cachext
     def debug
       if block_given?
         if @debug
-          @mutex.synchronize do
+          @debug_mutex.synchronize do
             yield
           end
         end

data/lib/cachext/features/circuit_breaker.rb

@@ -11,7 +11,9 @@ module Cachext
       def read key, options
         circuit = breaker.for(key)
         if circuit.open?
-          key.read_backup
+          val = key.read_backup
+          debug_log { { m: :circuit_open, key: key, msg: "Circuit breaker open, reading from backup", val: val.inspect } }
+          val
         else
           circuit.check_health
           super

data/lib/cachext/features/lock.rb

@@ -19,7 +19,7 @@ module Cachext
       end
 
       def call_block key, options, &block
-        with_heartbeat_extender key.digest, options.heartbeat_expires do
+        with_heartbeat_extender key.lock_key, options.heartbeat_expires do
           super
         end
       end
@@ -46,9 +46,9 @@ module Cachext
       def obtain_lock key, options
         start_time = Time.now
 
-        until lock_info ||= @config.lock_manager.lock(key.digest, (options.heartbeat_expires * 1000).ceil)
+        until lock_info ||= @config.lock_manager.lock(key.lock_key, (options.heartbeat_expires * 1000).ceil)
           if wait_for_lock(key, start_time) == :timeout
-            lock_info = @config.lock_manager.lock(key.digest, (options.heartbeat_expires * 1000).ceil)
+            lock_info = @config.lock_manager.lock(key.lock_key, (options.heartbeat_expires * 1000).ceil)
             raise TimeoutWaitingForLock unless lock_info
           end
         end

data/lib/cachext/key.rb

@@ -19,8 +19,12 @@ module Cachext
       [:backup_cache] + raw
     end
 
+    def lock_key
+      "cachext:lock:#{digest}"
+    end
+
     def locked?
-      lock_redis.exists digest
+      lock_redis.exists lock_key
     end
 
     def read

data/lib/cachext/multi.rb

@@ -106,7 +106,7 @@ module Cachext
 
       def lock_key_from_ids(ids)
         key = Key.new multi.key_base + ids
-        key.digest
+        key.lock_key
       end
 
       def write_cache records

data/lib/cachext/version.rb

@@ -1,3 +1,3 @@
 module Cachext
-  VERSION = "0.4.2"
+  VERSION = "0.5.0"
 end

metadata

@@ -1,31 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: cachext
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors:
 - Donald Plummer
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2016-07-19 00:00:00.000000000 Z
+date: 2017-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.2'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.2'
-- !ruby/object:Gem::Dependency
-  name: redis
+  name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: redis-namespace
+  name: redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: faraday
+  name: dalli
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,13 +67,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: dalli
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -231,7 +217,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Cache with lock and backup extensions