safe_memoize 1.5.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8ce254347308d6a616bc17df194ff5e91f9c151f6606d3b77963a963c8a3186c
-  data.tar.gz: 7399a03d13d297b798cfc60716376129c0162697ae845e5420409c0da33ecf68
+  metadata.gz: e7a646739aa7f6c178b20192ddc8e94768df0c6b000097586796153f5d2138bc
+  data.tar.gz: 9454f9a6cf6b8e420d27b82f39740484eddab506d871e94034483ae8caf12622
 SHA512:
-  metadata.gz: 8a034c60f1f200e3971be9828563d43b406e1fc1feef4d2e044f880456ac2d1e0b7cf98b3d1e3292fb2641bb8c5e9d3e21c387f1a0041ae8996fa004db863d92
-  data.tar.gz: 1f72d605f086951abc9bff9a2dc452ecece2694cd7ad27a118589ba8c48b4e02fb6a35b97271e0007e1dde55ff1af798bf278fabedc07b2c0b74d955af270a56
+  metadata.gz: f569af43ba1ca765dcdd9490f5629bb572f1dbedaa676538a08c199282fe55a6b40afd29f8870ddbab86c091a20a89c10e87c3b060a124f4994313b2a2ffdda4
+  data.tar.gz: 2d0634278dd32e98fc0c23a74abfb98bf1c8d5d087e7eb7a8006dd54846bd11f0bbce27d704e4f82bf0fc81c961c34b1c62fb8dc92cddafbcec26c2b930e79d8

data/CHANGELOG.md

@@ -8,6 +8,27 @@ from v1.0.0 onwards. Prior 0.x releases may include breaking changes between min
 
 ## [Unreleased]
 
+## [1.7.0] - 2026-06-02
+
+### Added
+
+- `SafeMemoize::Stores::Multilevel` — multi-level (L1/L2/…) cache store that checks faster layers first and promotes values from deeper layers into shallower ones on a miss ("read-through promotion"). Reads walk the list from first (fastest) to last; writes go to every level simultaneously; deletes and clears apply to all levels. Accepts `promote_expires_in:` to control the TTL of promoted entries (default: no TTL, relying on the L1 store's own eviction). Raises `ArgumentError` if fewer than two stores are supplied.
+- `store: [l1, l2]` shorthand on `memoize` — passing an `Array` of `Stores::Base` instances is automatically converted to `Stores::Multilevel.new(*stores)`, enabling multi-level caching without explicit wrapper construction.
+- `SafeMemoize::Stores::XFetch` — wraps any `Stores::Base` adapter with probabilistic early expiry (the XFetch algorithm) to prevent cache stampedes. Values are stored with an envelope that includes `expires_at`; on read the XFetch formula `now − (delta × beta × log(rand)) ≥ expires_at` decides whether to return the value or `MISS` (triggering early recomputation). Configurable via `beta:` (aggressiveness scalar, default 1.0) and `delta:` (estimated computation time in seconds, default 0.1). Composes naturally with `Multilevel` and `CircuitBreaker`.
+- `stampede_protection:` option on `memoize` — enables the XFetch algorithm for the per-instance in-process cache. Pass `true` (default beta 1.0) or a `Numeric` for a custom beta. Records actual computation time as `delta` on each miss so the XFetch probability adapts to real observed latency. Requires `ttl:`. Incompatible with `store:` (use `Stores::XFetch` for external stores) and `ractor_safe:`. Accepted by `safe_memoize_options` as a class-wide default.
+
+## [1.6.0] - 2026-06-02
+
+### Added
+
+- `SafeMemoize::Stores::CircuitBreaker` — a `Stores::Base` wrapper that protects any external store adapter with a three-state circuit breaker (`:closed` → `:open` → `:half_open`). When the wrapped store raises on `read` or `write`, the error is swallowed: reads return `MISS` (triggering the per-instance in-process fallback cache) and writes are no-ops (the return value is unaffected). After a configurable number of consecutive failures (`error_threshold:`, default 5) the circuit opens and all store calls are bypassed until a probe interval elapses (`probe_interval:`, default 30 s), at which point a single probe request is let through; success closes the circuit, failure resets the timer. Any successful call in `:closed` state resets the consecutive error counter, so transient blips do not accumulate toward the threshold.
+  - `state` — returns `:closed`, `:open`, or `:half_open`
+  - `open?` — `true` when the circuit is not fully closed
+  - `error_count` — current consecutive error count
+  - `reset!` — manually close the circuit and clear the counter
+  - `wrapped_store`, `error_threshold`, `probe_interval` — readers
+- `circuit_breaker:` option on `memoize` — syntactic sugar that auto-wraps the configured `store:` adapter in a `CircuitBreaker`. Pass `true` to use defaults, or a `Hash` with `:error_threshold` and/or `:probe_interval` keys to customise. Raises `ArgumentError` if no store is configured. Does not double-wrap a store that is already a `CircuitBreaker`. Accepted by `safe_memoize_options` as a class-wide default.
+
 ## [1.5.0] - 2026-06-02
 
 ### Added

data/README.md

@@ -80,6 +80,9 @@ SafeMemoize uses Ruby's `prepend` mechanism. When you call `memoize :method_name
 - [Per-class default options via `safe_memoize_options` — set TTL, max size, copy-on-read, and other defaults for every `memoize` call on the class without repeating them](#per-class-default-options-safe_memoize_options)
 - [Copy-on-read via `copy_on_read: true` — returns a `dup`/`deep_dup` on every cache read to protect shared cached state from caller mutation](#copy-on-read)
 - [Cache invalidation groups via `group:` — tag related methods with a group name and bust them all with a single `reset_memo_group` call](#cache-invalidation-groups)
+- [Circuit breaker for external stores — `Stores::CircuitBreaker` wraps any store adapter and falls back to the per-instance cache when the store is down; configurable error threshold and probe interval](#circuit-breaker-for-external-stores)
+- [Multi-level (L1/L2) caching — `Stores::Multilevel` or `store: [l1, l2]` shorthand; reads from the fastest layer first and promotes on miss](#multi-level-caching)
+- [Stampede protection — `stampede_protection:` option applies the XFetch algorithm to the per-instance cache; `Stores::XFetch` applies it to external stores](#stampede-protection)
 
 ## Installation
 
@@ -1448,6 +1451,186 @@ end
 
 [↑ Back to features](#features)
 
+## Circuit breaker for external stores
+
+`SafeMemoize::Stores::CircuitBreaker` wraps any `Stores::Base` adapter and silently falls back to the per-instance in-process cache when the external store is unavailable, rather than propagating exceptions to callers.
+
+### How it works
+
+The breaker moves through three states:
+
+| State | Behaviour |
+|---|---|
+| `:closed` | Normal — every call passes through to the wrapped store; consecutive errors are counted |
+| `:open` | Tripped — reads return `MISS` (triggering the per-instance fallback), writes are no-ops; no calls reach the store until the probe interval elapses |
+| `:half_open` | Probe — calls are let through; the first success closes the circuit; any failure re-opens it and resets the timer |
+
+Any successful call in `:closed` state resets the consecutive error counter, so transient blips do not accumulate toward the threshold.
+
+### Usage
+
+**Direct wrapping:**
+
+```ruby
+redis = SafeMemoize::Stores::CircuitBreaker.new(
+  MyRedisStore.new,
+  error_threshold: 5,   # trip after 5 consecutive failures (default)
+  probe_interval:  30   # wait 30 s before probing (default)
+)
+
+class CatalogService
+  prepend SafeMemoize
+
+  def products = fetch_from_redis
+  memoize :products, store: redis
+end
+```
+
+**Via the `circuit_breaker:` option** (auto-wraps the configured store):
+
+```ruby
+class CatalogService
+  prepend SafeMemoize
+
+  def products = fetch_from_redis
+  memoize :products, store: MyRedisStore.new, circuit_breaker: true
+
+  def orders = fetch_orders
+  memoize :orders,
+    store: MyRedisStore.new,
+    circuit_breaker: { error_threshold: 3, probe_interval: 60 }
+end
+```
+
+When the store raises, `products` falls back to the per-instance in-memory hash — callers see no exceptions and computation still runs once per instance until the circuit closes.
+
+### Introspection and manual control
+
+```ruby
+cb = SafeMemoize::Stores::CircuitBreaker.new(store)
+
+cb.state           # => :closed | :open | :half_open
+cb.open?           # => false
+cb.error_count     # => 0
+cb.error_threshold # => 5
+cb.probe_interval  # => 30.0
+cb.wrapped_store   # => the inner adapter
+cb.reset!          # manually close the circuit and clear error count
+```
+
+### Class-wide default
+
+```ruby
+class ApiService
+  prepend SafeMemoize
+  safe_memoize_options circuit_breaker: { error_threshold: 3, probe_interval: 15 }
+
+  def users  = http.get("/users")
+  def orders = http.get("/orders")
+
+  memoize :users,  store: redis
+  memoize :orders, store: redis   # both get the circuit breaker
+end
+```
+
+[↑ Back to features](#features)
+
+## Multi-level caching
+
+`SafeMemoize::Stores::Multilevel` chains two or more store adapters from fastest (L1) to slowest. Reads walk the chain until a hit is found; on a miss in an earlier layer the value is fetched from the next layer and written back ("promoted") into all shallower layers. Writes and deletes reach every layer.
+
+```ruby
+l1 = SafeMemoize::Stores::Memory.new          # fast, in-process
+l2 = MyRedisStore.new                          # slower, cross-process
+
+class ProductService
+  prepend SafeMemoize
+
+  def catalog = fetch_catalog_from_db
+  memoize :catalog, store: [l1, l2], ttl: 300  # Array shorthand
+end
+```
+
+The `store: [l1, l2]` shorthand is equivalent to `store: Stores::Multilevel.new(l1, l2)`.
+
+### Promotion TTL
+
+By default promoted entries have no TTL (the L1 store's own eviction — e.g. LRU — handles memory bounds). Set `promote_expires_in:` to give L1 entries a shorter lifetime than L2:
+
+```ruby
+store = SafeMemoize::Stores::Multilevel.new(l1, l2, promote_expires_in: 60)
+memoize :catalog, store: store, ttl: 300
+```
+
+### Composition
+
+`Multilevel` composes with `CircuitBreaker` and `XFetch`:
+
+```ruby
+safe_l2 = SafeMemoize::Stores::CircuitBreaker.new(MyRedisStore.new)
+store   = SafeMemoize::Stores::Multilevel.new(SafeMemoize::Stores::Memory.new, safe_l2)
+memoize :catalog, store: store, ttl: 300
+```
+
+[↑ Back to features](#features)
+
+## Stampede protection
+
+Cache stampedes (a.k.a. thundering-herd) happen when a popular entry expires and many processes simultaneously recompute it. SafeMemoize offers two mechanisms:
+
+### `stampede_protection:` — per-instance cache
+
+The `stampede_protection:` option applies the **XFetch algorithm** to the per-instance in-process cache. Instead of expiring at a hard deadline, each cache read probabilistically triggers early recomputation as the entry approaches its TTL:
+
+```ruby
+class ApiClient
+  prepend SafeMemoize
+
+  def catalog = fetch_catalog
+  memoize :catalog, ttl: 300, stampede_protection: true   # default beta=1.0
+  # or
+  memoize :catalog, ttl: 300, stampede_protection: 2.0    # custom beta (more aggressive)
+end
+```
+
+The measured computation time from each cache miss is stored as `delta` and used in subsequent reads, so the XFetch probability adapts to real observed latency automatically.
+
+**Requirements:** `ttl:` must be set. Incompatible with `store:` (see `Stores::XFetch` below) and `ractor_safe:`.
+
+### `Stores::XFetch` — external stores
+
+For external stores (Redis, Rails.cache, etc.) wrap the adapter with `Stores::XFetch`. Values are stored with an `expires_at` envelope so the wrapper can apply the formula even though the store's `read` returns only the plain value:
+
+```ruby
+store = SafeMemoize::Stores::XFetch.new(
+  MyRedisStore.new,
+  delta: 0.2,   # estimated typical computation time (seconds)
+  beta:  1.5    # aggressiveness scalar
+)
+
+class CatalogService
+  prepend SafeMemoize
+
+  def products = db_fetch
+  memoize :products, store: store, ttl: 300
+end
+```
+
+**XFetch formula:** `now − (delta × beta × log(rand)) ≥ expires_at`
+
+A higher `beta` triggers early recomputation more aggressively. A larger `delta` (longer computation) also increases the recomputation window.
+
+`Stores::XFetch` composes with `Multilevel` and `CircuitBreaker`:
+
+```ruby
+store = SafeMemoize::Stores::XFetch.new(
+  SafeMemoize::Stores::CircuitBreaker.new(MyRedisStore.new),
+  delta: 0.1
+)
+```
+
+[↑ Back to features](#features)
+
 ## Per-class default options (`safe_memoize_options`)
 
 `safe_memoize_options` sets option defaults for every `memoize` call on the class, eliminating repetition when many methods share the same TTL, LRU cap, or other option. Per-call options still take precedence; class defaults take precedence over global `SafeMemoize.configure` defaults.
@@ -1686,6 +1869,8 @@ Anything **not** listed here — internal modules, private methods, `@__safe_mem
 | `cache_bust:` | `Proc \| Symbol \| nil` | `nil` | Version-token callable; invoked on the instance at each lookup; token is folded into the key; incompatible with `key:` |
 | `copy_on_read:` | `Boolean` | `false` | Return a `dup`/`deep_dup` of the cached value on every read; protects shared state from caller mutation; nil and frozen values pass through; incompatible with `ractor_safe:` |
 | `group:` | `Symbol \| String \| nil` | `nil` | Assigns the method to a named invalidation group; call `reset_memo_group` / `reset_shared_memo_group` to bust all methods in the group at once; a method belongs to at most one group |
+| `circuit_breaker:` | `true \| Hash \| nil` | `nil` | Wraps the configured `store:` in a `Stores::CircuitBreaker`; `true` uses defaults (`error_threshold: 5`, `probe_interval: 30`); pass a Hash to customise; requires a store to be set; does not double-wrap |
+| `stampede_protection:` | `true \| Numeric \| nil` | `nil` | Enables XFetch probabilistic early expiry on the per-instance cache; `true` uses beta=1.0; pass a `Numeric` for a custom beta; requires `ttl:`; incompatible with `store:` and `ractor_safe:` |
 | *(extension options)* | any | — | Unknown kwargs are validated against registered extensions; raise `ArgumentError` if unclaimed |
 
 ### `memoize_all` options (class method)
@@ -1703,7 +1888,7 @@ All `memoize` option keys above, plus:
 
 | Option key | Type | Default | Notes |
 |---|---|---|---|
-| any `memoize` key except mode-switches | — | — | Accepts `ttl:`, `max_size:`, `ttl_refresh:`, `if:`, `unless:`, `key:`, `cache_bust:`, `copy_on_read:`, `namespace:`, `store:`, `group:`; raises `ArgumentError` for `shared:`, `fiber_local:`, `ractor_safe:`, `shared_cache:` |
+| any `memoize` key except mode-switches | — | — | Accepts `ttl:`, `max_size:`, `ttl_refresh:`, `if:`, `unless:`, `key:`, `cache_bust:`, `copy_on_read:`, `namespace:`, `store:`, `group:`, `circuit_breaker:`, `stampede_protection:`; raises `ArgumentError` for `shared:`, `fiber_local:`, `ractor_safe:`, `shared_cache:` |
 
 ### Instance methods (public)
 

data/ROADMAP.md

@@ -4,27 +4,6 @@ This document tracks the planned evolution of SafeMemoize through v1.0.0 and bey
 
 ---
 
-## v1.6.0 — Resilience
-
-*Goal: make external-store memoization resilient to infrastructure failures.*
-
-| Feature | Description | Status |
-|---|---|---|
-| Circuit breaker for external stores | When a `store:` adapter raises on `read` or `write`, automatically fall back to the per-instance in-process hash rather than propagating the exception; configurable error threshold and recovery probe interval | Planned |
-
----
-
-## v1.7.0 — Advanced Store Features
-
-*Goal: multi-process performance patterns for high-traffic deployments.*
-
-| Feature | Description | Status |
-|---|---|---|
-| Multi-level (L1/L2) caching | `store: [memory_store, redis_store]` — check in-process first, fall back to the remote store on miss, and promote to L1 on read; each level can have independent TTL and eviction settings | Planned |
-| Stampede protection | Probabilistic early expiry (XFetch algorithm) for external stores; recomputes slightly before a TTL expires to prevent multiple processes hitting a cold miss simultaneously | Planned |
-
----
-
 ## v2.0.0 — Next Generation (Long Horizon)
 
 *Goal: incorporate real-world usage feedback, clean up accumulated API surface, and open a path for advanced extension.*

data/lib/safe_memoize/cache_record_methods.rb

@@ -22,8 +22,10 @@ module SafeMemoize
       Process.clock_gettime(Process::CLOCK_MONOTONIC) + ttl
     end
 
-    def memo_record(value, expires_at:)
-      {value: value, expires_at: expires_at, cached_at: Process.clock_gettime(Process::CLOCK_MONOTONIC)}
+    def memo_record(value, expires_at:, delta: nil)
+      rec = {value: value, expires_at: expires_at, cached_at: Process.clock_gettime(Process::CLOCK_MONOTONIC)}
+      rec[:delta] = delta if delta
+      rec
     end
 
     def memo_record_value(record)

data/lib/safe_memoize/class_methods.rb

@@ -69,6 +69,17 @@ module SafeMemoize
     #   {.reset_shared_memo_group} for shared-mode methods) to bust every method in the
     #   group at once. A method may belong to at most one group; re-memoizing with a
     #   different group moves it. Must be a non-empty Symbol or String.
+    # @param circuit_breaker [Boolean, Hash, nil] wraps the configured +store:+ adapter
+    #   in a {Stores::CircuitBreaker}. Pass +true+ to use defaults (+error_threshold: 5+,
+    #   +probe_interval: 30+), or a +Hash+ with +:error_threshold+ and/or +:probe_interval+
+    #   keys to customise. Requires a +store:+ to be set (per-method, class-level, or
+    #   global default); raises +ArgumentError+ otherwise.
+    # @param stampede_protection [Boolean, Numeric, nil] enables probabilistic early
+    #   expiry (XFetch algorithm) on the per-instance in-process cache. Pass +true+ to
+    #   use the default beta scalar (1.0), or a +Numeric+ to set a custom beta. A higher
+    #   beta causes early recomputation to trigger more aggressively. Requires +ttl:+ to
+    #   be set. Incompatible with +store:+ (use {Stores::XFetch} instead) and
+    #   +ractor_safe:+. For the store-backed path, wrap the store with {Stores::XFetch}.
     # @return [void]
     # @raise [ArgumentError] if the method does not exist, or option values are invalid
     #
@@ -89,7 +100,7 @@ module SafeMemoize
     # @example With a custom store
     #   STORE = SafeMemoize::Stores::Memory.new
     #   memoize :fetch, store: STORE, ttl: 300
-    def memoize(method_name, ttl: UNSET, max_size: UNSET, ttl_refresh: UNSET, if: UNSET, unless: UNSET, shared: UNSET, key: UNSET, store: UNSET, fiber_local: UNSET, ractor_safe: UNSET, namespace: UNSET, shared_cache: UNSET, cache_bust: UNSET, copy_on_read: UNSET, group: UNSET, **extension_options)
+    def memoize(method_name, ttl: UNSET, max_size: UNSET, ttl_refresh: UNSET, if: UNSET, unless: UNSET, shared: UNSET, key: UNSET, store: UNSET, fiber_local: UNSET, ractor_safe: UNSET, namespace: UNSET, shared_cache: UNSET, cache_bust: UNSET, copy_on_read: UNSET, group: UNSET, circuit_breaker: UNSET, stampede_protection: UNSET, **extension_options)
       method_name = method_name.to_sym
 
       unless method_defined?(method_name) || private_method_defined?(method_name) || protected_method_defined?(method_name)
@@ -132,6 +143,8 @@ module SafeMemoize
         namespace = cls_defaults[:namespace] if namespace.equal?(UNSET) && cls_defaults.key?(:namespace)
         store = cls_defaults[:store] if store.equal?(UNSET) && cls_defaults.key?(:store)
         group = cls_defaults[:group] if group.equal?(UNSET) && cls_defaults.key?(:group)
+        circuit_breaker = cls_defaults[:circuit_breaker] if circuit_breaker.equal?(UNSET) && cls_defaults.key?(:circuit_breaker)
+        stampede_protection = cls_defaults[:stampede_protection] if stampede_protection.equal?(UNSET) && cls_defaults.key?(:stampede_protection)
       end
 
       # Normalize remaining UNSET to original per-call defaults
@@ -148,6 +161,8 @@ module SafeMemoize
       cache_bust = nil if cache_bust.equal?(UNSET)
       copy_on_read = false if copy_on_read.equal?(UNSET)
       group = nil if group.equal?(UNSET)
+      circuit_breaker = nil if circuit_breaker.equal?(UNSET)
+      stampede_protection = nil if stampede_protection.equal?(UNSET)
       cond_if = nil if cond_if.equal?(UNSET)
       cond_unless = nil if cond_unless.equal?(UNSET)
 
@@ -192,6 +207,24 @@ module SafeMemoize
         raise ArgumentError, "cache_bust: and key: cannot be combined" if key
       end
 
+      if store.is_a?(Array)
+        store.each_with_index do |s, i|
+          unless s.is_a?(SafeMemoize::Stores::Base)
+            raise ArgumentError, "store: Array entry [#{i}] must be a Stores::Base instance (got #{s.class})"
+          end
+        end
+        store = SafeMemoize::Stores::Multilevel.new(*store)
+      end
+
+      if stampede_protection
+        unless stampede_protection == true || stampede_protection.is_a?(Numeric)
+          raise ArgumentError, "stampede_protection: must be true or a Numeric beta value (got #{stampede_protection.class})"
+        end
+        raise ArgumentError, "stampede_protection: requires ttl: to be set" if ttl.nil?
+        raise ArgumentError, "stampede_protection: is incompatible with store: — use Stores::XFetch instead" if store
+        raise ArgumentError, "stampede_protection: is incompatible with ractor_safe:" if ractor_safe
+      end
+
       if store
         raise ArgumentError, "store: must be a SafeMemoize::Stores::Base instance (got #{store.class})" unless store.is_a?(SafeMemoize::Stores::Base)
         raise ArgumentError, "max_size: is not supported with store: — use the store adapter's own eviction" if max_size
@@ -260,6 +293,19 @@ module SafeMemoize
         end
       end
 
+      if circuit_breaker
+        unless circuit_breaker == true || circuit_breaker.is_a?(Hash)
+          raise ArgumentError, "circuit_breaker: must be true or a Hash of options (got #{circuit_breaker.class})"
+        end
+        unless effective_store
+          raise ArgumentError, "circuit_breaker: requires a store: to be configured (no store is set for :#{method_name})"
+        end
+        unless effective_store.is_a?(Stores::CircuitBreaker)
+          cb_opts = circuit_breaker.is_a?(Hash) ? circuit_breaker : {}
+          effective_store = Stores::CircuitBreaker.new(effective_store, **cb_opts)
+        end
+      end
+
       __safe_memo_class_key_generators__[method_name] = key if key
       __safe_memo_class_cache_bust_generators__[method_name] = cache_bust if cache_bust
 
@@ -334,7 +380,15 @@ module SafeMemoize
             fiber_cache = fiber_memo_cache!
             record = fiber_cache[cache_key]
 
-            if memo_record_live?(record)
+            sp_early = stampede_protection && memo_record_live?(record) && record[:expires_at] &&
+              (record[:delta].to_f > 0) &&
+              begin
+                sp_beta = stampede_protection.is_a?(Numeric) ? stampede_protection.to_f : 1.0
+                now = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+                now - record[:delta].to_f * sp_beta * Math.log(rand) >= record[:expires_at]
+              end
+
+            if memo_record_live?(record) && !sp_early
               if max_size
                 lru = fiber_memo_lru![method_name] ||= {}
                 lru.delete(cache_key)
@@ -345,7 +399,7 @@ module SafeMemoize
               call_memo_hooks(:on_hit, cache_key, record)
               dup_fn.call(memo_record_value(record))
             else
-              call_memo_hooks(:on_expire, cache_key, record) if record
+              call_memo_hooks(:on_expire, cache_key, record) if record && (!memo_record_live?(record) || sp_early)
 
               start_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)
               value = Adapters::OpenTelemetry.trace(
@@ -353,7 +407,7 @@ module SafeMemoize
               ) { super(*args, **kwargs) }
               elapsed_time = Process.clock_gettime(Process::CLOCK_MONOTONIC) - start_time
 
-              new_record = memo_record(value, expires_at: memo_expires_at(ttl))
+              new_record = memo_record(value, expires_at: memo_expires_at(ttl), delta: stampede_protection ? elapsed_time : nil)
 
               if !condition || condition.call(value)
                 if max_size
@@ -412,7 +466,14 @@ module SafeMemoize
               now = Process.clock_gettime(Process::CLOCK_MONOTONIC)
               record_live = record && (record[:expires_at].nil? || record[:expires_at] > now)
 
-              if record_live
+              sp_early = record_live && stampede_protection && record[:expires_at] &&
+                (record[:delta].to_f > 0) &&
+                begin
+                  sp_beta = stampede_protection.is_a?(Numeric) ? stampede_protection.to_f : 1.0
+                  now - record[:delta].to_f * sp_beta * Math.log(rand) >= record[:expires_at]
+                end
+
+              if record_live && !sp_early
                 if max_size
                   lru = klass.send(:__safe_memo_shared_lru_order__)[method_name] ||= {}
                   lru.delete(cache_key)
@@ -423,13 +484,13 @@ module SafeMemoize
                 call_memo_hooks(:on_hit, cache_key, record)
                 dup_fn.call(record[:value])
               else
-                call_memo_hooks(:on_expire, cache_key, record) if record && !record_live
+                call_memo_hooks(:on_expire, cache_key, record) if record && (!record_live || sp_early)
 
                 start_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)
                 value = Adapters::OpenTelemetry.trace(SafeMemoize.configuration.opentelemetry_tracer, method_name, klass.name) { super(*args, **kwargs) }
                 elapsed_time = Process.clock_gettime(Process::CLOCK_MONOTONIC) - start_time
 
-                new_record = memo_record(value, expires_at: memo_expires_at(ttl))
+                new_record = memo_record(value, expires_at: memo_expires_at(ttl), delta: stampede_protection ? elapsed_time : nil)
 
                 if !condition || condition.call(value)
                   if max_size
@@ -473,10 +534,22 @@ module SafeMemoize
 
           cache_key = compute_cache_key(method_name, args, kwargs)
 
-          if max_size || condition || ttl_refresh
-            # Locked path: used when LRU tracking, conditional storage, or TTL refresh is needed.
+          if max_size || condition || ttl_refresh || stampede_protection
+            # Locked path: LRU, conditional storage, TTL refresh, or stampede protection.
+            sp_beta = stampede_protection.is_a?(Numeric) ? stampede_protection.to_f : 1.0
+
             memo_mutex!.synchronize do
               record = memo_cache_record(cache_key)
+
+              if record && stampede_protection && record[:expires_at]
+                now = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+                delta = record[:delta].to_f
+                if delta > 0 && now - delta * sp_beta * Math.log(rand) >= record[:expires_at]
+                  call_memo_hooks(:on_expire, cache_key, record)
+                  record = nil
+                end
+              end
+
               if record
                 lru_touch(method_name, cache_key) if max_size
                 record[:expires_at] = memo_expires_at(ttl) if ttl_refresh
@@ -488,7 +561,7 @@ module SafeMemoize
                 value = Adapters::OpenTelemetry.trace(SafeMemoize.configuration.opentelemetry_tracer, method_name, self.class.name) { super(*args, **kwargs) }
                 elapsed_time = Process.clock_gettime(Process::CLOCK_MONOTONIC) - start_time
 
-                new_record = memo_record(value, expires_at: memo_expires_at(ttl))
+                new_record = memo_record(value, expires_at: memo_expires_at(ttl), delta: stampede_protection ? elapsed_time : nil)
                 if !condition || condition.call(value)
                   lru_evict_if_over_limit(method_name, max_size) if max_size
                   @__safe_memo_cache__ ||= {}

data/lib/safe_memoize/stores/circuit_breaker.rb

@@ -0,0 +1,178 @@
+# frozen_string_literal: true
+
+module SafeMemoize
+  module Stores
+    # Wraps any {Base} store adapter with a circuit breaker that silently falls
+    # back to the per-instance in-process cache when the external store is
+    # unavailable, rather than propagating exceptions to callers.
+    #
+    # === States
+    #
+    # * +:closed+    — normal; every call goes through to the wrapped store;
+    #                  consecutive errors are counted
+    # * +:open+      — tripped; reads return {MISS} and writes are no-ops so the
+    #                  memoize wrapper falls back to the per-instance hash; no
+    #                  calls reach the wrapped store until the probe interval elapses
+    # * +:half_open+ — probe period (probe interval elapsed); calls are let
+    #                  through to the wrapped store; the first success closes the
+    #                  circuit, any failure re-opens it and resets the timer
+    #
+    # Any successful call while the circuit is +:closed+ resets the consecutive
+    # error counter, so transient blips do not accumulate toward the threshold.
+    #
+    # @example Wrap a custom Redis store
+    #   store = SafeMemoize::Stores::CircuitBreaker.new(
+    #     MyRedisStore.new,
+    #     error_threshold: 5,
+    #     probe_interval:  30
+    #   )
+    #   memoize :fetch, store: store
+    #
+    # @example Via the circuit_breaker: option (auto-wraps the configured store)
+    #   memoize :fetch, store: MyRedisStore.new, circuit_breaker: true
+    #   memoize :fetch, store: MyRedisStore.new,
+    #                   circuit_breaker: { error_threshold: 3, probe_interval: 60 }
+    class CircuitBreaker < Base
+      DEFAULT_ERROR_THRESHOLD = 5
+      DEFAULT_PROBE_INTERVAL = 30.0
+
+      # @return [Stores::Base] the wrapped inner store
+      attr_reader :wrapped_store
+      # @return [Integer] number of consecutive errors that trip the circuit
+      attr_reader :error_threshold
+      # @return [Float] seconds after tripping before a probe is attempted
+      attr_reader :probe_interval
+
+      # @param store [Stores::Base] the backing store to protect
+      # @param error_threshold [Integer] consecutive errors that trip the circuit (default 5)
+      # @param probe_interval [Numeric] seconds to wait before probing (default 30)
+      # @raise [ArgumentError] if +store+ is not a {Stores::Base} instance, or
+      #   if threshold / interval are invalid
+      def initialize(store, error_threshold: DEFAULT_ERROR_THRESHOLD, probe_interval: DEFAULT_PROBE_INTERVAL)
+        unless store.is_a?(Base)
+          raise ArgumentError, "CircuitBreaker requires a Stores::Base instance (got #{store.class})"
+        end
+
+        @wrapped_store = store
+        @error_threshold = Integer(error_threshold)
+        @probe_interval = Float(probe_interval)
+
+        raise ArgumentError, "error_threshold must be positive" unless @error_threshold > 0
+        raise ArgumentError, "probe_interval must be positive" unless @probe_interval > 0
+
+        @mutex = Mutex.new
+        @error_count = 0
+        @opened_at = nil
+      end
+
+      # Read from the wrapped store, returning {MISS} on error or when the
+      # circuit is open instead of raising.
+      def read(key)
+        st = current_state
+        return MISS if st == :open
+
+        result = @wrapped_store.read(key)
+        record_success(st)
+        result
+      rescue
+        record_failure
+        MISS
+      end
+
+      # Write to the wrapped store, silently swallowing errors so the caller's
+      # return value is unaffected. A no-op when the circuit is open.
+      def write(key, value, expires_in: nil)
+        st = current_state
+        return if st == :open
+
+        @wrapped_store.write(key, value, expires_in: expires_in)
+        record_success(st)
+      rescue
+        record_failure
+      end
+
+      # Delete from the wrapped store. A no-op when the circuit is open.
+      def delete(key)
+        return if current_state == :open
+
+        @wrapped_store.delete(key)
+      rescue
+        record_failure
+      end
+
+      # Clear the wrapped store. Errors are recorded but not re-raised.
+      def clear
+        @wrapped_store.clear
+      rescue
+        record_failure
+      end
+
+      # Returns live keys from the wrapped store, or an empty array when the
+      # circuit is open or the store raises.
+      def keys
+        return [] if current_state == :open
+
+        @wrapped_store.keys
+      rescue
+        record_failure
+        []
+      end
+
+      # Returns the current circuit state: +:closed+, +:open+, or +:half_open+.
+      # @return [Symbol]
+      def state
+        current_state
+      end
+
+      # Returns +true+ when the circuit is not fully closed (i.e. open or half-open).
+      # @return [Boolean]
+      def open?
+        current_state != :closed
+      end
+
+      # Returns the current consecutive error count.
+      # @return [Integer]
+      def error_count
+        @mutex.synchronize { @error_count }
+      end
+
+      # Manually resets the circuit to +:closed+, clearing the error counter.
+      # @return [void]
+      def reset!
+        @mutex.synchronize do
+          @error_count = 0
+          @opened_at = nil
+        end
+      end
+
+      private
+
+      def current_state
+        @mutex.synchronize do
+          next :closed if @opened_at.nil?
+
+          elapsed = Process.clock_gettime(Process::CLOCK_MONOTONIC) - @opened_at
+          (elapsed >= @probe_interval) ? :half_open : :open
+        end
+      end
+
+      def record_success(prior_state)
+        return unless prior_state == :half_open || @error_count > 0
+
+        @mutex.synchronize do
+          @error_count = 0
+          @opened_at = nil
+        end
+      end
+
+      def record_failure
+        @mutex.synchronize do
+          @error_count += 1
+          if @error_count >= @error_threshold || !@opened_at.nil?
+            @opened_at = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/safe_memoize/stores/multilevel.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+module SafeMemoize
+  module Stores
+    # Multi-level (L1/L2/…) cache store that checks faster layers first and
+    # promotes values up on a miss, reducing latency and load on slower backends.
+    #
+    # Reads walk the store list from first (fastest) to last (slowest). On a
+    # miss at level N the value is read from level N+1 and written back into
+    # all preceding levels ("read-through promotion"). Writes always go to every
+    # level so all layers stay consistent.
+    #
+    # @example In-process L1 + Redis L2
+    #   l1 = SafeMemoize::Stores::Memory.new
+    #   l2 = MyRedisStore.new
+    #
+    #   memoize :fetch, store: SafeMemoize::Stores::Multilevel.new(l1, l2)
+    #
+    # @example Via the store: Array shorthand
+    #   memoize :fetch, store: [l1, l2], ttl: 300
+    #
+    # @example With a short promote_expires_in for the L1 layer
+    #   memoize :fetch, store: SafeMemoize::Stores::Multilevel.new(l1, l2, promote_expires_in: 60)
+    class Multilevel < Base
+      # @return [Array<Stores::Base>] the ordered store layers (fastest first)
+      attr_reader :stores
+
+      # @param stores [Array<Stores::Base>] two or more store instances, ordered
+      #   from fastest (L1) to slowest (last)
+      # @param promote_expires_in [Numeric, nil] TTL applied when promoting a
+      #   value from a deeper layer into a shallower one; +nil+ means no expiry
+      #   on the promoted entry (the L1 store's own eviction — e.g. LRU — handles
+      #   memory bounds instead)
+      # @raise [ArgumentError] if fewer than two stores are supplied, or any
+      #   element is not a {Stores::Base} instance
+      def initialize(*stores, promote_expires_in: nil)
+        raise ArgumentError, "Multilevel requires at least 2 stores" if stores.size < 2
+
+        stores.each_with_index do |s, i|
+          unless s.is_a?(Base)
+            raise ArgumentError,
+              "Multilevel store[#{i}] must be a Stores::Base instance (got #{s.class})"
+          end
+        end
+
+        @stores = stores.freeze
+        @promote_expires_in = promote_expires_in ? Float(promote_expires_in) : nil
+      end
+
+      # Walk levels from fastest to slowest; return the first hit, promoting
+      # the value into all shallower layers.
+      def read(key)
+        @stores.each_with_index do |store, i|
+          result = store.read(key)
+          next if result.equal?(MISS)
+
+          # Promote into every shallower level
+          @stores.first(i).each { |s| s.write(key, result, expires_in: @promote_expires_in) }
+          return result
+        end
+
+        MISS
+      end
+
+      # Write to every level simultaneously.
+      def write(key, value, expires_in: nil)
+        @stores.each { |s| s.write(key, value, expires_in: expires_in) }
+      end
+
+      # Delete from every level.
+      def delete(key)
+        @stores.each { |s| s.delete(key) }
+      end
+
+      # Clear every level.
+      def clear
+        @stores.each(&:clear)
+      end
+
+      # Union of live keys across all levels.
+      def keys
+        @stores.flat_map(&:keys).uniq
+      end
+    end
+  end
+end

data/lib/safe_memoize/stores/xfetch.rb

@@ -0,0 +1,129 @@
+# frozen_string_literal: true
+
+module SafeMemoize
+  module Stores
+    # Wraps any {Base} store adapter with probabilistic early expiry (the
+    # XFetch algorithm) to prevent cache stampedes — the thundering-herd
+    # problem where many processes simultaneously recompute a value the moment
+    # it expires under high load.
+    #
+    # Instead of waiting until {#read} returns {MISS} at the hard expiry
+    # deadline, the wrapper stochastically returns {MISS} slightly before
+    # expiry, giving one process a head start on recomputation while everyone
+    # else still gets the cached value. The probability of early expiry rises
+    # as the entry approaches its deadline.
+    #
+    # === XFetch formula
+    #
+    #   early_expire = now − (delta × beta × log(rand)) ≥ expires_at
+    #
+    # * +delta+ — estimated computation time in seconds (default 0.1 s).
+    #   Configure this to the typical duration of the underlying computation.
+    # * +beta+  — aggressiveness scalar (default 1.0); higher values trigger
+    #   early recomputation more eagerly.
+    #
+    # Values are stored internally as an envelope +{value:, expires_at:}+ so
+    # the wrapper always knows the hard deadline regardless of what the inner
+    # store exposes on read. The envelope survives standard Ruby Marshal
+    # serialization (Redis via the +redis-store+ or +redis-client+ gems,
+    # Rails.cache, etc.). Values that cannot be serialized alongside a small
+    # hash are not supported.
+    #
+    # @example Wrap a Redis store
+    #   store = SafeMemoize::Stores::XFetch.new(
+    #     MyRedisStore.new,
+    #     delta: 0.2,   # typical computation time in seconds
+    #     beta:  1.5    # slightly aggressive early expiry
+    #   )
+    #   memoize :fetch, store: store, ttl: 300
+    #
+    # @example Compose with CircuitBreaker
+    #   store = SafeMemoize::Stores::XFetch.new(
+    #     SafeMemoize::Stores::CircuitBreaker.new(MyRedisStore.new),
+    #     delta: 0.1
+    #   )
+    #   memoize :fetch, store: store, ttl: 60
+    class XFetch < Base
+      ENVELOPE_KEY = :__sm_xfetch_v1__
+
+      DEFAULT_BETA = 1.0
+      DEFAULT_DELTA = 0.1
+
+      # @return [Stores::Base] the wrapped inner store
+      attr_reader :wrapped_store
+      # @return [Float] aggressiveness scalar
+      attr_reader :beta
+      # @return [Float] estimated computation time in seconds
+      attr_reader :delta
+
+      # @param store [Stores::Base] the backing store to wrap
+      # @param beta  [Numeric] aggressiveness scalar (default 1.0)
+      # @param delta [Numeric] estimated computation time in seconds (default 0.1)
+      # @raise [ArgumentError] if +store+ is not a {Stores::Base} instance, or
+      #   if +beta+/+delta+ are not positive numbers
+      def initialize(store, beta: DEFAULT_BETA, delta: DEFAULT_DELTA)
+        unless store.is_a?(Base)
+          raise ArgumentError, "XFetch requires a Stores::Base instance (got #{store.class})"
+        end
+
+        @wrapped_store = store
+        @beta = Float(beta)
+        @delta = Float(delta)
+
+        raise ArgumentError, "beta must be positive" unless @beta > 0
+        raise ArgumentError, "delta must be positive" unless @delta > 0
+      end
+
+      # Read from the wrapped store and apply the XFetch probabilistic check.
+      #
+      # Returns {MISS} when:
+      # * the inner store has no entry for +key+
+      # * the stored value is not an XFetch envelope (possibly written by an
+      #   older version or a different store wrapper)
+      # * the XFetch formula triggers early expiry
+      def read(key)
+        raw = @wrapped_store.read(key)
+        return MISS if raw.equal?(MISS)
+        return MISS unless envelope?(raw)
+
+        expires_at = raw[:expires_at]
+
+        if expires_at
+          now = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+          early = now - @delta * @beta * Math.log(rand) >= expires_at
+          return MISS if early
+        end
+
+        raw[:value]
+      end
+
+      # Write the value to the wrapped store inside an XFetch envelope.
+      def write(key, value, expires_in: nil)
+        expires_at = expires_in ? Process.clock_gettime(Process::CLOCK_MONOTONIC) + expires_in.to_f : nil
+        envelope = {ENVELOPE_KEY => true, :value => value, :expires_at => expires_at}
+        @wrapped_store.write(key, envelope, expires_in: expires_in)
+      end
+
+      # Delete from the wrapped store.
+      def delete(key)
+        @wrapped_store.delete(key)
+      end
+
+      # Clear the wrapped store.
+      def clear
+        @wrapped_store.clear
+      end
+
+      # Returns live keys from the wrapped store.
+      def keys
+        @wrapped_store.keys
+      end
+
+      private
+
+      def envelope?(value)
+        value.is_a?(Hash) && value[ENVELOPE_KEY]
+      end
+    end
+  end
+end

data/lib/safe_memoize/version.rb

@@ -2,5 +2,5 @@
 
 module SafeMemoize
   # The current gem version string.
-  VERSION = "1.5.0"
+  VERSION = "1.7.0"
 end

data/lib/safe_memoize.rb

@@ -5,6 +5,9 @@ require_relative "safe_memoize/configuration"
 require_relative "safe_memoize/extension"
 require_relative "safe_memoize/stores/base"
 require_relative "safe_memoize/stores/memory"
+require_relative "safe_memoize/stores/circuit_breaker"
+require_relative "safe_memoize/stores/multilevel"
+require_relative "safe_memoize/stores/xfetch"
 require_relative "safe_memoize/adapters/statsd"
 require_relative "safe_memoize/adapters/opentelemetry"
 require_relative "safe_memoize/adapters/concurrent_ruby"

data/sig/safe_memoize.rbs

@@ -66,7 +66,7 @@ module SafeMemoize
   end
 
   module ClassMethods
-    def memoize: (Symbol | String method_name, ?ttl: Numeric?, ?max_size: Integer?, ?ttl_refresh: bool, ?if: (^(untyped result) -> boolish)?, ?unless: (^(untyped result) -> boolish)?, ?shared: bool, ?key: (^(*untyped args, **untyped kwargs) -> untyped)?, ?store: Stores::Base?, ?fiber_local: bool, ?ractor_safe: bool, ?namespace: String?, ?shared_cache: String?, ?cache_bust: (^() -> untyped) | Symbol | nil, ?copy_on_read: bool, ?group: Symbol | String | nil, **untyped extension_options) -> void
+    def memoize: (Symbol | String method_name, ?ttl: Numeric?, ?max_size: Integer?, ?ttl_refresh: bool, ?if: (^(untyped result) -> boolish)?, ?unless: (^(untyped result) -> boolish)?, ?shared: bool, ?key: (^(*untyped args, **untyped kwargs) -> untyped)?, ?store: Stores::Base | Array[Stores::Base] | nil, ?fiber_local: bool, ?ractor_safe: bool, ?namespace: String?, ?shared_cache: String?, ?cache_bust: (^() -> untyped) | Symbol | nil, ?copy_on_read: bool, ?group: Symbol | String | nil, ?circuit_breaker: bool | Hash[Symbol, untyped] | nil, ?stampede_protection: bool | Numeric | nil, **untyped extension_options) -> void
     def safe_memoize_store: () -> Stores::Base?
     def safe_memoize_store=: (Stores::Base?) -> Stores::Base?
     def safe_memoize_namespace: () -> String?
@@ -148,7 +148,7 @@ module SafeMemoize
 
     def memo_ttl: (Numeric? ttl) -> Float?
     def memo_expires_at: (Float? ttl) -> Float?
-    def memo_record: (untyped value, expires_at: Float?) -> memo_record
+    def memo_record: (untyped value, expires_at: Float?, ?delta: Float?) -> memo_record
     def memo_record_value: (memo_record record) -> untyped
     def memo_record_live?: (memo_record? record) -> bool
     def memo_prune_expired_entries!: (Hash[memo_key, memo_record] cache) -> void
@@ -300,6 +300,64 @@ module SafeMemoize
 
       def expired?: ({ expires_at: Float?, value: untyped, cached_at: Float }) -> bool
     end
+
+    class Multilevel < Base
+      attr_reader stores: Array[Base]
+
+      def initialize: (*Base stores, ?promote_expires_in: Numeric?) -> void
+      def read: (untyped key) -> untyped
+      def write: (untyped key, untyped value, ?expires_in: Numeric?) -> void
+      def delete: (untyped key) -> void
+      def clear: () -> void
+      def keys: () -> Array[untyped]
+    end
+
+    class XFetch < Base
+      ENVELOPE_KEY: Symbol
+      DEFAULT_BETA: Float
+      DEFAULT_DELTA: Float
+
+      attr_reader wrapped_store: Base
+      attr_reader beta: Float
+      attr_reader delta: Float
+
+      def initialize: (Base store, ?beta: Numeric, ?delta: Numeric) -> void
+      def read: (untyped key) -> untyped
+      def write: (untyped key, untyped value, ?expires_in: Numeric?) -> void
+      def delete: (untyped key) -> void
+      def clear: () -> void
+      def keys: () -> Array[untyped]
+
+      private
+
+      def envelope?: (untyped value) -> bool
+    end
+
+    class CircuitBreaker < Base
+      DEFAULT_ERROR_THRESHOLD: Integer
+      DEFAULT_PROBE_INTERVAL: Float
+
+      attr_reader wrapped_store: Base
+      attr_reader error_threshold: Integer
+      attr_reader probe_interval: Float
+
+      def initialize: (Base store, ?error_threshold: Integer, ?probe_interval: Numeric) -> void
+      def read: (untyped key) -> untyped
+      def write: (untyped key, untyped value, ?expires_in: Numeric?) -> void
+      def delete: (untyped key) -> void
+      def clear: () -> void
+      def keys: () -> Array[untyped]
+      def state: () -> Symbol
+      def open?: () -> bool
+      def error_count: () -> Integer
+      def reset!: () -> void
+
+      private
+
+      def current_state: () -> Symbol
+      def record_success: (Symbol prior_state) -> void
+      def record_failure: () -> void
+    end
   end
 
   module Adapters

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: safe_memoize
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.7.0
 platform: ruby
 authors:
 - Chuck Smith
@@ -77,9 +77,12 @@ files:
 - lib/safe_memoize/rails/request_scoped.rb
 - lib/safe_memoize/release_tooling.rb
 - lib/safe_memoize/stores/base.rb
+- lib/safe_memoize/stores/circuit_breaker.rb
 - lib/safe_memoize/stores/memory.rb
+- lib/safe_memoize/stores/multilevel.rb
 - lib/safe_memoize/stores/rails_cache.rb
 - lib/safe_memoize/stores/redis.rb
+- lib/safe_memoize/stores/xfetch.rb
 - lib/safe_memoize/version.rb
 - rbi/safe_memoize.rbi
 - sig/safe_memoize.rbs