activestorage 6.0.6.1 → 6.1.7.3

data/lib/active_storage/gem_version.rb

@@ -8,9 +8,9 @@ module ActiveStorage
 
   module VERSION
     MAJOR = 6
-    MINOR = 0
-    TINY  = 6
-    PRE   = "1"
+    MINOR = 1
+    TINY  = 7
+    PRE   = "3"
 
     STRING = [MAJOR, MINOR, TINY, PRE].compact.join(".")
   end

data/lib/active_storage/log_subscriber.rb

@@ -32,6 +32,12 @@ module ActiveStorage
       debug event, color("Generated URL for file at key: #{key_in(event)} (#{event.payload[:url]})", BLUE)
     end
 
+    def service_mirror(event)
+      message = "Mirrored file at key: #{key_in(event)}"
+      message += " (checksum: #{event.payload[:checksum]})" if event.payload[:checksum]
+      debug event, color(message, GREEN)
+    end
+
     def logger
       ActiveStorage.logger
     end

data/lib/active_storage/previewer/mupdf_previewer.rb

@@ -12,7 +12,7 @@ module ActiveStorage
       end
 
       def mutool_exists?
-        return @mutool_exists unless @mutool_exists.nil?
+        return @mutool_exists if defined?(@mutool_exists) && !@mutool_exists.nil?
 
         system mutool_path, out: File::NULL, err: File::NULL
 
@@ -20,10 +20,10 @@ module ActiveStorage
       end
     end
 
-    def preview
+    def preview(**options)
       download_blob_to_tempfile do |input|
         draw_first_page_from input do |output|
-          yield io: output, filename: "#{blob.filename.base}.png", content_type: "image/png"
+          yield io: output, filename: "#{blob.filename.base}.png", content_type: "image/png", **options
         end
       end
     end

data/lib/active_storage/previewer/poppler_pdf_previewer.rb

@@ -18,10 +18,10 @@ module ActiveStorage
       end
     end
 
-    def preview
+    def preview(**options)
       download_blob_to_tempfile do |input|
         draw_first_page_from input do |output|
-          yield io: output, filename: "#{blob.filename.base}.png", content_type: "image/png"
+          yield io: output, filename: "#{blob.filename.base}.png", content_type: "image/png", **options
         end
       end
     end

data/lib/active_storage/previewer/video_previewer.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "shellwords"
+
 module ActiveStorage
   class Previewer::VideoPreviewer < Previewer
     class << self
@@ -18,17 +20,17 @@ module ActiveStorage
       end
     end
 
-    def preview
+    def preview(**options)
       download_blob_to_tempfile do |input|
         draw_relevant_frame_from input do |output|
-          yield io: output, filename: "#{blob.filename.base}.jpg", content_type: "image/jpeg"
+          yield io: output, filename: "#{blob.filename.base}.jpg", content_type: "image/jpeg", **options
         end
       end
     end
 
     private
       def draw_relevant_frame_from(file, &block)
-        draw self.class.ffmpeg_path, "-i", file.path, "-y", "-vframes", "1", "-f", "image2", "-", &block
+        draw self.class.ffmpeg_path, "-i", file.path, *Shellwords.split(ActiveStorage.video_preview_arguments), "-", &block
       end
   end
 end

data/lib/active_storage/previewer.rb

@@ -18,8 +18,9 @@ module ActiveStorage
     end
 
     # Override this method in a concrete subclass. Have it yield an attachable preview image (i.e.
-    # anything accepted by ActiveStorage::Attached::One#attach).
-    def preview
+    # anything accepted by ActiveStorage::Attached::One#attach). Pass the additional options to
+    # the underlying blob that is created.
+    def preview(**options)
       raise NotImplementedError
     end
 
@@ -69,7 +70,16 @@ module ActiveStorage
 
       def capture(*argv, to:)
         to.binmode
-        IO.popen(argv, err: File::NULL) { |out| IO.copy_stream(out, to) }
+
+        open_tempfile do |err|
+          IO.popen(argv, err: err) { |out| IO.copy_stream(out, to) }
+          err.rewind
+
+          unless $?.success?
+            raise PreviewError, "#{argv.first} failed (status #{$?.exitstatus}): #{err.read.to_s.chomp}"
+          end
+        end
+
         to.rewind
       end
 

data/lib/active_storage/service/azure_storage_service.rb

@@ -1,26 +1,30 @@
 # frozen_string_literal: true
 
+gem "azure-storage-blob", ">= 1.1"
+
 require "active_support/core_ext/numeric/bytes"
-require "azure/storage"
-require "azure/storage/core/auth/shared_access_signature"
+require "azure/storage/blob"
+require "azure/storage/common/core/auth/shared_access_signature"
 
 module ActiveStorage
   # Wraps the Microsoft Azure Storage Blob Service as an Active Storage service.
   # See ActiveStorage::Service for the generic API documentation that applies to all services.
   class Service::AzureStorageService < Service
-    attr_reader :client, :blobs, :container, :signer
+    attr_reader :client, :container, :signer
 
-    def initialize(storage_account_name:, storage_access_key:, container:, **options)
-      @client = Azure::Storage::Client.create(storage_account_name: storage_account_name, storage_access_key: storage_access_key, **options)
-      @signer = Azure::Storage::Core::Auth::SharedAccessSignature.new(storage_account_name, storage_access_key)
-      @blobs = client.blob_client
+    def initialize(storage_account_name:, storage_access_key:, container:, public: false, **options)
+      @client = Azure::Storage::Blob::BlobService.create(storage_account_name: storage_account_name, storage_access_key: storage_access_key, **options)
+      @signer = Azure::Storage::Common::Core::Auth::SharedAccessSignature.new(storage_account_name, storage_access_key)
       @container = container
+      @public = public
     end
 
-    def upload(key, io, checksum: nil, **)
+    def upload(key, io, checksum: nil, filename: nil, content_type: nil, disposition: nil, **)
       instrument :upload, key: key, checksum: checksum do
         handle_errors do
-          blobs.create_block_blob(container, key, IO.try_convert(io) || io, content_md5: checksum)
+          content_disposition = content_disposition_with(filename: filename, type: disposition) if disposition && filename
+
+          client.create_block_blob(container, key, IO.try_convert(io) || io, content_md5: checksum, content_type: content_type, content_disposition: content_disposition)
         end
       end
     end
@@ -33,7 +37,7 @@ module ActiveStorage
       else
         instrument :download, key: key do
           handle_errors do
-            _, io = blobs.get_blob(container, key)
+            _, io = client.get_blob(container, key)
             io.force_encoding(Encoding::BINARY)
           end
         end
@@ -43,7 +47,7 @@ module ActiveStorage
     def download_chunk(key, range)
       instrument :download_chunk, key: key, range: range do
         handle_errors do
-          _, io = blobs.get_blob(container, key, start_range: range.begin, end_range: range.exclude_end? ? range.end - 1 : range.end)
+          _, io = client.get_blob(container, key, start_range: range.begin, end_range: range.exclude_end? ? range.end - 1 : range.end)
           io.force_encoding(Encoding::BINARY)
         end
       end
@@ -51,7 +55,7 @@ module ActiveStorage
 
     def delete(key)
       instrument :delete, key: key do
-        blobs.delete_blob(container, key)
+        client.delete_blob(container, key)
       rescue Azure::Core::Http::HTTPError => e
         raise unless e.type == "BlobNotFound"
         # Ignore files already deleted
@@ -63,10 +67,10 @@ module ActiveStorage
         marker = nil
 
         loop do
-          results = blobs.list_blobs(container, prefix: prefix, marker: marker)
+          results = client.list_blobs(container, prefix: prefix, marker: marker)
 
           results.each do |blob|
-            blobs.delete_blob(container, blob.name)
+            client.delete_blob(container, blob.name)
           end
 
           break unless marker = results.continuation_token.presence
@@ -82,15 +86,13 @@ module ActiveStorage
       end
     end
 
-    def url(key, expires_in:, filename:, disposition:, content_type:)
+    def url_for_direct_upload(key, expires_in:, content_type:, content_length:, checksum:)
       instrument :url, key: key do |payload|
         generated_url = signer.signed_uri(
           uri_for(key), false,
           service: "b",
-          permissions: "r",
-          expiry: format_expiry(expires_in),
-          content_disposition: content_disposition_with(type: disposition, filename: filename),
-          content_type: content_type
+          permissions: "rw",
+          expiry: format_expiry(expires_in)
         ).to_s
 
         payload[:url] = generated_url
@@ -99,32 +101,35 @@ module ActiveStorage
       end
     end
 
-    def url_for_direct_upload(key, expires_in:, content_type:, content_length:, checksum:)
-      instrument :url, key: key do |payload|
-        generated_url = signer.signed_uri(
+    def headers_for_direct_upload(key, content_type:, checksum:, filename: nil, disposition: nil, **)
+      content_disposition = content_disposition_with(type: disposition, filename: filename) if filename
+
+      { "Content-Type" => content_type, "Content-MD5" => checksum, "x-ms-blob-content-disposition" => content_disposition, "x-ms-blob-type" => "BlockBlob" }
+    end
+
+    private
+      def private_url(key, expires_in:, filename:, disposition:, content_type:, **)
+        signer.signed_uri(
           uri_for(key), false,
           service: "b",
-          permissions: "rw",
-          expiry: format_expiry(expires_in)
+          permissions: "r",
+          expiry: format_expiry(expires_in),
+          content_disposition: content_disposition_with(type: disposition, filename: filename),
+          content_type: content_type
         ).to_s
+      end
 
-        payload[:url] = generated_url
-
-        generated_url
+      def public_url(key, **)
+        uri_for(key).to_s
       end
-    end
 
-    def headers_for_direct_upload(key, content_type:, checksum:, **)
-      { "Content-Type" => content_type, "Content-MD5" => checksum, "x-ms-blob-type" => "BlockBlob" }
-    end
 
-    private
       def uri_for(key)
-        blobs.generate_uri("#{container}/#{key}")
+        client.generate_uri("#{container}/#{key}")
       end
 
       def blob_for(key)
-        blobs.get_blob_properties(container, key)
+        client.get_blob_properties(container, key)
       rescue Azure::Core::Http::HTTPError
         false
       end
@@ -143,7 +148,7 @@ module ActiveStorage
         raise ActiveStorage::FileNotFoundError unless blob.present?
 
         while offset < blob.properties[:content_length]
-          _, chunk = blobs.get_blob(container, key, start_range: offset, end_range: offset + chunk_size - 1)
+          _, chunk = client.get_blob(container, key, start_range: offset, end_range: offset + chunk_size - 1)
           yield chunk.force_encoding(Encoding::BINARY)
           offset += chunk_size
         end

data/lib/active_storage/service/configurator.rb

@@ -14,7 +14,9 @@ module ActiveStorage
 
     def build(service_name)
       config = config_for(service_name.to_sym)
-      resolve(config.fetch(:service)).build(**config, configurator: self)
+      resolve(config.fetch(:service)).build(
+        **config, configurator: self, name: service_name
+      )
     end
 
     private

data/lib/active_storage/service/disk_service.rb

@@ -11,8 +11,9 @@ module ActiveStorage
   class Service::DiskService < Service
     attr_reader :root
 
-    def initialize(root:)
+    def initialize(root:, public: false, **options)
       @root = root
+      @public = public
     end
 
     def upload(key, io, checksum: nil, **)
@@ -71,35 +72,6 @@ module ActiveStorage
       end
     end
 
-    def url(key, expires_in:, filename:, disposition:, content_type:)
-      instrument :url, key: key do |payload|
-        content_disposition = content_disposition_with(type: disposition, filename: filename)
-        verified_key_with_expiration = ActiveStorage.verifier.generate(
-          {
-            key: key,
-            disposition: content_disposition,
-            content_type: content_type
-          },
-          expires_in: expires_in,
-          purpose: :blob_key
-        )
-
-        current_uri = URI.parse(current_host)
-
-        generated_url = url_helpers.rails_disk_service_url(verified_key_with_expiration,
-          protocol: current_uri.scheme,
-          host: current_uri.host,
-          port: current_uri.port,
-          disposition: content_disposition,
-          content_type: content_type,
-          filename: filename
-        )
-        payload[:url] = generated_url
-
-        generated_url
-      end
-    end
-
     def url_for_direct_upload(key, expires_in:, content_type:, content_length:, checksum:)
       instrument :url, key: key do |payload|
         verified_token_with_expiration = ActiveStorage.verifier.generate(
@@ -107,7 +79,8 @@ module ActiveStorage
             key: key,
             content_type: content_type,
             content_length: content_length,
-            checksum: checksum
+            checksum: checksum,
+            service_name: name
           },
           expires_in: expires_in,
           purpose: :blob_token
@@ -130,6 +103,38 @@ module ActiveStorage
     end
 
     private
+      def private_url(key, expires_in:, filename:, content_type:, disposition:, **)
+        generate_url(key, expires_in: expires_in, filename: filename, content_type: content_type, disposition: disposition)
+      end
+
+      def public_url(key, filename:, content_type: nil, disposition: :attachment, **)
+        generate_url(key, expires_in: nil, filename: filename, content_type: content_type, disposition: disposition)
+      end
+
+      def generate_url(key, expires_in:, filename:, content_type:, disposition:)
+        content_disposition = content_disposition_with(type: disposition, filename: filename)
+        verified_key_with_expiration = ActiveStorage.verifier.generate(
+          {
+            key: key,
+            disposition: content_disposition,
+            content_type: content_type,
+            service_name: name
+          },
+          expires_in: expires_in,
+          purpose: :blob_key
+        )
+
+        current_uri = URI.parse(current_host)
+
+        url_helpers.rails_disk_service_url(verified_key_with_expiration,
+          protocol: current_uri.scheme,
+          host: current_uri.host,
+          port: current_uri.port,
+          filename: filename
+        )
+      end
+
+
       def stream(key)
         File.open(path_for(key), "rb") do |file|
           while data = file.read(5.megabytes)

data/lib/active_storage/service/gcs_service.rb

@@ -7,8 +7,9 @@ module ActiveStorage
   # Wraps the Google Cloud Storage as an Active Storage service. See ActiveStorage::Service for the generic API
   # documentation that applies to all services.
   class Service::GCSService < Service
-    def initialize(**config)
+    def initialize(public: false, **config)
       @config = config
+      @public = public
     end
 
     def upload(key, io, checksum: nil, content_type: nil, disposition: nil, filename: nil)
@@ -81,19 +82,6 @@ module ActiveStorage
       end
     end
 
-    def url(key, expires_in:, filename:, content_type:, disposition:)
-      instrument :url, key: key do |payload|
-        generated_url = file_for(key).signed_url expires: expires_in, query: {
-          "response-content-disposition" => content_disposition_with(type: disposition, filename: filename),
-          "response-content-type" => content_type
-        }
-
-        payload[:url] = generated_url
-
-        generated_url
-      end
-    end
-
     def url_for_direct_upload(key, expires_in:, checksum:, **)
       instrument :url, key: key do |payload|
         generated_url = bucket.signed_url key, method: "PUT", expires: expires_in, content_md5: checksum
@@ -104,11 +92,25 @@ module ActiveStorage
       end
     end
 
-    def headers_for_direct_upload(key, checksum:, **)
-      { "Content-MD5" => checksum }
+    def headers_for_direct_upload(key, checksum:, filename: nil, disposition: nil, **)
+      content_disposition = content_disposition_with(type: disposition, filename: filename) if filename
+
+      { "Content-MD5" => checksum, "Content-Disposition" => content_disposition }
     end
 
     private
+      def private_url(key, expires_in:, filename:, content_type:, disposition:, **)
+        file_for(key).signed_url expires: expires_in, query: {
+          "response-content-disposition" => content_disposition_with(type: disposition, filename: filename),
+          "response-content-type" => content_type
+        }
+      end
+
+      def public_url(key, **)
+        file_for(key).public_url
+      end
+
+
       attr_reader :config
 
       def file_for(key, skip_lookup: true)

data/lib/active_storage/service/mirror_service.rb

@@ -4,18 +4,26 @@ require "active_support/core_ext/module/delegation"
 
 module ActiveStorage
   # Wraps a set of mirror services and provides a single ActiveStorage::Service object that will all
-  # have the files uploaded to them. A +primary+ service is designated to answer calls to +download+, +exists?+,
-  # and +url+.
+  # have the files uploaded to them. A +primary+ service is designated to answer calls to:
+  # * +download+
+  # * +exists?+
+  # * +url+
+  # * +url_for_direct_upload+
+  # * +headers_for_direct_upload+
   class Service::MirrorService < Service
     attr_reader :primary, :mirrors
 
-    delegate :download, :download_chunk, :exist?, :url, :path_for, to: :primary
+    delegate :download, :download_chunk, :exist?, :url,
+      :url_for_direct_upload, :headers_for_direct_upload, :path_for, to: :primary
 
     # Stitch together from named services.
-    def self.build(primary:, mirrors:, configurator:, **options) #:nodoc:
-      new \
+    def self.build(primary:, mirrors:, name:, configurator:, **options) #:nodoc:
+      new(
         primary: configurator.build(primary),
-        mirrors: mirrors.collect { |name| configurator.build name }
+        mirrors: mirrors.collect { |mirror_name| configurator.build mirror_name }
+      ).tap do |service_instance|
+        service_instance.name = name
+      end
     end
 
     def initialize(primary:, mirrors:)
@@ -26,7 +34,8 @@ module ActiveStorage
     # ensure a match when the upload has completed or raise an ActiveStorage::IntegrityError.
     def upload(key, io, checksum: nil, **options)
       each_service.collect do |service|
-        service.upload key, io.tap(&:rewind), checksum: checksum, **options
+        io.rewind
+        service.upload key, io, checksum: checksum, **options
       end
     end
 
@@ -40,6 +49,21 @@ module ActiveStorage
       perform_across_services :delete_prefixed, prefix
     end
 
+
+    # Copy the file at the +key+ from the primary service to each of the mirrors where it doesn't already exist.
+    def mirror(key, checksum:)
+      instrument :mirror, key: key, checksum: checksum do
+        if (mirrors_in_need_of_mirroring = mirrors.select { |service| !service.exist?(key) }).any?
+          primary.open(key, checksum: checksum) do |io|
+            mirrors_in_need_of_mirroring.each do |service|
+              io.rewind
+              service.upload key, io, checksum: checksum
+            end
+          end
+        end
+      end
+    end
+
     private
       def each_service(&block)
         [ primary, *mirrors ].each(&block)

data/lib/active_storage/service/registry.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module ActiveStorage
+  class Service::Registry #:nodoc:
+    def initialize(configurations)
+      @configurations = configurations.deep_symbolize_keys
+      @services = {}
+    end
+
+    def fetch(name)
+      services.fetch(name.to_sym) do |key|
+        if configurations.include?(key)
+          services[key] = configurator.build(key)
+        else
+          if block_given?
+            yield key
+          else
+            raise KeyError, "Missing configuration for the #{key} Active Storage service. " \
+              "Configurations available for the #{configurations.keys.to_sentence} services."
+          end
+        end
+      end
+    end
+
+    private
+      attr_reader :configurations, :services
+
+      def configurator
+        @configurator ||= ActiveStorage::Service::Configurator.new(configurations)
+      end
+  end
+end

data/lib/active_storage/service/s3_service.rb

@@ -9,20 +9,29 @@ module ActiveStorage
   # Wraps the Amazon Simple Storage Service (S3) as an Active Storage service.
   # See ActiveStorage::Service for the generic API documentation that applies to all services.
   class Service::S3Service < Service
-    attr_reader :client, :bucket, :upload_options
+    attr_reader :client, :bucket
+    attr_reader :multipart_upload_threshold, :upload_options
 
-    def initialize(bucket:, upload: {}, **options)
+    def initialize(bucket:, upload: {}, public: false, **options)
       @client = Aws::S3::Resource.new(**options)
       @bucket = @client.bucket(bucket)
 
+      @multipart_upload_threshold = upload.delete(:multipart_threshold) || 100.megabytes
+      @public = public
+
       @upload_options = upload
+      @upload_options[:acl] = "public-read" if public?
     end
 
-    def upload(key, io, checksum: nil, content_type: nil, **)
+    def upload(key, io, checksum: nil, filename: nil, content_type: nil, disposition: nil, **)
       instrument :upload, key: key, checksum: checksum do
-        object_for(key).put(upload_options.merge(body: io, content_md5: checksum, content_type: content_type))
-      rescue Aws::S3::Errors::BadDigest
-        raise ActiveStorage::IntegrityError
+        content_disposition = content_disposition_with(filename: filename, type: disposition) if disposition && filename
+
+        if io.size < multipart_upload_threshold
+          upload_with_single_part key, io, checksum: checksum, content_type: content_type, content_disposition: content_disposition
+        else
+          upload_with_multipart key, io, content_type: content_type, content_disposition: content_disposition
+        end
       end
     end
 
@@ -42,7 +51,7 @@ module ActiveStorage
 
     def download_chunk(key, range)
       instrument :download_chunk, key: key, range: range do
-        object_for(key).get(range: "bytes=#{range.begin}-#{range.exclude_end? ? range.end - 1 : range.end}").body.read.force_encoding(Encoding::BINARY)
+        object_for(key).get(range: "bytes=#{range.begin}-#{range.exclude_end? ? range.end - 1 : range.end}").body.string.force_encoding(Encoding::BINARY)
       rescue Aws::S3::Errors::NoSuchKey
         raise ActiveStorage::FileNotFoundError
       end
@@ -68,23 +77,11 @@ module ActiveStorage
       end
     end
 
-    def url(key, expires_in:, filename:, disposition:, content_type:)
-      instrument :url, key: key do |payload|
-        generated_url = object_for(key).presigned_url :get, expires_in: expires_in.to_i,
-          response_content_disposition: content_disposition_with(type: disposition, filename: filename),
-          response_content_type: content_type
-
-        payload[:url] = generated_url
-
-        generated_url
-      end
-    end
-
     def url_for_direct_upload(key, expires_in:, content_type:, content_length:, checksum:)
       instrument :url, key: key do |payload|
         generated_url = object_for(key).presigned_url :put, expires_in: expires_in.to_i,
           content_type: content_type, content_length: content_length, content_md5: checksum,
-          whitelist_headers: ['content-length']
+          whitelist_headers: ["content-length"], **upload_options
 
         payload[:url] = generated_url
 
@@ -92,11 +89,42 @@ module ActiveStorage
       end
     end
 
-    def headers_for_direct_upload(key, content_type:, checksum:, **)
-      { "Content-Type" => content_type, "Content-MD5" => checksum }
+    def headers_for_direct_upload(key, content_type:, checksum:, filename: nil, disposition: nil, **)
+      content_disposition = content_disposition_with(type: disposition, filename: filename) if filename
+
+      { "Content-Type" => content_type, "Content-MD5" => checksum, "Content-Disposition" => content_disposition }
     end
 
     private
+      def private_url(key, expires_in:, filename:, disposition:, content_type:, **)
+        object_for(key).presigned_url :get, expires_in: expires_in.to_i,
+          response_content_disposition: content_disposition_with(type: disposition, filename: filename),
+          response_content_type: content_type
+      end
+
+      def public_url(key, **)
+        object_for(key).public_url
+      end
+
+
+      MAXIMUM_UPLOAD_PARTS_COUNT = 10000
+      MINIMUM_UPLOAD_PART_SIZE   = 5.megabytes
+
+      def upload_with_single_part(key, io, checksum: nil, content_type: nil, content_disposition: nil)
+        object_for(key).put(body: io, content_md5: checksum, content_type: content_type, content_disposition: content_disposition, **upload_options)
+      rescue Aws::S3::Errors::BadDigest
+        raise ActiveStorage::IntegrityError
+      end
+
+      def upload_with_multipart(key, io, content_type: nil, content_disposition: nil)
+        part_size = [ io.size.fdiv(MAXIMUM_UPLOAD_PARTS_COUNT).ceil, MINIMUM_UPLOAD_PART_SIZE ].max
+
+        object_for(key).upload_stream(content_type: content_type, content_disposition: content_disposition, part_size: part_size, **upload_options) do |out|
+          IO.copy_stream(io, out)
+        end
+      end
+
+
       def object_for(key)
         bucket.object(key)
       end
@@ -111,7 +139,7 @@ module ActiveStorage
         raise ActiveStorage::FileNotFoundError unless object.exists?
 
         while offset < object.content_length
-          yield object.get(range: "bytes=#{offset}-#{offset + chunk_size - 1}").body.read.force_encoding(Encoding::BINARY)
+          yield object.get(range: "bytes=#{offset}-#{offset + chunk_size - 1}").body.string.force_encoding(Encoding::BINARY)
           offset += chunk_size
         end
       end