composite_cache_store 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6b6a9480fa18ff9ed0c17318f3ea093c6f8b586b4595427ff9b1056e7c0e9a5f
+  data.tar.gz: 5e9af188c3726dbebec690aabcb838f426e9d26f9c96e48d291b3bb8083a28bc
+SHA512:
+  metadata.gz: 636f9164938ce4dc6d5fbfc54d24e0e2e0870b8822c770b13bfdb293f02ac5fe4787bc0d9f883a398563f0e8210dcdfd7e89824298cc2dff20c03d4a9a98efea
+  data.tar.gz: c4b79fefc6e70e02243ab8cfdf2c662de139e1e2b3062cd2f171d078cefb2869dae0c8a035d1269be5238015a020d378b77b9288cc42e630858eb91866641706

data/README.md

@@ -0,0 +1,98 @@
+# CompositeCacheStore
+
+### A composite cache store comprised of 2 ActiveSupport::Cache::Store instances
+
+<!-- Tocer[start]: Auto-generated, don't remove. -->
+
+## Table of Contents
+
+  - [Why a composite cache?](#why-a-composite-cache)
+  - [Sponsors](#sponsors)
+  - [Dependencies](#dependencies)
+  - [Installation](#installation)
+  - [Setup](#setup)
+    - [Ruby on Rails](#ruby-on-rails)
+  - [Usage](#usage)
+  - [License](#license)
+
+<!-- Tocer[finish]: Auto-generated, don't remove. -->
+
+## Why a composite cache?
+
+Most web applications implement some form of caching mechanics to improve performance.
+Sufficiently large applications often employ a persistence service to back the cache.
+_(Redis, Memcache, etc.)_ These services make it possible to use a shared cache between multiple machines/processes.
+
+While these services are robust and performant, they can also be a source of latency and are potential bottlenecks.
+__A composite (or layered) cache can mitigate these risks__
+by reducing traffic and backpressure on the persistence service.
+
+Consider a composite cache that wraps a remote Redis-backed store with an local in-memory store.
+When both caches are warm, a read hit on the local in-memory store will return instantly, avoiding the overhead
+of inter-process communication (IPC) and/or network traffic _(with its attendant data marshaling and socket/wire noise)._
+
+## Sponsors
+
+<p align="center">
+  <em>Proudly sponsored by</em>
+</p>
+<p align="center">
+  <a href="https://www.clickfunnels.com?utm_source=hopsoft&utm_medium=open-source&utm_campaign=composite_cache_store">
+    <img src="https://images.clickfunnel.com/uploads/digital_asset/file/176632/clickfunnels-dark-logo.svg" width="575" />
+  </a>
+</p>
+
+## Dependencies
+
+- [ActiveSupport `>= 6.0`](https://github.com/rails/rails/tree/main/activesupport)
+
+## Installation
+
+```sh
+bundle add "composite_cache_store"
+```
+
+## Setup
+
+### Ruby on Rails
+
+```ruby
+# config/environments/production.rb
+module Example
+  class Application < Rails::Application
+    config.cache_store = :redis_cache_store, { url: "redis://example.com:6379/1" }
+  end
+end
+```
+
+```ruby
+# config/initializers/composite_cache_store.rb
+def Rails.composite_cache
+  @store ||= CompositeCacheStore.new(
+    inner_cache_store: Rails.cache, # use whatever makes sense for your app as the remote inner-cache
+    outer_cache_store: ActiveSupport::Cache::MemoryStore.new( # employs an LRU eviction policy
+      expires_in: 15.minutes, # constrain entry lifetime so the local outer-cache doesn't drift out of sync
+      size: 32.megabytes # constrain max memory used by the local outer-cache
+    )
+  )
+end
+```
+
+## Usage
+
+A composite cache is ideal for mitigating hot spot latency in frequently invoked areas of the codebase.
+
+```ruby
+# method that's invoked frequently by multiple processes
+def hotspot
+  # NOTE: the expires_in option is only applied to the remote inner-cache
+  #       the local outer-cache uses its globally configured expiration policy
+  Rails.composite_cache.fetch("example/slow/operation", expires_in: 12.hours) do
+    # a slow operation
+  end
+end
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+task default: :test
+
+Minitest::TestTask.create(:test) do |t|
+  t.test_globs = ["test/**/*_test.rb"]
+end

data/lib/composite_cache_store/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class CompositeCacheStore
+  VERSION = "0.0.1"
+end

data/lib/composite_cache_store.rb

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+require "active_support/cache"
+require_relative "composite_cache_store/version"
+
+class CompositeCacheStore
+  DEFAULT_OUTER_OPTIONS = {
+    expires_in: 5.minutes,
+    size: 16.megabytes
+  }
+
+  DEFAULT_INNER_OPTIONS = {
+    expires_in: 1.day,
+    size: 32.megabytes
+  }
+
+  attr_reader :outer_cache_store, :inner_cache_store
+
+  alias_method :outer, :outer_cache_store
+  alias_method :inner, :inner_cache_store
+
+  # Returns a new CompositeCacheStore instance
+  # - inner_cache_store: An ActiveSupport::Cache::Store instance to use for the inner cache store (typically remote)
+  # - outer_cache_store: An ActiveSupport::Cache::Store instance to use for the outer cache store (typically local)
+  def initialize(options = {})
+    options ||= {}
+
+    @inner_cache_store = options[:inner_cache_store]
+    @inner_cache_store = ActiveSupport::Cache::MemoryStore.new(DEFAULT_INNER_OPTIONS) unless inner.is_a?(ActiveSupport::Cache::Store)
+
+    @outer_cache_store = options[:outer_cache_store]
+    @outer_cache_store = ActiveSupport::Cache::MemoryStore.new(DEFAULT_OUTER_OPTIONS) unless outer.is_a?(ActiveSupport::Cache::Store)
+  end
+
+  def cleanup(...)
+    outer.cleanup(...)
+    inner.cleanup(...)
+  end
+
+  def clear(...)
+    outer.clear(...)
+    inner.clear(...)
+  end
+
+  def decrement(...)
+    outer.decrement(...)
+    inner.decrement(...)
+  end
+
+  def delete(...)
+    outer.delete(...)
+    inner.delete(...)
+  end
+
+  def delete_matched(...)
+    outer.delete_matched(...)
+    inner.delete_matched(...)
+  end
+
+  def delete_multi(...)
+    outer.delete_multi(...)
+    inner.delete_multi(...)
+  end
+
+  def exist?(...)
+    outer.exist?(...) || inner.exist?(...)
+  end
+
+  def fetch(*args, &block)
+    outer.fetch(*args) do
+      inner.fetch(*args, &block)
+    end
+  end
+
+  def fetch_multi(*args, &block)
+    outer.fetch_multi(*args) do
+      inner.fetch_multi(*args, &block)
+    end
+  end
+
+  # write
+  def increment(...)
+    outer.increment(...)
+    inner.increment(...)
+  end
+
+  def mute
+    outer.mute do
+      inner.mute do
+        yield
+      end
+    end
+  end
+
+  def read(*args)
+    outer.fetch(*args) do
+      inner.read(*args)
+    end
+  end
+
+  def read_multi(...)
+    result = outer.read_multi(...)
+    result = inner.read_multi(...) if result.blank?
+    result
+  end
+
+  def silence!
+    outer.silence!
+    inner.silence!
+  end
+
+  def write(name, value, options = nil)
+    options ||= {}
+    outer.write(name, value, options.except(:expires_in)) # ? accept expires_in if less than outer.config[:expires_in] ?
+    inner.write(name, value, options)
+  end
+
+  def write_multi(hash, options = nil)
+    options ||= {}
+    outer.write_multi(hash, options.except(:expires_in)) # ? accept expires_in if less than outer.config[:expires_in] ?
+    inner.write_multi(hash, options)
+  end
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: composite_cache_store
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Nate Hopkins (hopsoft)
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-03-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: magic_frozen_string_literal
+  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'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  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'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  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'
+- !ruby/object:Gem::Dependency
+  name: standardrb
+  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: |
+  Enhanced application performance with faster reads, data redundancy,
+  and reduced backpressure on the inner cache store.
+email:
+- natehop@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- lib/composite_cache_store.rb
+- lib/composite_cache_store/version.rb
+homepage: https://github.com/hopsoft/composite_cache_store
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/hopsoft/composite_cache_store
+  source_code_uri: https://github.com/hopsoft/composite_cache_store
+  changelog_uri: https://github.com/hopsoft/composite_cache_store/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.5
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.6
+signing_key:
+specification_version: 4
+summary: A composite cache store comprised of 2 ActiveSupport::Cache::Store instances
+test_files: []