Support deferred expiration of records and attributes for one-to-many associations (#577)

* Support deferred expiration of records and attributes for one-to-many associations

* Merge the two methods into one

* Remove byedebug

* Fix rubocop

* Merge the parent and children into one set

* Remove exist

* Add change log and bump the version

Author: drinkbeer

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+## 1.6.2
+
+- Support deferred expiry of associations and attributes. Add a rake task to create test database.
+
 ## 1.6.1
 
 - Fix deprecation warnings on Active Record 7.2. (#575)

Gemfile.lock

@@ -8,7 +8,7 @@ GIT
 PATH
   remote: .
   specs:
-    identity_cache (1.6.1)
+    identity_cache (1.6.2)
       activerecord (>= 7.0)
       ar_transaction_changes (~> 1.1)
 

Rakefile

@@ -47,3 +47,27 @@ namespace :profile do
     ruby "./performance/profile.rb"
   end
 end
+
+namespace :db do
+  desc "Create the identity_cache_test database"
+  task :create do
+    require "mysql2"
+
+    config = {
+      host: ENV.fetch("MYSQL_HOST") || "localhost",
+      port: ENV.fetch("MYSQL_PORT") || 1037,
+      username: ENV.fetch("MYSQL_USER") || "root",
+      password: ENV.fetch("MYSQL_PASSWORD") || "",
+    }
+
+    begin
+      client = Mysql2::Client.new(config)
+      client.query("CREATE DATABASE IF NOT EXISTS identity_cache_test")
+      puts "Database 'identity_cache_test' created successfully. host: #{config[:host]}, port: #{config[:port]}"
+    rescue Mysql2::Error => e
+      puts "Error creating database: #{e.message}"
+    ensure
+      client&.close
+    end
+  end
+end

dev.yml

@@ -5,14 +5,18 @@ up:
   - bundler
   - memcached
   - mysql
+  - custom:
+      name: create database identity_cache_test
+      met?: mysql -u root -h 127.0.0.1 -P 1037 -e "SHOW DATABASES;" | grep identity_cache_test
+      meet: bundle exec rake db:create
 
 commands:
   test:
     syntax:
       optional:
         argument: file
         optional: args...
-    desc: 'Run tests'
+    desc: "Run tests"
     run: |
       if [[ $# -eq 0 ]]; then
         bundle exec rake test
@@ -21,21 +25,21 @@ commands:
       fi
 
   style:
-    desc: 'Run rubocop checks'
+    desc: "Run rubocop checks"
     run: bundle exec rubocop "$@"
 
   check:
-    desc: 'Run tests and style checks'
+    desc: "Run tests and style checks"
     run: bundle exec rake test && bundle exec rubocop
 
   benchmark-cpu:
-    desc: 'Run the identity cache CPU benchmark'
+    desc: "Run the identity cache CPU benchmark"
     run: bundle exec rake benchmark:cpu
 
   profile:
-    desc: 'Profile IDC code'
+    desc: "Profile IDC code"
     run: bundle exec rake profile:run
 
   update-serialization-format:
-    desc: 'Update serialization format test fixture'
+    desc: "Update serialization format test fixture"
     run: bundle exec rake update_serialization_format

lib/identity_cache.rb

@@ -60,7 +60,7 @@ class AssociationError < StandardError; end
 
   class InverseAssociationError < StandardError; end
 
-  class NestedDeferredParentBlockError < StandardError; end
+  class NestedDeferredCacheExpirationBlockError < StandardError; end
 
   class UnsupportedScopeError < StandardError; end
 
@@ -202,42 +202,51 @@ def fetch_multi(*keys)
       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.
+    # 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:
-    # NestedDeferredParentBlockError if a deferred parent expiration block is already active.
+    # NestedDeferredCacheExpirationBlockError if a deferred cache expiration block is already active.
     #
     # == Yield:
-    # Runs the provided block with deferred parent expiration.
+    # 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 parent expiration regardless
+    # Cleans up thread-local variables related to deferred cache expiration regardless
     # of whether the block raises an exception.
-    def with_deferred_parent_expiration
-      raise NestedDeferredParentBlockError if Thread.current[:idc_deferred_parent_expiration]
+    def with_deferred_expiration
+      raise NestedDeferredCacheExpirationBlockError if Thread.current[:idc_deferred_expiration]
 
-      Thread.current[:idc_deferred_parent_expiration] = true
-      Thread.current[:idc_parent_records_for_cache_expiry] = Set.new
+      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_parent_expiration] = nil
-      Thread.current[:idc_parent_records_for_cache_expiry].each(&:expire_primary_index)
-
+      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_parent_expiration] = nil
-      Thread.current[:idc_parent_records_for_cache_expiry].clear
+      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)

lib/identity_cache/cache_fetcher.rb

@@ -60,6 +60,11 @@ def delete(key)
       @cache_backend.write(key, IdentityCache::DELETED, expires_in: IdentityCache::DELETED_TTL.seconds)
     end
 
+    def delete_multi(keys)
+      key_values = keys.map { |key| [key, IdentityCache::DELETED] }.to_h
+      @cache_backend.write_multi(key_values, expires_in: IdentityCache::DELETED_TTL.seconds)
+    end
+
     def clear
       @cache_backend.clear
     end

lib/identity_cache/cached/attribute.rb

@@ -39,12 +39,24 @@ def expire(record)
 
         unless record.send(:was_new_record?)
           old_key = old_cache_key(record)
-          all_deleted = IdentityCache.cache.delete(old_key)
+
+          if Thread.current[:idc_deferred_expiration]
+            Thread.current[:idc_attributes_to_expire] << old_key
+            # defer the deletion, and don't block the following deletion
+            all_deleted = true
+          else
+            all_deleted = IdentityCache.cache.delete(old_key)
+          end
         end
         unless record.destroyed?
           new_key = new_cache_key(record)
           if new_key != old_key
-            all_deleted = IdentityCache.cache.delete(new_key) && all_deleted
+            if Thread.current[:idc_deferred_expiration]
+              Thread.current[:idc_attributes_to_expire] << new_key
+              all_deleted = true
+            else
+              all_deleted = IdentityCache.cache.delete(new_key) && all_deleted
+            end
           end
         end
 
@@ -152,9 +164,9 @@ def new_cache_key(record)
       end
 
       def old_cache_key(record)
+        changes = record.transaction_changed_attributes
         old_key_values = key_fields.map do |field|
           field_string = field.to_s
-          changes = record.transaction_changed_attributes
           if record.destroyed? && changes.key?(field_string)
             changes[field_string]
           elsif record.persisted? && changes.key?(field_string)

lib/identity_cache/cached/primary_index.rb

@@ -45,7 +45,11 @@ def fetch_multi(ids)
 
       def expire(id)
         id = cast_id(id)
-        IdentityCache.cache.delete(cache_key(id))
+        if Thread.current[:idc_deferred_expiration]
+          Thread.current[:idc_records_to_expire] << cache_key(id)
+        else
+          IdentityCache.cache.delete(cache_key(id))
+        end
       end
 
       def cache_key(id)

lib/identity_cache/memoized_cache_proxy.rb

@@ -70,6 +70,16 @@ def delete(key)
       end
     end
 
+    def delete_multi(keys)
+      memoizing = memoizing?
+      ActiveSupport::Notifications.instrument("cache_delete_multi.identity_cache", memoizing: memoizing) do
+        if memoizing
+          keys.each { |key| memoized_key_values.delete(key) }
+        end
+        @cache_fetcher.delete_multi(keys)
+      end
+    end
+
     def fetch(key, cache_fetcher_options = {}, &block)
       memo_misses = 0
       cache_misses = 0

lib/identity_cache/parent_model_expiration.rb

@@ -47,10 +47,6 @@ def expire_parent_caches
       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

lib/identity_cache/version.rb

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

test/index_cache_test.rb

@@ -166,48 +166,47 @@ def test_unique_cache_index_with_non_id_primary_key
     assert_equal(123, KeyedRecord.fetch_by_value("a").id)
   end
 
-  def test_with_deferred_parent_expiration_expires_parent_index_once
+  def test_with_deferred_expiration_for_parent_records_expires_parent_index_once
     Item.send(:cache_has_many, :associated_records, embed: true)
 
     @parent = Item.create!(title: "bob")
     @records = @parent.associated_records.create!([{ name: "foo" }, { name: "bar" }, { name: "baz" }])
 
-    @memcached_spy = Spy.on(backend, :write).and_call_through
-
+    @memcached_spy_write_multi = Spy.on(backend, :write_multi).and_call_through
     expected_item_expiration_count = Array(@parent).count
     expected_associated_record_expiration_count = @records.count
 
     expected_return_value = "Some text that we expect to see returned from the block"
 
-    result = IdentityCache.with_deferred_parent_expiration do
+    result = IdentityCache.with_deferred_expiration do
       @parent.transaction do
         @parent.associated_records.destroy_all
       end
-      assert_equal(expected_associated_record_expiration_count, @memcached_spy.calls.count)
       expected_return_value
     end
 
-    expired_cache_keys = @memcached_spy.calls.map(&:args).map(&:first)
-    item_expiration_count = expired_cache_keys.count { _1.include?("Item") }
-    associated_record_expiration_count = expired_cache_keys.count { _1.include?("AssociatedRecord") }
+    all_keys = @memcached_spy_write_multi.calls.flat_map { |call| call.args.first.keys }
+    item_expiration_count = all_keys.count { _1.include?(":blob:Item:") }
+    associated_record_expiration_count = all_keys.count { _1.include?(":blob:AssociatedRecord:") }
 
-    assert_operator(@memcached_spy.calls.count, :>, 0)
+    assert_equal(1, @memcached_spy_write_multi.calls.count)
     assert_equal(expected_item_expiration_count, item_expiration_count)
     assert_equal(expected_associated_record_expiration_count, associated_record_expiration_count)
     assert_equal(expected_return_value, result)
   end
 
-  def test_double_nested_deferred_parent_expiration_will_raise_error
+  def test_double_nested_deferred_expiration_for_parent_records_will_raise_error
     Item.send(:cache_has_many, :associated_records, embed: true)
 
     @parent = Item.create!(title: "bob")
     @records = @parent.associated_records.create!([{ name: "foo" }, { name: "bar" }, { name: "baz" }])
 
     @memcached_spy = Spy.on(backend, :write).and_call_through
+    @memcached_spy_write_multi = Spy.on(backend, :write_multi).and_call_through
 
-    assert_raises(IdentityCache::NestedDeferredParentBlockError) do
-      IdentityCache.with_deferred_parent_expiration do
-        IdentityCache.with_deferred_parent_expiration do
+    assert_raises(IdentityCache::NestedDeferredCacheExpirationBlockError) do
+      IdentityCache.with_deferred_expiration do
+        IdentityCache.with_deferred_expiration do
           @parent.transaction do
             @parent.associated_records.destroy_all
           end
@@ -216,9 +215,10 @@ def test_double_nested_deferred_parent_expiration_will_raise_error
     end
 
     assert_equal(0, @memcached_spy.calls.count)
+    assert_equal(0, @memcached_spy_write_multi.calls.count)
   end
 
-  def test_deep_association_with_deferred_parent_expiration_expires_parent_once
+  def test_deep_association_with_deferred_expiration_expires_parent_once
     AssociatedRecord.send(:has_many, :deeply_associated_records, dependent: :destroy)
     Item.send(:cache_has_many, :associated_records, embed: true)
 
@@ -232,27 +232,27 @@ def test_deep_association_with_deferred_parent_expiration_expires_parent_once
       ])
     end
 
-    @memcached_spy = Spy.on(backend, :write).and_call_through
+    @memcached_spy_write_multi = Spy.on(backend, :write_multi).and_call_through
 
     expected_item_expiration_count = Array(@parent).count
     expected_associated_record_expiration_count = @records.count
     expected_deeply_associated_record_expiration_count = @records.flat_map(&:deeply_associated_records).count
 
-    IdentityCache.with_deferred_parent_expiration do
+    IdentityCache.with_deferred_expiration do
       @parent.transaction do
         @parent.associated_records.destroy_all
       end
     end
 
-    expired_cache_keys = @memcached_spy.calls.map(&:args).map(&:first)
-    item_expiration_count = expired_cache_keys.count { _1.include?("Item") }
-    associated_record_expiration_count = expired_cache_keys.count { _1.include?(":AssociatedRecord:") }
-    deeply_associated_record_expiration_count = expired_cache_keys.count { _1.include?("DeeplyAssociatedRecord") }
+    all_keys = @memcached_spy_write_multi.calls.flat_map { |call| call.args.first.keys }
+    item_expiration_count = all_keys.count { |key| key.include?(":blob:Item:") }
+    associated_record_keys = all_keys.count { |key| key.include?(":blob:AssociatedRecord:") }
+    deeply_associated_record_keys = all_keys.count { |key| key.include?(":blob:DeeplyAssociatedRecord:") }
 
-    assert_operator(@memcached_spy.calls.count, :>, 0)
+    assert_equal(1, @memcached_spy_write_multi.calls.count)
     assert_equal(expected_item_expiration_count, item_expiration_count)
-    assert_equal(expected_associated_record_expiration_count, associated_record_expiration_count)
-    assert_equal(expected_deeply_associated_record_expiration_count, deeply_associated_record_expiration_count)
+    assert_equal(expected_associated_record_expiration_count, associated_record_keys)
+    assert_equal(expected_deeply_associated_record_expiration_count, deeply_associated_record_keys)
   end
 
   private