identity_cache 1.6.2 → 1.6.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 463112ddb217364a26a8232ef1958c45bdb24fc7dcd891be3e7d4db4ca4d29a4
-  data.tar.gz: 13ea742aca4c33f710a6f8a229f6cf0531dba50291c1ec7c67bce735028ce527
+  metadata.gz: c1c4e1e77b3c4a778ba9a9b20540aa092a747ab19534cf6b49566bf74f02e5b7
+  data.tar.gz: 906ac8772c48e590b2dbacb2507319f04a97af51309fa01822461715ec503212
 SHA512:
-  metadata.gz: d4c3cae9c3c4a6444f62d84242326da8901e0aa66895c8b6d2916930a5824fe402299d5e7c6270982e37fa9cd97991310756320aea0fb93b64a1f515a27f1c1f
-  data.tar.gz: 5512f9b845a4bc9ea8821d6e8563bc4307ba46a32fe32f1f5d2a708b624be3a5ed72c1b64fe2a9ade21f52ffa8d6c3220e23bc3bb433249bceb4d6eacdf7ba67
+  metadata.gz: 1a86b5918fbfa174f8d2d01626de61b7b3cfdef06690f0e4c0440be0e5615a74fd84cab6d7e6c7982dcbdc8811e76db3b7f6344f8e2a15dfad3ade11e2cf7e40
+  data.tar.gz: 31910c9568c5ead4d8157092933e31d76544e12dfdec5f74c6ac6f24ff9ca41d8bd1587e31e1fee63c0044fadb8ebac104e8854c4d36ceef5dc40b975c4e0f76

data/.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: github-actions
+    directory: "/"
+    schedule:
+      interval: weekly

data/.github/workflows/ci.yml

@@ -19,11 +19,11 @@ jobs:
             ruby: '3.0'
             gemfile: "Gemfile.min-supported"
           - name: 'Latest released & run rubocop'
-            ruby: '3.3'
+            ruby: '3.4'
             gemfile: "Gemfile.latest-release"
             rubocop: true
           - name: 'Rails edge'
-            ruby: '3.3'
+            ruby: '3.4'
             gemfile: "Gemfile.rails-edge"
             edge: true
 
@@ -70,9 +70,9 @@ jobs:
         sudo apt-get update
         sudo apt-get -y install libmemcached-dev libmysqlclient-dev libpq-dev libsasl2-dev
 
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
     - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@4ff6f3611a42bc75eee1e5138240eb1613f48c8f # v1.266.0
       with:
         ruby-version: ${{ matrix.entry.ruby }}
         bundler-cache: true

data/.gitignore

@@ -16,3 +16,4 @@ test/version_tmp
 tmp
 .rubocop-http*
 .byebug_history
+gemfiles/*.lock

data/CHANGELOG.md

@@ -2,9 +2,17 @@
 
 ## Unreleased
 
+## 1.6.4
+
+- Patch `run_callbacks` instead of `_run_commit_callbacks` to expire cache prior to `after_commit` callbacks. (#602)
+
+## 1.6.3
+
+- Split the `with_deferred_parent_expiration` and `with_deferred_parent_expiration`. (#578)
+
 ## 1.6.2
 
-- Support deferred expiry of associations and attributes. Add a rake task to create test database.
+- Support deferred expiry of associations and attributes. Add a rake task to create test database. (#577)
 
 ## 1.6.1
 

data/Gemfile.lock

@@ -1,6 +1,6 @@
 GIT
   remote: https://github.com/Shopify/memcached.git
-  revision: 54a89bae698896a00fd2ceeb142dada6285f73ed
+  revision: 30f5735d5db2dfd50dd885ceeb51672320b356d3
   branch: 1-0-stable-shopify
   specs:
     memcached (1.9.0)
@@ -8,21 +8,22 @@ GIT
 PATH
   remote: .
   specs:
-    identity_cache (1.6.2)
+    identity_cache (1.6.4)
       activerecord (>= 7.0)
       ar_transaction_changes (~> 1.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (7.2.0)
-      activesupport (= 7.2.0)
-    activerecord (7.2.0)
-      activemodel (= 7.2.0)
-      activesupport (= 7.2.0)
+    activemodel (8.0.2)
+      activesupport (= 8.0.2)
+    activerecord (8.0.2)
+      activemodel (= 8.0.2)
+      activesupport (= 8.0.2)
       timeout (>= 0.4.0)
-    activesupport (7.2.0)
+    activesupport (8.0.2)
       base64
+      benchmark (>= 0.3)
       bigdecimal
       concurrent-ruby (~> 1.0, >= 1.3.1)
       connection_pool (>= 2.2.5)
@@ -32,40 +33,42 @@ GEM
       minitest (>= 5.1)
       securerandom (>= 0.3)
       tzinfo (~> 2.0, >= 2.0.5)
+      uri (>= 0.13.1)
     ar_transaction_changes (1.1.9)
       activerecord (>= 5.2.0)
-    ast (2.4.2)
-    base64 (0.2.0)
-    bigdecimal (3.1.8)
-    byebug (11.1.3)
+    ast (2.4.3)
+    base64 (0.3.0)
+    benchmark (0.4.1)
+    bigdecimal (3.2.2)
+    byebug (12.0.0)
     cityhash (0.6.0)
-    concurrent-ruby (1.3.4)
-    connection_pool (2.4.1)
-    dalli (3.2.3)
-    drb (2.2.1)
-    i18n (1.14.5)
+    concurrent-ruby (1.3.5)
+    connection_pool (2.5.3)
+    dalli (3.2.8)
+    drb (2.2.3)
+    i18n (1.14.7)
       concurrent-ruby (~> 1.0)
-    json (2.7.1)
-    language_server-protocol (3.17.0.3)
-    logger (1.6.0)
+    json (2.13.1)
+    language_server-protocol (3.17.0.5)
+    logger (1.7.0)
     memcached_store (2.3.4)
       activesupport (>= 6)
       memcached (~> 1.8)
-    minitest (5.25.1)
-    mocha (2.1.0)
+    minitest (5.25.5)
+    mocha (2.7.1)
       ruby2_keywords (>= 0.0.5)
     mysql2 (0.5.6)
-    parallel (1.24.0)
-    parser (3.3.0.5)
+    parallel (1.27.0)
+    parser (3.3.9.0)
       ast (~> 2.4.1)
       racc
-    pg (1.5.6)
-    racc (1.7.3)
+    pg (1.5.9)
+    prism (1.4.0)
+    racc (1.8.1)
     rainbow (3.1.1)
-    rake (13.1.0)
-    regexp_parser (2.9.0)
-    rexml (3.3.6)
-      strscan
+    rake (13.3.0)
+    regexp_parser (2.10.0)
+    rexml (3.4.2)
     rubocop (1.61.0)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
@@ -77,20 +80,21 @@ GEM
       rubocop-ast (>= 1.30.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.31.2)
-      parser (>= 3.3.0.4)
+    rubocop-ast (1.46.0)
+      parser (>= 3.3.7.2)
+      prism (~> 1.4)
     rubocop-shopify (2.9.0)
       rubocop (~> 1.33)
     ruby-progressbar (1.13.0)
     ruby2_keywords (0.0.5)
-    securerandom (0.3.1)
+    securerandom (0.4.1)
     spy (1.0.5)
-    stackprof (0.2.26)
-    strscan (3.1.0)
-    timeout (0.4.1)
+    stackprof (0.2.27)
+    timeout (0.4.3)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.5.0)
+    unicode-display_width (2.6.0)
+    uri (1.0.3)
 
 PLATFORMS
   arm64-darwin-22

data/Rakefile

@@ -9,14 +9,82 @@ require "rdoc/task"
 desc("Default: run tests and style checks.")
 task(default: [:test, :rubocop])
 
-desc("Test the identity_cache plugin.")
-Rake::TestTask.new(:test) do |t|
-  t.libs << "lib"
-  t.libs << "test"
-  t.pattern = "test/**/*_test.rb"
-  t.verbose = true
+namespace :test do
+  desc "Test the identity_cache plugin with default Gemfile"
+  Rake::TestTask.new(:default) do |t|
+    t.libs << "lib"
+    t.libs << "test"
+    t.pattern = "test/**/*_test.rb"
+    t.verbose = true
+  end
+
+  desc "Test the identity_cache plugin with minimum supported dependencies"
+  task :min_supported do
+    gemfile = File.expand_path("gemfiles/Gemfile.min-supported", __dir__)
+    ENV["BUNDLE_GEMFILE"] = gemfile
+
+    puts "\nInstalling dependencies for #{gemfile}..."
+    Bundler.with_unbundled_env do
+      system("bundle install --gemfile #{gemfile}") || abort("Bundle install failed")
+    end
+
+    puts "Running tests with #{gemfile}..."
+    Rake::TestTask.new(:run_min_supported) do |t|
+      t.libs << "lib"
+      t.libs << "test"
+      t.pattern = "test/**/*_test.rb"
+      t.verbose = true
+    end
+    Rake::Task["run_min_supported"].invoke
+  end
+
+  desc "Test the identity_cache plugin with latest released dependencies"
+  task :latest_release do
+    gemfile = File.expand_path("gemfiles/Gemfile.latest-release", __dir__)
+    ENV["BUNDLE_GEMFILE"] = gemfile
+
+    puts "\nInstalling dependencies for #{gemfile}..."
+    Bundler.with_unbundled_env do
+      system("bundle install --gemfile #{gemfile}") || abort("Bundle install failed")
+    end
+
+    puts "Running tests with #{gemfile}..."
+    Rake::TestTask.new(:run_latest_release) do |t|
+      t.libs << "lib"
+      t.libs << "test"
+      t.pattern = "test/**/*_test.rb"
+      t.verbose = true
+    end
+    Rake::Task["run_latest_release"].invoke
+  end
+
+  desc "Test the identity_cache plugin with rails edge dependencies"
+  task :rails_edge do
+    gemfile = File.expand_path("gemfiles/Gemfile.rails-edge", __dir__)
+    ENV["BUNDLE_GEMFILE"] = gemfile
+
+    puts "\nInstalling dependencies for #{gemfile}..."
+    Bundler.with_unbundled_env do
+      system("bundle install --gemfile #{gemfile}") || abort("Bundle install failed")
+    end
+
+    puts "Running tests with #{gemfile}..."
+    Rake::TestTask.new(:run_rails_edge) do |t|
+      t.libs << "lib"
+      t.libs << "test"
+      t.pattern = "test/**/*_test.rb"
+      t.verbose = true
+    end
+    Rake::Task["run_rails_edge"].invoke
+  end
 end
 
+desc "Run default tests"
+task test: ["test:default"]
+
+desc "Run all tests (default, min_supported, latest_release, rails_edge)"
+task test_all: ["test:default", "test:min_supported", "test:latest_release", "test:rails_edge"]
+
 task :rubocop do
   require "rubocop/rake_task"
   RuboCop::RakeTask.new

data/dev.yml

@@ -24,6 +24,10 @@ commands:
         bundle exec ruby -I test "$@"
       fi
 
+  test-all:
+    desc: "Run tests for all gemfiles (default, min_supported, latest_release, rails_edge)"
+    run: bundle exec rake test_all
+
   style:
     desc: "Run rubocop checks"
     run: bundle exec rubocop "$@"

data/identity_cache.gemspec

@@ -26,7 +26,6 @@ Gem::Specification.new do |gem|
   gem.files         = Dir.chdir(File.expand_path(__dir__)) do
     %x(git ls-files -z).split("\x0").reject { |f| f.match(%r{^test/}) }
   end
-  gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
   gem.name          = "identity_cache"
   gem.require_paths = ["lib"]
   gem.version       = IdentityCache::VERSION

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/query_api.rb

@@ -165,11 +165,20 @@ module IdentityCache
     # cache reads that happen from the ordering of callbacks. For example, if an after_commit
     # callback enqueues a background job, then we don't want it to be possible for the
     # background job to run and load data from the cache before it is invalidated.
-    def _run_commit_callbacks
-      if destroyed? || transaction_changed_attributes.present?
-        expire_cache
+    if ActiveRecord.version >= Gem::Version.new("7.1")
+      def run_callbacks(kind, type = nil)
+        if kind == :commit && (destroyed? || transaction_changed_attributes.present?)
+          expire_cache
+        end
+        super
+      end
+    else
+      def run_callbacks(kind)
+        if kind == :commit && (destroyed? || transaction_changed_attributes.present?)
+          expire_cache
+        end
+        super
       end
-      super
     end
 
     # Invalidate the cache data associated with the record. Returns `true` on success,

data/lib/identity_cache/version.rb

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

data/lib/identity_cache.rb

@@ -60,6 +60,8 @@ module IdentityCache
 
   class InverseAssociationError < StandardError; end
 
+  class NestedDeferredParentBlockError < StandardError; end
+
   class NestedDeferredCacheExpirationBlockError < StandardError; end
 
   class UnsupportedScopeError < StandardError; end
@@ -202,6 +204,48 @@ 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
@@ -225,6 +269,10 @@ module IdentityCache
     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
@@ -268,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)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: identity_cache
 version: !ruby/object:Gem::Version
-  version: 1.6.2
+  version: 1.6.4
 platform: ruby
 authors:
 - Camilo Lopez
@@ -11,10 +11,9 @@ authors:
 - Tobias Lutke
 - Arthur Neves
 - Francis Bogsanyi
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-10 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -107,6 +106,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
 - ".github/workflows/ci.yml"
 - ".github/workflows/cla.yml"
 - ".gitignore"
@@ -176,7 +176,6 @@ homepage: https://github.com/Shopify/identity_cache
 licenses: []
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -191,8 +190,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.21
-signing_key:
+rubygems_version: 3.7.2
 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