Merge branch 'bvl-merge-base-multiple-revisions' into 'master'

Allow getting the merge base of multiple revisions

Closes #52573

See merge request gitlab-org/gitlab-ce!22295

app/models/repository.rb

@@ -881,10 +881,12 @@ class Repository
 
   delegate :merged_branch_names, to: :raw_repository
 
-  def merge_base(first_commit_id, second_commit_id)
-    first_commit_id = commit(first_commit_id).try(:id) || first_commit_id
-    second_commit_id = commit(second_commit_id).try(:id) || second_commit_id
-    raw_repository.merge_base(first_commit_id, second_commit_id)
+  def merge_base(*commits_or_ids)
+    commit_ids = commits_or_ids.map do |commit_or_id|
+      commit_or_id.is_a?(::Commit) ? commit_or_id.id : commit_or_id
+    end
+
+    raw_repository.merge_base(*commit_ids)
   end
 
   def ancestor?(ancestor_id, descendant_id)

changelogs/unreleased/bvl-merge-base-multiple-revisions.yml

+---
+title: Allow finding the common ancestor for multiple revisions through the API
+merge_request: 22295
+author:
+type: changed

doc/api/repositories.md

@@ -216,7 +216,7 @@ GET /projects/:id/repository/merge_base
 | Attribute | Type | Required | Description |
 | --------- | ---- | -------- | ----------- |
 | `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) |
-| `refs` | array | yes | The refs to find the common ancestor of, for now only 2 refs are supported |
+| `refs` | array | yes | The refs to find the common ancestor of, multiple refs can be passed |
 
 ```bash
 curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v4/projects/5/repository/merge_base?refs[]=304d257dcb821665ab5110318fc58a007bd104ed&refs[]=0031876facac3f2b2702a0e53a26e89939a42209"

lib/api/repositories.rb

@@ -130,18 +130,13 @@ module API
         success Entities::Commit
       end
       params do
-        # For now we just support 2 refs passed, but `merge-base` supports
-        # multiple defining this as an Array instead of 2 separate params will
-        # make sure we don't need to deprecate this API in favor of one
-        # supporting multiple commits when this functionality gets added to
-        # Gitaly
         requires :refs, type: Array[String]
       end
       get ':id/repository/merge_base' do
         refs = params[:refs]
 
-        unless refs.size == 2
-          render_api_error!('Provide exactly 2 refs', 400)
+        if refs.size < 2
+          render_api_error!('Provide at least 2 refs', 400)
         end
 
         merge_base = Gitlab::Git::MergeBase.new(user_project.repository, refs)

lib/gitlab/git/repository.rb

@@ -382,9 +382,9 @@ module Gitlab
       end
 
       # Returns the SHA of the most recent common ancestor of +from+ and +to+
-      def merge_base(from, to)
+      def merge_base(*commits)
         wrapped_gitaly_errors do
-          gitaly_repository_client.find_merge_base(from, to)
+          gitaly_repository_client.find_merge_base(*commits)
         end
       end
 

spec/models/repository_spec.rb

@@ -2386,4 +2386,15 @@ describe Repository do
       end
     end
   end
+
+  describe '#merge_base' do
+    set(:project) { create(:project, :repository) }
+    subject(:repository) { project.repository }
+
+    it 'only makes one gitaly call' do
+      expect(Gitlab::GitalyClient).to receive(:call).once.and_call_original
+
+      repository.merge_base('master', 'fix')
+    end
+  end
 end

spec/requests/api/repositories_spec.rb

@@ -468,7 +468,7 @@ describe API::Repositories do
 
   describe 'GET :id/repository/merge_base' do
     let(:refs) do
-      %w(304d257dcb821665ab5110318fc58a007bd104ed 0031876facac3f2b2702a0e53a26e89939a42209)
+      %w(304d257dcb821665ab5110318fc58a007bd104ed 0031876facac3f2b2702a0e53a26e89939a42209 570e7b2abdd848b95f2f578043fc23bd6f6fd24d)
     end
 
     subject(:request) do
@@ -534,7 +534,7 @@ describe API::Repositories do
         request
 
         expect(response).to have_gitlab_http_status(:bad_request)
-        expect(json_response['message']).to eq('Provide exactly 2 refs')
+        expect(json_response['message']).to eq('Provide at least 2 refs')
       end
     end
   end