identity_cache 1.5.6 → 1.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ffba8f1b3669ad74b16896e59c3b4f669d5802f96ce2fad7ead33ac06b16880c
-  data.tar.gz: 74edc98197bd0671dd39ac6446553b23998c1c3a67a122ba916e2542ea7bfcdb
+  metadata.gz: 1cb45582de9a181e4b32595a183630023ba9af3a84ed5123308eada240420ab8
+  data.tar.gz: 46ce8b2795adbd03ca67d69ba9ddd725ac1b7bcbf56ac85344ee220380495ad4
 SHA512:
-  metadata.gz: c09f6b0e32127203cde69cff41bae906577781d43222115fe34b8632a886d4bec78f7878928e20128f63cd3c39445a8b447ef7ee224a47e8f9b65982e01be339
-  data.tar.gz: 7a4bb522ed8674102bcbaf35cb853f2f2816f501e0349c52154214519559f03a5dc876c1ba318296f17c9dece94153e37157cac9afbeaecebb6bbf7a1a4eecbc
+  metadata.gz: 5a4053d1a93c89a058593fc998dad0c77ac32aae4d691db3087bd88743bae2aa76193112262e0ac536468c3ddc14ceef5fd34e2d770d7e8d3129d83df65d604d
+  data.tar.gz: e397cb05b4d7bc5a3a6304fc4346ac63318c043c44dee032730af30c23a19d42168f0390039d6986aeef33dfda28e99dda831ca23dca8ea217a356d736dccd6e

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.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)
+
 ## 1.5.6
 
 - Minor performance improvements on association read

data/Gemfile

@@ -9,9 +9,9 @@ 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", "~> 2.7.11"
+gem "dalli", "~> 3.2.3"
 gem "cityhash", "~> 0.6.0", platform: :mri
 
 gem "byebug", 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.5.6)
+    identity_cache (1.6.1)
       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 (2.7.11)
+    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,7 +64,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)
@@ -75,8 +83,10 @@ 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)
     timeout (0.4.1)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
@@ -84,14 +94,15 @@ 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!
   memcached_store (~> 2.3.2)
   minitest (~> 5.14)
   mocha (~> 2.0)

data/dev.yml

@@ -1,18 +1,10 @@
 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
 
 commands:
   test:

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/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.1"
   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
@@ -115,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
 
@@ -191,6 +202,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.1
 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-08-21 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
@@ -177,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
@@ -192,8 +191,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.17
+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