Merge branch 'pass-commit-id-to-MR-discussion' into 'master'

Merge Request Discussions API: accept commit_id to create discussion on commit

See merge request gitlab-org/gitlab!47130

changelogs/unreleased/pass-commit-id-to-MR-discussion.yml

+---
+title: Allow passing `commit_id` when creating MR discussions via the API and expose `commit_id` for MR diff notes
+merge_request: 47130
+author: Johannes Altmanninger @krobelus
+type: added

doc/api/discussions.md

@@ -773,6 +773,7 @@ Diff comments also contain position:
         "noteable_id": 3,
         "noteable_type": "Merge request",
         "noteable_iid": null,
+        "commit_id": "4803c71e6b1833ca72b8b26ef2ecd5adc8a38031",
         "position": {
           "base_sha": "b5d6e7b1613fca24d250fa8e5bc7bcc3dd6002ef",
           "start_sha": "7c9c2ead8a320fb7ba0b4e234bd9529a2614e306",
@@ -828,6 +829,8 @@ curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/a
 
 ### Create new merge request thread
 
+> The `commit id` entry was [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/47130) in GitLab 13.7.
+
 Creates a new thread to a single project merge request. This is similar to creating
 a note but other comments (replies) can be added to it later.
 
@@ -842,6 +845,7 @@ Parameters:
 | `id`                                     | integer/string | yes      | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) |
 | `merge_request_iid`                      | integer        | yes      | The IID of a merge request |
 | `body`                                   | string         | yes      | The content of the thread |
+| `commit_id`                              | string         | no       | SHA referencing commit to start this thread on |
 | `created_at`                             | string         | no       | Date time string, ISO 8601 formatted, e.g. 2016-03-11T03:45:40Z (requires admin or project/group owner rights) |
 | `position`                               | hash           | no       | Position when creating a diff note |
 | `position[base_sha]`                     | string         | yes      | Base commit SHA in the source branch |

lib/api/discussions.rb

@@ -104,6 +104,7 @@ module API
             position: params[:position],
             id_key => noteable.id
           }
+          opts[:commit_id] = params[:commit_id] if noteable.is_a?(MergeRequest) && type == 'DiffNote'
 
           note = create_note(noteable, opts)
 

lib/api/entities/note.rb

@@ -14,6 +14,7 @@ module API
       expose :created_at, :updated_at
       expose :system?, as: :system
       expose :noteable_id, :noteable_type
+      expose :commit_id, if: ->(note, options) { note.noteable_type == "MergeRequest" && note.is_a?(DiffNote) }
 
       expose :position, if: ->(note, options) { note.is_a?(DiffNote) } do |note|
         note.position.to_h

spec/requests/api/discussions_spec.rb

@@ -61,6 +61,37 @@ RSpec.describe API::Discussions do
         expect(response).to have_gitlab_http_status(:bad_request)
       end
     end
+
+    context "when a commit parameter is given" do
+      it "creates the discussion on that commit within the merge request" do
+        # SHAs of "feature" and its parent in spec/support/gitlab-git-test.git
+        mr_commit = '0b4bc9a49b562e85de7cc9e834518ea6828729b9'
+        parent_commit = 'ae73cb07c9eeaf35924a10f713b364d32b2dd34f'
+        file = "files/ruby/feature.rb"
+        line_range = {
+          "start_line_code" => Gitlab::Git.diff_line_code(file, 1, 1),
+          "end_line_code" => Gitlab::Git.diff_line_code(file, 1, 1),
+          "start_line_type" => "text",
+          "end_line_type" => "text"
+        }
+        position = build(
+          :text_diff_position,
+          :added,
+          file: file,
+          new_line: 1,
+          line_range: line_range,
+          base_sha: parent_commit,
+          head_sha: mr_commit,
+          start_sha: parent_commit
+        )
+
+        post api("/projects/#{project.id}/merge_requests/#{noteable['iid']}/discussions", user),
+          params: { body: 'MR discussion on commit', position: position.to_h, commit_id: mr_commit }
+
+        expect(response).to have_gitlab_http_status(:created)
+        expect(json_response['notes'].first['commit_id']).to eq(mr_commit)
+      end
+    end
   end
 
   context 'when noteable is a Commit' do