fix: draft note edits + reply keybinding (#279)

fix: issue with editing draft notes; jumping to correct position for draft notes; and replying (not supported) to draft notes.

Author: harrisoncramer

cmd/draft_notes.go

@@ -22,7 +22,8 @@ type PostDraftNoteRequest struct {
 }
 
 type UpdateDraftNoteRequest struct {
-	Note string `json:"note"`
+	Note     string `json:"note"`
+	Position gitlab.PositionOptions
 }
 
 type DraftNotePublishRequest struct {
@@ -242,7 +243,8 @@ func (a *api) updateDraftNote(w http.ResponseWriter, r *http.Request) {
 	}
 
 	opt := gitlab.UpdateDraftNoteOptions{
-		Note: &updateDraftNoteRequest.Note,
+		Note:     &updateDraftNoteRequest.Note,
+		Position: &updateDraftNoteRequest.Position,
 	}
 
 	draftNote, res, err := a.client.UpdateDraftNote(a.projectInfo.ProjectId, a.projectInfo.MergeId, id, &opt)

cmd/draft_notes_test.go

@@ -106,7 +106,7 @@ func updateDraftNote(pid interface{}, mergeRequest int, note int, opt *gitlab.Up
 
 func TestEditDraftNote(t *testing.T) {
 	t.Run("Edits draft note", func(t *testing.T) {
-		request := makeRequest(t, http.MethodPatch, "/mr/draft_notes/3", UpdateDraftNoteRequest{Note: "Some new note"})
+		request := makeRequest(t, http.MethodPatch, "/mr/draft_notes/3", UpdateDraftNoteRequest{Note: "Some new note", Position: gitlab.PositionOptions{}})
 		server, _ := createRouterAndApi(fakeClient{updateDraftNote: updateDraftNote})
 		data := serveRequest(t, server, request, SuccessResponse{})
 		assert(t, data.Message, "Draft note updated")

lua/gitlab/actions/common.lua

@@ -4,6 +4,7 @@
 local List = require("gitlab.utils.list")
 local u = require("gitlab.utils")
 local reviewer = require("gitlab.reviewer")
+local indicators_common = require("gitlab.indicators.common")
 local common_indicators = require("gitlab.indicators.common")
 local state = require("gitlab.state")
 local M = {}
@@ -176,7 +177,7 @@ end
 
 ---Takes a node and returns the line where the note is positioned in the new SHA. If
 ---the line is not in the new SHA, returns nil
----@param node any
+---@param node NuiTree.Node
 ---@return number|nil
 local function get_new_line(node)
   ---@type GitlabLineRange|nil
@@ -191,7 +192,7 @@ end
 
 ---Takes a node and returns the line where the note is positioned in the old SHA. If
 ---the line is not in the old SHA, returns nil
----@param node any
+---@param node NuiTree.Node
 ---@return number|nil
 local function get_old_line(node)
   ---@type GitlabLineRange|nil
@@ -204,6 +205,36 @@ local function get_old_line(node)
   return start_old_line
 end
 
+---@param id string|integer
+---@return integer|nil
+M.get_line_number = function(id)
+  ---@type Discussion|DraftNote|nil
+  local d_or_n
+  d_or_n = List.new(state.DISCUSSION_DATA.discussions or {}):find(function(d)
+    return d.id == id
+  end) or List.new(state.DRAFT_NOTES or {}):find(function(d)
+    return d.id == id
+  end)
+
+  if d_or_n == nil then
+    return
+  end
+
+  local first_note = indicators_common.get_first_note(d_or_n)
+  return (indicators_common.is_new_sha(d_or_n) and first_note.position.new_line or first_note.position.old_line) or 1
+end
+
+---@param root_node NuiTree.Node
+---@return integer|nil
+M.get_line_number_from_node = function(root_node)
+  if root_node.range then
+    local start_old_line, start_new_line = common_indicators.parse_line_code(root_node.range.start.line_code)
+    return root_node.old_line and start_old_line or start_new_line
+  else
+    return M.get_line_number(root_node.id)
+  end
+end
+
 -- This function (settings.discussion_tree.jump_to_reviewer) will jump the cursor to the reviewer's location associated with the note. The implementation depends on the reviewer
 M.jump_to_reviewer = function(tree, callback)
   local node = tree:get_node()
@@ -212,10 +243,10 @@ M.jump_to_reviewer = function(tree, callback)
     u.notify("Could not get discussion node", vim.log.levels.ERROR)
     return
   end
-  local line_number = (root_node.new_line or root_node.old_line or 1)
-  if root_node.range then
-    local start_old_line, start_new_line = common_indicators.parse_line_code(root_node.range.start.line_code)
-    line_number = root_node.old_line and start_old_line or start_new_line
+  local line_number = M.get_line_number_from_node(root_node)
+  if line_number == nil then
+    u.notify("Could not get line number", vim.log.levels.ERROR)
+    return
   end
   reviewer.jump(root_node.file_name, line_number, root_node.old_line == nil)
   callback()

lua/gitlab/actions/discussions/init.lua

@@ -215,6 +215,10 @@ end
 
 -- The reply popup will mount in a window when you trigger it (settings.discussion_tree.reply) when hovering over a node in the discussion tree.
 M.reply = function(tree)
+  if M.is_draft_note(tree) then
+    u.notify("Gitlab does not support replying to draft notes", vim.log.levels.WARN)
+    return
+  end
   local reply_popup = Popup(u.create_popup_state("Reply", state.settings.popup.reply))
   local node = tree:get_node()
   local discussion_node = common.get_root_node(tree, node)

lua/gitlab/actions/draft_notes/init.lua

@@ -85,11 +85,15 @@ end
 ---Send edits will actually send the edits to Gitlab and refresh the draft_notes tree
 M.send_edits = function(note_id)
   return function(text)
-    local body = { note = text }
+    local all_notes = List.new(state.DRAFT_NOTES)
+    local the_note = all_notes:find(function(note)
+      return note.id == note_id
+    end)
+    local body = { note = text, position = the_note.position }
     job.run_job(string.format("/mr/draft_notes/%d", note_id), "PATCH", body, function(data)
       u.notify(data.message, vim.log.levels.INFO)
       local has_position = false
-      local new_draft_notes = List.new(state.DRAFT_NOTES):map(function(note)
+      local new_draft_notes = all_notes:map(function(note)
         if note.id == note_id then
           has_position = M.has_position(note)
           note.note = text

lua/gitlab/indicators/diagnostics.lua

@@ -51,9 +51,7 @@ end
 ---@param d_or_n Discussion|DraftNote
 ---@return Diagnostic
 local create_single_line_diagnostic = function(d_or_n)
-  local first_note = indicators_common.get_first_note(d_or_n)
-  local linnr = (indicators_common.is_new_sha(d_or_n) and first_note.position.new_line or first_note.position.old_line)
-    or 1
+  local linnr = actions_common.get_line_number(d_or_n.id)
   return create_diagnostic({
     lnum = linnr - 1,
   }, d_or_n)