build_service.rb 8.45 KB
Newer Older
1 2
# frozen_string_literal: true

3 4
module MergeRequests
  class BuildService < MergeRequests::BaseService
5 6
    include Gitlab::Utils::StrongMemoize

7
    def execute
8
      @params_issue_iid = params.delete(:issue_iid)
9
      self.merge_request = MergeRequest.new
10
      # TODO: this should handle all quick actions that don't have side effects
11
      # https://gitlab.com/gitlab-org/gitlab-foss/issues/53658
12
      merge_quick_actions_into_params!(merge_request, only: [:target_branch])
13

14
      # Assign the projects first so we can use policies for `filter_params`
15
      merge_request.author = current_user
16 17 18
      merge_request.source_project = find_source_project
      merge_request.target_project = find_target_project

19 20 21 22 23 24 25 26
      # Source project sets the default source branch removal setting
      merge_request.merge_params['force_remove_source_branch'] =
        if params.key?(:force_remove_source_branch)
          params.delete(:force_remove_source_branch)
        else
          merge_request.source_project.remove_source_branch_after_merge?
        end

27 28
      self.params = assign_allowed_merge_params(merge_request, params)

29
      filter_params(merge_request)
30 31 32 33 34 35 36 37 38 39 40 41

      # merge_request.assign_attributes(...) below is a Rails
      # method that only work if all the params it is passed have
      # corresponding fields in the database. As there are no fields
      # in the database for :add_label_ids and :remove_label_ids, we
      # need to remove them from the params before the call to
      # merge_request.assign_attributes(...)
      #
      # IssuableBaseService#process_label_ids takes care
      # of the removal.
      params[:label_ids] = process_label_ids(params, extra_label_ids: merge_request.label_ids.to_a)

42 43
      merge_request.assign_attributes(params.to_h.compact)

44
      merge_request.compare_commits = []
45 46
      set_merge_request_target_branch

47
      merge_request.can_be_created = projects_and_branches_valid?
48

49 50 51 52 53
      # compare branches only if branches are valid, otherwise
      # compare_branches may raise an error
      if merge_request.can_be_created
        compare_branches
        assign_title_and_description
54 55
        assign_labels
        assign_milestone
56
      end
57 58 59

      merge_request
    end
60

61
    private
62

63
    attr_accessor :merge_request
64

65 66 67 68 69 70 71 72 73 74 75
    delegate :target_branch,
             :target_branch_ref,
             :target_project,
             :source_branch,
             :source_branch_ref,
             :source_project,
             :compare_commits,
             :wip_title,
             :description,
             :errors,
             to: :merge_request
76 77

    def find_source_project
78
      source_project = project_from_params(:source_project)
79
      return source_project if source_project.present? && can?(current_user, :create_merge_request_from, source_project)
80 81

      project
82
    end
Artem Sidorenko's avatar
Artem Sidorenko committed
83

84
    def find_target_project
85
      target_project = project_from_params(:target_project)
86
      return target_project if target_project.present? && can?(current_user, :create_merge_request_in, target_project)
87

88 89 90 91 92
      target_project = project.default_merge_request_target

      return target_project if target_project.present? && can?(current_user, :create_merge_request_in, target_project)

      project
93 94
    end

95 96 97 98 99 100 101 102 103 104 105
    def project_from_params(param_name)
      project_from_params = params.delete(param_name)

      id_param_name = :"#{param_name}_id"
      if project_from_params.nil? && params[id_param_name]
        project_from_params = Project.find_by_id(params.delete(id_param_name))
      end

      project_from_params
    end

106 107 108 109 110 111
    def set_merge_request_target_branch
      if source_branch_default? && !target_branch_specified?
        merge_request.target_branch = nil
      else
        merge_request.target_branch ||= target_project.default_branch
      end
112 113
    end

114 115 116 117 118 119
    def source_branch_specified?
      params[:source_branch].present?
    end

    def target_branch_specified?
      params[:target_branch].present?
120 121
    end

122 123
    def projects_and_branches_valid?
      return false if source_project.nil? || target_project.nil?
124 125
      return false unless source_branch_specified? || target_branch_specified?

126
      validate_projects_and_branches
127 128 129 130
      errors.blank?
    end

    def compare_branches
131
      compare = CompareService.new(
132
        source_project,
133
        source_branch_ref
134
      ).execute(
135
        target_project,
136
        target_branch_ref
137 138
      )

139 140 141 142
      if compare
        merge_request.compare_commits = compare.commits
        merge_request.compare = compare
      end
143 144
    end

145 146 147 148 149 150
    def validate_projects_and_branches
      merge_request.validate_target_project
      merge_request.validate_fork

      return if errors.any?

151 152 153 154 155
      add_error('You must select source and target branch') unless branches_present?
      add_error('You must select different branches') if same_source_and_target?
      add_error("Source branch \"#{source_branch}\" does not exist") unless source_branch_exists?
      add_error("Target branch \"#{target_branch}\" does not exist") unless target_branch_exists?
    end
156

157 158 159
    def add_error(message)
      errors.add(:base, message)
    end
160

161 162 163
    def branches_present?
      target_branch.present? && source_branch.present?
    end
164

165
    def same_source_and_target?
166 167 168 169 170 171 172 173 174
      same_source_and_target_project? && target_branch == source_branch
    end

    def source_branch_default?
      same_source_and_target_project? && source_branch == target_project.default_branch
    end

    def same_source_and_target_project?
      source_project == target_project
175
    end
176

177 178 179
    def source_branch_exists?
      source_branch.blank? || source_project.commit(source_branch)
    end
180

181 182
    def target_branch_exists?
      target_branch.blank? || target_project.commit(target_branch)
183 184
    end

185 186 187 188 189 190 191 192 193 194 195 196
    # When your branch name starts with an iid followed by a dash this pattern will be
    # interpreted as the user wants to close that issue on this project.
    #
    # For example:
    # - Issue 112 exists, title: Emoji don't show up in commit title
    # - Source branch is: 112-fix-mep-mep
    #
    # Will lead to:
    # - Appending `Closes #112` to the description
    # - Setting the title as 'Resolves "Emoji don't show up in commit title"' if there is
    #   more than one commit in the MR
    #
197
    def assign_title_and_description
198
      assign_title_and_description_from_single_commit
199
      merge_request.title ||= title_from_issue if target_project.issues_enabled? || target_project.external_issue_tracker
200 201 202 203 204 205
      merge_request.title ||= source_branch.titleize.humanize
      merge_request.title = wip_title if compare_commits.empty?

      append_closes_description
    end

206 207 208 209 210 211 212 213 214 215 216 217 218 219
    def assign_labels
      return unless target_project.issues_enabled? && issue
      return if merge_request.label_ids&.any?

      merge_request.label_ids = issue.try(:label_ids)
    end

    def assign_milestone
      return unless target_project.issues_enabled? && issue
      return if merge_request.milestone_id.present?

      merge_request.milestone_id = issue.try(:milestone_id)
    end

220
    def append_closes_description
221
      return unless issue&.to_reference.present?
222

223
      closes_issue = "Closes #{issue.to_reference}"
224 225

      if description.present?
226 227
        descr_parts = [merge_request.description, closes_issue]
        merge_request.description = descr_parts.join("\n\n")
228
      else
229
        merge_request.description = closes_issue
230
      end
231
    end
232

233 234 235 236 237 238 239 240 241 242
    def assign_title_and_description_from_single_commit
      commits = compare_commits

      return unless commits&.count == 1

      commit = commits.first
      merge_request.title ||= commit.title
      merge_request.description ||= commit.description.try(:strip)
    end

243
    def title_from_issue
244 245
      return unless issue

246
      return "Resolve \"#{issue.title}\"" if issue.is_a?(Issue)
Zeger-Jan van de Weg's avatar
Zeger-Jan van de Weg committed
247

248
      return if issue_iid.blank?
249

250 251
      title_parts = ["Resolve #{issue.to_reference}"]
      branch_title = source_branch.downcase.remove(issue_iid.downcase).titleize.humanize
252

253
      title_parts << "\"#{branch_title}\"" if branch_title.present?
254
      title_parts.join(' ')
255 256 257
    end

    def issue_iid
258 259 260 261 262 263 264 265 266
      strong_memoize(:issue_iid) do
        @params_issue_iid || begin
          id = if target_project.external_issue_tracker
                 source_branch.match(target_project.external_issue_reference_pattern).try(:[], 0)
               end

          id || source_branch.match(/\A(\d+)-/).try(:[], 1)
        end
      end
267
    end
Zeger-Jan van de Weg's avatar
Zeger-Jan van de Weg committed
268

269
    def issue
270 271 272
      strong_memoize(:issue) do
        target_project.get_issue(issue_iid, current_user)
      end
273 274 275
    end
  end
end
276 277

MergeRequests::BuildService.prepend_if_ee('EE::MergeRequests::BuildService')