activestorage 8.1.0.beta1 → 8.1.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8959531cd3a50439e1d30882ac0398b7d361da8a6859049b01c31e1a35e58862
-  data.tar.gz: c4027f992ab9f941cecbe88a7a415d52f5a3800b86e69fe8789567f320a9b9ea
+  metadata.gz: 5fdd6b9b99061ff4e07861b93dbf9136f8f38f8e424a7225fcb2ad920e26d397
+  data.tar.gz: a9187612f84e46a680fed02e26e279154a3ce93d3bba051e2f128d81a3bc0fcd
 SHA512:
-  metadata.gz: 2750ae72f60c4e388b74813b74fa2580a5ebe48887eca53905b1d1173a08bac4ff931f22fadc3fb2ffec0d96417f7661fe22aba44cdaa36e7480c7df4b0f52d0
-  data.tar.gz: 3201606c2dce4e6e41649c8aca6432dbd2c0635c966366809bc6552ad07cc074596d3d973054bce87f79f3eca9ffb68d91e116d9b8f81ac5dad7d59b8040cd5b
+  metadata.gz: '08713db028801c930b720d6ed6d498218f85d62d6b8fb4d5d209bbdbb3e193dd68cbb6969cb42cd3078c0c38d6822408b26df59076892f49a077b5442c8f84ce'
+  data.tar.gz: 8ce0d30a68bc92bf8e34b14b6d638cf03c09873b0b925a307d5a43ac3cd345cd63d0cf3d91d358652ec86593a5bf02f4a970be744cca9f6a0e20d757df4350ae

data/CHANGELOG.md

@@ -1,3 +1,40 @@
+## Rails 8.1.0.rc1 (October 15, 2025) ##
+
+*   Add structured events for Active Storage:
+    - `active_storage.service_upload`
+    - `active_storage.service_download`
+    - `active_storage.service_streaming_download`
+    - `active_storage.preview`
+    - `active_storage.service_delete`
+    - `active_storage.service_delete_prefixed`
+    - `active_storage.service_exist`
+    - `active_storage.service_url`
+    - `active_storage.service_mirror`
+
+    *Gannon McGibbon*
+
+*   Allow analyzers and variant transformer to be fully configurable
+
+    ```ruby
+    # ActiveStorage.analyzers can be set to an empty array:
+    config.active_storage.analyzers = []
+    # => ActiveStorage.analyzers = []
+
+    # or use custom analyzer:
+    config.active_storage.analyzers = [ CustomAnalyzer ]
+    # => ActiveStorage.analyzers = [ CustomAnalyzer ]
+    ```
+
+    If no configuration is provided, it will use the default analyzers.
+
+    You can also disable variant processor to remove warnings on startup about missing gems.
+
+    ```ruby
+    config.active_storage.variant_processor = :disabled
+    ```
+
+    *zzak*, *Alexandre Ruban*
+
 ## Rails 8.1.0.beta1 (September 04, 2025) ##
 
 *   Remove deprecated `:azure` storage service.
@@ -40,13 +77,6 @@
 
     *Sean Doyle*
 
-*   Add support for alternative MD5 implementation through `config.active_storage.checksum_implementation`.
-
-    Also automatically degrade to using the slower `Digest::MD5` implementation if `OpenSSL::Digest::MD5`
-    is found to be disabled because of OpenSSL FIPS mode.
-
-    *Matt Pasquini*, *Jean Boussier*
-
 *   A Blob will no longer autosave associated Attachment.
 
     This fixes an issue where a record with an attachment would have

data/app/models/active_storage/blob/representable.rb

@@ -25,8 +25,8 @@ module ActiveStorage::Blob::Representable
   #
   #   <%= image_tag Current.user.avatar.variant(resize_to_limit: [100, 100]) %>
   #
-  # This will create a URL for that specific blob with that specific variant, which the ActiveStorage::RepresentationsController
-  # can then produce on-demand.
+  # This will create a URL for that specific blob with that specific variant, which the ActiveStorage::Representations::ProxyController
+  # or ActiveStorage::Representations::RedirectController can then produce on-demand.
   #
   # Raises ActiveStorage::InvariableError if the variant processor cannot
   # transform the blob. To determine whether a blob is variable, call

data/app/models/active_storage/blob.rb

@@ -332,7 +332,7 @@ class ActiveStorage::Blob < ActiveStorage::Record
     def compute_checksum_in_chunks(io)
       raise ArgumentError, "io must be rewindable" unless io.respond_to?(:rewind)
 
-      ActiveStorage.checksum_implementation.new.tap do |checksum|
+      OpenSSL::Digest::MD5.new.tap do |checksum|
         read_buffer = "".b
         while io.read(5.megabytes, read_buffer)
           checksum << read_buffer

data/app/models/active_storage/variant.rb

@@ -22,15 +22,15 @@
 # Note that to create a variant it's necessary to download the entire blob file from the service. Because of this process,
 # you also want to be considerate about when the variant is actually processed. You shouldn't be processing variants inline
 # in a template, for example. Delay the processing to an on-demand controller, like the one provided in
-# ActiveStorage::RepresentationsController.
+# ActiveStorage::Representations::ProxyController and ActiveStorage::Representations::RedirectController.
 #
 # To refer to such a delayed on-demand variant, simply link to the variant through the resolved route provided
 # by Active Storage like so:
 #
 #   <%= image_tag Current.user.avatar.variant(resize_to_limit: [100, 100]) %>
 #
-# This will create a URL for that specific blob with that specific variant, which the ActiveStorage::RepresentationsController
-# can then produce on-demand.
+# This will create a URL for that specific blob with that specific variant, which the ActiveStorage::Representations::ProxyController
+# or ActiveStorage::Representations::RedirectController can then produce on-demand.
 #
 # When you do want to actually produce the variant needed, call +processed+. This will check that the variant
 # has already been processed and uploaded to the service, and, if so, just return that. Otherwise it will perform
@@ -77,8 +77,8 @@ class ActiveStorage::Variant
   # Returns the URL of the blob variant on the service. See ActiveStorage::Blob#url for details.
   #
   # Use <tt>url_for(variant)</tt> (or the implied form, like <tt>link_to variant</tt> or <tt>redirect_to variant</tt>) to get the stable URL
-  # for a variant that points to the ActiveStorage::RepresentationsController, which in turn will use this +service_call+ method
-  # for its redirection.
+  # for a variant that points to the ActiveStorage::Representations::ProxyController or ActiveStorage::Representations::RedirectController,
+  # which in turn will use this +service_call+ method for its redirection.
   def url(expires_in: ActiveStorage.service_urls_expire_in, disposition: :inline)
     service.url key, expires_in: expires_in, disposition: disposition, filename: filename, content_type: content_type
   end

data/lib/active_storage/analyzer/image_analyzer/image_magick.rb

@@ -3,7 +3,9 @@
 begin
   gem "mini_magick"
   require "mini_magick"
+  ActiveStorage::MINIMAGICK_AVAILABLE = true # :nodoc:
 rescue LoadError => error
+  ActiveStorage::MINIMAGICK_AVAILABLE = false # :nodoc:
   raise error unless error.message.include?("mini_magick")
 end
 
@@ -11,8 +13,17 @@ module ActiveStorage
   # This analyzer relies on the third-party {MiniMagick}[https://github.com/minimagick/minimagick] gem. MiniMagick requires
   # the {ImageMagick}[http://www.imagemagick.org] system library.
   class Analyzer::ImageAnalyzer::ImageMagick < Analyzer::ImageAnalyzer
+    def self.accept?(blob)
+      super && ActiveStorage.variant_processor == :mini_magick
+    end
+
     private
       def read_image
+        unless MINIMAGICK_AVAILABLE
+          logger.error "Skipping image analysis because the mini_magick gem isn't installed"
+          return {}
+        end
+
         download_blob_to_tempfile do |file|
           image = instrument("mini_magick") do
             MiniMagick::Image.new(file.path)

data/lib/active_storage/analyzer/image_analyzer/vips.rb

@@ -1,18 +1,37 @@
 # frozen_string_literal: true
 
+begin
+  require "nokogiri"
+rescue LoadError
+  # Ensure nokogiri is loaded before vips, which also depends on libxml2.
+  # See Nokogiri RFC: Stop exporting symbols:
+  #   https://github.com/sparklemotion/nokogiri/discussions/2746
+end
+
 begin
   gem "ruby-vips"
   require "ruby-vips"
+  ActiveStorage::VIPS_AVAILABLE = true # :nodoc:
 rescue LoadError => error
-  raise error unless error.message.include?("ruby-vips")
+  ActiveStorage::VIPS_AVAILABLE = false # :nodoc:
+  raise error unless error.message.match?(/libvips|ruby-vips/)
 end
 
 module ActiveStorage
   # This analyzer relies on the third-party {ruby-vips}[https://github.com/libvips/ruby-vips] gem. Ruby-vips requires
   # the {libvips}[https://libvips.github.io/libvips/] system library.
   class Analyzer::ImageAnalyzer::Vips < Analyzer::ImageAnalyzer
+    def self.accept?(blob)
+      super && ActiveStorage.variant_processor == :vips
+    end
+
     private
       def read_image
+        unless VIPS_AVAILABLE
+          logger.error "Skipping image analysis because the ruby-vips gem isn't installed"
+          return {}
+        end
+
         download_blob_to_tempfile do |file|
           image = instrument("vips") do
             # ruby-vips will raise Vips::Error if it can't find an appropriate loader for the file

data/lib/active_storage/downloader.rb

@@ -35,7 +35,7 @@ module ActiveStorage
       end
 
       def verify_integrity_of(file, checksum:)
-        unless ActiveStorage.checksum_implementation.file(file).base64digest == checksum
+        unless OpenSSL::Digest::MD5.file(file).base64digest == checksum
           raise ActiveStorage::IntegrityError
         end
       end

data/lib/active_storage/engine.rb

@@ -25,7 +25,7 @@ module ActiveStorage
 
     config.active_storage = ActiveSupport::OrderedOptions.new
     config.active_storage.previewers = [ ActiveStorage::Previewer::PopplerPDFPreviewer, ActiveStorage::Previewer::MuPDFPreviewer, ActiveStorage::Previewer::VideoPreviewer ]
-    config.active_storage.analyzers = [ ActiveStorage::Analyzer::VideoAnalyzer, ActiveStorage::Analyzer::AudioAnalyzer ]
+    config.active_storage.analyzers = [ ActiveStorage::Analyzer::ImageAnalyzer::Vips, ActiveStorage::Analyzer::ImageAnalyzer::ImageMagick, ActiveStorage::Analyzer::VideoAnalyzer, ActiveStorage::Analyzer::AudioAnalyzer ]
     config.active_storage.paths = ActiveSupport::OrderedOptions.new
     config.active_storage.queues = ActiveSupport::InheritableOptions.new
     config.active_storage.precompile_assets = true
@@ -88,26 +88,20 @@ module ActiveStorage
 
       config.after_initialize do |app|
         ActiveStorage.logger            = app.config.active_storage.logger || Rails.logger
-        ActiveStorage.variant_processor = app.config.active_storage.variant_processor
+        ActiveStorage.variant_processor = app.config.active_storage.variant_processor || :mini_magick
         ActiveStorage.previewers        = app.config.active_storage.previewers || []
+        ActiveStorage.analyzers         = app.config.active_storage.analyzers || []
 
         begin
-          analyzer, transformer =
+          ActiveStorage.variant_transformer =
             case ActiveStorage.variant_processor
+            when :disabled
+              ActiveStorage::Transformers::NullTransformer
             when :vips
-              [
-                ActiveStorage::Analyzer::ImageAnalyzer::Vips,
-                ActiveStorage::Transformers::Vips
-              ]
+              ActiveStorage::Transformers::Vips
             when :mini_magick
-              [
-                ActiveStorage::Analyzer::ImageAnalyzer::ImageMagick,
-                ActiveStorage::Transformers::ImageMagick
-              ]
+              ActiveStorage::Transformers::ImageMagick
             end
-
-          ActiveStorage.analyzers = [analyzer].compact.concat(app.config.active_storage.analyzers || [])
-          ActiveStorage.variant_transformer = transformer
         rescue LoadError => error
           case error.message
           when /libvips/
@@ -118,7 +112,8 @@ module ActiveStorage
           when /image_processing/
             ActiveStorage.logger.warn <<~WARNING.squish
               Generating image variants require the image_processing gem.
-              Please add `gem 'image_processing', '~> 1.2'` to your Gemfile.
+              Please add `gem "image_processing", "~> 1.2"` to your Gemfile
+              or set `config.active_storage.variant_processor = :disabled`.
             WARNING
           else
             raise
@@ -154,9 +149,6 @@ module ActiveStorage
         ActiveStorage.binary_content_type = app.config.active_storage.binary_content_type || "application/octet-stream"
         ActiveStorage.video_preview_arguments = app.config.active_storage.video_preview_arguments || "-y -vframes 1 -f image2"
         ActiveStorage.track_variants = app.config.active_storage.track_variants || false
-        if app.config.active_storage.checksum_implementation
-          ActiveStorage.checksum_implementation = app.config.active_storage.checksum_implementation
-        end
       end
     end
 

data/lib/active_storage/gem_version.rb

@@ -10,7 +10,7 @@ module ActiveStorage
     MAJOR = 8
     MINOR = 1
     TINY  = 0
-    PRE   = "beta1"
+    PRE   = "rc1"
 
     STRING = [MAJOR, MINOR, TINY, PRE].compact.join(".")
   end

data/lib/active_storage/log_subscriber.rb

@@ -3,7 +3,7 @@
 require "active_support/log_subscriber"
 
 module ActiveStorage
-  class LogSubscriber < ActiveSupport::LogSubscriber
+  class LogSubscriber < ActiveSupport::LogSubscriber # :nodoc:
     def service_upload(event)
       message = "Uploaded file to key: #{key_in(event)}"
       message += " (checksum: #{event.payload[:checksum]})" if event.payload[:checksum]

data/lib/active_storage/service/disk_service.rb

@@ -161,7 +161,7 @@ module ActiveStorage
       end
 
       def ensure_integrity_of(key, checksum)
-        unless ActiveStorage.checksum_implementation.file(path_for(key)).base64digest == checksum
+        unless OpenSSL::Digest::MD5.file(path_for(key)).base64digest == checksum
           delete key
           raise ActiveStorage::IntegrityError
         end

data/lib/active_storage/service.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "active_storage/log_subscriber"
+require "active_storage/structured_event_subscriber"
 require "active_storage/downloader"
 require "action_dispatch"
 require "action_dispatch/http/content_disposition"

data/lib/active_storage/structured_event_subscriber.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+require "active_support/structured_event_subscriber"
+
+module ActiveStorage
+  class StructuredEventSubscriber < ActiveSupport::StructuredEventSubscriber # :nodoc:
+    def service_upload(event)
+      emit_event("active_storage.service_upload",
+        key: event.payload[:key],
+        checksum: event.payload[:checksum],
+        duration_ms: event.duration.round(2),
+      )
+    end
+
+    def service_download(event)
+      emit_event("active_storage.service_download",
+        key: event.payload[:key],
+        duration_ms: event.duration.round(2),
+      )
+    end
+
+    def service_streaming_download(event)
+      emit_event("active_storage.service_streaming_download",
+        key: event.payload[:key],
+        duration_ms: event.duration.round(2),
+      )
+    end
+
+    def preview(event)
+      emit_event("active_storage.preview",
+        key: event.payload[:key],
+        duration_ms: event.duration.round(2),
+      )
+    end
+
+    def service_delete(event)
+      emit_event("active_storage.service_delete",
+        key: event.payload[:key],
+        duration_ms: event.duration.round(2),
+      )
+    end
+
+    def service_delete_prefixed(event)
+      emit_event("active_storage.service_delete_prefixed",
+        prefix: event.payload[:prefix],
+        duration_ms: event.duration.round(2),
+      )
+    end
+
+    def service_exist(event)
+      emit_debug_event("active_storage.service_exist",
+        key: event.payload[:key],
+        exist: event.payload[:exist],
+        duration_ms: event.duration.round(2),
+      )
+    end
+    debug_only :service_exist
+
+    def service_url(event)
+      emit_debug_event("active_storage.service_url",
+        key: event.payload[:key],
+        url: event.payload[:url],
+        duration_ms: event.duration.round(2),
+      )
+    end
+    debug_only :service_url
+
+    def service_mirror(event)
+      emit_debug_event("active_storage.service_mirror",
+        key: event.payload[:key],
+        checksum: event.payload[:checksum],
+        duration_ms: event.duration.round(2),
+      )
+    end
+    debug_only :service_mirror
+  end
+end
+
+ActiveStorage::StructuredEventSubscriber.attach_to :active_storage

data/lib/active_storage/transformers/null_transformer.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module ActiveStorage
+  module Transformers
+    class NullTransformer < Transformer # :nodoc:
+      private
+        def process(file, format:)
+          file
+        end
+    end
+  end
+end

data/lib/active_storage.rb

@@ -362,21 +362,13 @@ module ActiveStorage
 
   mattr_accessor :track_variants, default: false
 
-  singleton_class.attr_accessor :checksum_implementation
-  @checksum_implementation = OpenSSL::Digest::MD5
-  begin
-    @checksum_implementation.hexdigest("test")
-  rescue # OpenSSL may have MD5 disabled
-    require "digest/md5"
-    @checksum_implementation = Digest::MD5
-  end
-
   mattr_accessor :video_preview_arguments, default: "-y -vframes 1 -f image2"
 
   module Transformers
     extend ActiveSupport::Autoload
 
     autoload :Transformer
+    autoload :NullTransformer
     autoload :ImageProcessingTransformer
     autoload :Vips
     autoload :ImageMagick

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: activestorage
 version: !ruby/object:Gem::Version
-  version: 8.1.0.beta1
+  version: 8.1.0.rc1
 platform: ruby
 authors:
 - David Heinemeier Hansson
@@ -15,56 +15,56 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 8.1.0.beta1
+        version: 8.1.0.rc1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 8.1.0.beta1
+        version: 8.1.0.rc1
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 8.1.0.beta1
+        version: 8.1.0.rc1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 8.1.0.beta1
+        version: 8.1.0.rc1
 - !ruby/object:Gem::Dependency
   name: activejob
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 8.1.0.beta1
+        version: 8.1.0.rc1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 8.1.0.beta1
+        version: 8.1.0.rc1
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 8.1.0.beta1
+        version: 8.1.0.rc1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 8.1.0.beta1
+        version: 8.1.0.rc1
 - !ruby/object:Gem::Dependency
   name: marcel
   requirement: !ruby/object:Gem::Requirement
@@ -179,8 +179,10 @@ files:
 - lib/active_storage/service/mirror_service.rb
 - lib/active_storage/service/registry.rb
 - lib/active_storage/service/s3_service.rb
+- lib/active_storage/structured_event_subscriber.rb
 - lib/active_storage/transformers/image_magick.rb
 - lib/active_storage/transformers/image_processing_transformer.rb
+- lib/active_storage/transformers/null_transformer.rb
 - lib/active_storage/transformers/transformer.rb
 - lib/active_storage/transformers/vips.rb
 - lib/active_storage/version.rb
@@ -190,10 +192,10 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/rails/rails/issues
-  changelog_uri: https://github.com/rails/rails/blob/v8.1.0.beta1/activestorage/CHANGELOG.md
-  documentation_uri: https://api.rubyonrails.org/v8.1.0.beta1/
+  changelog_uri: https://github.com/rails/rails/blob/v8.1.0.rc1/activestorage/CHANGELOG.md
+  documentation_uri: https://api.rubyonrails.org/v8.1.0.rc1/
   mailing_list_uri: https://discuss.rubyonrails.org/c/rubyonrails-talk
-  source_code_uri: https://github.com/rails/rails/tree/v8.1.0.beta1/activestorage
+  source_code_uri: https://github.com/rails/rails/tree/v8.1.0.rc1/activestorage
   rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths: