response_bank 1.6.0 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4049027dc5a512bb6f1225b179ac82989b995e8e77f0b384fce0154c58cd76c0
-  data.tar.gz: 0351324db2bb6a5d00d2585d7e2fb52d5f1f17860f19ec56e23bc848d411ce0f
+  metadata.gz: 29c24e1f40f49dfe75fb0fee30851a8892ed5ca93d3740038fc059c3eb23eac1
+  data.tar.gz: 6b1d0473f7abcf5b7b3377da97e67d4954fd14f90b9c4a75b7ebe3d0f136d8e7
 SHA512:
-  metadata.gz: 278e15de6e89c0a006c13da52ff42a326be704050ef905d8ad7c0541a8444359253923a9331747440f72fe2855ac7addf3af3b917c75c5a2775c052618aa62fb
-  data.tar.gz: 9ec95ddb14b3a4d6763dd7ddd0e40b9f5367a3943baad464890b64723747b849627cbb513e1d3b982640563f3c73e1f18d8a437470e6303853369c07bf9b8154
+  metadata.gz: 06d5965eed82aba811616d52444a07287e566aff3f43451d1ff343eb55b2f8be47773daa8a9388589e69465e2d728654162925108614fbdd39c173bc16671e2f
+  data.tar.gz: 5f47dd03e0ed7fc61ef67306416040be136faa4e6c1fe0bc8552a3ef150b531cad370212772420bdfe36452d3918adf38722da7e56b560a8f892db6fb43a2456

data/README.md

@@ -305,6 +305,19 @@ Advanced integrations can still install the per-request injector directly in the
 env[ResponseBank::BrotliSpliceSlot::INJECTOR_ENV_KEY] = injector
 ```
 
+## Observing server cache hits
+
+After successfully serving an entry from the server cache, ResponseBank exposes its generation time and stale-while-revalidate status in the Rack environment:
+
+```ruby
+timestamp = env['cacheable.timestamp']
+stale = env['cacheable.stale']
+```
+
+`cacheable.timestamp` is only set after successfully serving a server-cache entry.
+`cacheable.stale` is initialized to `false` when a server-cache entry is evaluated
+and set to `true` only when ResponseBank serves it through stale-while-revalidate.
+
 ## Exception Handling
 
 ResponseBank handles all exceptions gracefully during cache operations. If an exception occurs while reading from cache, deserializing cached data, or writing to cache, the middleware will:

data/lib/response_bank/response_cache_handler.rb

@@ -133,6 +133,7 @@ module ResponseBank
         @env['cacheable.compression_level'] = compression_level
 
         @env['cacheable.locked'] ||= false
+        @env['cacheable.stale'] = false
 
         # to preserve the unversioned/versioned logging messages from past releases we split the match_entity_tag test
         if match_entity_tag == "*"
@@ -149,6 +150,7 @@ module ResponseBank
             return
           elsif stale_while_revalidate?(timestamp, cache_age_tolerance)
             # cache is being regenerated, can we avoid piling on and use a stale version in the interim?
+            @env['cacheable.stale'] = true
             ResponseBank.log("Cache hit: server (recent)")
           else
             ResponseBank.log("Found an unversioned cache entry, but it was too old (#{timestamp})")
@@ -184,6 +186,7 @@ module ResponseBank
           @env.delete(ResponseBank::METADATA_ENV_KEY)
         end
 
+        @env['cacheable.timestamp'] = timestamp
         [status, @headers, [body]]
 
       end

data/lib/response_bank/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module ResponseBank
-  VERSION = "1.6.0"
+  VERSION = "1.8.0"
 end

data/lib/response_bank.rb

@@ -114,16 +114,20 @@ module ResponseBank
       when Hash
         return data.inspect unless data.key?(:key)
 
-        key = hash_value_str(data[:key])
+        # Components are joined as bytes, so values in different encodings can't raise.
+        key = String.new(encoding: Encoding::BINARY)
 
-        key = %{#{data[:key_schema_version]}:#{key}} if data[:key_schema_version]
+        key << hash_value_str(data[:key_schema_version]) << ":" if data[:key_schema_version]
 
-        key = %{#{key}:#{hash_value_str(data[:version])}} if data[:version]
+        key << hash_value_str(data[:key])
+
+        key << ":" << hash_value_str(data[:version]) if data[:version]
 
         # add the encoding to only the cache key but don't expose this detail in the entity_tag
-        key = %{#{key}:#{hash_value_str(data[:encoding])}} if data[:encoding]
+        key << ":" << hash_value_str(data[:encoding]) if data[:encoding]
 
-        key
+        key.force_encoding(Encoding::UTF_8)
+        key.valid_encoding? ? key : key.force_encoding(Encoding::BINARY)
       when Array
         data.inspect
       when Time, DateTime
@@ -152,10 +156,32 @@ module ResponseBank
 
     def hash_value_str(data)
       if data.is_a?(Hash)
-        data.values.join(",")
+        append_key_component(String.new(encoding: Encoding::BINARY), data)
+      else
+        data.to_s.b
+      end
+    end
+
+    # Hashes and Arrays are written as a type tag and element count, followed
+    # by their elements; Hash entries are written as name then value, in
+    # insertion order. Every other value is written as the byte length of its
+    # #to_s followed by those bytes, so no value can be read as part of another.
+    def append_key_component(buffer, data)
+      case data
+      when Hash
+        buffer << "h" << data.size.to_s << ":"
+        data.each do |name, value|
+          append_key_component(buffer, name)
+          append_key_component(buffer, value)
+        end
+      when Array
+        buffer << "a" << data.size.to_s << ":"
+        data.each { |value| append_key_component(buffer, value) }
       else
-        data.to_s
+        value = data.to_s.b
+        buffer << value.bytesize.to_s << ":" << value
       end
+      buffer
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: response_bank
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.8.0
 platform: ruby
 authors:
 - Tobias Lütke
@@ -176,7 +176,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.21
+rubygems_version: 4.0.23
 specification_version: 4
 summary: Simple response caching for Ruby applications
 test_files: []