matador 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6256fdbcce0efe4709e095ff091d42043ae112c4
+  data.tar.gz: f69fbf4b7b818efff53d920749ee7c59938de7f5
+SHA512:
+  metadata.gz: 83e8a3c051a03ff5583f85d87f83a634d4ab77cb9a07bfbf834a7cee2465821d8c52343a8706d88117df129110faf404798f6e8a5d2139ca579bf2b741dcc618
+  data.tar.gz: 6d1ccab8eecfa921b2e456296c9a5a7696168519ca6ea949a5c932c76320a4d1be5455ab6481e21840c96b54ad95090378ed51860da8d4bc90ed4aeb00c84959

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.ruby-version

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 2.1.2
+services:
+  - redis
+branches:
+  only:
+    - master
+

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Steven Li
+
+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,59 @@
+# Matador
+
+[![Build Status](https://travis-ci.org/StevenJL/matador.svg?branch=master)](https://travis-ci.org/StevenJL/matador)
+
+Stop cache expiration triggered [thundering herd](https://en.wikipedia.org/wiki/Thundering_herd_problem) problems with Matador. Currently works with redis.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'matador'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install matador
+
+## Usage
+
+Set your cache service object (currently only supports redis)
+```ruby
+require "matador"
+require "redis"
+
+$redis = Redis.new(host: "127.0.0.1", port: "16379")
+Matador.cache_store = $redis
+```
+
+Caching with an expiration is susceptible to a thundering herd in high traffic situations:
+
+```ruby
+data = time_consuming_operation(...)
+$redis.set("some_key", data)
+$redis.expire("some_key", 120)
+```
+
+Wrap it in matador.  When the cache expires after 2 minutes, the first request goes through to generate the new cache.  While the new cache is being built (next 10 seconds), all other requests are served the stale cache.
+
+```ruby
+Matador.fetch("some_key", :ttl => 120, :therd_ttl => 10) do
+  time_consuming_operation
+end
+```
+
+## TO DO
+
+1. Integrate with Memcache
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/matador/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 new Pull Request
+

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+task default: :spec
+
+RSpec::Core::RakeTask.new
+
+namespace :spec do
+    Rake::Task["spec"].invoke
+end
+

data/lib/matador.rb

@@ -0,0 +1,19 @@
+$:.unshift(File.expand_path("../", __FILE__))
+
+module Matador
+  autoload :VERSION, "matador/version"
+  autoload :Fetcher, "matador/fetcher"
+
+  def self.cache_store=(cache_store_arg)
+    @@cache_store = cache_store_arg
+  end
+
+  def self.cache_store
+    @@cache_store
+  end
+
+  def self.fetch(key, options={}, &block)
+    Matador::Fetcher.new(key, options, block).perform 
+  end
+end
+

data/lib/matador/fetcher.rb

@@ -0,0 +1,93 @@
+module Matador
+  class Fetcher
+    attr_reader :key, :ttl, :therd_ttl, :block
+
+    def initialize(key, options, block)
+      @key = key
+      @ttl = options[:ttl]
+      @therd_ttl = options[:therd_ttl]
+      @block = block
+    end
+
+    def perform
+      if (cache_valid? && (valid_cache = current_cache))
+        valid_cache
+      elsif !(cache_valid? || locked_for_rebuilding_cache?)
+        # cache just expired but no request has gone through yet
+        rebuild_cache_with_first_request
+      elsif (locked_for_rebuilding_cache? && (stale_value = current_cache))
+        # first request already went through
+        # serving up stale value while new cache is built
+        stale_value
+      else  
+        # fallback case (this should be a rare occurence)
+        # Happens if therd_ttl isn't long enough
+        # or cache_store evicted key 
+        # or cache_store failed to save key in the first place
+        
+        if locked_for_rebuilding_cache?
+          # already rebuilding cache so just return the value
+          block.call 
+        else
+          # have not started rebuilding cache 
+          # so this becomes the "first request"
+          rebuild_cache_with_first_request 
+        end
+      end
+    end
+
+    private
+    def locked_for_rebuilding_cache?
+      !!cache_store.get(key_rebuilding)
+    end
+
+    def cache_valid?
+      !!cache_store.get(key_nominal_ttl)
+    end
+
+    def current_cache
+      cache_store.get(key)
+    end
+
+    def cache_store
+      Matador.cache_store
+    end
+
+    def rebuild_cache_with_first_request
+      lock_rebuilding_cache
+      
+      new_value = block.call
+      # compute new value
+
+      cache_store.set(key, new_value)
+      cache_store.expire(key, ttl + therd_ttl)
+      # cache new value and expire accordingly
+     
+      cache_store.set(key_nominal_ttl, "1")
+      cache_store.expire(key_nominal_ttl, ttl)
+      # set the nominal (ie. end user) ttl
+
+      unlock_rebuilding_cache
+
+      new_value
+    end
+
+    def lock_rebuilding_cache
+      cache_store.set(key_rebuilding, "1") 
+      cache_store.expire(key_rebuilding, therd_ttl)
+    end
+
+    def unlock_rebuilding_cache
+      cache_store.del(key_rebuilding)
+    end
+
+    def key_nominal_ttl
+      "matador:nominal_ttl:#{key}"
+    end
+
+    def key_rebuilding
+      "matador:rebuilding:#{key}"
+    end
+  end
+end
+

data/lib/matador/version.rb

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

data/matador.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'matador/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "matador"
+  spec.version       = Matador::VERSION
+  spec.authors       = ["Steven Li"]
+  spec.email         = ["sli@bleacherreport.com"]
+  spec.summary       = %q{Prevent cache-expiration-triggered thundering herds}
+  spec.description   = %q{Prevent cache-expiration-triggered thundering herds}
+  spec.homepage      = ""
+  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{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "redis", "3.1.0"
+  spec.add_development_dependency "rspec", "3.0.0"
+  spec.add_development_dependency "pry", "0.10.1"
+end

data/spec/lib/matador/fetcher_spec.rb

@@ -0,0 +1,148 @@
+require "spec_helper"
+
+describe Matador::Fetcher do
+  before(:all) do
+    @redis = Redis.new(host: "127.0.0.1", port: "6379")
+    Matador.cache_store = @redis 
+    @redis.del("test_key1")
+    @redis.del("matador:nominal_ttl:test_key1")
+    @redis.del("matador:rebuilding:test_key1")
+  end
+
+  context "#fetch" do
+    after(:each) do
+      @redis.del("test_key1")
+      @redis.del("matador:nominal_ttl:test_key1")
+      @redis.del("matador:rebuilding:test_key1")
+    end
+
+    it "#fetch gets the cache if it is still valid" do
+      Matador.fetch("test_key1", :ttl => 60, :therd_ttl => 10) do
+        "foobar"
+      end
+      # set value to foobar
+
+      value = Matador.fetch("test_key1", :ttl => 60, :therd_ttl => 10) do
+        "foobaz"
+      end
+      # cache should still be active so value sould be foobar, not foobaz
+
+      expect(value == "foobar").to be true
+    end
+   
+    it "#fetch kicks off a single request to rebuild cache after it expires" do
+      Matador::Fetcher.any_instance.stub(:rebuild_cache_with_first_request).and_return("first_of_the_herd")
+
+      Matador.fetch("test_key1", :ttl => 1, :therd_ttl => 5) do
+        "foobar"
+      end
+
+      sleep 2
+
+      value = Matador.fetch("test_key1", :ttl => 1, :therd_ttl => 5) do
+        "foobaz"
+      end
+
+      expect(value).to eq("first_of_the_herd")
+    end
+
+    it "#fetch returns stale_value after first post-expiration request went through to rebuild cache" do
+      Matador::Fetcher.any_instance.stub(:locked_for_rebuilding_cache?).and_return(true)
+      Matador::Fetcher.any_instance.stub(:valid_cache?).and_return(false)
+      Matador::Fetcher.any_instance.stub(:current_cache).and_return("stale cache")
+
+      value = Matador.fetch("test_key1", :ttl => 1, :therd_ttl => 5) do
+        "foobar"
+      end
+      
+      expect(value).to eq("stale cache")
+    end
+
+    it "no matter how many requests come in after the first request, they do not rebuild the cache" do
+      @redis.set("test_key1", "stale_cache")
+
+      Thread.new do
+        Matador.fetch("test_key1", :ttl => 100, :therd_ttl => 12) do
+          sleep 10 
+          "foobar"
+        end
+      end
+
+      sleep 2
+
+      value1 = Matador.fetch("test_key1", :ttl => 100, :therd_ttl => 10) do
+        "foobar"
+      end
+
+      sleep 2 
+
+      value2 = Matador.fetch("test_key1", :ttl => 100, :therd_ttl => 10) do
+        "foobar"
+      end
+
+      sleep 2
+
+      value3 = Matador.fetch("test_key1", :ttl => 100, :therd_ttl => 10) do
+        "foobar"
+      end
+
+      sleep 8
+
+      value4 = Matador.fetch("test_key1", :ttl => 100, :therd_ttl => 10) do
+        "foobar"
+      end
+   
+      expect(value1).to eq("stale_cache")
+      expect(value2).to eq("stale_cache")
+      expect(value3).to eq("stale_cache")
+      expect(value4).to eq("foobar")
+    end
+
+    context "when therd_ttl is not long enough" do
+      after(:each) do
+        @redis.del("test_key1")
+        @redis.del("matador:nominal_ttl:test_key1")
+        @redis.del("matador:rebuilding:test_key1")
+      end
+
+      it "returns the computation once while cache is building in the background" do
+        @redis.set("test_key1", "stale_cache")
+
+        Thread.new do
+          Matador.fetch("test_key1", :ttl => 100, :therd_ttl => 5) do
+            sleep 10 
+            "foobar"
+          end
+        end
+
+        value = Matador.fetch("test_key1", :ttl => 100, :therd_ttl => 10) do
+          "foobaz"
+        end
+
+        expect(value).to eq("foobaz")
+      end
+
+      it "rebuilds the cache with first request if that has not happened already" do
+        @redis.set("test_key1", "stale_cache")
+
+        Thread.new do
+          Matador.fetch("test_key1", :ttl => 100, :therd_ttl => 3) do
+            sleep 100
+            "foobar"
+          end
+        end
+
+        sleep 5
+
+        Matador.fetch("test_key1", :ttl => 100, :therd_ttl => 10) do
+          "foobaz"
+        end
+
+        value = @redis.get("test_key1")
+
+        expect(value).to eq("foobaz")
+      end
+    end
+  end
+end
+

data/spec/matador_spec.rb

@@ -0,0 +1,12 @@
+$root = File.expand_path('../../', __FILE__)
+require "#{$root}/spec/spec_helper"
+
+describe Matador do
+  it "registers a cache_store" do
+    redis = Redis.new(host: "127.0.0.1", port: "6379")
+    Matador.cache_store = redis
+
+    expect(Matador.cache_store).to be_a Redis
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require "redis"
+
+$root = File.expand_path("../../", __FILE__)
+
+require "#{$root}/lib/matador"
+
+

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: matador
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Steven Li
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+description: Prevent cache-expiration-triggered thundering herds
+email:
+- sli@bleacherreport.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/matador.rb
+- lib/matador/fetcher.rb
+- lib/matador/version.rb
+- matador.gemspec
+- spec/lib/matador/fetcher_spec.rb
+- spec/matador_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.2
+signing_key: 
+specification_version: 4
+summary: Prevent cache-expiration-triggered thundering herds
+test_files:
+- spec/lib/matador/fetcher_spec.rb
+- spec/matador_spec.rb
+- spec/spec_helper.rb