cache-coalescer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1523415f0c539633da76fde9e1f0e435be4734ffdffcaa5e02a5ea7695b8aa55
+  data.tar.gz: 6e146143145e475412339ad3bc4d24bfa5234769e215cf0b909e1c2f838c031b
+SHA512:
+  metadata.gz: 49583cc46cc5a62a6b6433667076f6422937b7b5084c7d066f39aad57e942c1bc6d456722bc2ab8a092efde37fc4bd080b2a630039dc559eafb09e5f0a90e163
+  data.tar.gz: 69eebe43f705403d3030f939e6757bbb49458952931a7342d06641170121e38c623c508de09684caf8130be27fea9a20b8fa4bdaf18d8dc9f79474064273d4a9

data/.github/workflows/ci.yml

@@ -0,0 +1,19 @@
+name: CI
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: ["3.0", "3.1", "3.2", "3.3"]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - run: bundle exec rspec

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# bundler
+Gemfile.lock
+

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+# Changelog
+
+## 0.1.0
+- Initial release.

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,26 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+We pledge to make participation in our community a harassment-free experience for everyone.
+
+## Our Standards
+Examples of behavior that contributes to a positive environment include:
+- Using welcoming and inclusive language
+- Respecting differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+
+Examples of unacceptable behavior include:
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+
+## Enforcement Responsibilities
+Project maintainers are responsible for clarifying and enforcing standards of acceptable behavior.
+
+## Scope
+This Code of Conduct applies within all project spaces and in public spaces when representing the project.
+
+## Enforcement
+Instances of abusive behavior may be reported to the maintainer listed in the gemspec.
+
+## Attribution
+This Code of Conduct is adapted from the Contributor Covenant, version 1.4.

data/CONTRIBUTING.md

@@ -0,0 +1,10 @@
+# Contributing
+
+## Development setup
+- Run `bundle install`
+- Run `bundle exec rspec`
+
+## Release
+1. Update `CHANGELOG.md`
+2. Bump version in `lib/**/version.rb`
+3. Run `bundle exec rake release`

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in cache-coalescer.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 MounirGaiby
+
+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,56 @@
+# Cache Coalescer
+
+Distributed singleflight for Rails cache misses to prevent stampedes on cold keys.
+
+## About
+Cache Coalescer ensures only one request computes a missing value while the rest wait for it. The first caller acquires a lock, computes, and writes to cache. Other callers poll briefly and reuse the result. Optional stale values can be served if the lock is held for too long.
+
+This is ideal for expensive cache-miss work such as API calls, report generation, or heavyweight database queries.
+
+## Use Cases
+- Prevent thundering herds on cold cache keys
+- Reduce p99 latency spikes during traffic bursts
+- Protect downstream services from request stampedes
+- Coalesce expensive fan-out workloads into a single computation
+
+## Compatibility
+- Ruby 3.0+
+- ActiveSupport 6.1+
+- Works with any ActiveSupport cache store
+- Best with Redis-backed stores for distributed locking
+
+## Installation
+```ruby
+# Gemfile
+
+gem "cache-coalescer"
+```
+
+## Usage
+```ruby
+value = Cache::Coalescer.fetch("expensive-key", ttl: 60, lock_ttl: 5, wait_timeout: 2, store: Rails.cache) do
+  ExpensiveQuery.call
+end
+```
+
+Rails integration adds `Rails.cache.fetch_coalesced`:
+```ruby
+Rails.cache.fetch_coalesced("expensive-key", ttl: 60) { ExpensiveQuery.call }
+```
+
+## Options
+- `ttl` (Integer) cache TTL in seconds
+- `lock_ttl` (Integer) lock expiry in seconds
+- `wait_timeout` (Float) how long waiters poll for a result
+- `wait_sleep` (Float) polling interval in seconds
+- `stale_ttl` (Integer) optional stale window; if set, stale values are returned on timeout
+- `store` ActiveSupport cache store (defaults to `Rails.cache` when available)
+- `lock_client` Redis client or `Cache::Coalescer::Lock::InMemoryLock`
+
+## Locking
+If the cache store exposes `redis`, a Redis lock is used automatically. Otherwise, the gem falls back to an in-memory lock which is safe for single-process usage.
+
+## Release
+```bash
+bundle exec rake release
+```

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "cache/coalescer"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/cache-coalescer.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "cache/coalescer/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "cache-coalescer"
+  spec.version = Cache::Coalescer::VERSION
+  spec.authors = ["MounirGaiby"]
+  spec.email = ["mounirgaiby@gmail.com"]
+
+  spec.summary = "Distributed singleflight for Rails cache misses to prevent stampedes."
+  spec.description = "Coalesce concurrent cache-miss computations with Redis-backed locks and shared results."
+  spec.homepage = "https://github.com/elysium-arc/cache-coalescer"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/elysium-arc/cache-coalescer"
+  spec.metadata["changelog_uri"] = "https://github.com/elysium-arc/cache-coalescer/blob/main/CHANGELOG.md"
+  spec.metadata["rubygems_mfa_required"] = "true"
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir = "bin"
+  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport", ">= 6.1"
+  spec.add_dependency "redis", ">= 4.0"
+
+  spec.add_development_dependency "bundler", ">= 1.17"
+  spec.add_development_dependency "rake", ">= 13.0"
+  spec.add_development_dependency "rspec", "~> 3.12"
+  spec.add_development_dependency "simplecov", "~> 0.22"
+end

data/lib/cache/coalescer/lock.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module Cache
+  module Coalescer
+    module Lock
+      LUA_RELEASE = <<~LUA
+        if redis.call("get", KEYS[1]) == ARGV[1] then
+          return redis.call("del", KEYS[1])
+        else
+          return 0
+        end
+      LUA
+
+      def self.default_for(store)
+        return RedisLock.new(store.redis) if store.respond_to?(:redis)
+        raise Cache::Coalescer::Error, "lock_client is required when store does not expose redis"
+      end
+
+      class RedisLock
+        def initialize(redis)
+          @redis = redis
+        end
+
+        def acquire(key, token, ttl)
+          with_redis do |conn|
+            conn.set(key, token, nx: true, px: (ttl * 1000).to_i)
+          end
+        end
+
+        def release(key, token)
+          with_redis do |conn|
+            conn.eval(LUA_RELEASE, keys: [key], argv: [token])
+          end
+        rescue StandardError
+          false
+        end
+
+        private
+
+        def with_redis
+          if @redis.respond_to?(:with)
+            @redis.with { |conn| yield conn }
+          else
+            yield @redis
+          end
+        end
+      end
+
+      class InMemoryLock
+        def initialize
+          @mutex = Mutex.new
+          @locks = {}
+        end
+
+        def acquire(key, _token, ttl)
+          now = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+          @mutex.synchronize do
+            expires_at = @locks[key]
+            return false if expires_at && expires_at > now
+            @locks[key] = now + ttl
+            true
+          end
+        end
+
+        def release(key, _token)
+          @mutex.synchronize { @locks.delete(key) }
+          true
+        end
+      end
+    end
+  end
+end

data/lib/cache/coalescer/railtie.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+# :nocov:
+begin
+  require "rails/railtie"
+rescue LoadError
+end
+
+if defined?(Rails::Railtie)
+  module Cache
+    module Coalescer
+      module StoreExtension
+        def fetch_coalesced(key, ttl:, **options, &block)
+          Cache::Coalescer.fetch(key, ttl: ttl, store: self, **options, &block)
+        end
+      end
+
+      class Railtie < Rails::Railtie
+        initializer "cache_coalescer.extend_cache" do
+          require "active_support/cache"
+          ::ActiveSupport::Cache::Store.include(Cache::Coalescer::StoreExtension)
+        end
+      end
+    end
+  end
+end
+# :nocov:

data/lib/cache/coalescer/version.rb

@@ -0,0 +1,5 @@
+module Cache
+  module Coalescer
+    VERSION = "0.1.0"
+  end
+end

data/lib/cache/coalescer.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require "active_support/notifications"
+require "securerandom"
+require "cache/coalescer/version"
+require "cache/coalescer/lock"
+
+module Cache
+  module Coalescer
+    class Error < StandardError; end
+
+    DEFAULT_LOCK_TTL = 5
+    DEFAULT_WAIT_TIMEOUT = 5
+    DEFAULT_WAIT_SLEEP = 0.05
+
+    def self.fetch(key, ttl:, store: nil, lock_ttl: DEFAULT_LOCK_TTL, wait_timeout: DEFAULT_WAIT_TIMEOUT,
+                   wait_sleep: DEFAULT_WAIT_SLEEP, stale_ttl: nil, lock_client: nil, &block)
+      raise ArgumentError, "block required" unless block
+
+      store ||= default_store
+      value = store.read(key)
+      return value unless value.nil?
+
+      lock_client ||= store.respond_to?(:redis) ? Lock.default_for(store) : Lock::InMemoryLock.new
+      lock_key = lock_key_for(key)
+      token = SecureRandom.uuid
+
+      if lock_client.acquire(lock_key, token, lock_ttl)
+        return compute_and_store(store, key, ttl, stale_ttl, lock_client, lock_key, token, &block)
+      end
+
+      deadline = monotonic + wait_timeout
+      loop do
+        value = store.read(key)
+        return value unless value.nil?
+        break if monotonic >= deadline
+        sleep wait_sleep
+      end
+
+      if lock_client.acquire(lock_key, token, lock_ttl)
+        return compute_and_store(store, key, ttl, stale_ttl, lock_client, lock_key, token, &block)
+      end
+
+      if stale_ttl
+        stale_value = store.read(stale_key_for(key))
+        return stale_value unless stale_value.nil?
+      end
+
+      nil
+    end
+
+    def self.default_store
+      return Rails.cache if defined?(Rails) && Rails.respond_to?(:cache)
+      raise Error, "store is required when Rails.cache is unavailable"
+    end
+
+    def self.compute_and_store(store, key, ttl, stale_ttl, lock_client, lock_key, token)
+      value = yield
+      store.write(key, value, expires_in: ttl)
+      if stale_ttl
+        store.write(stale_key_for(key), value, expires_in: ttl + stale_ttl)
+      end
+      value
+    ensure
+      lock_client.release(lock_key, token) if lock_client
+    end
+
+    def self.lock_key_for(key)
+      "cache-coalescer:lock:#{key}"
+    end
+
+    def self.stale_key_for(key)
+      "cache-coalescer:stale:#{key}"
+    end
+
+    def self.monotonic
+      Process.clock_gettime(Process::CLOCK_MONOTONIC)
+    end
+  end
+end
+
+require "cache/coalescer/railtie"

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: cache-coalescer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- MounirGaiby
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-02-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+description: Coalesce concurrent cache-miss computations with Redis-backed locks and
+  shared results.
+email:
+- mounirgaiby@gmail.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ci.yml"
+- ".gitignore"
+- ".rspec"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- cache-coalescer.gemspec
+- lib/cache/coalescer.rb
+- lib/cache/coalescer/lock.rb
+- lib/cache/coalescer/railtie.rb
+- lib/cache/coalescer/version.rb
+homepage: https://github.com/elysium-arc/cache-coalescer
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/elysium-arc/cache-coalescer
+  source_code_uri: https://github.com/elysium-arc/cache-coalescer
+  changelog_uri: https://github.com/elysium-arc/cache-coalescer/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.3
+signing_key:
+specification_version: 4
+summary: Distributed singleflight for Rails cache misses to prevent stampedes.
+test_files: []