Feat: Check feature branch is up-to-date on remote (#278)

feat: check the up-to-date status of the remote feature branch before creating a MR, starting a review, or opening the MR summary

Author: jakubbortlik

lua/gitlab/actions/create_mr.lua

@@ -43,6 +43,10 @@ end
 --- continue working on it.
 ---@param args? Mr
 M.start = function(args)
+  if not git.current_branch_up_to_date_on_remote("ERROR") then
+    return
+  end
+
   if M.started then
     vim.ui.select({ "Yes", "No" }, { prompt = "Continue your previous MR?" }, function(choice)
       if choice == "Yes" then

lua/gitlab/actions/summary.lua

@@ -3,6 +3,7 @@
 -- send edits to the description back to Gitlab
 local Layout = require("nui.layout")
 local Popup = require("nui.popup")
+local git = require("gitlab.git")
 local job = require("gitlab.job")
 local common = require("gitlab.actions.common")
 local u = require("gitlab.utils")
@@ -70,6 +71,8 @@ M.summary = function()
 
     vim.api.nvim_set_current_buf(description_popup.bufnr)
   end)
+
+  git.current_branch_up_to_date_on_remote("WARN")
 end
 
 -- Builds a lua list of strings that contain metadata about the current MR. Only builds the

lua/gitlab/git.lua

@@ -1,3 +1,5 @@
+local List = require("gitlab.utils.list")
+
 local M = {}
 
 M.has_clean_tree = function()
@@ -12,4 +14,71 @@ M.switch_branch = function(branch)
   return vim.fn.trim(vim.fn.system({ "git", "checkout", "-q", branch }))
 end
 
+---Return the name of the current branch
+---@return 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)
+  end
+end
+
+---Return the list of names of all remote-tracking branches or an empty list.
+---@return table
+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
+  end
+
+  for line in handle:lines() do
+    table.insert(all_branches, line)
+  end
+  handle:close()
+
+  return List.new(all_branches)
+    :map(function(line)
+      -- Trim "origin/"
+      return line:match("origin/(%S+)")
+    end)
+    :filter(function(branch)
+      -- Don't include the HEAD pointer
+      return not branch:match("^HEAD$")
+    end)
+end
+
+---Returns true if `branch` is up-to-date on remote, false otherwise.
+---@return boolean|nil
+M.current_branch_up_to_date_on_remote = function(log_level)
+  local current_branch = M.get_current_branch()
+  local handle = io.popen("git branch -r --contains " .. current_branch .. " 2>&1")
+  if not handle then
+    require("gitlab.utils").notify("Error running 'git branch' command.", vim.log.levels.ERROR)
+    return nil
+  end
+
+  local remote_branches_with_current_head = {}
+  for line in handle:lines() do
+    table.insert(remote_branches_with_current_head, line)
+  end
+  handle:close()
+
+  local current_head_on_remote = List.new(remote_branches_with_current_head):filter(function(line)
+    return line == "  origin/" .. current_branch
+  end)
+  local remote_up_to_date = #current_head_on_remote == 1
+
+  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]
+    )
+  end
+  return remote_up_to_date
+end
+
 return M

lua/gitlab/reviewer/init.lua

@@ -86,6 +86,8 @@ M.open = function()
     discussions.close()
     require("gitlab").toggle_discussions() -- Fetches data and opens discussions
   end
+
+  git.current_branch_up_to_date_on_remote("WARN")
 end
 
 -- Closes the reviewer and cleans up

lua/gitlab/utils/init.lua

@@ -1,3 +1,4 @@
+local git = require("gitlab.git")
 local List = require("gitlab.utils.list")
 local has_devicons, devicons = pcall(require, "nvim-web-devicons")
 local M = {}
@@ -656,46 +657,16 @@ M.make_comma_separated_readable = function(str)
   return string.gsub(str, ",", ", ")
 end
 
----Return the name of the current branch
----@return string|nil
-M.get_current_branch = function()
-  local handle = io.popen("git branch --show-current 2>&1")
-  if handle then
-    return handle:read()
-  else
-    M.notify("Error running 'git branch' command.", vim.log.levels.ERROR)
-  end
-end
-
----Return the list of names of all remote-tracking branches
+---Return the list of possible merge targets.
+---@return table|nil
 M.get_all_merge_targets = function()
-  local handle = io.popen("git branch -r 2>&1")
-  if not handle then
-    M.notify("Error running 'git branch' command.", vim.log.levels.ERROR)
-    return
-  end
-
-  local current_branch = M.get_current_branch()
+  local current_branch = git.get_current_branch()
   if not current_branch then
     return
   end
-
-  local lines = {}
-  for line in handle:lines() do
-    table.insert(lines, line)
-  end
-  handle:close()
-
-  -- Trim "origin/" and don't include the HEAD pointer
-  local branches = List.new(lines)
-    :map(function(line)
-      return line:match("origin/(%S+)")
-    end)
-    :filter(function(branch)
-      return not branch:match("^HEAD$") and branch ~= current_branch
-    end)
-
-  return branches
+  return List.new(git.get_all_remote_branches()):filter(function(branch)
+    return branch ~= current_branch
+  end)
 end
 
 ---Select a git branch and perform callback with the branch as an argument