response_bank 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 75476fbf8271b8744fdca486f31ddfff585ab0680e29c600e25393d24b6b6fbb
-  data.tar.gz: 6092909983069ec5689e4e6ada0d241e632331fd6c97fb94e4ce5029c4cf228a
+  metadata.gz: 7d25739f9bd846e1cd3364a422cc90590b32fcb5f7e56cd307af0e83f0d5ddac
+  data.tar.gz: 14c1a7f96abcc45025cee9f998342fb6185779774dc72986ebb1a5bbcb96c413
 SHA512:
-  metadata.gz: ccade0feb4bcc259e6bd0d3435799960014f204031b564ca88892e5c80afce36997f266b91acb0eb2af1e64f80488af49166fe4a99ab2d31874cac9827e37eaa
-  data.tar.gz: 5e74d777bfd30f8eed957d5ed07d11ffab8e6d4d462194277b7a38c28b70728445d0c598a26173020fc1d26c3c11410aabc6cf7f79f5a06cd806546a687cff7e
+  metadata.gz: b6120bc7a707fa5ddd1cd3a143e40681e375864b075fe0e74b1128cc4ee460690400a70c47599772addba8d2bee56b02ce14a820c5e4af376f0eaa154f1fe88c
+  data.tar.gz: 5ae1545f2c40d7abbf06b8ba43c8d353cb171fc97ce667fa280c5f991c37f7e514c7673898a99242e446f9975ef22f4cb91eaa053165664a9c309fa4d6b39197

data/lib/response_bank/middleware.rb

@@ -1,11 +1,10 @@
 # frozen_string_literal: true
-require 'useragent'
 
 module ResponseBank
   class Middleware
     # Limit the cached headers
     # TODO: Make this lowercase/case-insentitive as per rfc2616 §4.2
-    CACHEABLE_HEADERS = ["Location", "Content-Type", "ETag", "Content-Encoding", "Last-Modified", "Cache-Control", "Expires", "Surrogate-Keys", "Cache-Tags"].freeze
+    CACHEABLE_HEADERS = ["Location", "Content-Type", "ETag", "Content-Encoding", "Last-Modified", "Cache-Control", "Expires", "Link", "Surrogate-Keys", "Cache-Tags"].freeze
 
     REQUESTED_WITH = "HTTP_X_REQUESTED_WITH"
     ACCEPT = "HTTP_ACCEPT"
@@ -17,7 +16,7 @@ module ResponseBank
 
     def call(env)
       env['cacheable.cache'] = false
-      gzip = env['gzip'] = env['HTTP_ACCEPT_ENCODING'].to_s.include?("gzip")
+      content_encoding = env['response_bank.server_cache_encoding'] = ResponseBank.check_encoding(env)
 
       status, headers, body = @app.call(env)
 
@@ -25,9 +24,6 @@ module ResponseBank
         if [200, 404, 301, 304].include?(status)
           headers['ETag'] = env['cacheable.key']
 
-          if ie_ajax_request?(env)
-            headers["Expires"] = "-1"
-          end
         end
 
         if [200, 404, 301].include?(status) && env['cacheable.miss']
@@ -39,11 +35,15 @@ module ResponseBank
             body.each { |part| body_string << part }
           end
 
-          body_gz = ResponseBank.compress(body_string)
+          body_compressed = nil
+          if body_string && body_string != ""
+            headers['Content-Encoding'] = content_encoding
+            body_compressed = ResponseBank.compress(body_string, content_encoding)
+          end
 
           cached_headers = headers.slice(*CACHEABLE_HEADERS)
           # Store result
-          cache_data = [status, cached_headers, body_gz, timestamp]
+          cache_data = [status, cached_headers, body_compressed, timestamp]
 
           ResponseBank.write_to_cache(env['cacheable.key']) do
             payload = MessagePack.dump(cache_data)
@@ -55,11 +55,15 @@ module ResponseBank
             )
           end
 
-          # since we had to generate the gz version above already we may
+          # since we had to generate the compressed version already we may
           # as well serve it if the client wants it
-          if gzip
-            headers['Content-Encoding'] = "gzip"
-            body = [body_gz]
+          if body_compressed
+            if env['HTTP_ACCEPT_ENCODING'].to_s.include?(content_encoding)
+              body = [body_compressed]
+            else
+              # Remove content-encoding header for response with compressed content
+              headers.delete('Content-Encoding')
+            end
           end
         end
 
@@ -79,14 +83,5 @@ module ResponseBank
       Time.now.to_i
     end
 
-    def ie_ajax_request?(env)
-      return false unless !env[USER_AGENT].nil? && !env[USER_AGENT].empty?
-
-      if env[REQUESTED_WITH] == "XmlHttpRequest" || env[ACCEPT] == "application/json"
-        UserAgent.parse(env["HTTP_USER_AGENT"]).is_a?(UserAgent::Browsers::InternetExplorer)
-      else
-        false
-      end
-    end
   end
 end

data/lib/response_bank/response_cache_handler.rb

@@ -55,7 +55,7 @@ module ResponseBank
     private
 
     def hash(key)
-      "cacheable:#{Digest::MD5.hexdigest(key)}"
+      "cacheable:" + Digest::MD5.hexdigest(key)
     end
 
     def entity_tag
@@ -63,7 +63,7 @@ module ResponseBank
     end
 
     def cache_key
-      @cache_key ||= ResponseBank.cache_key_for(key: @key_data, key_schema_version: @key_schema_version)
+      @cache_key ||= ResponseBank.cache_key_for(key: @key_data, key_schema_version: @key_schema_version, encoding: @env['response_bank.server_cache_encoding'])
     end
 
     def cacheable_info_dump
@@ -84,7 +84,7 @@ module ResponseBank
       response = serve_from_browser_cache(entity_tag_hash, @env['HTTP_IF_NONE_MATCH'])
       return response if response
 
-      response = serve_from_cache(cache_key_hash, entity_tag_hash, @cache_age_tolerance)
+      response = serve_from_cache(cache_key_hash, @serve_unversioned ? "*" : entity_tag_hash, @cache_age_tolerance)
       return response if response
 
       # No cache hit; this request cannot be handled from cache.
@@ -143,16 +143,17 @@ module ResponseBank
         # version check
         # unversioned but tolerance threshold
         # regen
-        @headers = @headers.merge(headers)
+        @headers.merge!(headers)
 
-        if @env["gzip"]
-          @headers['Content-Encoding'] = "gzip"
-        else
-          # we have to uncompress because the client doesn't support gzip
-          ResponseBank.log("uncompressing for client without gzip")
-          body = ResponseBank.decompress(body)
+        # if a cache key hit and client doesn't match encoding, return the raw body
+        if !@env['HTTP_ACCEPT_ENCODING'].to_s.include?(@headers['Content-Encoding'])
+          ResponseBank.log("uncompressing payload for client as client doesn't require encoding")
+          body = ResponseBank.decompress(body, @headers['Content-Encoding'])
+          @headers.delete('Content-Encoding')
         end
+
         [status, @headers, [body]]
+
       end
     end
 

data/lib/response_bank/version.rb

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

data/lib/response_bank.rb

@@ -3,6 +3,7 @@ require 'response_bank/middleware'
 require 'response_bank/railtie' if defined?(Rails)
 require 'response_bank/response_cache_handler'
 require 'msgpack'
+require 'brotli'
 
 module ResponseBank
   class << self
@@ -29,17 +30,26 @@ module ResponseBank
       backing_cache_store.read(cache_key, raw: true)
     end
 
-    def compress(content)
-      io = StringIO.new
-      gz = Zlib::GzipWriter.new(io)
-      gz.write(content)
-      io.string
-    ensure
-      gz.close
+    def compress(content, encoding = "gzip")
+      case encoding
+      when 'gzip'
+        Zlib.gzip(content, level: Zlib::BEST_COMPRESSION)
+      when 'br'
+        Brotli.deflate(content, mode: :text, quality: 7)
+      else
+        raise ArgumentError, "Unsupported encoding: #{encoding}"
+      end
     end
 
-    def decompress(content)
-      Zlib::GzipReader.new(StringIO.new(content)).read
+    def decompress(content, encoding = "gzip")
+      case encoding
+      when 'gzip'
+        Zlib.gunzip(content)
+      when 'br'
+        Brotli.inflate(content)
+      else
+        raise ArgumentError, "Unsupported encoding: #{encoding}"
+      end
     end
 
     def cache_key_for(data)
@@ -53,6 +63,9 @@ module ResponseBank
 
         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] && data[:encoding] != "gzip"
+
         key
       when Array
         data.inspect
@@ -67,6 +80,17 @@ module ResponseBank
       end
     end
 
+    def check_encoding(env, default_encoding = 'br')
+      if env['HTTP_ACCEPT_ENCODING'].to_s.include?('br')
+        'br'
+      elsif env['HTTP_ACCEPT_ENCODING'].to_s.include?('gzip')
+        'gzip'
+      else
+        # No encoding requested from client, but we still need to cache the page in server cache
+        default_encoding
+      end
+    end
+
     private
 
     def hash_value_str(data)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: response_bank
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Tobias Lütke
@@ -9,10 +9,10 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-03-28 00:00:00.000000000 Z
+date: 2023-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: useragent
+  name: msgpack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -26,7 +26,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: msgpack
+  name: brotli
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -95,6 +95,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
 description: 
 email:
 - tobi@shopify.com
@@ -132,7 +146,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.9
+rubygems_version: 3.4.10
 signing_key: 
 specification_version: 4
 summary: Simple response caching for Ruby applications