feat(lsp_status): use vim.loop.hrtime on older nvim versions (#1391)

* feat(lsp_status): use vim.loop.hrtime when vim.uv.hrtime is not supported.

There's no need to do custom approximations when vim.uv.hrtime is not
available, because vim.loop.hrtime should work on older nvim versions
(see neovim/neovim#22846).

* fix(lsp_stauts): don't append space if empty progress symbol

* fix(lsp_status): improve readibility with parantheses around LSP name formatting

Author: andreihh

lua/lualine/components/lsp_status.lua

@@ -14,19 +14,6 @@ local default_options = {
   ignore_lsp = {},
 }
 
----Advances the spinner every 80ms (or just once if precise time measurement is not supported) and returns the new
----spinner symbol.
-function M:__advance_spinner()
-  if vim.uv then
-    self.__spinner_index = math.floor(vim.uv.hrtime() / (1e6 * 80))
-  else
-    self.__spinner_index = (self.__spinner_index or 0) + 1
-  end
-  self.__spinner_index = self.__spinner_index % #self.symbols.spinner
-  -- The spinner symbols table is 1-indexed.
-  return self.symbols.spinner[self.__spinner_index + 1]
-end
-
 function M:init(options)
   -- Run `super()`.
   M.super.init(self, options)
@@ -65,20 +52,18 @@ function M:init(options)
 end
 
 function M:update_status()
-  local bufnr = vim.api.nvim_get_current_buf()
   local result = {}
 
-  -- Retrieve the active LSPs in the current buffer in a backwards-compatible way.
-  local clients
-  if vim.lsp.get_clients then
-    clients = vim.lsp.get_clients { bufnr = bufnr }
-  else
-    ---@diagnostic disable-next-line: deprecated
-    clients = vim.lsp.get_active_clients { bufnr = bufnr }
-  end
+  -- Backwards-compatible function to get the active LSP clients.
+  ---@diagnostic disable-next-line: deprecated
+  local get_lsp_clients = vim.lsp.get_clients or vim.lsp.get_active_clients
+  local clients = get_lsp_clients { bufnr = vim.api.nvim_get_current_buf() }
 
-  -- Advance the spinner only once, not for each client (otherwise the spinners will skip steps).
-  local spinner_symbol = self:__advance_spinner()
+  -- Backwards-compatible function to get the current time in nanoseconds.
+  local hrtime = (vim.uv or vim.loop).hrtime
+  -- Advance the spinner every 80ms only once, not for each client (otherwise the spinners will skip steps).
+  -- NOTE: the spinner symbols table is 1-indexed.
+  local spinner_symbol = self.symbols.spinner[math.floor(hrtime() / (1e6 * 80)) % #self.symbols.spinner + 1]
 
   for _, client in ipairs(clients) do
     local status
@@ -91,10 +76,9 @@ function M:update_status()
 
     -- Backwards-compatible function to check if a list contains a value.
     local list_contains = vim.list_contains or vim.tbl_contains
-
     -- Append the status to the LSP only if it supports progress reporting and is not ignored.
     if not list_contains(self.options.ignore_lsp, client.name) then
-      table.insert(result, client.name .. (status and ' ' .. status or ''))
+      table.insert(result, client.name .. ((status and status ~= '') and (' ' .. status) or ''))
     end
   end
   return table.concat(result, self.symbols.separator)

tests/spec/component_spec.lua

@@ -931,13 +931,17 @@ describe('lsp_status component', function()
     assert_comp_ins(lsp_status_comp, ' lua_ls')
   end)
 
-  it('shows LSP progress when supported with precise time measurement', function()
+  it('shows LSP progress when supported', function()
     vim.cmd('edit ' .. file)
     stub(vim.lsp, 'get_clients')
     vim.lsp.get_clients.on_call_with({ bufnr = vim.api.nvim_get_current_buf() }).returns { { id = 2, name = 'lua_ls' } }
-    vim.uv = vim.uv or {}
-    stub(vim.uv, 'hrtime')
-    vim.uv.hrtime.on_call_with().returns(12 * 1e6 * 80)
+    if vim.uv and vim.uv.hrtime then
+      stub(vim.uv, 'hrtime')
+      vim.uv.hrtime.on_call_with().returns(12 * 1e6 * 80)
+    elseif vim.loop and vim.loop.hrtime then
+      stub(vim.loop, 'hrtime')
+      vim.loop.hrtime.on_call_with().returns(12 * 1e6 * 80)
+    end
 
     local ok = pcall(vim.api.nvim_exec_autocmds, 'LspProgress', {
       data = { client_id = 2, params = { value = { kind = 'begin' } } },
@@ -950,24 +954,24 @@ describe('lsp_status component', function()
     end
   end)
 
-  it('shows LSP progress when supported without precise time measurement', function()
+  it('shows LSP done when supported', function()
     vim.cmd('edit ' .. file)
     stub(vim.lsp, 'get_clients')
     vim.lsp.get_clients.on_call_with({ bufnr = vim.api.nvim_get_current_buf() }).returns { { id = 2, name = 'lua_ls' } }
-    vim.uv = nil
 
     local ok = pcall(vim.api.nvim_exec_autocmds, 'LspProgress', {
       data = { client_id = 2, params = { value = { kind = 'begin' } } },
+    }) and pcall(vim.api.nvim_exec_autocmds, 'LspProgress', {
+      data = { client_id = 2, params = { value = { kind = 'end' } } },
     })
 
     -- Skip assertion if LSP progress updates are not supported by the current `nvim` version.
     if ok then
-      -- We start from 0 and advanced by 1, so use spinner symbol 1.
-      assert_comp_ins(lsp_status_comp, ' lua_ls ⠙')
+      assert_comp_ins(lsp_status_comp, ' lua_ls ✓')
     end
   end)
 
-  it('shows LSP progress when supported with precise time measurement', function()
+  it('shows LSP done when supported and no begin', function()
     vim.cmd('edit ' .. file)
     stub(vim.lsp, 'get_clients')
     vim.lsp.get_clients.on_call_with({ bufnr = vim.api.nvim_get_current_buf() }).returns { { id = 2, name = 'lua_ls' } }
@@ -982,7 +986,11 @@ describe('lsp_status component', function()
     end
   end)
 
-  it('shows LSP done when supported', function()
+  it('does not add unnecessary space separator when LSP progress symbol is empty', function()
+    local opts_no_done = opts
+    opts_no_done.symbols = { done = '' }
+    local lsp_status_comp_no_done = helpers.init_component('lsp_status', opts)
+
     vim.cmd('edit ' .. file)
     stub(vim.lsp, 'get_clients')
     vim.lsp.get_clients.on_call_with({ bufnr = vim.api.nvim_get_current_buf() }).returns { { id = 2, name = 'lua_ls' } }
@@ -995,7 +1003,7 @@ describe('lsp_status component', function()
 
     -- Skip assertion if LSP progress updates are not supported by the current `nvim` version.
     if ok then
-      assert_comp_ins(lsp_status_comp, ' lua_ls ✓')
+      assert_comp_ins(lsp_status_comp_no_done, ' lua_ls')
     end
   end)
 end)