merge_request.rb 12.7 KB
Newer Older
1 2 3 4
# == Schema Information
#
# Table name: merge_requests
#
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
5 6 7 8 9 10 11
#  id                :integer          not null, primary key
#  target_branch     :string(255)      not null
#  source_branch     :string(255)      not null
#  source_project_id :integer          not null
#  author_id         :integer
#  assignee_id       :integer
#  title             :string(255)
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
12 13
#  created_at        :datetime
#  updated_at        :datetime
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
14 15 16 17 18
#  milestone_id      :integer
#  state             :string(255)
#  merge_status      :string(255)
#  target_project_id :integer          not null
#  iid               :integer
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
19
#  description       :text
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
20
#  position          :integer          default(0)
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
21
#  locked_at         :datetime
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
22
#
23

24
require Rails.root.join("app/models/commit")
25
require Rails.root.join("lib/static_model")
26

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
27
class MergeRequest < ActiveRecord::Base
28
  include InternalId
29 30
  include Issuable
  include Referable
31
  include Sortable
32
  include Taskable
33

34 35
  belongs_to :target_project, foreign_key: :target_project_id, class_name: "Project"
  belongs_to :source_project, foreign_key: :source_project_id, class_name: "Project"
36

37
  has_one :merge_request_diff, dependent: :destroy
38
  has_many :approvals, dependent: :destroy
39
  has_many :approvers, as: :target, dependent: :destroy
40

41
  after_create :create_merge_request_diff
42
  after_update :update_merge_request_diff
43 44

  delegate :commits, :diffs, :last_commit, :last_commit_short_sha, to: :merge_request_diff, prefix: nil
45

46 47 48 49
  # When this attribute is true some MR validation is ignored
  # It allows us to close or modify broken merge requests
  attr_accessor :allow_broken

50 51
  # Temporary fields to store compare vars
  # when creating new merge request
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
52
  attr_accessor :can_be_created, :compare_failed,
53
    :compare_commits, :compare_diffs
54

Andrew8xx8's avatar
Andrew8xx8 committed
55
  state_machine :state, initial: :opened do
56 57 58 59
    event :close do
      transition [:reopened, :opened] => :closed
    end

60
    event :mark_as_merged do
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
61
      transition [:reopened, :opened, :locked] => :merged
62 63 64
    end

    event :reopen do
Andrew8xx8's avatar
Andrew8xx8 committed
65
      transition closed: :reopened
66 67
    end

68
    event :lock_mr do
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
69 70 71
      transition [:reopened, :opened] => :locked
    end

72
    event :unlock_mr do
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
73 74 75
      transition locked: :reopened
    end

76 77 78 79 80
    after_transition any => :locked do |merge_request, transition|
      merge_request.locked_at = Time.now
      merge_request.save
    end

81
    after_transition locked: (any - :locked) do |merge_request, transition|
82 83 84 85
      merge_request.locked_at = nil
      merge_request.save
    end

86 87 88 89
    state :opened
    state :reopened
    state :closed
    state :merged
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
90
    state :locked
91 92
  end

93 94 95 96 97 98
  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
99
      transition [:unchecked, :cannot_be_merged] => :can_be_merged
100 101 102
    end

    event :mark_as_unmergeable do
103
      transition [:unchecked, :can_be_merged] => :cannot_be_merged
104 105
    end

106
    state :unchecked
107 108
    state :can_be_merged
    state :cannot_be_merged
109 110 111 112 113 114 115 116 117

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

120
  validates :source_project, presence: true, unless: :allow_broken
Andrey Kumanyaev's avatar
Andrey Kumanyaev committed
121
  validates :source_branch, presence: true
122
  validates :target_project, presence: true
Andrey Kumanyaev's avatar
Andrey Kumanyaev committed
123
  validates :target_branch, presence: true
124
  validate :validate_branches
125
  validate :validate_fork
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
126

127
  scope :of_group, ->(group) { where("source_project_id in (:group_project_ids) OR target_project_id in (:group_project_ids)", group_project_ids: group.project_ids) }
128
  scope :by_branch, ->(branch_name) { where("(source_branch LIKE :branch) OR (target_branch LIKE :branch)", branch: branch_name) }
129
  scope :cared, ->(user) { where('assignee_id = :user OR author_id = :user', user: user.id) }
130
  scope :by_milestone, ->(milestone) { where(milestone_id: milestone) }
131
  scope :in_projects, ->(project_ids) { where("source_project_id in (:project_ids) OR target_project_id in (:project_ids)", project_ids: project_ids) }
132
  scope :of_projects, ->(ids) { where(target_project_id: ids) }
133 134 135
  scope :merged, -> { with_state(:merged) }
  scope :closed, -> { with_state(:closed) }
  scope :closed_and_merged, -> { with_states(:closed, :merged) }
136

137 138 139 140
  def self.reference_prefix
    '!'
  end

141 142 143 144 145
  # Pattern used to extract `!123` merge request references from text
  #
  # This pattern supports cross-project references.
  def self.reference_pattern
    %r{
146
      (#{Project.reference_pattern})?
147 148 149 150
      #{Regexp.escape(reference_prefix)}(?<merge_request>\d+)
    }x
  end

151 152 153 154 155 156 157 158 159
  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
160

161
  def validate_branches
162
    if target_project == source_project && target_branch == source_branch
163
      errors.add :branch_conflict, "You can not use same project/branch for source and target"
164
    end
165

166
    if opened? || reopened?
Izaak Alpert's avatar
Izaak Alpert committed
167
      similar_mrs = self.target_project.merge_requests.where(source_branch: source_branch, target_branch: target_branch, source_project_id: source_project.id).opened
168 169
      similar_mrs = similar_mrs.where('id not in (?)', self.id) if self.id
      if similar_mrs.any?
170 171 172 173
        errors.add :validate_branches,
                   "Cannot Create: This merge request already exists: #{
                   similar_mrs.pluck(:title)
                   }"
174
      end
175
    end
176 177
  end

178
  def validate_fork
179 180 181
    return true unless target_project && source_project

    if target_project == source_project
182 183 184 185 186 187 188
      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
189 190
        errors.add :validate_fork,
                   'Source project is not a fork of target project'
191 192 193 194
      end
    end
  end

195 196 197 198 199 200
  def update_merge_request_diff
    if source_branch_changed? || target_branch_changed?
      reload_code
    end
  end

201
  def reload_code
202
    if merge_request_diff && open?
203 204
      merge_request_diff.reload_content
    end
205 206
  end

207
  def check_if_can_be_merged
208 209 210 211
    can_be_merged =
      project.repository.can_be_merged?(source_sha, target_branch)

    if can_be_merged
212 213 214 215
      mark_as_mergeable
    else
      mark_as_unmergeable
    end
216 217
  end

218
  def merge_event
219
    self.target_project.events.where(target_id: self.id, target_type: "MergeRequest", action: Event::MERGED).last
220 221
  end

222
  def closed_event
223
    self.target_project.events.where(target_id: self.id, target_type: "MergeRequest", action: Event::CLOSED).last
224 225
  end

226 227 228 229
  def open?
    opened? || reopened?
  end

230 231 232 233
  def work_in_progress?
    title =~ /\A\[?WIP\]?:? /i
  end

234
  def mergeable?
235 236 237
    open? && !work_in_progress? && can_be_merged?
  end

238
  def gitlab_merge_status
239 240 241 242 243 244 245
    if work_in_progress?
      "work_in_progress"
    else
      merge_status_name
    end
  end

246
  def mr_and_commit_notes
247 248 249 250
    # Fetch comments only from last 100 commits
    commits_for_notes_limit = 100
    commit_ids = commits.last(commits_for_notes_limit).map(&:id)

251 252 253
    Note.where(
      "(project_id = :target_project_id AND noteable_type = 'MergeRequest' AND noteable_id = :mr_id) OR" +
      "(project_id = :source_project_id AND noteable_type = 'Commit' AND commit_id IN (:commit_ids))",
254
      mr_id: id,
255 256 257
      commit_ids: commit_ids,
      target_project_id: target_project_id,
      source_project_id: source_project_id
258
    )
259
  end
260

261 262 263
  # Returns the raw diff for this merge request
  #
  # see "git diff"
264
  def to_diff(current_user)
265
    target_project.repository.diff_text(target_branch, source_sha)
266 267 268 269 270
  end

  # Returns the commit as a series of email patches.
  #
  # see "git format-patch"
271
  def to_patch(current_user)
272
    target_project.repository.format_patch(target_branch, source_sha)
273
  end
274

Kirill Zaitsev's avatar
Kirill Zaitsev committed
275 276 277 278 279 280 281 282
  def hook_attrs
    attrs = {
      source: source_project.hook_attrs,
      target: target_project.hook_attrs,
      last_commit: nil
    }

    unless last_commit.nil?
283
      attrs.merge!(last_commit: last_commit.hook_attrs)
Kirill Zaitsev's avatar
Kirill Zaitsev committed
284 285 286 287 288
    end

    attributes.merge!(attrs)
  end

289 290 291 292
  def for_fork?
    target_project != source_project
  end

293 294 295 296
  def project
    target_project
  end

297
  # Return the set of issues that will be closed if this merge request is accepted.
298
  def closes_issues(current_user = self.author)
299
    if target_branch == project.default_branch
300
      issues = commits.flat_map { |c| c.closes_issues(current_user) }
301 302
      issues.push(*Gitlab::ClosingIssueExtractor.new(project, current_user).
                  closed_by_message(description))
303
      issues.uniq.sort_by(&:id)
304 305 306 307 308
    else
      []
    end
  end

309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324
  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

325 326 327 328 329 330 331 332
  def source_project_namespace
    if source_project && source_project.namespace
      source_project.namespace.path
    else
      "(removed)"
    end
  end

333 334 335 336 337 338 339 340
  def target_project_namespace
    if target_project && target_project.namespace
      target_project.namespace.path
    else
      "(removed)"
    end
  end

341 342 343 344 345 346 347 348 349 350 351 352
  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
353 354 355 356 357 358 359 360 361
  # 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
362
    Event.reset_event_cache_for(self)
Drew Blessing's avatar
Drew Blessing committed
363 364
  end

365 366 367
  def merge_commit_message
    message = "Merge branch '#{source_branch}' into '#{target_branch}'"
    message << "\n\n"
368
    message << title.to_s
369
    message << "\n\n"
370
    message << description.to_s
371 372
    message << "\n\n"
    message << "See merge request !#{iid}"
373
    message
374
  end
375 376

  # Return array of possible target branches
Steven Burgart's avatar
Steven Burgart committed
377
  # depends on target project of MR
378 379 380 381 382 383 384 385 386
  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
387
  # depends on source project of MR
388 389 390 391 392 393 394
  def source_branches
    if source_project.nil?
      []
    else
      source_project.repository.branch_names
    end
  end
395 396

  def locked_long_ago?
Ben Bodenmiller's avatar
Ben Bodenmiller committed
397 398 399
    return false unless locked?

    locked_at.nil? || locked_at < (Time.now - 1.day)
400
  end
401 402 403 404 405

  def approvals_left
    approvals_required - approvals.count
  end

406 407 408 409 410
  def approvers_left
    user_ids = overall_approvers.map(&:user_id) - approvals.map(&:user_id)
    User.where id: user_ids
  end

411 412 413 414 415
  def approvals_required
    target_project.approvals_before_merge
  end

  def requires_approve?
416 417 418 419 420 421 422 423 424
    approvals_required.nonzero?
  end

  def overall_approvers
    if approvers.any?
      approvers
    else
      target_project.approvers
    end
425 426 427
  end

  def approved?
428
    approvals_left.zero?
429 430 431 432 433
  end

  def approved_by?(user)
    approved_by_users.include?(user)
  end
434

435 436
  def approved_by_users
    approvals.map(&:user)
437
  end
438

439 440 441 442 443 444 445 446 447
  def can_approve?(user)
    approvers_left.include?(user) ||
    (any_approver_allowed? && !approved_by?(user))
  end

  def any_approver_allowed?
    approvals_left > approvers_left.count
  end

448 449 450 451 452 453 454
  def has_ci?
    source_project.ci_service && commits.any?
  end

  def branch_missing?
    !source_branch_exists? || !target_branch_exists?
  end
455 456 457 458

  def can_be_merged_by?(user)
    ::Gitlab::GitAccess.new(user, project).can_push_to_branch?(target_branch)
  end
459 460 461 462 463 464 465 466 467 468

  def state_human_name
    if merged?
      "Merged"
    elsif closed?
      "Closed"
    else
      "Open"
    end
  end
469 470 471

  def approver_ids=(value)
    value.split(",").map(&:strip).each do |user_id|
Valery Sizov's avatar
Valery Sizov committed
472
      approvers.find_or_initialize_by(user_id: user_id, target_id: id)
473 474
    end
  end
475

476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500
  def target_sha
    @target_sha ||= target_project.
      repository.commit(target_branch).sha
  end

  def source_sha
    commits.first.sha
  end

  def fetch_ref
    target_project.repository.fetch_ref(
      source_project.repository.path_to_repo,
      "refs/heads/#{source_branch}",
      "refs/merge-requests/#{iid}/head"
    )
  end

  def in_locked_state
    begin
      lock_mr
      yield
    ensure
      unlock_mr if locked?
    end
  end
501 502 503 504 505 506 507 508

  def source_sha_parent
    source_project.repository.commit(source_sha).parents.first.sha
  end

  def ff_merge_possible?
    target_sha == source_sha_parent
  end
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
509
end