kevin/neovim
1
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2024-12-20 03:05:11 -07:00
Code Issues Packages Projects Releases Wiki Activity

Revert "refactor(lsp): simplify client tracking"

Browse Source 
This reverts commit 3f238b39cf.
This commit is contained in:
Lewis Russell 2024-03-25 20:16:42 +00:00
parent 2bcf88d354
commit 934f38682a
5 changed files with 198 additions and 164 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
runtime/doc/lsp.txt
View File

@ -907,8 +907,8 @@ stop_client({client_id}, {force}) *vim.lsp.stop_client()*
for this client, then force-shutdown is attempted.
Parameters: ~
• {client_id} (`integer|integer[]|vim.lsp.Client[]`) id, list of id's,
or list of |vim.lsp.Client| objects
• {client_id} (`integer|vim.lsp.Client`) id or |vim.lsp.Client| object,
or list thereof
• {force} (`boolean?`) shutdown forcefully
tagfunc({pattern}, {flags}) *vim.lsp.tagfunc()*

338
runtime/lua/vim/lsp.lua
View File

@ -1,5 +1,7 @@
local api = vim.api
local tbl_isempty, tbl_extend = vim.tbl_isempty, vim.tbl_extend
local validate = vim.validate
local if_nil = vim.F.if_nil
local lsp = vim._defer_require('vim.lsp', {
_changetracking = ..., --- @module 'vim.lsp._changetracking'
@ -106,7 +108,40 @@ function lsp._buf_get_line_ending(bufnr)
end
-- Tracks all clients created via lsp.start_client
local all_clients = {} --- @type table<integer,vim.lsp.Client>
local active_clients = {} --- @type table<integer,vim.lsp.Client>
local all_buffer_active_clients = {} --- @type table<integer,table<integer,true>>
local uninitialized_clients = {} --- @type table<integer,vim.lsp.Client>
---@param bufnr? integer
---@param fn fun(client: vim.lsp.Client, client_id: integer, bufnr: integer)
local function for_each_buffer_client(bufnr, fn, restrict_client_ids)
validate({
fn = { fn, 'f' },
restrict_client_ids = { restrict_client_ids, 't', true },
})
bufnr = resolve_bufnr(bufnr)
local client_ids = all_buffer_active_clients[bufnr]
if not client_ids or tbl_isempty(client_ids) then
return
end
if restrict_client_ids and #restrict_client_ids > 0 then
local filtered_client_ids = {} --- @type table<integer,true>
for client_id in pairs(client_ids) do
if vim.list_contains(restrict_client_ids, client_id) then
filtered_client_ids[client_id] = true
end
end
client_ids = filtered_client_ids
end
for client_id in pairs(client_ids) do
local client = active_clients[client_id]
if client then
fn(client, client_id, bufnr)
end
end
end
local client_errors_base = table.maxn(lsp.rpc.client_errors)
local client_errors_offset = 0
@ -121,7 +156,7 @@ end
--- Can be used to look up the string from a the number or the number
--- from the string.
--- @nodoc
lsp.client_errors = vim.tbl_extend(
lsp.client_errors = tbl_extend(
'error',
lsp.rpc.client_errors,
client_error('BEFORE_INIT_CALLBACK_ERROR'),
@ -223,10 +258,12 @@ function lsp.start(config, opts)
local bufnr = resolve_bufnr(opts.bufnr)
for _, client in pairs(all_clients) do
if reuse_client(client, config) then
lsp.buf_attach_client(bufnr, client.id)
return client.id
for _, clients in ipairs({ uninitialized_clients, lsp.get_clients() }) do
for _, client in pairs(clients) do
if reuse_client(client, config) then
lsp.buf_attach_client(bufnr, client.id)
return client.id
end
end
end
@ -348,11 +385,17 @@ end
--- @param client vim.lsp.Client
local function on_client_init(client)
local id = client.id
uninitialized_clients[id] = nil
-- Only assign after initialized.
active_clients[id] = client
-- If we had been registered before we start, then send didOpen This can
-- happen if we attach to buffers before initialize finishes or if
-- someone restarts a client.
for bufnr in pairs(client.attached_buffers) do
client:_on_attach(bufnr)
for bufnr, client_ids in pairs(all_buffer_active_clients) do
if client_ids[id] then
client.on_attach(bufnr)
end
end
end
@ -360,26 +403,28 @@ end
--- @param signal integer
--- @param client_id integer
local function on_client_exit(code, signal, client_id)
local client = all_clients[client_id]
local client = active_clients[client_id] or uninitialized_clients[client_id]
for bufnr in pairs(client.attached_buffers) do
vim.schedule(function()
if client and client.attached_buffers[bufnr] then
api.nvim_exec_autocmds('LspDetach', {
buffer = bufnr,
modeline = false,
data = { client_id = client_id },
})
end
for bufnr, client_ids in pairs(all_buffer_active_clients) do
if client_ids[client_id] then
vim.schedule(function()
if client and client.attached_buffers[bufnr] then
api.nvim_exec_autocmds('LspDetach', {
buffer = bufnr,
modeline = false,
data = { client_id = client_id },
})
end
local namespace = vim.lsp.diagnostic.get_namespace(client_id)
vim.diagnostic.reset(namespace, bufnr)
client.attached_buffers[bufnr] = nil
local namespace = vim.lsp.diagnostic.get_namespace(client_id)
vim.diagnostic.reset(namespace, bufnr)
if #lsp.get_clients({ bufnr = bufnr, _uninitialized = true }) == 0 then
reset_defaults(bufnr)
end
end)
client_ids[client_id] = nil
if vim.tbl_isempty(client_ids) then
reset_defaults(bufnr)
end
end)
end
end
local name = client.name or 'unknown'
@ -387,7 +432,8 @@ local function on_client_exit(code, signal, client_id)
-- Schedule the deletion of the client object so that it exists in the execution of LspDetach
-- autocommands
vim.schedule(function()
all_clients[client_id] = nil
active_clients[client_id] = nil
uninitialized_clients[client_id] = nil
-- Client can be absent if executable starts, but initialize fails
-- init/attach won't have happened
@ -420,12 +466,12 @@ function lsp.start_client(config)
end
--- @diagnostic disable-next-line: invisible
table.insert(client._on_init_cbs, 1, on_client_init)
table.insert(client._on_init_cbs, on_client_init)
--- @diagnostic disable-next-line: invisible
table.insert(client._on_exit_cbs, on_client_exit)
all_clients[client.id] = client
-- Store the uninitialized_clients for cleanup in case we exit before initialize finishes.
uninitialized_clients[client.id] = client
client:initialize()
@ -449,7 +495,7 @@ local function text_document_did_change_handler(
new_lastline
)
-- Detach (nvim_buf_attach) via returning True to on_lines if no clients are attached
if #lsp.get_clients({ bufnr = bufnr }) == 0 then
if tbl_isempty(all_buffer_active_clients[bufnr] or {}) then
return true
end
util.buf_versions[bufnr] = changedtick
@ -497,80 +543,6 @@ local function text_document_did_save_handler(bufnr)
end
end
--- @param bufnr integer
--- @param client_id integer
local function buf_attach(bufnr, client_id)
local uri = vim.uri_from_bufnr(bufnr)
local augroup = ('lsp_c_%d_b_%d_save'):format(client_id, bufnr)
local group = api.nvim_create_augroup(augroup, { clear = true })
api.nvim_create_autocmd('BufWritePre', {
group = group,
buffer = bufnr,
desc = 'vim.lsp: textDocument/willSave',
callback = function(ctx)
for _, client in ipairs(lsp.get_clients({ bufnr = ctx.buf })) do
local params = {
textDocument = {
uri = uri,
},
reason = protocol.TextDocumentSaveReason.Manual,
}
if vim.tbl_get(client.server_capabilities, 'textDocumentSync', 'willSave') then
client.notify(ms.textDocument_willSave, params)
end
if vim.tbl_get(client.server_capabilities, 'textDocumentSync', 'willSaveWaitUntil') then
local result, err =
client.request_sync(ms.textDocument_willSaveWaitUntil, params, 1000, ctx.buf)
if result and result.result then
util.apply_text_edits(result.result, ctx.buf, client.offset_encoding)
elseif err then
log.error(vim.inspect(err))
end
end
end
end,
})
api.nvim_create_autocmd('BufWritePost', {
group = group,
buffer = bufnr,
desc = 'vim.lsp: textDocument/didSave handler',
callback = function(ctx)
text_document_did_save_handler(ctx.buf)
end,
})
-- First time, so attach and set up stuff.
api.nvim_buf_attach(bufnr, false, {
on_lines = text_document_did_change_handler,
on_reload = function()
local params = { textDocument = { uri = uri } }
for _, client in ipairs(lsp.get_clients({ bufnr = bufnr })) do
changetracking.reset_buf(client, bufnr)
if vim.tbl_get(client.server_capabilities, 'textDocumentSync', 'openClose') then
client.notify(ms.textDocument_didClose, params)
end
client:_text_document_did_open_handler(bufnr)
end
end,
on_detach = function()
local params = { textDocument = { uri = uri } }
for _, client in ipairs(lsp.get_clients({ bufnr = bufnr })) do
changetracking.reset_buf(client, bufnr)
if vim.tbl_get(client.server_capabilities, 'textDocumentSync', 'openClose') then
client.notify(ms.textDocument_didClose, params)
end
end
for _, client in ipairs(all_clients) do
client.attached_buffers[bufnr] = nil
end
util.buf_versions[bufnr] = nil
end,
-- TODO if we know all of the potential clients ahead of time, then we
-- could conditionally set this.
-- utf_sizes = size_index > 1;
utf_sizes = true,
})
end
--- Implements the `textDocument/did…` notifications required to track a buffer
--- for any language server.
---
@ -589,26 +561,92 @@ function lsp.buf_attach_client(bufnr, client_id)
log.warn(string.format('buf_attach_client called on unloaded buffer (id: %d): ', bufnr))
return false
end
local buffer_client_ids = all_buffer_active_clients[bufnr]
-- This is our first time attaching to this buffer.
if #lsp.get_clients({ bufnr = bufnr, _uninitialized = true }) == 0 then
buf_attach(bufnr, client_id)
if not buffer_client_ids then
buffer_client_ids = {}
all_buffer_active_clients[bufnr] = buffer_client_ids
local uri = vim.uri_from_bufnr(bufnr)
local augroup = ('lsp_c_%d_b_%d_save'):format(client_id, bufnr)
local group = api.nvim_create_augroup(augroup, { clear = true })
api.nvim_create_autocmd('BufWritePre', {
group = group,
buffer = bufnr,
desc = 'vim.lsp: textDocument/willSave',
callback = function(ctx)
for _, client in ipairs(lsp.get_clients({ bufnr = ctx.buf })) do
local params = {
textDocument = {
uri = uri,
},
reason = protocol.TextDocumentSaveReason.Manual,
}
if vim.tbl_get(client.server_capabilities, 'textDocumentSync', 'willSave') then
client.notify(ms.textDocument_willSave, params)
end
if vim.tbl_get(client.server_capabilities, 'textDocumentSync', 'willSaveWaitUntil') then
local result, err =
client.request_sync(ms.textDocument_willSaveWaitUntil, params, 1000, ctx.buf)
if result and result.result then
util.apply_text_edits(result.result, ctx.buf, client.offset_encoding)
elseif err then
log.error(vim.inspect(err))
end
end
end
end,
})
api.nvim_create_autocmd('BufWritePost', {
group = group,
buffer = bufnr,
desc = 'vim.lsp: textDocument/didSave handler',
callback = function(ctx)
text_document_did_save_handler(ctx.buf)
end,
})
-- First time, so attach and set up stuff.
api.nvim_buf_attach(bufnr, false, {
on_lines = text_document_did_change_handler,
on_reload = function()
local params = { textDocument = { uri = uri } }
for _, client in ipairs(lsp.get_clients({ bufnr = bufnr })) do
changetracking.reset_buf(client, bufnr)
if vim.tbl_get(client.server_capabilities, 'textDocumentSync', 'openClose') then
client.notify(ms.textDocument_didClose, params)
end
client:_text_document_did_open_handler(bufnr)
end
end,
on_detach = function()
local params = { textDocument = { uri = uri } }
for _, client in ipairs(lsp.get_clients({ bufnr = bufnr })) do
changetracking.reset_buf(client, bufnr)
if vim.tbl_get(client.server_capabilities, 'textDocumentSync', 'openClose') then
client.notify(ms.textDocument_didClose, params)
end
client.attached_buffers[bufnr] = nil
end
util.buf_versions[bufnr] = nil
all_buffer_active_clients[bufnr] = nil
end,
-- TODO if we know all of the potential clients ahead of time, then we
-- could conditionally set this.
-- utf_sizes = size_index > 1;
utf_sizes = true,
})
end
local client = lsp.get_client_by_id(client_id)
if not client then
return false
end
if client.attached_buffers[bufnr] then
if buffer_client_ids[client_id] then
return true
end
client.attached_buffers[bufnr] = true
-- This is our first time attaching this client to this buffer.
buffer_client_ids[client_id] = true
local client = active_clients[client_id]
-- Send didOpen for the client if it is initialized. If it isn't initialized
-- then it will send didOpen on initialize.
if client.initialized then
if client then
client:_on_attach(bufnr)
end
return true
@ -627,7 +665,7 @@ function lsp.buf_detach_client(bufnr, client_id)
})
bufnr = resolve_bufnr(bufnr)
local client = all_clients[client_id]
local client = lsp.get_client_by_id(client_id)
if not client or not client.attached_buffers[bufnr] then
vim.notify(
string.format(
@ -656,6 +694,11 @@ function lsp.buf_detach_client(bufnr, client_id)
client.attached_buffers[bufnr] = nil
util.buf_versions[bufnr] = nil
all_buffer_active_clients[bufnr][client_id] = nil
if #vim.tbl_keys(all_buffer_active_clients[bufnr]) == 0 then
all_buffer_active_clients[bufnr] = nil
end
local namespace = lsp.diagnostic.get_namespace(client_id)
vim.diagnostic.reset(namespace, bufnr)
end
@ -665,7 +708,7 @@ end
---@param bufnr (integer) Buffer handle, or 0 for current
---@param client_id (integer) the client id
function lsp.buf_is_attached(bufnr, client_id)
return lsp.get_clients({ bufnr = bufnr, id = client_id, _uninitialized = true })[1] ~= nil
return (all_buffer_active_clients[resolve_bufnr(bufnr)] or {})[client_id] == true
end
--- Gets a client by id, or nil if the id is invalid.
@ -675,7 +718,7 @@ end
---
---@return (nil|vim.lsp.Client) client rpc object
function lsp.get_client_by_id(client_id)
return all_clients[client_id]
return active_clients[client_id] or uninitialized_clients[client_id]
end
--- Returns list of buffers attached to client_id.
@ -683,7 +726,7 @@ end
---@param client_id integer client id
---@return integer[] buffers list of buffer ids
function lsp.get_buffers_by_client_id(client_id)
local client = all_clients[client_id]
local client = lsp.get_client_by_id(client_id)
return client and vim.tbl_keys(client.attached_buffers) or {}
end
@ -699,22 +742,17 @@ end
--- By default asks the server to shutdown, unless stop was requested
--- already for this client, then force-shutdown is attempted.
---
---@param client_id integer|integer[]|vim.lsp.Client[] id, list of id's, or list of |vim.lsp.Client| objects
---@param force? boolean shutdown forcefully
---@param client_id integer|vim.lsp.Client id or |vim.lsp.Client| object, or list thereof
---@param force boolean|nil shutdown forcefully
function lsp.stop_client(client_id, force)
--- @type integer[]|vim.lsp.Client[]
local ids = type(client_id) == 'table' and client_id or { client_id }
for _, id in ipairs(ids) do
if type(id) == 'table' then
if id.stop then
id.stop(force)
end
else
--- @cast id -vim.lsp.Client
local client = all_clients[id]
if client then
client.stop(force)
end
if type(id) == 'table' and id.stop ~= nil then
id.stop(force)
elseif active_clients[id] then
active_clients[id].stop(force)
elseif uninitialized_clients[id] then
uninitialized_clients[id].stop(true)
end
end
end
@ -734,9 +772,6 @@ end
---
--- Only return clients supporting the given method
--- @field method? string
---
--- Also return uninitialized clients.
--- @field package _uninitialized? boolean
--- Get active clients.
---
@ -749,16 +784,15 @@ function lsp.get_clients(filter)
local clients = {} --- @type vim.lsp.Client[]
local bufnr = filter.bufnr and resolve_bufnr(filter.bufnr)
for _, client in pairs(all_clients) do
local t = filter.bufnr and (all_buffer_active_clients[resolve_bufnr(filter.bufnr)] or {})
or active_clients
for client_id in pairs(t) do
local client = active_clients[client_id]
if
client
and (filter.id == nil or client.id == filter.id)
and (filter.bufnr == nil or client.attached_buffers[bufnr])
and (filter.name == nil or client.name == filter.name)
and (filter.method == nil or client.supports_method(filter.method, { bufnr = filter.bufnr }))
and (filter._uninitialized or client.initialized)
then
clients[#clients + 1] = client
end
@ -776,9 +810,15 @@ end
api.nvim_create_autocmd('VimLeavePre', {
desc = 'vim.lsp: exit handler',
callback = function()
local active_clients = lsp.get_clients()
log.info('exit_handler', active_clients)
for _, client in pairs(all_clients) do
for _, client in pairs(uninitialized_clients) do
client.stop(true)
end
-- TODO handle v:dying differently?
if tbl_isempty(active_clients) then
return
end
for _, client in pairs(active_clients) do
client.stop()
end
@ -787,7 +827,7 @@ api.nvim_create_autocmd('VimLeavePre', {
local send_kill = false
for client_id, client in pairs(active_clients) do
local timeout = client.flags.exit_timeout
local timeout = if_nil(client.flags.exit_timeout, false)
if timeout then
send_kill = true
timeouts[client_id] = timeout
@ -870,7 +910,7 @@ function lsp.buf_request(bufnr, method, params, handler)
local function _cancel_all_requests()
for client_id, request_id in pairs(client_request_ids) do
local client = all_clients[client_id]
local client = active_clients[client_id]
client.cancel_request(request_id)
end
end
@ -1066,7 +1106,7 @@ end
---@return boolean stopped true if client is stopped, false otherwise.
function lsp.client_is_stopped(client_id)
assert(client_id, 'missing client_id param')
return not all_clients[client_id]
return active_clients[client_id] == nil and not uninitialized_clients[client_id]
end
--- Gets a map of client_id:client pairs for the given buffer, where each value
@ -1132,11 +1172,7 @@ function lsp.for_each_buffer_client(bufnr, fn)
'lsp.get_clients({ bufnr = bufnr }) with regular loop',
'0.12'
)
bufnr = resolve_bufnr(bufnr)
for _, client in pairs(lsp.get_clients({ bufnr = bufnr })) do
fn(client, client.id, bufnr)
end
return for_each_buffer_client(bufnr, fn)
end
--- Function to manage overriding defaults for LSP handlers.

2
runtime/lua/vim/lsp/client.lua
View File

@ -761,7 +761,7 @@ function Client:_request_sync(method, params, timeout_ms, bufnr)
return request_result
end
--- @package
--- @private
--- Sends a notification to an LSP server.
---
--- @param method string LSP method name.

2
test/functional/fixtures/fake-lsp-server.lua
View File

@ -983,7 +983,7 @@ local test_name = arg[1]
local timeout = arg[2]
assert(type(test_name) == 'string', 'test_name must be specified as first arg.')
local kill_timer = assert(vim.uv.new_timer())
local kill_timer = vim.uv.new_timer()
kill_timer:start(timeout or 1e3, 0, function()
kill_timer:stop()
kill_timer:close()

16
test/functional/plugin/lsp_spec.lua
View File

@ -282,7 +282,8 @@ describe('LSP', function()
local client
test_rpc_server {
test_name = 'basic_finish',
on_setup = function()
on_init = function(_client)
client = _client
exec_lua [[
BUFFER = vim.api.nvim_create_buf(false, true)
]]
@ -291,9 +292,6 @@ describe('LSP', function()
exec_lua [[
vim.api.nvim_command(BUFFER.."bwipeout")
]]
end,
on_init = function(_client)
client = _client
client.notify('finish')
end,
on_exit = function(code, signal)
@ -808,12 +806,14 @@ describe('LSP', function()
BUFFER = vim.api.nvim_get_current_buf()
lsp.buf_attach_client(BUFFER, TEST_RPC_CLIENT_ID)
vim.lsp.handlers['textDocument/typeDefinition'] = function() end
vim.cmd(BUFFER.."bwipeout")
]=])
end,
on_init = function(client)
client.stop()
exec_lua('vim.lsp.buf.type_definition()')
exec_lua [[
vim.api.nvim_command(BUFFER.."bwipeout")
]]
end,
on_exit = function(code, signal)
eq(0, code, 'exit code')
@ -1058,7 +1058,8 @@ describe('LSP', function()
local client
test_rpc_server {
test_name = 'basic_finish',
on_setup = function()
on_init = function(_client)
client = _client
exec_lua [[
BUFFER = vim.api.nvim_create_buf(false, true)
vim.api.nvim_buf_set_lines(BUFFER, 0, -1, false, {
@ -1072,9 +1073,6 @@ describe('LSP', function()
exec_lua [[
vim.api.nvim_command(BUFFER.."bwipeout")
]]
end,
on_init = function(_client)
client = _client
local full_kind = exec_lua("return require'vim.lsp.protocol'.TextDocumentSyncKind.Full")
eq(full_kind, client.server_capabilities().textDocumentSync.change)
eq(true, client.server_capabilities().textDocumentSync.openClose)