rack-cache 1.11.1 → 1.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 72c6863d1ab30f180c440983790218237cb542bf35a9636a7de7ac05696a5849
-  data.tar.gz: 684819d0453cd2dda5484614710953e8bc195ff754aab219bc2c86ea6ced068a
+  metadata.gz: bb5dc6e1debaa841064dcf380a8015f6f63568187fda3ede9da81ed8d84041ec
+  data.tar.gz: 96c26c225e307ddaeaf6f8cbd5d219b0dacdcf18d9b36b11282af98a458af8be
 SHA512:
-  metadata.gz: 1ada4b8f869a5c8bb0308d2270351a42c280f2e1d6cba6553666d70878672ce702e132ace809ac7f5b30fb5704bfa8570b041d5fd00d5e1d7e479b9d445095c3
-  data.tar.gz: 4faff3e9359720d9328db752a14f4cf321ccf752806c07afbceca7fe476a389e4b23923f3819caa0fe568a56c235a5a3476a93bb502c5709a1403f316fff5f36
+  metadata.gz: b28a19dbb93f8eddce6bc7ab9e8307c9222c21131e5340db30b132c119ac8dbfd7079801365dbf987c68676f7605b26daab9bb03f996d2128c4ee9153a10006b
+  data.tar.gz: 4b810c3911b1e37dba674188165553c179da277f1ef0a7dd804afa8bc037f956f00322cfab0ab2d22a0e30e7ce44fb5eb1d07401c64b8b8c91f760c0a3c12b2c

data/CHANGES

@@ -1,3 +1,7 @@
+## 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

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/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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rack-cache
 version: !ruby/object:Gem::Version
-  version: 1.11.1
+  version: 1.12.0
 platform: ruby
 authors:
 - Ryan Tomayko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-06 00:00:00.000000000 Z
+date: 2020-06-06 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.1.3
 signing_key: 
 specification_version: 4
 summary: HTTP Caching for Rack