atomic_redis_cache 0.0.1

data/.gitignore

@@ -0,0 +1,10 @@
+*.sw?
+
+.ruby-version
+.ruby-gemset
+.bundle
+Gemfile.lock
+
+*.gem
+pkg
+vendor

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in atomic_redis_cache.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Anuj Das
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,58 @@
+# AtomicRedisCache
+
+AtomicRedisCache is an overlay on top of the redis-rb library that allows you to
+use Redis much like the Rails cache (ActiveSupport::Cache). It duplicates only
+the .fetch() method, which reads from a key if present and valid, or else
+evaluates the passed block and saves it as the new value at that key. The
+foremost design goals apply mainly to webapps and are twofold:
+- when cache expires, to avoid dogpile/thundering herd from multiple processes
+recalculating by serving the cached value to all but one process, then updating
+atomically when calculation by that process completes
+- when calculation takes too long (i.e., due to db, network calls) and a
+recently expired cached value is available, to fail fast with it and try
+calculating again later (for a reaosnable # of retries)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'atomic_redis_cache'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install atomic_redis_cache
+
+## Usage
+
+Ensure that you set the value of `AtomicRedisCache.redis`. This can be either an
+instance of redis-rb (or compatible), or a lambda/Proc evaluating to one. Ex.
+
+```
+AtomicRedisCache.redis = Redis.new(:host => '127.0.0.1', :port => 6379)
+```
+
+Then use it as you would Rails.cache:
+
+```
+>> v = AtomicRedisCache.fetch('key') { Faraday.get('example.com').status }
+=> 200  # network call made
+>> v = AtomicRedisCache.fetch('key') { }
+=> 200  # value read from cache
+```
+
+There are a couple of configurable options can be set per fetch:
+- `:expires_in` - expiry in seconds; defaults to a day
+- `:race_condition_ttl` - time to lock down key for recalculation
+- `:max_retries` - # of times to retry cache refresh before expiring
+
+## Contributing
+
+1. Fork it ( https://github.com/anujdas/atomic_redis_cache/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/atomic_redis_cache.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'atomic_redis_cache/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "atomic_redis_cache"
+  spec.version       = AtomicRedisCache::VERSION
+  spec.authors       = ["Anuj Das"]
+  spec.email         = ["anujdas@gmail.com"]
+  spec.summary       = %q{Use Redis as a multi-process atomic cache to avoid thundering herds and long calculations}
+  spec.description   = %q{}
+  spec.homepage      = "https://github.com/anujdas/atomic_redis_cache"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^spec/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'redis'
+
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'fakeredis'
+end

data/lib/atomic_redis_cache/version.rb

@@ -0,0 +1,3 @@
+module AtomicRedisCache
+  VERSION = "0.0.1"
+end

data/lib/atomic_redis_cache.rb

@@ -0,0 +1,61 @@
+require 'atomic_redis_cache/version'
+
+module AtomicRedisCache
+  DEFAULT_EXPIRATION = 60*60*24  # 86400 seconds in a day
+  DEFAULT_RACE_TTL = 30          # seconds to acquire new value
+  MAX_RETRIES = 3                # recalc attempts before expiring cache
+
+  class << self
+    attr_writer :redis
+
+    # Fetch from cache with fallback, just like ActiveSupport::Cache.
+    # The main differences are in the edge cases around expiration.
+    # - when cache expires, we avoid dogpile/thundering herd
+    #   from multiple processes recalculating at once
+    # - when calculation takes too long (i.e., due to network traffic)
+    #   we return the previously cached value for several attempts
+    # Options:
+    # :expires_in - expiry in seconds; defaults to a day
+    # :race_condition_ttl - time to lock value for recalculation
+    # :max_retries - # of times to retry cache refresh before expiring
+    def fetch(key, opts={}, &blk)
+      expires_in = opts[:expires_in] || DEFAULT_EXPIRATION
+      race_ttl   = opts[:race_condition_ttl] || DEFAULT_RACE_TTL
+      retries    = opts[:max_retries] || MAX_RETRIES
+
+      now        = Time.now.to_i
+      ttl        = expires_in + retries * race_ttl
+      t_key      = "timer:#{key}"
+
+      if val = redis.get(key)              # cache hit
+        if redis.get(t_key).to_i < now     # expired entry or dne
+          redis.set t_key, now + race_ttl  # block other callers for recalc duration
+          begin
+            Timeout.timeout(race_ttl) do   # if recalc exceeds race_ttl, abort
+              val = Marshal.dump(blk.call) # determine new value
+              redis.multi do               # atomically cache + mark as valid
+                redis.setex key, ttl, val
+                redis.set t_key, now + expires_in
+              end
+            end
+          rescue Timeout::Error => e       # eval timed out, use cached val
+          end
+        end
+      else                                 # cache miss
+        val = Marshal.dump(blk.call)       # determine new value
+        redis.multi do                     # atomically cache + mark as valid
+          redis.setex key, ttl, val
+          redis.set t_key, now + expires_in
+        end
+      end
+
+      Marshal.load(val)
+    end
+
+    def redis
+      raise 'AtomicRedisCache.redis must be set before use.' unless @redis
+      @redis.respond_to?(:call) ? @redis.call : @redis
+    end
+    private :redis
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'rspec'
+require 'fakeredis/rspec'

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: atomic_redis_cache
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Anuj Das
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: fakeredis
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email:
+- anujdas@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- atomic_redis_cache.gemspec
+- lib/atomic_redis_cache.rb
+- lib/atomic_redis_cache/version.rb
+- spec/spec_helper.rb
+- spec/unit/.gitkeep
+homepage: https://github.com/anujdas/atomic_redis_cache
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Use Redis as a multi-process atomic cache to avoid thundering herds and long
+  calculations
+test_files:
+- spec/spec_helper.rb
+- spec/unit/.gitkeep