1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
|
# frozen_string_literal: true
class WorkItem < Issue
include Gitlab::Utils::StrongMemoize
COMMON_QUICK_ACTIONS_COMMANDS = [
:title, :reopen, :close, :cc, :tableflip, :shrug, :type, :promote_to, :checkin_reminder,
:subscribe, :unsubscribe, :confidential, :award
].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_one :dates_source, class_name: 'WorkItems::DatesSource', foreign_key: 'issue_id', inverse_of: :work_item
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) }
scope :with_confidentiality_check, ->(user) {
confidential_query = <<~SQL
issues.confidential = FALSE
OR (issues.confidential = TRUE
AND (issues.author_id = :user_id
OR EXISTS (SELECT TRUE FROM issue_assignees WHERE user_id = :user_id AND issue_id = issues.id)))
SQL
where(confidential_query, user_id: user.id)
}
class << self
def find_by_namespace_and_iid!(namespace, iid)
find_by!(namespace: namespace, iid: iid)
end
def assignee_association_name
'issue'
end
def test_reports_join_column
'issues.id'
end
# def reference_pattern
# # no-op: We currently only support link_reference_pattern parsing
# end
def link_reference_pattern
@link_reference_pattern ||= compose_link_reference_pattern('work_items', Gitlab::Regex.work_item)
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(:parent_link).order(keyset_order)
end
def linked_items_keyset_order
::Gitlab::Pagination::Keyset::Order.build(
[
::Gitlab::Pagination::Keyset::ColumnOrderDefinition.new(
attribute_name: 'issue_link_id',
column_expression: IssueLink.arel_table[:id],
order_expression: IssueLink.arel_table[:id].asc,
nullable: :not_nullable,
distinct: true
)
])
end
override :related_link_class
def related_link_class
WorkItems::RelatedWorkItemLink
end
end
def noteable_target_type_name
'issue'
end
# Todo: remove method after target_type cleanup
# See https://gitlab.com/gitlab-org/gitlab/-/issues/416009
def todoable_target_type_name
%w[Issue WorkItem]
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.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] ||= {}
param_value = common_params.delete(param_name)
widget_params[widget.api_symbol].merge!(widget.process_quick_action_param(param_name, param_value))
end
end
{ common: common_params, widgets: widget_params }
end
def linked_work_items(current_user = nil, authorize: true, preload: nil, link_type: nil)
return [] if new_record?
linked_work_items = linked_work_items_query(link_type)
.preload(preload)
.reorder(self.class.linked_items_keyset_order)
return linked_work_items unless authorize
cross_project_filter = ->(work_items) { work_items.where(project: project) }
Ability.work_items_readable_by_user(
linked_work_items,
current_user,
filters: { read_cross_project: cross_project_filter }
)
end
def linked_items_count
linked_work_items(authorize: false).size
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} when linked to a parent %{parent_type}.'),
new_type: work_item_type.name.downcase,
parent_type: parent_link.work_item_parent.work_item_type.name.downcase
)
)
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
def linked_work_items_query(link_type)
type_condition =
if link_type == WorkItems::RelatedWorkItemLink::TYPE_RELATES_TO
" AND issue_links.link_type = #{WorkItems::RelatedWorkItemLink.link_types[link_type]}"
else
""
end
linked_issues_select
.joins("INNER JOIN issue_links ON
(issue_links.source_id = issues.id AND issue_links.target_id = #{id}#{type_condition})
OR
(issue_links.target_id = issues.id AND issue_links.source_id = #{id}#{type_condition})")
end
end
WorkItem.prepend_mod
|