fix download server async

Author: joaopluigi

lua/eca/path_finder.lua

@@ -1,5 +1,6 @@
 local uv = vim.uv or vim.loop
 local Utils = require("eca.utils")
+local Config = require("eca.config")
 local Logger = require("eca.logger")
 
 ---@class eca.PathFinder
@@ -184,15 +185,7 @@ function M:_download_latest_server(server_path, version)
 end
 
 ---@return string
-function M:find(custom_path)
-  -- Check for custom server path first
-  if custom_path and custom_path:gsub("%s+", "") ~= "" then
-    if not Utils.file_exists(custom_path) then
-      error("Custom server path does not exist: " .. custom_path)
-    end
-    return custom_path
-  end
-
+function M:find()
   local server_path = self:_get_extension_server_path()
   local latest_version = self:_get_latest_version()
   local current_version = self:_read_version_file()

lua/eca/server.lua

@@ -91,6 +91,61 @@ local function on_stderr(err, data)
   end
 end
 
+---@class eca.ServerStartOpts: vim.SystemOpts
+---@field cmd string[] The command to pass to vim.system
+---@field on_exit fun(out: vim.SystemCompleted) callback to pass to vim.system
+---@field initialize boolean Send the initialize message to ECA on startup, used
+---in testing
+---@param opts? eca.ServerStartOpts
+function M:_run(server_path, opts)
+  Logger.debug("Starting ECA server: " .. server_path)
+
+  local args = { server_path, "server" }
+
+  if Config.server_args and Config.server_args ~= "" then
+    vim.list_extend(args, vim.split(Config.server_args, " "))
+  end
+
+  opts = vim.tbl_deep_extend("keep", opts, {
+    cmd = args,
+    text = true,
+    cwd = self.cwd,
+    stdin = true,
+    stdout = on_stdout(self),
+    stderr = on_stderr,
+    ---@param out vim.SystemCompleted
+    on_exit = function(out)
+      if out.code ~= 0 then
+        require("eca.logger").notify(string.format("Server exited with status code %d", out.code), vim.log.levels
+        .ERROR)
+      end
+    end,
+  })
+
+  local started, process_or_err = pcall(vim.system, opts.cmd, {
+    cwd = opts.cwd,
+    text = opts.text,
+    stdin = opts.stdin,
+    stdout = opts.stdout,
+    stderr = opts.stderr,
+  }, opts.on_exit)
+
+  if not started then
+    self.process = nil
+    Logger.notify(vim.inspect(process_or_err), vim.log.levels.ERROR)
+    return
+  end
+
+  self.process = process_or_err
+  if self.on_start then
+    self.on_start(process_or_err.pid)
+  end
+
+  if opts.initialize then
+    self:initialize()
+  end
+end
+
 ---@class eca.ServerStartOpts: vim.SystemOpts
 ---@field cmd string[] The command to pass to vim.system
 ---@field on_exit fun(out: vim.SystemCompleted) callback to pass to vim.system
@@ -100,6 +155,18 @@ end
 function M:start(opts)
   opts = vim.tbl_deep_extend("force", { initialize = true }, opts or {})
 
+  -- Check for custom server path first
+  local custom_path = Config.server_path
+  if custom_path and custom_path:gsub("%s+", "") ~= "" then
+    if not Utils.file_exists(custom_path) then
+      Logger.notify("Custom server path does not exist: " .. custom_path, vim.log.levels.ERROR)
+      return
+    end
+
+    self:_run(custom_path, opts)
+    return
+  end
+
   local this_file = debug.getinfo(1, "S").source:sub(2)
   local proj_root = vim.fn.fnamemodify(this_file, ":p:h:h:h")
   local script_path = proj_root .. "/scripts/server_path.lua"
@@ -110,9 +177,7 @@ function M:start(opts)
     nvim_exe = "nvim"
   end
 
-  local lua_cmd = string.format("lua ServerPath.run(%s)", Utils.lua_quote(Config.server_path or ""))
-
-  local cmd = { nvim_exe, "--headless", "--noplugin", (opts.clean and " --clean" or ""), "-u", script_path, "-c", lua_cmd }
+  local cmd = { nvim_exe, "--headless", "-S", script_path }
 
   vim.system(cmd, { text = true }, function(out)
     if out.code ~= 0 then
@@ -123,52 +188,7 @@ function M:start(opts)
     local stdout_lines = Utils.split_lines(out.stdout)
     local server_path = stdout_lines[#stdout_lines]
 
-    Logger.debug("Starting ECA server: " .. server_path)
-
-    local args = { server_path, "server" }
-
-    if Config.server_args and Config.server_args ~= "" then
-      vim.list_extend(args, vim.split(Config.server_args, " "))
-    end
-
-    opts = vim.tbl_deep_extend("keep", opts, {
-      cmd = args,
-      text = true,
-      cwd = self.cwd,
-      stdin = true,
-      stdout = on_stdout(self),
-      stderr = on_stderr,
-      ---@param output vim.SystemCompleted
-      on_exit = function(output)
-        if output.code ~= 0 then
-          require("eca.logger").notify(string.format("Server exited with status code %d", output.code), vim.log.levels
-          .ERROR)
-        end
-      end,
-    })
-
-    local started, process_or_err = pcall(vim.system, opts.cmd, {
-      cwd = opts.cwd,
-      text = opts.text,
-      stdin = opts.stdin,
-      stdout = opts.stdout,
-      stderr = opts.stderr,
-    }, opts.on_exit)
-
-    if not started then
-      self.process = nil
-      Logger.notify(vim.inspect(process_or_err), vim.log.levels.ERROR)
-      return
-    end
-
-    self.process = process_or_err
-    if self.on_start then
-      self.on_start(process_or_err.pid)
-    end
-
-    if opts.initialize then
-      self:initialize()
-    end
+    self:_run(server_path, opts)
   end)
 end
 

scripts/server_path.lua

@@ -1,39 +1,42 @@
-local ServerPath = {}
-
 -- Setup if headless
 if #vim.api.nvim_list_uis() == 0 then
-  _G.ServerPath = ServerPath
-
   -- hijack to make server tests work on CI using --clean mode
-  local eca_available = pcall(require, "eca")
-  if not eca_available then
+  local ok = pcall(require, "eca")
+  if not ok then
     vim.cmd([[let &rtp.=','.getcwd()]])
     vim.cmd('set rtp+=deps/nui.nvim')
     vim.cmd('set rtp+=deps/eca-nvim')
+
+    local try_again, err = pcall(require, "eca")
+    if not try_again then
+      error("Could not load eca.nvim: " .. tostring(err))
+      os.exit(1)
+    end
   end
 
   vim.o.swapfile = false
   vim.o.backup = false
   vim.o.writebackup = false
-
-  require("eca").setup({})
 end
 
-ServerPath.run = function(custom_path)
-  local path_finder = require("eca.path_finder"):new()
-  local path
+local path_finder, path_finder_or_err = pcall(require, "eca.path_finder")
 
-  local ok, err = pcall(function()
-    path = path_finder:find(custom_path)
-  end)
+if not path_finder then
+  io.stderr:write("Could not load eca.path_finder: " .. tostring(path_finder_or_err))
+  os.exit(1)
+end
 
-  if not ok then
-    io.stderr:write(tostring(err))
-    os.exit(1)
-  end
+local PathFinder = path_finder_or_err:new()
+local path
+
+local ok, err = pcall(function()
+  path = PathFinder:find()
+end)
 
-  io.stdout:write(tostring(path))
-  os.exit(0)
+if not ok then
+  io.stderr:write(tostring(err))
+  os.exit(1)
 end
 
-return ServerPath
+io.stdout:write(tostring(path))
+os.exit(0)

tests/test_server_integration.lua

@@ -40,7 +40,7 @@ end
 T["server"] = MiniTest.new_set()
 
 T["server"]["start"] = function()
-  child.lua("_G.server:start({ clean = true })")
+  child.lua("_G.server:start()")
   child.lua([[
     _G.server_started = vim.wait(10000, function()
       return _G.server and _G.server:is_running()
@@ -52,7 +52,7 @@ T["server"]["start"] = function()
 end
 
 T["server"]["start without initialize"] = function()
-  child.lua("_G.server:start({ clean = true, initialize = false })")
+  child.lua("_G.server:start({ initialize = false })")
   child.lua([[
     _G.server_started = vim.wait(10000, function()
       return _G.server and _G.server:is_running()
@@ -65,18 +65,20 @@ end
 
 T["server"]["start with inexistent path"] = function()
   child.lua([[
-    Config = require("eca.config")
-    Config.setup({ server_path = "non-existing-path" } )
-    _G.server:start({ clean = true })
+    _G.config = require("eca.config")
+    _G.config.setup({ server_path = "non-existing-path" })
+    _G.server:start()
   ]])
   child.lua([[
     _G.server_started = vim.wait(1000, function()
       return _G.server and _G.server:is_running()
     end, 100)
   ]])
-  eq(string.find(child.lua_get("_G.notifications[1].message"), "non-existing-path", 1 , true) ~= nil, true)
+
   eq(child.lua_get("_G.server_started"), false)
+  sleep(1000)
   eq(child.lua_get("_G.server.initialized"), false)
+  eq(string.find(child.lua_get("_G.notifications[1].message"), "non-existing-path", 1 , true) ~= nil, true)
 end
 
 return T

tests/test_server_path.lua

@@ -8,26 +8,35 @@ local function setup_test_environment()
     return {
       "nvim",
       "--headless",
-      "--noplugin",
-      "--clean",
       "--cmd",
-      [[lua package.preload["eca.path_finder"] = function()
-        local M = {}
-        function M.new()
-          return setmetatable({}, { __index = M })
+      string.format([[lua
+        package.preload["eca.config"] = function()
+          local M = {}
+          M.server_path = %q
+          return M
         end
-        function M:find(custom_path)
-          if custom_path == "error" then
-            error("custom-server-path-error")
+      ]], custom_path or ""),
+      "--cmd",
+      [[lua
+        package.preload["eca.path_finder"] = function()
+          local M = {}
+          function M.new()
+            return setmetatable({}, { __index = M })
+          end
+          function M:find()
+            Config = require("eca.config")
+            local custom_path = Config.server_path
+
+            if custom_path == "error" then
+              error("custom-server-path-error")
+            end
+            return (custom_path ~= "" and custom_path) or "no-custom-server-path"
           end
-          return (custom_path ~= "" and custom_path) or "no-custom-server-path"
+          return M
         end
-        return M
-      end]],
-      "-u",
+      ]],
+      "-S",
       "scripts/server_path.lua",
-      "-c",
-      string.format("lua ServerPath.run(%s)", Utils.lua_quote(custom_path or "")),
     }
   end
 end