identity_cache 1.6.0 → 1.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0238eadfff3efbdc9ad2e6625ce51fa8bc43cf722f317ab096cf4dcf42b8ab11'
-  data.tar.gz: 8f6c334a2bcc97cceef427cb626dfd5cdd7528982a1062356113217e9268f836
+  metadata.gz: 463112ddb217364a26a8232ef1958c45bdb24fc7dcd891be3e7d4db4ca4d29a4
+  data.tar.gz: 13ea742aca4c33f710a6f8a229f6cf0531dba50291c1ec7c67bce735028ce527
 SHA512:
-  metadata.gz: 30132bc792a1095e821ddd2602cf6a7edead2f52a50f4a6d1fa75ab22321d4459172aa6de95760693ad069895d741b4756fc5b827581eea4d23b6beb813b7c21
-  data.tar.gz: b93b51adc8d89c33eb5e051f98e9f6637bd16e9c0fa4640a4b23bdea241548a428d3ea5dcc582922166d04096479bf1a62e27ba587029d2428e47bc9dacfea1f
+  metadata.gz: d4c3cae9c3c4a6444f62d84242326da8901e0aa66895c8b6d2916930a5824fe402299d5e7c6270982e37fa9cd97991310756320aea0fb93b64a1f515a27f1c1f
+  data.tar.gz: 5512f9b845a4bc9ea8821d6e8563bc4307ba46a32fe32f1f5d2a708b624be3a5ed72c1b64fe2a9ade21f52ffa8d6c3220e23bc3bb433249bceb4d6eacdf7ba67

data/.github/workflows/ci.yml

@@ -19,11 +19,11 @@ jobs:
             ruby: '3.0'
             gemfile: "Gemfile.min-supported"
           - name: 'Latest released & run rubocop'
-            ruby: '3.2'
+            ruby: '3.3'
             gemfile: "Gemfile.latest-release"
             rubocop: true
           - name: 'Rails edge'
-            ruby: '3.2'
+            ruby: '3.3'
             gemfile: "Gemfile.rails-edge"
             edge: true
 
@@ -69,25 +69,26 @@ jobs:
       run: |
         sudo apt-get update
         sudo apt-get -y install libmemcached-dev libmysqlclient-dev libpq-dev libsasl2-dev
+
     - uses: actions/checkout@v2
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.entry.ruby }}
-    - name: Install bundler and gems
-      run: |
-        gem install bundler
-        bundle install --jobs 4 --retry 3
+        bundler-cache: true
+
     - name: Test with mysql
       env:
         DB: mysql2
       run: bundle exec rake test
+
     - name: Test with postgres and memcached_store
       env:
         DB: postgresql
         POSTGRES_PASSWORD: postgres
         ADAPTER: memcached
       run: bundle exec rake test
+
     - name: Run rubocop
       if: matrix.entry.rubocop
       run: bundle exec rubocop

data/.ruby-version

@@ -1 +1 @@
-3.2.2
+3.3.4

data/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 ## 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)
+
 ## 1.6.0
 
 - Introduce `.with_deferred_parent_expiration`, which takes a block and avoids duplicate parent cache expiry. (#569)

data/Gemfile

@@ -9,7 +9,7 @@ gem "rubocop-shopify", "~> 2.9.0", require: false
 
 gem "mysql2", "~> 0.5.3", platform: :mri
 gem "pg", ">= 0.18", "< 2.0", platform: :mri
-gem "memcached", "~> 1.8.0", platform: :mri
+gem "memcached", github: "Shopify/memcached", branch: "1-0-stable-shopify", platform: :mri
 gem "memcached_store", "~> 2.3.2", platform: :mri
 gem "dalli", "~> 3.2.3"
 gem "cityhash", "~> 0.6.0", platform: :mri

data/Gemfile.lock

@@ -1,52 +1,59 @@
+GIT
+  remote: https://github.com/Shopify/memcached.git
+  revision: 54a89bae698896a00fd2ceeb142dada6285f73ed
+  branch: 1-0-stable-shopify
+  specs:
+    memcached (1.9.0)
+
 PATH
   remote: .
   specs:
-    identity_cache (1.6.0)
+    identity_cache (1.6.2)
       activerecord (>= 7.0)
       ar_transaction_changes (~> 1.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (7.1.3.2)
-      activesupport (= 7.1.3.2)
-    activerecord (7.1.3.2)
-      activemodel (= 7.1.3.2)
-      activesupport (= 7.1.3.2)
+    activemodel (7.2.0)
+      activesupport (= 7.2.0)
+    activerecord (7.2.0)
+      activemodel (= 7.2.0)
+      activesupport (= 7.2.0)
       timeout (>= 0.4.0)
-    activesupport (7.1.3.2)
+    activesupport (7.2.0)
       base64
       bigdecimal
-      concurrent-ruby (~> 1.0, >= 1.0.2)
+      concurrent-ruby (~> 1.0, >= 1.3.1)
       connection_pool (>= 2.2.5)
       drb
       i18n (>= 1.6, < 2)
+      logger (>= 1.4.2)
       minitest (>= 5.1)
-      mutex_m
-      tzinfo (~> 2.0)
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0, >= 2.0.5)
     ar_transaction_changes (1.1.9)
       activerecord (>= 5.2.0)
     ast (2.4.2)
     base64 (0.2.0)
-    bigdecimal (3.1.6)
+    bigdecimal (3.1.8)
     byebug (11.1.3)
     cityhash (0.6.0)
-    concurrent-ruby (1.2.3)
+    concurrent-ruby (1.3.4)
     connection_pool (2.4.1)
     dalli (3.2.3)
     drb (2.2.1)
-    i18n (1.14.4)
+    i18n (1.14.5)
       concurrent-ruby (~> 1.0)
     json (2.7.1)
     language_server-protocol (3.17.0.3)
-    memcached (1.8.0)
+    logger (1.6.0)
     memcached_store (2.3.4)
       activesupport (>= 6)
       memcached (~> 1.8)
-    minitest (5.22.2)
+    minitest (5.25.1)
     mocha (2.1.0)
       ruby2_keywords (>= 0.0.5)
-    mutex_m (0.2.0)
     mysql2 (0.5.6)
     parallel (1.24.0)
     parser (3.3.0.5)
@@ -57,8 +64,8 @@ GEM
     rainbow (3.1.1)
     rake (13.1.0)
     regexp_parser (2.9.0)
-    rexml (3.2.8)
-      strscan (>= 3.0.9)
+    rexml (3.3.6)
+      strscan
     rubocop (1.61.0)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
@@ -76,6 +83,7 @@ GEM
       rubocop (~> 1.33)
     ruby-progressbar (1.13.0)
     ruby2_keywords (0.0.5)
+    securerandom (0.3.1)
     spy (1.0.5)
     stackprof (0.2.26)
     strscan (3.1.0)
@@ -94,7 +102,7 @@ DEPENDENCIES
   cityhash (~> 0.6.0)
   dalli (~> 3.2.3)
   identity_cache!
-  memcached (~> 1.8.0)
+  memcached!
   memcached_store (~> 2.3.2)
   minitest (~> 5.14)
   mocha (~> 2.0)

data/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

data/dev.yml

@@ -1,18 +1,14 @@
 name: identity-cache
 
 up:
-  - homebrew:
-    - mysql-client@5.7:
-        or:        [mysql@5.7]
-        conflicts: [mysql-connector-c, mysql, mysql-client]
   - ruby
-  - isogun
   - bundler
-
-env:
-  RAILGUN_HOST: identity-cache.railgun
-  MYSQL_HOST: identity-cache.railgun
-  MEMCACHED_HOST: identity-cache.railgun
+  - 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:
@@ -20,7 +16,7 @@ commands:
       optional:
         argument: file
         optional: args...
-    desc: 'Run tests'
+    desc: "Run tests"
     run: |
       if [[ $# -eq 0 ]]; then
         bundle exec rake test
@@ -29,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

data/gemfiles/Gemfile.latest-release

@@ -8,6 +8,7 @@ gem "activerecord"
 gem "activesupport"
 gem "mysql2", "~> 0.5"
 gem "pg", "~> 1.1"
+gem "memcached", github: "Shopify/memcached", branch: "1-0-stable-shopify"
 gem "memcached_store"
 gem "dalli"
 gem "cityhash"

data/gemfiles/Gemfile.min-supported

@@ -6,7 +6,7 @@ gem "ar_transaction_changes", "~> 1.1.0"
 gem "activerecord", "~> 7.0.0"
 gem "mysql2", "~> 0.5"
 gem "pg", "~> 1.1"
-gem "memcached", "~> 1.8.0"
+gem "memcached", github: "Shopify/memcached", branch: "1-0-stable-shopify"
 gem "memcached_store", "~> 2.3.2"
 gem "dalli", "~> 2.7.11"
 gem "cityhash", "~> 0.6.0"

data/gemfiles/Gemfile.rails-edge

@@ -5,6 +5,7 @@ gem "activerecord", github: "rails/rails", branch: "main"
 gem "activesupport", github: "rails/rails", branch: "main"
 gem "mysql2", "~> 0.5"
 gem "pg", "~> 1.1"
+gem "memcached", github: "Shopify/memcached", branch: "1-0-stable-shopify"
 gem "memcached_store"
 gem "dalli"
 gem "cityhash"

data/lib/identity_cache/cache_fetcher.rb

@@ -60,6 +60,11 @@ module IdentityCache
       @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

data/lib/identity_cache/cached/attribute.rb

@@ -39,12 +39,24 @@ module IdentityCache
 
         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 @@ module IdentityCache
       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)

data/lib/identity_cache/cached/primary_index.rb

@@ -45,7 +45,11 @@ module IdentityCache
 
       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)

data/lib/identity_cache/memoized_cache_proxy.rb

@@ -70,6 +70,16 @@ module IdentityCache
       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

data/lib/identity_cache/parent_model_expiration.rb

@@ -47,10 +47,6 @@ 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.6.0"
+  VERSION = "1.6.2"
   CACHE_VERSION = 8
 end

data/lib/identity_cache.rb

@@ -60,7 +60,7 @@ module IdentityCache
 
   class InverseAssociationError < StandardError; end
 
-  class NestedDeferredParentBlockError < StandardError; end
+  class NestedDeferredCacheExpirationBlockError < StandardError; end
 
   class UnsupportedScopeError < StandardError; end
 
@@ -117,27 +117,36 @@ module IdentityCache
       !readonly
     end
 
-    def should_use_cache? # :nodoc:
-      ActiveRecord::Base.connection_handler.connection_pool_list(ActiveRecord::Base.current_role).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
 
@@ -193,42 +202,51 @@ 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.
+    # 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)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: identity_cache
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.6.2
 platform: ruby
 authors:
 - Camilo Lopez
@@ -14,7 +14,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-05 00:00:00.000000000 Z
+date: 2024-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -127,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
@@ -192,7 +191,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.14
+rubygems_version: 3.5.21
 signing_key:
 specification_version: 4
 summary: IdentityCache lets you specify how you want to cache your model objects,

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