2020-03-11 11:09:37 -04:00
|
|
|
# frozen_string_literal: true
|
|
|
|
|
|
|
|
module Gitlab
|
|
|
|
module BackgroundMigration
|
|
|
|
# Class that will fill the project_repositories table for projects that
|
|
|
|
# are on hashed storage and an entry is missing in this table.
|
|
|
|
class BackfillSnippetRepositories
|
|
|
|
MAX_RETRIES = 2
|
|
|
|
|
|
|
|
def perform(start_id, stop_id)
|
|
|
|
Snippet.includes(:author, snippet_repository: :shard).where(id: start_id..stop_id).find_each do |snippet|
|
|
|
|
# We need to expire the exists? value for the cached method in case it was cached
|
|
|
|
snippet.repository.expire_exists_cache
|
|
|
|
|
|
|
|
next if repository_present?(snippet)
|
|
|
|
|
|
|
|
retry_index = 0
|
2020-05-05 14:09:43 -04:00
|
|
|
@invalid_path_error = false
|
2020-03-11 11:09:37 -04:00
|
|
|
|
|
|
|
begin
|
|
|
|
create_repository_and_files(snippet)
|
|
|
|
|
|
|
|
logger.info(message: 'Snippet Migration: repository created and migrated', snippet: snippet.id)
|
|
|
|
rescue => e
|
2020-05-05 14:09:43 -04:00
|
|
|
set_file_path_error(e)
|
|
|
|
|
2020-03-11 11:09:37 -04:00
|
|
|
retry_index += 1
|
|
|
|
|
|
|
|
retry if retry_index < MAX_RETRIES
|
|
|
|
|
|
|
|
logger.error(message: "Snippet Migration: error migrating snippet. Reason: #{e.message}", snippet: snippet.id)
|
|
|
|
|
|
|
|
destroy_snippet_repository(snippet)
|
|
|
|
delete_repository(snippet)
|
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
private
|
|
|
|
|
|
|
|
def repository_present?(snippet)
|
|
|
|
snippet.snippet_repository && !snippet.empty_repo?
|
|
|
|
end
|
|
|
|
|
|
|
|
def create_repository_and_files(snippet)
|
|
|
|
snippet.create_repository
|
|
|
|
create_commit(snippet)
|
|
|
|
end
|
|
|
|
|
2020-04-28 17:09:35 -04:00
|
|
|
# Removing the db record
|
2020-03-11 11:09:37 -04:00
|
|
|
def destroy_snippet_repository(snippet)
|
2020-04-28 17:09:35 -04:00
|
|
|
snippet.snippet_repository&.delete
|
2020-03-11 11:09:37 -04:00
|
|
|
rescue => e
|
|
|
|
logger.error(message: "Snippet Migration: error destroying snippet repository. Reason: #{e.message}", snippet: snippet.id)
|
|
|
|
end
|
|
|
|
|
2020-04-28 17:09:35 -04:00
|
|
|
# Removing the repository in disk
|
2020-03-11 11:09:37 -04:00
|
|
|
def delete_repository(snippet)
|
2020-04-28 17:09:35 -04:00
|
|
|
return unless snippet.repository_exists?
|
|
|
|
|
|
|
|
snippet.repository.remove
|
|
|
|
snippet.repository.expire_exists_cache
|
2020-03-11 11:09:37 -04:00
|
|
|
rescue => e
|
|
|
|
logger.error(message: "Snippet Migration: error deleting repository. Reason: #{e.message}", snippet: snippet.id)
|
|
|
|
end
|
|
|
|
|
|
|
|
def logger
|
|
|
|
@logger ||= Gitlab::BackgroundMigration::Logger.build
|
|
|
|
end
|
|
|
|
|
|
|
|
def snippet_action(snippet)
|
|
|
|
# We don't need the previous_path param
|
|
|
|
# Because we're not updating any existing file
|
|
|
|
[{ file_path: filename(snippet),
|
|
|
|
content: snippet.content }]
|
|
|
|
end
|
|
|
|
|
|
|
|
def filename(snippet)
|
2020-05-05 14:09:43 -04:00
|
|
|
file_name = snippet.file_name
|
|
|
|
file_name = file_name.parameterize if @invalid_path_error
|
|
|
|
|
|
|
|
file_name.presence || empty_file_name
|
2020-03-11 11:09:37 -04:00
|
|
|
end
|
|
|
|
|
|
|
|
def empty_file_name
|
|
|
|
@empty_file_name ||= "#{SnippetRepository::DEFAULT_EMPTY_FILE_NAME}1.txt"
|
|
|
|
end
|
|
|
|
|
|
|
|
def commit_attrs
|
|
|
|
@commit_attrs ||= { branch_name: 'master', message: 'Initial commit' }
|
|
|
|
end
|
|
|
|
|
|
|
|
def create_commit(snippet)
|
2020-04-28 17:09:35 -04:00
|
|
|
snippet.snippet_repository.multi_files_action(commit_author(snippet), snippet_action(snippet), commit_attrs)
|
|
|
|
end
|
|
|
|
|
|
|
|
# If the user is not allowed to access git or update the snippet
|
|
|
|
# because it is blocked, internal, ghost, ... we cannot commit
|
|
|
|
# files because these users are not allowed to, but we need to
|
|
|
|
# migrate their snippets as well.
|
|
|
|
# In this scenario an admin user will be the one that will commit the files.
|
|
|
|
def commit_author(snippet)
|
|
|
|
if Gitlab::UserAccessSnippet.new(snippet.author, snippet: snippet).can_do_action?(:update_snippet)
|
|
|
|
snippet.author
|
|
|
|
else
|
|
|
|
admin_user
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
def admin_user
|
|
|
|
@admin_user ||= User.admins.active.first
|
2020-03-11 11:09:37 -04:00
|
|
|
end
|
2020-05-05 14:09:43 -04:00
|
|
|
|
|
|
|
# We sometimes receive invalid path errors from Gitaly if the Snippet filename
|
|
|
|
# cannot be parsed into a valid git path.
|
|
|
|
# In this situation, we need to parameterize the file name of the Snippet so that
|
|
|
|
# the migration can succeed, to achieve that, we'll identify in migration retries
|
|
|
|
# that the path is invalid
|
|
|
|
def set_file_path_error(error)
|
|
|
|
@invalid_path_error = error.message.downcase.start_with?('invalid path', 'path cannot include directory traversal')
|
|
|
|
end
|
2020-03-11 11:09:37 -04:00
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|