activesupport 6.1.7.2 → 7.0.5

data/lib/active_support/cache.rb

@@ -22,13 +22,24 @@ module ActiveSupport
 
     # These options mean something to all cache implementations. Individual cache
     # implementations may support additional options.
-    UNIVERSAL_OPTIONS = [:namespace, :compress, :compress_threshold, :expires_in, :race_condition_ttl, :coder]
+    UNIVERSAL_OPTIONS = [:namespace, :compress, :compress_threshold, :expires_in, :expire_in, :expired_in, :race_condition_ttl, :coder, :skip_nil]
+
+    DEFAULT_COMPRESS_LIMIT = 1.kilobyte
+
+    # Mapping of canonical option names to aliases that a store will recognize.
+    OPTION_ALIASES = {
+      expires_in: [:expire_in, :expired_in]
+    }.freeze
 
     module Strategy
       autoload :LocalCache, "active_support/cache/strategy/local_cache"
     end
 
+    @format_version = 6.1
+
     class << self
+      attr_accessor :format_version
+
       # Creates a new Store object according to the given options.
       #
       # If no arguments are passed to this method, then a new
@@ -128,9 +139,10 @@ module ActiveSupport
     # popular cache store for large production websites.
     #
     # Some implementations may not support all methods beyond the basic cache
-    # methods of +fetch+, +write+, +read+, +exist?+, and +delete+.
+    # methods of #fetch, #write, #read, #exist?, and #delete.
     #
-    # ActiveSupport::Cache::Store can store any serializable Ruby object.
+    # ActiveSupport::Cache::Store can store any Ruby object that is supported by
+    # its +coder+'s +dump+ and +load+ methods.
     #
     #   cache = ActiveSupport::Cache::MemoryStore.new
     #
@@ -138,6 +150,8 @@ module ActiveSupport
     #   cache.write('city', "Duckburgh")
     #   cache.read('city')   # => "Duckburgh"
     #
+    #   cache.write('not serializable', Proc.new {}) # => TypeError
+    #
     # Keys are always translated into Strings and are case sensitive. When an
     # object is specified as a key and has a +cache_key+ method defined, this
     # method will be called to define the key.  Otherwise, the +to_param+
@@ -158,14 +172,7 @@ module ActiveSupport
     #   cache.namespace = -> { @last_mod_time }  # Set the namespace to a variable
     #   @last_mod_time = Time.now  # Invalidate the entire cache by changing namespace
     #
-    # Cached data larger than 1kB are compressed by default. To turn off
-    # compression, pass <tt>compress: false</tt> to the initializer or to
-    # individual +fetch+ or +write+ method calls. The 1kB compression
-    # threshold is configurable with the <tt>:compress_threshold</tt> option,
-    # specified in bytes.
     class Store
-      DEFAULT_CODER = Marshal
-
       cattr_accessor :logger, instance_writer: true
 
       attr_reader :silence, :options
@@ -188,12 +195,26 @@ module ActiveSupport
           end
       end
 
-      # Creates a new cache. The options will be passed to any write method calls
-      # except for <tt>:namespace</tt> which can be used to set the global
-      # namespace for the cache.
+      # Creates a new cache.
+      #
+      # ==== Options
+      #
+      # * +:namespace+ - Sets the namespace for the cache. This option is
+      #   especially useful if your application shares a cache with other
+      #   applications.
+      # * +:coder+ - Replaces the default cache entry serialization mechanism
+      #   with a custom one. The +coder+ must respond to +dump+ and +load+.
+      #   Using a custom coder disables automatic compression.
+      #
+      # Any other specified options are treated as default options for the
+      # relevant cache operations, such as #read, #write, and #fetch.
       def initialize(options = nil)
-        @options = options ? options.dup : {}
-        @coder = @options.delete(:coder) { self.class::DEFAULT_CODER } || NullCoder
+        @options = options ? normalize_options(options) : {}
+        @options[:compress] = true unless @options.key?(:compress)
+        @options[:compress_threshold] = DEFAULT_COMPRESS_LIMIT unless @options.key?(:compress_threshold)
+
+        @coder = @options.delete(:coder) { default_coder } || NullCoder
+        @coder_supports_compression = @coder.respond_to?(:dump_compressed)
       end
 
       # Silences the logger.
@@ -228,101 +249,75 @@ module ActiveSupport
       #   end
       #   cache.fetch('city')   # => "Duckburgh"
       #
-      # You may also specify additional options via the +options+ argument.
-      # Setting <tt>force: true</tt> forces a cache "miss," meaning we treat
-      # the cache value as missing even if it's present. Passing a block is
-      # required when +force+ is true so this always results in a cache write.
+      # ==== Options
       #
-      #   cache.write('today', 'Monday')
-      #   cache.fetch('today', force: true) { 'Tuesday' } # => 'Tuesday'
-      #   cache.fetch('today', force: true) # => ArgumentError
-      #
-      # The +:force+ option is useful when you're calling some other method to
-      # ask whether you should force a cache write. Otherwise, it's clearer to
-      # just call <tt>Cache#write</tt>.
-      #
-      # Setting <tt>skip_nil: true</tt> will not cache nil result:
-      #
-      #   cache.fetch('foo') { nil }
-      #   cache.fetch('bar', skip_nil: true) { nil }
-      #   cache.exist?('foo') # => true
-      #   cache.exist?('bar') # => false
-      #
-      #
-      # Setting <tt>compress: false</tt> disables compression of the cache entry.
-      #
-      # Setting <tt>:expires_in</tt> will set an expiration time on the cache.
-      # All caches support auto-expiring content after a specified number of
-      # seconds. This value can be specified as an option to the constructor
-      # (in which case all entries will be affected), or it can be supplied to
-      # the +fetch+ or +write+ method to effect just one entry.
-      #
-      #   cache = ActiveSupport::Cache::MemoryStore.new(expires_in: 5.minutes)
-      #   cache.write(key, value, expires_in: 1.minute) # Set a lower value for one entry
-      #
-      # Setting <tt>:version</tt> verifies the cache stored under <tt>name</tt>
-      # is of the same version. nil is returned on mismatches despite contents.
-      # This feature is used to support recyclable cache keys.
-      #
-      # Setting <tt>:race_condition_ttl</tt> is very useful in situations where
-      # a cache entry is used very frequently and is under heavy load. If a
-      # cache expires and due to heavy load several different processes will try
-      # to read data natively and then they all will try to write to cache. To
-      # avoid that case the first process to find an expired cache entry will
-      # bump the cache expiration time by the value set in <tt>:race_condition_ttl</tt>.
-      # Yes, this process is extending the time for a stale value by another few
-      # seconds. Because of extended life of the previous cache, other processes
-      # will continue to use slightly stale data for a just a bit longer. In the
-      # meantime that first process will go ahead and will write into cache the
-      # new value. After that all the processes will start getting the new value.
-      # The key is to keep <tt>:race_condition_ttl</tt> small.
-      #
-      # If the process regenerating the entry errors out, the entry will be
-      # regenerated after the specified number of seconds. Also note that the
-      # life of stale cache is extended only if it expired recently. Otherwise
-      # a new value is generated and <tt>:race_condition_ttl</tt> does not play
-      # any role.
-      #
-      #   # Set all values to expire after one minute.
-      #   cache = ActiveSupport::Cache::MemoryStore.new(expires_in: 1.minute)
-      #
-      #   cache.write('foo', 'original value')
-      #   val_1 = nil
-      #   val_2 = nil
-      #   sleep 60
-      #
-      #   Thread.new do
-      #     val_1 = cache.fetch('foo', race_condition_ttl: 10.seconds) do
-      #       sleep 1
-      #       'new value 1'
-      #     end
-      #   end
+      # Internally, +fetch+ calls #read_entry, and calls #write_entry on a cache
+      # miss. Thus, +fetch+ supports the same options as #read and #write.
+      # Additionally, +fetch+ supports the following options:
       #
-      #   Thread.new do
-      #     val_2 = cache.fetch('foo', race_condition_ttl: 10.seconds) do
-      #       'new value 2'
-      #     end
-      #   end
+      # * <tt>force: true</tt> - Forces a cache "miss," meaning we treat the
+      #   cache value as missing even if it's present. Passing a block is
+      #   required when +force+ is true so this always results in a cache write.
       #
-      #   cache.fetch('foo') # => "original value"
-      #   sleep 10 # First thread extended the life of cache by another 10 seconds
-      #   cache.fetch('foo') # => "new value 1"
-      #   val_1 # => "new value 1"
-      #   val_2 # => "original value"
+      #     cache.write('today', 'Monday')
+      #     cache.fetch('today', force: true) { 'Tuesday' } # => 'Tuesday'
+      #     cache.fetch('today', force: true) # => ArgumentError
       #
-      # Other options will be handled by the specific cache store implementation.
-      # Internally, #fetch calls #read_entry, and calls #write_entry on a cache
-      # miss. +options+ will be passed to the #read and #write calls.
+      #   The +:force+ option is useful when you're calling some other method to
+      #   ask whether you should force a cache write. Otherwise, it's clearer to
+      #   just call +write+.
       #
-      # For example, MemCacheStore's #write method supports the +:raw+
-      # option, which tells the memcached server to store all values as strings.
-      # We can use this option with #fetch too:
+      # * <tt>skip_nil: true</tt> - Prevents caching a nil result:
+      #
+      #     cache.fetch('foo') { nil }
+      #     cache.fetch('bar', skip_nil: true) { nil }
+      #     cache.exist?('foo') # => true
+      #     cache.exist?('bar') # => false
+      #
+      # * +:race_condition_ttl+ - Specifies the number of seconds during which
+      #   an expired value can be reused while a new value is being generated.
+      #   This can be used to prevent race conditions when cache entries expire,
+      #   by preventing multiple processes from simultaneously regenerating the
+      #   same entry (also known as the dog pile effect).
+      #
+      #   When a process encounters a cache entry that has expired less than
+      #   +:race_condition_ttl+ seconds ago, it will bump the expiration time by
+      #   +:race_condition_ttl+ seconds before generating a new value. During
+      #   this extended time window, while the process generates a new value,
+      #   other processes will continue to use the old value. After the first
+      #   process writes the new value, other processes will then use it.
+      #
+      #   If the first process errors out while generating a new value, another
+      #   process can try to generate a new value after the extended time window
+      #   has elapsed.
+      #
+      #     # Set all values to expire after one minute.
+      #     cache = ActiveSupport::Cache::MemoryStore.new(expires_in: 1.minute)
+      #
+      #     cache.write('foo', 'original value')
+      #     val_1 = nil
+      #     val_2 = nil
+      #     sleep 60
+      #
+      #     Thread.new do
+      #       val_1 = cache.fetch('foo', race_condition_ttl: 10.seconds) do
+      #         sleep 1
+      #         'new value 1'
+      #       end
+      #     end
+      #
+      #     Thread.new do
+      #       val_2 = cache.fetch('foo', race_condition_ttl: 10.seconds) do
+      #         'new value 2'
+      #       end
+      #     end
+      #
+      #     cache.fetch('foo') # => "original value"
+      #     sleep 10 # First thread extended the life of cache by another 10 seconds
+      #     cache.fetch('foo') # => "new value 1"
+      #     val_1 # => "new value 1"
+      #     val_2 # => "original value"
       #
-      #   cache = ActiveSupport::Cache::MemCacheStore.new
-      #   cache.fetch("foo", force: true, raw: true) do
-      #     :bar
-      #   end
-      #   cache.fetch('foo') # => "bar"
       def fetch(name, options = nil, &block)
         if block_given?
           options = merged_options(options)
@@ -357,7 +352,13 @@ module ActiveSupport
       # <tt>:version</tt> options, both of these conditions are applied before
       # the data is returned.
       #
-      # Options are passed to the underlying cache implementation.
+      # ==== Options
+      #
+      # * +:version+ - Specifies a version for the cache entry. If the cached
+      #   version does not match the requested version, the read will be treated
+      #   as a cache miss. This feature is used to support recyclable cache keys.
+      #
+      # Other options will be handled by the specific cache store implementation.
       def read(name, options = nil)
         options = merged_options(options)
         key     = normalize_key(name, options)
@@ -465,9 +466,39 @@ module ActiveSupport
         end
       end
 
-      # Writes the value to the cache, with the key.
+      # Writes the value to the cache with the key. The value must be supported
+      # by the +coder+'s +dump+ and +load+ methods.
       #
-      # Options are passed to the underlying cache implementation.
+      # By default, cache entries larger than 1kB are compressed. Compression
+      # allows more data to be stored in the same memory footprint, leading to
+      # fewer cache evictions and higher hit rates.
+      #
+      # ==== Options
+      #
+      # * <tt>compress: false</tt> - Disables compression of the cache entry.
+      #
+      # * +:compress_threshold+ - The compression threshold, specified in bytes.
+      #   \Cache entries larger than this threshold will be compressed. Defaults
+      #   to +1.kilobyte+.
+      #
+      # * +:expires_in+ - Sets a relative expiration time for the cache entry,
+      #   specified in seconds. +:expire_in+ and +:expired_in+ are aliases for
+      #   +:expires_in+.
+      #
+      #     cache = ActiveSupport::Cache::MemoryStore.new(expires_in: 5.minutes)
+      #     cache.write(key, value, expires_in: 1.minute) # Set a lower value for one entry
+      #
+      # * +:expires_at+ - Sets an absolute expiration time for the cache entry.
+      #
+      #     cache = ActiveSupport::Cache::MemoryStore.new
+      #     cache.write(key, value, expires_at: Time.now.at_end_of_hour)
+      #
+      # * +:version+ - Specifies a version for the cache entry. When reading
+      #   from the cache, if the cached version does not match the requested
+      #   version, the read will be treated as a cache miss. This feature is
+      #   used to support recyclable cache keys.
+      #
+      # Other options will be handled by the specific cache store implementation.
       def write(name, value, options = nil)
         options = merged_options(options)
 
@@ -512,6 +543,10 @@ module ActiveSupport
         end
       end
 
+      def new_entry(value, options = nil) # :nodoc:
+        Entry.new(value, **merged_options(options))
+      end
+
       # Deletes all entries with keys matching the pattern.
       #
       # Options are passed to the underlying cache implementation.
@@ -539,7 +574,7 @@ module ActiveSupport
         raise NotImplementedError.new("#{self.class.name} does not support decrement")
       end
 
-      # Cleanups the cache by removing expired entries.
+      # Cleans up the cache by removing expired entries.
       #
       # Options are passed to the underlying cache implementation.
       #
@@ -559,6 +594,10 @@ module ActiveSupport
       end
 
       private
+        def default_coder
+          Coders[Cache.format_version]
+        end
+
         # Adds the namespace defined in the options to a pattern designed to
         # match keys. Implementations that support delete_matched should call
         # this method to translate a pattern that matches names into one that
@@ -590,8 +629,13 @@ module ActiveSupport
           raise NotImplementedError.new
         end
 
-        def serialize_entry(entry)
-          @coder.dump(entry)
+        def serialize_entry(entry, **options)
+          options = merged_options(options)
+          if @coder_supports_compression && options[:compress]
+            @coder.dump_compressed(entry, options[:compress_threshold] || DEFAULT_COMPRESS_LIMIT)
+          else
+            @coder.dump(entry)
+          end
         end
 
         def deserialize_entry(payload)
@@ -640,6 +684,7 @@ module ActiveSupport
         # Merges the default options with ones specific to a method call.
         def merged_options(call_options)
           if call_options
+            call_options = normalize_options(call_options)
             if options.empty?
               call_options
             else
@@ -650,6 +695,18 @@ module ActiveSupport
           end
         end
 
+        # Normalize aliased options to their canonical form
+        def normalize_options(options)
+          options = options.dup
+          OPTION_ALIASES.each do |canonical_name, aliases|
+            alias_key = aliases.detect { |key| options.key?(key) }
+            options[canonical_name] ||= options[alias_key] if alias_key
+            options.except!(*aliases)
+          end
+
+          options
+        end
+
         # Expands and namespaces the cache key. May be overridden by
         # cache stores to do additional normalization.
         def normalize_key(key, options = nil)
@@ -732,7 +789,7 @@ module ActiveSupport
             if (race_ttl > 0) && (Time.now.to_f - entry.expires_at <= race_ttl)
               # When an entry has a positive :race_condition_ttl defined, put the stale entry back into the cache
               # for a brief period while the entry is being recalculated.
-              entry.expires_at = Time.now + race_ttl
+              entry.expires_at = Time.now.to_f + race_ttl
               write_entry(key, entry, expires_in: race_ttl * 2)
             else
               delete_entry(key, **options)
@@ -758,13 +815,93 @@ module ActiveSupport
     end
 
     module NullCoder # :nodoc:
+      extend self
+
+      def dump(entry)
+        entry
+      end
+
+      def dump_compressed(entry, threshold)
+        entry.compressed(threshold)
+      end
+
+      def load(payload)
+        payload
+      end
+    end
+
+    module Coders # :nodoc:
+      MARK_61              = "\x04\b".b.freeze # The one set by Marshal.
+      MARK_70_UNCOMPRESSED = "\x00".b.freeze
+      MARK_70_COMPRESSED   = "\x01".b.freeze
+
       class << self
+        def [](version)
+          case version
+          when 6.1
+            Rails61Coder
+          when 7.0
+            Rails70Coder
+          else
+            raise ArgumentError, "Unknown ActiveSupport::Cache.format_version: #{Cache.format_version.inspect}"
+          end
+        end
+      end
+
+      module Loader
+        extend self
+
         def load(payload)
-          payload
+          if !payload.is_a?(String)
+            ActiveSupport::Cache::Store.logger&.warn %{Payload wasn't a string, was #{payload.class.name} - couldn't unmarshal, so returning nil."}
+
+            return nil
+          elsif payload.start_with?(MARK_70_UNCOMPRESSED)
+            members = Marshal.load(payload.byteslice(1..-1))
+          elsif payload.start_with?(MARK_70_COMPRESSED)
+            members = Marshal.load(Zlib::Inflate.inflate(payload.byteslice(1..-1)))
+          elsif payload.start_with?(MARK_61)
+            return Marshal.load(payload)
+          else
+            ActiveSupport::Cache::Store.logger&.warn %{Invalid cache prefix: #{payload.byteslice(0).inspect}, expected "\\x00" or "\\x01"}
+
+            return nil
+          end
+          Entry.unpack(members)
         end
+      end
+
+      module Rails61Coder
+        include Loader
+        extend self
 
         def dump(entry)
-          entry
+          Marshal.dump(entry)
+        end
+
+        def dump_compressed(entry, threshold)
+          Marshal.dump(entry.compressed(threshold))
+        end
+      end
+
+      module Rails70Coder
+        include Loader
+        extend self
+
+        def dump(entry)
+          MARK_70_UNCOMPRESSED + Marshal.dump(entry.pack)
+        end
+
+        def dump_compressed(entry, threshold)
+          payload = Marshal.dump(entry.pack)
+          if payload.bytesize >= threshold
+            compressed_payload = Zlib::Deflate.deflate(payload)
+            if compressed_payload.bytesize < payload.bytesize
+              return MARK_70_COMPRESSED + compressed_payload
+            end
+          end
+
+          MARK_70_UNCOMPRESSED + payload
         end
       end
     end
@@ -777,19 +914,22 @@ module ActiveSupport
     # Since cache entries in most instances will be serialized, the internals of this class are highly optimized
     # using short instance variable names that are lazily defined.
     class Entry # :nodoc:
-      attr_reader :version
+      class << self
+        def unpack(members)
+          new(members[0], expires_at: members[1], version: members[2])
+        end
+      end
 
-      DEFAULT_COMPRESS_LIMIT = 1.kilobyte
+      attr_reader :version
 
       # Creates a new cache entry for the specified value. Options supported are
-      # +:compress+, +:compress_threshold+, +:version+ and +:expires_in+.
-      def initialize(value, compress: true, compress_threshold: DEFAULT_COMPRESS_LIMIT, version: nil, expires_in: nil, **)
+      # +:compressed+, +:version+, +:expires_at+ and +:expires_in+.
+      def initialize(value, compressed: false, version: nil, expires_in: nil, expires_at: nil, **)
         @value      = value
         @version    = version
-        @created_at = Time.now.to_f
-        @expires_in = expires_in && expires_in.to_f
-
-        compress!(compress_threshold) if compress
+        @created_at = 0.0
+        @expires_in = expires_at&.to_f || expires_in && (expires_in.to_f + Time.now.to_f)
+        @compressed = true if compressed
       end
 
       def value
@@ -831,6 +971,38 @@ module ActiveSupport
         end
       end
 
+      def compressed? # :nodoc:
+        defined?(@compressed)
+      end
+
+      def compressed(compress_threshold)
+        return self if compressed?
+
+        case @value
+        when nil, true, false, Numeric
+          uncompressed_size = 0
+        when String
+          uncompressed_size = @value.bytesize
+        else
+          serialized = Marshal.dump(@value)
+          uncompressed_size = serialized.bytesize
+        end
+
+        if uncompressed_size >= compress_threshold
+          serialized ||= Marshal.dump(@value)
+          compressed = Zlib::Deflate.deflate(serialized)
+
+          if compressed.bytesize < uncompressed_size
+            return Entry.new(compressed, compressed: true, expires_at: expires_at, version: version)
+          end
+        end
+        self
+      end
+
+      def local?
+        false
+      end
+
       # Duplicates the value in a class. This is used by cache implementations that don't natively
       # serialize entries to protect against accidental cache modifications.
       def dup_value!
@@ -843,33 +1015,13 @@ module ActiveSupport
         end
       end
 
-      private
-        def compress!(compress_threshold)
-          case @value
-          when nil, true, false, Numeric
-            uncompressed_size = 0
-          when String
-            uncompressed_size = @value.bytesize
-          else
-            serialized = Marshal.dump(@value)
-            uncompressed_size = serialized.bytesize
-          end
-
-          if uncompressed_size >= compress_threshold
-            serialized ||= Marshal.dump(@value)
-            compressed = Zlib::Deflate.deflate(serialized)
-
-            if compressed.bytesize < uncompressed_size
-              @value = compressed
-              @compressed = true
-            end
-          end
-        end
-
-        def compressed?
-          defined?(@compressed)
-        end
+      def pack
+        members = [value, expires_at, version]
+        members.pop while !members.empty? && members.last.nil?
+        members
+      end
 
+      private
         def uncompress(value)
           Marshal.load(Zlib::Inflate.inflate(value))
         end