Class: MergeRequest

Inherits:
ApplicationRecord show all
Extended by:
Gitlab::Utils::Override
Includes:
ApprovableBase, AtomicInternalId, DeprecatedAssignee, EachBatch, FromUnion, Gitlab::Utils::StrongMemoize, IdInOrdered, IgnorableColumns, IidRoutes, Issuable, LabelEventable, ManualInverseAssociation, MilestoneEventable, Noteable, Presentable, ReactiveCaching, Referable, ShaAttribute, StateEventable, ThrottledTouch, TimeTrackable, Todoable
Defined in:
app/models/merge_request.rb

Defined Under Namespace

Classes: CleanupSchedule, DiffCommitUser, Metrics, MetricsFinder

Constant Summary collapse

SORTING_PREFERENCE_FIELD = 
:merge_requests_sort
ALLOWED_TO_USE_MERGE_BASE_PIPELINE_FOR_COMPARISON = 
{
  'Ci::CompareMetricsReportsService'     => ->(project) { true },
  'Ci::CompareCodequalityReportsService' => ->(project) { true }
}.freeze
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 = 
/\A*#{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::SEARCHABLE_FIELDS, 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

Constants included from AtomicInternalId

AtomicInternalId::MissingValueError

Constants inherited from ApplicationRecord

ApplicationRecord::MAX_PLUCK

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?, #can_be_unapproved_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_change, #human_time_estimate, #human_total_time_spent, #spend_time, #time_change, #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, #creatable_note_email_address, #discussion_ids_relation, #discussion_root_note_ids, #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, #noteable_target_type_name, #resolvable_discussions, #supports_creating_notes_by_email?, #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, #hook_association_changes, #label_names, #labels_array, #labels_hook_attrs, #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

#lazy_subscription, #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, #user_mention_class, #user_mention_identifier

Methods included from Participable

#participant?, #participants, #visible_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, #mentionable_attributes_changed?, #parent_user, #refresh_markdown_cache, #refresh_markdown_cache!, #rendered_field_content, #skip_project_check?, #store_mentions!, #updated_cached_html_for

Methods included from IidRoutes

#to_param

Methods included from AtomicInternalId

group_init, #internal_id_read_scope, #internal_id_scope_attrs, #internal_id_scope_usage, project_init, scope_attrs, scope_usage

Methods inherited from ApplicationRecord

cached_column_list, #create_or_load_association, declarative_enum, default_select_columns, id_in, id_not_in, iid_in, pluck_primary_key, primary_key_in, #readable_by?, safe_ensure_unique, safe_find_or_create_by, safe_find_or_create_by!, #to_ability_name, underscore, where_exists, where_not_exists, with_fast_read_statement_timeout, without_order

Methods included from SensitiveSerializableHash

#serializable_hash

Instance Attribute Details

#allow_broken ⇒ Object

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


138
139
140
 
# File 'app/models/merge_request.rb', line 138

def allow_broken
  @allow_broken
end

#can_be_created ⇒ Object

Temporary fields to store compare vars when creating new merge request


142
143
144
 
# File 'app/models/merge_request.rb', line 142

def can_be_created
  @can_be_created
end

#compare ⇒ Object

Temporary fields to store compare vars when creating new merge request


142
143
144
 
# File 'app/models/merge_request.rb', line 142

def compare
  @compare
end

#compare_commits ⇒ Object

Temporary fields to store compare vars when creating new merge request


142
143
144
 
# File 'app/models/merge_request.rb', line 142

def compare_commits
  @compare_commits
end

#diff_options ⇒ Object

Temporary fields to store compare vars when creating new merge request


142
143
144
 
# File 'app/models/merge_request.rb', line 142

def diff_options
  @diff_options
end

#source_branch_sha ⇒ Object 


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

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

#target_branch_sha ⇒ Object 


901
902
903
 
# File 'app/models/merge_request.rb', line 901

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

Class Method Details

.available_state_names ⇒ Object

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.


148
149
150
 
# File 'app/models/merge_request.rb', line 148

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

.draft?(title) ⇒ Boolean

Returns:

  • (Boolean) 

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

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

.draft_title(title) ⇒ Object 


591
592
593
 
# File 'app/models/merge_request.rb', line 591

def self.draft_title(title)
  draft?(title) ? title : "Draft: #{title}"
end

.draftless_title(title) ⇒ Object 


587
588
589
 
# File 'app/models/merge_request.rb', line 587

def self.draftless_title(title)
  title.sub(DRAFT_REGEX, "")
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.


552
553
554
555
556
557
558
559
 
# File 'app/models/merge_request.rb', line 552

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

.link_reference_pattern ⇒ Object 


530
531
532
 
# File 'app/models/merge_request.rb', line 530

def self.link_reference_pattern
  @link_reference_pattern ||= super("merge_requests", Gitlab::Regex.merge_request)
end

.merge_request_ref?(ref) ⇒ Boolean

Returns:

  • (Boolean) 

1500
1501
1502
 
# File 'app/models/merge_request.rb', line 1500

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

.merge_train_ref?(ref) ⇒ Boolean

Returns:

  • (Boolean) 

1504
1505
1506
 
# File 'app/models/merge_request.rb', line 1504

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

.participant_includes ⇒ Object 


601
602
603
 
# File 'app/models/merge_request.rb', line 601

def self.participant_includes
  [:reviewers, :award_emoji] + super
end

.project_foreign_key ⇒ Object 


538
539
540
 
# File 'app/models/merge_request.rb', line 538

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.


456
457
458
459
460
461
462
 
# File 'app/models/merge_request.rb', line 456

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_pattern ⇒ Object

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

This pattern supports cross-project references.


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

def self.reference_pattern
  @reference_pattern ||= %r{
    (#{Project.reference_pattern})?
    #{Regexp.escape(reference_prefix)}#{Gitlab::Regex.merge_request}
  }x
end

.reference_prefix ⇒ Object 


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

def self.reference_prefix
  '!'
end

.reference_valid?(reference) ⇒ Boolean

Returns:

  • (Boolean) 

534
535
536
 
# File 'app/models/merge_request.rb', line 534

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

.reviewers_subquery ⇒ Object 


475
476
477
478
479
 
# File 'app/models/merge_request.rb', line 475

def self.reviewers_subquery
  MergeRequestReviewer.arel_table
    .project('true')
    .where(Arel::Nodes::SqlLiteral.new("#{to_ability_name}_id = #{to_ability_name}s.id"))
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.

Only set `regular` merge request diffs as latest so `merge_head` diff won't be considered as `MergeRequest#merge_request_diff`.


567
568
569
570
571
572
573
574
575
576
577
578
579
 
# File 'app/models/merge_request.rb', line 567

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
      AND merge_request_diffs.diff_type = #{MergeRequestDiff.diff_types[:regular]}
    )".squish

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

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


464
465
466
467
468
469
470
471
472
473
 
# File 'app/models/merge_request.rb', line 464

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

.total_time_to_merge ⇒ Object 


420
421
422
423
424
425
 
# File 'app/models/merge_request.rb', line 420

def self.total_time_to_merge
  join_metrics
    .merge(MergeRequest::Metrics.with_valid_time_to_merge)
    .pluck(MergeRequest::Metrics.time_to_merge_expression)
    .first
end

.wip_title ⇒ Object 


598
599
600
 
# File 'app/models/merge_request.rb', line 598

def self.draft_title(title)
  draft?(title) ? title : "Draft: #{title}"
end

.wipless_title ⇒ Object 


597
598
599
 
# File 'app/models/merge_request.rb', line 597

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

.work_in_progress? ⇒ Boolean

Returns:

  • (Boolean) 

596
597
598
 
# File 'app/models/merge_request.rb', line 596

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

Instance Method Details

#actual_head_pipeline ⇒ Object

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


494
495
496
 
# File 'app/models/merge_request.rb', line 494

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

#actual_head_pipeline_active? ⇒ Boolean

Returns:

  • (Boolean) 

512
513
514
 
# File 'app/models/merge_request.rb', line 512

def actual_head_pipeline_active?
  !!actual_head_pipeline&.active?
end

#actual_head_pipeline_success? ⇒ Boolean

Returns:

  • (Boolean) 

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

def actual_head_pipeline_success?
  !!actual_head_pipeline&.success?
end

#all_commit_shas ⇒ Object

Note that this could also return SHA from now dangling commits


1733
1734
1735
1736
1737
1738
1739
 
# File 'app/models/merge_request.rb', line 1733

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

    all_commits.pluck(:sha).uniq
  end
end

#all_commits ⇒ Object 


1725
1726
1727
1728
1729
 
# File 'app/models/merge_request.rb', line 1725

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

#all_pipelines ⇒ Object 


1550
1551
1552
1553
1554
 
# File 'app/models/merge_request.rb', line 1550

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

#allow_collaboration ⇒ Object Also known as: allow_collaboration? 


1894
1895
1896
 
# File 'app/models/merge_request.rb', line 1894

def allow_collaboration
  collaborative_push_possible? && allow_maintainer_to_push
end

#allows_multiple_reviewers? ⇒ Boolean

Returns:

  • (Boolean) 

1937
1938
1939
 
# File 'app/models/merge_request.rb', line 1937

def allows_multiple_reviewers?
  false
end

#allows_reviewers? ⇒ Boolean

Returns:

  • (Boolean) 

1933
1934
1935
 
# File 'app/models/merge_request.rb', line 1933

def allows_reviewers?
  true
end

#auto_merge_strategy ⇒ Object 


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

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 


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

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

#banzai_render_context(field) ⇒ Object 


1924
1925
1926
 
# File 'app/models/merge_request.rb', line 1924

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

#base_pipeline ⇒ Object 


1862
1863
1864
1865
1866
 
# File 'app/models/merge_request.rb', line 1862

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

#branch_merge_base_commit ⇒ Object 


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

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_sha ⇒ Object 


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

def branch_merge_base_sha
  branch_merge_base_commit.try(:sha)
end

#branch_missing? ⇒ Boolean

Returns:

  • (Boolean) 

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

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

#broken? ⇒ Boolean

Returns:

  • (Boolean) 

1419
1420
1421
 
# File 'app/models/merge_request.rb', line 1419

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.


1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
 
# File 'app/models/merge_request.rb', line 1270

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) 

1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
 
# File 'app/models/merge_request.rb', line 1710

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(comparison_base_pipeline(identifier), actual_head_pipeline)
end

#can_allow_collaboration?(user) ⇒ Boolean

Returns:

  • (Boolean) 

1907
1908
1909
1910
 
# File 'app/models/merge_request.rb', line 1907

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

#can_be_cherry_picked? ⇒ Boolean

Returns:

  • (Boolean) 

1788
1789
1790
 
# File 'app/models/merge_request.rb', line 1788

def can_be_cherry_picked?
  merge_commit.present?
end

#can_be_closed? ⇒ Boolean

Returns:

  • (Boolean) 

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

def can_be_closed?
  opened?
end

#can_be_merged_by?(user, skip_collaboration_check: false) ⇒ Boolean

Returns:

  • (Boolean) 

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

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

#can_be_merged_via_command_line_by?(user) ⇒ Boolean

Returns:

  • (Boolean) 

1428
1429
1430
1431
 
# File 'app/models/merge_request.rb', line 1428

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) 

1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
 
# File 'app/models/merge_request.rb', line 1762

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) 

1184
1185
1186
 
# File 'app/models/merge_request.rb', line 1184

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) 

1188
1189
1190
1191
1192
1193
1194
 
# File 'app/models/merge_request.rb', line 1188

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 


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

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 


1491
1492
1493
1494
1495
1496
1497
1498
 
# File 'app/models/merge_request.rb', line 1491

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_shas ⇒ Object 


1077
1078
1079
1080
1081
1082
 
# File 'app/models/merge_request.rb', line 1077

def clear_memoized_shas
  @target_branch_sha = @source_branch_sha = nil

  clear_memoization(:source_branch_head)
  clear_memoization(:target_branch_head)
end

#closed_event ⇒ Object 


1125
1126
1127
 
# File 'app/models/merge_request.rb', line 1125

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

#closed_or_merged_without_fork? ⇒ Boolean

Returns:

  • (Boolean) 

996
997
998
 
# File 'app/models/merge_request.rb', line 996

def closed_or_merged_without_fork?
  (closed? || merged?) && 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.


1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
 
# File 'app/models/merge_request.rb', line 1298

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) 

1900
1901
1902
1903
1904
1905
 
# File 'app/models/merge_request.rb', line 1900

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_notes ⇒ Object 


1241
1242
1243
1244
1245
1246
1247
1248
1249
 
# File 'app/models/merge_request.rb', line 1241

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 


666
667
668
669
670
671
672
673
674
675
676
677
 
# File 'app/models/merge_request.rb', line 666

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, load_from_gitaly: false) ⇒ Object 


639
640
641
642
643
644
645
646
647
648
649
650
 
# File 'app/models/merge_request.rb', line 639

def commits(limit: nil, load_from_gitaly: false)
  return merge_request_diff.commits(limit: limit, load_from_gitaly: load_from_gitaly) 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_count ⇒ Object 


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

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

#committers ⇒ Object 


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

def committers
  @committers ||= commits.committers
end

#compare_accessibility_reports ⇒ Object 


1604
1605
1606
1607
1608
1609
1610
 
# File 'app/models/merge_request.rb', line 1604

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_codequality_reports ⇒ Object 


1644
1645
1646
1647
1648
1649
1650
 
# File 'app/models/merge_request.rb', line 1644

def compare_codequality_reports
  unless has_codequality_reports?
    return { status: :error, status_reason: _('This merge request does not have codequality reports') }
  end

  compare_reports(Ci::CompareCodequalityReportsService)
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


1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
 
# File 'app/models/merge_request.rb', line 1679

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?(comparison_base_pipeline(service_class.name), actual_head_pipeline, data)
      raise InvalidateReactiveCache
    end

    data
  end || { status: :parsing }
end

#compare_sast_reports(current_user) ⇒ Object 


1698
1699
1700
1701
1702
 
# File 'app/models/merge_request.rb', line 1698

def compare_sast_reports(current_user)
  return missing_report_error("SAST") unless has_sast_reports?

  compare_reports(::Ci::CompareSecurityReportsService, current_user, 'sast')
end

#compare_secret_detection_reports(current_user) ⇒ Object 


1704
1705
1706
1707
1708
 
# File 'app/models/merge_request.rb', line 1704

def compare_secret_detection_reports(current_user)
  return missing_report_error("secret detection") unless has_secret_detection_reports?

  compare_reports(::Ci::CompareSecurityReportsService, current_user, 'secret_detection')
end

#compare_test_reports ⇒ Object 


1584
1585
1586
1587
1588
1589
1590
 
# File 'app/models/merge_request.rb', line 1584

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

#comparison_base_pipeline(service_class) ⇒ Object 


1858
1859
1860
 
# File 'app/models/merge_request.rb', line 1858

def comparison_base_pipeline(service_class)
  (use_merge_base_pipeline_for_comparison?(service_class) && merge_base_pipeline) || base_pipeline
end

#context_commits(limit: nil) ⇒ Object 


627
628
629
 
# File 'app/models/merge_request.rb', line 627

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

#context_commits_count ⇒ Object 


635
636
637
 
# File 'app/models/merge_request.rb', line 635

def context_commits_count
  context_commits.count
end

#context_commits_diff ⇒ Object 


1974
1975
1976
1977
1978
 
# File 'app/models/merge_request.rb', line 1974

def context_commits_diff
  strong_memoize(:context_commits_diff) do
    ContextCommitsDiff.new(self)
  end
end

#create_merge_request_diff ⇒ Object 


1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
 
# File 'app/models/merge_request.rb', line 1033

def create_merge_request_diff
  # Callers such as MergeRequests::BuildService may not call eager_fetch_ref!. Just
  # in case they haven't, we fetch the ref.
  fetch_ref! unless skip_fetch_ref

  # n+1: https://gitlab.com/gitlab-org/gitlab/-/issues/19377
  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, user: nil) ⇒ Object 


1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
 
# File 'app/models/merge_request.rb', line 1363

def default_merge_commit_message(include_description: false, user: nil)
  if self.target_project.merge_commit_template.present? && !include_description
    return ::Gitlab::MergeRequests::CommitMessageGenerator.new(merge_request: self, current_user: user).merge_message
  end

  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_message(user: nil) ⇒ Object 


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

def default_squash_commit_message(user: nil)
  if self.target_project.squash_commit_template.present?
    return ::Gitlab::MergeRequests::CommitMessageGenerator.new(merge_request: self, current_user: user).squash_message
  end

  title
end

#diff_base_commit ⇒ Object 


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

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

#diff_base_sha ⇒ Object 


842
843
844
845
846
847
848
 
# File 'app/models/merge_request.rb', line 842

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_commit ⇒ Object 


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

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

#diff_head_sha ⇒ Object 


850
851
852
853
854
855
856
 
# File 'app/models/merge_request.rb', line 850

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

#diff_refs ⇒ Object 


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

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

#diff_size ⇒ Object 


790
791
792
793
794
 
# File 'app/models/merge_request.rb', line 790

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_commit ⇒ Object 


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

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

#diff_start_sha ⇒ Object 


834
835
836
837
838
839
840
 
# File 'app/models/merge_request.rb', line 834

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

#diff_stats ⇒ Object 


782
783
784
785
786
787
788
 
# File 'app/models/merge_request.rb', line 782

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) 

1111
1112
1113
 
# File 'app/models/merge_request.rb', line 1111

def diffable_merge_ref?
  open? && merge_head_diff.present? && (Feature.enabled?(:display_merge_conflicts_in_diff, project) || can_be_merged?)
end

#diffs(diff_options = {}) ⇒ Object 


735
736
737
738
739
740
741
742
743
744
 
# File 'app/models/merge_request.rb', line 735

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_diffs ⇒ Object 


771
772
773
774
775
776
777
778
779
780
 
# File 'app/models/merge_request.rb', line 771

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) 

1874
1875
1876
 
# File 'app/models/merge_request.rb', line 1874

def discussions_rendered_on_frontend?
  true
end

#diverged_commits_count ⇒ Object 


1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
 
# File 'app/models/merge_request.rb', line 1523

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) 

1546
1547
1548
 
# File 'app/models/merge_request.rb', line 1546

def diverged_from_target_branch?
  diverged_commits_count > 0
end

#draft? ⇒ Boolean Also known as: work_in_progress?

Returns:

  • (Boolean) 

1129
1130
1131
 
# File 'app/models/merge_request.rb', line 1129

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

#draft_title ⇒ Object Also known as: wip_title 


1139
1140
1141
 
# File 'app/models/merge_request.rb', line 1139

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

#draftless_title ⇒ Object Also known as: wipless_title 


1134
1135
1136
 
# File 'app/models/merge_request.rb', line 1134

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

#draftless_title_changed(old_title) ⇒ Object Also known as: wipless_title_changed

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


611
612
613
 
# File 'app/models/merge_request.rb', line 611

def draftless_title_changed(old_title)
  self.class.draftless_title(old_title) != self.draftless_title
end

#eager_fetch_ref! ⇒ Object 


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

def eager_fetch_ref!
  return unless valid?

  # has_internal_id normally attempts to allocate the iid in the
  # before_create hook, but we need the iid to be available before
  # that to fetch the ref into the target project.
  track_target_project_iid!
  ensure_target_project_iid!

  fetch_ref!
  # Prevent the after_create hook from fetching the source branch again.
  @skip_fetch_ref = true
end

#enabled_reports ⇒ Object 


1961
1962
1963
1964
1965
1966
 
# File 'app/models/merge_request.rb', line 1961

def enabled_reports
  {
    sast: report_type_enabled?(:sast),
    secret_detection: report_type_enabled?(:secret_detection)
  }
end

#ensure_merge_request_diff ⇒ Object 


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

def ensure_merge_request_diff
  merge_request_diff.persisted? || create_merge_request_diff
end

#ensure_metrics ⇒ Object 


1929
1930
1931
 
# File 'app/models/merge_request.rb', line 1929

def ensure_metrics
  MergeRequest::Metrics.record!(self)
end

#environments_in_head_pipeline(deployment_status: nil) ⇒ Object 


1459
1460
1461
1462
1463
1464
1465
 
# File 'app/models/merge_request.rb', line 1459

def environments_in_head_pipeline(deployment_status: nil)
  if ::Feature.enabled?(:fix_related_environments_for_merge_requests, target_project)
    actual_head_pipeline&.environments_in_self_and_descendants(deployment_status: deployment_status) || Environment.none
  else
    legacy_environments
  end
end

#etag_caching_enabled? ⇒ Boolean

Returns:

  • (Boolean) 

1916
1917
1918
 
# File 'app/models/merge_request.rb', line 1916

def etag_caching_enabled?
  true
end

#fetch_ref! ⇒ Object 


1467
1468
1469
 
# File 'app/models/merge_request.rb', line 1467

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

#ff_merge_possible? ⇒ Boolean

rubocop: enable CodeReuse/ServiceClass

Returns:

  • (Boolean) 

1176
1177
1178
 
# File 'app/models/merge_request.rb', line 1176

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

#find_actual_head_pipeline ⇒ Object 


1912
1913
1914
 
# File 'app/models/merge_request.rb', line 1912

def find_actual_head_pipeline
  all_pipelines.for_sha_or_source_sha(diff_head_sha).first
end

#find_assignee(user) ⇒ Object 


1945
1946
1947
 
# File 'app/models/merge_request.rb', line 1945

def find_assignee(user)
  merge_request_assignees.find_by(user_id: user.id)
end

#find_codequality_mr_diff_reports ⇒ Object

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


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

def find_codequality_mr_diff_reports
  unless has_codequality_mr_diff_report?
    return { status: :error, status_reason: 'This merge request does not have codequality mr diff reports' }
  end

  compare_reports(Ci::GenerateCodequalityMrDiffReportService)
end

#find_coverage_reports ⇒ Object

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


1616
1617
1618
1619
1620
1621
1622
 
# File 'app/models/merge_request.rb', line 1616

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_artifacts ⇒ Object

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


1668
1669
1670
1671
1672
1673
1674
 
# File 'app/models/merge_request.rb', line 1668

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_reviewer(user) ⇒ Object 


1953
1954
1955
 
# File 'app/models/merge_request.rb', line 1953

def find_reviewer(user)
  merge_request_reviewers.find_by(user_id: user.id)
end

#find_terraform_reports ⇒ Object 


1652
1653
1654
1655
1656
1657
1658
 
# File 'app/models/merge_request.rb', line 1652

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_commit ⇒ Object 


727
728
729
 
# File 'app/models/merge_request.rb', line 727

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

#first_contribution? ⇒ Boolean

rubocop: enable CodeReuse/ServiceClass

Returns:

  • (Boolean) 

1884
1885
1886
1887
1888
 
# File 'app/models/merge_request.rb', line 1884

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

  !project.merge_requests.merged.exists?(author_id: author_id)
end

#first_multiline_commit ⇒ Object

Returns the oldest multi-line commit


1396
1397
1398
1399
1400
 
# File 'app/models/merge_request.rb', line 1396

def first_multiline_commit
  strong_memoize(:first_multiline_commit) do
    recent_commits.without_merge_commits.reverse_each.find(&:description?)
  end
end

#for_fork? ⇒ Boolean

Returns:

  • (Boolean) 

1257
1258
1259
 
# File 'app/models/merge_request.rb', line 1257

def for_fork?
  target_project != source_project
end

#for_same_project? ⇒ Boolean

Returns:

  • (Boolean) 

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

def for_same_project?
  target_project == source_project
end

#force_remove_source_branch? ⇒ Boolean

Returns:

  • (Boolean) 

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

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

#has_accessibility_reports? ⇒ Boolean

Returns:

  • (Boolean) 

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

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

#has_ci? ⇒ Boolean

Returns:

  • (Boolean) 

1409
1410
1411
1412
1413
 
# File 'app/models/merge_request.rb', line 1409

def has_ci?
  return false if has_no_commits?

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

#has_codequality_mr_diff_report? ⇒ Boolean

Returns:

  • (Boolean) 

1624
1625
1626
 
# File 'app/models/merge_request.rb', line 1624

def has_codequality_mr_diff_report?
  actual_head_pipeline&.has_codequality_mr_diff_report?
end

#has_codequality_reports? ⇒ Boolean

Returns:

  • (Boolean) 

1640
1641
1642
 
# File 'app/models/merge_request.rb', line 1640

def has_codequality_reports?
  actual_head_pipeline&.has_reports?(Ci::JobArtifact.codequality_reports)
end

#has_commits? ⇒ Boolean

Returns:

  • (Boolean) 

1840
1841
1842
 
# File 'app/models/merge_request.rb', line 1840

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

#has_complete_diff_refs? ⇒ Boolean

Returns:

  • (Boolean) 

1792
1793
1794
 
# File 'app/models/merge_request.rb', line 1792

def has_complete_diff_refs?
  diff_refs && diff_refs.complete?
end

#has_coverage_reports? ⇒ Boolean

Returns:

  • (Boolean) 

1596
1597
1598
 
# File 'app/models/merge_request.rb', line 1596

def has_coverage_reports?
  actual_head_pipeline&.has_coverage_reports?
end

#has_exposed_artifacts? ⇒ Boolean

Returns:

  • (Boolean) 

1660
1661
1662
 
# File 'app/models/merge_request.rb', line 1660

def has_exposed_artifacts?
  actual_head_pipeline&.has_exposed_artifacts?
end

#has_no_commits? ⇒ Boolean

Returns:

  • (Boolean) 

1844
1845
1846
 
# File 'app/models/merge_request.rb', line 1844

def has_no_commits?
  !has_commits?
end

#has_sast_reports? ⇒ Boolean

Returns:

  • (Boolean) 

1690
1691
1692
 
# File 'app/models/merge_request.rb', line 1690

def has_sast_reports?
  !!actual_head_pipeline&.has_reports?(::Ci::JobArtifact.sast_reports)
end

#has_secret_detection_reports? ⇒ Boolean

Returns:

  • (Boolean) 

1694
1695
1696
 
# File 'app/models/merge_request.rb', line 1694

def has_secret_detection_reports?
  !!actual_head_pipeline&.has_reports?(::Ci::JobArtifact.secret_detection_reports)
end

#has_terraform_reports? ⇒ Boolean

Returns:

  • (Boolean) 

1600
1601
1602
 
# File 'app/models/merge_request.rb', line 1600

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

#has_test_reports? ⇒ Boolean

Returns:

  • (Boolean) 

1563
1564
1565
 
# File 'app/models/merge_request.rb', line 1563

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

#head_pipeline_active? ⇒ Boolean

Returns:

  • (Boolean) 

508
509
510
 
# File 'app/models/merge_request.rb', line 508

def head_pipeline_active?
  !!head_pipeline&.active?
end

#hook_attrs ⇒ Object 


616
617
618
 
# File 'app/models/merge_request.rb', line 616

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

#in_locked_state ⇒ Object 


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

def in_locked_state
  lock_mr
  yield
ensure
  unlock_mr
end

#includes_ci_config? ⇒ Boolean

Returns:

  • (Boolean) 

1968
1969
1970
1971
1972
 
# File 'app/models/merge_request.rb', line 1968

def includes_ci_config?
  return false unless diff_stats

  diff_stats.map(&:path).include?(project.ci_config_path_or_default)
end

#issues_mentioned_but_not_closing(current_user) ⇒ Object 


1310
1311
1312
1313
1314
1315
1316
1317
 
# File 'app/models/merge_request.rb', line 1310

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_commit ⇒ Object

rubocop: enable CodeReuse/ServiceClass


1836
1837
1838
 
# File 'app/models/merge_request.rb', line 1836

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

#legacy_environments ⇒ Object

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.


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

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

  build_for_actual_head_pipeline = Ci::Build.latest.where(pipeline: actual_head_pipeline)

  environments = build_for_actual_head_pipeline.joins(:metadata)
                                              .where.not('ci_builds_metadata.expanded_environment_name' => nil)
                                              .distinct('ci_builds_metadata.expanded_environment_name')
                                              .limit(100)
                                              .pluck(:expanded_environment_name)

  Environment.where(project: project, name: environments)
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.


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

def merge_async(user_id, params)
  jid = MergeWorker.with_status.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_base_pipeline ⇒ Object 


1868
1869
1870
1871
1872
 
# File 'app/models/merge_request.rb', line 1868

def merge_base_pipeline
  @merge_base_pipeline ||= project.ci_pipelines
    .order(id: :desc)
    .find_by(sha: actual_head_pipeline.target_sha, ref: target_branch)
end

#merge_commit ⇒ Object 


1741
1742
1743
 
# File 'app/models/merge_request.rb', line 1741

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

#merge_event ⇒ Object 


1121
1122
1123
 
# File 'app/models/merge_request.rb', line 1121

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) 

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

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_participants ⇒ Object 


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

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_pipeline ⇒ Object 


498
499
500
501
502
503
504
505
506
 
# File 'app/models/merge_request.rb', line 498

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_head ⇒ Object

Returns the current merge-ref HEAD commit.


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

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

  project.repository.commit(merge_ref_path)
end

#merge_ref_path ⇒ Object 


1483
1484
1485
 
# File 'app/models/merge_request.rb', line 1483

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

#merge_request_assignees_with(user_ids) ⇒ Object 


1949
1950
1951
 
# File 'app/models/merge_request.rb', line 1949

def merge_request_assignees_with(user_ids)
  merge_request_assignees.where(user_id: user_ids)
end

#merge_request_diff ⇒ Object

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.


82
83
84
85
86
 
# File 'app/models/merge_request.rb', line 82

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 


1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
 
# File 'app/models/merge_request.rb', line 1049

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

#merge_request_reviewers_with(user_ids) ⇒ Object 


1957
1958
1959
 
# File 'app/models/merge_request.rb', line 1957

def merge_request_reviewers_with(user_ids)
  merge_request_reviewers.where(user_id: user_ids)
end

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

Returns:

  • (Boolean) 

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

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) 

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

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) 

1251
1252
1253
1254
1255
 
# File 'app/models/merge_request.rb', line 1251

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

rubocop: disable CodeReuse/ServiceClass

Returns:

  • (Boolean) 

1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
 
# File 'app/models/merge_request.rb', line 1154

def mergeable_state?(skip_ci_check: false, skip_discussions_check: false)
  if Feature.enabled?(:improved_mergeability_checks, self.project)
    additional_checks = MergeRequests::Mergeability::RunChecksService.new(
      merge_request: self,
      params: {
        skip_ci_check: skip_ci_check,
        skip_discussions_check: skip_discussions_check
      }
    )
    additional_checks.execute.all?(&:success?)
  else
    return false unless open?
    return false if draft?
    return false if broken?
    return false unless skip_discussions_check || mergeable_discussions_state?
    return false unless skip_ci_check || mergeable_ci_state?

    true
  end
end

#merged_at ⇒ Object 


1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
 
# File 'app/models/merge_request.rb', line 1777

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

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

#merged_commit_sha ⇒ Object 


1749
1750
1751
1752
1753
1754
 
# File 'app/models/merge_request.rb', line 1749

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 


796
797
798
799
800
801
802
803
804
 
# File 'app/models/merge_request.rb', line 796

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_paths ⇒ Object 


806
807
808
 
# File 'app/models/merge_request.rb', line 806

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

#non_latest_diffs ⇒ Object 


746
747
748
 
# File 'app/models/merge_request.rb', line 746

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

#note_positions_for_paths(paths, user = nil) ⇒ Object 


750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
 
# File 'app/models/merge_request.rb', line 750

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) 

1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
 
# File 'app/models/merge_request.rb', line 1218

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

#permits_force_push? ⇒ Boolean

Returns:

  • (Boolean) 

485
486
487
488
489
 
# File 'app/models/merge_request.rb', line 485

def permits_force_push?
  return true unless ProtectedBranch.protected?(source_project, source_branch)

  ProtectedBranch.allow_force_push?(source_project, source_branch)
end

#pipeline_coverage_delta ⇒ Object 


1848
1849
1850
1851
1852
 
# File 'app/models/merge_request.rb', line 1848

def pipeline_coverage_delta
  if base_pipeline&.coverage && head_pipeline&.coverage
    head_pipeline.coverage - base_pipeline.coverage
  end
end

#predefined_variables ⇒ Object 


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

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) 

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

def preloads_discussion_diff_highlighting?
  true
end

#public_merge_status ⇒ Object

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


247
248
249
 
# File 'app/models/merge_request.rb', line 247

def public_merge_status
  cannot_be_merged_rechecking? || preparing? ? 'checking' : merge_status
end

#raw_diffs(*args) ⇒ Object 


731
732
733
 
# File 'app/models/merge_request.rb', line 731

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.


697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
 
# File 'app/models/merge_request.rb', line 697

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.with_status.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) 

481
482
483
 
# File 'app/models/merge_request.rb', line 481

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

#recent_commits(load_from_gitaly: false) ⇒ Object 


652
653
654
 
# File 'app/models/merge_request.rb', line 652

def recent_commits(load_from_gitaly: false)
  commits(limit: MergeRequestDiff::COMMITS_SAFE_SIZE, load_from_gitaly: load_from_gitaly)
end

#recent_context_commits ⇒ Object 


631
632
633
 
# File 'app/models/merge_request.rb', line 631

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

#recent_diff_head_shas(limit = 100) ⇒ Object 


1721
1722
1723
 
# File 'app/models/merge_request.rb', line 1721

def recent_diff_head_shas(limit = 100)
  merge_request_diffs.recent(limit).pluck(:head_commit_sha)
end

#recent_visible_deployments ⇒ Object 


1920
1921
1922
 
# File 'app/models/merge_request.rb', line 1920

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) 

1117
1118
1119
 
# File 'app/models/merge_request.rb', line 1117

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

#ref_path ⇒ Object 


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

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

#related_notes ⇒ Object Also known as: discussion_notes 


1229
1230
1231
1232
1233
1234
1235
1236
1237
 
# File 'app/models/merge_request.rb', line 1229

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


1092
1093
1094
1095
1096
 
# File 'app/models/merge_request.rb', line 1092

def reload_diff(current_user = nil)
  return unless open?

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

#reload_diff_if_branch_changed ⇒ Object 


1084
1085
1086
1087
1088
1089
 
# File 'app/models/merge_request.rb', line 1084

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) 

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

def remove_source_branch?
  should_remove_source_branch? || force_remove_source_branch?
end

#reopenable? ⇒ Boolean

Returns:

  • (Boolean) 

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

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

#repository_diff_refs ⇒ Object

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


921
922
923
924
925
926
927
 
# File 'app/models/merge_request.rb', line 921

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_sha ⇒ Object 


1745
1746
1747
 
# File 'app/models/merge_request.rb', line 1745

def short_merge_commit_sha
  Commit.truncate_sha(merge_commit_sha) if merge_commit_sha
end

#short_merged_commit_sha ⇒ Object 


1756
1757
1758
1759
1760
 
# File 'app/models/merge_request.rb', line 1756

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

#should_be_rebased? ⇒ Boolean

Returns:

  • (Boolean) 

1180
1181
1182
 
# File 'app/models/merge_request.rb', line 1180

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

#should_remove_source_branch? ⇒ Boolean

Returns:

  • (Boolean) 

1196
1197
1198
 
# File 'app/models/merge_request.rb', line 1196

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

#source_branch_exists? ⇒ Boolean

Returns:

  • (Boolean) 

1351
1352
1353
1354
1355
 
# File 'app/models/merge_request.rb', line 1351

def source_branch_exists?
  return false unless self.source_project

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

#source_branch_head ⇒ Object 


878
879
880
881
882
883
884
 
# File 'app/models/merge_request.rb', line 878

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_ref ⇒ Object 


864
865
866
867
868
869
 
# File 'app/models/merge_request.rb', line 864

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) 

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

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_namespace ⇒ Object 


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

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

#source_project_path ⇒ Object 


1327
1328
1329
1330
1331
1332
1333
 
# File 'app/models/merge_request.rb', line 1327

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

#squash_on_merge? ⇒ Boolean

Returns:

  • (Boolean) 

1402
1403
1404
1405
1406
1407
 
# File 'app/models/merge_request.rb', line 1402

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

  squash?
end

#supports_assignee? ⇒ Boolean

Returns:

  • (Boolean) 

1941
1942
1943
 
# File 'app/models/merge_request.rb', line 1941

def supports_assignee?
  true
end

#supports_suggestion? ⇒ Boolean

Returns:

  • (Boolean) 

679
680
681
 
# File 'app/models/merge_request.rb', line 679

def supports_suggestion?
  true
end

#target_branch_exists? ⇒ Boolean

Returns:

  • (Boolean) 

1357
1358
1359
1360
1361
 
# File 'app/models/merge_request.rb', line 1357

def target_branch_exists?
  return false unless self.target_project

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

#target_branch_head ⇒ Object 


886
887
888
889
890
 
# File 'app/models/merge_request.rb', line 886

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

#target_branch_ref ⇒ Object 


871
872
873
874
875
876
 
# File 'app/models/merge_request.rb', line 871

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_namespace ⇒ Object 


1343
1344
1345
1346
1347
1348
1349
 
# File 'app/models/merge_request.rb', line 1343

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

#target_project_path ⇒ Object 


1319
1320
1321
1322
1323
1324
1325
 
# File 'app/models/merge_request.rb', line 1319

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.


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

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

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

#train_ref_path ⇒ Object 


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

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

#update_and_mark_in_progress_merge_commit_sha(commit_id) ⇒ Object 


1515
1516
1517
1518
1519
1520
1521
 
# File 'app/models/merge_request.rb', line 1515

def update_and_mark_in_progress_merge_commit_sha(commit_id)
  self.update(in_progress_merge_commit_sha: commit_id)
  # Since another process checks for matching merge request, we need
  # to make it possible to detect whether the query should go to the
  # primary.
  target_project.mark_primary_write_location
end

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

rubocop: disable CodeReuse/ServiceClass


1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
 
# File 'app/models/merge_request.rb', line 1797

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

  active_discussions_resolved = active_diff_discussions.all?(&:resolved?)

  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)
    discussion.clear_memoized_values
  end

  # If they were all already resolved, this method will have already been called.
  # If they all don't get resolved, we don't need to call the method
  # If they go from unresolved -> resolved, then we call the method
  if !active_discussions_resolved &&
      active_diff_discussions.all?(&:resolved?) &&
      project.resolve_outdated_diff_discussions?
    MergeRequests::ResolvedDiscussionNotificationService
      .new(project: project, current_user: current_user)
      .execute(self)
  end
end

#update_head_pipeline ⇒ Object 


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

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_caches ⇒ Object

rubocop: disable CodeReuse/ServiceClass


1879
1880
1881
 
# File 'app/models/merge_request.rb', line 1879

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

#use_merge_base_pipeline_for_comparison?(service_class) ⇒ Boolean

Returns:

  • (Boolean) 

1854
1855
1856
 
# File 'app/models/merge_request.rb', line 1854

def use_merge_base_pipeline_for_comparison?(service_class)
  ALLOWED_TO_USE_MERGE_BASE_PIPELINE_FOR_COMPARISON[service_class]&.call(project)
end

#validate_branch_name(attr) ⇒ Object 


963
964
965
966
967
968
969
970
971
 
# File 'app/models/merge_request.rb', line 963

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_branches ⇒ Object 


933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
 
# File 'app/models/merge_request.rb', line 933

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_fork ⇒ Object 


979
980
981
982
983
984
985
986
 
# File 'app/models/merge_request.rb', line 979

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_project ⇒ Object 


973
974
975
976
977
 
# File 'app/models/merge_request.rb', line 973

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 


1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
 
# File 'app/models/merge_request.rb', line 1066

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_diffs ⇒ Object 


1045
1046
1047
 
# File 'app/models/merge_request.rb', line 1045

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

#visible_closing_issues_for(current_user = self.author) ⇒ Object 


1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
 
# File 'app/models/merge_request.rb', line 1285

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