25818bd7ae
We've seen a significant performance penalty when using `BatchLoader#__replace_with!`. This defines methods on the batch loader that proxy to the 'real' object using send. The alternative is `method_missing`, which is slower. However, we've noticed that `method_missing` can be faster if: 1. The objects being loaded have a large interface. 2. We don't call too many methods on the loaded object. Avatar uploads meet both criteria above, so let's use the newly-released feature in https://github.com/exAspArk/batch-loader/pull/45. Closes https://gitlab.com/gitlab-org/gitlab-ce/issues/60903
118 lines
3.9 KiB
Ruby
118 lines
3.9 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
module Avatarable
|
|
extend ActiveSupport::Concern
|
|
|
|
included do
|
|
prepend ShadowMethods
|
|
include ObjectStorage::BackgroundMove
|
|
include Gitlab::Utils::StrongMemoize
|
|
|
|
validate :avatar_type, if: ->(user) { user.avatar.present? && user.avatar_changed? }
|
|
validates :avatar, file_size: { maximum: 200.kilobytes.to_i }, if: :avatar_changed?
|
|
|
|
mount_uploader :avatar, AvatarUploader
|
|
|
|
after_initialize :add_avatar_to_batch
|
|
end
|
|
|
|
module ShadowMethods
|
|
def avatar_url(**args)
|
|
# We use avatar_path instead of overriding avatar_url because of carrierwave.
|
|
# See https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/11001/diffs#note_28659864
|
|
|
|
avatar_path(only_path: args.fetch(:only_path, true), size: args[:size]) || super
|
|
end
|
|
|
|
def retrieve_upload(identifier, paths)
|
|
upload = retrieve_upload_from_batch(identifier)
|
|
|
|
# This fallback is needed when deleting an upload, because we may have
|
|
# already been removed from the DB. We have to check an explicit `#nil?`
|
|
# because it's a BatchLoader instance.
|
|
upload = super if upload.nil?
|
|
|
|
upload
|
|
end
|
|
end
|
|
|
|
def avatar_type
|
|
unless self.avatar.image?
|
|
errors.add :avatar, "file format is not supported. Please try one of the following supported formats: #{AvatarUploader::IMAGE_EXT.join(', ')}"
|
|
end
|
|
end
|
|
|
|
def avatar_path(only_path: true, size: nil)
|
|
unless self.try(:id)
|
|
return uncached_avatar_path(only_path: only_path, size: size)
|
|
end
|
|
|
|
# Cache this avatar path only within the request because avatars in
|
|
# object storage may be generated with time-limited, signed URLs.
|
|
key = "#{self.class.name}:#{self.id}:#{only_path}:#{size}"
|
|
Gitlab::SafeRequestStore[key] ||= uncached_avatar_path(only_path: only_path, size: size)
|
|
end
|
|
|
|
def uncached_avatar_path(only_path: true, size: nil)
|
|
return unless self.try(:avatar).present?
|
|
|
|
asset_host = ActionController::Base.asset_host
|
|
use_asset_host = asset_host.present?
|
|
use_authentication = respond_to?(:public?) && !public?
|
|
query_params = size&.nonzero? ? "?width=#{size}" : ""
|
|
|
|
# Avatars for private and internal groups and projects require authentication to be viewed,
|
|
# which means they can only be served by Rails, on the regular GitLab host.
|
|
# If an asset host is configured, we need to return the fully qualified URL
|
|
# instead of only the avatar path, so that Rails doesn't prefix it with the asset host.
|
|
if use_asset_host && use_authentication
|
|
use_asset_host = false
|
|
only_path = false
|
|
end
|
|
|
|
url_base = []
|
|
|
|
if use_asset_host
|
|
url_base << asset_host unless only_path
|
|
else
|
|
url_base << gitlab_config.base_url unless only_path
|
|
url_base << gitlab_config.relative_url_root
|
|
end
|
|
|
|
url_base.join + avatar.local_url + query_params
|
|
end
|
|
|
|
# Path that is persisted in the tracking Upload model. Used to fetch the
|
|
# upload from the model.
|
|
def upload_paths(identifier)
|
|
avatar_mounter.blank_uploader.store_dirs.map { |store, path| File.join(path, identifier) }
|
|
end
|
|
|
|
private
|
|
|
|
def retrieve_upload_from_batch(identifier)
|
|
BatchLoader.for(identifier: identifier, model: self)
|
|
.batch(key: self.class, cache: true, replace_methods: false) do |upload_params, loader, args|
|
|
model_class = args[:key]
|
|
paths = upload_params.flat_map do |params|
|
|
params[:model].upload_paths(params[:identifier])
|
|
end
|
|
|
|
Upload.where(uploader: AvatarUploader.name, path: paths).find_each do |upload|
|
|
model = model_class.instantiate('id' => upload.model_id)
|
|
|
|
loader.call({ model: model, identifier: File.basename(upload.path) }, upload)
|
|
end
|
|
end
|
|
end
|
|
|
|
def add_avatar_to_batch
|
|
return unless avatar_mounter
|
|
|
|
avatar_mounter.read_identifiers.each { |identifier| retrieve_upload_from_batch(identifier) }
|
|
end
|
|
|
|
def avatar_mounter
|
|
strong_memoize(:avatar_mounter) { _mounter(:avatar) }
|
|
end
|
|
end
|