rails / 7.0.0 / activestorage / service / mirrorservice.html /

class ActiveStorage::Service::MirrorService

Parent:
ActiveStorage::Service

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?

  • url

  • url_for_direct_upload

  • headers_for_direct_upload

Attributes

mirrors [R]
primary [R]

Public Class Methods

new (primary:, mirrors:) Show source
# File activestorage/lib/active_storage/service/mirror_service.rb, line 29
def initialize(primary:, mirrors:)
  @primary, @mirrors = primary, mirrors
end

Public Instance Methods

delete (key) Show source
# File activestorage/lib/active_storage/service/mirror_service.rb, line 43
def delete(key)
  perform_across_services :delete, key
end

Delete the file at the key on all services.

delete_prefixed (prefix) Show source
# File activestorage/lib/active_storage/service/mirror_service.rb, line 48
def delete_prefixed(prefix)
  perform_across_services :delete_prefixed, prefix
end

Delete files at keys starting with the prefix on all services.

mirror (key, checksum:) Show source
# File activestorage/lib/active_storage/service/mirror_service.rb, line 54
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

Copy the file at the key from the primary service to each of the mirrors where it doesn't already exist.

upload (key, io, checksum: nil, **options) Show source
# File activestorage/lib/active_storage/service/mirror_service.rb, line 35
def upload(key, io, checksum: nil, **options)
  each_service.collect do |service|
    io.rewind
    service.upload key, io, checksum: checksum, **options
  end
end

Upload the io to the key specified to all services. If a checksum is provided, all services will ensure a match when the upload has completed or raise an ActiveStorage::IntegrityError.

© 2004–2021 David Heinemeier Hansson
Licensed under the MIT License.