Merge branch '25381-add-a-custom-commit-message-when-applying-a-suggested-change' into 'master'

Add a message parameter for the suggestion endpoints

See merge request gitlab-org/gitlab!51245

app/services/suggestions/apply_service.rb

@@ -2,8 +2,9 @@
 
 module Suggestions
   class ApplyService < ::BaseService
-    def initialize(current_user, *suggestions)
+    def initialize(current_user, *suggestions, message: nil)
       @current_user = current_user
+      @message = message
       @suggestion_set = Gitlab::Suggestions::SuggestionSet.new(suggestions)
     end
 
@@ -47,7 +48,7 @@ module Suggestions
     end
 
     def commit_message
-      Gitlab::Suggestions::CommitMessage.new(current_user, suggestion_set).message
+      Gitlab::Suggestions::CommitMessage.new(current_user, suggestion_set, @message).message
     end
   end
 end

changelogs/unreleased/25381-add-a-custom-commit-message-when-applying-a-suggested-change.yml

+---
+title: Add a commit message parameter for the suggestion endpoints
+merge_request: 51245
+author:
+type: added

doc/api/suggestions.md

@@ -21,6 +21,7 @@ PUT /suggestions/:id/apply
 | Attribute | Type | Required | Description |
 | --------- | ---- | -------- | ----------- |
 | `id` | integer/string | yes | The ID of a suggestion |
+| `commit_message` | string | no | A custom commit message to use instead of the default generated message or the project's default message |
 
 ```shell
 curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/suggestions/5/apply"

lib/api/suggestions.rb

@@ -12,12 +12,13 @@ module API
       end
       params do
         requires :id, type: String, desc: 'The suggestion ID'
+        optional :commit_message, type: String, desc: "A custom commit message to use instead of the default generated message or the project's default message"
       end
       put ':id/apply' do
         suggestion = Suggestion.find_by_id(params[:id])
 
         if suggestion
-          apply_suggestions(suggestion, current_user)
+          apply_suggestions(suggestion, current_user, params[:commit_message])
         else
           render_api_error!(_('Suggestion is not applicable as the suggestion was not found.'), :not_found)
         end
@@ -28,6 +29,7 @@ module API
       end
       params do
         requires :ids, type: Array[Integer], coerce_with: ::API::Validations::Types::CommaSeparatedToIntegerArray.coerce, desc: "An array of suggestion ID's"
+        optional :commit_message, type: String, desc: "A custom commit message to use instead of the default generated message or the project's default message"
       end
       put 'batch_apply' do
         ids = params[:ids]
@@ -35,7 +37,7 @@ module API
         suggestions = Suggestion.id_in(ids)
 
         if suggestions.size == ids.length
-          apply_suggestions(suggestions, current_user)
+          apply_suggestions(suggestions, current_user, params[:commit_message])
         else
           render_api_error!(_('Suggestions are not applicable as one or more suggestions were not found.'), :not_found)
         end
@@ -43,10 +45,10 @@ module API
     end
 
     helpers do
-      def apply_suggestions(suggestions, current_user)
+      def apply_suggestions(suggestions, current_user, message)
         authorize_suggestions(*suggestions)
 
-        result = ::Suggestions::ApplyService.new(current_user, *suggestions).execute
+        result = ::Suggestions::ApplyService.new(current_user, *suggestions, message: message).execute
 
         if result[:status] == :success
           present suggestions, with: Entities::Suggestion, current_user: current_user

lib/gitlab/suggestions/commit_message.rb

@@ -6,14 +6,15 @@ module Gitlab
       DEFAULT_SUGGESTION_COMMIT_MESSAGE =
         'Apply %{suggestions_count} suggestion(s) to %{files_count} file(s)'
 
-      def initialize(user, suggestion_set)
+      def initialize(user, suggestion_set, custom_message = nil)
         @user = user
         @suggestion_set = suggestion_set
+        @custom_message = custom_message
       end
 
       def message
         project = suggestion_set.project
-        user_defined_message = project.suggestion_commit_message.presence
+        user_defined_message = @custom_message.presence || project.suggestion_commit_message.presence
         message = user_defined_message || DEFAULT_SUGGESTION_COMMIT_MESSAGE
 
         Gitlab::StringPlaceholderReplacer

spec/lib/gitlab/suggestions/commit_message_spec.rb

@@ -72,6 +72,17 @@ RSpec.describe Gitlab::Suggestions::CommitMessage do
       end
     end
 
+    context 'when a custom commit message is specified' do
+      let(:message) { "i'm a project message. a user's custom message takes precedence over me :(" }
+      let(:custom_message) { "hello there! i'm a cool custom commit message." }
+
+      it 'shows the custom commit message' do
+        expect(Gitlab::Suggestions::CommitMessage
+                 .new(user, suggestion_set, custom_message)
+                 .message).to eq(custom_message)
+      end
+    end
+
     context 'is specified and includes all placeholders' do
       let(:message) do
         '*** %{branch_name} %{files_count} %{file_paths} %{project_name} %{project_path} %{user_full_name} %{username} %{suggestions_count} ***'

spec/requests/api/suggestions_spec.rb

@@ -65,6 +65,19 @@ RSpec.describe API::Suggestions do
       end
     end
 
+    context 'when a custom commit message is included' do
+      it 'renders an ok response and returns json content' do
+        project.add_maintainer(user)
+
+        message = "cool custom commit message!"
+
+        put api(url, user), params: { commit_message: message }
+
+        expect(response).to have_gitlab_http_status(:ok)
+        expect(project.repository.commit.message).to eq(message)
+      end
+    end
+
     context 'when not able to apply patch' do
       let(:url) { "/suggestions/#{unappliable_suggestion.id}/apply" }
 
@@ -113,9 +126,11 @@ RSpec.describe API::Suggestions do
     let(:url) { "/suggestions/batch_apply" }
 
     context 'when successfully applies multiple patches as a batch' do
-      it 'renders an ok response and returns json content' do
+      before do
         project.add_maintainer(user)
+      end
 
+      it 'renders an ok response and returns json content' do
         put api(url, user), params: { ids: [suggestion.id, suggestion2.id] }
 
         expect(response).to have_gitlab_http_status(:ok)
@@ -123,6 +138,16 @@ RSpec.describe API::Suggestions do
                                              'appliable', 'applied',
                                              'from_content', 'to_content'))
       end
+
+      it 'provides a custom commit message' do
+        message = "cool custom commit message!"
+
+        put api(url, user), params: { ids: [suggestion.id, suggestion2.id],
+                                      commit_message: message }
+
+        expect(response).to have_gitlab_http_status(:ok)
+        expect(project.repository.commit.message).to eq(message)
+      end
     end
 
     context 'when not able to apply one or more of the patches' do

spec/services/suggestions/apply_service_spec.rb

@@ -32,8 +32,8 @@ RSpec.describe Suggestions::ApplyService do
     create(:suggestion, :content_from_repo, suggestion_args)
   end
 
-  def apply(suggestions)
-    result = apply_service.new(user, *suggestions).execute
+  def apply(suggestions, custom_message = nil)
+    result = apply_service.new(user, *suggestions, message: custom_message).execute
 
     suggestions.map { |suggestion| suggestion.reload }
 
@@ -111,6 +111,16 @@ RSpec.describe Suggestions::ApplyService do
         end
       end
     end
+
+    context 'with a user suggested commit message' do
+      let(:message) { "i'm a custom commit message!" }
+
+      it "uses the user's commit message" do
+        apply(suggestions, message)
+
+        expect(project.repository.commit.message).to(eq(message))
+      end
+    end
   end
 
   subject(:apply_service) { described_class }