Add dirties option to Model.uncached #51204

djmb · 2024-02-27T08:52:17Z

Motivation / Background

This is an alternative to #50721.

For Solid Cache, we want to be able to read and write from the cache database without using the query cache.

We also don't want to expire the query cache on other connection pools when we write. Writing to the Rails cache shouldn't invalidate the main query cache.

cc @byroot, @jeremy

Detail

This adds a dirties option to ActiveRecord::Base.uncached and ActiveRecord::ConnectionAdapters::ConnectionPool#uncached.

Setting dirties to false, means database writes to the connection pool will not mark any query caches as dirty.

The option defaults to true which retains the existing behaviour and clears query caches on all connection pools used by the current thread.

Additional information

Checklist

Before submitting the PR make sure the following are checked:

This Pull Request is related to one change. Changes that are unrelated should be opened in separate PRs.
Commit message has a detailed description of what changed and why. If this PR fixes a related issue include it in the commit message. Ex: [Fix #issue-number]
Tests are added or updated if you fix a bug or add a feature.
CHANGELOG files are updated for the changed libraries if there is a behavior change or additional feature. Minor bug fixes and documentation changes should not be included.

activerecord/lib/active_record/connection_adapters/abstract/connection_pool.rb

activerecord/CHANGELOG.md

activerecord/lib/active_record/connection_adapters/abstract/query_cache.rb

activerecord/lib/active_record/query_cache.rb

jeremy · 2024-02-28T16:42:35Z

activerecord/test/cases/query_cache_test.rb

+    }
+    mw.call({})
+  end
+


Great coverage.

activerecord/lib/active_record/query_cache.rb

This adds a `dirties` option to `ActiveRecord::Base.uncached` and `ActiveRecord::ConnectionAdapters::ConnectionPool#uncached`. Setting `dirties` to `false`, means database writes to the connection pool will not mark any query caches as dirty. The option defaults to `true` which retains the existing behaviour and clears query caches on all connection pools used by the current thread.

This commit addresses these errors since rails#51192 renames `.connection` into `.lease_connection` Follow up rails#51204 ```ruby $ cd activerecord $ bin/test test/cases/query_cache_test.rb -n /uncached_dirties/ Using sqlite3 Run options: -n /uncached_dirties/ --seed 57207 E Error: QueryCacheTest#test_query_cache_uncached_dirties: NoMethodError: undefined method `connection' for class ActiveRecord::Base lib/active_record/dynamic_matchers.rb:22:in `method_missing' test/cases/query_cache_test.rb:712:in `block (2 levels) in test_query_cache_uncached_dirties' /home/yahonda/src/github.com/rails/rails/activesupport/lib/active_support/testing/assertions.rb:241:in `assert_no_changes' test/cases/query_cache_test.rb:712:in `block in test_query_cache_uncached_dirties' test/cases/query_cache_test.rb:771:in `block (2 levels) in middleware' /home/yahonda/src/github.com/rails/rails/activesupport/lib/active_support/execution_wrapper.rb:91:in `wrap' test/cases/query_cache_test.rb:771:in `block in middleware' test/cases/query_cache_test.rb:720:in `test_query_cache_uncached_dirties' bin/test test/cases/query_cache_test.rb:709 E Error: QueryCacheTest#test_query_cache_connection_uncached_dirties: NoMethodError: undefined method `connection' for class ActiveRecord::Base lib/active_record/dynamic_matchers.rb:22:in `method_missing' test/cases/query_cache_test.rb:726:in `block (2 levels) in test_query_cache_connection_uncached_dirties' /home/yahonda/src/github.com/rails/rails/activesupport/lib/active_support/testing/assertions.rb:241:in `assert_no_changes' test/cases/query_cache_test.rb:726:in `block in test_query_cache_connection_uncached_dirties' test/cases/query_cache_test.rb:771:in `block (2 levels) in middleware' /home/yahonda/src/github.com/rails/rails/activesupport/lib/active_support/execution_wrapper.rb:91:in `wrap' test/cases/query_cache_test.rb:771:in `block in middleware' test/cases/query_cache_test.rb:734:in `test_query_cache_connection_uncached_dirties' bin/test test/cases/query_cache_test.rb:723 E Error: QueryCacheTest#test_query_cache_uncached_dirties_disabled_with_nested_cache: NoMethodError: undefined method `connection' for class ActiveRecord::Base lib/active_record/dynamic_matchers.rb:22:in `method_missing' test/cases/query_cache_test.rb:740:in `block (2 levels) in test_query_cache_uncached_dirties_disabled_with_nested_cache' /home/yahonda/src/github.com/rails/rails/activesupport/lib/active_support/testing/assertions.rb:194:in `assert_changes' test/cases/query_cache_test.rb:740:in `block in test_query_cache_uncached_dirties_disabled_with_nested_cache' test/cases/query_cache_test.rb:771:in `block (2 levels) in middleware' /home/yahonda/src/github.com/rails/rails/activesupport/lib/active_support/execution_wrapper.rb:91:in `wrap' test/cases/query_cache_test.rb:771:in `block in middleware' test/cases/query_cache_test.rb:757:in `test_query_cache_uncached_dirties_disabled_with_nested_cache' bin/test test/cases/query_cache_test.rb:737 Finished in 0.134429s, 22.3166 runs/s, 0.0000 assertions/s. 3 runs, 0 assertions, 0 failures, 3 errors, 0 skips $ ```

This adds a `dirties` option to `ActiveRecord::Base.uncached` and `ActiveRecord::ConnectionAdapters::ConnectionPool#uncached`. Setting `dirties` to `false`, means database writes to the connection pool will not mark any query caches as dirty. The option defaults to `true` which retains the existing behaviour and clears query caches on all connection pools used by the current thread. Co-authored-by: Jeremy Daer <jeremy@rubyonrails.org>

This commit addresses these errors since rails#51192 renames `.connection` into `.lease_connection` Follow up rails#51204 ```ruby $ cd activerecord $ bin/test test/cases/query_cache_test.rb -n /uncached_dirties/ Using sqlite3 Run options: -n /uncached_dirties/ --seed 57207 E Error: QueryCacheTest#test_query_cache_uncached_dirties: NoMethodError: undefined method `connection' for class ActiveRecord::Base lib/active_record/dynamic_matchers.rb:22:in `method_missing' test/cases/query_cache_test.rb:712:in `block (2 levels) in test_query_cache_uncached_dirties' /home/yahonda/src/github.com/rails/rails/activesupport/lib/active_support/testing/assertions.rb:241:in `assert_no_changes' test/cases/query_cache_test.rb:712:in `block in test_query_cache_uncached_dirties' test/cases/query_cache_test.rb:771:in `block (2 levels) in middleware' /home/yahonda/src/github.com/rails/rails/activesupport/lib/active_support/execution_wrapper.rb:91:in `wrap' test/cases/query_cache_test.rb:771:in `block in middleware' test/cases/query_cache_test.rb:720:in `test_query_cache_uncached_dirties' bin/test test/cases/query_cache_test.rb:709 E Error: QueryCacheTest#test_query_cache_connection_uncached_dirties: NoMethodError: undefined method `connection' for class ActiveRecord::Base lib/active_record/dynamic_matchers.rb:22:in `method_missing' test/cases/query_cache_test.rb:726:in `block (2 levels) in test_query_cache_connection_uncached_dirties' /home/yahonda/src/github.com/rails/rails/activesupport/lib/active_support/testing/assertions.rb:241:in `assert_no_changes' test/cases/query_cache_test.rb:726:in `block in test_query_cache_connection_uncached_dirties' test/cases/query_cache_test.rb:771:in `block (2 levels) in middleware' /home/yahonda/src/github.com/rails/rails/activesupport/lib/active_support/execution_wrapper.rb:91:in `wrap' test/cases/query_cache_test.rb:771:in `block in middleware' test/cases/query_cache_test.rb:734:in `test_query_cache_connection_uncached_dirties' bin/test test/cases/query_cache_test.rb:723 E Error: QueryCacheTest#test_query_cache_uncached_dirties_disabled_with_nested_cache: NoMethodError: undefined method `connection' for class ActiveRecord::Base lib/active_record/dynamic_matchers.rb:22:in `method_missing' test/cases/query_cache_test.rb:740:in `block (2 levels) in test_query_cache_uncached_dirties_disabled_with_nested_cache' /home/yahonda/src/github.com/rails/rails/activesupport/lib/active_support/testing/assertions.rb:194:in `assert_changes' test/cases/query_cache_test.rb:740:in `block in test_query_cache_uncached_dirties_disabled_with_nested_cache' test/cases/query_cache_test.rb:771:in `block (2 levels) in middleware' /home/yahonda/src/github.com/rails/rails/activesupport/lib/active_support/execution_wrapper.rb:91:in `wrap' test/cases/query_cache_test.rb:771:in `block in middleware' test/cases/query_cache_test.rb:757:in `test_query_cache_uncached_dirties_disabled_with_nested_cache' bin/test test/cases/query_cache_test.rb:737 Finished in 0.134429s, 22.3166 runs/s, 0.0000 assertions/s. 3 runs, 0 assertions, 0 failures, 3 errors, 0 skips $ ```

This adds a `dirties` option to `ActiveRecord::Base.uncached` and `ActiveRecord::ConnectionAdapters::ConnectionPool#uncached`. Setting `dirties` to `false`, means database writes to the connection pool will not mark any query caches as dirty. The option defaults to `true` which retains the existing behaviour and clears query caches on all connection pools used by the current thread. Co-authored-by: Jeremy Daer <jeremy@rubyonrails.org>

This commit addresses these errors since rails#51192 renames `.connection` into `.lease_connection` Follow up rails#51204 ```ruby $ cd activerecord $ bin/test test/cases/query_cache_test.rb -n /uncached_dirties/ Using sqlite3 Run options: -n /uncached_dirties/ --seed 57207 E Error: QueryCacheTest#test_query_cache_uncached_dirties: NoMethodError: undefined method `connection' for class ActiveRecord::Base lib/active_record/dynamic_matchers.rb:22:in `method_missing' test/cases/query_cache_test.rb:712:in `block (2 levels) in test_query_cache_uncached_dirties' /home/yahonda/src/github.com/rails/rails/activesupport/lib/active_support/testing/assertions.rb:241:in `assert_no_changes' test/cases/query_cache_test.rb:712:in `block in test_query_cache_uncached_dirties' test/cases/query_cache_test.rb:771:in `block (2 levels) in middleware' /home/yahonda/src/github.com/rails/rails/activesupport/lib/active_support/execution_wrapper.rb:91:in `wrap' test/cases/query_cache_test.rb:771:in `block in middleware' test/cases/query_cache_test.rb:720:in `test_query_cache_uncached_dirties' bin/test test/cases/query_cache_test.rb:709 E Error: QueryCacheTest#test_query_cache_connection_uncached_dirties: NoMethodError: undefined method `connection' for class ActiveRecord::Base lib/active_record/dynamic_matchers.rb:22:in `method_missing' test/cases/query_cache_test.rb:726:in `block (2 levels) in test_query_cache_connection_uncached_dirties' /home/yahonda/src/github.com/rails/rails/activesupport/lib/active_support/testing/assertions.rb:241:in `assert_no_changes' test/cases/query_cache_test.rb:726:in `block in test_query_cache_connection_uncached_dirties' test/cases/query_cache_test.rb:771:in `block (2 levels) in middleware' /home/yahonda/src/github.com/rails/rails/activesupport/lib/active_support/execution_wrapper.rb:91:in `wrap' test/cases/query_cache_test.rb:771:in `block in middleware' test/cases/query_cache_test.rb:734:in `test_query_cache_connection_uncached_dirties' bin/test test/cases/query_cache_test.rb:723 E Error: QueryCacheTest#test_query_cache_uncached_dirties_disabled_with_nested_cache: NoMethodError: undefined method `connection' for class ActiveRecord::Base lib/active_record/dynamic_matchers.rb:22:in `method_missing' test/cases/query_cache_test.rb:740:in `block (2 levels) in test_query_cache_uncached_dirties_disabled_with_nested_cache' /home/yahonda/src/github.com/rails/rails/activesupport/lib/active_support/testing/assertions.rb:194:in `assert_changes' test/cases/query_cache_test.rb:740:in `block in test_query_cache_uncached_dirties_disabled_with_nested_cache' test/cases/query_cache_test.rb:771:in `block (2 levels) in middleware' /home/yahonda/src/github.com/rails/rails/activesupport/lib/active_support/execution_wrapper.rb:91:in `wrap' test/cases/query_cache_test.rb:771:in `block in middleware' test/cases/query_cache_test.rb:757:in `test_query_cache_uncached_dirties_disabled_with_nested_cache' bin/test test/cases/query_cache_test.rb:737 Finished in 0.134429s, 22.3166 runs/s, 0.0000 assertions/s. 3 runs, 0 assertions, 0 failures, 3 errors, 0 skips $ ```

This adds a `dirties` option to `ActiveRecord::Base.uncached` and `ActiveRecord::ConnectionAdapters::ConnectionPool#uncached`. Setting `dirties` to `false`, means database writes to the connection pool will not mark any query caches as dirty. The option defaults to `true` which retains the existing behaviour and clears query caches on all connection pools used by the current thread. Co-authored-by: Jeremy Daer <jeremy@rubyonrails.org>

This commit addresses these errors since rails#51192 renames `.connection` into `.lease_connection` Follow up rails#51204 ```ruby $ cd activerecord $ bin/test test/cases/query_cache_test.rb -n /uncached_dirties/ Using sqlite3 Run options: -n /uncached_dirties/ --seed 57207 E Error: QueryCacheTest#test_query_cache_uncached_dirties: NoMethodError: undefined method `connection' for class ActiveRecord::Base lib/active_record/dynamic_matchers.rb:22:in `method_missing' test/cases/query_cache_test.rb:712:in `block (2 levels) in test_query_cache_uncached_dirties' /home/yahonda/src/github.com/rails/rails/activesupport/lib/active_support/testing/assertions.rb:241:in `assert_no_changes' test/cases/query_cache_test.rb:712:in `block in test_query_cache_uncached_dirties' test/cases/query_cache_test.rb:771:in `block (2 levels) in middleware' /home/yahonda/src/github.com/rails/rails/activesupport/lib/active_support/execution_wrapper.rb:91:in `wrap' test/cases/query_cache_test.rb:771:in `block in middleware' test/cases/query_cache_test.rb:720:in `test_query_cache_uncached_dirties' bin/test test/cases/query_cache_test.rb:709 E Error: QueryCacheTest#test_query_cache_connection_uncached_dirties: NoMethodError: undefined method `connection' for class ActiveRecord::Base lib/active_record/dynamic_matchers.rb:22:in `method_missing' test/cases/query_cache_test.rb:726:in `block (2 levels) in test_query_cache_connection_uncached_dirties' /home/yahonda/src/github.com/rails/rails/activesupport/lib/active_support/testing/assertions.rb:241:in `assert_no_changes' test/cases/query_cache_test.rb:726:in `block in test_query_cache_connection_uncached_dirties' test/cases/query_cache_test.rb:771:in `block (2 levels) in middleware' /home/yahonda/src/github.com/rails/rails/activesupport/lib/active_support/execution_wrapper.rb:91:in `wrap' test/cases/query_cache_test.rb:771:in `block in middleware' test/cases/query_cache_test.rb:734:in `test_query_cache_connection_uncached_dirties' bin/test test/cases/query_cache_test.rb:723 E Error: QueryCacheTest#test_query_cache_uncached_dirties_disabled_with_nested_cache: NoMethodError: undefined method `connection' for class ActiveRecord::Base lib/active_record/dynamic_matchers.rb:22:in `method_missing' test/cases/query_cache_test.rb:740:in `block (2 levels) in test_query_cache_uncached_dirties_disabled_with_nested_cache' /home/yahonda/src/github.com/rails/rails/activesupport/lib/active_support/testing/assertions.rb:194:in `assert_changes' test/cases/query_cache_test.rb:740:in `block in test_query_cache_uncached_dirties_disabled_with_nested_cache' test/cases/query_cache_test.rb:771:in `block (2 levels) in middleware' /home/yahonda/src/github.com/rails/rails/activesupport/lib/active_support/execution_wrapper.rb:91:in `wrap' test/cases/query_cache_test.rb:771:in `block in middleware' test/cases/query_cache_test.rb:757:in `test_query_cache_uncached_dirties_disabled_with_nested_cache' bin/test test/cases/query_cache_test.rb:737 Finished in 0.134429s, 22.3166 runs/s, 0.0000 assertions/s. 3 runs, 0 assertions, 0 failures, 3 errors, 0 skips $ ```

rails-bot bot added the activerecord label Feb 27, 2024

byroot reviewed Feb 27, 2024

View reviewed changes

activerecord/lib/active_record/connection_adapters/abstract/connection_pool.rb Show resolved Hide resolved

jeremy approved these changes Feb 28, 2024

View reviewed changes

djmb commented Feb 29, 2024

View reviewed changes

activerecord/lib/active_record/query_cache.rb Outdated Show resolved Hide resolved

djmb force-pushed the uncached-dirties branch 2 times, most recently from 97126b4 to cee1f28 Compare February 29, 2024 08:50

djmb force-pushed the uncached-dirties branch from cee1f28 to 4d531fa Compare March 1, 2024 10:19

jeremy added this to the 7.2.0 milestone Mar 3, 2024

Merge branch 'main' into uncached-dirties

3c32c5c

jeremy merged commit 5d528ba into rails:main Mar 3, 2024
3 of 4 checks passed

yahonda mentioned this pull request Mar 3, 2024

Use ActiveRecord::Base.lease_connection for uncached dirties tests #51240

Merged

4 tasks

fatkodima mentioned this pull request Mar 3, 2024

Fix QueryCache :dirties tests #51241

Closed

djmb mentioned this pull request Mar 11, 2024

Remove ActiveRecord query cache workarounds rails/solid_cache#123

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add dirties option to Model.uncached #51204

Add dirties option to Model.uncached #51204

djmb commented Feb 27, 2024

jeremy Feb 28, 2024

Add dirties option to Model.uncached #51204

Add dirties option to Model.uncached #51204

Conversation

djmb commented Feb 27, 2024

Motivation / Background

Detail

Additional information

Checklist

jeremy Feb 28, 2024

Choose a reason for hiding this comment