rails-fast-cache 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1e10ff2fb43319e203157ada74f91675ba2c9e21c756afa561ca601dcbb4f36f
+  data.tar.gz: 3b765c36cf325775ffcaa52976bf9775df7a32cc3aac02c3b17d779ab793acad
+SHA512:
+  metadata.gz: cf399f1cd89133979da4b1f41fe97c2f9ab014d1e63ee9e705f37eeaecd78a8cc0317108687585ecab36489817e468aeee85dce7f8e27037a9c8badaa9a83af1
+  data.tar.gz: 4bcfbd7e0de24062dd16dfdcced6ed61f4f3b192ee9d4d0574897d103405db6735a78857856b4e962fed0d985cf1ff14dac086572814af7be4de07347c3ef713

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2024 Filippo Liverani
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,30 @@
+# Rails Fast Cache
+
+This gem provides a wrapper around Rails cache store that improves performance by:
+- using Brotli as default compressor instead of GZip
+- using MessagePack as default serializer instead of Marshal
+- delegating cache writes to a thread pool instead of running them synchronously
+
+## Requirements
+- Rails 7.1+
+- You need to provide appropriate MessagePack serializers to cache custom classes
+
+## Installation
+
+`Gemfile`
+
+```ruby
+gem 'rails-fast-cache'
+```
+
+## Configuration
+
+Rail Fast Cache implements ActionsSupport::Cache::Store API and can be
+instantiated by passing the same parameters you would pass to Rails'
+`config.cache_store` configuration option.
+
+```ruby
+class Application < Rails::Application
+...
+  config.cache_store = RailsFastCache::Store.new(:memory_store, { size: 64.megabytes })
+```

data/lib/rails-fast-cache/brotli_compressor.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'brotli'
+
+module RailsFastCache
+  module BrotliCompressor
+    COMPRESSION_PREFIX = "\x02".b
+    ZLIB_COMPRESSION_PREFIX = "\x78".b
+    COMPRESSION_QUALITY = 3
+
+    def self.deflate(dumped)
+      COMPRESSION_PREFIX +
+        ::Brotli.deflate(dumped, quality: COMPRESSION_QUALITY)
+    end
+
+    def self.inflate(compressed)
+      if compressed.start_with?(COMPRESSION_PREFIX)
+        ::Brotli.inflate(compressed.byteslice(1..-1))
+      elsif compressed.start_with?(ZLIB_COMPRESSION_PREFIX)
+        ::Zlib.inflate(compressed)
+      else
+        compressed
+      end
+    end
+  end
+end

data/lib/rails-fast-cache/non_serializing_job.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'active_job'
+
+module RailsFastCache
+  class NonSerializingJob < ::ActiveJob::Base
+    self.logger = nil
+
+    def deserialize_arguments(serialized_arguments)
+      serialized_arguments
+    end
+
+    def serialize_arguments(arguments)
+      arguments
+    end
+  end
+end

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

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require 'active_job'
+require 'active_support'
+require 'active_support/core_ext'
+
+require_relative 'brotli_compressor'
+require_relative 'write_job'
+require_relative 'write_multi_job'
+
+module RailsFastCache
+  class Store < ::ActiveSupport::Cache::Store
+    DEFAULT_EXECUTOR_OPTIONS = {
+      min_threads: ENV.fetch('RAILS_MAX_THREADS', 3).to_i,
+      max_threads: ENV.fetch('RAILS_MAX_THREADS', 3).to_i,
+      max_queue: 100,
+      fallback_policy: :caller_runs
+    }.freeze
+
+    delegate(
+      :cleanup,
+      :clear,
+      :decrement,
+      :delete,
+      :delete_matched,
+      :delete_multi,
+      :exist?,
+      :fetch,
+      :fetch_multi,
+      :increment,
+      :key_matcher,
+      :mute,
+      :new,
+      :read,
+      :read_multi,
+      :silence!,
+      to: :@store
+    )
+
+    def initialize(cache_store, *parameters)
+      options = parameters.extract_options!
+      options[:compressor] ||= RailsFastCache::BrotliCompressor if !options.key?(:coder) && cache_store != :memory_store
+      options[:serializer] ||= :message_pack unless options.key?(:coder)
+
+      @queue = ActiveJob::QueueAdapters::AsyncAdapter.new(
+        **DEFAULT_EXECUTOR_OPTIONS.merge(*options.delete(:executor))
+      )
+      @store = ActiveSupport::Cache.lookup_store(cache_store, *parameters, **options)
+    end
+
+    def write(name, value, options = nil)
+      @queue.enqueue(WriteJob.perform_later(@store, name, value, options))
+    end
+
+    def write_multi(hash, options = nil)
+      @queue.enqueue(WriteMultiJob.perform_later(@store, hash, options))
+    end
+
+    def shutdown(wait: true)
+      @queue.shutdown(wait:)
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module RailsFastCache
+  VERSION = '0.0.1'
+end

data/lib/rails-fast-cache/write_job.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative 'non_serializing_job'
+
+module RailsFastCache
+  class WriteJob < NonSerializingJob
+    def perform(store, name, value, options)
+      store.write(name, value, options)
+    end
+  end
+end

data/lib/rails-fast-cache/write_multi_job.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative 'non_serializing_job'
+
+module RailsFastCache
+  class WriteMultiJob < NonSerializingJob
+    def perform(store, hash, options)
+      store.write_multi(hash, options)
+    end
+  end
+end

data/lib/rails-fast-cache.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require_relative 'rails-fast-cache/store'
+
+module RailsFastCache; end

data/spec/rails-fast-cache/brotli_compressor_spec.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe RailsFastCache::BrotliCompressor do
+  describe '#deflate' do
+    it 'compresses payload with Brotli' do
+      deflated = described_class.deflate('test')
+
+      expect(deflated).to start_with("\x02")
+    end
+  end
+
+  describe '#inflate' do
+    it 'decompresses payload with Brotli' do
+      inflated = described_class.inflate(described_class.deflate('test'))
+
+      expect(inflated).to eq('test')
+    end
+  end
+end

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

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe RailsFastCache::Store do
+  let(:value) do
+    {
+      time: Time.now,
+      string: SecureRandom.hex(2048)
+    }
+  end
+
+  def self.test_write(cache_store)
+    describe '#write' do
+      it "stores value in #{cache_store}" do
+        store = initialize_store(cache_store)
+
+        store.write('store_spec_key', value)
+        store.shutdown
+
+        expect(store.read('store_spec_key')).to eq(value)
+      end
+    end
+
+    describe '#write_multi' do
+      it "stores value in #{cache_store}" do
+        store = initialize_store(cache_store)
+        values = {
+          'store_spec_key_1' => value,
+          'store_spec_key_2' => value
+        }
+
+        store.write_multi(values)
+        store.shutdown
+
+        expect(store.read_multi('store_spec_key_1', 'store_spec_key_2')).to eq(values)
+      end
+    end
+  end
+
+  [
+    :memory_store,
+    [:file_store, 'tmp/cache/'],
+    :redis_cache_store
+  ].each do |cache_store|
+    test_write(cache_store)
+  end
+
+  def initialize_store(cache_store)
+    store = RailsFastCache::Store.new(*cache_store)
+    store.delete_matched('store_spec_*')
+    store
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require 'rubygems'
+require 'bundler/setup'
+
+require_relative '../lib/rails-fast-cache'

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: rails-fast-cache
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Filippo Liverani
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-02-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activejob
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+- !ruby/object:Gem::Dependency
+  name: brotli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: msgpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: benchmark-ips
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Drop-in improvement for Rails cache
+email:
+- 1382917+filippoliverani@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/rails-fast-cache.rb
+- lib/rails-fast-cache/brotli_compressor.rb
+- lib/rails-fast-cache/non_serializing_job.rb
+- lib/rails-fast-cache/store.rb
+- lib/rails-fast-cache/version.rb
+- lib/rails-fast-cache/write_job.rb
+- lib/rails-fast-cache/write_multi_job.rb
+- spec/rails-fast-cache/brotli_compressor_spec.rb
+- spec/rails-fast-cache/store_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/filippoliverani/rails-fast-cache
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.6
+signing_key:
+specification_version: 4
+summary: Drop-in improvement for Rails cache, providing enhanced performance with
+  asynchronous processing and better default serialization and compression
+test_files:
+- spec/rails-fast-cache/brotli_compressor_spec.rb
+- spec/rails-fast-cache/store_spec.rb
+- spec/spec_helper.rb