merge_request.rb 25.6 KB
Newer Older
D
Dmitriy Zaporozhets 已提交
1
class MergeRequest < ActiveRecord::Base
2
  include InternalId
3
  include Issuable
4
  include Noteable
5
  include Referable
6
  include Sortable
7
  include IgnorableColumn
J
James Lopez 已提交
8
  include CreatedAtFilterable
9

10
  ignore_column :locked_at
11

12 13
  belongs_to :target_project, class_name: "Project"
  belongs_to :source_project, class_name: "Project"
Z
Zeger-Jan van de Weg 已提交
14
  belongs_to :merge_user, class_name: "User"
15

16
  has_many :merge_request_diffs
17
  has_one :merge_request_diff,
18
    -> { order('merge_request_diffs.id DESC') }, inverse_of: :merge_request
19

20 21
  belongs_to :head_pipeline, foreign_key: "head_pipeline_id", class_name: "Ci::Pipeline"

22
  has_many :events, as: :target, dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent
23

24 25 26
  has_many :merge_requests_closing_issues,
    class_name: 'MergeRequestsClosingIssues',
    dependent: :delete_all # rubocop:disable Cop/ActiveRecordDependent
27

28 29
  belongs_to :assignee, class_name: "User"

30
  serialize :merge_params, Hash # rubocop:disable Cop/ActiveRecordSerialize
Z
Zeger-Jan van de Weg 已提交
31

32 33
  after_create :ensure_merge_request_diff, unless: :importing?
  after_update :reload_diff_if_branch_changed
34
  after_commit :update_project_counter_caches, on: :destroy
35

D
Dmitriy Zaporozhets 已提交
36 37 38 39
  # When this attribute is true some MR validation is ignored
  # It allows us to close or modify broken merge requests
  attr_accessor :allow_broken

D
Dmitriy Zaporozhets 已提交
40 41
  # Temporary fields to store compare vars
  # when creating new merge request
42
  attr_accessor :can_be_created, :compare_commits, :diff_options, :compare
D
Dmitriy Zaporozhets 已提交
43

A
Andrew8xx8 已提交
44
  state_machine :state, initial: :opened do
A
Andrew8xx8 已提交
45
    event :close do
46
      transition [:opened] => :closed
A
Andrew8xx8 已提交
47 48
    end

49
    event :mark_as_merged do
50
      transition [:opened, :locked] => :merged
A
Andrew8xx8 已提交
51 52 53
    end

    event :reopen do
54
      transition closed: :opened
A
Andrew8xx8 已提交
55 56
    end

57
    event :lock_mr do
58
      transition [:opened] => :locked
D
Dmitriy Zaporozhets 已提交
59 60
    end

61
    event :unlock_mr do
62
      transition locked: :opened
D
Dmitriy Zaporozhets 已提交
63 64
    end

A
Andrew8xx8 已提交
65 66 67
    state :opened
    state :closed
    state :merged
D
Dmitriy Zaporozhets 已提交
68
    state :locked
A
Andrew8xx8 已提交
69 70
  end

71 72 73 74 75 76
  state_machine :merge_status, initial: :unchecked do
    event :mark_as_unchecked do
      transition [:can_be_merged, :cannot_be_merged] => :unchecked
    end

    event :mark_as_mergeable do
77
      transition [:unchecked, :cannot_be_merged] => :can_be_merged
78 79 80
    end

    event :mark_as_unmergeable do
81
      transition [:unchecked, :can_be_merged] => :cannot_be_merged
82 83
    end

84
    state :unchecked
85 86
    state :can_be_merged
    state :cannot_be_merged
87 88

    around_transition do |merge_request, transition, block|
89
      Gitlab::Timeless.timeless(merge_request, &block)
90
    end
91
  end
92

93
  validates :source_project, presence: true, unless: [:allow_broken, :importing?, :closed_without_fork?]
A
Andrey Kumanyaev 已提交
94
  validates :source_branch, presence: true
I
Izaak Alpert 已提交
95
  validates :target_project, presence: true
A
Andrey Kumanyaev 已提交
96
  validates :target_branch, presence: true
J
James Lopez 已提交
97
  validates :merge_user, presence: true, if: :merge_when_pipeline_succeeds?, unless: :importing?
98 99
  validate :validate_branches, unless: [:allow_broken, :importing?, :closed_without_fork?]
  validate :validate_fork, unless: :closed_without_fork?
100
  validate :validate_target_project, on: :create
D
Dmitriy Zaporozhets 已提交
101

102 103 104
  scope :by_source_or_target_branch, ->(branch_name) do
    where("source_branch = :branch OR target_branch = :branch", branch: branch_name)
  end
105
  scope :by_milestone, ->(milestone) { where(milestone_id: milestone) }
106
  scope :of_projects, ->(ids) { where(target_project_id: ids) }
107
  scope :from_project, ->(project) { where(source_project_id: project.id) }
108 109
  scope :merged, -> { with_state(:merged) }
  scope :closed_and_merged, -> { with_states(:closed, :merged) }
S
Scott Le 已提交
110
  scope :from_source_branches, ->(branches) { where(source_branch: branches) }
111

112 113
  scope :join_project, -> { joins(:target_project) }
  scope :references_project, -> { references(:target_project) }
114 115 116 117 118
  scope :assigned, -> { where("assignee_id IS NOT NULL") }
  scope :unassigned, -> { where("assignee_id IS NULL") }
  scope :assigned_to, ->(u) { where(assignee_id: u.id)}

  participant :assignee
119

120 121
  after_save :keep_around_commit

122 123 124 125
  def self.reference_prefix
    '!'
  end

126 127 128 129
  # Pattern used to extract `!123` merge request references from text
  #
  # This pattern supports cross-project references.
  def self.reference_pattern
130
    @reference_pattern ||= %r{
131
      (#{Project.reference_pattern})?
132 133 134 135
      #{Regexp.escape(reference_prefix)}(?<merge_request>\d+)
    }x
  end

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

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

144 145 146 147
  def self.project_foreign_key
    'target_project_id'
  end

148 149 150 151 152 153 154 155 156 157 158
  # 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.
  def self.in_projects(relation)
M
mhasbini 已提交
159 160 161 162
    # unscoping unnecessary conditions that'll be applied
    # when executing `where("merge_requests.id IN (#{union.to_sql})")`
    source = unscoped.where(source_project_id: relation).select(:id)
    target = unscoped.where(target_project_id: relation).select(:id)
163 164
    union  = Gitlab::SQL::Union.new([source, target])

165
    where("merge_requests.id IN (#{union.to_sql})") # rubocop:disable GitlabSecurity/SqlInjection
166 167
  end

T
Thomas Balthazar 已提交
168 169 170 171 172 173 174 175 176 177 178 179 180 181
  WIP_REGEX = /\A\s*(\[WIP\]\s*|WIP:\s*|WIP\s+)+\s*/i.freeze

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

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

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

182 183 184 185 186 187 188 189
  # Returns a Hash of attributes to be used for Twitter card metadata
  def card_attributes
    {
      'Author'   => author.try(:name),
      'Assignee' => assignee.try(:name)
    }
  end

190
  # These method are needed for compatibility with issues to not mess view and other code
191 192 193 194
  def assignees
    Array(assignee)
  end

195 196 197 198 199 200 201 202
  def assignee_ids
    Array(assignee_id)
  end

  def assignee_ids=(ids)
    write_attribute(:assignee_id, ids.last)
  end

203 204 205 206
  def assignee_or_author?(user)
    author_id == user.id || assignee_id == user.id
  end

207
  # `from` argument can be a Namespace or Project.
208
  def to_reference(from = nil, full: false)
209 210
    reference = "#{self.class.reference_prefix}#{iid}"

211
    "#{project.to_reference(from, full: full)}#{reference}"
212 213
  end

214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243
  def commits
    if persisted?
      merge_request_diff.commits
    elsif compare_commits
      compare_commits.reverse
    else
      []
    end
  end

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

  def commit_shas
    if persisted?
      merge_request_diff.commit_shas
    elsif compare_commits
      compare_commits.reverse.map(&:sha)
    else
      []
    end
  end

244 245 246
  # Calls `MergeWorker` to proceed with the merge process and
  # updates `merge_jid` with the MergeWorker#jid.
  # This helps tracking enqueued and ongoing merge jobs.
247
  def merge_async(user_id, params)
248 249 250 251
    jid = MergeWorker.perform_async(id, user_id, params)
    update_column(:merge_jid, jid)
  end

252 253
  def first_commit
    merge_request_diff ? merge_request_diff.first_commit : compare_commits.first
254
  end
255

256
  def raw_diffs(*args)
257
    merge_request_diff ? merge_request_diff.raw_diffs(*args) : compare.raw_diffs(*args)
S
Sean McGivern 已提交
258 259
  end

260
  def diffs(diff_options = {})
261
    if compare
262
      # When saving MR diffs, `expanded` is implicitly added (because we need
263 264
      # to save the entire contents to the DB), so add that here for
      # consistency.
265
      compare.diffs(diff_options.merge(expanded: true))
266
    else
267
      merge_request_diff.diffs(diff_options)
268
    end
S
Sean McGivern 已提交
269 270
  end

J
Jacob Vosmaer 已提交
271
  def diff_size
272 273
    # Calling `merge_request_diff.diffs.real_size` will also perform
    # highlighting, which we don't need here.
274
    merge_request_diff&.real_size || diffs.real_size
J
Jacob Vosmaer 已提交
275 276
  end

277
  def diff_base_commit
278
    if persisted?
279
      merge_request_diff.base_commit
280 281
    else
      branch_merge_base_commit
282 283 284 285 286 287 288 289
    end
  end

  def diff_start_commit
    if persisted?
      merge_request_diff.start_commit
    else
      target_branch_head
290 291 292
    end
  end

293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319
  def diff_head_commit
    if persisted?
      merge_request_diff.head_commit
    else
      source_branch_head
    end
  end

  def diff_start_sha
    diff_start_commit.try(:sha)
  end

  def diff_base_sha
    diff_base_commit.try(:sha)
  end

  def diff_head_sha
    diff_head_commit.try(:sha)
  end

  # When importing a pull request from GitHub, the old and new branches may no
  # longer actually exist by those names, but we need to recreate the merge
  # request diff with the right source and target shas.
  # We use these attributes to force these to the intended values.
  attr_writer :target_branch_sha, :source_branch_sha

  def source_branch_head
320 321
    return unless source_project

322
    source_branch_ref = @source_branch_sha || source_branch
S
Sean McGivern 已提交
323
    source_project.repository.commit(source_branch_ref) if source_branch_ref
324 325 326 327
  end

  def target_branch_head
    target_branch_ref = @target_branch_sha || target_branch
S
Sean McGivern 已提交
328
    target_project.repository.commit(target_branch_ref) if target_branch_ref
329 330
  end

331 332 333 334 335 336 337 338 339
  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

340
  def target_branch_sha
341
    @target_branch_sha || target_branch_head.try(:sha)
342 343 344
  end

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

348
  def diff_refs
349
    if persisted?
350
      merge_request_diff.diff_refs
351
    else
352 353 354 355 356
      Gitlab::Diff::DiffRefs.new(
        base_sha:  diff_base_sha,
        start_sha: diff_start_sha,
        head_sha:  diff_head_sha
      )
357
    end
358 359
  end

360 361 362 363
  def branch_merge_base_sha
    branch_merge_base_commit.try(:sha)
  end

364
  def validate_branches
365
    if target_project == source_project && target_branch == source_branch
I
Izaak Alpert 已提交
366
      errors.add :branch_conflict, "You can not use same project/branch for source and target"
367
    end
368

369
    if opened?
370
      similar_mrs = self.target_project.merge_requests.where(source_branch: source_branch, target_branch: target_branch, source_project_id: source_project.try(:id)).opened
371 372
      similar_mrs = similar_mrs.where('id not in (?)', self.id) if self.id
      if similar_mrs.any?
J
jubianchi 已提交
373
        errors.add :validate_branches,
G
Gabriel Mazetto 已提交
374
                   "Cannot Create: This merge request already exists: #{similar_mrs.pluck(:title)}"
375
      end
376
    end
377 378
  end

379 380 381 382 383 384
  def validate_target_project
    return true if target_project.merge_requests_enabled?

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

385
  def validate_fork
386
    return true unless target_project && source_project
387
    return true if target_project == source_project
388
    return true unless source_project_missing?
389

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

394
  def merge_ongoing?
O
Oswaldo Ferreira 已提交
395
    !!merge_jid && !merged?
396 397
  end

398
  def closed_without_fork?
399
    closed? && source_project_missing?
400 401
  end

402
  def source_project_missing?
403 404 405 406
    return false unless for_fork?
    return true unless source_project

    !source_project.forked_from?(target_project)
407 408
  end

409
  def reopenable?
410
    closed? && !source_project_missing? && source_branch_exists?
K
Katarzyna Kobierska 已提交
411 412
  end

413 414
  def ensure_merge_request_diff
    merge_request_diff || create_merge_request_diff
415 416
  end

417
  def create_merge_request_diff
418 419 420 421 422
    # n+1: https://gitlab.com/gitlab-org/gitlab-ce/issues/37435
    Gitlab::GitalyClient.allow_n_plus_1_calls do
      merge_request_diffs.create
      reload_merge_request_diff
    end
423 424 425 426 427 428
  end

  def reload_merge_request_diff
    merge_request_diff(true)
  end

429 430 431 432 433 434 435 436 437
  def merge_request_diff_for(diff_refs_or_sha)
    @merge_request_diffs_by_diff_refs_or_sha ||= Hash.new do |h, diff_refs_or_sha|
      diffs = merge_request_diffs.viewable.select_without_diff
      h[diff_refs_or_sha] =
        if diff_refs_or_sha.is_a?(Gitlab::Diff::DiffRefs)
          diffs.find_by_diff_refs(diff_refs_or_sha)
        else
          diffs.find_by(head_commit_sha: diff_refs_or_sha)
        end
D
Douwe Maan 已提交
438 439
    end

440
    @merge_request_diffs_by_diff_refs_or_sha[diff_refs_or_sha]
441 442
  end

443 444 445 446 447 448 449 450 451 452 453
  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

454
  def reload_diff_if_branch_changed
455 456
    if (source_branch_changed? || target_branch_changed?) &&
        (source_branch_head && target_branch_head)
457
      reload_diff
D
Dmitriy Zaporozhets 已提交
458 459 460
    end
  end

461
  def reload_diff(current_user = nil)
462 463
    return unless open?

464
    old_diff_refs = self.diff_refs
465
    create_merge_request_diff
466
    MergeRequests::MergeRequestDiffCacheService.new.execute(self)
467 468
    new_diff_refs = self.diff_refs

469
    update_diff_discussion_positions(
470
      old_diff_refs: old_diff_refs,
471 472
      new_diff_refs: new_diff_refs,
      current_user: current_user
473
    )
474 475
  end

476
  def check_if_can_be_merged
477 478
    return unless unchecked?

479
    can_be_merged =
480
      !broken? && project.repository.can_be_merged?(diff_head_sha, target_branch)
481 482

    if can_be_merged
483 484 485 486
      mark_as_mergeable
    else
      mark_as_unmergeable
    end
487 488
  end

D
Dmitriy Zaporozhets 已提交
489
  def merge_event
490
    @merge_event ||= target_project.events.where(target_id: self.id, target_type: "MergeRequest", action: Event::MERGED).last
D
Dmitriy Zaporozhets 已提交
491 492
  end

493
  def closed_event
494
    @closed_event ||= target_project.events.where(target_id: self.id, target_type: "MergeRequest", action: Event::CLOSED).last
495 496
  end

497
  def work_in_progress?
T
Thomas Balthazar 已提交
498
    self.class.work_in_progress?(title)
499 500 501
  end

  def wipless_title
T
Thomas Balthazar 已提交
502 503 504 505 506
    self.class.wipless_title(self.title)
  end

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

509 510
  def mergeable?(skip_ci_check: false)
    return false unless mergeable_state?(skip_ci_check: skip_ci_check)
511 512 513 514

    check_if_can_be_merged

    can_be_merged?
515 516
  end

517
  def mergeable_state?(skip_ci_check: false)
518 519 520
    return false unless open?
    return false if work_in_progress?
    return false if broken?
521
    return false unless skip_ci_check || mergeable_ci_state?
522
    return false unless mergeable_discussions_state?
523 524

    true
525 526
  end

J
James Lopez 已提交
527
  def can_cancel_merge_when_pipeline_succeeds?(current_user)
528
    can_be_merged_by?(current_user) || self.author == current_user
529 530
  end

531
  def can_remove_source_branch?(current_user)
532
    !ProtectedBranch.protected?(source_project, source_branch) &&
533
      !source_project.root_ref?(source_branch) &&
H
http://jneen.net/ 已提交
534
      Ability.allowed?(current_user, :push_code, source_project) &&
535
      diff_head_commit == source_branch_head
536 537
  end

538
  def should_remove_source_branch?
539
    Gitlab::Utils.to_boolean(merge_params['should_remove_source_branch'])
540 541 542
  end

  def force_remove_source_branch?
543
    Gitlab::Utils.to_boolean(merge_params['force_remove_source_branch'])
544 545 546 547 548 549
  end

  def remove_source_branch?
    should_remove_source_branch? || force_remove_source_branch?
  end

550
  def related_notes
551 552
    # Fetch comments only from last 100 commits
    commits_for_notes_limit = 100
553
    commit_ids = commit_shas.take(commits_for_notes_limit)
554

555 556
    Note.where(
      "(project_id = :target_project_id AND noteable_type = 'MergeRequest' AND noteable_id = :mr_id) OR" +
557
      "((project_id = :source_project_id OR project_id = :target_project_id) AND noteable_type = 'Commit' AND commit_id IN (:commit_ids))",
558
      mr_id: id,
559 560 561
      commit_ids: commit_ids,
      target_project_id: target_project_id,
      source_project_id: source_project_id
562
    )
563
  end
564

565
  alias_method :discussion_notes, :related_notes
566

567 568 569
  def mergeable_discussions_state?
    return true unless project.only_allow_merge_if_all_discussions_are_resolved?

570
    !discussions_to_be_resolved?
571 572
  end

K
Kirill Zaitsev 已提交
573 574
  def hook_attrs
    attrs = {
575
      source: source_project.try(:hook_attrs),
K
Kirill Zaitsev 已提交
576
      target: target_project.hook_attrs,
577
      last_commit: nil,
578 579 580 581
      work_in_progress: work_in_progress?,
      total_time_spent: total_time_spent,
      human_total_time_spent: human_total_time_spent,
      human_time_estimate: human_time_estimate
K
Kirill Zaitsev 已提交
582 583
    }

584
    if diff_head_commit
D
Douwe Maan 已提交
585
      attrs[:last_commit] = diff_head_commit.hook_attrs
K
Kirill Zaitsev 已提交
586 587 588 589 590
    end

    attributes.merge!(attrs)
  end

I
Izaak Alpert 已提交
591 592 593 594
  def for_fork?
    target_project != source_project
  end

595 596 597 598
  def project
    target_project
  end

599 600 601 602
  # 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.
603
  # This optimization does not apply to issues from external sources.
604
  def cache_merge_request_closes_issues!(current_user)
605
    return unless project.issues_enabled?
606

607
    transaction do
608
      self.merge_requests_closing_issues.delete_all
609

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

613
        self.merge_requests_closing_issues.create!(issue: issue)
614 615 616 617
      end
    end
  end

618
  # Return the set of issues that will be closed if this merge request is accepted.
619
  def closes_issues(current_user = self.author)
620
    if target_branch == project.default_branch
621
      messages = [title, description]
622
      messages.concat(commits.map(&:safe_message)) if merge_request_diff
623

624 625
      Gitlab::ClosingIssueExtractor.new(project, current_user)
        .closed_by_message(messages.join("\n"))
626 627 628 629 630
    else
      []
    end
  end

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

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

637
    ext.issues - closes_issues(current_user)
638 639
  end

640 641
  def target_project_path
    if target_project
642
      target_project.full_path
643 644 645 646 647 648 649
    else
      "(removed)"
    end
  end

  def source_project_path
    if source_project
650
      source_project.full_path
651 652 653 654 655
    else
      "(removed)"
    end
  end

656 657
  def source_project_namespace
    if source_project && source_project.namespace
658
      source_project.namespace.full_path
659 660 661 662 663
    else
      "(removed)"
    end
  end

664 665
  def target_project_namespace
    if target_project && target_project.namespace
666
      target_project.namespace.full_path
667 668 669 670 671
    else
      "(removed)"
    end
  end

672 673 674 675 676 677 678 679 680 681 682 683
  def source_branch_exists?
    return false unless self.source_project

    self.source_project.repository.branch_names.include?(self.source_branch)
  end

  def target_branch_exists?
    return false unless self.target_project

    self.target_project.repository.branch_names.include?(self.target_branch)
  end

684
  def merge_commit_message(include_description: false)
685 686 687 688
    closes_issues_references = closes_issues.map do |issue|
      issue.to_reference(target_project)
    end

689 690 691 692
    message = [
      "Merge branch '#{source_branch}' into '#{target_branch}'",
      title
    ]
693

694
    if !include_description && closes_issues_references.present?
695
      message << "Closes #{closes_issues_references.to_sentence}"
696
    end
697
    message << "#{description}" if include_description && description.present?
698
    message << "See merge request #{to_reference(full: true)}"
699

700
    message.join("\n\n")
701
  end
702

J
James Lopez 已提交
703 704
  def reset_merge_when_pipeline_succeeds
    return unless merge_when_pipeline_succeeds?
705

J
James Lopez 已提交
706
    self.merge_when_pipeline_succeeds = false
Z
Zeger-Jan van de Weg 已提交
707
    self.merge_user = nil
708 709 710 711
    if merge_params
      merge_params.delete('should_remove_source_branch')
      merge_params.delete('commit_message')
    end
Z
Zeger-Jan van de Weg 已提交
712 713 714 715

    self.save
  end

716
  # Return array of possible target branches
S
Steven Burgart 已提交
717
  # depends on target project of MR
718 719 720 721 722 723 724 725 726
  def target_branches
    if target_project.nil?
      []
    else
      target_project.repository.branch_names
    end
  end

  # Return array of possible source branches
S
Steven Burgart 已提交
727
  # depends on source project of MR
728 729 730 731 732 733 734
  def source_branches
    if source_project.nil?
      []
    else
      source_project.repository.branch_names
    end
  end
735

736
  def has_ci?
737 738 739 740
    has_ci_integration = source_project.try(:ci_service)
    uses_gitlab_ci = all_pipelines.any?

    (has_ci_integration || uses_gitlab_ci) && commits.any?
741 742 743 744 745
  end

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

747
  def broken?
748
    has_no_commits? || branch_missing? || cannot_be_merged?
749 750
  end

751
  def can_be_merged_by?(user)
752 753 754 755 756 757 758
    access = ::Gitlab::UserAccess.new(user, project: project)
    access.can_push_to_branch?(target_branch) || access.can_merge_to_branch?(target_branch)
  end

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

761
  def mergeable_ci_state?
J
James Lopez 已提交
762
    return true unless project.only_allow_merge_if_pipeline_succeeds?
763

764
    !head_pipeline || head_pipeline.success? || head_pipeline.skipped?
765 766
  end

D
Douwe Maan 已提交
767
  def environments_for(current_user)
768
    return [] unless diff_head_commit
769

D
Douwe Maan 已提交
770 771 772
    @environments ||= Hash.new do |h, current_user|
      envs = EnvironmentsFinder.new(target_project, current_user,
        ref: target_branch, commit: diff_head_commit, with_tags: true).execute
773

D
Douwe Maan 已提交
774 775 776 777
      if source_project
        envs.concat EnvironmentsFinder.new(source_project, current_user,
          ref: source_branch, commit: diff_head_commit).execute
      end
778

D
Douwe Maan 已提交
779
      h[current_user] = envs.uniq
780
    end
D
Douwe Maan 已提交
781 782

    @environments[current_user]
783 784
  end

785 786 787 788 789 790 791 792 793
  def state_human_name
    if merged?
      "Merged"
    elsif closed?
      "Closed"
    else
      "Open"
    end
  end
794

795 796 797 798 799 800 801 802 803 804
  def state_icon_name
    if merged?
      "check"
    elsif closed?
      "times"
    else
      "circle-o"
    end
  end

805
  def fetch_ref
806
    write_ref
807
    update_column(:ref_fetched, true)
808 809
  end

810
  def ref_path
811
    "refs/#{Repository::REF_MERGE_REQUEST}/#{iid}/head"
812 813
  end

814
  def ref_fetched?
815 816 817 818 819 820 821
    super ||
      begin
        computed_value = project.repository.ref_exists?(ref_path)
        update_column(:ref_fetched, true) if computed_value

        computed_value
      end
822 823 824
  end

  def ensure_ref_fetched
825
    fetch_ref unless ref_fetched?
826 827
  end

828 829 830 831 832
  def in_locked_state
    begin
      lock_mr
      yield
    ensure
833
      unlock_mr
834 835
    end
  end
836

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

840
    if cache.blank? || cache[:source_sha] != source_branch_sha || cache[:target_sha] != target_branch_sha
841
      cache = {
842 843
        source_sha: source_branch_sha,
        target_sha: target_branch_sha,
844 845 846 847 848 849 850 851 852
        diverged_commits_count: compute_diverged_commits_count
      }
      Rails.cache.write(:"merge_request_#{id}_diverged_commits", cache)
    end

    cache[:diverged_commits_count]
  end

  def compute_diverged_commits_count
853
    return 0 unless source_branch_sha && target_branch_sha
854

855
    Gitlab::Git::Commit.between(target_project.repository.raw_repository, source_branch_sha, target_branch_sha).size
856
  end
857
  private :compute_diverged_commits_count
858 859 860 861 862

  def diverged_from_target_branch?
    diverged_commits_count > 0
  end

863
  def all_pipelines
864
    return Ci::Pipeline.none unless source_project
865

866
    @all_pipelines ||= source_project.pipelines
867
      .where(sha: all_commit_shas, ref: source_branch)
868
      .order(id: :desc)
869
  end
870

871
  # Note that this could also return SHA from now dangling commits
872
  #
873
  def all_commit_shas
874
    if persisted?
875 876 877 878
      column_shas = MergeRequestDiffCommit.where(merge_request_diff: merge_request_diffs).pluck('DISTINCT(sha)')
      serialised_shas = merge_request_diffs.where.not(st_commits: nil).flat_map(&:commit_shas)

      (column_shas + serialised_shas).uniq
879 880
    elsif compare_commits
      compare_commits.to_a.reverse.map(&:id)
881
    else
882
      [diff_head_sha]
883
    end
884 885
  end

886 887 888 889
  def merge_commit
    @merge_commit ||= project.commit(merge_commit_sha) if merge_commit_sha
  end

890
  def can_be_reverted?(current_user)
891
    merge_commit && !merge_commit.has_been_reverted?(current_user, self)
892
  end
893 894

  def can_be_cherry_picked?
F
Fatih Acet 已提交
895
    merge_commit.present?
896
  end
897

898
  def has_complete_diff_refs?
899
    diff_refs && diff_refs.complete?
900 901
  end

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

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

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

913
    service = Discussions::UpdateDiffPositionService.new(
914
      self.project,
915
      current_user,
916 917 918 919 920
      old_diff_refs: old_diff_refs,
      new_diff_refs: new_diff_refs,
      paths: paths
    )

921 922
    active_diff_discussions.each do |discussion|
      service.execute(discussion)
923
    end
924 925 926 927 928 929

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

932 933 934
  def keep_around_commit
    project.repository.keep_around(self.merge_commit_sha)
  end
935

936
  def has_commits?
937
    merge_request_diff && commits_count > 0
938 939 940 941 942
  end

  def has_no_commits?
    !has_commits?
  end
943

944
  def mergeable_with_quick_action?(current_user, autocomplete_precheck: false, last_diff_sha: nil)
945 946 947 948 949 950 951 952 953 954
    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 head_pipeline && !(head_pipeline.success? || head_pipeline.active?)
    return false if last_diff_sha != diff_head_sha

    true
  end
955

956 957 958 959
  def update_project_counter_caches?
    state_changed?
  end

960 961 962 963
  def update_project_counter_caches
    Projects::OpenMergeRequestsCountService.new(target_project).refresh_cache
  end

M
micael.bergeron 已提交
964
  def first_contribution?
M
micael.bergeron 已提交
965
    return false if project.team.max_member_access(author_id) > Gitlab::Access::GUEST
M
micael.bergeron 已提交
966

M
micael.bergeron 已提交
967 968 969
    project.merge_requests.merged.where(author_id: author_id).empty?
  end

970 971 972
  private

  def write_ref
973
    target_project.repository.fetch_source_branch(source_project.repository, source_branch, ref_path)
974
  end
D
Dmitriy Zaporozhets 已提交
975
end