identity_cache 1.2.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 561965856845fc5d5094581d735584924eda58557edfb3831c39bce2498635aa
-  data.tar.gz: 33a85428a3b2a298076d81a79b662b742c00a25971bf453f8f57eeab7cba2681
+  metadata.gz: 3abed29487ae94532060d1a35e2bc86f8b4187cbc9a3074c8c304ab4f8426b4b
+  data.tar.gz: ddcaf494c9bc48055ee4e1ddc83a5caf61e047e4d053eb2b4e87a086a73f97ae
 SHA512:
-  metadata.gz: 6a8c691d8883acfd69f11724dfff13a3ef4858a2abd2ca658659981f1d08b36dea244100c4030b8ef5d39ac8509e639fea6cd02127e09d157be636fcc2bee77a
-  data.tar.gz: e357c3a4f02a288a5ddb3290cbd11176937821bb3c9052fb318d9139ac253650f7018a8249b2ebc9f115015a6434baf7cb1b7e76bfb0dbf1e98ee745e3e95ed7
+  metadata.gz: e0c8e9d0996d6f7f3f3e760fbf1ec2f7b8fa819bbeeaa3dc8b1286125265da45c6b174a77d3b13f763e6db104d613a55562f0a0ff13eb6d0c800e455ae30020c
+  data.tar.gz: 03a5cffffa5a0971f0d12a4d449c518a471d579410c2f7b8dfe32ad82234fb08115fa44cc99e726ed28352ead0287c5e966f47fb0b607758ddb29b1baa4667a4

data/.github/workflows/ci.yml

@@ -16,14 +16,14 @@ jobs:
       matrix:
         entry:
           - name: 'Minimum supported'
-            ruby: '2.5'
+            ruby: '2.7'
             gemfile: "Gemfile.min-supported"
           - name: 'Latest released & run rubocop'
-            ruby: '3.0'
+            ruby: '3.2'
             gemfile: "Gemfile.latest-release"
             rubocop: true
           - name: 'Rails edge'
-            ruby: '3.0'
+            ruby: '3.2'
             gemfile: "Gemfile.rails-edge"
             edge: true
 

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Identity Cache Changelog
 
+## Unreleased
+
+## 1.3.1
+
+### Fixes
+- Remove N+1 queries from embedded associations when using `fetch` while `should_use_cache` is false. (#531)
+
+## 1.3.0
+
+### Features
+- Return meaningful value from `expire_cache` indicating whenever it succeeded or failed in the process. (#523)
+
+### Fixes
+- Expire parents cache when when calling `expire_cache`. (#523)
+- Avoid creating too many shapes on Ruby 3.2+. (#526)
+
 ## 1.2.0
 
 ### Fixes

data/README.md

@@ -254,11 +254,26 @@ Cache keys include a version number by default, specified in `IdentityCache::CAC
 
 ## Caveats
 
-A word of warning. If an `after_commit` fails before the cache expiry `after_commit` the cache will not be expired and you will be left with stale data.
-
-Since everything is being marshalled and unmarshalled from Memcached changing Ruby or Rails versions could mean your objects cannot be unmarshalled from Memcached. There are a number of ways to get around this such as namespacing keys when you upgrade or rescuing marshal load errors and treating it as a cache miss. Just something to be aware of if you are using IdentityCache and upgrade Ruby or Rails.
-
-IdentityCache is also very much _opt-in_ by deliberate design. This means IdentityCache does not mess with the way normal Rails associations work, and including it in a model won't change any clients of that model until you switch them to use `fetch` instead of `find`. This is because there is no way IdentityCache is ever going to be 100% consistent. Processes die, exceptions happen, and network blips occur, which means there is a chance that some database transaction might commit but the corresponding memcached cache invalidation operation does not make it. This means that you need to think carefully about when you use `fetch` and when you use `find`. For example, at Shopify, we never use any `fetch`ers on the path which moves money around, because IdentityCache could simply be wrong, and we want to charge people the right amount of money. We do however use the fetchers on performance critical paths where absolute correctness isn't the most important thing, and this is what IdentityCache is intended for.
+IdentityCache is never going to be 100% consistent, since cache invalidations can be lost. As such, it was intentionally designed to be _opt-in_, so it is only used where cache inconsistency is tolerated. This means IdentityCache does not mess with the way normal Rails associations work, and including it in a model won't change any clients of that model until you switch them to use `fetch` instead of `find`. This means that you need to think carefully about when you use `fetch` and when you use `find`.
+
+Expected sources of lost cache invalidations include:
+* Database write performed that doesn't trigger an after_commit callback
+* Process/system getting killed or crashing between the database commit and cache invalidation
+* Network unavailability, including transient failures, preventing the delivery of the cache invalidation
+* Memcached unavailability or failure preventing the processing of the cache invalidation request
+* Memcached flush / restart could remove a cache invalidation that would normally interrupt a cache fill that started when the cache key was absent. E.g.
+  1. cache key absent (not just invalidated)
+  2. process 1 reads cache key
+  3. process 1 starts reading from the database
+  4. process 2 writes to the database
+  5. process 2 writes a cache invalidation marker to cache key
+  6. memcached flush
+  7. process 1 uses an `ADD` operation, which succeeds in filling the cache with the now stale data
+* Rollout of cache namespace changes (e.g. from upgrading IdentityCache, adding columns, cached associations or from application changes to IdentityCache.cache_namespace) can result in cache fills to the new namespace that aren't invalidated by cache invalidations from a process still using the old namespace
+
+Cache expiration is meant to be used to help the system recover, but it only works if the application avoids using the cache data as a transaction to write data. IdentityCache avoids loading cached data from its methods during an open transaction, but can't prevent cache data that was loaded before the transaction was opened from being used in a transaction. IdentityCache won't help with scaling write traffic, it was intended for scaling database queries from read-only requests.
+
+IdentityCache also caches the absence of database values (e.g. to avoid performance problems when it is destroyed), so lost cache invalidations can also result in that value continuing to remain absent. As such, avoid sending the id of an uncommitted database record to another process (e.g. queuing it to a background job), since that could result in an attempt to read the record by its id before it has been created. A cache invalidation will still be attempted when the record is created, but that could be lost.
 
 ## Notes
 

data/dev.yml

@@ -5,7 +5,7 @@ up:
     - mysql-client@5.7:
         or:        [mysql@5.7]
         conflicts: [mysql-connector-c, mysql, mysql-client]
-  - ruby: 2.7.2
+  - ruby: 3.2.0
   - isogun
   - bundler
 

data/lib/identity_cache/cache_key_loader.rb

@@ -44,7 +44,7 @@ module IdentityCache
       # @param db_key [Array] Reference to what to load from the database.
       # @return [Hash] A hash mapping each database key to its corresponding value
       def load_multi(cache_fetcher, db_keys)
-        load_batch(cache_fetcher => db_keys).fetch(cache_fetcher)
+        load_batch({ cache_fetcher => db_keys }).fetch(cache_fetcher)
       end
 
       # Load multiple keys for multiple cache fetchers

data/lib/identity_cache/cached/attribute.rb

@@ -35,16 +35,20 @@ module IdentityCache
       end
 
       def expire(record)
+        all_deleted = true
+
         unless record.send(:was_new_record?)
           old_key = old_cache_key(record)
-          IdentityCache.cache.delete(old_key)
+          all_deleted = IdentityCache.cache.delete(old_key)
         end
         unless record.destroyed?
           new_key = new_cache_key(record)
           if new_key != old_key
-            IdentityCache.cache.delete(new_key)
+            all_deleted = IdentityCache.cache.delete(new_key) && all_deleted
           end
         end
+
+        all_deleted
       end
 
       def cache_key(index_key)

data/lib/identity_cache/parent_model_expiration.rb

@@ -45,8 +45,9 @@ module IdentityCache
     def expire_parent_caches
       parents_to_expire = Set.new
       add_parents_to_cache_expiry_set(parents_to_expire)
-      parents_to_expire.each do |parent|
-        parent.expire_primary_index if parent.class.primary_cache_index_enabled
+      parents_to_expire.select! { |parent| parent.class.primary_cache_index_enabled }
+      parents_to_expire.reduce(true) do |all_expired, parent|
+        parent.expire_primary_index && all_expired
       end
     end
 

data/lib/identity_cache/query_api.rb

@@ -70,6 +70,8 @@ module IdentityCache
         readonly: IdentityCache.fetch_read_only_records && should_use_cache?)
         return if records.empty?
 
+        return unless should_use_cache?
+
         records.each(&:readonly!) if readonly
         each_id_embedded_association do |cached_association|
           preload_id_embedded_association(records, cached_association)
@@ -166,15 +168,17 @@ module IdentityCache
     def _run_commit_callbacks
       if destroyed? || transaction_changed_attributes.present?
         expire_cache
-        expire_parent_caches
       end
       super
     end
 
-    # Invalidate the cache data associated with the record.
+    # Invalidate the cache data associated with the record. Returns `true` on success,
+    # `false` otherwise.
     def expire_cache
-      expire_attribute_indexes
-      true
+      expired_parent_caches = expire_parent_caches
+      expired_attribute_indexes = expire_attribute_indexes
+
+      expired_parent_caches && expired_attribute_indexes
     end
 
     # @api private
@@ -185,9 +189,11 @@ module IdentityCache
 
     private
 
+    # Even if we have problems with some attributes, carry over the results and expire
+    # all possible attributes without array allocation.
     def expire_attribute_indexes # :nodoc:
-      cache_indexes.each do |cached_attribute|
-        cached_attribute.expire(self)
+      cache_indexes.reduce(true) do |all_expired, cached_attribute|
+        cached_attribute.expire(self) && all_expired
       end
     end
   end

data/lib/identity_cache/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module IdentityCache
-  VERSION = "1.2.0"
+  VERSION = "1.3.1"
   CACHE_VERSION = 8
 end

data/lib/identity_cache/with_primary_index.rb

@@ -7,8 +7,9 @@ module IdentityCache
     include WithoutPrimaryIndex
 
     def expire_cache
-      expire_primary_index
-      super
+      expired_primary_index = expire_primary_index
+
+      super && expired_primary_index
     end
 
     # @api private
@@ -158,6 +159,15 @@ module IdentityCache
       def expire_primary_key_cache_index(id)
         cached_primary_index.expire(id)
       end
+
+      private
+
+      def inherited(subclass)
+        super
+        subclass.class_eval do
+          @cached_primary_index = nil
+        end
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: identity_cache
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.1
 platform: ruby
 authors:
 - Camilo Lopez
@@ -14,7 +14,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-08-15 00:00:00.000000000 Z
+date: 2023-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -190,7 +190,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.4.9
 signing_key: 
 specification_version: 4
 summary: IdentityCache lets you specify how you want to cache your model objects,