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 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642
|
# frozen_string_literal: true
class IssuableBaseService < ::BaseContainerService
private
def available_callbacks
[
Issuable::Callbacks::Description,
Issuable::Callbacks::Milestone,
Issuable::Callbacks::Labels,
Issuable::Callbacks::TimeTracking
].freeze
end
def initialize_callbacks!(issuable)
@callbacks = available_callbacks.filter_map do |callback_class|
callback_params = params.slice(*callback_class::ALLOWED_PARAMS)
next if callback_params.empty?
callback_class.new(issuable: issuable, current_user: current_user, params: callback_params)
end
remove_callback_params
@callbacks.each(&:after_initialize)
end
def remove_callback_params
available_callbacks.each do |callback_class|
callback_class::ALLOWED_PARAMS.each { |p| params.delete(p) }
end
end
def self.constructor_container_arg(value)
# TODO: Dynamically determining the type of a constructor arg based on the class is an antipattern,
# but the root cause is that Epics::BaseService has some issues that inheritance may not be the
# appropriate pattern. See more details in comments at the top of Epics::BaseService#initialize.
# Follow on issue to address this:
# https://gitlab.com/gitlab-org/gitlab/-/issues/328438
{ container: value }
end
attr_accessor :params
def initialize(container:, current_user: nil, params: {})
# we need to exclude project params since they may come from external requests. project should always
# be passed as part of the service's initializer
super(container: container, current_user: current_user, params: params.except(:project, :project_id))
end
def can_admin_issuable?(issuable)
ability_name = :"admin_#{issuable.to_ability_name}"
can?(current_user, ability_name, issuable)
end
def can_set_issuable_metadata?(issuable)
ability_name = :"set_#{issuable.to_ability_name}_metadata"
can?(current_user, ability_name, issuable)
end
def can_set_confidentiality?(issuable)
can?(current_user, :set_confidentiality, issuable)
end
def filter_params(issuable)
unless can_set_issuable_metadata?(issuable)
params.delete(:assignee_ids)
params.delete(:assignee_id)
params.delete(:add_assignee_ids)
params.delete(:remove_assignee_ids)
params.delete(:due_date)
params.delete(:canonical_issue_id)
params.delete(:project)
params.delete(:discussion_locked)
end
# confidential attribute is a special type of metadata and needs to be allowed to be set
# by non-members on issues in public projects so that security issues can be reported as confidential.
params.delete(:confidential) unless can_set_confidentiality?(issuable)
filter_contact_params(issuable)
filter_assignees(issuable)
filter_severity(issuable)
filter_escalation_status(issuable)
end
def filter_assignees(issuable)
filter_assignees_using_checks(issuable, :assignee_ids)
filter_assignees_using_checks(issuable, :add_assignee_ids)
filter_assignees_using_checks(issuable, :remove_assignee_ids)
end
def filter_assignees_using_checks(issuable, id_key)
return if params[id_key].blank?
unless issuable.allows_multiple_assignees?
params[id_key] = params[id_key].first(1)
end
assignee_ids = params[id_key].select { |assignee_id| user_can_read?(issuable, assignee_id) }
if params[id_key].map(&:to_s) == [IssuableFinder::Params::NONE]
params[id_key] = []
elsif assignee_ids.any?
params[id_key] = assignee_ids
else
params.delete(id_key)
end
end
def user_can_read?(issuable, user_id)
user = User.find_by_id(user_id)
return false unless user
ability_name = :"read_#{issuable.to_ability_name}"
can?(user, ability_name, issuable.resource_parent)
end
def filter_severity(issuable)
severity = params.delete(:severity)
return unless severity && issuable.supports_severity?
return unless can_admin_issuable?(issuable)
severity = IssuableSeverity::DEFAULT unless IssuableSeverity.severities.key?(severity)
return if severity == issuable.severity
params[:issuable_severity_attributes] = { severity: severity }
end
def filter_escalation_status(issuable)
status_params = params.delete(:escalation_status) || {}
status_params.permit! if status_params.respond_to?(:permit!)
result = ::IncidentManagement::IssuableEscalationStatuses::PrepareUpdateService.new(
issuable,
current_user,
status_params
).execute
return unless result.success? && result[:escalation_status].present?
params[:incident_management_issuable_escalation_status_attributes] = result[:escalation_status]
end
def process_assignee_ids(attributes, existing_assignee_ids: nil, extra_assignee_ids: [])
process = Issuable::ProcessAssignees.new(
assignee_ids: attributes.delete(:assignee_ids),
add_assignee_ids: attributes.delete(:add_assignee_ids),
remove_assignee_ids: attributes.delete(:remove_assignee_ids),
existing_assignee_ids: existing_assignee_ids,
extra_assignee_ids: extra_assignee_ids
)
process.execute
end
def handle_quick_actions(issuable)
merge_quick_actions_into_params!(issuable, params: params)
end
# Notes: When the description has been edited, then we need to sanitize and compare with
# the original description, removing any extra quick actions.
# If the description has not been edited, then just remove any quick actions
# in the current description.
def merge_quick_actions_into_params!(issuable, params:, only: nil)
target_description = params.fetch(:description, issuable.description)
description, command_params = QuickActions::InterpretService.new(
container: container,
current_user: current_user,
params: quick_action_options
).execute_with_original_text(target_description, issuable, only: only, original_text: issuable.description_was)
# Avoid a description already set on an issuable to be overwritten by a nil
params[:description] = description if description && description != target_description
params.merge!(command_params)
end
def quick_action_options
{}
end
def create(issuable, skip_system_notes: false)
# Set author early since this is used for ability checks
set_issuable_author(issuable)
handle_quick_actions(issuable)
filter_params(issuable)
params.delete(:state_event)
if issuable.respond_to?(:assignee_ids)
params[:assignee_ids] = process_assignee_ids(params, extra_assignee_ids: issuable.assignee_ids.to_a)
end
params.delete(:remove_contacts)
add_crm_contact_emails = params.delete(:add_contacts)
initialize_callbacks!(issuable)
issuable.assign_attributes(allowed_create_params(params))
before_create(issuable)
issuable_saved = issuable.with_transaction_returning_status do
@callbacks.each(&:before_create)
transaction_create(issuable)
end
if issuable_saved
@callbacks.each(&:after_save_commit)
create_system_notes(issuable, is_update: false) unless skip_system_notes
handle_changes(issuable, { params: params })
after_create(issuable)
set_crm_contacts(issuable, add_crm_contact_emails)
execute_hooks(issuable)
users_to_invalidate = issuable.allows_reviewers? ? issuable.assignees | issuable.reviewers : issuable.assignees
invalidate_cache_counts(issuable, users: users_to_invalidate)
issuable.update_project_counter_caches
end
issuable
end
def set_issuable_author(issuable)
author = params.delete(:author)
author_id = params.delete(:author_id)
if author
issuable.author = author
elsif author_id
issuable.author_id = author_id
else
issuable.author ||= current_user
end
end
def set_crm_contacts(issuable, add_crm_contact_emails, remove_crm_contact_emails = [])
return unless add_crm_contact_emails.present? || remove_crm_contact_emails.present?
::Issues::SetCrmContactsService.new(container: project, current_user: current_user, params: { add_emails: add_crm_contact_emails, remove_emails: remove_crm_contact_emails }).execute(issuable)
end
def before_create(issuable)
# To be overridden by subclasses
end
def after_create(issuable)
# To be overridden by subclasses
end
def before_update(issuable, skip_spam_check: false)
# To be overridden by subclasses
end
def after_update(issuable, old_associations)
handle_description_updated(issuable)
handle_label_changes(issuable, old_associations[:labels])
end
def handle_description_updated(issuable)
return unless issuable.previous_changes.include?('description')
GraphqlTriggers.issuable_description_updated(issuable)
end
def update(issuable)
::Gitlab::Database::LoadBalancing::SessionMap.current(issuable.load_balancer).use_primary!
old_associations = associations_before_update(issuable)
handle_quick_actions(issuable)
filter_params(issuable)
change_additional_attributes(issuable)
assign_requested_assignees(issuable)
assign_requested_crm_contacts(issuable)
widget_params = filter_widget_params
initialize_callbacks!(issuable)
if issuable.changed? || params.present? || widget_params.present? || @callbacks.present?
issuable.assign_attributes(allowed_update_params(params))
before_update(issuable)
# We have to perform this check before saving the issuable as Rails resets
# the changed fields upon calling #save.
update_project_counters = issuable.project && update_project_counter_caches?(issuable)
issuable_saved = issuable.with_transaction_returning_status do
@callbacks.each(&:before_update)
# Do not touch when saving the issuable if only changes position within a list. We should call
# this method at this point to capture all possible changes.
should_touch = update_timestamp?(issuable)
issuable.updated_by = current_user if should_touch
transaction_update(issuable, { save_with_touch: should_touch })
end
if issuable_saved
@callbacks.each(&:after_update_commit)
@callbacks.each(&:after_save_commit)
create_system_notes(
issuable, old_labels: old_associations[:labels], old_milestone: old_associations[:milestone]
)
handle_changes(issuable, old_associations: old_associations, params: params)
new_assignees = issuable.assignees.to_a
affected_assignees = (old_associations[:assignees] + new_assignees) - (old_associations[:assignees] & new_assignees)
invalidate_cache_counts(issuable, users: affected_assignees.compact)
after_update(issuable, old_associations)
issuable.create_new_cross_references!(current_user)
Gitlab::Database::QueryAnalyzers::PreventCrossDatabaseModification.temporary_ignore_tables_in_transaction(
%w[
internal_ids
issues
issue_user_mentions
issue_metrics
notes
system_note_metadata
vulnerability_issue_links
], url: 'https://gitlab.com/gitlab-org/gitlab/-/issues/480369'
) do
execute_hooks(
issuable,
'update',
old_associations: old_associations
)
end
issuable.update_project_counter_caches if update_project_counters
end
end
trigger_update_subscriptions(issuable, old_associations)
issuable
end
# Overriden in child class
def trigger_update_subscriptions(issuable, old_associations); end
def transaction_update(issuable, opts = {})
touch = opts[:save_with_touch] || false
issuable.save(touch: touch).tap do |saved|
if saved
@callbacks.each(&:after_update)
@callbacks.each(&:after_save)
end
end
end
def transaction_create(issuable)
issuable.save.tap do |saved|
if saved
@callbacks.each(&:after_create)
@callbacks.each(&:after_save)
end
end
end
def update_task(issuable)
filter_params(issuable)
if issuable.changed? || params.present?
issuable.assign_attributes(params.merge(
updated_by: current_user,
last_edited_at: Time.current,
last_edited_by: current_user
))
before_update(issuable, skip_spam_check: true)
if issuable.with_transaction_returning_status { transaction_update_task(issuable) }
create_system_notes(issuable, old_labels: nil)
handle_task_changes(issuable)
invalidate_cache_counts(issuable, users: issuable.assignees.to_a)
# not passing old_associations here to keep `update_task` as fast as possible
after_update(issuable, {})
execute_hooks(issuable, 'update', old_associations: nil)
if issuable.is_a?(MergeRequest)
Gitlab::UsageDataCounters::MergeRequestActivityUniqueCounter
.track_task_item_status_changed(user: current_user)
end
end
end
issuable
end
def transaction_update_task(issuable)
issuable.save
end
# Handle the `update_task` event sent from UI. Attempts to update a specific
# line in the markdown and cached html, bypassing any unnecessary updates or checks.
def update_task_event(issuable)
update_task_params = params.delete(:update_task)
return unless update_task_params
tasklist_toggler = TaskListToggleService.new(
issuable.description,
issuable.description_html,
line_source: update_task_params[:line_source],
line_number: update_task_params[:line_number].to_i,
toggle_as_checked: update_task_params[:checked]
)
unless tasklist_toggler.execute
# if we make it here, the data is much newer than we thought it was - fail fast
raise ActiveRecord::StaleObjectError
end
# by updating the description_html field at the same time,
# the markdown cache won't be considered invalid
params[:description] = tasklist_toggler.updated_markdown
params[:description_html] = tasklist_toggler.updated_markdown_html
# since we're updating a very specific line, we don't care whether
# the `lock_version` sent from the FE is the same or not. Just
# make sure the data hasn't changed since we queried it
params[:lock_version] = issuable.lock_version
update_task(issuable)
end
def change_additional_attributes(issuable)
change_state(issuable)
change_subscription(issuable)
change_todo(issuable)
toggle_award(issuable)
end
def change_state(issuable)
case params.delete(:state_event)
when 'reopen'
service_class = reopen_service
when 'close'
service_class = close_service
end
if service_class
service_class.new(**service_class.constructor_container_arg(project), current_user: current_user).execute(issuable)
end
end
def change_subscription(issuable)
case params.delete(:subscription_event)
when 'subscribe'
issuable.subscribe(current_user, project)
when 'unsubscribe'
issuable.unsubscribe(current_user, project)
end
end
# rubocop: disable CodeReuse/ActiveRecord
def change_todo(issuable)
case params.delete(:todo_event)
when 'add'
todo_service.mark_todo(issuable, current_user)
when 'done'
todo = TodosFinder.new(current_user).find_by(target: issuable)
todo_service.resolve_todo(todo, current_user) if todo
end
end
# rubocop: enable CodeReuse/ActiveRecord
def assign_requested_crm_contacts(issuable)
add_crm_contact_emails = params.delete(:add_contacts)
remove_crm_contact_emails = params.delete(:remove_contacts)
set_crm_contacts(issuable, add_crm_contact_emails, remove_crm_contact_emails)
end
def assign_requested_assignees(issuable)
return if issuable.is_a?(Epic)
assignee_ids = process_assignee_ids(params, existing_assignee_ids: issuable.assignee_ids)
if ids_changing?(issuable.assignee_ids, assignee_ids)
params[:assignee_ids] = assignee_ids
issuable.touch
end
end
# Arrays of ids are used, but we should really use sets of ids, so
# let's have an helper to properly check if some ids are changing
def ids_changing?(old_array, new_array)
old_array.sort != new_array.sort
end
def toggle_award(issuable)
award = params.delete(:emoji_award)
AwardEmojis::ToggleService.new(issuable, award, current_user).execute if award
end
def create_system_notes(issuable, **options)
Issuable::CommonSystemNotesService.new(project: project, current_user: current_user).execute(issuable, **options)
end
def associations_before_update(issuable)
associations =
{
labels: issuable.labels.to_a,
mentioned_users: issuable.mentioned_users(current_user).to_a,
assignees: issuable.assignees.to_a,
milestone: issuable.try(:milestone)
}
associations[:total_time_spent] = issuable.total_time_spent if issuable.respond_to?(:total_time_spent)
associations[:time_change] = issuable.time_change if issuable.respond_to?(:time_change)
associations[:description] = issuable.description
associations[:reviewers] = issuable.reviewers.to_a if issuable.allows_reviewers?
associations[:severity] = issuable.severity if issuable.supports_severity?
associations[:target_branch] = issuable.target_branch if issuable.is_a?(MergeRequest)
if issuable.supports_escalation? && issuable.escalation_status
associations[:escalation_status] = issuable.escalation_status.status_name
end
associations
end
def handle_move_between_ids(issuable_position)
return unless params[:move_between_ids]
before_id, after_id = params.delete(:move_between_ids)
positioning_scope = issuable_position.class.relative_positioning_query_base(issuable_position)
issuable_before = issuable_for_positioning(before_id, positioning_scope)
issuable_after = issuable_for_positioning(after_id, positioning_scope)
raise ActiveRecord::RecordNotFound unless issuable_before || issuable_after
issuable_position.move_between(issuable_before, issuable_after)
end
def has_changes?(issuable, old_labels: [], old_assignees: [], old_reviewers: [])
valid_attrs = [:title, :description, :assignee_ids, :reviewer_ids, :milestone_id, :target_branch]
attrs_changed = valid_attrs.any? do |attr|
issuable.previous_changes.include?(attr.to_s)
end
labels_changed = issuable.labels != old_labels
assignees_changed = issuable.assignees != old_assignees
reviewers_changed = issuable.reviewers != old_reviewers if issuable.allows_reviewers?
attrs_changed || labels_changed || assignees_changed || reviewers_changed
end
def has_label_changes?(issuable, old_labels)
return false if old_labels.nil?
Set.new(issuable.labels) != Set.new(old_labels)
end
def invalidate_cache_counts(issuable, users: [])
users.each do |user|
user.public_send("invalidate_#{issuable.noteable_target_type_name}_cache_counts") # rubocop:disable GitlabSecurity/PublicSend
end
end
# override if needed
def handle_label_changes(issuable, old_labels)
return false unless has_label_changes?(issuable, old_labels)
# reset to preserve the label sort order (title ASC)
issuable.labels.reset
GraphqlTriggers.issuable_labels_updated(issuable)
# return true here to avoid checking for label changes in sub classes
true
end
# override if needed
def handle_changes(issuable, options); end
# override if needed
def handle_task_changes(issuable); end
# override if needed
def execute_hooks(issuable, action = 'open', params = {}); end
def update_project_counter_caches?(issuable)
issuable.state_id_changed?
end
def parent
project
end
def update_timestamp?(issuable)
issuable.changes.keys != ["relative_position"]
end
def allowed_create_params(params)
params.except(:observability_links)
end
def allowed_update_params(params)
params
end
def update_issuable_sla(issuable)
return unless issuable_sla = issuable.issuable_sla
issuable_sla.update(issuable_closed: issuable.closed?)
end
def filter_widget_params
params.delete(:widget_params)
end
def filter_contact_params(issuable)
return if params.slice(:add_contacts, :remove_contacts).empty?
return if can?(current_user, :set_issue_crm_contacts, issuable)
params.extract!(:add_contacts, :remove_contacts)
end
end
IssuableBaseService.prepend_mod_with('IssuableBaseService')
|