mirror of
https://github.com/neovim/neovim.git
synced 2025-09-05 19:08:15 +00:00
refactor(lsp): tidy up logging
This commit is contained in:
Lewis Russell
committed by
Lewis Russell
Lewis Russell
parent
2a7c4aca42
commit
1f9da3d083
@@ -12,131 +12,131 @@ log.levels = vim.deepcopy(vim.log.levels)
|
||||
|
||||
-- Default log level is warn.
|
||||
local current_log_level = log.levels.WARN
|
||||
|
||||
local log_date_format = '%F %H:%M:%S'
|
||||
local format_func = function(arg)
|
||||
|
||||
local function format_func(arg)
|
||||
return vim.inspect(arg, { newline = '' })
|
||||
end
|
||||
|
||||
do
|
||||
local function notify(msg, level)
|
||||
if vim.in_fast_event() then
|
||||
vim.schedule(function()
|
||||
vim.notify(msg, level)
|
||||
end)
|
||||
else
|
||||
local function notify(msg, level)
|
||||
if vim.in_fast_event() then
|
||||
vim.schedule(function()
|
||||
vim.notify(msg, level)
|
||||
end
|
||||
end
|
||||
|
||||
local path_sep = vim.uv.os_uname().version:match('Windows') and '\\' or '/'
|
||||
local function path_join(...)
|
||||
return table.concat(vim.tbl_flatten({ ... }), path_sep)
|
||||
end
|
||||
local logfilename = path_join(vim.fn.stdpath('log'), 'lsp.log')
|
||||
|
||||
-- TODO: Ideally the directory should be created in open_logfile(), right
|
||||
-- before opening the log file, but open_logfile() can be called from libuv
|
||||
-- callbacks, where using fn.mkdir() is not allowed.
|
||||
vim.fn.mkdir(vim.fn.stdpath('log'), 'p')
|
||||
|
||||
--- Returns the log filename.
|
||||
---@return string log filename
|
||||
function log.get_filename()
|
||||
return logfilename
|
||||
end
|
||||
|
||||
local logfile, openerr
|
||||
--- Opens log file. Returns true if file is open, false on error
|
||||
local function open_logfile()
|
||||
-- Try to open file only once
|
||||
if logfile then
|
||||
return true
|
||||
end
|
||||
if openerr then
|
||||
return false
|
||||
end
|
||||
|
||||
logfile, openerr = io.open(logfilename, 'a+')
|
||||
if not logfile then
|
||||
local err_msg = string.format('Failed to open LSP client log file: %s', openerr)
|
||||
notify(err_msg, vim.log.levels.ERROR)
|
||||
return false
|
||||
end
|
||||
|
||||
local log_info = vim.uv.fs_stat(logfilename)
|
||||
if log_info and log_info.size > 1e9 then
|
||||
local warn_msg = string.format(
|
||||
'LSP client log is large (%d MB): %s',
|
||||
log_info.size / (1000 * 1000),
|
||||
logfilename
|
||||
)
|
||||
notify(warn_msg)
|
||||
end
|
||||
|
||||
-- Start message for logging
|
||||
logfile:write(string.format('[START][%s] LSP logging initiated\n', os.date(log_date_format)))
|
||||
return true
|
||||
end
|
||||
|
||||
for level, levelnr in pairs(log.levels) do
|
||||
-- Also export the log level on the root object.
|
||||
log[level] = levelnr
|
||||
-- FIXME: DOC
|
||||
-- Should be exposed in the vim docs.
|
||||
--
|
||||
-- Set the lowercase name as the main use function.
|
||||
-- If called without arguments, it will check whether the log level is
|
||||
-- greater than or equal to this one. When called with arguments, it will
|
||||
-- log at that level (if applicable, it is checked either way).
|
||||
--
|
||||
-- Recommended usage:
|
||||
-- ```
|
||||
-- if log.warn() then
|
||||
-- log.warn("123")
|
||||
-- end
|
||||
-- ```
|
||||
--
|
||||
-- This way you can avoid string allocations if the log level isn't high enough.
|
||||
if level ~= 'OFF' then
|
||||
log[level:lower()] = function(...)
|
||||
local argc = select('#', ...)
|
||||
if levelnr < current_log_level then
|
||||
return false
|
||||
end
|
||||
if argc == 0 then
|
||||
return true
|
||||
end
|
||||
if not open_logfile() then
|
||||
return false
|
||||
end
|
||||
local info = debug.getinfo(2, 'Sl')
|
||||
local header = string.format(
|
||||
'[%s][%s] ...%s:%s',
|
||||
level,
|
||||
os.date(log_date_format),
|
||||
string.sub(info.short_src, #info.short_src - 15),
|
||||
info.currentline
|
||||
)
|
||||
local parts = { header }
|
||||
for i = 1, argc do
|
||||
local arg = select(i, ...)
|
||||
if arg == nil then
|
||||
table.insert(parts, 'nil')
|
||||
else
|
||||
table.insert(parts, format_func(arg))
|
||||
end
|
||||
end
|
||||
logfile:write(table.concat(parts, '\t'), '\n')
|
||||
logfile:flush()
|
||||
end
|
||||
end
|
||||
end)
|
||||
else
|
||||
vim.notify(msg, level)
|
||||
end
|
||||
end
|
||||
|
||||
-- This is put here on purpose after the loop above so that it doesn't
|
||||
-- interfere with iterating the levels
|
||||
local logfilename = vim.fs.joinpath(vim.fn.stdpath('log'), 'lsp.log')
|
||||
|
||||
-- TODO: Ideally the directory should be created in open_logfile(), right
|
||||
-- before opening the log file, but open_logfile() can be called from libuv
|
||||
-- callbacks, where using fn.mkdir() is not allowed.
|
||||
vim.fn.mkdir(vim.fn.stdpath('log'), 'p')
|
||||
|
||||
--- Returns the log filename.
|
||||
---@return string log filename
|
||||
function log.get_filename()
|
||||
return logfilename
|
||||
end
|
||||
|
||||
--- @type file*?, string?
|
||||
local logfile, openerr
|
||||
|
||||
--- Opens log file. Returns true if file is open, false on error
|
||||
local function open_logfile()
|
||||
-- Try to open file only once
|
||||
if logfile then
|
||||
return true
|
||||
end
|
||||
if openerr then
|
||||
return false
|
||||
end
|
||||
|
||||
logfile, openerr = io.open(logfilename, 'a+')
|
||||
if not logfile then
|
||||
local err_msg = string.format('Failed to open LSP client log file: %s', openerr)
|
||||
notify(err_msg, vim.log.levels.ERROR)
|
||||
return false
|
||||
end
|
||||
|
||||
local log_info = vim.uv.fs_stat(logfilename)
|
||||
if log_info and log_info.size > 1e9 then
|
||||
local warn_msg = string.format(
|
||||
'LSP client log is large (%d MB): %s',
|
||||
log_info.size / (1000 * 1000),
|
||||
logfilename
|
||||
)
|
||||
notify(warn_msg)
|
||||
end
|
||||
|
||||
-- Start message for logging
|
||||
logfile:write(string.format('[START][%s] LSP logging initiated\n', os.date(log_date_format)))
|
||||
return true
|
||||
end
|
||||
|
||||
for level, levelnr in pairs(log.levels) do
|
||||
-- Also export the log level on the root object.
|
||||
log[level] = levelnr
|
||||
end
|
||||
|
||||
vim.tbl_add_reverse_lookup(log.levels)
|
||||
|
||||
--- @param level string
|
||||
--- @param levelnr integer
|
||||
--- @return fun(...:any): boolean?
|
||||
local function create_logger(level, levelnr)
|
||||
return function(...)
|
||||
if levelnr < current_log_level then
|
||||
return false
|
||||
end
|
||||
local argc = select('#', ...)
|
||||
if argc == 0 then
|
||||
return true
|
||||
end
|
||||
if not open_logfile() then
|
||||
return false
|
||||
end
|
||||
local info = debug.getinfo(2, 'Sl')
|
||||
local header = string.format(
|
||||
'[%s][%s] ...%s:%s',
|
||||
level,
|
||||
os.date(log_date_format),
|
||||
info.short_src:sub(-16),
|
||||
info.currentline
|
||||
)
|
||||
local parts = { header }
|
||||
for i = 1, argc do
|
||||
local arg = select(i, ...)
|
||||
table.insert(parts, arg == nil and 'nil' or format_func(arg))
|
||||
end
|
||||
assert(logfile)
|
||||
logfile:write(table.concat(parts, '\t'), '\n')
|
||||
logfile:flush()
|
||||
end
|
||||
end
|
||||
|
||||
-- If called without arguments, it will check whether the log level is
|
||||
-- greater than or equal to this one. When called with arguments, it will
|
||||
-- log at that level (if applicable, it is checked either way).
|
||||
|
||||
--- @nodoc
|
||||
log.debug = create_logger('DEBUG', vim.log.levels.DEBUG)
|
||||
|
||||
--- @nodoc
|
||||
log.error = create_logger('ERROR', vim.log.levels.ERROR)
|
||||
|
||||
--- @nodoc
|
||||
log.info = create_logger('INFO', vim.log.levels.INFO)
|
||||
|
||||
--- @nodoc
|
||||
log.trace = create_logger('TRACE', vim.log.levels.TRACE)
|
||||
|
||||
--- @nodoc
|
||||
log.warn = create_logger('WARN', vim.log.levels.WARN)
|
||||
|
||||
--- Sets the current log level.
|
||||
---@param level (string|integer) One of `vim.lsp.log.levels`
|
||||
function log.set_level(level)
|
||||
|
||||
Reference in New Issue
Block a user