Release 2.5.1 (#271)

* feat: Support for custom authentication provider functions (#270)
* feat: Support for adding "draft" notes to the review, and publishing them, either individually or all at once. Addresses feature request #223.
* feat: Lets users select + checkout a merge request directly within Neovim, without exiting to the terminal
* fix: Checks that the remote feature branch exists and is up-to-date before creating a MR, starting a review, or opening the MR summary (#278)
* docs: We require some state from Diffview, this shows how to load that state prior to installing w/ Packer. Fixes #94.

This is a #MINOR release.

---------

Co-authored-by: Jakub F. Bortlík <[email protected]>
Co-authored-by: sunfuze <[email protected]>
Co-authored-by: Patrick Pichler <[email protected]>

Author: 4 people

README.md

@@ -25,9 +25,9 @@ To view these help docs and to get more detailed help information, please run `:
 
 1. Install Go
 2. Add configuration (see Installation section)
-3. Checkout your feature branch: `git checkout feature-branch`
-4. Open Neovim
-5. Run `:lua require("gitlab").review()` to open the reviewer pane
+5. Run `:lua require("gitlab").choose_merge_request()`
+
+This will checkout the branch locally, and open the plugin's reviewer pane.
 
 For more detailed information about the Lua APIs please run `:h gitlab.nvim.api`
 
@@ -56,20 +56,25 @@ return {
 And with Packer:
 
 ```lua
-use {
-  'harrisoncramer/gitlab.nvim',
-  requires = {
-    "MunifTanjim/nui.nvim",
-    "nvim-lua/plenary.nvim",
-    "sindrets/diffview.nvim",
-    "stevearc/dressing.nvim", -- Recommended but not required. Better UI for pickers.
-    "nvim-tree/nvim-web-devicons", -- Recommended but not required. Icons in discussion tree.
-  },
-  run = function() require("gitlab.server").build(true) end,
-  config = function()
-    require("gitlab").setup()
-  end,
-}
+  use {
+    "harrisoncramer/gitlab.nvim",
+    requires = {
+      "MunifTanjim/nui.nvim",
+      "nvim-lua/plenary.nvim",
+      "sindrets/diffview.nvim"
+      "stevearc/dressing.nvim", -- Recommended but not required. Better UI for pickers.
+      "nvim-tree/nvim-web-devicons", -- Recommended but not required. Icons in discussion tree.
+    },
+    build = function()
+      require("gitlab.server").build()
+    end,
+    branch = "develop",
+    config = function()
+      require("diffview") -- We require some global state from diffview
+      local gitlab = require("gitlab")
+      gitlab.setup()
+    end,
+  }
 ```
 
 ## Connecting to Gitlab
@@ -92,6 +97,18 @@ gitlab_url=https://my-personal-gitlab-instance.com/
 
 The plugin will look for the `.gitlab.nvim` file in the root of the current project by default. However, you may provide a custom path to the configuration file via the `config_path` option. This must be an absolute path to the directory that holds your `.gitlab.nvim` file.
 
+In case even more control over the auth config is needed, there is the possibility to override the `auth_provider` settings field. It should be
+a function that returns the `token` as well as the `gitlab_url` value, and a nilable error. If the `gitlab_url` is `nil`, `https://gitlab.com` is used as default.
+
+Here an example how to use a custom `auth_provider`:
+```lua
+require("gitlab").setup({
+  auth_provider = function()
+    return "my_token", "https://custom.gitlab.instance.url", nil
+  end,
+}
+```
+
 For more settings, please see `:h gitlab.nvim.connecting-to-gitlab`
 
 ## Configuring the Plugin
@@ -103,7 +120,10 @@ require("gitlab").setup({
   port = nil, -- The port of the Go server, which runs in the background, if omitted or `nil` the port will be chosen automatically
   log_path = vim.fn.stdpath("cache") .. "/gitlab.nvim.log", -- Log path for the Go server
   config_path = nil, -- Custom path for `.gitlab.nvim` file, please read the "Connecting to Gitlab" section
-  debug = { go_request = false, go_response = false }, -- Which values to log
+  debug = {
+      go_request = false,
+      go_response = false,
+  },
   attachment_dir = nil, -- The local directory for files (see the "summary" section)
   reviewer_settings = {
     diffview = {
@@ -150,6 +170,7 @@ require("gitlab").setup({
     toggle_resolved_discussions = "R", -- Open or close all resolved discussions
     toggle_unresolved_discussions = "U", -- Open or close all unresolved discussions
     keep_current_open = false, -- If true, current discussion stays open even if it should otherwise be closed when toggling
+    publish_draft = "P", -- Publishes the currently focused note/comment
     toggle_resolved = "p" -- Toggles the resolved status of the whole discussion
     position = "left", -- "top", "right", "bottom" or "left"
     open_in_browser = "b" -- Jump to the URL of the current note/discussion
@@ -160,9 +181,14 @@ require("gitlab").setup({
     unresolved = '-', -- Symbol to show next to unresolved discussions
     tree_type = "simple", -- Type of discussion tree - "simple" means just list of discussions, "by_file_name" means file tree with discussions under file
     toggle_tree_type = "i", -- Toggle type of discussion tree - "simple", or "by_file_name"
+    draft_mode = false, -- Whether comments are posted as drafts as part of a review
+    toggle_draft_mode = "D" -- Toggle between draft mode (comments posted as drafts) and live mode (comments are posted immediately)
     winbar = nil -- Custom function to return winbar title, should return a string. Provided with WinbarTable (defined in annotations.lua)
                  -- If using lualine, please add "gitlab" to disabled file types, otherwise you will not see the winbar.
   },
+  choose_merge_request = {
+    open_reviewer = true, -- Open the reviewer window automatically after switching merge requests
+  },
   info = { -- Show additional fields in the summary view
     enabled = true,
     horizontal = false, -- Display metadata to the left of the summary rather than underneath
@@ -246,6 +272,7 @@ you need to set them up yourself. Here's what I'm using:
 ```lua
 local gitlab = require("gitlab")
 local gitlab_server = require("gitlab.server")
+vim.keymap.set("n", "glb", gitlab.choose_merge_request)
 vim.keymap.set("n", "glr", gitlab.review)
 vim.keymap.set("n", "gls", gitlab.summary)
 vim.keymap.set("n", "glA", gitlab.approve)
@@ -266,6 +293,8 @@ vim.keymap.set("n", "glrd", gitlab.delete_reviewer)
 vim.keymap.set("n", "glp", gitlab.pipeline)
 vim.keymap.set("n", "glo", gitlab.open_in_browser)
 vim.keymap.set("n", "glM", gitlab.merge)
+vim.keymap.set("n", "glu", gitlab.copy_mr_url)
+vim.keymap.set("n", "glP", gitlab.publish_all_drafts)
 ```
 
 For more information about each of these commands, and about the APIs in general, run `:h gitlab.nvim.api`

after/syntax/gitlab.vim

@@ -8,12 +8,14 @@ syntax match ChevronDown ""
 syntax match ChevronRight ""
 syntax match Resolved /\s✓\s\?/
 syntax match Unresolved /\s-\s\?/
+syntax match Pencil //
 
 highlight link Username GitlabUsername
 highlight link Date GitlabDate
 highlight link ChevronDown GitlabChevron
 highlight link ChevronRight GitlabChevron
 highlight link Resolved GitlabResolved
 highlight link Unresolved GitlabUnresolved
+highlight link Pencil GitlabDraft
 
 let b:current_syntax = "gitlab"

cmd/assignee_test.go

@@ -23,15 +23,15 @@ func updateAssigneesErr(pid interface{}, mergeRequest int, opt *gitlab.UpdateMer
 func TestAssigneeHandler(t *testing.T) {
 	t.Run("Updates assignees", func(t *testing.T) {
 		request := makeRequest(t, http.MethodPut, "/mr/assignee", AssigneeUpdateRequest{Ids: []int{1, 2}})
-		server, _ := createRouterAndApi(fakeClient{updateMergeRequestFn: updateAssignees})
+		server, _ := createRouterAndApi(fakeClient{updateMergeRequest: updateAssignees})
 		data := serveRequest(t, server, request, AssigneeUpdateResponse{})
 		assert(t, data.SuccessResponse.Message, "Assignees updated")
 		assert(t, data.SuccessResponse.Status, http.StatusOK)
 	})
 
 	t.Run("Disallows non-PUT method", func(t *testing.T) {
 		request := makeRequest(t, http.MethodPost, "/mr/assignee", nil)
-		server, _ := createRouterAndApi(fakeClient{updateMergeRequestFn: updateAssignees})
+		server, _ := createRouterAndApi(fakeClient{updateMergeRequest: updateAssignees})
 		data := serveRequest(t, server, request, ErrorResponse{})
 		assert(t, data.Status, http.StatusMethodNotAllowed)
 		assert(t, data.Details, "Invalid request type")
@@ -40,7 +40,7 @@ func TestAssigneeHandler(t *testing.T) {
 
 	t.Run("Handles errors from Gitlab client", func(t *testing.T) {
 		request := makeRequest(t, http.MethodPut, "/mr/assignee", AssigneeUpdateRequest{Ids: []int{1, 2}})
-		server, _ := createRouterAndApi(fakeClient{updateMergeRequestFn: updateAssigneesErr})
+		server, _ := createRouterAndApi(fakeClient{updateMergeRequest: updateAssigneesErr})
 		data := serveRequest(t, server, request, ErrorResponse{})
 		assert(t, data.Status, http.StatusInternalServerError)
 		assert(t, data.Message, "Could not modify merge request assignees")
@@ -49,7 +49,7 @@ func TestAssigneeHandler(t *testing.T) {
 
 	t.Run("Handles non-200s from Gitlab client", func(t *testing.T) {
 		request := makeRequest(t, http.MethodPut, "/mr/assignee", AssigneeUpdateRequest{Ids: []int{1, 2}})
-		server, _ := createRouterAndApi(fakeClient{updateMergeRequestFn: updateAssigneesNon200})
+		server, _ := createRouterAndApi(fakeClient{updateMergeRequest: updateAssigneesNon200})
 		data := serveRequest(t, server, request, ErrorResponse{})
 		assert(t, data.Status, http.StatusSeeOther)
 		assert(t, data.Message, "Could not modify merge request assignees")

cmd/client.go

@@ -40,6 +40,7 @@ type Client struct {
 	*gitlab.LabelsService
 	*gitlab.AwardEmojiService
 	*gitlab.UsersService
+	*gitlab.DraftNotesService
 }
 
 /* initGitlabClient parses and validates the project settings and initializes the Gitlab client. */
@@ -116,6 +117,7 @@ func initGitlabClient() (error, *Client) {
 		LabelsService:                client.Labels,
 		AwardEmojiService:            client.AwardEmoji,
 		UsersService:                 client.Users,
+		DraftNotesService:            client.DraftNotes,
 	}
 }
 

cmd/comment.go

@@ -1,7 +1,6 @@
 package main
 
 import (
-	"crypto/sha1"
 	"encoding/json"
 	"fmt"
 	"io"
@@ -11,28 +10,8 @@ import (
 )
 
 type PostCommentRequest struct {
-	Comment        string     `json:"comment"`
-	FileName       string     `json:"file_name"`
-	NewLine        *int       `json:"new_line,omitempty"`
-	OldLine        *int       `json:"old_line,omitempty"`
-	HeadCommitSHA  string     `json:"head_commit_sha"`
-	BaseCommitSHA  string     `json:"base_commit_sha"`
-	StartCommitSHA string     `json:"start_commit_sha"`
-	Type           string     `json:"type"`
-	LineRange      *LineRange `json:"line_range,omitempty"`
-}
-
-/* LineRange represents the range of a note. */
-type LineRange struct {
-	StartRange *LinePosition `json:"start"`
-	EndRange   *LinePosition `json:"end"`
-}
-
-/* LinePosition represents a position in a line range. Unlike the Gitlab struct, this does not contain LineCode with a sha1 of the filename */
-type LinePosition struct {
-	Type    string `json:"type"`
-	OldLine int    `json:"old_line"`
-	NewLine int    `json:"new_line"`
+	Comment string `json:"comment"`
+	PositionData
 }
 
 type DeleteCommentRequest struct {
@@ -53,6 +32,15 @@ type CommentResponse struct {
 	Discussion *gitlab.Discussion `json:"discussion"`
 }
 
+/* CommentWithPosition is a comment with an (optional) position data value embedded in it. The position data will be non-nil for range-based comments. */
+type CommentWithPosition struct {
+	PositionData PositionData
+}
+
+func (comment CommentWithPosition) GetPositionData() PositionData {
+	return comment.PositionData
+}
+
 /* commentHandler creates, edits, and deletes discussions (comments, multi-line comments) */
 func (a *api) commentHandler(w http.ResponseWriter, r *http.Request) {
 	w.Header().Set("Content-Type", "application/json")
@@ -133,46 +121,10 @@ func (a *api) postComment(w http.ResponseWriter, r *http.Request) {
 
 	/* If we are leaving a comment on a line, leave position. Otherwise,
 	we are leaving a note (unlinked comment) */
-	var friendlyName = "Note"
+
 	if postCommentRequest.FileName != "" {
-		friendlyName = "Comment"
-		opt.Position = &gitlab.PositionOptions{
-			PositionType: &postCommentRequest.Type,
-			StartSHA:     &postCommentRequest.StartCommitSHA,
-			HeadSHA:      &postCommentRequest.HeadCommitSHA,
-			BaseSHA:      &postCommentRequest.BaseCommitSHA,
-			NewPath:      &postCommentRequest.FileName,
-			OldPath:      &postCommentRequest.FileName,
-			NewLine:      postCommentRequest.NewLine,
-			OldLine:      postCommentRequest.OldLine,
-		}
-
-		if postCommentRequest.LineRange != nil {
-			friendlyName = "Multiline Comment"
-			shaFormat := "%x_%d_%d"
-			startFilenameSha := fmt.Sprintf(
-				shaFormat,
-				sha1.Sum([]byte(postCommentRequest.FileName)),
-				postCommentRequest.LineRange.StartRange.OldLine,
-				postCommentRequest.LineRange.StartRange.NewLine,
-			)
-			endFilenameSha := fmt.Sprintf(
-				shaFormat,
-				sha1.Sum([]byte(postCommentRequest.FileName)),
-				postCommentRequest.LineRange.EndRange.OldLine,
-				postCommentRequest.LineRange.EndRange.NewLine,
-			)
-			opt.Position.LineRange = &gitlab.LineRangeOptions{
-				Start: &gitlab.LinePositionOptions{
-					Type:     &postCommentRequest.LineRange.StartRange.Type,
-					LineCode: &startFilenameSha,
-				},
-				End: &gitlab.LinePositionOptions{
-					Type:     &postCommentRequest.LineRange.EndRange.Type,
-					LineCode: &endFilenameSha,
-				},
-			}
-		}
+		commentWithPositionData := CommentWithPosition{postCommentRequest.PositionData}
+		opt.Position = buildCommentPosition(commentWithPositionData)
 	}
 
 	discussion, res, err := a.client.CreateMergeRequestDiscussion(a.projectInfo.ProjectId, a.projectInfo.MergeId, &opt)
@@ -190,7 +142,7 @@ func (a *api) postComment(w http.ResponseWriter, r *http.Request) {
 	w.WriteHeader(http.StatusOK)
 	response := CommentResponse{
 		SuccessResponse: SuccessResponse{
-			Message: fmt.Sprintf("%s created successfully", friendlyName),
+			Message: "Comment created successfully",
 			Status:  http.StatusOK,
 		},
 		Comment:    discussion.Notes[0],

cmd/comment_helpers.go

@@ -0,0 +1,82 @@
+package main
+
+import (
+	"crypto/sha1"
+	"fmt"
+
+	"github.com/xanzy/go-gitlab"
+)
+
+/* LinePosition represents a position in a line range. Unlike the Gitlab struct, this does not contain LineCode with a sha1 of the filename */
+type LinePosition struct {
+	Type    string `json:"type"`
+	OldLine int    `json:"old_line"`
+	NewLine int    `json:"new_line"`
+}
+
+/* LineRange represents the range of a note. */
+type LineRange struct {
+	StartRange *LinePosition `json:"start"`
+	EndRange   *LinePosition `json:"end"`
+}
+
+/* PositionData represents the position of a comment or note (relative to a file diff) */
+type PositionData struct {
+	FileName       string     `json:"file_name"`
+	NewLine        *int       `json:"new_line,omitempty"`
+	OldLine        *int       `json:"old_line,omitempty"`
+	HeadCommitSHA  string     `json:"head_commit_sha"`
+	BaseCommitSHA  string     `json:"base_commit_sha"`
+	StartCommitSHA string     `json:"start_commit_sha"`
+	Type           string     `json:"type"`
+	LineRange      *LineRange `json:"line_range,omitempty"`
+}
+
+/* RequestWithPosition is an interface that abstracts the handling of position data for a comment or a draft comment */
+type RequestWithPosition interface {
+	GetPositionData() PositionData
+}
+
+/* buildCommentPosition takes a comment or draft comment request and builds the position data necessary for a location-based comment */
+func buildCommentPosition(commentWithPositionData RequestWithPosition) *gitlab.PositionOptions {
+	positionData := commentWithPositionData.GetPositionData()
+
+	opt := &gitlab.PositionOptions{
+		PositionType: &positionData.Type,
+		StartSHA:     &positionData.StartCommitSHA,
+		HeadSHA:      &positionData.HeadCommitSHA,
+		BaseSHA:      &positionData.BaseCommitSHA,
+		NewPath:      &positionData.FileName,
+		OldPath:      &positionData.FileName,
+		NewLine:      positionData.NewLine,
+		OldLine:      positionData.OldLine,
+	}
+
+	if positionData.LineRange != nil {
+		shaFormat := "%x_%d_%d"
+		startFilenameSha := fmt.Sprintf(
+			shaFormat,
+			sha1.Sum([]byte(positionData.FileName)),
+			positionData.LineRange.StartRange.OldLine,
+			positionData.LineRange.StartRange.NewLine,
+		)
+		endFilenameSha := fmt.Sprintf(
+			shaFormat,
+			sha1.Sum([]byte(positionData.FileName)),
+			positionData.LineRange.EndRange.OldLine,
+			positionData.LineRange.EndRange.NewLine,
+		)
+		opt.LineRange = &gitlab.LineRangeOptions{
+			Start: &gitlab.LinePositionOptions{
+				Type:     &positionData.LineRange.StartRange.Type,
+				LineCode: &startFilenameSha,
+			},
+			End: &gitlab.LinePositionOptions{
+				Type:     &positionData.LineRange.EndRange.Type,
+				LineCode: &endFilenameSha,
+			},
+		}
+	}
+
+	return opt
+}