fix(server): use vim.system instead of jobstart to bypass shell (#560)

Switch the server launch from vim.fn.jobstart to vim.system, passing the binary and JSON settings as a list. Neovim spawns the process directly instead of going through the user's shell, removing the Windows-specific "-escaping hack that only worked for POSIX-style shells, otherwise it prevented the Go server from starting.

Author: JonLD

README.md

@@ -18,6 +18,7 @@ To view these help docs and to get more detailed help information, please run `:
 
 ## Requirements
 
+- <a href="https://neovim.io/">Neovim</a> >= v0.10
 - <a href="https://go.dev/">Go</a> >= v1.25.1
 
 ## Quick Start

lua/gitlab/server.lua

@@ -1,7 +1,6 @@
 -- This module contains the logic responsible for building and starting
 -- the Golang server. The Go server is responsible for making API calls
 -- to Gitlab and returning the data
-local List = require("gitlab.utils.list")
 local state = require("gitlab.state")
 local u = require("gitlab.utils")
 local job = require("gitlab.job")
@@ -62,58 +61,50 @@ M.start = function(callback)
   state.chosen_mr_iid = 0 -- Do not let this interfere with subsequent reviewer.open() calls
 
   local settings = vim.json.encode(go_server_settings)
-  if vim.fn.has("win32") then
-    settings = settings:gsub('"', '\\"')
-  end
-
-  local command = string.format('"%s" "%s"', state.settings.server.binary, settings)
 
-  local job_id = vim.fn.jobstart(command, {
-    on_stdout = function(_, data)
-      -- if port was not provided then we need to parse it from output of server
-      if parsed_port == nil then
-        for _, line in ipairs(data) do
-          port = line:match("Server started on port:%s+(%d+)")
-          if port ~= nil then
-            parsed_port = port
-            state.settings.server.port = port
-            break
-          end
-        end
-      end
+  local stderr_buf = ""
 
-      -- This assumes that first output of server will be parsable and port will be correctly set.
-      -- Make sure that this actually check if port was correctly parsed based on server output
-      -- because server outputs port only if it started successfully.
-      if parsed_port ~= nil and not callback_called then
-        state.go_server_running = true
-        callback()
-        callback_called = true
+  local ok, err = pcall(vim.system, { state.settings.server.binary, settings }, {
+    stdout = function(_, data)
+      if data == nil or parsed_port ~= nil then
+        return
       end
-    end,
-    on_stderr = function(_, errors)
-      local err_msg = List.new(errors):reduce(function(agg, err)
-        if err ~= "" and err ~= nil then
-          agg = agg .. err .. "\n"
+      for line in data:gmatch("[^\r\n]+") do
+        local matched = line:match("Server started on port:%s+(%d+)")
+        if matched ~= nil then
+          parsed_port = matched
+          vim.schedule(function()
+            state.settings.server.port = matched
+            state.go_server_running = true
+            if not callback_called then
+              callback_called = true
+              callback()
+            end
+          end)
+          break
         end
-        return agg
-      end, "")
-
-      if err_msg ~= "" then
-        u.notify(err_msg, vim.log.levels.ERROR)
       end
     end,
-    on_exit = function(job_id, exit_code)
-      if exit_code ~= 0 then
-        u.notify(
-          "Golang gitlab server exited: job_id: " .. job_id .. ", exit_code: " .. exit_code,
-          vim.log.levels.ERROR
-        )
+    stderr = function(_, data)
+      if data == nil or data == "" then
+        return
       end
+      stderr_buf = stderr_buf .. data
     end,
-  })
-  if job_id <= 0 then
-    u.notify("Could not start gitlab.nvim binary", vim.log.levels.ERROR)
+  }, function(out)
+    if out.code ~= 0 then
+      vim.schedule(function()
+        local msg = "Golang gitlab server exited: code: " .. out.code .. ", signal: " .. (out.signal or 0)
+        if stderr_buf ~= "" then
+          msg = msg .. ", msg: " .. vim.trim(stderr_buf)
+        end
+        u.notify(msg, vim.log.levels.ERROR)
+      end)
+    end
+  end)
+
+  if not ok then
+    u.notify("Could not start gitlab.nvim binary: " .. tostring(err), vim.log.levels.ERROR)
   end
 end