aboutsummaryrefslogtreecommitdiffstats
path: root/app
diff options
context:
space:
mode:
authorDavid Heinemeier Hansson <david@loudthinking.com>2017-07-24 08:48:42 -0500
committerDavid Heinemeier Hansson <david@loudthinking.com>2017-07-24 08:48:42 -0500
commit69922fc7154fb0b99031b3215f42bb0124715608 (patch)
treedfa246ca0ef21c2abfe16b485db6881339dc4d15 /app
parentb2032888194ded868d22993c720ea1b03c4f754b (diff)
downloadrails-69922fc7154fb0b99031b3215f42bb0124715608.tar.gz
rails-69922fc7154fb0b99031b3215f42bb0124715608.tar.bz2
rails-69922fc7154fb0b99031b3215f42bb0124715608.zip
Everything under app/ is eager loaded, don't want that for service
Since it references all the specific cloud services that are intended only to be loaded on demand.
Diffstat (limited to 'app')
-rw-r--r--app/models/active_storage/service.rb96
-rw-r--r--app/models/active_storage/service/configurator.rb28
-rw-r--r--app/models/active_storage/service/disk_service.rb91
-rw-r--r--app/models/active_storage/service/gcs_service.rb73
-rw-r--r--app/models/active_storage/service/mirror_service.rb40
-rw-r--r--app/models/active_storage/service/s3_service.rb90
6 files changed, 0 insertions, 418 deletions
diff --git a/app/models/active_storage/service.rb b/app/models/active_storage/service.rb
deleted file mode 100644
index 9d370d0a2b..0000000000
--- a/app/models/active_storage/service.rb
+++ /dev/null
@@ -1,96 +0,0 @@
-require "active_storage/log_subscriber"
-
-# Abstract class serving as an interface for concrete services.
-#
-# The available services are:
-#
-# * +Disk+, to manage attachments saved directly on the hard drive.
-# * +GCS+, to manage attachments through Google Cloud Storage.
-# * +S3+, to manage attachments through Amazon S3.
-# * +Mirror+, to be able to use several services to manage attachments.
-#
-# Inside a Rails application, you can set-up your services through the
-# generated <tt>config/storage_services.yml</tt> file and reference one
-# of the aforementioned constant under the +service+ key. For example:
-#
-# local:
-# service: Disk
-# root: <%= Rails.root.join("storage") %>
-#
-# You can checkout the service's constructor to know which keys are required.
-#
-# Then, in your application's configuration, you can specify the service to
-# use like this:
-#
-# config.active_storage.service = :local
-#
-# If you are using Active Storage outside of a Ruby on Rails application, you
-# can configure the service to use like this:
-#
-# ActiveStorage::Blob.service = ActiveStorage::Service.configure(
-# :Disk,
-# root: Pathname("/foo/bar/storage")
-# )
-class ActiveStorage::Service
- class ActiveStorage::IntegrityError < StandardError; end
-
- extend ActiveSupport::Autoload
- autoload :Configurator
-
- class_attribute :logger
-
- class << self
- # Configure an Active Storage service by name from a set of configurations,
- # typically loaded from a YAML file. The Active Storage engine uses this
- # to set the global Active Storage service when the app boots.
- def configure(service_name, configurations)
- Configurator.build(service_name, configurations)
- end
-
- # Override in subclasses that stitch together multiple services and hence
- # need to build additional services using the configurator.
- #
- # Passes the configurator and all of the service's config as keyword args.
- #
- # See MirrorService for an example.
- def build(configurator:, service: nil, **service_config) #:nodoc:
- new(**service_config)
- end
- end
-
- def upload(key, io, checksum: nil)
- raise NotImplementedError
- end
-
- def download(key)
- raise NotImplementedError
- end
-
- def delete(key)
- raise NotImplementedError
- end
-
- def exist?(key)
- raise NotImplementedError
- end
-
- def url(key, expires_in:, disposition:, filename:, content_type:)
- raise NotImplementedError
- end
-
- def url_for_direct_upload(key, expires_in:, content_type:, content_length:)
- raise NotImplementedError
- end
-
- private
- def instrument(operation, key, payload = {}, &block)
- ActiveSupport::Notifications.instrument(
- "service_#{operation}.active_storage",
- payload.merge(key: key, service: service_name), &block)
- end
-
- def service_name
- # ActiveStorage::Service::DiskService => Disk
- self.class.name.split("::").third.remove("Service")
- end
-end
diff --git a/app/models/active_storage/service/configurator.rb b/app/models/active_storage/service/configurator.rb
deleted file mode 100644
index 00ae24d251..0000000000
--- a/app/models/active_storage/service/configurator.rb
+++ /dev/null
@@ -1,28 +0,0 @@
-class ActiveStorage::Service::Configurator #:nodoc:
- attr_reader :configurations
-
- def self.build(service_name, configurations)
- new(configurations).build(service_name)
- end
-
- def initialize(configurations)
- @configurations = configurations.deep_symbolize_keys
- end
-
- def build(service_name)
- config = config_for(service_name.to_sym)
- resolve(config.fetch(:service)).build(**config, configurator: self)
- end
-
- private
- def config_for(name)
- configurations.fetch name do
- raise "Missing configuration for the #{name.inspect} Active Storage service. Configurations available for #{configurations.keys.inspect}"
- end
- end
-
- def resolve(class_name)
- require "active_storage/service/#{class_name.to_s.downcase}_service"
- ActiveStorage::Service.const_get(:"#{class_name}Service")
- end
-end
diff --git a/app/models/active_storage/service/disk_service.rb b/app/models/active_storage/service/disk_service.rb
deleted file mode 100644
index 3cde203a31..0000000000
--- a/app/models/active_storage/service/disk_service.rb
+++ /dev/null
@@ -1,91 +0,0 @@
-require "fileutils"
-require "pathname"
-require "digest/md5"
-require "active_support/core_ext/numeric/bytes"
-
-class ActiveStorage::Service::DiskService < ActiveStorage::Service
- attr_reader :root
-
- def initialize(root:)
- @root = root
- end
-
- def upload(key, io, checksum: nil)
- instrument :upload, key, checksum: checksum do
- IO.copy_stream(io, make_path_for(key))
- ensure_integrity_of(key, checksum) if checksum
- end
- end
-
- def download(key)
- if block_given?
- instrument :streaming_download, key do
- File.open(path_for(key), "rb") do |file|
- while data = file.read(64.kilobytes)
- yield data
- end
- end
- end
- else
- instrument :download, key do
- File.binread path_for(key)
- end
- end
- end
-
- def delete(key)
- instrument :delete, key do
- begin
- File.delete path_for(key)
- rescue Errno::ENOENT
- # Ignore files already deleted
- end
- end
- end
-
- def exist?(key)
- instrument :exist, key do |payload|
- answer = File.exist? path_for(key)
- payload[:exist] = answer
- answer
- end
- end
-
- def url(key, expires_in:, disposition:, filename:, content_type:)
- instrument :url, key do |payload|
- verified_key_with_expiration = ActiveStorage.verifier.generate(key, expires_in: expires_in, purpose: :blob_key)
-
- generated_url =
- if defined?(Rails) && defined?(Rails.application)
- Rails.application.routes.url_helpers.rails_disk_blob_path \
- verified_key_with_expiration,
- disposition: disposition, filename: filename, content_type: content_type
- else
- "/rails/active_storage/disk/#{verified_key_with_expiration}/#{filename}?disposition=#{disposition}&content_type=#{content_type}"
- end
-
- payload[:url] = generated_url
-
- generated_url
- end
- end
-
- private
- def path_for(key)
- File.join root, folder_for(key), key
- end
-
- def folder_for(key)
- [ key[0..1], key[2..3] ].join("/")
- end
-
- def make_path_for(key)
- path_for(key).tap { |path| FileUtils.mkdir_p File.dirname(path) }
- end
-
- def ensure_integrity_of(key, checksum)
- unless Digest::MD5.file(path_for(key)).base64digest == checksum
- raise ActiveStorage::IntegrityError
- end
- end
-end
diff --git a/app/models/active_storage/service/gcs_service.rb b/app/models/active_storage/service/gcs_service.rb
deleted file mode 100644
index 4530de22f6..0000000000
--- a/app/models/active_storage/service/gcs_service.rb
+++ /dev/null
@@ -1,73 +0,0 @@
-require "google/cloud/storage"
-require "active_support/core_ext/object/to_query"
-
-class ActiveStorage::Service::GCSService < ActiveStorage::Service
- attr_reader :client, :bucket
-
- def initialize(project:, keyfile:, bucket:)
- @client = Google::Cloud::Storage.new(project: project, keyfile: keyfile)
- @bucket = @client.bucket(bucket)
- end
-
- def upload(key, io, checksum: nil)
- instrument :upload, key, checksum: checksum do
- begin
- bucket.create_file(io, key, md5: checksum)
- rescue Google::Cloud::InvalidArgumentError
- raise ActiveStorage::IntegrityError
- end
- end
- end
-
- # FIXME: Add streaming when given a block
- def download(key)
- instrument :download, key do
- io = file_for(key).download
- io.rewind
- io.read
- end
- end
-
- def delete(key)
- instrument :delete, key do
- file_for(key)&.delete
- end
- end
-
- def exist?(key)
- instrument :exist, key do |payload|
- answer = file_for(key).present?
- payload[:exist] = answer
- answer
- end
- end
-
- def url(key, expires_in:, disposition:, filename:, content_type:)
- instrument :url, key do |payload|
- generated_url = file_for(key).signed_url expires: expires_in, query: {
- "response-content-disposition" => "#{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:)
- instrument :url, key do |payload|
- generated_url = bucket.signed_url key, method: "PUT", expires: expires_in,
- content_type: content_type
-
- payload[:url] = generated_url
-
- generated_url
- end
- end
-
- private
- def file_for(key)
- bucket.file(key)
- end
-end
diff --git a/app/models/active_storage/service/mirror_service.rb b/app/models/active_storage/service/mirror_service.rb
deleted file mode 100644
index 54465cad05..0000000000
--- a/app/models/active_storage/service/mirror_service.rb
+++ /dev/null
@@ -1,40 +0,0 @@
-require "active_support/core_ext/module/delegation"
-
-class ActiveStorage::Service::MirrorService < ActiveStorage::Service
- attr_reader :primary, :mirrors
-
- delegate :download, :exist?, :url, to: :primary
-
- # Stitch together from named services.
- def self.build(primary:, mirrors:, configurator:, **options) #:nodoc:
- new \
- primary: configurator.build(primary),
- mirrors: mirrors.collect { |name| configurator.build name }
- end
-
- def initialize(primary:, mirrors:)
- @primary, @mirrors = primary, mirrors
- end
-
- def upload(key, io, checksum: nil)
- each_service.collect do |service|
- service.upload key, io.tap(&:rewind), checksum: checksum
- end
- end
-
- def delete(key)
- perform_across_services :delete, key
- end
-
- private
- def each_service(&block)
- [ primary, *mirrors ].each(&block)
- end
-
- def perform_across_services(method, *args)
- # FIXME: Convert to be threaded
- each_service.collect do |service|
- service.public_send method, *args
- end
- end
-end
diff --git a/app/models/active_storage/service/s3_service.rb b/app/models/active_storage/service/s3_service.rb
deleted file mode 100644
index 4c17f9902f..0000000000
--- a/app/models/active_storage/service/s3_service.rb
+++ /dev/null
@@ -1,90 +0,0 @@
-require "aws-sdk"
-require "active_support/core_ext/numeric/bytes"
-
-class ActiveStorage::Service::S3Service < ActiveStorage::Service
- attr_reader :client, :bucket, :upload_options
-
- def initialize(access_key_id:, secret_access_key:, region:, bucket:, upload: {}, **options)
- @client = Aws::S3::Resource.new(access_key_id: access_key_id, secret_access_key: secret_access_key, region: region, **options)
- @bucket = @client.bucket(bucket)
-
- @upload_options = upload
- end
-
- def upload(key, io, checksum: nil)
- instrument :upload, key, checksum: checksum do
- begin
- object_for(key).put(upload_options.merge(body: io, content_md5: checksum))
- rescue Aws::S3::Errors::BadDigest
- raise ActiveStorage::IntegrityError
- end
- end
- end
-
- def download(key)
- if block_given?
- instrument :streaming_download, key do
- stream(key, &block)
- end
- else
- instrument :download, key do
- object_for(key).get.body.read.force_encoding(Encoding::BINARY)
- end
- end
- end
-
- def delete(key)
- instrument :delete, key do
- object_for(key).delete
- end
- end
-
- def exist?(key)
- instrument :exist, key do |payload|
- answer = object_for(key).exists?
- payload[:exist] = answer
- answer
- end
- end
-
- def url(key, expires_in:, disposition:, filename:, content_type:)
- instrument :url, key do |payload|
- generated_url = object_for(key).presigned_url :get, expires_in: expires_in,
- response_content_disposition: "#{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:)
- instrument :url, key do |payload|
- generated_url = object_for(key).presigned_url :put, expires_in: expires_in,
- content_type: content_type, content_length: content_length
-
- payload[:url] = generated_url
-
- generated_url
- end
- end
-
- private
- def object_for(key)
- bucket.object(key)
- end
-
- # Reads the object for the given key in chunks, yielding each to the block.
- def stream(key, options = {}, &block)
- object = object_for(key)
-
- chunk_size = 5.megabytes
- offset = 0
-
- while offset < object.content_length
- yield object.read(options.merge(range: "bytes=#{offset}-#{offset + chunk_size - 1}"))
- offset += chunk_size
- end
- end
-end