rack-cache 1.11.0 → 1.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e2ca34b16edeb06ab8ce7df32ad78b273b600cd950ce3b56d03b898bf00e53f
-  data.tar.gz: 5d35c87987859feb36e5f24b3b065ac790c6dc4f3df0969e41aaa6f15819ab94
+  metadata.gz: 2d031263204dbdf38df4290dfcda6ebf48f349d69b6499a878e616a18f0ff914
+  data.tar.gz: a4153ac38a62c88f8bae3e760d1a903dfbb1ba641f086d1dbd32bca20a81d118
 SHA512:
-  metadata.gz: 1d156a65178883329c11d00024f60af8d013cd4fe2a3def6d930c43d822c76dd1bd9b6d26d965209fbfdc038e79cff96a5efd973deadace39e0b83097c332ec5
-  data.tar.gz: 9a3b6fdc70f24de95a8cc02d3d9180c5c59f277156605ddca2b295e56542f81b0433fb8da279d0f337d49d4352e0e2500be4a468fc75a61c5b13eadccf1b3cc7
+  metadata.gz: c627fb81cd7eee48a3d54d9a07942b8b62b1fd480d1a89bfc58a717fd400a8f7e2d8453c336e2090c9bed92f410bf1f31a3bbe6a49f42d7b262e0da81c98b55d
+  data.tar.gz: 9329f2fd9d67707fd984a0dc9c8fc9030687d3b08e3a1a34a4efc168e5840d97be4dc065a3af6e7516ca821d1cf285ef7a29562b3d84788e6ae200b19c86b7c9

data/CHANGES

@@ -1,3 +1,11 @@
+## 1.12.0
+
+ * Add a fault_tolerant flag to fail-over to stale cache
+
+## 1.11.1
+
+ * when ignoring parts of the query, remove query in key when all params are ignored
+
 ## 1.11.0
 
  * Add a proc to allow ignoring parts of the query string in the key

data/README.md

@@ -16,7 +16,7 @@ validation (Last-Modified, ETag) information:
 
 For more information about Rack::Cache features and usage, see:
 
-http://rtomayko.github.com/rack-cache/
+https://rtomayko.github.com/rack-cache/
 
 Rack::Cache is not overly optimized for performance. The main goal of the
 project is to provide a portable, easy-to-configure, and standards-based
@@ -70,7 +70,7 @@ You should now see `Rack::Cache` listed in the middleware pipeline:
 
     rake middleware
 
-[more information](http://snippets.aktagon.com/snippets/302-how-to-setup-and-use-rack-cache-with-rails)
+[more information](https://snippets.aktagon.com/snippets/302-how-to-setup-and-use-rack-cache-with-rails)
 
 Using with Dalli
 ----------------

data/lib/rack/cache/context.rb

@@ -161,10 +161,12 @@ module Rack::Cache
     end
 
     # Try to serve the response from cache. When a matching cache entry is
-    # found and is fresh, use it as the response without forwarding any
-    # request to the backend. When a matching cache entry is found but is
-    # stale, attempt to #validate the entry with the backend using conditional
-    # GET. When no matching cache entry is found, trigger #miss processing.
+    # found and is fresh, use it as the response without forwarding any request
+    # to the backend. When a matching cache entry is found but is stale, attempt
+    # to #validate the entry with the backend using conditional GET.
+    # If validation raises an exception and fault tolerant caching is enabled,
+    # serve the stale cache entry.
+    # When no matching cache entry is found, trigger miss processing.
     def lookup
       if @request.no_cache? && allow_reload?
         record :reload
@@ -183,7 +185,11 @@ module Rack::Cache
             entry
           else
             record :stale
-            validate(entry)
+            if fault_tolerant?
+              validate_with_stale_cache_failover(entry)
+            else
+              validate(entry)
+            end
           end
         else
           record :miss
@@ -192,6 +198,17 @@ module Rack::Cache
       end
     end
 
+    # Returns stale cache on exception.
+    def validate_with_stale_cache_failover(entry)
+      validate(entry)
+    rescue => e
+      record :connnection_failed
+      age = entry.age.to_s
+      entry.headers['Age'] = age
+      record "Fail-over to stale cache data with age #{age} due to #{e.class.name}: #{e}"
+      entry
+    end
+
     # Validate that the cache entry is fresh. The original request is used
     # as a template for a conditional GET request with the backend.
     def validate(entry)

data/lib/rack/cache/key.rb

@@ -62,7 +62,7 @@ module Rack::Cache
       parts.sort!
       parts.reject!(&self.class.query_string_ignore)
       parts.map! { |k,v| "#{escape(k)}=#{escape(v)}" }
-      parts.join('&')
+      parts.empty? ? nil : parts.join('&')
     end
   end
 end

data/lib/rack/cache/meta_store.rb

@@ -34,7 +34,7 @@ module Rack::Cache
 
       # find a cached entry that matches the request.
       env = request.env
-      match = entries.detect{|req,res| requests_match?(res['Vary'], env, req)}
+      match = entries.detect{ |req,res| requests_match?((res['Vary'] || res['vary']), env, req) }
       return nil if match.nil?
 
       _, res = match
@@ -90,13 +90,14 @@ module Rack::Cache
       # the list
       vary = response.vary
       entries =
-        read(key).reject do |env,res|
-          (vary == res['Vary']) &&
+        read(key).reject do |env, res|
+          (vary == (res['Vary'] || res['vary'])) &&
             requests_match?(vary, env, stored_env)
         end
 
       headers = persist_response(response)
-      headers.delete 'Age'
+      headers.delete('Age')
+      headers.delete('age')
 
       entries.unshift [stored_env, headers]
       if request.env['rack-cache.use_native_ttl'] && response.fresh?

data/lib/rack/cache/options.rb

@@ -107,6 +107,10 @@ module Rack::Cache
     # be used.
     option_accessor :use_native_ttl
 
+    # Specifies whether to serve a request from a stale cache entry if
+    # the attempt to revalidate the cache entry raises an exception.
+    option_accessor :fault_tolerant
+
     # The underlying options Hash. During initialization (or outside of a
     # request), this is a default values Hash. During a request, this is the
     # Rack environment Hash. The default values Hash is merged in underneath
@@ -149,6 +153,7 @@ module Rack::Cache
         'rack-cache.allow_reload'     => false,
         'rack-cache.allow_revalidate' => false,
         'rack-cache.use_native_ttl'   => false,
+        'rack-cache.fault_tolerant'   => false,
       }
       self.options = options
     end

data/lib/rack/cache/response.rb

@@ -40,6 +40,7 @@ module Rack::Cache
     def initialize_copy(other)
       super
       @headers = other.headers.dup
+      @cache_control = nil
     end
 
     # Return the status, headers, and body in a three-tuple.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rack-cache
 version: !ruby/object:Gem::Version
-  version: 1.11.0
+  version: 1.13.0
 platform: ruby
 authors:
 - Ryan Tomayko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-06 00:00:00.000000000 Z
+date: 2021-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -163,7 +163,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.16
 signing_key: 
 specification_version: 4
 summary: HTTP Caching for Rack