solid_cache 1.0.6 → 1.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1cf02364d38d08f18cbe3d9811a7957018ec23ebaf08951c51110204eea237de
-  data.tar.gz: c04b221f9c37fdc78f78e07143afe33bc1d346695ef8c910dc986533dd460a38
+  metadata.gz: fbc53d2cf4cc3edfeb5292055f3e8bb9c0057e4e067bee764a4d88a62fbd8278
+  data.tar.gz: e3e9eac0f9a24a26eb3e992b2d2cdd0037c5d9ca4c36ea7cf8751b257fdf152b
 SHA512:
-  metadata.gz: 725fa1c931e54f8aa743aa8311fd05f44fe200904ede83bcb1207377f54926c330abe887a2dfb04c956f703f8e673b38f8af219a31e04c2f1d653cdbe0b980db
-  data.tar.gz: 6d793397978b7d1e1797ed4b97726dc25c1e053a8a8dc2aa9b39669bbb79c3a9d7b9d0d676e43bea4f1a401ae7528a1aee34c5985899e96e092b86c1be4c2f0a
+  metadata.gz: 3e94a6318abc57922c7b98c34b4034a660c8f598a557f0fb38a95f313228e02ae437396d415fe7bb2ed8782a492274458f621e059f74ea75905fd91b2bdee155
+  data.tar.gz: deebaed2b15b865e87aaf27ac521e0b85fb8ebffab19651dec622c6ad6008cb489ec1648059a26f7d870bf327b8295f70eb76651bb3465a5613a16c14b2901b8

data/README.md

@@ -1,6 +1,6 @@
 # Solid Cache
 
-Solid Cache is a database-backed Active Support cache store that let's you keep a much larger cache than is typically possible with traditional memory-only Redis or Memcached stores. This is thanks to the speed of modern SSD drives, which make the access-time penalty of using disk vs RAM insignificant for most caching purposes. Simply put, you're now usually better off keeping a huge cache on disk rather than a small cache in memory.
+Solid Cache is a database-backed Active Support cache store that lets you keep a much larger cache than is typically possible with traditional memory-only Redis or Memcached stores. This is thanks to the speed of modern SSD drives, which make the access-time penalty of using disk vs RAM insignificant for most caching purposes. Simply put, you're now usually better off keeping a huge cache on disk rather than a small cache in memory.
 
 ## Installation
 
@@ -11,7 +11,7 @@ Solid Cache is configured by default in new Rails 8 applications. But if you're
 
 This will configure Solid Cache as the production cache store, create `config/cache.yml`, and create `db/cache_schema.rb`.
 
-You will then have to add the configuration for the queue database in `config/database.yml`. If you're using sqlite, it'll look like this:
+You will then have to add the configuration for the cache database in `config/database.yml`. If you're using sqlite, it'll look like this:
 
 ```yaml
 production:
@@ -55,7 +55,7 @@ default:
   size_estimate_samples: 1000
 
 development: &development
-  database: development_cache
+  database: cache
   store_options:
     <<: *default_store_options
     max_size: <%= 256.gigabytes %>
@@ -69,6 +69,13 @@ production: &production
 
 For the full list of keys for `store_options` see [Cache configuration](#cache-configuration). Any options passed to the cache lookup will overwrite those specified here.
 
+After running `solid_cache:install`, `environments/production.rb` will replace your cache store with Solid Cache, but you can also do this manually:
+
+```ruby
+# config/environments/production.rb
+config.cache_store = :solid_cache_store
+```
+
 ### Connection configuration
 
 You can set one of `database`, `databases` and `connects_to` in the config file. They will be used to configure the cache databases in `SolidCache::Record#connects_to`.
@@ -189,7 +196,7 @@ or
 config.solid_cache.encrypt = true
 ```
 
-You will need to set up your application to (use Active Record Encryption)[https://guides.rubyonrails.org/active_record_encryption.html].
+You will need to set up your application to [use Active Record Encryption](https://guides.rubyonrails.org/active_record_encryption.html).
 
 Solid Cache by default uses a custom encryptor and message serializer that are optimised for it.
 
@@ -260,7 +267,7 @@ This ensures that all the Rails versions dependencies are updated.
 
 ## Implementation
 
-Solid Cache is a FIFO (first in, first out) cache. While this is not as efficient as an LRU cache, it is mitigated by the longer cache lifespan.
+Solid Cache is a FIFO (first in, first out) cache. While this is not as efficient as an LRU (least recently used) cache, it is mitigated by the longer cache lifespan.
 
 A FIFO cache is much easier to manage:
 1. We don't need to track when items are read.

data/app/models/solid_cache/entry.rb

@@ -14,6 +14,8 @@ module SolidCache
 
     KEY_HASH_ID_RANGE = -(2**63)..(2**63 - 1)
 
+    MULTI_BATCH_SIZE = 1000
+
     class << self
       def write(key, value)
         write_multi([ { key: key, value: value } ])
@@ -21,9 +23,11 @@ module SolidCache
 
       def write_multi(payloads)
         without_query_cache do
-          upsert_all \
-            add_key_hash_and_byte_size(payloads),
-            unique_by: upsert_unique_by, on_duplicate: :update, update_only: [ :key, :value, :byte_size ]
+          payloads.each_slice(MULTI_BATCH_SIZE).each do |payload_batch|
+            upsert_all \
+              add_key_hash_and_byte_size(payload_batch),
+              unique_by: upsert_unique_by, on_duplicate: :update, update_only: [ :key, :value, :byte_size ]
+          end
         end
       end
 
@@ -33,9 +37,15 @@ module SolidCache
 
       def read_multi(keys)
         without_query_cache do
-          query = Arel.sql(select_sql(keys), *key_hashes_for(keys))
+          {}.tap do |results|
+            keys.each_slice(MULTI_BATCH_SIZE).each do |keys_batch|
+              query = Arel.sql(select_sql(keys_batch), *key_hashes_for(keys_batch))
 
-          connection.select_all(query, "SolidCache::Entry Load").cast_values(attribute_types).to_h
+              with_connection do |connection|
+                results.merge!(connection.select_all(query, "SolidCache::Entry Load").cast_values(attribute_types).to_h)
+              end
+            end
+          end
         end
       end
 
@@ -46,7 +56,9 @@ module SolidCache
       end
 
       def clear_truncate
-        connection.truncate(table_name)
+        with_connection do |connection|
+          connection.truncate(table_name)
+        end
       end
 
       def clear_delete
@@ -83,7 +95,9 @@ module SolidCache
         end
 
         def upsert_unique_by
-          connection.supports_insert_conflict_target? ? :key_hash : nil
+          with_connection do |connection|
+            connection.supports_insert_conflict_target? ? :key_hash : nil
+          end
         end
 
         # This constructs and caches a SQL query for a given number of keys.

data/app/models/solid_cache/record.rb

@@ -10,7 +10,22 @@ module SolidCache
 
     class << self
       def disable_instrumentation(&block)
-        connection.with_instrumenter(NULL_INSTRUMENTER, &block)
+        with_instrumenter(NULL_INSTRUMENTER, &block)
+      end
+
+      def with_instrumenter(instrumenter, &block)
+        with_connection do |connection|
+          if connection.respond_to?(:with_instrumenter)
+            connection.with_instrumenter(instrumenter, &block)
+          else
+            begin
+              old_instrumenter, ActiveSupport::IsolatedExecutionState[:active_record_instrumenter] = ActiveSupport::IsolatedExecutionState[:active_record_instrumenter], instrumenter
+              block.call
+            ensure
+              ActiveSupport::IsolatedExecutionState[:active_record_instrumenter] = old_instrumenter
+            end
+          end
+        end
       end
 
       def with_shard(shard, &block)

data/lib/solid_cache/engine.rb

@@ -41,7 +41,7 @@ module SolidCache
     end
 
     config.after_initialize do
-      if SolidCache.configuration.encrypt? && Record.connection.adapter_name == "PostgreSQL" && Rails::VERSION::MAJOR <= 7
+      if SolidCache.configuration.encrypt? && Record.lease_connection.adapter_name == "PostgreSQL" && Rails::VERSION::MAJOR <= 7
         raise \
           "Cannot enable encryption for Solid Cache: in Rails 7, Active Record Encryption does not support " \
           "encrypting binary columns on PostgreSQL"

data/lib/solid_cache/store/connections.rb

@@ -34,26 +34,6 @@ module SolidCache
         end
       end
 
-      def with_connection_for(key, async: false, &block)
-        connections.with_connection_for(key) do
-          execute(async, &block)
-        end
-      end
-
-      def with_connection(name, async: false, &block)
-        connections.with(name) do
-          execute(async, &block)
-        end
-      end
-
-      def group_by_connection(keys)
-        connections.assign(keys)
-      end
-
-      def connection_names
-        connections.names
-      end
-
       def connections
         @connections ||= SolidCache::Connections.from_config(@shard_options)
       end
@@ -63,6 +43,26 @@ module SolidCache
           connections
         end
 
+        def with_connection_for(key, async: false, &block)
+          connections.with_connection_for(key) do
+            execute(async, &block)
+          end
+        end
+
+        def with_connection(name, async: false, &block)
+          connections.with(name) do
+            execute(async, &block)
+          end
+        end
+
+        def group_by_connection(keys)
+          connections.assign(keys)
+        end
+
+        def connection_names
+          connections.names
+        end
+
         def reading_key(key, failsafe:, failsafe_returning: nil, &block)
           failsafe(failsafe, returning: failsafe_returning) do
             with_connection_for(key, &block)
@@ -70,16 +70,15 @@ module SolidCache
         end
 
         def reading_keys(keys, failsafe:, failsafe_returning: nil)
-          group_by_connection(keys).map do |connection, keys|
+          group_by_connection(keys).map do |connection, grouped_keys|
             failsafe(failsafe, returning: failsafe_returning) do
               with_connection(connection) do
-                yield keys
+                yield grouped_keys
               end
             end
           end
         end
 
-
         def writing_key(key, failsafe:, failsafe_returning: nil, &block)
           failsafe(failsafe, returning: failsafe_returning) do
             with_connection_for(key, &block)
@@ -87,10 +86,10 @@ module SolidCache
         end
 
         def writing_keys(entries, failsafe:, failsafe_returning: nil)
-          group_by_connection(entries).map do |connection, entries|
+          group_by_connection(entries).map do |connection, grouped_entries|
             failsafe(failsafe, returning: failsafe_returning) do
               with_connection(connection) do
-                yield entries
+                yield grouped_entries
               end
             end
           end

data/lib/solid_cache/store/expiry.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "concurrent/atomic/atomic_fixnum"
-
 module SolidCache
   class Store
     module Expiry

data/lib/solid_cache/store/failsafe.rb

@@ -6,7 +6,6 @@ module SolidCache
       TRANSIENT_ACTIVE_RECORD_ERRORS = [
         ActiveRecord::AdapterTimeout,
         ActiveRecord::ConnectionNotEstablished,
-        ActiveRecord::ConnectionTimeoutError,
         ActiveRecord::Deadlocked,
         ActiveRecord::LockWaitTimeout,
         ActiveRecord::QueryCanceled,

data/lib/solid_cache/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SolidCache
-  VERSION = "1.0.6"
+  VERSION = "1.0.8"
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: solid_cache
 version: !ruby/object:Gem::Version
-  version: 1.0.6
+  version: 1.0.8
 platform: ruby
 authors:
 - Donal McBreen
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-10 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -141,9 +140,6 @@ licenses:
 metadata:
   homepage_uri: http://github.com/rails/solid_cache
   source_code_uri: http://github.com/rails/solid_cache
-post_install_message: |
-  Upgrading from Solid Cache v0.3 or earlier? There are new database migrations in v0.4.
-  See https://github.com/rails/solid_cache/blob/main/upgrading_to_version_0.4.x.md for upgrade instructions.
 rdoc_options: []
 require_paths:
 - lib
@@ -158,8 +154,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: A database backed ActiveSupport::Cache::Store
 test_files: []