Class: SystemNotes::IssuablesService

Inherits:
BaseService show all
Defined in:
app/services/system_notes/issuables_service.rb

Constant Summary collapse

USE_COMMIT_DATE_FOR_CROSS_REFERENCE_NOTE =

We create cross-referenced system notes when a commit relates to an issue. There are two options what time to use for the system note:

  1. The push date (default)

  2. The commit date

The commit date is useful when an existing Git repository is imported to GitLab. It helps to preserve an original order of all notes (comments, commits, status changes, e.t.c) in the imported issues. Otherwise, all commits will be linked before or after all other imported notes.

See also the discussion in gitlab.com/gitlab-org/gitlab/-/merge_requests/60700#note_612724683

false

Instance Attribute Summary

Attributes inherited from BaseService

#author, #noteable, #project

Instance Method Summary collapse

Methods inherited from BaseService

#initialize

Constructor Details

This class inherits a constructor from SystemNotes::BaseService

Instance Method Details

#add_email_participants(body) ⇒ Object


435
436
437
# File 'app/services/system_notes/issuables_service.rb', line 435

def add_email_participants(body)
  create_note(NoteSummary.new(noteable, project, author, body))
end

#auto_resolve_prometheus_alertObject


458
459
460
# File 'app/services/system_notes/issuables_service.rb', line 458

def auto_resolve_prometheus_alert
  create_resource_state_event(status: 'closed', close_auto_resolve_prometheus_alert: true)
end

#change_assignee(assignee) ⇒ Object

Called when the assignee of a Noteable is changed or removed

assignee - User being assigned, or nil

Example Note text:

"removed assignee"

"assigned to @rspeicher"

Returns the created Note object


61
62
63
64
65
66
67
# File 'app/services/system_notes/issuables_service.rb', line 61

def change_assignee(assignee)
  body = assignee.nil? ? 'removed assignee' : "assigned to #{assignee.to_reference}"

  issue_activity_counter.track_issue_assignee_changed_action(author: author) if noteable.is_a?(Issue)

  create_note(NoteSummary.new(noteable, project, author, body, action: 'assignee'))
end

#change_descriptionObject

Called when the description of a Noteable is changed

noteable - Noteable object that responds to `description` project - Project owning noteable author - User performing the change

Example Note text:

"changed the description"

Returns the created Note object


192
193
194
195
196
197
198
# File 'app/services/system_notes/issuables_service.rb', line 192

def change_description
  body = 'changed the description'

  issue_activity_counter.track_issue_description_changed_action(author: author) if noteable.is_a?(Issue)

  create_note(NoteSummary.new(noteable, project, author, body, action: 'description'))
end

#change_issuable_assignees(old_assignees) ⇒ Object

Called when the assignees of an issuable is changed or removed

assignees - Users being assigned, or nil

Example Note text:

"removed all assignees"

"assigned to @user1 additionally to @user2"

"assigned to @user1, @user2 and @user3 and unassigned from @user4 and @user5"

"assigned to @user1 and @user2"

Returns the created Note object


84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
# File 'app/services/system_notes/issuables_service.rb', line 84

def change_issuable_assignees(old_assignees)
  unassigned_users = old_assignees - noteable.assignees
  added_users = noteable.assignees.to_a - old_assignees
  text_parts = []

  Gitlab::I18n.with_default_locale do
    text_parts << "assigned to #{added_users.map(&:to_reference).to_sentence}" if added_users.any?
    text_parts << "unassigned #{unassigned_users.map(&:to_reference).to_sentence}" if unassigned_users.any?
  end

  body = text_parts.join(' and ')

  issue_activity_counter.track_issue_assignee_changed_action(author: author) if noteable.is_a?(Issue)

  create_note(NoteSummary.new(noteable, project, author, body, action: 'assignee'))
end

#change_issuable_contacts(added_count, removed_count) ⇒ Object

Called when the contacts of an issuable are changed or removed We intend to reference the contacts but for security we are just going to state how many were added/removed for now. See discussion: gitlab.com/gitlab-org/gitlab/-/merge_requests/77816#note_806114273

added_count - number of contacts added, or 0 removed_count - number of contacts removed, or 0

Example Note text:

"added 2 contacts"

"added 3 contacts and removed one contact"

Returns the created Note object


142
143
144
145
146
147
148
149
150
151
152
153
154
# File 'app/services/system_notes/issuables_service.rb', line 142

def change_issuable_contacts(added_count, removed_count)
  text_parts = []

  Gitlab::I18n.with_default_locale do
    text_parts << "added #{added_count} #{'contact'.pluralize(added_count)}" if added_count > 0
    text_parts << "removed #{removed_count} #{'contact'.pluralize(removed_count)}" if removed_count > 0
  end

  return if text_parts.empty?

  body = text_parts.join(' and ')
  create_note(NoteSummary.new(noteable, project, author, body, action: 'contact'))
end

#change_issuable_reviewers(old_reviewers) ⇒ Object

Called when the reviewers of an issuable is changed or removed

reviewers - Users being requested to review, or nil

Example Note text:

"requested review from @user1 and @user2"

"requested review from @user1, @user2 and @user3 and removed review request for @user4 and @user5"

Returns the created Note object


112
113
114
115
116
117
118
119
120
121
122
123
124
125
# File 'app/services/system_notes/issuables_service.rb', line 112

def change_issuable_reviewers(old_reviewers)
  unassigned_users = old_reviewers - noteable.reviewers
  added_users = noteable.reviewers - old_reviewers
  text_parts = []

  Gitlab::I18n.with_default_locale do
    text_parts << "requested review from #{added_users.map(&:to_reference).to_sentence}" if added_users.any?
    text_parts << "removed review request for #{unassigned_users.map(&:to_reference).to_sentence}" if unassigned_users.any?
  end

  body = text_parts.join(' and ')

  create_note(NoteSummary.new(noteable, project, author, body, action: 'reviewer'))
end

#change_issue_confidentialityObject

Called when the confidentiality changes

Example Note text:

"made the issue confidential"

Returns the created Note object


323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
# File 'app/services/system_notes/issuables_service.rb', line 323

def change_issue_confidentiality
  if noteable.confidential
    body = 'made the issue confidential'
    action = 'confidential'

    issue_activity_counter.track_issue_made_confidential_action(author: author) if noteable.is_a?(Issue)
  else
    body = 'made the issue visible to everyone'
    action = 'visible'

    issue_activity_counter.track_issue_made_visible_action(author: author) if noteable.is_a?(Issue)
  end

  create_note(NoteSummary.new(noteable, project, author, body, action: action))
end

#change_issue_typeObject


462
463
464
465
466
# File 'app/services/system_notes/issuables_service.rb', line 462

def change_issue_type
  body = "changed issue type to #{noteable.issue_type.humanize(capitalize: false)}"

  create_note(NoteSummary.new(noteable, project, author, body, action: 'issue_type'))
end

#change_status(status, source = nil) ⇒ Object

Called when the status of a Noteable is changed

status - String status source - Mentionable performing the change, or nil

Example Note text:

"merged"

"closed via bc17db76"

Returns the created Note object


351
352
353
# File 'app/services/system_notes/issuables_service.rb', line 351

def change_status(status, source = nil)
  create_resource_state_event(status: status, mentionable_source: source)
end

#change_task_status(new_task) ⇒ Object

Called when the status of a Task has changed

new_task - TaskList::Item object.

Example Note text:

"marked the task Whatever as completed."

Returns the created Note object


261
262
263
264
265
266
267
268
# File 'app/services/system_notes/issuables_service.rb', line 261

def change_task_status(new_task)
  status_label = new_task.complete? ? Taskable::COMPLETED : Taskable::INCOMPLETE
  body = "marked the task **#{new_task.source}** as #{status_label}"

  issue_activity_counter.track_issue_description_changed_action(author: author) if noteable.is_a?(Issue)

  create_note(NoteSummary.new(noteable, project, author, body, action: 'task'))
end

#change_title(old_title) ⇒ Object

Called when the title of a Noteable is changed

old_title - Previous String title

Example Note text:

"changed title from **Old** to **New**"

Returns the created Note object


165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
# File 'app/services/system_notes/issuables_service.rb', line 165

def change_title(old_title)
  new_title = noteable.title.dup

  old_diffs, new_diffs = Gitlab::Diff::InlineDiff.new(old_title, new_title).inline_diffs

  marked_old_title = Gitlab::Diff::InlineDiffMarkdownMarker.new(old_title).mark(old_diffs)
  marked_new_title = Gitlab::Diff::InlineDiffMarkdownMarker.new(new_title).mark(new_diffs)

  body = "changed title from **#{marked_old_title}** to **#{marked_new_title}**"

  issue_activity_counter.track_issue_title_changed_action(author: author) if noteable.is_a?(Issue)
  work_item_activity_counter.track_work_item_title_changed_action(author: author) if noteable.is_a?(WorkItem)

  create_note(NoteSummary.new(noteable, project, author, body, action: 'title'))
end

#close_after_error_tracking_resolveObject


454
455
456
# File 'app/services/system_notes/issuables_service.rb', line 454

def close_after_error_tracking_resolve
  create_resource_state_event(status: 'closed', close_after_error_tracking_resolve: true)
end

#cross_reference(mentioned_in) ⇒ Note

Called when a Mentionable (the `mentioned_in`) references another Mentionable (the `mentioned`, passed to this service as `noteable`).

Example Note text:

"mentioned in #1"

"mentioned in !2"

"mentioned in 54f7727c"

See cross_reference_note_content.

Parameters:

Returns:


215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
# File 'app/services/system_notes/issuables_service.rb', line 215

def cross_reference(mentioned_in)
  return if cross_reference_disallowed?(mentioned_in)

  gfm_reference = mentioned_in.gfm_reference(noteable.project || noteable.group)
  body = cross_reference_note_content(gfm_reference)

  if noteable.is_a?(ExternalIssue)
    Integrations::CreateExternalCrossReferenceWorker.perform_async(
      noteable.project_id,
      noteable.id,
      mentioned_in.class.name,
      mentioned_in.id,
      author.id
    )
  else
    track_cross_reference_action
    created_at = mentioner.created_at if USE_COMMIT_DATE_FOR_CROSS_REFERENCE_NOTE && mentioner.is_a?(Commit)
    create_note(NoteSummary.new(noteable, noteable.project, author, body, action: 'cross_reference', created_at: created_at))
  end
end

#cross_reference_disallowed?(mentioned_in) ⇒ Boolean

Check if a cross-reference is disallowed

This method prevents adding a “mentioned in !1” note on every single commit in a merge request. Additionally, it prevents the creation of references to external issues (which would fail).

Parameters:

Returns:

  • (Boolean)

244
245
246
247
248
249
250
# File 'app/services/system_notes/issuables_service.rb', line 244

def cross_reference_disallowed?(mentioned_in)
  return true if noteable.is_a?(ExternalIssue) && !noteable.project&.external_references_supported?
  return false unless mentioned_in.is_a?(MergeRequest)
  return false unless noteable.is_a?(Commit)

  mentioned_in.commits.include?(noteable)
end

#cross_reference_exists?(mentioned_in) ⇒ Boolean

Check if a cross reference to a Mentionable from the `mentioned_in` Mentionable already exists.

This method is used to prevent multiple notes being created for a mention when a issue is updated, for example. The method also calls `existing_mentions_for` to check if the mention is in a commit, and return matches only on commit hash instead of project + commit, to avoid repeated mentions from forks.

Parameters:

Returns:

  • (Boolean)

365
366
367
368
# File 'app/services/system_notes/issuables_service.rb', line 365

def cross_reference_exists?(mentioned_in)
  notes = noteable.notes.system
  existing_mentions_for(mentioned_in, noteable, notes).exists?
end

#discussion_lockObject


439
440
441
442
443
444
445
446
447
448
449
450
451
452
# File 'app/services/system_notes/issuables_service.rb', line 439

def discussion_lock
  action = noteable.discussion_locked? ? 'locked' : 'unlocked'
  body = "#{action} this #{noteable.class.to_s.titleize.downcase}"

  if noteable.is_a?(Issue)
    if action == 'locked'
      issue_activity_counter.track_issue_locked_action(author: author)
    else
      issue_activity_counter.track_issue_unlocked_action(author: author)
    end
  end

  create_note(NoteSummary.new(noteable, project, author, body, action: action))
end

#mark_canonical_issue_of_duplicate(duplicate_issue) ⇒ Object

Called when a Noteable has been marked as the canonical Issue of a duplicate

duplicate_issue - Issue that was a duplicate of this

Example Note text:

"marked #1234 as a duplicate of this issue"

"marked other_project#5678 as a duplicate of this issue"

Returns the created Note object


411
412
413
414
# File 'app/services/system_notes/issuables_service.rb', line 411

def mark_canonical_issue_of_duplicate(duplicate_issue)
  body = "marked #{duplicate_issue.to_reference(project)} as a duplicate of this issue"
  create_note(NoteSummary.new(noteable, project, author, body, action: 'duplicate'))
end

#mark_duplicate_issue(canonical_issue) ⇒ Object

Called when a Noteable has been marked as a duplicate of another Issue

canonical_issue - Issue that this is a duplicate of

Example Note text:

"marked this issue as a duplicate of #1234"

"marked this issue as a duplicate of other_project#5678"

Returns the created Note object


427
428
429
430
431
432
433
# File 'app/services/system_notes/issuables_service.rb', line 427

def mark_duplicate_issue(canonical_issue)
  body = "marked this issue as a duplicate of #{canonical_issue.to_reference(project)}"

  issue_activity_counter.track_issue_marked_as_duplicate_action(author: author) if noteable.is_a?(Issue)

  create_note(NoteSummary.new(noteable, project, author, body, action: 'duplicate'))
end

#noteable_cloned(noteable_ref, direction) ⇒ Object

Called when noteable has been cloned

noteable_ref - Referenced noteable direction - symbol, :to or :from

Example Note text:

"cloned to some_namespace/project_new#11"

Returns the created Note object


303
304
305
306
307
308
309
310
311
312
313
314
# File 'app/services/system_notes/issuables_service.rb', line 303

def noteable_cloned(noteable_ref, direction)
  unless [:to, :from].include?(direction)
    raise ArgumentError, "Invalid direction `#{direction}`"
  end

  cross_reference = noteable_ref.to_reference(project)
  body = "cloned #{direction} #{cross_reference}"

  issue_activity_counter.track_issue_cloned_action(author: author) if noteable.is_a?(Issue) && direction == :to

  create_note(NoteSummary.new(noteable, project, author, body, action: 'cloned'))
end

#noteable_moved(noteable_ref, direction) ⇒ Object

Called when noteable has been moved to another project

noteable_ref - Referenced noteable direction - symbol, :to or :from

Example Note text:

"moved to some_namespace/project_new#11"

Returns the created Note object


280
281
282
283
284
285
286
287
288
289
290
291
# File 'app/services/system_notes/issuables_service.rb', line 280

def noteable_moved(noteable_ref, direction)
  unless [:to, :from].include?(direction)
    raise ArgumentError, "Invalid direction `#{direction}`"
  end

  cross_reference = noteable_ref.to_reference(project)
  body = "moved #{direction} #{cross_reference}"

  issue_activity_counter.track_issue_moved_action(author: author) if noteable.is_a?(Issue)

  create_note(NoteSummary.new(noteable, project, author, body, action: 'moved'))
end

#relate_issuable(noteable_ref) ⇒ Object

noteable_ref - Referenced noteable object

Example Note text:

"marked this issue as related to gitlab-foss#9001"

Returns the created Note object


25
26
27
28
29
30
31
32
# File 'app/services/system_notes/issuables_service.rb', line 25

def relate_issuable(noteable_ref)
  issuable_type = noteable.to_ability_name.humanize(capitalize: false)
  body = "marked this #{issuable_type} as related to #{noteable_ref.to_reference(noteable.resource_parent)}"

  issue_activity_counter.track_issue_related_action(author: author) if noteable.is_a?(Issue)

  create_note(NoteSummary.new(noteable, project, author, body, action: 'relate'))
end

#remove_attention_request(user) ⇒ Object

Called when a user's attention request has been removed for a Notable

user - User's whos attention request has been removed

Example Note text:

"removed attention request from @eli.wisoky"

Returns the created Note object


394
395
396
397
398
# File 'app/services/system_notes/issuables_service.rb', line 394

def remove_attention_request(user)
  body = "removed attention request from #{user.to_reference}"

  create_note(NoteSummary.new(noteable, project, author, body, action: 'attention_request_removed'))
end

#request_attention(user) ⇒ Object

Called when a user's attention has been requested for a Notable

user - User's whos attention has been requested

Example Note text:

"requested attention from @eli.wisoky"

Returns the created Note object


379
380
381
382
383
# File 'app/services/system_notes/issuables_service.rb', line 379

def request_attention(user)
  body = "requested attention from #{user.to_reference}"

  create_note(NoteSummary.new(noteable, project, author, body, action: 'attention_requested'))
end

#unrelate_issuable(noteable_ref) ⇒ Object

noteable_ref - Referenced noteable object

Example Note text:

"removed the relation with gitlab-foss#9001"

Returns the created Note object


42
43
44
45
46
47
48
# File 'app/services/system_notes/issuables_service.rb', line 42

def unrelate_issuable(noteable_ref)
  body = "removed the relation with #{noteable_ref.to_reference(noteable.resource_parent)}"

  issue_activity_counter.track_issue_unrelated_action(author: author) if noteable.is_a?(Issue)

  create_note(NoteSummary.new(noteable, project, author, body, action: 'unrelate'))
end