rails-brotli-cache 0.2.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 01d8f09dfdea5ea7f2c19ce63e44b88322b319bfcda33f9efeeb679710e78f87
-  data.tar.gz: bd6df6fadfd6206ed598dab1ced924d59e5c27da6f1c8a0eaeed434f934219c6
+  metadata.gz: ed8813c2a9849358eb4d1756cd39eda4acf03846ea166880b956d9c630a5f3ee
+  data.tar.gz: cdff030d0d6bdd7e2b7790c5aea0441ecc89e184165c38e899dc5abdc7f5c900
 SHA512:
-  metadata.gz: 7919aaad175395d8494f20f1e40b6b5d96e6bd68a3aa60036dd0aa9682b8251e06139fa56748cfe4a5660be3aea5f09f9b7609806336b47b954cefadca227c1d
-  data.tar.gz: 41ddc8e815662f7f0e9037e5b0beaeacf48cb62eac1c05380b3be44664ed951256cf185d2ecc730f406f7b8a7ee615cad782e68f037907a37b56a1a658766f1d
+  metadata.gz: 5bf99730b2b31ed9591157fe75764fb15c17cf84cfd664d148a339e8552ed27dc62512cdff39f84552bc151aa4105d8720546eef38aa9e2da0552427d05ab86f
+  data.tar.gz: 7aa77827f595e73d55dc838ac8c6159a3f0f9138ed5bcdf57b2a0876060e01b66704dfd93f2eb8dc6502d109a0933f825bfc9d422858cbb786b03a75569f32d6

data/README.md

@@ -9,8 +9,8 @@ This gem enables support for compressing Ruby on Rails cache entries using the [
 Brotli cache works as a proxy layer wrapping the underlying cache data store.
 
 ```ruby
-default_cache = ActiveSupport::Cache::RedisCacheStore.new(redis: $redis)
-brotli_cache = RailsBrotliCache::Store.new(default_cache)
+redis_cache = ActiveSupport::Cache::RedisCacheStore.new
+brotli_redis_cache = RailsBrotliCache::Store.new(redis_cache)
 ```
 
 **~25%** better compression of a sample JSON object:
@@ -18,8 +18,8 @@ brotli_cache = RailsBrotliCache::Store.new(default_cache)
 ```ruby
 json = File.read("sample.json") # sample 435kb JSON text
 json.size # => 435662
-default_cache.write("json", json)
-brotli_cache.write("json", json)
+redis_cache.write("json", json)
+brotli_redis_cache.write("json", json)
 
 ## Check the size of cache entry stored in Redis
 $redis.get("json").size # => 31698
@@ -30,8 +30,8 @@ $redis.get("br-json").size # => 24058
 
 ```ruby
 users = User.limit(100).to_a # 100 ActiveRecord objects
-default_cache.write("users", users)
-brotli_cache.write("users", users)
+redis_cache.write("users", users)
+brotli_redis_cache.write("users", users)
 $redis.get("users").size # => 12331
 $redis.get("br-users").size # => 10299
 ```
@@ -39,27 +39,44 @@ $redis.get("br-users").size # => 10299
 **~25%** faster performance for reading/writing a larger JSON file:
 
 ```ruby
-json = File.read("sample.json") # sample 435kb JSON text
+json = File.read("sample.json") # sample ~1mb JSON text
 
 Benchmark.bm do |x|
-  x.report("default_cache") do
-    1000.times do
-      default_cache.write("test", json)
-      default_cache.read("test")
+  x.report("redis_cache") do
+    100.times do
+      redis_cache.write("test", json)
+      redis_cache.read("test")
     end
   end
 
-  x.report("brotli_cache") do
-    1000.times do
-      brotli_cache.write("test", json)
-      brotli_cache.read("test")
+  x.report("brotli_redis_cache") do
+    100.times do
+      brotli_redis_cache.write("test", json)
+      brotli_redis_cache.read("test")
     end
   end
+
+  # ...
 end
 
-# user     system      total        real
-# default_cache  5.177678   0.216435   5.394113 (  8.296072)
-# brotli_cache   3.513312   0.323601   3.836913 (  6.114179)
+# memory_cache  2.081221   0.051615   2.132836 (  2.132877)
+# brotli_memory_cache  1.134411   0.032996   1.167407 (  1.167418)
+# redis_cache  1.782225   0.049936   1.832161 (  2.523317)
+# brotli_redis_cache  1.218365   0.051084   1.269449 (  1.850894)
+# memcached_cache  1.766268   0.045351   1.811619 (  2.504233)
+# brotli_memcached_cache  1.194646   0.051750   1.246396 (  1.752982)
+```
+
+Regardless of the underlying data store, Brotli cache offers between 20%-40% performance improvment.
+
+You can run the benchmarks yourself by executing:
+
+```ruby
+cp docker-compose.yml.sample docker-compose.yml
+docker compose up -d
+cd benchmarks
+bundle install
+ruby main.rb
 ```
 
 ## Configuration
@@ -84,12 +101,13 @@ config.cache_store = RailsBrotliCache::Store.new(
 )
 ```
 
-Gem appends `br-` to the cache key names to prevent conflicts with previously saved cache entries. You can disable this behaviour by adding the following initializer file:
-
-`app/config/initializers/rails-brotli-cache.rb`
+Gem appends `br-` to the cache key names to prevent conflicts with previously saved cache entries. You can disable this behaviour by passing `{ prefix: nil }` during initialization:
 
 ```ruby
-Rails.cache.disable_prefix!
+config.cache_store = RailsBrotliCache::Store.new(
+  ActiveSupport::Cache::MemoryStore.new,
+  { prefix: nil }
+)
 ```
 
 ## Testing

data/benchmarks/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gem 'rails-brotli-cache'

data/benchmarks/main.rb

@@ -0,0 +1,69 @@
+require 'rails'
+require 'net/http'
+require 'rails-brotli-cache'
+
+memory_cache = ActiveSupport::Cache::MemoryStore.new(compress: true) # memory store does not use compression by default
+brotli_memory_cache = RailsBrotliCache::Store.new(memory_cache)
+redis_cache = ActiveSupport::Cache::RedisCacheStore.new
+brotli_redis_cache = RailsBrotliCache::Store.new(redis_cache)
+memcached_cache = ActiveSupport::Cache::MemCacheStore.new
+brotli_memcached_cache = RailsBrotliCache::Store.new(memcached_cache)
+
+json_uri = URI("https://raw.githubusercontent.com/pawurb/rails-brotli-cache/main/spec/fixtures/sample.json")
+json = Net::HTTP.get(json_uri)
+
+puts "Uncompressed JSON size: #{json.size}"
+redis_cache.write("gz-json", json)
+gzip_json_size = redis_cache.redis.get("gz-json").size
+puts "Gzip JSON size: #{gzip_json_size}"
+brotli_redis_cache.write("json", json)
+br_json_size = redis_cache.redis.get("br-json").size
+puts "Brotli JSON size: #{br_json_size}"
+puts "~#{((gzip_json_size - br_json_size).to_f / gzip_json_size.to_f * 100).round}% improvment"
+puts ""
+
+iterations = 100
+
+Benchmark.bm do |x|
+  x.report("memory_cache") do
+    iterations.times do
+      memory_cache.write("test", json)
+      memory_cache.read("test")
+    end
+  end
+
+  x.report("brotli_memory_cache") do
+    iterations.times do
+      brotli_memory_cache.write("test", json)
+      brotli_memory_cache.read("test")
+    end
+  end
+
+  x.report("redis_cache") do
+    iterations.times do
+      redis_cache.write("test", json)
+      redis_cache.read("test")
+    end
+  end
+
+  x.report("brotli_redis_cache") do
+    iterations.times do
+      brotli_redis_cache.write("test", json)
+      brotli_redis_cache.read("test")
+    end
+  end
+
+  x.report("memcached_cache") do
+    iterations.times do
+      memcached_cache.write("test", json)
+      memcached_cache.read("test")
+    end
+  end
+
+  x.report("brotli_memcached_cache") do
+    iterations.times do
+      brotli_memcached_cache.write("test", json)
+      brotli_memcached_cache.read("test")
+    end
+  end
+end

data/lib/rails-brotli-cache/store.rb

@@ -9,9 +9,15 @@ module RailsBrotliCache
     COMPRESS_QUALITY = ENV.fetch("BR_CACHE_COMPRESS_QUALITY", 5).to_i
     MARK_BR_COMPRESSED = "\x02".b
 
+    attr_reader :core_store
+
     def initialize(core_store, options = {})
       @core_store = core_store
-      @prefix = "br-"
+      @prefix = if options.key?(:prefix)
+        options.fetch(:prefix)
+      else
+        "br-"
+      end
     end
 
     def fetch(name, options = nil, &block)
@@ -74,10 +80,6 @@ module RailsBrotliCache
       @core_store.clear
     end
 
-    def disable_prefix!
-      @@prefix = nil
-    end
-
     private
 
     def cache_key(name)

data/lib/rails-brotli-cache/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RailsBrotliCache
-  VERSION = "0.2.0"
+  VERSION = "0.2.2"
 end

data/spec/rails-brotli-cache/rails_store_spec.rb

@@ -73,12 +73,4 @@ describe RailsBrotliCache do
       expect(cache_store.read("test-key")).to eq nil
     end
   end
-
-  describe "disable_prefix!" do
-    it "saves brotli cache entries without `br-` prefix" do
-      cache_store.disable_prefix!
-      cache_store.fetch("test-key") { 123 }
-      cache_store.instance_variable_set(:@prefix, "br-")
-    end
-  end
 end

data/spec/rails-brotli-cache/redis_spec.rb

@@ -5,9 +5,14 @@ require 'spec_helper'
 return unless ENV['RAILS_CACHE_STORE'] == 'redis_cache_store'
 
 describe RailsBrotliCache do
+  let(:options) do
+    {}
+  end
+
   subject(:cache_store) do
     RailsBrotliCache::Store.new(
-      ActiveSupport::Cache::RedisCacheStore.new(redis: $redis)
+      ActiveSupport::Cache::RedisCacheStore.new(redis: $redis),
+      options
     )
   end
 
@@ -27,4 +32,26 @@ describe RailsBrotliCache do
     cache_store.write("test-key", json)
     expect($redis.get("gz-test-key").size > $redis.get("br-test-key").size).to eq true
   end
+
+  describe "disable_prefix" do
+    context "default prefix" do
+      it "appends 'br-' prefix" do
+        cache_store.fetch("test-key") { 123 }
+        expect($redis.get("test-key")).to eq nil
+        expect($redis.get("br-test-key")).to be_present
+      end
+    end
+
+    context "no prefix" do
+      let(:options) do
+        { prefix: nil }
+      end
+
+      it "saves brotli cache entries without `br-` prefix" do
+        cache_store.fetch("test-key") { 123 }
+        expect($redis.get("br-test-key")).to eq nil
+        expect($redis.get("test-key")).to be_present
+      end
+    end
+  end
 end

data/spec/rails-brotli-cache/store_spec.rb

@@ -40,6 +40,12 @@ describe RailsBrotliCache do
     end
   end
 
+  describe "#core_store" do
+    it "exposes the underlying data store" do
+      expect(cache_store.core_store.class).to eq ActiveSupport::Cache::MemoryStore
+    end
+  end
+
   describe "#read and #write" do
     it "reads values stored in Rails cache with a prefix" do
       expect(cache_store.read("test-key")).to eq nil
@@ -67,12 +73,4 @@ describe RailsBrotliCache do
       expect(cache_store.read("test-key")).to eq nil
     end
   end
-
-  describe "disable_prefix!" do
-    it "saves brotli cache entries without `br-` prefix" do
-      cache_store.disable_prefix!
-      cache_store.fetch("test-key") { 123 }
-      cache_store.instance_variable_set(:@prefix, "br-")
-    end
-  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-brotli-cache
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.2
 platform: ruby
 authors:
 - pawurb
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-05-18 00:00:00.000000000 Z
+date: 2023-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -108,6 +108,8 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- benchmarks/Gemfile
+- benchmarks/main.rb
 - docker-compose.yml.sample
 - lib/rails-brotli-cache.rb
 - lib/rails-brotli-cache/store.rb