Class: MergeRequest

Defined Under Namespace

Classes: Metrics

Constant Summary collapse

SORTING_PREFERENCE_FIELD =
:merge_requests_sort
KNOWN_MERGE_PARAMS =
[
  :auto_merge_strategy,
  :should_remove_source_branch,
  :force_remove_source_branch,
  :commit_message,
  :squash_commit_message,
  :sha
].freeze
RebaseLockTimeout =
Class.new(StandardError)
DRAFT_REGEX =

WIP is deprecated in favor of Draft. Currently both options are supported gitlab.com/gitlab-org/gitlab/-/issues/227426

/\A*#{Regexp.union(Gitlab::Regex.merge_request_wip, Gitlab::Regex.merge_request_draft)}+\s*/i.freeze

Constants included from ReactiveCaching

ReactiveCaching::ExceededReactiveCacheLimit, ReactiveCaching::InvalidateReactiveCache, ReactiveCaching::WORK_TYPE

Constants included from ThrottledTouch

ThrottledTouch::TOUCH_INTERVAL

Constants included from Noteable

Noteable::MAX_NOTES_LIMIT

Constants included from Issuable

Issuable::DESCRIPTION_HTML_LENGTH_MAX, Issuable::DESCRIPTION_LENGTH_MAX, Issuable::STATE_ID_MAP, Issuable::TITLE_HTML_LENGTH_MAX, Issuable::TITLE_LENGTH_MAX

Constants included from Taskable

Taskable::COMPLETED, Taskable::COMPLETE_PATTERN, Taskable::INCOMPLETE, Taskable::INCOMPLETE_PATTERN, Taskable::ITEM_PATTERN

Constants included from CacheMarkdownField

CacheMarkdownField::INVALIDATED_BY

Constants included from Redactable

Redactable::UNSUBSCRIBE_PATTERN

Constants included from Gitlab::SQL::Pattern

Gitlab::SQL::Pattern::MIN_CHARS_FOR_PARTIAL_MATCHING, Gitlab::SQL::Pattern::REGEX_QUOTED_WORD

Instance Attribute Summary collapse

Attributes included from Noteable

#system_note_timestamp

Attributes included from Importable

#imported, #importing

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Gitlab::Utils::Override

extended, extensions, included, method_added, override, prepended, queue_verification, verify!

Methods included from ApprovableBase

#approved_by?, #can_be_approved_by?

Methods included from DeprecatedAssignee

#assignee, #assignee=, #assignee_id, #assignee_id=, #assignee_ids, #assignee_ids=, #assignees, #assignees=

Methods included from Gitlab::Utils::StrongMemoize

#clear_memoization, #strong_memoize, #strong_memoized?

Methods included from ThrottledTouch

#touch

Methods included from TimeTrackable

#human_time_estimate, #human_total_time_spent, #spend_time, #time_estimate=, #total_time_spent

Methods included from Presentable

#present

Methods included from Referable

#referable_inspect, #reference_link_text, #to_reference_base

Methods included from Noteable

#after_note_created, #after_note_destroyed, #base_class_name, #capped_notes_count, #discussion_ids_relation, #discussions, #discussions_can_be_resolved_by?, #discussions_resolvable?, #discussions_resolved?, #discussions_to_be_resolved, #expire_note_etag_cache, #grouped_diff_discussions, #has_any_diff_note_positions?, #human_class_name, #lockable?, #note_etag_key, #resolvable_discussions, #supports_discussions?, #supports_replying_to_individual_notes?, #supports_resolvable_notes?

Methods included from Issuable

#assignee_list, #assignee_or_author?, #assignee_username_list, #can_assign_epic?, #can_move?, #card_attributes, #created_hours_ago, #label_names, #labels_array, #new?, #notes_with_associations, #open?, #overdue?, #resource_parent, #state, #state=, #subscribed_without_subscriptions?, #to_ability_name, #to_hook_data, #today?, #updated_tasks, #user_notes_count

Methods included from AfterCommitQueue

#run_after_commit, #run_after_commit_or_now

Methods included from Editable

#edited?, #last_edited_by

Methods included from Taskable

get_tasks, get_updated_tasks, #task_completion_status, #task_list_items, #task_status, #task_status_short, #tasks, #tasks?

Methods included from Awardable

#awarded_emoji?, #downvotes, #emoji_awardable?, #grouped_awards, #upvotes, #user_authored?, #user_can_award?

Methods included from StripAttribute

#strip_attributes

Methods included from Subscribable

#set_subscription, #subscribe, #subscribed?, #subscribed_without_subscriptions?, #subscribers, #toggle_subscription, #unsubscribe

Methods included from Milestoneable

#milestone_available?, #supports_milestone?

Methods included from Mentionable

#all_references, #create_cross_references!, #create_new_cross_references!, #directly_addressed_users, #extractors, #gfm_reference, #local_reference, #matches_cross_reference_regex?, #mentioned_users, #referenced_group_users, #referenced_groups, #referenced_mentionables, #referenced_project_users, #referenced_projects, #referenced_users, #store_mentions!

Methods included from Participable

#participants

Methods included from CacheMarkdownField

#attribute_invalidated?, #cached_html_for, #cached_html_up_to_date?, #can_cache_field?, #invalidated_markdown_cache?, #latest_cached_markdown_version, #local_version, #parent_user, #refresh_markdown_cache, #refresh_markdown_cache!, #rendered_field_content, #skip_project_check?, #updated_cached_html_for

Methods included from IidRoutes

#to_param

Methods included from AtomicInternalId

#internal_id_read_scope, #internal_id_scope_attrs, #internal_id_scope_usage

Methods inherited from ApplicationRecord

at_most, id_in, id_not_in, iid_in, pluck_primary_key, primary_key_in, safe_ensure_unique, safe_find_or_create_by, safe_find_or_create_by!, underscore, without_order

Instance Attribute Details

#allow_brokenObject

When this attribute is true some MR validation is ignored It allows us to close or modify broken merge requests


117
118
119
# File 'app/models/merge_request.rb', line 117

def allow_broken
  @allow_broken
end

#can_be_createdObject

Temporary fields to store compare vars when creating new merge request


121
122
123
# File 'app/models/merge_request.rb', line 121

def can_be_created
  @can_be_created
end

#compareObject

Temporary fields to store compare vars when creating new merge request


121
122
123
# File 'app/models/merge_request.rb', line 121

def compare
  @compare
end

#compare_commitsObject

Temporary fields to store compare vars when creating new merge request


121
122
123
# File 'app/models/merge_request.rb', line 121

def compare_commits
  @compare_commits
end

#diff_optionsObject

Temporary fields to store compare vars when creating new merge request


121
122
123
# File 'app/models/merge_request.rb', line 121

def diff_options
  @diff_options
end

#source_branch_shaObject


743
744
745
# File 'app/models/merge_request.rb', line 743

def source_branch_sha
  @source_branch_sha || source_branch_head.try(:sha)
end

#target_branch_shaObject


739
740
741
# File 'app/models/merge_request.rb', line 739

def target_branch_sha
  @target_branch_sha || target_branch_head.try(:sha)
end

Class Method Details

.available_state_namesObject

Keep states definition to be evaluated before the state_machine block to avoid spec failures. If this gets evaluated after, the `merged` and `locked` states which are overrided can be nil.


125
126
127
# File 'app/models/merge_request.rb', line 125

def self.available_state_names
  super + [:merged, :locked]
end

.in_projects(relation) ⇒ Object

Returns all the merge requests from an ActiveRecord:Relation.

This method uses a UNION as it usually operates on the result of ProjectsFinder#execute. PostgreSQL in particular doesn't always like queries using multiple sub-queries especially when combined with an OR statement. UNIONs on the other hand perform much better in these cases.

relation - An ActiveRecord::Relation that returns a list of Projects.

Returns an ActiveRecord::Relation.


403
404
405
406
407
408
409
410
# File 'app/models/merge_request.rb', line 403

def self.in_projects(relation)
  # unscoping unnecessary conditions that'll be applied
  # when executing `where("merge_requests.id IN (#{union.to_sql})")`
  source = unscoped.where(source_project_id: relation)
  target = unscoped.where(target_project_id: relation)

  from_union([source, target])
end

381
382
383
# File 'app/models/merge_request.rb', line 381

def self.link_reference_pattern
  @link_reference_pattern ||= super("merge_requests", /(?<merge_request>\d+)/)
end

.merge_request_ref?(ref) ⇒ Boolean

Returns:

  • (Boolean)

1288
1289
1290
# File 'app/models/merge_request.rb', line 1288

def self.merge_request_ref?(ref)
  ref.start_with?("refs/#{Repository::REF_MERGE_REQUEST}/")
end

.merge_train_ref?(ref) ⇒ Boolean

Returns:

  • (Boolean)

1292
1293
1294
# File 'app/models/merge_request.rb', line 1292

def self.merge_train_ref?(ref)
  %r{\Arefs/#{Repository::REF_MERGE_REQUEST}/\d+/train\z}.match?(ref)
end

.project_foreign_keyObject


389
390
391
# File 'app/models/merge_request.rb', line 389

def self.project_foreign_key
  'target_project_id'
end

.recent_target_branches(limit: 100) ⇒ Object

Returns the top 100 target branches

The returned value is a Array containing branch names sort by updated_at of merge request:

['master', 'develop', 'production']

limit - The maximum number of target branch to return.


333
334
335
336
337
338
339
# File 'app/models/merge_request.rb', line 333

def self.recent_target_branches(limit: 100)
  group(:target_branch)
    .select(:target_branch)
    .reorder(arel_table[:updated_at].maximum.desc)
    .limit(limit)
    .pluck(:target_branch)
end

.reference_patternObject

Pattern used to extract `!123` merge request references from text

This pattern supports cross-project references.


374
375
376
377
378
379
# File 'app/models/merge_request.rb', line 374

def self.reference_pattern
  @reference_pattern ||= %r{
    (#{Project.reference_pattern})?
    #{Regexp.escape(reference_prefix)}(?<merge_request>\d+)
  }x
end

.reference_prefixObject


321
322
323
# File 'app/models/merge_request.rb', line 321

def self.reference_prefix
  '!'
end

.reference_valid?(reference) ⇒ Boolean

Returns:

  • (Boolean)

385
386
387
# File 'app/models/merge_request.rb', line 385

def self.reference_valid?(reference)
  reference.to_i > 0 && reference.to_i <= Gitlab::Database::MAX_INT_VALUE
end

.set_latest_merge_request_diff_ids!Object

This is used after project import, to reset the IDs to the correct values. It is not intended to be called without having already scoped the relation.


415
416
417
418
419
420
421
422
423
424
425
426
# File 'app/models/merge_request.rb', line 415

def self.set_latest_merge_request_diff_ids!
  update = '
    latest_merge_request_diff_id = (
      SELECT MAX(id)
      FROM merge_request_diffs
      WHERE merge_requests.id = merge_request_diffs.merge_request_id
    )'.squish

  self.each_batch do |batch|
    batch.update_all(update)
  end
end

.sort_by_attribute(method, excluded_labels: []) ⇒ Object


341
342
343
344
345
346
347
348
# File 'app/models/merge_request.rb', line 341

def self.sort_by_attribute(method, excluded_labels: [])
  case method.to_s
  when 'merged_at', 'merged_at_asc' then order_merged_at_asc.with_order_id_desc
  when 'merged_at_desc' then order_merged_at_desc.with_order_id_desc
  else
    super
  end
end

.wip_title(title) ⇒ Object


440
441
442
# File 'app/models/merge_request.rb', line 440

def self.wip_title(title)
  work_in_progress?(title) ? title : "Draft: #{title}"
end

.wipless_title(title) ⇒ Object


436
437
438
# File 'app/models/merge_request.rb', line 436

def self.wipless_title(title)
  title.sub(DRAFT_REGEX, "")
end

.work_in_progress?(title) ⇒ Boolean

Returns:

  • (Boolean)

432
433
434
# File 'app/models/merge_request.rb', line 432

def self.work_in_progress?(title)
  !!(title =~ DRAFT_REGEX)
end

Instance Method Details

#actual_head_pipelineObject

Use this method whenever you need to make sure the head_pipeline is synced with the branch head commit, for example checking if a merge request can be merged. For more information check: gitlab.com/gitlab-org/gitlab-foss/issues/40004


357
358
359
# File 'app/models/merge_request.rb', line 357

def actual_head_pipeline
  head_pipeline&.matches_sha_or_source_sha?(diff_head_sha) ? head_pipeline : nil
end

#all_commit_shasObject

Note that this could also return SHA from now dangling commits


1463
1464
1465
1466
1467
1468
1469
# File 'app/models/merge_request.rb', line 1463

def all_commit_shas
  @all_commit_shas ||= begin
    return commit_shas unless persisted?

    all_commits.pluck(:sha).uniq
  end
end

#all_commitsObject


1455
1456
1457
1458
1459
# File 'app/models/merge_request.rb', line 1455

def all_commits
  MergeRequestDiffCommit
    .where(merge_request_diff: merge_request_diffs.recent)
    .limit(10_000)
end

#all_pipelinesObject


1330
1331
1332
1333
1334
# File 'app/models/merge_request.rb', line 1330

def all_pipelines
  strong_memoize(:all_pipelines) do
    Ci::PipelinesForMergeRequestFinder.new(self, nil).all
  end
end

#allow_collaborationObject Also known as: allow_collaboration?


1613
1614
1615
# File 'app/models/merge_request.rb', line 1613

def allow_collaboration
  collaborative_push_possible? && allow_maintainer_to_push
end

#allows_reviewers?Boolean

Returns:

  • (Boolean)

1678
1679
1680
# File 'app/models/merge_request.rb', line 1678

def allows_reviewers?
  Feature.enabled?(:merge_request_reviewers, project)
end

#auto_merge_strategyObject


1006
1007
1008
1009
1010
# File 'app/models/merge_request.rb', line 1006

def auto_merge_strategy
  return unless auto_merge_enabled?

  merge_params['auto_merge_strategy'] || AutoMergeService::STRATEGY_MERGE_WHEN_PIPELINE_SUCCEEDS
end

#auto_merge_strategy=(strategy) ⇒ Object


1012
1013
1014
# File 'app/models/merge_request.rb', line 1012

def auto_merge_strategy=(strategy)
  merge_params['auto_merge_strategy'] = strategy
end

#banzai_render_context(field) ⇒ Object


1650
1651
1652
# File 'app/models/merge_request.rb', line 1650

def banzai_render_context(field)
  super.merge(label_url_method: :project_merge_requests_url)
end

#base_pipelineObject


1587
1588
1589
1590
1591
# File 'app/models/merge_request.rb', line 1587

def base_pipeline
  @base_pipeline ||= project.ci_pipelines
    .order(id: :desc)
    .find_by(sha: diff_base_sha, ref: target_branch)
end

#branch_merge_base_commitObject


730
731
732
733
734
735
736
737
# File 'app/models/merge_request.rb', line 730

def branch_merge_base_commit
  start_sha = target_branch_sha
  head_sha  = source_branch_sha

  if start_sha && head_sha
    target_project.merge_base_commit(start_sha, head_sha)
  end
end

#branch_merge_base_shaObject


767
768
769
# File 'app/models/merge_request.rb', line 767

def branch_merge_base_sha
  branch_merge_base_commit.try(:sha)
end

#branch_missing?Boolean

Returns:

  • (Boolean)

1205
1206
1207
# File 'app/models/merge_request.rb', line 1205

def branch_missing?
  !source_branch_exists? || !target_branch_exists?
end

#broken?Boolean

Returns:

  • (Boolean)

1209
1210
1211
# File 'app/models/merge_request.rb', line 1209

def broken?
  has_no_commits? || branch_missing? || cannot_be_merged?
end

#cache_merge_request_closes_issues!(current_user = self.author) ⇒ Object

If the merge request closes any issues, save this information in the `MergeRequestsClosingIssues` model. This is a performance optimization. Calculating this information for a number of merge requests requires running `ReferenceExtractor` on each of them separately. This optimization does not apply to issues from external sources.


1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
# File 'app/models/merge_request.rb', line 1072

def cache_merge_request_closes_issues!(current_user = self.author)
  return unless project.issues_enabled?
  return if closed? || merged?

  transaction do
    self.merge_requests_closing_issues.delete_all

    closes_issues(current_user).each do |issue|
      next if issue.is_a?(ExternalIssue)

      self.merge_requests_closing_issues.create!(issue: issue)
    end
  end
end

#calculate_reactive_cache(identifier, current_user_id = nil, report_type = nil, *args) ⇒ Object

Raises:

  • (NameError)

1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
# File 'app/models/merge_request.rb', line 1444

def calculate_reactive_cache(identifier, current_user_id = nil, report_type = nil, *args)
  service_class = identifier.constantize

  # TODO: the type check should change to something that includes exposed artifacts service
  # issue: https://gitlab.com/gitlab-org/gitlab/issues/34224
  raise NameError, service_class unless service_class < Ci::CompareReportsBaseService

  current_user = User.find_by(id: current_user_id)
  service_class.new(project, current_user, id: id, report_type: report_type).execute(base_pipeline, actual_head_pipeline)
end

#can_allow_collaboration?(user) ⇒ Boolean

Returns:

  • (Boolean)

1626
1627
1628
1629
# File 'app/models/merge_request.rb', line 1626

def can_allow_collaboration?(user)
  collaborative_push_possible? &&
    Ability.allowed?(user, :push_code, source_project)
end

#can_be_cherry_picked?Boolean

Returns:

  • (Boolean)

1517
1518
1519
# File 'app/models/merge_request.rb', line 1517

def can_be_cherry_picked?
  merge_commit.present?
end

#can_be_merged_by?(user) ⇒ Boolean

Returns:

  • (Boolean)

1213
1214
1215
1216
# File 'app/models/merge_request.rb', line 1213

def can_be_merged_by?(user)
  access = ::Gitlab::UserAccess.new(user, container: project)
  access.can_update_branch?(target_branch)
end

#can_be_merged_via_command_line_by?(user) ⇒ Boolean

Returns:

  • (Boolean)

1218
1219
1220
1221
# File 'app/models/merge_request.rb', line 1218

def can_be_merged_via_command_line_by?(user)
  access = ::Gitlab::UserAccess.new(user, container: project)
  access.can_push_to_branch?(target_branch)
end

#can_be_reverted?(current_user) ⇒ Boolean

Returns:

  • (Boolean)

1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
# File 'app/models/merge_request.rb', line 1492

def can_be_reverted?(current_user)
  return false unless merge_commit
  return false unless merged_at

  # It is not guaranteed that Note#created_at will be strictly later than
  # MergeRequestMetric#merged_at. Nanoseconds on MySQL may break this
  # comparison, as will a HA environment if clocks are not *precisely*
  # synchronized. Add a minute's leeway to compensate for both possibilities
  cutoff = merged_at - 1.minute

  notes_association = notes_with_associations.where('created_at >= ?', cutoff)

  !merge_commit.has_been_reverted?(current_user, notes_association)
end

#can_cancel_auto_merge?(current_user) ⇒ Boolean

Returns:

  • (Boolean)

986
987
988
# File 'app/models/merge_request.rb', line 986

def can_cancel_auto_merge?(current_user)
  can_be_merged_by?(current_user) || self.author == current_user
end

#can_remove_source_branch?(current_user) ⇒ Boolean

Returns:

  • (Boolean)

990
991
992
993
994
995
996
# File 'app/models/merge_request.rb', line 990

def can_remove_source_branch?(current_user)
  source_project &&
    !ProtectedBranch.protected?(source_project, source_branch) &&
    !source_project.root_ref?(source_branch) &&
    Ability.allowed?(current_user, :push_code, source_project) &&
    diff_head_sha == source_branch_head.try(:sha)
end

#check_mergeability(async: false) ⇒ Object


916
917
918
919
920
921
922
923
924
925
926
# File 'app/models/merge_request.rb', line 916

def check_mergeability(async: false)
  return unless recheck_merge_status?

  check_service = MergeRequests::MergeabilityCheckService.new(self)

  if async
    check_service.async_execute
  else
    check_service.execute(retry_lease: false)
  end
end

#cleanup_refs(only: :all) ⇒ Object


1279
1280
1281
1282
1283
1284
1285
1286
# File 'app/models/merge_request.rb', line 1279

def cleanup_refs(only: :all)
  target_refs = []
  target_refs << ref_path       if %i[all head].include?(only)
  target_refs << merge_ref_path if %i[all merge].include?(only)
  target_refs << train_ref_path if %i[all train].include?(only)

  project.repository.delete_refs(*target_refs)
end

#clear_memoized_shasObject


895
896
897
898
899
900
# File 'app/models/merge_request.rb', line 895

def clear_memoized_shas
  @target_branch_sha = @source_branch_sha = nil

  clear_memoization(:source_branch_head)
  clear_memoization(:target_branch_head)
end

#closed_eventObject


943
944
945
# File 'app/models/merge_request.rb', line 943

def closed_event
  @closed_event ||= target_project.events.where(target_id: self.id, target_type: "MergeRequest", action: :closed).last
end

#closed_without_fork?Boolean

Returns:

  • (Boolean)

834
835
836
# File 'app/models/merge_request.rb', line 834

def closed_without_fork?
  closed? && source_project_missing?
end

#closes_issues(current_user = self.author) ⇒ Object

Return the set of issues that will be closed if this merge request is accepted.


1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
# File 'app/models/merge_request.rb', line 1100

def closes_issues(current_user = self.author)
  if target_branch == project.default_branch
    messages = [title, description]
    messages.concat(commits.map(&:safe_message)) if merge_request_diff.persisted?

    Gitlab::ClosingIssueExtractor.new(project, current_user)
      .closed_by_message(messages.join("\n"))
  else
    []
  end
end

#collaborative_push_possible?Boolean

Returns:

  • (Boolean)

1619
1620
1621
1622
1623
1624
# File 'app/models/merge_request.rb', line 1619

def collaborative_push_possible?
  source_project.present? && for_fork? &&
    target_project.visibility_level > Gitlab::VisibilityLevel::PRIVATE &&
    source_project.visibility_level > Gitlab::VisibilityLevel::PRIVATE &&
    !ProtectedBranch.protected?(source_project, source_branch)
end

#commit_notesObject


1043
1044
1045
1046
1047
1048
1049
1050
1051
# File 'app/models/merge_request.rb', line 1043

def commit_notes
  # Fetch comments only from last 100 commits
  commit_ids = commit_shas(limit: 100)

  Note
    .user
    .where(project_id: [source_project_id, target_project_id])
    .for_commit_id(commit_ids)
end

#commit_shas(limit: nil) ⇒ Object


504
505
506
507
508
509
510
511
512
513
514
515
# File 'app/models/merge_request.rb', line 504

def commit_shas(limit: nil)
  return merge_request_diff.commit_shas(limit: limit) if merge_request_diff.persisted?

  shas =
    if compare_commits
      compare_commits.to_a.reverse.map(&:sha)
    else
      Array(diff_head_sha)
    end

  limit ? shas.take(limit) : shas
end

#commits(limit: nil) ⇒ Object


477
478
479
480
481
482
483
484
485
486
487
488
# File 'app/models/merge_request.rb', line 477

def commits(limit: nil)
  return merge_request_diff.commits(limit: limit) if merge_request_diff.persisted?

  commits_arr = if compare_commits
                  reversed_commits = compare_commits.reverse
                  limit ? reversed_commits.take(limit) : reversed_commits
                else
                  []
                end

  CommitCollection.new(source_project, commits_arr, source_branch)
end

#commits_countObject


494
495
496
497
498
499
500
501
502
# File 'app/models/merge_request.rb', line 494

def commits_count
  if merge_request_diff.persisted?
    merge_request_diff.commits_count
  elsif compare_commits
    compare_commits.size
  else
    0
  end
end

#committersObject


444
445
446
# File 'app/models/merge_request.rb', line 444

def committers
  @committers ||= commits.committers
end

#compare_accessibility_reportsObject


1386
1387
1388
1389
1390
1391
1392
# File 'app/models/merge_request.rb', line 1386

def compare_accessibility_reports
  unless has_accessibility_reports?
    return { status: :error, status_reason: _('This merge request does not have accessibility reports') }
  end

  compare_reports(Ci::CompareAccessibilityReportsService)
end

#compare_reports(service_class, current_user = nil, report_type = nil) ⇒ Object

TODO: consider renaming this as with exposed artifacts we generate reports, not always compare issue: gitlab.com/gitlab-org/gitlab/issues/34224


1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
# File 'app/models/merge_request.rb', line 1433

def compare_reports(service_class, current_user = nil, report_type = nil )
  with_reactive_cache(service_class.name, current_user&.id, report_type) do |data|
    unless service_class.new(project, current_user, id: id, report_type: report_type)
      .latest?(base_pipeline, actual_head_pipeline, data)
      raise InvalidateReactiveCache
    end

    data
  end || { status: :parsing }
end

#compare_test_reportsObject


1364
1365
1366
1367
1368
1369
1370
# File 'app/models/merge_request.rb', line 1364

def compare_test_reports
  unless has_test_reports?
    return { status: :error, status_reason: 'This merge request does not have test reports' }
  end

  compare_reports(Ci::CompareTestReportsService)
end

#context_commits(limit: nil) ⇒ Object


465
466
467
# File 'app/models/merge_request.rb', line 465

def context_commits(limit: nil)
  @context_commits ||= merge_request_context_commits.order_by_committed_date_desc.limit(limit).map(&:to_commit)
end

#context_commits_countObject


473
474
475
# File 'app/models/merge_request.rb', line 473

def context_commits_count
  context_commits.count
end

#create_merge_request_diffObject


853
854
855
856
857
858
859
860
861
# File 'app/models/merge_request.rb', line 853

def create_merge_request_diff
  fetch_ref!

  # n+1: https://gitlab.com/gitlab-org/gitlab-foss/issues/37435
  Gitlab::GitalyClient.allow_n_plus_1_calls do
    merge_request_diffs.create!
    reload_merge_request_diff
  end
end

#default_merge_commit_message(include_description: false) ⇒ Object


1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
# File 'app/models/merge_request.rb', line 1165

def default_merge_commit_message(include_description: false)
  closes_issues_references = visible_closing_issues_for.map do |issue|
    issue.to_reference(target_project)
  end

  message = [
    "Merge branch '#{source_branch}' into '#{target_branch}'",
    title
  ]

  if !include_description && closes_issues_references.present?
    message << "Closes #{closes_issues_references.to_sentence}"
  end

  message << "#{description}" if include_description && description.present?
  message << "See merge request #{to_reference(full: true)}"

  message.join("\n\n")
end

#default_squash_commit_messageObject

Returns the oldest multi-line commit message, or the MR title if none found


1186
1187
1188
1189
1190
# File 'app/models/merge_request.rb', line 1186

def default_squash_commit_message
  strong_memoize(:default_squash_commit_message) do
    recent_commits.without_merge_commits.reverse_each.find(&:description?)&.safe_message || title
  end
end

#diff_base_commitObject


648
649
650
651
652
653
654
# File 'app/models/merge_request.rb', line 648

def diff_base_commit
  if merge_request_diff.persisted?
    merge_request_diff.base_commit
  else
    branch_merge_base_commit
  end
end

#diff_base_shaObject


680
681
682
683
684
685
686
# File 'app/models/merge_request.rb', line 680

def diff_base_sha
  if merge_request_diff.persisted?
    merge_request_diff.base_commit_sha
  else
    branch_merge_base_commit.try(:sha)
  end
end

#diff_head_commitObject


664
665
666
667
668
669
670
# File 'app/models/merge_request.rb', line 664

def diff_head_commit
  if merge_request_diff.persisted?
    merge_request_diff.head_commit
  else
    source_branch_head
  end
end

#diff_head_shaObject


688
689
690
691
692
693
694
# File 'app/models/merge_request.rb', line 688

def diff_head_sha
  if merge_request_diff.persisted?
    merge_request_diff.head_commit_sha
  else
    source_branch_head.try(:sha)
  end
end

#diff_refsObject


747
748
749
750
751
752
753
# File 'app/models/merge_request.rb', line 747

def diff_refs
  if importing? || persisted?
    merge_request_diff.diff_refs
  else
    repository_diff_refs
  end
end

#diff_sizeObject


628
629
630
631
632
# File 'app/models/merge_request.rb', line 628

def diff_size
  # Calling `merge_request_diff.diffs.real_size` will also perform
  # highlighting, which we don't need here.
  merge_request_diff&.real_size || diff_stats&.real_size || diffs.real_size
end

#diff_start_commitObject


656
657
658
659
660
661
662
# File 'app/models/merge_request.rb', line 656

def diff_start_commit
  if merge_request_diff.persisted?
    merge_request_diff.start_commit
  else
    target_branch_head
  end
end

#diff_start_shaObject


672
673
674
675
676
677
678
# File 'app/models/merge_request.rb', line 672

def diff_start_sha
  if merge_request_diff.persisted?
    merge_request_diff.start_commit_sha
  else
    target_branch_head.try(:sha)
  end
end

#diff_statsObject


620
621
622
623
624
625
626
# File 'app/models/merge_request.rb', line 620

def diff_stats
  return unless diff_refs

  strong_memoize(:diff_stats) do
    project.repository.diff_stats(diff_refs.base_sha, diff_refs.head_sha)
  end
end

#diffable_merge_ref?Boolean

rubocop: enable CodeReuse/ServiceClass

Returns:

  • (Boolean)

929
930
931
# File 'app/models/merge_request.rb', line 929

def diffable_merge_ref?
  can_be_merged? && merge_ref_head.present?
end

#diffs(diff_options = {}) ⇒ Object


573
574
575
576
577
578
579
580
581
582
# File 'app/models/merge_request.rb', line 573

def diffs(diff_options = {})
  if compare
    # When saving MR diffs, `expanded` is implicitly added (because we need
    # to save the entire contents to the DB), so add that here for
    # consistency.
    compare.diffs(diff_options.merge(expanded: true))
  else
    merge_request_diff.diffs(diff_options)
  end
end

#discussions_diffsObject


609
610
611
612
613
614
615
616
617
618
# File 'app/models/merge_request.rb', line 609

def discussions_diffs
  strong_memoize(:discussions_diffs) do
    note_diff_files = NoteDiffFile
      .joins(:diff_note)
      .merge(notes.or(commit_notes))
      .includes(diff_note: :project)

    Gitlab::DiscussionsDiff::FileCollection.new(note_diff_files.to_a)
  end
end

#discussions_rendered_on_frontend?Boolean

Returns:

  • (Boolean)

1593
1594
1595
# File 'app/models/merge_request.rb', line 1593

def discussions_rendered_on_frontend?
  true
end

#diverged_commits_countObject


1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
# File 'app/models/merge_request.rb', line 1303

def diverged_commits_count
  cache = Rails.cache.read(:"merge_request_#{id}_diverged_commits")

  if cache.blank? || cache[:source_sha] != source_branch_sha || cache[:target_sha] != target_branch_sha
    cache = {
      source_sha: source_branch_sha,
      target_sha: target_branch_sha,
      diverged_commits_count: compute_diverged_commits_count
    }
    Rails.cache.write(:"merge_request_#{id}_diverged_commits", cache)
  end

  cache[:diverged_commits_count]
end

#diverged_from_target_branch?Boolean

Returns:

  • (Boolean)

1326
1327
1328
# File 'app/models/merge_request.rb', line 1326

def diverged_from_target_branch?
  diverged_commits_count > 0
end

#ensure_merge_request_diffObject


849
850
851
# File 'app/models/merge_request.rb', line 849

def ensure_merge_request_diff
  merge_request_diff.persisted? || create_merge_request_diff
end

#ensure_metricsObject


1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
# File 'app/models/merge_request.rb', line 1655

def ensure_metrics
  # Backward compatibility: some merge request metrics records will not have target_project_id filled in.
  # In that case the first `safe_find_or_create_by` will return false.
  # The second finder call will be eliminated in https://gitlab.com/gitlab-org/gitlab/-/issues/233507
  metrics_record = MergeRequest::Metrics.safe_find_or_create_by(merge_request_id: id, target_project_id: target_project_id) || MergeRequest::Metrics.safe_find_or_create_by(merge_request_id: id)

  metrics_record.tap do |metrics_record|
    # Make sure we refresh the loaded association object with the newly created/loaded item.
    # This is needed in order to have the exact functionality than before.
    #
    # Example:
    #
    # merge_request.metrics.destroy
    # merge_request.ensure_metrics
    # merge_request.metrics # should return the metrics record and not nil
    # merge_request.metrics.merge_request # should return the same MR record

    metrics_record.target_project_id = target_project_id
    metrics_record.association(:merge_request).target = self
    association(:metrics).target = metrics_record
  end
end

#environmentsObject

This method is for looking for active environments which created via pipelines for merge requests. Since deployments run on a merge request ref (e.g. `refs/merge-requests/:iid/head`), we cannot look up environments with source branch name.


1249
1250
1251
1252
1253
# File 'app/models/merge_request.rb', line 1249

def environments
  return Environment.none unless actual_head_pipeline&.merge_request?

  actual_head_pipeline.environments
end

#environments_for(current_user, latest: false) ⇒ Object


1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
# File 'app/models/merge_request.rb', line 1231

def environments_for(current_user, latest: false)
  return [] unless diff_head_commit

  envs = EnvironmentsFinder.new(target_project, current_user,
    ref: target_branch, commit: diff_head_commit, with_tags: true, find_latest: latest).execute

  if source_project
    envs.concat EnvironmentsFinder.new(source_project, current_user,
      ref: source_branch, commit: diff_head_commit, find_latest: latest).execute
  end

  envs.uniq
end

#etag_caching_enabled?Boolean

Returns:

  • (Boolean)

1642
1643
1644
# File 'app/models/merge_request.rb', line 1642

def etag_caching_enabled?
  true
end

#fetch_ref!Object


1255
1256
1257
# File 'app/models/merge_request.rb', line 1255

def fetch_ref!
  target_project.repository.fetch_source_branch!(source_project.repository, source_branch, ref_path)
end

#ff_merge_possible?Boolean

Returns:

  • (Boolean)

978
979
980
# File 'app/models/merge_request.rb', line 978

def ff_merge_possible?
  project.repository.ancestor?(target_branch_sha, diff_head_sha)
end

#find_actual_head_pipelineObject


1638
1639
1640
# File 'app/models/merge_request.rb', line 1638

def find_actual_head_pipeline
  all_pipelines.for_sha_or_source_sha(diff_head_sha).first
end

#find_coverage_reportsObject

TODO: this method and compare_test_reports use the same result type, which is handled by the controller's #reports_response. we should minimize mistakes by isolating the common parts. issue: gitlab.com/gitlab-org/gitlab/issues/34224


1398
1399
1400
1401
1402
1403
1404
# File 'app/models/merge_request.rb', line 1398

def find_coverage_reports
  unless has_coverage_reports?
    return { status: :error, status_reason: 'This merge request does not have coverage reports' }
  end

  compare_reports(Ci::GenerateCoverageReportsService)
end

#find_exposed_artifactsObject

TODO: this method and compare_test_reports use the same result type, which is handled by the controller's #reports_response. we should minimize mistakes by isolating the common parts. issue: gitlab.com/gitlab-org/gitlab/issues/34224


1422
1423
1424
1425
1426
1427
1428
# File 'app/models/merge_request.rb', line 1422

def find_exposed_artifacts
  unless has_exposed_artifacts?
    return { status: :error, status_reason: 'This merge request does not have exposed artifacts' }
  end

  compare_reports(Ci::GenerateExposedArtifactsReportService)
end

#find_terraform_reportsObject


1406
1407
1408
1409
1410
1411
1412
# File 'app/models/merge_request.rb', line 1406

def find_terraform_reports
  unless has_terraform_reports?
    return { status: :error, status_reason: 'This merge request does not have terraform reports' }
  end

  compare_reports(Ci::GenerateTerraformReportsService)
end

#first_commitObject


565
566
567
# File 'app/models/merge_request.rb', line 565

def first_commit
  compare_commits.present? ? compare_commits.first : merge_request_diff.first_commit
end

#first_contribution?Boolean

rubocop: enable CodeReuse/ServiceClass

Returns:

  • (Boolean)

1603
1604
1605
1606
1607
# File 'app/models/merge_request.rb', line 1603

def first_contribution?
  return false if project.team.max_member_access(author_id) > Gitlab::Access::GUEST

  project.merge_requests.merged.where(author_id: author_id).empty?
end

#for_fork?Boolean

Returns:

  • (Boolean)

1059
1060
1061
# File 'app/models/merge_request.rb', line 1059

def for_fork?
  target_project != source_project
end

#for_same_project?Boolean

Returns:

  • (Boolean)

1063
1064
1065
# File 'app/models/merge_request.rb', line 1063

def for_same_project?
  target_project == source_project
end

#force_remove_source_branch?Boolean

Returns:

  • (Boolean)

1002
1003
1004
# File 'app/models/merge_request.rb', line 1002

def force_remove_source_branch?
  Gitlab::Utils.to_boolean(merge_params['force_remove_source_branch'])
end

#has_accessibility_reports?Boolean

Returns:

  • (Boolean)

1372
1373
1374
# File 'app/models/merge_request.rb', line 1372

def has_accessibility_reports?
  actual_head_pipeline.present? && actual_head_pipeline.has_reports?(Ci::JobArtifact.accessibility_reports)
end

#has_ci?Boolean

Returns:

  • (Boolean)

1199
1200
1201
1202
1203
# File 'app/models/merge_request.rb', line 1199

def has_ci?
  return false if has_no_commits?

  !!(head_pipeline_id || all_pipelines.any? || source_project&.ci_service)
end

#has_commits?Boolean

Returns:

  • (Boolean)

1561
1562
1563
# File 'app/models/merge_request.rb', line 1561

def has_commits?
  merge_request_diff.persisted? && commits_count.to_i > 0
end

#has_complete_diff_refs?Boolean

Returns:

  • (Boolean)

1521
1522
1523
# File 'app/models/merge_request.rb', line 1521

def has_complete_diff_refs?
  diff_refs && diff_refs.complete?
end

#has_coverage_reports?Boolean

Returns:

  • (Boolean)

1376
1377
1378
1379
1380
# File 'app/models/merge_request.rb', line 1376

def has_coverage_reports?
  return false unless Feature.enabled?(:coverage_report_view, project)

  actual_head_pipeline&.has_coverage_reports?
end

#has_exposed_artifacts?Boolean

Returns:

  • (Boolean)

1414
1415
1416
# File 'app/models/merge_request.rb', line 1414

def has_exposed_artifacts?
  actual_head_pipeline&.has_exposed_artifacts?
end

#has_no_commits?Boolean

Returns:

  • (Boolean)

1565
1566
1567
# File 'app/models/merge_request.rb', line 1565

def has_no_commits?
  !has_commits?
end

#has_terraform_reports?Boolean

Returns:

  • (Boolean)

1382
1383
1384
# File 'app/models/merge_request.rb', line 1382

def has_terraform_reports?
  actual_head_pipeline&.has_reports?(Ci::JobArtifact.terraform_reports)
end

#has_test_reports?Boolean

Returns:

  • (Boolean)

1343
1344
1345
# File 'app/models/merge_request.rb', line 1343

def has_test_reports?
  actual_head_pipeline&.has_reports?(Ci::JobArtifact.test_reports)
end

#hook_attrsObject


454
455
456
# File 'app/models/merge_request.rb', line 454

def hook_attrs
  Gitlab::HookData::MergeRequestBuilder.new(self).build
end

#in_locked_stateObject


1296
1297
1298
1299
1300
1301
# File 'app/models/merge_request.rb', line 1296

def in_locked_state
  lock_mr
  yield
ensure
  unlock_mr
end

#issues_mentioned_but_not_closing(current_user) ⇒ Object


1112
1113
1114
1115
1116
1117
1118
1119
# File 'app/models/merge_request.rb', line 1112

def issues_mentioned_but_not_closing(current_user)
  return [] unless target_branch == project.default_branch

  ext = Gitlab::ReferenceExtractor.new(project, current_user)
  ext.analyze("#{title}\n#{description}")

  ext.issues - visible_closing_issues_for(current_user)
end

#keep_around_commitObject

rubocop: enable CodeReuse/ServiceClass


1557
1558
1559
# File 'app/models/merge_request.rb', line 1557

def keep_around_commit
  project.repository.keep_around(self.merge_commit_sha)
end

#merge_async(user_id, params) ⇒ Object

Calls `MergeWorker` to proceed with the merge process and updates `merge_jid` with the MergeWorker#jid. This helps tracking enqueued and ongoing merge jobs.


524
525
526
527
528
529
530
531
# File 'app/models/merge_request.rb', line 524

def merge_async(user_id, params)
  jid = MergeWorker.perform_async(id, user_id, params.to_h)
  update_column(:merge_jid, jid)

  # merge_ongoing? depends on merge_jid
  # expire etag cache since the attribute is changed without triggering callbacks
  expire_etag_cache
end

#merge_commitObject


1471
1472
1473
# File 'app/models/merge_request.rb', line 1471

def merge_commit
  @merge_commit ||= project.commit(merge_commit_sha) if merge_commit_sha
end

#merge_eventObject


939
940
941
# File 'app/models/merge_request.rb', line 939

def merge_event
  @merge_event ||= target_project.events.where(target_id: self.id, target_type: "MergeRequest", action: :merged).last
end

#merge_ongoing?Boolean

Returns:

  • (Boolean)

826
827
828
829
830
831
832
# File 'app/models/merge_request.rb', line 826

def merge_ongoing?
  # While the MergeRequest is locked, it should present itself as 'merge ongoing'.
  # The unlocking process is handled by StuckMergeJobsWorker scheduled in Cron.
  return true if locked?

  !!merge_jid && !merged? && Gitlab::SidekiqStatus.running?(merge_jid)
end

#merge_participantsObject


555
556
557
558
559
560
561
562
563
# File 'app/models/merge_request.rb', line 555

def merge_participants
  participants = [author]

  if auto_merge_enabled? && !participants.include?(merge_user)
    participants << merge_user
  end

  participants.select { |participant| Ability.allowed?(participant, :read_merge_request, self) }
end

#merge_pipelineObject


361
362
363
364
365
366
367
368
369
# File 'app/models/merge_request.rb', line 361

def merge_pipeline
  return unless merged?

  # When the merge_method is :merge there will be a merge_commit_sha, however
  # when it is fast-forward there is no merge commit, so we must fall back to
  # either the squash commit (if the MR was squashed) or the diff head commit.
  sha = merge_commit_sha || squash_commit_sha || diff_head_sha
  target_project.latest_pipeline(target_branch, sha)
end

#merge_ref_headObject

Returns the current merge-ref HEAD commit.


1261
1262
1263
1264
1265
# File 'app/models/merge_request.rb', line 1261

def merge_ref_head
  return project.repository.commit(merge_ref_sha) if merge_ref_sha

  project.repository.commit(merge_ref_path)
end

#merge_ref_pathObject


1271
1272
1273
# File 'app/models/merge_request.rb', line 1271

def merge_ref_path
  "refs/#{Repository::REF_MERGE_REQUEST}/#{iid}/merge"
end

#merge_request_diffObject

This is the same as latest_merge_request_diff unless:

  1. There are arguments - in which case we might be trying to force-reload.

  2. This association is already loaded.

  3. The latest diff does not exist.

  4. It doesn't have any merge_request_diffs - it returns an empty MergeRequestDiff

The second one in particular is important - MergeRequestDiff#merge_request is the inverse of MergeRequest#merge_request_diff, which means it may not be the latest diff, because we could have loaded any diff from this particular MR. If we haven't already loaded a diff, then it's fine to load the latest.


63
64
65
66
67
# File 'app/models/merge_request.rb', line 63

def merge_request_diff
  fallback = latest_merge_request_diff unless association(:merge_request_diff).loaded?

  fallback || super || MergeRequestDiff.new(merge_request_id: id)
end

#merge_request_diff_for(diff_refs_or_sha) ⇒ Object


867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
# File 'app/models/merge_request.rb', line 867

def merge_request_diff_for(diff_refs_or_sha)
  matcher =
    if diff_refs_or_sha.is_a?(Gitlab::Diff::DiffRefs)
      {
        'start_commit_sha' => diff_refs_or_sha.start_sha,
        'head_commit_sha' => diff_refs_or_sha.head_sha,
        'base_commit_sha' => diff_refs_or_sha.base_sha
      }
    else
      { 'head_commit_sha' => diff_refs_or_sha }
    end

  viewable_diffs.find do |diff|
    diff.attributes.slice(*matcher.keys) == matcher
  end
end

#mergeable?(skip_ci_check: false, skip_discussions_check: false) ⇒ Boolean

Returns:

  • (Boolean)

959
960
961
962
963
964
965
966
# File 'app/models/merge_request.rb', line 959

def mergeable?(skip_ci_check: false, skip_discussions_check: false)
  return false unless mergeable_state?(skip_ci_check: skip_ci_check,
                                       skip_discussions_check: skip_discussions_check)

  check_mergeability

  can_be_merged? && !should_be_rebased?
end

#mergeable_ci_state?Boolean

Returns:

  • (Boolean)

1223
1224
1225
1226
1227
1228
1229
# File 'app/models/merge_request.rb', line 1223

def mergeable_ci_state?
  return true unless project.only_allow_merge_if_pipeline_succeeds?
  return false unless actual_head_pipeline
  return true if project.allow_merge_on_skipped_pipeline? && actual_head_pipeline.skipped?

  actual_head_pipeline.success?
end

#mergeable_discussions_state?Boolean

Returns:

  • (Boolean)

1053
1054
1055
1056
1057
# File 'app/models/merge_request.rb', line 1053

def mergeable_discussions_state?
  return true unless project.only_allow_merge_if_all_discussions_are_resolved?

  unresolved_notes.none?(&:to_be_resolved?)
end

#mergeable_state?(skip_ci_check: false, skip_discussions_check: false) ⇒ Boolean

Returns:

  • (Boolean)

968
969
970
971
972
973
974
975
976
# File 'app/models/merge_request.rb', line 968

def mergeable_state?(skip_ci_check: false, skip_discussions_check: false)
  return false unless open?
  return false if work_in_progress?
  return false if broken?
  return false unless skip_ci_check || mergeable_ci_state?
  return false unless skip_discussions_check || mergeable_discussions_state?

  true
end

#mergeable_with_quick_action?(current_user, autocomplete_precheck: false, last_diff_sha: nil) ⇒ Boolean

Returns:

  • (Boolean)

1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
# File 'app/models/merge_request.rb', line 1569

def mergeable_with_quick_action?(current_user, autocomplete_precheck: false, last_diff_sha: nil)
  return false unless can_be_merged_by?(current_user)

  return true if autocomplete_precheck

  return false unless mergeable?(skip_ci_check: true)
  return false if actual_head_pipeline && !(actual_head_pipeline.success? || actual_head_pipeline.active?)
  return false if last_diff_sha != diff_head_sha

  true
end

#merged_atObject


1507
1508
1509
1510
1511
1512
1513
1514
1515
# File 'app/models/merge_request.rb', line 1507

def merged_at
  strong_memoize(:merged_at) do
    next unless merged?

    metrics&.merged_at ||
      merge_event&.created_at ||
      notes.system.reorder(nil).find_by(note: 'merged')&.created_at
  end
end

#merged_commit_shaObject


1479
1480
1481
1482
1483
1484
# File 'app/models/merge_request.rb', line 1479

def merged_commit_sha
  return unless merged?

  sha = merge_commit_sha || squash_commit_sha || diff_head_sha
  sha.presence
end

#modified_paths(past_merge_request_diff: nil, fallback_on_overflow: false) ⇒ Object


634
635
636
637
638
639
640
641
642
# File 'app/models/merge_request.rb', line 634

def modified_paths(past_merge_request_diff: nil, fallback_on_overflow: false)
  if past_merge_request_diff
    past_merge_request_diff.modified_paths(fallback_on_overflow: fallback_on_overflow)
  elsif compare
    diff_stats&.paths || compare.modified_paths
  else
    merge_request_diff.modified_paths(fallback_on_overflow: fallback_on_overflow)
  end
end

#new_pathsObject


644
645
646
# File 'app/models/merge_request.rb', line 644

def new_paths
  diffs.diff_files.map(&:new_path)
end

#non_latest_diffsObject


584
585
586
# File 'app/models/merge_request.rb', line 584

def non_latest_diffs
  merge_request_diffs.where.not(id: merge_request_diff.id)
end

#note_positions_for_paths(paths, user = nil) ⇒ Object


588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
# File 'app/models/merge_request.rb', line 588

def note_positions_for_paths(paths, user = nil)
  positions = notes.new_diff_notes.joins(:note_diff_file)
    .where('note_diff_files.old_path IN (?) OR note_diff_files.new_path IN (?)', paths, paths)
    .positions

  collection = Gitlab::Diff::PositionCollection.new(positions, diff_head_sha)

  return collection unless user

  positions = draft_notes
    .authored_by(user)
    .positions
    .select { |pos| paths.include?(pos.file_path) }

  collection.concat(positions)
end

#notify_conflict?Boolean

Returns:

  • (Boolean)

1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
# File 'app/models/merge_request.rb', line 1020

def notify_conflict?
  (opened? || locked?) &&
    has_commits? &&
    !branch_missing? &&
    !project.repository.can_be_merged?(diff_head_sha, target_branch)
rescue Gitlab::Git::CommandError
  # Checking mergeability can trigger exception, e.g. non-utf8
  # We ignore this type of errors.
  false
end

#pipeline_coverage_deltaObject


1581
1582
1583
1584
1585
# File 'app/models/merge_request.rb', line 1581

def pipeline_coverage_delta
  if base_pipeline&.coverage && head_pipeline&.coverage
    '%.2f' % (head_pipeline.coverage.to_f - base_pipeline.coverage.to_f)
  end
end

#predefined_variablesObject


1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
# File 'app/models/merge_request.rb', line 1347

def predefined_variables
  Gitlab::Ci::Variables::Collection.new.tap do |variables|
    variables.append(key: 'CI_MERGE_REQUEST_ID', value: id.to_s)
    variables.append(key: 'CI_MERGE_REQUEST_IID', value: iid.to_s)
    variables.append(key: 'CI_MERGE_REQUEST_REF_PATH', value: ref_path.to_s)
    variables.append(key: 'CI_MERGE_REQUEST_PROJECT_ID', value: project.id.to_s)
    variables.append(key: 'CI_MERGE_REQUEST_PROJECT_PATH', value: project.full_path)
    variables.append(key: 'CI_MERGE_REQUEST_PROJECT_URL', value: project.web_url)
    variables.append(key: 'CI_MERGE_REQUEST_TARGET_BRANCH_NAME', value: target_branch.to_s)
    variables.append(key: 'CI_MERGE_REQUEST_TITLE', value: title)
    variables.append(key: 'CI_MERGE_REQUEST_ASSIGNEES', value: assignee_username_list) if assignees.present?
    variables.append(key: 'CI_MERGE_REQUEST_MILESTONE', value: milestone.title) if milestone
    variables.append(key: 'CI_MERGE_REQUEST_LABELS', value: label_names.join(',')) if labels.present?
    variables.concat(source_project_variables)
  end
end

#preloads_discussion_diff_highlighting?Boolean

Returns:

  • (Boolean)

605
606
607
# File 'app/models/merge_request.rb', line 605

def preloads_discussion_diff_highlighting?
  true
end

#public_merge_statusObject

Returns current merge_status except it returns `cannot_be_merged_rechecking` as `checking` to avoid exposing unnecessary internal state


219
220
221
# File 'app/models/merge_request.rb', line 219

def public_merge_status
  cannot_be_merged_rechecking? ? 'checking' : merge_status
end

#raw_diffs(*args) ⇒ Object


569
570
571
# File 'app/models/merge_request.rb', line 569

def raw_diffs(*args)
  compare.present? ? compare.raw_diffs(*args) : merge_request_diff.raw_diffs(*args)
end

#rebase_async(user_id, skip_ci: false) ⇒ Object

Set off a rebase asynchronously, atomically updating the `rebase_jid` of the MR so that the status of the operation can be tracked.


535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
# File 'app/models/merge_request.rb', line 535

def rebase_async(user_id, skip_ci: false)
  with_rebase_lock do
    raise ActiveRecord::StaleObjectError if !open? || rebase_in_progress?

    # Although there is a race between setting rebase_jid here and clearing it
    # in the RebaseWorker, it can't do any harm since we check both that the
    # attribute is set *and* that the sidekiq job is still running. So a JID
    # for a completed RebaseWorker is equivalent to a nil JID.
    jid = Sidekiq::Worker.skipping_transaction_check do
      RebaseWorker.perform_async(id, user_id, skip_ci)
    end

    update_column(:rebase_jid, jid)
  end

  # rebase_in_progress? depends on rebase_jid
  # expire etag cache since the attribute is changed without triggering callbacks
  expire_etag_cache
end

#rebase_in_progress?Boolean

Returns:

  • (Boolean)

350
351
352
# File 'app/models/merge_request.rb', line 350

def rebase_in_progress?
  rebase_jid.present? && Gitlab::SidekiqStatus.running?(rebase_jid)
end

#recent_commitsObject


490
491
492
# File 'app/models/merge_request.rb', line 490

def recent_commits
  commits(limit: MergeRequestDiff::COMMITS_SAFE_SIZE)
end

#recent_context_commitsObject


469
470
471
# File 'app/models/merge_request.rb', line 469

def recent_context_commits
  context_commits(limit: MergeRequestDiff::COMMITS_SAFE_SIZE)
end

#recent_visible_deploymentsObject


1646
1647
1648
# File 'app/models/merge_request.rb', line 1646

def recent_visible_deployments
  deployments.visible.includes(:environment).order(id: :desc).limit(10)
end

#recheck_merge_status?Boolean

Returns boolean indicating the merge_status should be rechecked in order to switch to either can_be_merged or cannot_be_merged.

Returns:

  • (Boolean)

935
936
937
# File 'app/models/merge_request.rb', line 935

def recheck_merge_status?
  self.class.state_machines[:merge_status].check_state?(merge_status)
end

#ref_pathObject


1267
1268
1269
# File 'app/models/merge_request.rb', line 1267

def ref_path
  "refs/#{Repository::REF_MERGE_REQUEST}/#{iid}/head"
end

1031
1032
1033
1034
1035
1036
1037
1038
1039
# File 'app/models/merge_request.rb', line 1031

def related_notes
  # We're using a UNION ALL here since this results in better performance
  # compared to using OR statements. We're using UNION ALL since the queries
  # used won't produce any duplicates (e.g. a note for a commit can't also be
  # a note for an MR).
  Note
    .from_union([notes, commit_notes], remove_duplicates: false)
    .includes(:noteable)
end

#reload_diff(current_user = nil) ⇒ Object

rubocop: disable CodeReuse/ServiceClass


910
911
912
913
914
# File 'app/models/merge_request.rb', line 910

def reload_diff(current_user = nil)
  return unless open?

  MergeRequests::ReloadDiffsService.new(self, current_user).execute
end

#reload_diff_if_branch_changedObject


902
903
904
905
906
907
# File 'app/models/merge_request.rb', line 902

def reload_diff_if_branch_changed
  if (saved_change_to_source_branch? || saved_change_to_target_branch?) &&
      (source_branch_head && target_branch_head)
    reload_diff
  end
end

#remove_source_branch?Boolean

Returns:

  • (Boolean)

1016
1017
1018
# File 'app/models/merge_request.rb', line 1016

def remove_source_branch?
  should_remove_source_branch? || force_remove_source_branch?
end

#reopenable?Boolean

Returns:

  • (Boolean)

845
846
847
# File 'app/models/merge_request.rb', line 845

def reopenable?
  closed? && !source_project_missing? && source_branch_exists?
end

#repository_diff_refsObject

Instead trying to fetch the persisted diff_refs, this method goes straight to the repository to get the most recent data possible.


759
760
761
762
763
764
765
# File 'app/models/merge_request.rb', line 759

def repository_diff_refs
  Gitlab::Diff::DiffRefs.new(
    base_sha:  branch_merge_base_sha,
    start_sha: target_branch_sha,
    head_sha:  source_branch_sha
  )
end

#short_merge_commit_shaObject


1475
1476
1477
# File 'app/models/merge_request.rb', line 1475

def short_merge_commit_sha
  Commit.truncate_sha(merge_commit_sha) if merge_commit_sha
end

#short_merged_commit_shaObject


1486
1487
1488
1489
1490
# File 'app/models/merge_request.rb', line 1486

def short_merged_commit_sha
  if sha = merged_commit_sha
    Commit.truncate_sha(sha)
  end
end

#should_be_rebased?Boolean

Returns:

  • (Boolean)

982
983
984
# File 'app/models/merge_request.rb', line 982

def should_be_rebased?
  project.ff_merge_must_be_possible? && !ff_merge_possible?
end

#should_remove_source_branch?Boolean

Returns:

  • (Boolean)

998
999
1000
# File 'app/models/merge_request.rb', line 998

def should_remove_source_branch?
  Gitlab::Utils.to_boolean(merge_params['should_remove_source_branch'])
end

#source_branch_exists?Boolean

Returns:

  • (Boolean)

1153
1154
1155
1156
1157
# File 'app/models/merge_request.rb', line 1153

def source_branch_exists?
  return false unless self.source_project

  self.source_project.repository.branch_exists?(self.source_branch)
end

#source_branch_headObject


716
717
718
719
720
721
722
# File 'app/models/merge_request.rb', line 716

def source_branch_head
  strong_memoize(:source_branch_head) do
    if source_project && source_branch_ref
      source_project.repository.commit(source_branch_ref)
    end
  end
end

#source_branch_refObject


702
703
704
705
706
707
# File 'app/models/merge_request.rb', line 702

def source_branch_ref
  return @source_branch_sha if @source_branch_sha
  return unless source_branch

  Gitlab::Git::BRANCH_REF_PREFIX + source_branch
end

#source_project_missing?Boolean

Returns:

  • (Boolean)

838
839
840
841
842
843
# File 'app/models/merge_request.rb', line 838

def source_project_missing?
  return false unless for_fork?
  return true unless source_project

  !source_project.in_fork_network_of?(target_project)
end

#source_project_namespaceObject


1137
1138
1139
1140
1141
1142
1143
# File 'app/models/merge_request.rb', line 1137

def source_project_namespace
  if source_project && source_project.namespace
    source_project.namespace.full_path
  else
    "(removed)"
  end
end

#source_project_pathObject


1129
1130
1131
1132
1133
1134
1135
# File 'app/models/merge_request.rb', line 1129

def source_project_path
  if source_project
    source_project.full_path
  else
    "(removed)"
  end
end

#squash_in_progress?Boolean

Returns:

  • (Boolean)

1631
1632
1633
1634
1635
1636
# File 'app/models/merge_request.rb', line 1631

def squash_in_progress?
  # The source project can be deleted
  return false unless source_project

  source_project.repository.squash_in_progress?(id)
end

#squash_on_merge?Boolean

Returns:

  • (Boolean)

1192
1193
1194
1195
1196
1197
# File 'app/models/merge_request.rb', line 1192

def squash_on_merge?
  return true if target_project.squash_always?
  return false if target_project.squash_never?

  squash?
end

#supports_suggestion?Boolean

Returns:

  • (Boolean)

517
518
519
# File 'app/models/merge_request.rb', line 517

def supports_suggestion?
  true
end

#target_branch_exists?Boolean

Returns:

  • (Boolean)

1159
1160
1161
1162
1163
# File 'app/models/merge_request.rb', line 1159

def target_branch_exists?
  return false unless self.target_project

  self.target_project.repository.branch_exists?(self.target_branch)
end

#target_branch_headObject


724
725
726
727
728
# File 'app/models/merge_request.rb', line 724

def target_branch_head
  strong_memoize(:target_branch_head) do
    target_project.repository.commit(target_branch_ref)
  end
end

#target_branch_refObject


709
710
711
712
713
714
# File 'app/models/merge_request.rb', line 709

def target_branch_ref
  return @target_branch_sha if @target_branch_sha
  return unless target_branch

  Gitlab::Git::BRANCH_REF_PREFIX + target_branch
end

#target_project_namespaceObject


1145
1146
1147
1148
1149
1150
1151
# File 'app/models/merge_request.rb', line 1145

def target_project_namespace
  if target_project && target_project.namespace
    target_project.namespace.full_path
  else
    "(removed)"
  end
end

#target_project_pathObject


1121
1122
1123
1124
1125
1126
1127
# File 'app/models/merge_request.rb', line 1121

def target_project_path
  if target_project
    target_project.full_path
  else
    "(removed)"
  end
end

#to_reference(from = nil, full: false) ⇒ Object

`from` argument can be a Namespace or Project.


459
460
461
462
463
# File 'app/models/merge_request.rb', line 459

def to_reference(from = nil, full: false)
  reference = "#{self.class.reference_prefix}#{iid}"

  "#{project.to_reference_base(from, full: full)}#{reference}"
end

#train_ref_pathObject


1275
1276
1277
# File 'app/models/merge_request.rb', line 1275

def train_ref_path
  "refs/#{Repository::REF_MERGE_REQUEST}/#{iid}/train"
end

#update_diff_discussion_positions(old_diff_refs:, new_diff_refs:, current_user: nil) ⇒ Object

rubocop: disable CodeReuse/ServiceClass


1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
# File 'app/models/merge_request.rb', line 1526

def update_diff_discussion_positions(old_diff_refs:, new_diff_refs:, current_user: nil)
  return unless has_complete_diff_refs?
  return if new_diff_refs == old_diff_refs

  active_diff_discussions = self.notes.new_diff_notes.discussions.select do |discussion|
    discussion.active?(old_diff_refs)
  end
  return if active_diff_discussions.empty?

  paths = active_diff_discussions.flat_map { |n| n.diff_file.paths }.uniq

  service = Discussions::UpdateDiffPositionService.new(
    self.project,
    current_user,
    old_diff_refs: old_diff_refs,
    new_diff_refs: new_diff_refs,
    paths: paths
  )

  active_diff_discussions.each do |discussion|
    service.execute(discussion)
  end

  if project.resolve_outdated_diff_discussions?
    MergeRequests::ResolvedDiscussionNotificationService
      .new(project, current_user)
      .execute(self)
  end
end

#update_head_pipelineObject


1336
1337
1338
1339
1340
1341
# File 'app/models/merge_request.rb', line 1336

def update_head_pipeline
  find_actual_head_pipeline.try do |pipeline|
    self.head_pipeline = pipeline
    update_column(:head_pipeline_id, head_pipeline.id) if head_pipeline_id_changed?
  end
end

#update_project_counter_cachesObject

rubocop: disable CodeReuse/ServiceClass


1598
1599
1600
# File 'app/models/merge_request.rb', line 1598

def update_project_counter_caches
  Projects::OpenMergeRequestsCountService.new(target_project).refresh_cache
end

#validate_branch_name(attr) ⇒ Object


801
802
803
804
805
806
807
808
809
# File 'app/models/merge_request.rb', line 801

def validate_branch_name(attr)
  return unless will_save_change_to_attribute?(attr)

  branch = read_attribute(attr)

  return unless branch

  errors.add(attr) unless Gitlab::GitRefValidator.validate_merge_request_branch(branch)
end

#validate_branchesObject


771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
# File 'app/models/merge_request.rb', line 771

def validate_branches
  return unless target_project && source_project

  if target_project == source_project && target_branch == source_branch
    errors.add :branch_conflict, "You can't use same project/branch for source and target"
    return
  end

  [:source_branch, :target_branch].each { |attr| validate_branch_name(attr) }

  if opened?
    similar_mrs = target_project
      .merge_requests
      .where(source_branch: source_branch, target_branch: target_branch)
      .where(source_project_id: source_project&.id)
      .opened

    similar_mrs = similar_mrs.where.not(id: id) if persisted?

    conflict = similar_mrs.first

    if conflict.present?
      errors.add(
        :validate_branches,
        "Another open merge request already exists for this source branch: #{conflict.to_reference}"
      )
    end
  end
end

#validate_forkObject


817
818
819
820
821
822
823
824
# File 'app/models/merge_request.rb', line 817

def validate_fork
  return true unless target_project && source_project
  return true if target_project == source_project
  return true unless source_project_missing?

  errors.add :validate_fork,
             'Source project is not a fork of the target project'
end

#validate_target_projectObject


811
812
813
814
815
# File 'app/models/merge_request.rb', line 811

def validate_target_project
  return true if target_project.merge_requests_enabled?

  errors.add :base, 'Target project has disabled merge requests'
end

#version_params_for(diff_refs) ⇒ Object


884
885
886
887
888
889
890
891
892
893
# File 'app/models/merge_request.rb', line 884

def version_params_for(diff_refs)
  if diff = merge_request_diff_for(diff_refs)
    { diff_id: diff.id }
  elsif diff = merge_request_diff_for(diff_refs.head_sha)
    {
      diff_id: diff.id,
      start_sha: diff_refs.start_sha
    }
  end
end

#viewable_diffsObject


863
864
865
# File 'app/models/merge_request.rb', line 863

def viewable_diffs
  @viewable_diffs ||= merge_request_diffs.viewable.to_a
end

#visible_closing_issues_for(current_user = self.author) ⇒ Object


1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
# File 'app/models/merge_request.rb', line 1087

def visible_closing_issues_for(current_user = self.author)
  strong_memoize(:visible_closing_issues_for) do
    if self.target_project.has_external_issue_tracker?
      closes_issues(current_user)
    else
      cached_closes_issues.select do |issue|
        Ability.allowed?(current_user, :read_issue, issue)
      end
    end
  end
end

#wip_titleObject


955
956
957
# File 'app/models/merge_request.rb', line 955

def wip_title
  self.class.wip_title(self.title)
end

#wipless_titleObject


951
952
953
# File 'app/models/merge_request.rb', line 951

def wipless_title
  self.class.wipless_title(self.title)
end

#wipless_title_changed(old_title) ⇒ Object

Verifies if title has changed not taking into account Draft prefix for merge requests.


450
451
452
# File 'app/models/merge_request.rb', line 450

def wipless_title_changed(old_title)
  self.class.wipless_title(old_title) != self.wipless_title
end

#work_in_progress?Boolean

Returns:

  • (Boolean)

947
948
949
# File 'app/models/merge_request.rb', line 947

def work_in_progress?
  self.class.work_in_progress?(title)
end