merge_request.rb 15.2 KB
Newer Older
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
1
class MergeRequest < ActiveRecord::Base
2
  include InternalId
3
4
  include Issuable
  include Referable
5
  include Sortable
6
  include Taskable
7

8
9
  belongs_to :target_project, foreign_key: :target_project_id, class_name: "Project"
  belongs_to :source_project, foreign_key: :source_project_id, class_name: "Project"
10
  belongs_to :merge_user, class_name: "User"
11

12
  has_one :merge_request_diff, dependent: :destroy
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
13

14
15
  serialize :merge_params, Hash

16
  after_create :create_merge_request_diff
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
17
  after_update :update_merge_request_diff
18

19
  delegate :commits, :diffs, :real_size, to: :merge_request_diff, prefix: nil
20

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
21
22
23
24
  # When this attribute is true some MR validation is ignored
  # It allows us to close or modify broken merge requests
  attr_accessor :allow_broken

25
26
  # Temporary fields to store compare vars
  # when creating new merge request
27
  attr_accessor :can_be_created, :compare_commits, :compare
28

29
30
31
32
  # Temporary fields to store target_sha, and base_sha to
  # compare when importing pull requests from GitHub
  attr_accessor :base_target_sha, :head_source_sha

Andrew8xx8's avatar
Andrew8xx8 committed
33
  state_machine :state, initial: :opened do
34
35
36
37
    event :close do
      transition [:reopened, :opened] => :closed
    end

38
    event :mark_as_merged do
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
39
      transition [:reopened, :opened, :locked] => :merged
40
41
42
    end

    event :reopen do
Andrew8xx8's avatar
Andrew8xx8 committed
43
      transition closed: :reopened
44
45
    end

46
    event :lock_mr do
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
47
48
49
      transition [:reopened, :opened] => :locked
    end

50
    event :unlock_mr do
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
51
52
53
      transition locked: :reopened
    end

54
55
56
57
58
    after_transition any => :locked do |merge_request, transition|
      merge_request.locked_at = Time.now
      merge_request.save
    end

59
    after_transition locked: (any - :locked) do |merge_request, transition|
60
61
62
63
      merge_request.locked_at = nil
      merge_request.save
    end

64
65
66
67
    state :opened
    state :reopened
    state :closed
    state :merged
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
68
    state :locked
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
89
90
91
92
93
94
95

    around_transition do |merge_request, transition, block|
      merge_request.record_timestamps = false
      begin
        block.call
      ensure
        merge_request.record_timestamps = true
      end
    end
96
  end
97

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
98
  validates :source_project, presence: true, unless: :allow_broken
Andrey Kumanyaev's avatar
Andrey Kumanyaev committed
99
  validates :source_branch, presence: true
100
  validates :target_project, presence: true
Andrey Kumanyaev's avatar
Andrey Kumanyaev committed
101
  validates :target_branch, presence: true
Zeger-Jan van de Weg's avatar
Zeger-Jan van de Weg committed
102
  validates :merge_user, presence: true, if: :merge_when_build_succeeds?
103
  validate :validate_branches, unless: :allow_broken
104
  validate :validate_fork
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
105

106
  scope :by_branch, ->(branch_name) { where("(source_branch LIKE :branch) OR (target_branch LIKE :branch)", branch: branch_name) }
107
  scope :cared, ->(user) { where('assignee_id = :user OR author_id = :user', user: user.id) }
108
  scope :by_milestone, ->(milestone) { where(milestone_id: milestone) }
109
  scope :of_projects, ->(ids) { where(target_project_id: ids) }
110
  scope :from_project, ->(project) { where(source_project_id: project.id) }
111
112
  scope :merged, -> { with_state(:merged) }
  scope :closed_and_merged, -> { with_states(:closed, :merged) }
113

114
115
116
  scope :join_project, -> { joins(:target_project) }
  scope :references_project, -> { references(:target_project) }

117
118
119
120
  def self.reference_prefix
    '!'
  end

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

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

135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
  # 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)
    source = where(source_project_id: relation).select(:id)
    target = where(target_project_id: relation).select(:id)
    union  = Gitlab::SQL::Union.new([source, target])

    where("merge_requests.id IN (#{union.to_sql})")
  end

153
154
155
156
157
158
159
160
161
162
  def to_reference(from_project = nil)
    reference = "#{self.class.reference_prefix}#{iid}"

    if cross_project_reference?(from_project)
      reference = project.to_reference + reference
    end

    reference
  end

163
164
  def last_commit
    merge_request_diff ? merge_request_diff.last_commit : compare_commits.last
165
  end
166
167
168

  def first_commit
    merge_request_diff ? merge_request_diff.first_commit : compare_commits.first
169
  end
170

171
172
173
174
  def diff_size
    merge_request_diff.size
  end

175
176
177
  def diff_base_commit
    if merge_request_diff
      merge_request_diff.base_commit
Douwe Maan's avatar
Douwe Maan committed
178
    elsif source_sha
179
      self.target_project.merge_base_commit(self.source_sha, self.target_branch)
180
181
182
    end
  end

183
184
185
186
  def last_commit_short_sha
    last_commit.short_id
  end

187
  def validate_branches
188
    if target_project == source_project && target_branch == source_branch
189
      errors.add :branch_conflict, "You can not use same project/branch for source and target"
190
    end
191

192
    if opened? || reopened?
193
      similar_mrs = self.target_project.merge_requests.where(source_branch: source_branch, target_branch: target_branch, source_project_id: source_project.try(:id)).opened
194
195
      similar_mrs = similar_mrs.where('id not in (?)', self.id) if self.id
      if similar_mrs.any?
196
        errors.add :validate_branches,
Gabriel Mazetto's avatar
Gabriel Mazetto committed
197
                   "Cannot Create: This merge request already exists: #{similar_mrs.pluck(:title)}"
198
      end
199
    end
200
201
  end

202
  def validate_fork
203
204
205
    return true unless target_project && source_project

    if target_project == source_project
206
207
208
209
210
211
212
      true
    else
      # If source and target projects are different
      # we should check if source project is actually a fork of target project
      if source_project.forked_from?(target_project)
        true
      else
213
214
        errors.add :validate_fork,
                   'Source project is not a fork of target project'
215
216
217
218
      end
    end
  end

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
219
220
221
222
223
224
  def update_merge_request_diff
    if source_branch_changed? || target_branch_changed?
      reload_code
    end
  end

225
  def reload_code
226
    if merge_request_diff && open?
227
228
      merge_request_diff.reload_content
    end
229
230
  end

231
  def check_if_can_be_merged
232
233
    return unless unchecked?

234
    can_be_merged =
235
      !broken? && project.repository.can_be_merged?(source_sha, target_branch)
236
237

    if can_be_merged
238
239
240
241
      mark_as_mergeable
    else
      mark_as_unmergeable
    end
242
243
  end

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
244
  def merge_event
245
    self.target_project.events.where(target_id: self.id, target_type: "MergeRequest", action: Event::MERGED).last
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
246
247
  end

248
  def closed_event
249
    self.target_project.events.where(target_id: self.id, target_type: "MergeRequest", action: Event::CLOSED).last
250
251
  end

252
  WIP_REGEX = /\A\s*(\[WIP\]\s*|WIP:\s*|WIP\s+)+\s*/i.freeze
253

254
  def work_in_progress?
255
    !!(title =~ WIP_REGEX)
256
257
258
259
  end

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

262
  def mergeable?
Rubén Dávila's avatar
Rubén Dávila committed
263
    return false unless open? && !work_in_progress? && !broken?
264
265
266
267

    check_if_can_be_merged

    can_be_merged?
268
269
  end

270
  def gitlab_merge_status
271
272
273
274
275
276
277
    if work_in_progress?
      "work_in_progress"
    else
      merge_status_name
    end
  end

278
279
  def can_cancel_merge_when_build_succeeds?(current_user)
    can_be_merged_by?(current_user) || self.author == current_user
280
281
  end

282
283
284
  def can_remove_source_branch?(current_user)
    !source_project.protected_branch?(source_branch) &&
      !source_project.root_ref?(source_branch) &&
285
286
      Ability.abilities.allowed?(current_user, :push_code, source_project) &&
      last_commit == source_project.commit(source_branch)
287
288
  end

289
290
291
292
293
294
295
296
297
298
299
300
  def should_remove_source_branch?
    merge_params['should_remove_source_branch'].present?
  end

  def force_remove_source_branch?
    merge_params['force_remove_source_branch'].present?
  end

  def remove_source_branch?
    should_remove_source_branch? || force_remove_source_branch?
  end

301
  def mr_and_commit_notes
302
303
304
305
    # Fetch comments only from last 100 commits
    commits_for_notes_limit = 100
    commit_ids = commits.last(commits_for_notes_limit).map(&:id)

306
307
    Note.where(
      "(project_id = :target_project_id AND noteable_type = 'MergeRequest' AND noteable_id = :mr_id) OR" +
308
      "((project_id = :source_project_id OR project_id = :target_project_id) AND noteable_type = 'Commit' AND commit_id IN (:commit_ids))",
309
      mr_id: id,
310
311
312
      commit_ids: commit_ids,
      target_project_id: target_project_id,
      source_project_id: source_project_id
313
    )
314
  end
315

316
317
318
  # Returns the raw diff for this merge request
  #
  # see "git diff"
319
  def to_diff
320
    target_project.repository.diff_text(diff_base_commit.sha, source_sha)
321
322
323
324
325
  end

  # Returns the commit as a series of email patches.
  #
  # see "git format-patch"
326
  def to_patch
327
    target_project.repository.format_patch(diff_base_commit.sha, source_sha)
328
  end
329

Kirill Zaitsev's avatar
Kirill Zaitsev committed
330
331
  def hook_attrs
    attrs = {
332
333
      source: source_project.try(:hook_attrs),
      target: target_project.hook_attrs,
334
335
      last_commit: nil,
      work_in_progress: work_in_progress?
Kirill Zaitsev's avatar
Kirill Zaitsev committed
336
337
    }

Valery Sizov's avatar
Valery Sizov committed
338
    if last_commit
339
      attrs.merge!(last_commit: last_commit.hook_attrs)
Kirill Zaitsev's avatar
Kirill Zaitsev committed
340
341
342
343
344
    end

    attributes.merge!(attrs)
  end

345
346
347
348
  def for_fork?
    target_project != source_project
  end

349
350
351
352
  def project
    target_project
  end

353
354
355
356
  def closes_issue?(issue)
    closes_issues.include?(issue)
  end

357
  # Return the set of issues that will be closed if this merge request is accepted.
358
  def closes_issues(current_user = self.author)
359
    if target_branch == project.default_branch
360
361
362
363
      messages = commits.map(&:safe_message) << description

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

369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
  def target_project_path
    if target_project
      target_project.path_with_namespace
    else
      "(removed)"
    end
  end

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

385
386
387
388
389
390
391
392
  def source_project_namespace
    if source_project && source_project.namespace
      source_project.namespace.path
    else
      "(removed)"
    end
  end

393
394
395
396
397
398
399
400
  def target_project_namespace
    if target_project && target_project.namespace
      target_project.namespace.path
    else
      "(removed)"
    end
  end

401
402
403
404
405
406
407
408
409
410
411
412
  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

Drew Blessing's avatar
Drew Blessing committed
413
414
415
416
417
418
419
420
421
  # Reset merge request events cache
  #
  # Since we do cache @event we need to reset cache in special cases:
  # * when a merge request is updated
  # Events cache stored like  events/23-20130109142513.
  # The cache key includes updated_at timestamp.
  # Thus it will automatically generate a new fragment
  # when the event is updated because the key changes.
  def reset_events_cache
422
    Event.reset_event_cache_for(self)
Drew Blessing's avatar
Drew Blessing committed
423
424
  end

425
426
427
  def merge_commit_message
    message = "Merge branch '#{source_branch}' into '#{target_branch}'"
    message << "\n\n"
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
428
    message << title.to_s
429
    message << "\n\n"
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
430
    message << description.to_s
431
432
    message << "\n\n"
    message << "See merge request !#{iid}"
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
433
    message
434
  end
435

436
437
  def reset_merge_when_build_succeeds
    return unless merge_when_build_succeeds?
438

439
440
    self.merge_when_build_succeeds = false
    self.merge_user = nil
441
442
443
444
    if merge_params
      merge_params.delete('should_remove_source_branch')
      merge_params.delete('commit_message')
    end
445
446
447
448

    self.save
  end

449
  # Return array of possible target branches
Steven Burgart's avatar
Steven Burgart committed
450
  # depends on target project of MR
451
452
453
454
455
456
457
458
459
  def target_branches
    if target_project.nil?
      []
    else
      target_project.repository.branch_names
    end
  end

  # Return array of possible source branches
Steven Burgart's avatar
Steven Burgart committed
460
  # depends on source project of MR
461
462
463
464
465
466
467
  def source_branches
    if source_project.nil?
      []
    else
      source_project.repository.branch_names
    end
  end
468
469

  def locked_long_ago?
Ben Bodenmiller's avatar
Ben Bodenmiller committed
470
471
472
    return false unless locked?

    locked_at.nil? || locked_at < (Time.now - 1.day)
473
  end
474
475
476
477
478
479
480
481

  def has_ci?
    source_project.ci_service && commits.any?
  end

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

483
484
485
486
  def broken?
    self.commits.blank? || branch_missing? || cannot_be_merged?
  end

487
488
489
  def can_be_merged_by?(user)
    ::Gitlab::GitAccess.new(user, project).can_push_to_branch?(target_branch)
  end
490
491
492
493
494
495
496
497
498
499

  def state_human_name
    if merged?
      "Merged"
    elsif closed?
      "Closed"
    else
      "Open"
    end
  end
500

501
502
503
504
505
506
507
508
509
510
  def state_icon_name
    if merged?
      "check"
    elsif closed?
      "times"
    else
      "circle-o"
    end
  end

511
  def target_sha
512
513
514
    return @base_target_sha if defined?(@base_target_sha)

    target_project.repository.commit(target_branch).try(:sha)
515
516
517
  end

  def source_sha
518
519
    return @head_source_sha if defined?(@head_source_sha)

520
521
522
523
524
    last_commit.try(:sha) || source_tip.try(:sha)
  end

  def source_tip
    source_branch && source_project.repository.commit(source_branch)
525
526
527
528
529
530
  end

  def fetch_ref
    target_project.repository.fetch_ref(
      source_project.repository.path_to_repo,
      "refs/heads/#{source_branch}",
531
      ref_path
532
533
534
    )
  end

535
536
537
538
539
  def ref_path
    "refs/merge-requests/#{iid}/head"
  end

  def ref_is_fetched?
540
    File.exist?(File.join(project.repository.path_to_repo, ref_path))
541
542
543
544
545
546
  end

  def ensure_ref_fetched
    fetch_ref unless ref_is_fetched?
  end

547
548
549
550
551
552
553
554
  def in_locked_state
    begin
      lock_mr
      yield
    ensure
      unlock_mr if locked?
    end
  end
555

556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
  def diverged_commits_count
    cache = Rails.cache.read(:"merge_request_#{id}_diverged_commits")

    if cache.blank? || cache[:source_sha] != source_sha || cache[:target_sha] != target_sha
      cache = {
        source_sha: source_sha,
        target_sha: target_sha,
        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
572
573
    return 0 unless source_sha && target_sha

574
575
    Gitlab::Git::Commit.between(target_project.repository.raw_repository, source_sha, target_sha).size
  end
576
  private :compute_diverged_commits_count
577
578
579
580
581

  def diverged_from_target_branch?
    diverged_commits_count > 0
  end

582
583
  def pipeline
    @pipeline ||= source_project.pipeline(last_commit.id, source_branch) if last_commit && source_project
584
  end
585

Douwe Maan's avatar
Douwe Maan committed
586
  def diff_refs
587
588
589
    return nil unless diff_base_commit

    [diff_base_commit, last_commit]
590
  end
591
592
593
594
595

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

596
597
  def can_be_reverted?(current_user = nil)
    merge_commit && !merge_commit.has_been_reverted?(current_user, self)
598
  end
599
600
601
602

  def can_be_cherry_picked?
    merge_commit
  end
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
603
end