Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

perf: optimize target_arch switching #548

Merged
merged 9 commits into from
Oct 28, 2024
110 changes: 36 additions & 74 deletions lua/rustaceanvim/lsp/init.lua
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,6 @@ local server_status = require('rustaceanvim.server_status')
local cargo = require('rustaceanvim.cargo')
local os = require('rustaceanvim.os')

---Local rustc targets cache
local rustc_targets_cache = nil

local function override_apply_text_edits()
local old_func = vim.lsp.util.apply_text_edits
---@diagnostic disable-next-line
Expand Down Expand Up @@ -96,42 +93,13 @@ local function configure_file_watcher(server_cfg)
end
end

---Handles retrieving rustc target architectures and running the passed in callback
---to perform certain actions using the retrieved targets.
---@param callback fun(targets: string[])
local function with_rustc_target_architectures(callback)
if rustc_targets_cache then
return callback(rustc_targets_cache)
end
vim.system(
{ 'rustc', '--print', 'target-list' },
{ text = true },
---@param result vim.SystemCompleted
function(result)
if result.code ~= 0 then
error('Failed to retrieve rustc targets: ' .. result.stderr)
end
rustc_targets_cache = vim.iter(result.stdout:gmatch('[^\r\n]+')):fold(
{},
---@param acc table<string, boolean>
---@param target string
function(acc, target)
acc[target] = true
return acc
end
)
return callback(rustc_targets_cache)
end
)
end

---LSP restart internal implementations
---@param bufnr? number
---@param exclude_rustc_target? string Optional target architecture. Clients with target won't be restarted.
---@param callback? fun(client: vim.lsp.Client) Optional callback to run for each client before restarting.
---@return number|nil client_id
local function restart(bufnr, callback)
bufnr = bufnr or vim.api.nvim_get_current_buf()
local clients = M.stop(bufnr)
local function restart(exclude_rustc_target, callback)
local bufnr = vim.api.nvim_get_current_buf()
local clients = M.stop(bufnr, exclude_rustc_target)
local timer, _, _ = vim.uv.new_timer()
if not timer then
vim.notify('Failed to init timer for LSP client restart.', vim.log.levels.ERROR)
Expand Down Expand Up @@ -285,10 +253,11 @@ end

---Stop the LSP client.
---@param bufnr? number The buffer number, defaults to the current buffer
---@param exclude_rustc_target? string Optional target architecture. Clients with target won't be stopped.
---@return vim.lsp.Client[] clients A list of clients that will be stopped
M.stop = function(bufnr)
M.stop = function(bufnr, exclude_rustc_target)
bufnr = bufnr or vim.api.nvim_get_current_buf()
local clients = rust_analyzer.get_active_rustaceanvim_clients(bufnr)
local clients = rust_analyzer.get_active_rustaceanvim_clients(bufnr, { exclude_rustc_target = exclude_rustc_target })
vim.lsp.stop_client(clients)
if type(clients) == 'table' then
---@cast clients vim.lsp.Client[]
Expand All @@ -303,10 +272,9 @@ M.stop = function(bufnr)
end

---Reload settings for the LSP client.
---@param bufnr? number The buffer number, defaults to the current buffer
---@return vim.lsp.Client[] clients A list of clients that will be have their settings reloaded
M.reload_settings = function(bufnr)
bufnr = bufnr or vim.api.nvim_get_current_buf()
M.reload_settings = function()
local bufnr = vim.api.nvim_get_current_buf()
local clients = rust_analyzer.get_active_rustaceanvim_clients(bufnr)
---@cast clients vim.lsp.Client[]
for _, client in ipairs(clients) do
Expand All @@ -320,44 +288,31 @@ M.reload_settings = function(bufnr)
return clients
end

---Updates the target architecture setting for the LSP client associated with the given buffer.
---@param bufnr? number The buffer number, defaults to the current buffer
---@param target? string The target architecture. Defaults to nil(the current buffer's target if not provided).
M.set_target_arch = function(bufnr, target)
---Updates LSP client target architecture setting.
---@param target_arch? string string The target architecture, defaults to the current buffer's target if not provided.
M.set_target_arch = function(target_arch)
-- Load target architectures if not already available
if not rust_analyzer.rustc_target_archs or rust_analyzer.os_rustc_target then
rust_analyzer.load_target_archs()
end
target_arch = target_arch or rust_analyzer.os_rustc_target
if not rust_analyzer.rustc_target_archs[target_arch] then
vim.notify('Invalid target architecture provided: ' .. tostring(target_arch), vim.log.levels.ERROR)
return
end
mrcjkb marked this conversation as resolved.
Show resolved Hide resolved
---@param client vim.lsp.Client
restart(bufnr, function(client)
-- Get current user's rust-analyzer target
local current_target = vim.tbl_get(client, 'config', 'settings', 'rust-analyzer', 'cargo', 'target')

if not target then
if not current_target then
vim.notify('Using default OS target architecture.', vim.log.levels.INFO)
else
vim.notify('Target architecture is already set to the default OS target.', vim.log.levels.INFO)
end
return
end

with_rustc_target_architectures(function(rustc_targets)
if target == nil or rustc_targets[target] then
client.settings['rust-analyzer'].cargo.target = target
client.notify('workspace/didChangeConfiguration', { settings = client.config.settings })
vim.notify('Target architecture updated successfully to: ' .. target, vim.log.levels.INFO)
return
else
vim.notify('Invalid target architecture provided: ' .. tostring(target), vim.log.levels.ERROR)
return
end
end)
restart(target_arch, function(client)
client.settings['rust-analyzer'].cargo.target = target_arch
client.notify('workspace/didChangeConfiguration', { settings = client.config.settings })
vim.notify('Target architecture updated successfully to: ' .. target_arch, vim.log.levels.INFO)
end)
end

---Restart the LSP client.
---Fails silently if the buffer's filetype is not one of the filetypes specified in the config.
---@param bufnr? number The buffer number (optional), defaults to the current buffer
mrcjkb marked this conversation as resolved.
Show resolved Hide resolved
---@return number|nil client_id The LSP client ID after restart
M.restart = function(bufnr)
M.restart(bufnr)
M.restart = function()
return restart()
end

---@enum RustAnalyzerCmd
Expand All @@ -372,7 +327,6 @@ local RustAnalyzerCmd = {
local function rust_analyzer_cmd(opts)
local fargs = opts.fargs
local cmd = fargs[1]
local arch = fargs[2]
---@cast cmd RustAnalyzerCmd
if cmd == RustAnalyzerCmd.start then
M.start()
Expand All @@ -383,7 +337,8 @@ local function rust_analyzer_cmd(opts)
elseif cmd == RustAnalyzerCmd.reload_settings then
M.reload_settings()
elseif cmd == RustAnalyzerCmd.target then
M.set_target_arch(nil, arch)
local target_arch = fargs[2]
M.set_target_arch(target_arch)
end
end

Expand All @@ -402,4 +357,11 @@ vim.api.nvim_create_user_command('RustAnalyzer', rust_analyzer_cmd, {
end,
})

vim.api.nvim_create_autocmd('BufEnter', {
once = true,
callback = function()
rust_analyzer.load_target_archs()
end,
})

return M
71 changes: 67 additions & 4 deletions lua/rustaceanvim/rust_analyzer.lua
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,81 @@ local os = require('rustaceanvim.os')
---@class rustaceanvim.rust-analyzer.ClientAdapter
local M = {}

---Local OS rustc target architecture
M.os_rustc_target_arch = nil
---Local rustc target architectures
M.rustc_target_archs = nil

local load_os_rustc_target_arch = function()
vim.system(
{ 'rustc', '-Vv' },
{ text = true },
---@param result vim.SystemCompleted
function(result)
if result.code ~= 0 then
error('Failed to retrieve OS rustc target: ' .. result.stderr)
end
for line in result.stdout:gmatch('[^\r\n]+') do
local host = line:match('^host:%s*(.+)$')
if host then
M.os_rustc_target = host
break
end
end
end
)
end

local load_rustc_target_archs = function()
vim.system(
{ 'rustc', '--print', 'target-list' },
{ text = true },
---@param result vim.SystemCompleted
function(result)
if result.code ~= 0 then
error('Failed to retrieve rustc targets: ' .. result.stderr)
end
M.rustc_target_archs = vim.iter(result.stdout:gmatch('[^\r\n]+')):fold({}, function(acc, target)
acc[target] = true
return acc
end)
end
)
end

M.load_target_archs = function()
load_os_rustc_target_arch()
load_rustc_target_archs()
end

---@class rustaceanvim.lsp.get_clients.Filter: vim.lsp.get_clients.Filter
---@field exclude_rustc_target? string Optional cargo target to filter rust-analyzer clients

---@param bufnr number | nil 0 for the current buffer, `nil` for no buffer filter
---@param filter? vim.lsp.get_clients.Filter
---@param filter? rustaceanvim.lsp.get_clients.Filter
---@return vim.lsp.Client[]
M.get_active_rustaceanvim_clients = function(bufnr, filter)
---@type vim.lsp.get_clients.Filter
filter = vim.tbl_deep_extend('force', filter or {}, {
local client_filter = vim.tbl_deep_extend('force', filter or {}, {
name = 'rust-analyzer',
})
if bufnr then
filter.bufnr = bufnr
client_filter.bufnr = bufnr
end
local clients = vim.lsp.get_clients(client_filter)
if filter and filter.exclude_rustc_target then
clients = vim.tbl_filter(function(client)
--Rust analyzer uses nil for default OS target arch in config if not explicitly defined
local cargo_target_or_default = vim.tbl_get(client, 'config', 'settings', 'rust-analyzer', 'cargo', 'target')
or M.os_rustc_target
if cargo_target_or_default ~= filter.exclude_rustc_target then
return true
end
vim.notify('Target architecture is already set to the default OS target.', vim.log.levels.INFO)
return false
end, clients)
end
return vim.lsp.get_clients(filter)
return clients
end

---@param method string LSP method name
Expand Down
Loading