identity_cache 1.2.0 → 1.6.3

data/lib/identity_cache.rb

@@ -60,6 +60,10 @@ module IdentityCache
 
   class InverseAssociationError < StandardError; end
 
+  class NestedDeferredParentBlockError < StandardError; end
+
+  class NestedDeferredCacheExpirationBlockError < StandardError; end
+
   class UnsupportedScopeError < StandardError; end
 
   class UnsupportedAssociationError < StandardError; end
@@ -115,27 +119,36 @@ module IdentityCache
       !readonly
     end
 
-    def should_use_cache? # :nodoc:
-      ActiveRecord::Base.connection_handler.connection_pool_list.none? do |pool|
-        pool.active_connection? &&
-          # Rails wraps each of your tests in a transaction, so that any changes
-          # made to the database during the test can be rolled back afterwards.
-          # These transactions are flagged as "unjoinable", which tries to make
-          # your application behave as if they weren't there. In particular:
-          #
-          #  - Opening another transaction during the test creates a savepoint,
-          #    which can be rolled back independently of the main transaction.
-          #  - When those nested transactions complete, any `after_commit`
-          #    callbacks for records modified during the transaction will run,
-          #    even though the changes haven't actually been committed yet.
-          #
-          # By ignoring unjoinable transactions, IdentityCache's behaviour
-          # during your test suite will more closely match production.
-          #
-          # When there are no open transactions, `current_transaction` returns a
-          # special `NullTransaction` object that is unjoinable, meaning we will
-          # use the cache.
-          pool.connection.current_transaction.joinable?
+    # Rails wraps each of your tests in a transaction, so that any changes
+    # made to the database during the test can be rolled back afterwards.
+    # These transactions are flagged as "unjoinable", which tries to make
+    # your application behave as if they weren't there. In particular:
+    #
+    #  - Opening another transaction during the test creates a savepoint,
+    #    which can be rolled back independently of the main transaction.
+    #  - When those nested transactions complete, any `after_commit`
+    #    callbacks for records modified during the transaction will run,
+    #    even though the changes haven't actually been committed yet.
+    #
+    # By ignoring unjoinable transactions, IdentityCache's behaviour
+    # during your test suite will more closely match production.
+    #
+    # When there are no open transactions, `current_transaction` returns a
+    # special `NullTransaction` object that is unjoinable, meaning we will
+    # use the cache.
+    if ActiveRecord::ConnectionAdapters::ConnectionPool.method_defined?(:active_connection)
+      def should_use_cache? # :nodoc:
+        ActiveRecord::Base.connection_handler.connection_pool_list(ActiveRecord::Base.current_role).none? do |pool|
+          pool.active_connection? &&
+            pool.active_connection.current_transaction.joinable?
+        end
+      end
+    else
+      def should_use_cache? # :nodoc:
+        ActiveRecord::Base.connection_handler.connection_pool_list(ActiveRecord::Base.current_role).none? do |pool|
+          pool.active_connection? &&
+            pool.connection.current_transaction.joinable?
+        end
       end
     end
 
@@ -191,6 +204,99 @@ 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]
+
+      if Thread.current[:idc_deferred_expiration]
+        deprecator.deprecation_warning("`with_deferred_parent_expiration`")
+      end
+
+      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
+
+    # Executes a block with deferred cache expiration, ensuring that the records' (parent,
+    # children and attributes) cache expiration is deferred until the block completes. When
+    # the block completes, it issues delete_multi calls for all the records and attributes
+    # that were marked for expiration.
+    #
+    # == Parameters:
+    # No parameters.
+    #
+    # == Raises:
+    # NestedDeferredCacheExpirationBlockError if a deferred cache expiration block is already active.
+    #
+    # == Yield:
+    # Runs the provided block with deferred cache expiration.
+    #
+    # == Returns:
+    # The result of executing the provided block.
+    #
+    # == Ensures:
+    # Cleans up thread-local variables related to deferred cache expiration regardless
+    # of whether the block raises an exception.
+    def with_deferred_expiration
+      raise NestedDeferredCacheExpirationBlockError if Thread.current[:idc_deferred_expiration]
+
+      if Thread.current[:idc_deferred_parent_expiration]
+        deprecator.deprecation_warning("`with_deferred_parent_expiration`")
+      end
+
+      Thread.current[:idc_deferred_expiration] = true
+      Thread.current[:idc_records_to_expire] = Set.new
+      Thread.current[:idc_attributes_to_expire] = Set.new
+
+      result = yield
+
+      Thread.current[:idc_deferred_expiration] = nil
+      if Thread.current[:idc_records_to_expire].any?
+        IdentityCache.cache.delete_multi(
+          Thread.current[:idc_records_to_expire]
+        )
+      end
+      if Thread.current[:idc_attributes_to_expire].any?
+        IdentityCache.cache.delete_multi(
+          Thread.current[:idc_attributes_to_expire]
+        )
+      end
+      result
+    ensure
+      Thread.current[:idc_deferred_expiration] = nil
+      Thread.current[:idc_records_to_expire].clear
+      Thread.current[:idc_attributes_to_expire].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
@@ -210,6 +316,10 @@ module IdentityCache
       ParentModelExpiration.install_all_pending_parent_expiry_hooks
     end
 
+    def deprecator
+      @deprecator ||= ActiveSupport::Deprecation.new("1.7.0", "IdentityCache")
+    end
+
     private
 
     def fetch_in_batches(keys, &block)

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.2.0
+  version: 1.6.3
 platform: ruby
 authors:
 - Camilo Lopez
@@ -11,10 +11,10 @@ authors:
 - Tobias Lutke
 - Arthur Neves
 - Francis Bogsanyi
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-15 00:00:00.000000000 Z
+date: 2024-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -22,14 +22,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: ar_transaction_changes
   requirement: !ruby/object:Gem::Requirement
@@ -64,14 +64,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -111,12 +111,14 @@ files:
 - ".github/workflows/cla.yml"
 - ".gitignore"
 - ".rubocop.yml"
+- ".ruby-version"
 - ".spin/bootstrap"
 - ".spin/svc.yml"
 - CAVEATS.md
 - CHANGELOG.md
 - CONTRIBUTING.md
 - Gemfile
+- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
@@ -125,7 +127,6 @@ files:
 - gemfiles/Gemfile.min-supported
 - gemfiles/Gemfile.rails-edge
 - identity_cache.gemspec
-- isogun.yml
 - lib/identity_cache.rb
 - lib/identity_cache/belongs_to_caching.rb
 - lib/identity_cache/cache_fetcher.rb
@@ -175,7 +176,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
@@ -183,15 +184,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
-signing_key: 
+rubygems_version: 3.5.22
+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

data/isogun.yml

@@ -1,11 +0,0 @@
-# https://dev-accel.shopify.io/dev/railgun/Railgun-Config
-name: identity-cache
-
-vm:
-  ip_address: 192.168.64.98
-  memory:     1G
-  cores:      2
-
-services:
-  - mysql
-  - memcached