2014-09-02 18:07:02 +05:30
# == Schema Information
#
# Table name: merge_requests
#
2015-12-23 02:04:40 +05:30
# 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)
# created_at :datetime
# updated_at :datetime
# milestone_id :integer
# state :string(255)
# merge_status :string(255)
# target_project_id :integer not null
# iid :integer
# description :text
# position :integer default(0)
# locked_at :datetime
# updated_by_id :integer
# merge_error :string(255)
# merge_params :text (serialized to hash)
# merge_when_build_succeeds :boolean default(false), not null
# merge_user_id :integer
2014-09-02 18:07:02 +05:30
#
require Rails . root . join ( " app/models/commit " )
require Rails . root . join ( " lib/static_model " )
class MergeRequest < ActiveRecord :: Base
include InternalId
2015-09-11 14:41:01 +05:30
include Issuable
include Referable
2015-04-26 12:48:37 +05:30
include Sortable
2015-09-11 14:41:01 +05:30
include Taskable
2014-09-02 18:07:02 +05:30
belongs_to :target_project , foreign_key : :target_project_id , class_name : " Project "
belongs_to :source_project , foreign_key : :source_project_id , class_name : " Project "
2015-12-23 02:04:40 +05:30
belongs_to :merge_user , class_name : " User "
2014-09-02 18:07:02 +05:30
has_one :merge_request_diff , dependent : :destroy
2015-12-23 02:04:40 +05:30
serialize :merge_params , Hash
2014-09-02 18:07:02 +05:30
after_create :create_merge_request_diff
after_update :update_merge_request_diff
2015-11-26 14:37:03 +05:30
delegate :commits , :diffs , :diffs_no_whitespace , to : :merge_request_diff , prefix : nil
2014-09-02 18:07:02 +05:30
# When this attribute is true some MR validation is ignored
# It allows us to close or modify broken merge requests
attr_accessor :allow_broken
# Temporary fields to store compare vars
# when creating new merge request
attr_accessor :can_be_created , :compare_failed ,
:compare_commits , :compare_diffs
state_machine :state , initial : :opened do
event :close do
transition [ :reopened , :opened ] = > :closed
end
2015-09-25 12:07:36 +05:30
event :mark_as_merged do
2014-09-02 18:07:02 +05:30
transition [ :reopened , :opened , :locked ] = > :merged
end
event :reopen do
transition closed : :reopened
end
event :lock_mr do
transition [ :reopened , :opened ] = > :locked
end
event :unlock_mr do
transition locked : :reopened
end
2015-04-26 12:48:37 +05:30
after_transition any = > :locked do | merge_request , transition |
merge_request . locked_at = Time . now
merge_request . save
end
after_transition locked : ( any - :locked ) do | merge_request , transition |
merge_request . locked_at = nil
merge_request . save
end
2014-09-02 18:07:02 +05:30
state :opened
state :reopened
state :closed
state :merged
state :locked
end
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
2015-04-26 12:48:37 +05:30
transition [ :unchecked , :cannot_be_merged ] = > :can_be_merged
2014-09-02 18:07:02 +05:30
end
event :mark_as_unmergeable do
2015-04-26 12:48:37 +05:30
transition [ :unchecked , :can_be_merged ] = > :cannot_be_merged
2014-09-02 18:07:02 +05:30
end
state :unchecked
state :can_be_merged
state :cannot_be_merged
2015-04-26 12:48:37 +05:30
around_transition do | merge_request , transition , block |
merge_request . record_timestamps = false
begin
block . call
ensure
merge_request . record_timestamps = true
end
end
2014-09-02 18:07:02 +05:30
end
validates :source_project , presence : true , unless : :allow_broken
validates :source_branch , presence : true
validates :target_project , presence : true
validates :target_branch , presence : true
2015-12-23 02:04:40 +05:30
validates :merge_user , presence : true , if : :merge_when_build_succeeds?
2014-09-02 18:07:02 +05:30
validate :validate_branches
validate :validate_fork
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 ) }
scope :by_branch , - > ( branch_name ) { where ( " (source_branch LIKE :branch) OR (target_branch LIKE :branch) " , branch : branch_name ) }
scope :cared , - > ( user ) { where ( 'assignee_id = :user OR author_id = :user' , user : user . id ) }
scope :by_milestone , - > ( milestone ) { where ( milestone_id : milestone ) }
scope :in_projects , - > ( project_ids ) { where ( " source_project_id in (:project_ids) OR target_project_id in (:project_ids) " , project_ids : project_ids ) }
scope :of_projects , - > ( ids ) { where ( target_project_id : ids ) }
2015-09-11 14:41:01 +05:30
scope :merged , - > { with_state ( :merged ) }
scope :closed , - > { with_state ( :closed ) }
scope :closed_and_merged , - > { with_states ( :closed , :merged ) }
2015-12-23 02:04:40 +05:30
scope :join_project , - > { joins ( :target_project ) }
scope :references_project , - > { references ( :target_project ) }
2015-09-11 14:41:01 +05:30
def self . reference_prefix
'!'
end
# Pattern used to extract `!123` merge request references from text
#
# This pattern supports cross-project references.
def self . reference_pattern
%r{
( #{Project.reference_pattern})?
#{Regexp.escape(reference_prefix)}(?<merge_request>\d+)
} x
end
2015-12-23 02:04:40 +05:30
def self . link_reference_pattern
super ( " merge_requests " , / (?<merge_request> \ d+) / )
end
2015-09-11 14:41:01 +05:30
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
2014-09-02 18:07:02 +05:30
2015-10-24 18:46:33 +05:30
def last_commit
merge_request_diff ? merge_request_diff . last_commit : compare_commits . last
2015-11-26 14:37:03 +05:30
end
2015-10-24 18:46:33 +05:30
def first_commit
merge_request_diff ? merge_request_diff . first_commit : compare_commits . first
2015-11-26 14:37:03 +05:30
end
2015-10-24 18:46:33 +05:30
def last_commit_short_sha
last_commit . short_id
end
2014-09-02 18:07:02 +05:30
def validate_branches
if target_project == source_project && target_branch == source_branch
errors . add :branch_conflict , " You can not use same project/branch for source and target "
end
if opened? || reopened?
similar_mrs = self . target_project . merge_requests . where ( source_branch : source_branch , target_branch : target_branch , source_project_id : source_project . id ) . opened
similar_mrs = similar_mrs . where ( 'id not in (?)' , self . id ) if self . id
if similar_mrs . any?
2015-04-26 12:48:37 +05:30
errors . add :validate_branches ,
2015-12-23 02:04:40 +05:30
" Cannot Create: This merge request already exists: #{ similar_mrs . pluck ( :title ) } "
2014-09-02 18:07:02 +05:30
end
end
end
def validate_fork
return true unless target_project && source_project
if target_project == source_project
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
2015-04-26 12:48:37 +05:30
errors . add :validate_fork ,
'Source project is not a fork of target project'
2014-09-02 18:07:02 +05:30
end
end
end
def update_merge_request_diff
if source_branch_changed? || target_branch_changed?
reload_code
end
end
def reload_code
if merge_request_diff && open ?
merge_request_diff . reload_content
end
end
def check_if_can_be_merged
2015-09-25 12:07:36 +05:30
can_be_merged =
project . repository . can_be_merged? ( source_sha , target_branch )
if can_be_merged
2014-09-02 18:07:02 +05:30
mark_as_mergeable
else
mark_as_unmergeable
end
end
def merge_event
self . target_project . events . where ( target_id : self . id , target_type : " MergeRequest " , action : Event :: MERGED ) . last
end
def closed_event
self . target_project . events . where ( target_id : self . id , target_type : " MergeRequest " , action : Event :: CLOSED ) . last
end
2015-09-11 14:41:01 +05:30
def work_in_progress?
2015-10-24 18:46:33 +05:30
! ! ( title =~ / \ A \ [?WIP \ ]?:? /i )
2015-09-11 14:41:01 +05:30
end
2015-09-25 12:07:36 +05:30
def mergeable?
2015-09-11 14:41:01 +05:30
open ? && ! work_in_progress? && can_be_merged?
end
2015-09-25 12:07:36 +05:30
def gitlab_merge_status
2015-09-11 14:41:01 +05:30
if work_in_progress?
" work_in_progress "
else
merge_status_name
end
end
2015-12-23 02:04:40 +05:30
def can_cancel_merge_when_build_succeeds? ( current_user )
can_be_merged_by? ( current_user ) || self . author == current_user
end
def can_remove_source_branch? ( current_user )
! source_project . protected_branch? ( source_branch ) &&
! source_project . root_ref? ( source_branch ) &&
Ability . abilities . allowed? ( current_user , :push_code , source_project )
end
2014-09-02 18:07:02 +05:30
def mr_and_commit_notes
# Fetch comments only from last 100 commits
commits_for_notes_limit = 100
commit_ids = commits . last ( commits_for_notes_limit ) . map ( & :id )
2015-09-11 14:41:01 +05:30
Note . where (
" (project_id = :target_project_id AND noteable_type = 'MergeRequest' AND noteable_id = :mr_id) OR " +
2015-11-26 14:37:03 +05:30
" ((project_id = :source_project_id OR project_id = :target_project_id) AND noteable_type = 'Commit' AND commit_id IN (:commit_ids)) " ,
2014-09-02 18:07:02 +05:30
mr_id : id ,
2015-09-11 14:41:01 +05:30
commit_ids : commit_ids ,
target_project_id : target_project_id ,
source_project_id : source_project_id
2014-09-02 18:07:02 +05:30
)
end
# Returns the raw diff for this merge request
#
# see "git diff"
def to_diff ( current_user )
2015-09-25 12:07:36 +05:30
target_project . repository . diff_text ( target_branch , source_sha )
2014-09-02 18:07:02 +05:30
end
# Returns the commit as a series of email patches.
#
# see "git format-patch"
def to_patch ( current_user )
2015-09-25 12:07:36 +05:30
target_project . repository . format_patch ( target_branch , source_sha )
2014-09-02 18:07:02 +05:30
end
2015-04-26 12:48:37 +05:30
def hook_attrs
attrs = {
source : source_project . hook_attrs ,
target : target_project . hook_attrs ,
2015-10-24 18:46:33 +05:30
last_commit : nil ,
work_in_progress : work_in_progress?
2015-04-26 12:48:37 +05:30
}
2015-12-23 02:04:40 +05:30
if last_commit
2015-09-11 14:41:01 +05:30
attrs . merge! ( last_commit : last_commit . hook_attrs )
2015-04-26 12:48:37 +05:30
end
attributes . merge! ( attrs )
end
2014-09-02 18:07:02 +05:30
def for_fork?
target_project != source_project
end
def project
target_project
end
2015-10-24 18:46:33 +05:30
def closes_issue? ( issue )
closes_issues . include? ( issue )
end
2014-09-02 18:07:02 +05:30
# Return the set of issues that will be closed if this merge request is accepted.
2015-04-26 12:48:37 +05:30
def closes_issues ( current_user = self . author )
2014-09-02 18:07:02 +05:30
if target_branch == project . default_branch
2015-09-11 14:41:01 +05:30
issues = commits . flat_map { | c | c . closes_issues ( current_user ) }
2015-04-26 12:48:37 +05:30
issues . push ( * Gitlab :: ClosingIssueExtractor . new ( project , current_user ) .
closed_by_message ( description ) )
2015-12-23 02:04:40 +05:30
issues . uniq ( & :id )
2014-09-02 18:07:02 +05:30
else
[ ]
end
end
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
def source_project_namespace
if source_project && source_project . namespace
source_project . namespace . path
else
" (removed) "
end
end
def target_project_namespace
if target_project && target_project . namespace
target_project . namespace . path
else
" (removed) "
end
end
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
# 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
Event . reset_event_cache_for ( self )
end
def merge_commit_message
message = " Merge branch ' #{ source_branch } ' into ' #{ target_branch } ' "
message << " \n \n "
message << title . to_s
message << " \n \n "
message << description . to_s
message << " \n \n "
message << " See merge request ! #{ iid } "
message
end
2015-12-23 02:04:40 +05:30
def reset_merge_when_build_succeeds
return unless merge_when_build_succeeds?
self . merge_when_build_succeeds = false
self . merge_user = nil
self . merge_params = nil
self . save
end
2014-09-02 18:07:02 +05:30
# Return array of possible target branches
2015-04-26 12:48:37 +05:30
# depends on target project of MR
2014-09-02 18:07:02 +05:30
def target_branches
if target_project . nil?
[ ]
else
target_project . repository . branch_names
end
end
# Return array of possible source branches
2015-04-26 12:48:37 +05:30
# depends on source project of MR
2014-09-02 18:07:02 +05:30
def source_branches
if source_project . nil?
[ ]
else
source_project . repository . branch_names
end
end
2015-04-26 12:48:37 +05:30
def locked_long_ago?
return false unless locked?
locked_at . nil? || locked_at < ( Time . now - 1 . day )
end
2015-09-11 14:41:01 +05:30
def has_ci?
source_project . ci_service && commits . any?
end
def branch_missing?
! source_branch_exists? || ! target_branch_exists?
end
def can_be_merged_by? ( user )
:: Gitlab :: GitAccess . new ( user , project ) . can_push_to_branch? ( target_branch )
end
def state_human_name
if merged?
" Merged "
elsif closed?
" Closed "
else
" Open "
end
end
2015-09-25 12:07:36 +05:30
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 } " ,
ref_path
)
end
def ref_path
" refs/merge-requests/ #{ iid } /head "
end
def ref_is_fetched?
File . exists? ( File . join ( project . repository . path_to_repo , ref_path ) )
end
def ensure_ref_fetched
fetch_ref unless ref_is_fetched?
end
def in_locked_state
begin
lock_mr
yield
ensure
unlock_mr if locked?
end
end
2015-11-26 14:37:03 +05:30
def ci_commit
2015-12-23 02:04:40 +05:30
@ci_commit || = source_project . ci_commit ( last_commit . id ) if last_commit && source_project
end
def broken?
self . commits . blank? || branch_missing? || cannot_be_merged?
2015-11-26 14:37:03 +05:30
end
2014-09-02 18:07:02 +05:30
end