atomic_cache 0.5.1.rc1 → 0.5.5.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f03b8f8d9294f3a40ea719ea5165d4c6789c3eebb36459768c8fbd0c57d8fc3a
-  data.tar.gz: b2a320b8323c57785e0202e29d89922b33e63fc9ebd898d6df61f76fb5e2600c
+  metadata.gz: 0e3ac94ddb9677147c7ac09a9a99773ba2f06c93c1c9133463f0e43645553bd5
+  data.tar.gz: 00734774a95fb01689e02b91de9c7f8aad7d0a9188512c9ff955c1bd1d9a0d54
 SHA512:
-  metadata.gz: f461c2bf7d903c6f7940334b8f5d11672c7ed04d1d55ad5d25c2337c07906d24a39f8958ddf04a2dd5d5dc690c9a0920121fb99c9f25c809c08959e48ee13ae3
-  data.tar.gz: 9100ad9f5e5012c3729e3bc3a3b95ca64705c562f14e5d610df9f223436ee9351ec58cddc64b61c87c186a588f18e6158e891308aa5d431739f56aa2562744fa
+  metadata.gz: 8ba37b1082a3f252d8d313303db631c349bc28ad713a4b4dc57c5bb259904576202e74e844fbdebb29fa557f3a47c0f3451a7f0ea015c817adba3a863070a222
+  data.tar.gz: ea17c5f647ab914079a48680bc79afc8f6958e087f532dd950fc31eee19d470689d28eeb053faf2fc72e717ca87119795a960f5e6d9500cefe34423ad583e992

data/docs/MODEL_SETUP.md

@@ -29,3 +29,65 @@ class Foo < ActiveRecord::Base
   cache_version(5)
 end
 ```
+
+### Inheritance
+
+When either `force_cache_class` or `cache_version` are used, those values will always be preferred by classes which inherit from the class on which those macros exist. When macros are used on descendant classes, the "closet" value wins.
+
+#### Example #1
+The keys used by `Bar` will be prefixed with `custom:v5`, as it prefers both the 'custom' class name and version 5 from the parent.
+```ruby
+class Foo < ActiveRecord::Base
+  include AtomicCache::GlobalLMTCacheConcern
+  force_cache_class('custom')
+  cache_version(5)
+end
+
+class Bar < Foo
+end
+```
+
+#### Example #2
+The keys used by `Bar` will be prefixed with `bar:v5`, as the version 5 is taken from the parent, but the use of forcing on the child class result in the cache class of 'bar'.
+```ruby
+class Foo < ActiveRecord::Base
+  include AtomicCache::GlobalLMTCacheConcern
+  cache_version(5)
+end
+
+class Bar < Foo
+  force_cache_class('bar')
+end
+```
+
+#### Example #3
+The keys used by `Bar` will be still be prefixed with `bar:v5` for the same reasons as above.
+```ruby
+class Foo < ActiveRecord::Base
+  include AtomicCache::GlobalLMTCacheConcern
+  force_cache_class('custom')
+  cache_version(5)
+end
+
+class Bar < Foo
+  force_cache_class('bar')
+end
+```
+
+### Rails Model Inheritance
+
+It's not uncommon in rails to end up with model inhertiance. For example:
+
+```ruby
+class Content < ActiveRecord::Base
+  include AtomicCache::GlobalLMTCacheConcern
+  force_cache_class('content')
+end
+
+class BlogPost < Content
+end
+```
+
+If these models will be cached together into a single key, it's preferable to force the cache class on the parent, causing all the descendant types to use the same keyspace. Not doing this will cause each subtype to use it's own last modified time.
+
+If the models will be treated as separate collections and cached separately, this is not recommended. Alternately, if only some subtypes will be cached together, those should share a forced cache class and version.

data/docs/USAGE.md

@@ -38,6 +38,12 @@ The ideal `generate_ttl_ms` time is just slightly longer than the average genera
 
 If metrics are enabled, the `<namespace>.generate.run` can be used to determine the min/max/average generate time for a particular cache and the `generate_ttl_ms` tuned using that.
 
+##### ⚠️ TTL Rounding
+When using atomic_cache with memcached, be aware that the TTL will be rounded down to the nearest whole seconds. For example, a `generate_ttl_ms` value of 3500 will result in a 3s TTL with memcache.
+
+##### ⚠️ Max Rate of Change
+Atomic_cache will *not* remove the lock after the generation process is done. This is both more efficient, and allows the `generate_ttl_ms` to be used to limit the total rate of change. For example, if the typical database query behind the cache takes 2s to run, but `generate_ttl_ms` is set to 10s, then the lock will live on for 8s after the generate process finishes, preventing other processes from querying for a new value. In many ways, `generate_ttl_ms` is the amount of time that the system will be un-allowed to make additional queries.  
+
 #### `max_retries` & `backoff_duration_ms`
 _`max_retries` defaults to 5._
 _`backoff_duration_ms` defaults to 50ms._

data/lib/atomic_cache/atomic_cache_client.rb

@@ -93,8 +93,8 @@ module AtomicCache
         end
 
         new_key = @timestamp_manager.next_key(keyspace, lmt)
-        @timestamp_manager.promote(keyspace, last_known_key: new_key, timestamp: lmt)
         @storage.set(new_key, new_value, options)
+        @timestamp_manager.promote(keyspace, last_known_key: new_key, timestamp: lmt)
 
         metrics(:increment, 'generate.current-thread', tags: tags)
         log(:debug, "Generating new value for `#{new_key}`")
@@ -148,7 +148,7 @@ module AtomicCache
       end
 
       metrics(:increment, 'wait.give-up')
-      log(:warn, "Giving up waiting. Exceeded max retries (#{max_retries}).")
+      log(:warn, "Giving up waiting. Exceeded max retries (#{max_retries}) for root #{keyspace.root}.")
       nil
     end
 

data/lib/atomic_cache/concerns/global_lmt_cache_concern.rb

@@ -63,15 +63,29 @@ module AtomicCache
         @timestamp_manager.last_modified_time
       end
 
+      # protected
+
+      def cache_version_get
+        return @atomic_cache_version if @atomic_cache_version.present?
+        return self.superclass.cache_version_get if self.superclass.respond_to?(:cache_version_get)
+        nil
+      end
+
+      def cache_class_get
+        return @atomic_cache_class if @atomic_cache_class.present?
+        return self.superclass.cache_class_get if self.superclass.respond_to?(:cache_class_get)
+        nil
+      end
+
       private
 
       def init_atomic_cache
         return if @atomic_cache.present?
         ATOMIC_CACHE_CONCERN_MUTEX.synchronize do
-          cache_class = @atomic_cache_class || default_cache_class
+          cache_class = cache_class_get || default_cache_class
           prefix = [cache_class]
           prefix.unshift(DefaultConfig.instance.namespace) if DefaultConfig.instance.namespace.present?
-          prefix.push("v#{@atomic_cache_version}") if @atomic_cache_version.present?
+          prefix.push("v#{cache_version_get}") if cache_version_get.present?
           @default_cache_keyspace = Keyspace.new(namespace: prefix, root: cache_class)
 
           @timestamp_manager = LastModTimeKeyManager.new(

data/lib/atomic_cache/key/last_mod_time_key_manager.rb

@@ -44,8 +44,7 @@ module AtomicCache
     # @param last_known_key [String] a key with a known value to refer other processes to
     # @param timestamp [String, Numeric, Time] the timestamp with which the last_known_key was updated at
     def promote(keyspace, last_known_key:, timestamp:)
-      key = keyspace.last_known_key_key
-      @storage.set(key, last_known_key)
+      @storage.set(keyspace.last_known_key_key, last_known_key)
       @storage.set(last_modified_time_key, self.format(timestamp))
     end
 

data/lib/atomic_cache/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AtomicCache
-  VERSION = "0.5.1.rc1"
+  VERSION = "0.5.5.rc1"
 end

data/spec/atomic_cache/concerns/global_lmt_cache_concern_spec.rb

@@ -113,6 +113,61 @@ describe 'AtomicCacheConcern' do
       subject.expire_cache
       expect(key_storage.store).to have_key(:'foo:v3:lmt')
     end
+
+    context 'with version < class inheritance' do
+      subject do
+        class Foo3
+          include AtomicCache::GlobalLMTCacheConcern
+          cache_version(6)
+        end
+        class Foo4 < Foo3
+          force_cache_class('foo')
+        end
+        Foo4
+      end
+
+      it 'uses the version from the parent and the forced class name from the macro' do
+        subject.expire_cache
+        expect(key_storage.store).to have_key(:'foo:v6:lmt')
+      end
+    end
+
+    context 'with class < version inheritance' do
+      subject do
+        class Foo5
+          include AtomicCache::GlobalLMTCacheConcern
+          force_cache_class('foo')
+        end
+        class Foo6 < Foo5
+          cache_version(6)
+        end
+        Foo6
+      end
+
+      it 'uses the cache class from the parent and version from the macro' do
+        subject.expire_cache
+        expect(key_storage.store).to have_key(:'foo:v6:lmt')
+      end
+    end
+
+    context 'dual force_cache_class' do
+      subject do
+        class Foo6
+          include AtomicCache::GlobalLMTCacheConcern
+          force_cache_class('foo')
+        end
+        class Foo7 < Foo6
+          force_cache_class('bar')
+          cache_version(6)
+        end
+        Foo7
+      end
+
+      it 'uses the prefers the forced class name from the macro' do
+        subject.expire_cache
+        expect(key_storage.store).to have_key(:'bar:v6:lmt')
+      end
+    end
   end
 
   context 'storage macros' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: atomic_cache
 version: !ruby/object:Gem::Version
-  version: 0.5.1.rc1
+  version: 0.5.5.rc1
 platform: ruby
 authors:
 - Ibotta Developers
@@ -9,22 +9,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-12 00:00:00.000000000 Z
+date: 2021-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: gems
   requirement: !ruby/object:Gem::Requirement
@@ -137,6 +137,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.8.1
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -144,9 +158,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.2'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -154,9 +165,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.2'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '6'
 - !ruby/object:Gem::Dependency
   name: murmurhash3
   requirement: !ruby/object:Gem::Requirement