debian-mirror-gitlab/app/models/work_item.rb
2023-06-20 00:43:36 +05:30

214 lines
6.9 KiB
Ruby

# frozen_string_literal: true
class WorkItem < Issue
include Gitlab::Utils::StrongMemoize
COMMON_QUICK_ACTIONS_COMMANDS = [
:title, :reopen, :close, :cc, :tableflip, :shrug
].freeze
self.table_name = 'issues'
self.inheritance_column = :_type_disabled
belongs_to :namespace, inverse_of: :work_items
has_one :parent_link, class_name: '::WorkItems::ParentLink', foreign_key: :work_item_id
has_one :work_item_parent, through: :parent_link, class_name: 'WorkItem'
has_many :child_links, class_name: '::WorkItems::ParentLink', foreign_key: :work_item_parent_id
has_many :work_item_children, through: :child_links, class_name: 'WorkItem',
foreign_key: :work_item_id, source: :work_item
has_many :work_item_children_by_relative_position, -> { work_item_children_keyset_order },
through: :child_links, class_name: 'WorkItem',
foreign_key: :work_item_id, source: :work_item
scope :inc_relations_for_permission_check, -> { includes(:author, project: :project_feature) }
delegate :supports_assignee?, to: :work_item_type
class << self
def assignee_association_name
'issue'
end
def test_reports_join_column
'issues.id'
end
def work_item_children_keyset_order
keyset_order = Gitlab::Pagination::Keyset::Order.build([
Gitlab::Pagination::Keyset::ColumnOrderDefinition.new(
attribute_name: :relative_position,
column_expression: WorkItems::ParentLink.arel_table[:relative_position],
order_expression: WorkItems::ParentLink.arel_table[:relative_position].asc.nulls_last,
nullable: :nulls_last,
distinct: false
),
Gitlab::Pagination::Keyset::ColumnOrderDefinition.new(
attribute_name: :created_at,
order_expression: WorkItem.arel_table[:created_at].asc,
nullable: :not_nullable,
distinct: false
)
])
includes(:child_links).order(keyset_order)
end
end
def noteable_target_type_name
'issue'
end
def widgets
strong_memoize(:widgets) do
work_item_type.widgets.map do |widget_class|
widget_class.new(self)
end
end
end
# Returns widget object if available
# type parameter can be a symbol, for example, `:description`.
def get_widget(type)
widgets.find do |widget|
widget.instance_of?(WorkItems::Widgets.const_get(type.to_s.camelize, false))
end
rescue NameError
nil
end
def ancestors
hierarchy.ancestors(hierarchy_order: :asc)
end
def same_type_base_and_ancestors
hierarchy(same_type: true).base_and_ancestors(hierarchy_order: :asc)
end
def same_type_descendants_depth
hierarchy(same_type: true).max_descendants_depth.to_i
end
def supported_quick_action_commands
commands_for_widgets = work_item_type.widgets.flat_map(&:quick_action_commands).uniq
COMMON_QUICK_ACTIONS_COMMANDS + commands_for_widgets
end
# Widgets have a set of quick action params that they must process.
# Map them to widget_params so they can be picked up by widget services.
def transform_quick_action_params(command_params)
common_params = command_params.deep_dup
widget_params = {}
work_item_type.widgets
.filter { |widget| widget.respond_to?(:quick_action_params) }
.each do |widget|
widget.quick_action_params
.filter { |param_name| common_params.key?(param_name) }
.each do |param_name|
widget_params[widget.api_symbol] ||= {}
widget_params[widget.api_symbol][param_name] = common_params.delete(param_name)
end
end
{ common: common_params, widgets: widget_params }
end
private
override :parent_link_confidentiality
def parent_link_confidentiality
if confidential? && work_item_children.public_only.exists?
errors.add(:base, _('A confidential work item cannot have a parent that already has non-confidential children.'))
end
if !confidential? && work_item_parent&.confidential?
errors.add(:base, _('A non-confidential work item cannot have a confidential parent.'))
end
end
def record_create_action
super
Gitlab::UsageDataCounters::WorkItemActivityUniqueCounter.track_work_item_created_action(author: author)
end
def hierarchy(options = {})
base = self.class.where(id: id)
base = base.where(work_item_type_id: work_item_type_id) if options[:same_type]
::Gitlab::WorkItems::WorkItemHierarchy.new(base, options: options)
end
override :allowed_work_item_type_change
def allowed_work_item_type_change
return unless work_item_type_id_changed?
child_links = WorkItems::ParentLink.for_parents(id)
parent_link = ::WorkItems::ParentLink.find_by(work_item: self)
validate_parent_restrictions(parent_link)
validate_child_restrictions(child_links)
validate_depth(parent_link, child_links)
end
def validate_parent_restrictions(parent_link)
return unless parent_link
parent_link.work_item.work_item_type_id = work_item_type_id
unless parent_link.valid?
errors.add(
:work_item_type_id,
format(
_('cannot be changed to %{new_type} with %{parent_type} as parent type.'),
new_type: work_item_type.name, parent_type: parent_link.work_item_parent.work_item_type.name
)
)
end
end
def validate_child_restrictions(child_links)
return if child_links.empty?
child_type_ids = child_links.joins(:work_item).select(self.class.arel_table[:work_item_type_id]).distinct
restrictions = ::WorkItems::HierarchyRestriction.where(
parent_type_id: work_item_type_id,
child_type_id: child_type_ids
)
# We expect a restriction for every child type
if restrictions.size < child_type_ids.size
errors.add(
:work_item_type_id,
format(_('cannot be changed to %{new_type} with these child item types.'), new_type: work_item_type.name)
)
end
end
def validate_depth(parent_link, child_links)
restriction = ::WorkItems::HierarchyRestriction.find_by_parent_type_id_and_child_type_id(
work_item_type_id,
work_item_type_id
)
return unless restriction&.maximum_depth
children_with_new_type = self.class.where(id: child_links.select(:work_item_id))
.where(work_item_type_id: work_item_type_id)
max_child_depth = ::Gitlab::WorkItems::WorkItemHierarchy.new(children_with_new_type).max_descendants_depth.to_i
ancestor_depth =
if parent_link&.work_item_parent && parent_link.work_item_parent.work_item_type_id == work_item_type_id
parent_link.work_item_parent.same_type_base_and_ancestors.count
else
0
end
if max_child_depth + ancestor_depth > restriction.maximum_depth - 1
errors.add(:work_item_type_id, _('reached maximum depth'))
end
end
end
WorkItem.prepend_mod