identity_cache 1.5.6 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ffba8f1b3669ad74b16896e59c3b4f669d5802f96ce2fad7ead33ac06b16880c
-  data.tar.gz: 74edc98197bd0671dd39ac6446553b23998c1c3a67a122ba916e2542ea7bfcdb
+  metadata.gz: '0238eadfff3efbdc9ad2e6625ce51fa8bc43cf722f317ab096cf4dcf42b8ab11'
+  data.tar.gz: 8f6c334a2bcc97cceef427cb626dfd5cdd7528982a1062356113217e9268f836
 SHA512:
-  metadata.gz: c09f6b0e32127203cde69cff41bae906577781d43222115fe34b8632a886d4bec78f7878928e20128f63cd3c39445a8b447ef7ee224a47e8f9b65982e01be339
-  data.tar.gz: 7a4bb522ed8674102bcbaf35cb853f2f2816f501e0349c52154214519559f03a5dc876c1ba318296f17c9dece94153e37157cac9afbeaecebb6bbf7a1a4eecbc
+  metadata.gz: 30132bc792a1095e821ddd2602cf6a7edead2f52a50f4a6d1fa75ab22321d4459172aa6de95760693ad069895d741b4756fc5b827581eea4d23b6beb813b7c21
+  data.tar.gz: b93b51adc8d89c33eb5e051f98e9f6637bd16e9c0fa4640a4b23bdea241548a428d3ea5dcc582922166d04096479bf1a62e27ba587029d2428e47bc9dacfea1f

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+## 1.6.0
+
+- Introduce `.with_deferred_parent_expiration`, which takes a block and avoids duplicate parent cache expiry. (#569)
+
 ## 1.5.6
 
 - Minor performance improvements on association read

data/Gemfile

@@ -11,7 +11,7 @@ gem "mysql2", "~> 0.5.3", platform: :mri
 gem "pg", ">= 0.18", "< 2.0", platform: :mri
 gem "memcached", "~> 1.8.0", platform: :mri
 gem "memcached_store", "~> 2.3.2", platform: :mri
-gem "dalli", "~> 2.7.11"
+gem "dalli", "~> 3.2.3"
 gem "cityhash", "~> 0.6.0", platform: :mri
 
 gem "byebug", platform: :mri

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    identity_cache (1.5.6)
+    identity_cache (1.6.0)
       activerecord (>= 7.0)
       ar_transaction_changes (~> 1.1)
 
@@ -33,7 +33,7 @@ GEM
     cityhash (0.6.0)
     concurrent-ruby (1.2.3)
     connection_pool (2.4.1)
-    dalli (2.7.11)
+    dalli (3.2.3)
     drb (2.2.1)
     i18n (1.14.4)
       concurrent-ruby (~> 1.0)
@@ -57,7 +57,8 @@ GEM
     rainbow (3.1.1)
     rake (13.1.0)
     regexp_parser (2.9.0)
-    rexml (3.2.6)
+    rexml (3.2.8)
+      strscan (>= 3.0.9)
     rubocop (1.61.0)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
@@ -77,6 +78,7 @@ GEM
     ruby2_keywords (0.0.5)
     spy (1.0.5)
     stackprof (0.2.26)
+    strscan (3.1.0)
     timeout (0.4.1)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
@@ -84,12 +86,13 @@ GEM
 
 PLATFORMS
   arm64-darwin-22
+  arm64-darwin-23
   x86_64-linux
 
 DEPENDENCIES
   byebug
   cityhash (~> 0.6.0)
-  dalli (~> 2.7.11)
+  dalli (~> 3.2.3)
   identity_cache!
   memcached (~> 1.8.0)
   memcached_store (~> 2.3.2)

data/lib/identity_cache/parent_model_expiration.rb

@@ -47,6 +47,10 @@ module IdentityCache
       add_parents_to_cache_expiry_set(parents_to_expire)
       parents_to_expire.select! { |parent| parent.class.primary_cache_index_enabled }
       parents_to_expire.reduce(true) do |all_expired, parent|
+        if Thread.current[:idc_deferred_parent_expiration]
+          Thread.current[:idc_parent_records_for_cache_expiry] << parent
+          next parent
+        end
         parent.expire_primary_index && all_expired
       end
     end

data/lib/identity_cache/version.rb

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

data/lib/identity_cache.rb

@@ -60,6 +60,8 @@ module IdentityCache
 
   class InverseAssociationError < StandardError; end
 
+  class NestedDeferredParentBlockError < StandardError; end
+
   class UnsupportedScopeError < StandardError; end
 
   class UnsupportedAssociationError < StandardError; end
@@ -191,6 +193,44 @@ module IdentityCache
       result
     end
 
+    # Executes a block with deferred parent expiration, ensuring that the parent
+    # records' cache expiration is deferred until the block completes. When the block
+    # completes, it triggers expiration of the primary index for the parent records.
+    # Raises a NestedDeferredParentBlockError if a deferred parent expiration block
+    # is already active on the current thread.
+    #
+    # == Parameters:
+    # No parameters.
+    #
+    # == Raises:
+    # NestedDeferredParentBlockError if a deferred parent expiration block is already active.
+    #
+    # == Yield:
+    # Runs the provided block with deferred parent expiration.
+    #
+    # == Returns:
+    # The result of executing the provided block.
+    #
+    # == Ensures:
+    # Cleans up thread-local variables related to deferred parent expiration regardless
+    # of whether the block raises an exception.
+    def with_deferred_parent_expiration
+      raise NestedDeferredParentBlockError if Thread.current[:idc_deferred_parent_expiration]
+
+      Thread.current[:idc_deferred_parent_expiration] = true
+      Thread.current[:idc_parent_records_for_cache_expiry] = Set.new
+
+      result = yield
+
+      Thread.current[:idc_deferred_parent_expiration] = nil
+      Thread.current[:idc_parent_records_for_cache_expiry].each(&:expire_primary_index)
+
+      result
+    ensure
+      Thread.current[:idc_deferred_parent_expiration] = nil
+      Thread.current[:idc_parent_records_for_cache_expiry].clear
+    end
+
     def with_fetch_read_only_records(value = true)
       old_value = Thread.current[:identity_cache_fetch_read_only_records]
       Thread.current[:identity_cache_fetch_read_only_records] = value

data/shipit.rubygems.yml

@@ -1 +1,4 @@
-# using the default shipit config
+dependencies:
+  bundler:
+    without:
+      - default

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: identity_cache
 version: !ruby/object:Gem::Version
-  version: 1.5.6
+  version: 1.6.0
 platform: ruby
 authors:
 - Camilo Lopez
@@ -11,10 +11,10 @@ authors:
 - Tobias Lutke
 - Arthur Neves
 - Francis Bogsanyi
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-19 00:00:00.000000000 Z
+date: 2024-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -177,7 +177,7 @@ homepage: https://github.com/Shopify/identity_cache
 licenses: []
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -192,8 +192,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.6
-signing_key: 
+rubygems_version: 3.5.14
+signing_key:
 specification_version: 4
 summary: IdentityCache lets you specify how you want to cache your model objects,
   at the model level, and adds a number of convenience methods for accessing those