response_bank 1.3.5 → 1.3.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b24a992a093711fd04ac8768221300e0c238a70b02ea40c49f87a3c05a1b87af
-  data.tar.gz: 4665251a057b21f12858b55332f45e8be3587cc9aa787082be32df8082971256
+  metadata.gz: 0a5c7a799e1272fffad4878273bf154c09f809059944dbf47bf6c6c83d1b4acb
+  data.tar.gz: ff7a669443427dcee35c7d2a590258fc0ac0591bd156c1316a42198cacc4bd0e
 SHA512:
-  metadata.gz: 834669e94059637b751b22783ad10c731b2a327f83bc1448e13d26532506bdb55145b6c12eb29c49fc635cf3cacdc9d6b5cad7c1e62af99000330b5b77e72c5c
-  data.tar.gz: c6dccc62b543bef77132a8cfa1de1608c8a32db5abb9c610d71c743e8b94538e079d132f70b90bfb18addf0181f3c1627bd73a45c8e727532a7378cfd7d9399a
+  metadata.gz: 5ddaeeca4364360ce6f2392d5b53d2f34421e44a62f1184d594add38dc45ebf23f72184bc9aa097667404c83d6b64c450b91b1dd25726a307ba41149b8a9509d
+  data.tar.gz: 4bfc7ebc29beab0c67f72e24e635d9fa2a0ca59a06fd92027d00172acc31a1974288adee1a97baf005e2ae64751a49e205a7005c70881f27e44b03a6827bf66a

data/lib/response_bank/middleware.rb

@@ -4,7 +4,7 @@ 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", "Link", "Surrogate-Keys", "Cache-Tags"].freeze
+    CACHEABLE_HEADERS = ["Location", "Content-Type", "ETag", "Content-Encoding", "Last-Modified", "Cache-Control", "Expires", "Link", "Surrogate-Keys", "Cache-Tags", "Speculation-Rules"].freeze
 
     REQUESTED_WITH = "HTTP_X_REQUESTED_WITH"
     ACCEPT = "HTTP_ACCEPT"
@@ -37,12 +37,21 @@ module ResponseBank
           body_compressed = nil
           if body_string && body_string != ""
             headers['Content-Encoding'] = content_encoding
-            body_compressed = ResponseBank.compress(body_string, content_encoding)
+            env["cacheable.compression_level"] = ResponseBank.compression_level_for_request(env, headers)
+            time = ResponseBank.measure do
+              body_compressed = ResponseBank.compress(
+                body_string,
+                content_encoding,
+                compression_level: env["cacheable.compression_level"],
+              )
+            end
+            ResponseBank.log("Compression time: #{time}ms")
+            env["cacheable.compression_time"] = time
           end
 
           cached_headers = headers.slice(*CACHEABLE_HEADERS)
           # Store result
-          cache_data = [status, cached_headers, body_compressed, timestamp]
+          cache_data = [status, cached_headers, body_compressed, timestamp, env["cacheable.compression_level"]]
 
           ResponseBank.write_to_cache(env['cacheable.key']) do
             payload = MessagePack.dump(cache_data)

data/lib/response_bank/response_cache_handler.rb

@@ -119,7 +119,9 @@ module ResponseBank
         @env['cacheable.miss']  = false
         @env['cacheable.store'] = 'server'
 
-        status, headers, body, timestamp = hit
+        status, headers, body, timestamp, compression_level = hit
+
+        @env['cacheable.compression_level'] = compression_level
 
         @env['cacheable.locked'] ||= false
 

data/lib/response_bank/version.rb

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

data/lib/response_bank.rb

@@ -4,11 +4,31 @@ require 'response_bank/railtie' if defined?(Rails)
 require 'response_bank/response_cache_handler'
 require 'msgpack'
 require 'brotli'
+require 'benchmark'
 
 module ResponseBank
   class << self
     attr_accessor :cache_store
-    attr_writer :logger
+    attr_writer :logger, :compression_level
+
+    DEFAULT_BROTLI_COMPRESSION_LEVEL = 7
+
+    DEFAULT_COMPRESSION_LEVEL = -> (_env, headers) {
+      case headers['Content-Encoding']
+      when 'br'
+        DEFAULT_BROTLI_COMPRESSION_LEVEL
+      when 'gzip'
+        Zlib::BEST_COMPRESSION
+      end
+    }
+
+    def compression_level_for_request(env, headers)
+      if @compression_level
+        return @compression_level.respond_to?(:call) ? @compression_level.call(env, headers) : @compression_level
+      end
+
+      DEFAULT_COMPRESSION_LEVEL.call(env, headers)
+    end
 
     def log(message)
       @logger.info("[ResponseBank] #{message}")
@@ -30,13 +50,19 @@ module ResponseBank
       backing_cache_store.read(cache_key, raw: true)
     end
 
-    def compress(content, encoding = "br")
+    def measure
+      Benchmark.realtime do
+        yield
+      end * 1000 # milliseconds
+    end
+
+    def compress(content, encoding = "br", compression_level: nil)
       case encoding
       when 'gzip'
         attempts = 0
 
         begin
-          Zlib.gzip(content, level: Zlib::BEST_COMPRESSION)
+          Zlib.gzip(content, level: compression_level || Zlib::BEST_COMPRESSION)
         rescue Zlib::BufError
           # We get sporadic Zlib::BufError, so we retry once (https://github.com/ruby/zlib/issues/49)
           attempts += 1
@@ -48,7 +74,7 @@ module ResponseBank
           end
         end
       when 'br'
-        Brotli.deflate(content, mode: :text, quality: 7)
+        Brotli.deflate(content, mode: :text, quality: compression_level || DEFAULT_BROTLI_COMPRESSION_LEVEL)
       else
         raise ArgumentError, "Unsupported encoding: #{encoding}"
       end

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: response_bank
 version: !ruby/object:Gem::Version
-  version: 1.3.5
+  version: 1.3.7
 platform: ruby
 authors:
 - Tobias Lütke
 - Burke Libbey
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-01-17 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: msgpack
@@ -45,28 +44,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.18.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.18.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -87,16 +86,16 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -109,7 +108,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
 email:
 - tobi@shopify.com
 - burke@burkelibbey.org
@@ -131,7 +129,6 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -146,8 +143,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.4
-signing_key: 
+rubygems_version: 3.7.2
 specification_version: 4
 summary: Simple response caching for Ruby applications
 test_files: []