feat: wrap CLI commands, toggle draft/live mode (#280)

harrisoncramer · web-flow · commit fa16905fab17 · 2024-04-21T20:47:32.000-04:00
feat: better error checking in git commands
feat: allow toggling between live mode and draft mode, adds "D" keybinding to discussion tree
diff --git a/README.md b/README.md
@@ -93,13 +93,13 @@ 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. If the `gitlab_url` is `nil`, `https://gitlab.com` is used as default.
+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"
+    return "my_token", "https://custom.gitlab.instance.url", nil
   end,
 }
 ```
@@ -176,12 +176,11 @@ 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.
   },
-  comments = {
-    default_to_draft = false, -- Whether to default a comment to a "draft" or not in the popup
-  },
   choose_merge_request = {
     open_reviewer = true, -- Open the reviewer window automatically after switching merge requests
   },
diff --git a/cmd/main.go b/cmd/main.go
@@ -5,9 +5,10 @@ import (
 )
 
 func main() {
+	log.SetFlags(0)
 	gitInfo, err := extractGitInfo(RefreshProjectInfo, GetProjectUrlFromNativeGitCmd, GetCurrentBranchNameFromNativeGitCmd)
 	if err != nil {
-		log.Fatalf("Failure initializing plugin with `git` commands: %v", err)
+		log.Fatalf("Failure initializing plugin: %v", err)
 	}
 
 	err, client := initGitlabClient()
diff --git a/doc/gitlab.nvim.txt b/doc/gitlab.nvim.txt
@@ -124,14 +124,16 @@ configure your connection to Gitlab.
 
 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.
+a function that returns the `token` as well as the `gitlab_url` value and
+a nilable error value.
+
 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"
+        return "my_token", "https://custom.gitlab.instance.url", nil
       end,
     }
 <
@@ -199,12 +201,11 @@ you call this function with no values the defaults will be used:
         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 and regular mode, where 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.
       },
-      comments = {
-        default_to_draft = false, -- Whether to default a comment to a "draft" or not in the popup
-      },
       choose_merge_request = {
         open_reviewer = true, -- Open the reviewer window automatically after switching merge requests
       },
diff --git a/lua/gitlab/actions/comment.lua b/lua/gitlab/actions/comment.lua
@@ -140,8 +140,8 @@ local function create_comment_layout(opts)
   end, miscellaneous.attach_file, popup_opts)
 
   vim.schedule(function()
-    local default_to_draft = state.settings.comments.default_to_draft
-    vim.api.nvim_buf_set_lines(M.draft_popup.bufnr, 0, -1, false, { u.bool_to_string(default_to_draft) })
+    local draft_mode = state.settings.discussion_tree.draft_mode
+    vim.api.nvim_buf_set_lines(M.draft_popup.bufnr, 0, -1, false, { u.bool_to_string(draft_mode) })
   end)
 
   return layout
@@ -150,7 +150,10 @@ end
 --- This function will open a comment popup in order to create a comment on the changed/updated
 --- line in the current MR
 M.create_comment = function()
-  local has_clean_tree = git.has_clean_tree()
+  local has_clean_tree, err = git.has_clean_tree()
+  if err ~= nil then
+    return
+  end
   local is_modified = vim.api.nvim_buf_get_option(0, "modified")
   if state.settings.reviewer_settings.diffview.imply_local and (is_modified or not has_clean_tree) then
     u.notify(
diff --git a/lua/gitlab/actions/common.lua b/lua/gitlab/actions/common.lua
@@ -32,10 +32,7 @@ end
 ---@param content string
 ---@return table
 M.build_content = function(content)
-  local description_lines = {}
-  for line in u.split_by_new_lines(content) do
-    table.insert(description_lines, line)
-  end
+  local description_lines = u.lines_into_table(content)
   table.insert(description_lines, "")
   return description_lines
 end
diff --git a/lua/gitlab/actions/create_mr.lua b/lua/gitlab/actions/create_mr.lua
@@ -43,7 +43,7 @@ end
 --- continue working on it.
 ---@param args? Mr
 M.start = function(args)
-  if not git.current_branch_up_to_date_on_remote("ERROR") then
+  if not git.current_branch_up_to_date_on_remote(vim.log.levels.ERROR) then
     return
   end
 
@@ -87,7 +87,10 @@ M.pick_target = function(mr)
 end
 
 local function make_template_path(t)
-  local base_dir = git.base_dir()
+  local base_dir, err = git.base_dir()
+  if err ~= nil then
+    return
+  end
   return base_dir
     .. state.settings.file_separator
     .. ".gitlab"
diff --git a/lua/gitlab/actions/discussions/init.lua b/lua/gitlab/actions/discussions/init.lua
@@ -528,6 +528,10 @@ M.set_tree_keymaps = function(tree, bufnr, unlinked)
       M.delete_comment(tree)
     end
   end, { buffer = bufnr, desc = "Delete comment" })
+  vim.keymap.set("n", state.settings.discussion_tree.toggle_draft_mode, function()
+    state.settings.discussion_tree.draft_mode = not state.settings.discussion_tree.draft_mode
+    winbar.update_winbar()
+  end, { buffer = bufnr, desc = "Toggle between draft mode and live mode" })
   vim.keymap.set("n", state.settings.discussion_tree.toggle_resolved, function()
     if M.is_current_node_note(tree) and not M.is_draft_note(tree) then
       M.toggle_discussion_resolved(tree)
diff --git a/lua/gitlab/actions/discussions/winbar.lua b/lua/gitlab/actions/discussions/winbar.lua
@@ -125,10 +125,32 @@ M.make_winbar = function(t)
     notes_title = "%#Text#" .. notes_title
   end
 
+  local mode = M.get_mode()
+
   -- Join everything together and return it
   local separator = "%#Comment#|"
-  local help = "%#Comment#%=Help: " .. t.help_keymap:gsub(" ", "<space>") .. " "
-  return string.format(" %s %s %s %s", discussion_title, separator, notes_title, help)
+  local end_section = "%="
+  local help = "%#Comment#Help: " .. t.help_keymap:gsub(" ", "<space>") .. " "
+  return string.format(
+    " %s %s %s %s %s %s %s",
+    discussion_title,
+    separator,
+    notes_title,
+    end_section,
+    mode,
+    separator,
+    help
+  )
+end
+
+---Returns a string for the winbar indicating the mode type, live or draft
+---@return string
+M.get_mode = function()
+  if state.settings.discussion_tree.draft_mode then
+    return "%#DiagnosticWarn#Draft Mode"
+  else
+    return "%#DiagnosticOK#Live Mode"
+  end
 end
 
 ---Sets the current view type (if provided an argument)
diff --git a/lua/gitlab/actions/merge_requests.lua b/lua/gitlab/actions/merge_requests.lua
@@ -10,7 +10,10 @@ local M = {}
 ---Opens up a select menu that lets you choose a different merge request.
 ---@param opts SwitchOpts|nil
 M.choose_merge_request = function(opts)
-  if not git.has_clean_tree() then
+  local has_clean_tree, clean_tree_err = git.has_clean_tree()
+  if clean_tree_err ~= nil then
+    return
+  elseif has_clean_tree ~= "" then
     u.notify("Your local branch has changes, please stash or commit and push", vim.log.levels.ERROR)
     return
   end
@@ -34,9 +37,8 @@ M.choose_merge_request = function(opts)
     end
 
     vim.schedule(function()
-      local err = git.switch_branch(choice.source_branch)
-      if err ~= "" then
-        u.notify(err, vim.log.levels.ERROR)
+      local _, branch_switch_err = git.switch_branch(choice.source_branch)
+      if branch_switch_err ~= nil then
         return
       end
 
diff --git a/lua/gitlab/actions/pipeline.lua b/lua/gitlab/actions/pipeline.lua
@@ -143,10 +143,7 @@ M.see_logs = function()
       return
     end
 
-    local lines = {}
-    for line in u.split_by_new_lines(file) do
-      table.insert(lines, line)
-    end
+    local lines = u.lines_into_table(file)
 
     if #lines == 0 then
       u.notify("Log trace lines could not be parsed", vim.log.levels.ERROR)
diff --git a/lua/gitlab/actions/summary.lua b/lua/gitlab/actions/summary.lua
@@ -72,7 +72,7 @@ M.summary = function()
     vim.api.nvim_set_current_buf(description_popup.bufnr)
   end)
 
-  git.current_branch_up_to_date_on_remote("WARN")
+  git.current_branch_up_to_date_on_remote(vim.log.levels.WARN)
 end
 
 -- Builds a lua list of strings that contain metadata about the current MR. Only builds the
diff --git a/lua/gitlab/git.lua b/lua/gitlab/git.lua
@@ -2,45 +2,75 @@ local List = require("gitlab.utils.list")
 
 local M = {}
 
+---Runs a system command, captures the output (if it exists) and handles errors
+---@param command table
+---@return string|nil, string|nil
+local run_system = function(command)
+  local u = require("gitlab.utils")
+  local result = vim.fn.trim(vim.fn.system(command))
+  if vim.v.shell_error ~= 0 then
+    u.notify(result, vim.log.levels.ERROR)
+    return nil, result
+  end
+  return result, nil
+end
+
+---Returns all branches for the current repository
+---@return string|nil, string|nil
+M.branches = function()
+  return run_system({ "git", "branch" })
+end
+
+---Checks whether the tree has any changes that haven't been pushed to the remote
+---@return string|nil, string|nil
 M.has_clean_tree = function()
-  return vim.fn.trim(vim.fn.system({ "git", "status", "--short", "--untracked-files=no" })) == ""
+  return run_system({ "git", "status", "--short", "--untracked-files=no" })
 end
 
+---Gets the base directory of the current project
+---@return string|nil, string|nil
 M.base_dir = function()
-  return vim.fn.trim(vim.fn.system({ "git", "rev-parse", "--show-toplevel" }))
+  return run_system({ "git", "rev-parse", "--show-toplevel" })
 end
 
+---Switches the current project to the given branch
+---@return string|nil, string|nil
 M.switch_branch = function(branch)
-  return vim.fn.trim(vim.fn.system({ "git", "checkout", "-q", branch }))
+  return run_system({ "git", "checkout", "-q", branch })
 end
 
 ---Return the name of the current branch
----@return string|nil
+---@return string|nil, string|nil
 M.get_current_branch = function()
-  local handle = io.popen("git branch --show-current 2>&1")
-  if handle then
-    return handle:read()
-  else
-    require("gitlab.utils").notify("Error running 'git branch' command.", vim.log.levels.ERROR)
+  return run_system({ "git", "branch", "--show-current" })
+end
+
+---Return the list of possible merge targets.
+---@return table|nil
+M.get_all_merge_targets = function()
+  local current_branch, err = M.get_current_branch()
+  if not current_branch or err ~= nil then
+    return
   end
+  return List.new(M.get_all_remote_branches()):filter(function(branch)
+    return branch ~= current_branch
+  end)
 end
 
 ---Return the list of names of all remote-tracking branches or an empty list.
----@return table
+---@return table, string|nil
 M.get_all_remote_branches = function()
-  local all_branches = {}
-  local handle = io.popen("git branch -r 2>&1")
-  if not handle then
-    require("gitlab.utils").notify("Error running 'git branch' command.", vim.log.levels.ERROR)
-    return all_branches
+  local all_branches, err = M.branches()
+  if err ~= nil then
+    return {}, err
   end
-
-  for line in handle:lines() do
-    table.insert(all_branches, line)
+  if all_branches == nil then
+    return {}, "Something went wrong getting branches for this repository"
   end
-  handle:close()
 
-  return List.new(all_branches)
+  local u = require("gitlab.utils")
+  local lines = u.lines_into_table(all_branches)
+  return List.new(lines)
     :map(function(line)
       -- Trim "origin/"
       return line:match("origin/(%S+)")
@@ -51,7 +81,15 @@ M.get_all_remote_branches = function()
     end)
 end
 
+---Return whether something
+---@param current_branch string
+---@return string|nil, string|nil
+M.contains_branch = function(current_branch)
+  return run_system({ "git", "branch", "-r", "--contains", current_branch })
+end
+
 ---Returns true if `branch` is up-to-date on remote, false otherwise.
+---@param log_level integer
 ---@return boolean|nil
 M.current_branch_up_to_date_on_remote = function(log_level)
   local current_branch = M.get_current_branch()
@@ -75,7 +113,7 @@ M.current_branch_up_to_date_on_remote = function(log_level)
   if not remote_up_to_date then
     require("gitlab.utils").notify(
       "You have local commits that are not on origin. Have you forgotten to push?",
-      vim.log.levels[log_level]
+      log_level
     )
   end
   return remote_up_to_date
diff --git a/lua/gitlab/reviewer/init.lua b/lua/gitlab/reviewer/init.lua
@@ -42,7 +42,10 @@ M.open = function()
   end
 
   local diffview_open_command = "DiffviewOpen"
-  local has_clean_tree = git.has_clean_tree()
+  local has_clean_tree, err = git.has_clean_tree()
+  if err ~= nil then
+    return
+  end
   if state.settings.reviewer_settings.diffview.imply_local and has_clean_tree then
     diffview_open_command = diffview_open_command .. " --imply-local"
   end
@@ -87,7 +90,7 @@ M.open = function()
     require("gitlab").toggle_discussions() -- Fetches data and opens discussions
   end
 
-  git.current_branch_up_to_date_on_remote("WARN")
+  git.current_branch_up_to_date_on_remote(vim.log.levels.WARN)
 end
 
 -- Closes the reviewer and cleans up
diff --git a/lua/gitlab/state.lua b/lua/gitlab/state.lua
diff --git a/lua/gitlab/utils/init.lua b/lua/gitlab/utils/init.lua

Original file line number	Diff line number	Diff line change
`@@ -5,9 +5,10 @@ import (`
`5`	`5`	`)`
`6`	`6`
`7`	`7`	`func main() {`
	`8`	`+ log.SetFlags(0)`
`8`	`9`	`gitInfo, err := extractGitInfo(RefreshProjectInfo, GetProjectUrlFromNativeGitCmd, GetCurrentBranchNameFromNativeGitCmd)`
`9`	`10`	`if err != nil {`
`10`		- log.Fatalf("Failure initializing plugin with `git` commands: %v", err)
	`11`	`+ log.Fatalf("Failure initializing plugin: %v", err)`
`11`	`12`	`}`
`12`	`13`
`13`	`14`	`err, client := initGitlabClient()`