240 lines
9.1 KiB
Ruby
240 lines
9.1 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
module Gitlab
|
|
module ImportExport
|
|
class ProjectTreeRestorer
|
|
# Relations which cannot be saved at project level (and have a group assigned)
|
|
GROUP_MODELS = [GroupLabel, Milestone].freeze
|
|
|
|
def initialize(user:, shared:, project:)
|
|
@path = File.join(shared.export_path, 'project.json')
|
|
@user = user
|
|
@shared = shared
|
|
@project = project
|
|
@project_id = project.id
|
|
@saved = true
|
|
end
|
|
|
|
def restore
|
|
begin
|
|
json = IO.read(@path)
|
|
@tree_hash = ActiveSupport::JSON.decode(json)
|
|
rescue => e
|
|
Rails.logger.error("Import/Export error: #{e.message}") # rubocop:disable Gitlab/RailsLogger
|
|
raise Gitlab::ImportExport::Error.new('Incorrect JSON format')
|
|
end
|
|
|
|
@project_members = @tree_hash.delete('project_members')
|
|
|
|
RelationRenameService.rename(@tree_hash)
|
|
|
|
ActiveRecord::Base.uncached do
|
|
ActiveRecord::Base.no_touching do
|
|
create_relations
|
|
end
|
|
end
|
|
rescue => e
|
|
@shared.error(e)
|
|
false
|
|
end
|
|
|
|
def restored_project
|
|
return @project unless @tree_hash
|
|
|
|
@restored_project ||= restore_project
|
|
end
|
|
|
|
private
|
|
|
|
def members_mapper
|
|
@members_mapper ||= Gitlab::ImportExport::MembersMapper.new(exported_members: @project_members,
|
|
user: @user,
|
|
project: restored_project)
|
|
end
|
|
|
|
# Loops through the tree of models defined in import_export.yml and
|
|
# finds them in the imported JSON so they can be instantiated and saved
|
|
# in the DB. The structure and relationships between models are guessed from
|
|
# the configuration yaml file too.
|
|
# Finally, it updates each attribute in the newly imported project.
|
|
def create_relations
|
|
project_relations_without_project_members.each do |relation_key, relation_definition|
|
|
relation_key_s = relation_key.to_s
|
|
|
|
if relation_definition.present?
|
|
create_sub_relations(relation_key_s, relation_definition, @tree_hash)
|
|
elsif @tree_hash[relation_key_s].present?
|
|
save_relation_hash(relation_key_s, @tree_hash[relation_key_s])
|
|
end
|
|
end
|
|
|
|
@project.merge_requests.set_latest_merge_request_diff_ids!
|
|
|
|
@saved
|
|
end
|
|
|
|
def save_relation_hash(relation_key, relation_hash_batch)
|
|
relation_hash = create_relation(relation_key, relation_hash_batch)
|
|
|
|
remove_group_models(relation_hash) if relation_hash.is_a?(Array)
|
|
|
|
@saved = false unless restored_project.append_or_update_attribute(relation_key, relation_hash)
|
|
|
|
# Restore the project again, extra query that skips holding the AR objects in memory
|
|
@restored_project = Project.find(@project_id)
|
|
end
|
|
|
|
# Remove project models that became group models as we found them at group level.
|
|
# This no longer required saving them at the root project level.
|
|
# For example, in the case of an existing group label that matched the title.
|
|
def remove_group_models(relation_hash)
|
|
relation_hash.reject! do |value|
|
|
GROUP_MODELS.include?(value.class) && value.group_id
|
|
end
|
|
end
|
|
|
|
def project_relations_without_project_members
|
|
# We remove `project_members` as they are deserialized separately
|
|
project_relations.except(:project_members)
|
|
end
|
|
|
|
def project_relations
|
|
reader.attributes_finder.find_relations_tree(:project)
|
|
end
|
|
|
|
def restore_project
|
|
Gitlab::Timeless.timeless(@project) do
|
|
@project.update(project_params)
|
|
end
|
|
|
|
@project
|
|
end
|
|
|
|
def project_params
|
|
@project_params ||= begin
|
|
attrs = json_params.merge(override_params).merge(visibility_level, external_label)
|
|
|
|
# Cleaning all imported and overridden params
|
|
Gitlab::ImportExport::AttributeCleaner.clean(relation_hash: attrs,
|
|
relation_class: Project,
|
|
excluded_keys: excluded_keys_for_relation(:project))
|
|
end
|
|
end
|
|
|
|
def override_params
|
|
@override_params ||= @project.import_data&.data&.fetch('override_params', nil) || {}
|
|
end
|
|
|
|
def json_params
|
|
@json_params ||= @tree_hash.reject do |key, value|
|
|
# return params that are not 1 to many or 1 to 1 relations
|
|
value.respond_to?(:each) && !Project.column_names.include?(key)
|
|
end
|
|
end
|
|
|
|
def visibility_level
|
|
level = override_params['visibility_level'] || json_params['visibility_level'] || @project.visibility_level
|
|
level = @project.group.visibility_level if @project.group && level.to_i > @project.group.visibility_level
|
|
level = Gitlab::VisibilityLevel::PRIVATE if level == Gitlab::VisibilityLevel::INTERNAL && Gitlab::CurrentSettings.restricted_visibility_levels.include?(level)
|
|
|
|
{ 'visibility_level' => level }
|
|
end
|
|
|
|
def external_label
|
|
label = override_params['external_authorization_classification_label'].presence ||
|
|
json_params['external_authorization_classification_label'].presence
|
|
|
|
{ 'external_authorization_classification_label' => label }
|
|
end
|
|
|
|
# Given a relation hash containing one or more models and its relationships,
|
|
# loops through each model and each object from a model type and
|
|
# and assigns its correspondent attributes hash from +tree_hash+
|
|
# Example:
|
|
# +relation_key+ issues, loops through the list of *issues* and for each individual
|
|
# issue, finds any subrelations such as notes, creates them and assign them back to the hash
|
|
#
|
|
# Recursively calls this method if the sub-relation is a hash containing more sub-relations
|
|
def create_sub_relations(relation_key, relation_definition, tree_hash, save: true)
|
|
return if tree_hash[relation_key].blank?
|
|
|
|
tree_array = [tree_hash[relation_key]].flatten
|
|
null_iid_pipelines = []
|
|
|
|
# Avoid keeping a possible heavy object in memory once we are done with it
|
|
while relation_item = (tree_array.shift || null_iid_pipelines.shift)
|
|
if nil_iid_pipeline?(relation_key, relation_item) && tree_array.any?
|
|
# Move pipelines with NULL IIDs to the end
|
|
# so they don't clash with existing IIDs.
|
|
null_iid_pipelines << relation_item
|
|
|
|
next
|
|
end
|
|
|
|
# The transaction at this level is less speedy than one single transaction
|
|
# But we can't have it in the upper level or GC won't get rid of the AR objects
|
|
# after we save the batch.
|
|
Project.transaction do
|
|
process_sub_relation(relation_key, relation_definition, relation_item)
|
|
|
|
# For every subrelation that hangs from Project, save the associated records altogether
|
|
# This effectively batches all records per subrelation item, only keeping those in memory
|
|
# We have to keep in mind that more batch granularity << Memory, but >> Slowness
|
|
if save
|
|
save_relation_hash(relation_key, [relation_item])
|
|
tree_hash[relation_key].delete(relation_item)
|
|
end
|
|
end
|
|
end
|
|
|
|
tree_hash.delete(relation_key) if save
|
|
end
|
|
|
|
def process_sub_relation(relation_key, relation_definition, relation_item)
|
|
relation_definition.each do |sub_relation_key, sub_relation_definition|
|
|
# We just use author to get the user ID, do not attempt to create an instance.
|
|
next if sub_relation_key == :author
|
|
|
|
sub_relation_key_s = sub_relation_key.to_s
|
|
|
|
# create dependent relations if present
|
|
if sub_relation_definition.present?
|
|
create_sub_relations(sub_relation_key_s, sub_relation_definition, relation_item, save: false)
|
|
end
|
|
|
|
# transform relation hash to actual object
|
|
sub_relation_hash = relation_item[sub_relation_key_s]
|
|
if sub_relation_hash.present?
|
|
relation_item[sub_relation_key_s] = create_relation(sub_relation_key, sub_relation_hash)
|
|
end
|
|
end
|
|
end
|
|
|
|
def create_relation(relation_key, relation_hash_list)
|
|
relation_array = [relation_hash_list].flatten.map do |relation_hash|
|
|
Gitlab::ImportExport::RelationFactory.create(
|
|
relation_sym: relation_key.to_sym,
|
|
relation_hash: relation_hash,
|
|
members_mapper: members_mapper,
|
|
user: @user,
|
|
project: @restored_project,
|
|
excluded_keys: excluded_keys_for_relation(relation_key))
|
|
end.compact
|
|
|
|
relation_hash_list.is_a?(Array) ? relation_array : relation_array.first
|
|
end
|
|
|
|
def reader
|
|
@reader ||= Gitlab::ImportExport::Reader.new(shared: @shared)
|
|
end
|
|
|
|
def excluded_keys_for_relation(relation)
|
|
reader.attributes_finder.find_excluded_keys(relation)
|
|
end
|
|
|
|
def nil_iid_pipeline?(relation_key, relation_item)
|
|
relation_key == 'ci_pipelines' && relation_item['iid'].nil?
|
|
end
|
|
end
|
|
end
|
|
end
|