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.

Sign up for GitHub

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

feat: error handling improvements #29

Merged
merged 5 commits into from
Oct 1, 2023
Merged

feat: error handling improvements #29

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
a55e163
fix: add entrypoint to error information
mikesmithgh Sep 29, 2023
b57aeaa
work in progress
mikesmithgh Oct 1, 2023
a9337aa
feat: add error handling to termopen
mikesmithgh Oct 1, 2023
98be08f
Merge branch 'main' into tbd
mikesmithgh Oct 1, 2023
e691b5b
fix: stderr and stdout error parsing termopen
mikesmithgh Oct 1, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion lua/kitty-scrollback/autocommands.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ local ksb_win = require('kitty-scrollback.windows')

local M = {}

---@type KsbPrivate
local p
---@type KsbOpts
local opts ---@diagnostic disable-line: unused-local
Expand Down Expand Up @@ -153,7 +154,7 @@ M.set_yank_post_autocmd = function()
{ buf = vim.api.nvim_get_current_buf() }
)
vim.cmd.help('clipboard-tool')
vim.cmd.redraw()
ksb_util.restore_and_redraw()
local response = vim.fn.confirm(prompt_msg, '&Quit\n&Continue')
if response ~= 2 then
ksb_api.quit_all()
Expand Down
237 changes: 180 additions & 57 deletions lua/kitty-scrollback/kitty_commands.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
---@mod kitty-scrollback.kitty_commands
local ksb_health = require('kitty-scrollback.health')
local ksb_util = require('kitty-scrollback.util')
local M = {}

---@type KsbPrivate
local p
local opts ---@diagnostic disable-line: unused-local

Expand All @@ -10,73 +12,194 @@ M.setup = function(private, options)
opts = options ---@diagnostic disable-line: unused-local
end

local error_header = {
'',
'==============================================================================',
'kitty-scrollback.nvim',
'',
'ERROR: failed to execute remote Kitty command',
'',
}

local display_error = function(cmd, r)
local msg = vim.list_extend({}, error_header)
local stdout = r.stdout or ''
local stderr = r.stderr or ''
local err = {}
if r.entrypoint then
table.insert(err, '*entrypoint:* |' .. r.entrypoint:gsub('(%s+)', '|%1|') .. '| ')
end
table.insert(err, '*command:* ' .. cmd)
if r.pid then
table.insert(err, '*pid:* ' .. r.pid)
end
if r.channel_id then
table.insert(err, '*channel_id:* ' .. r.channel_id)
end
if r.code then
table.insert(err, '*code:* ' .. r.code)
end
if r.signal then
table.insert(err, '*signal:* ' .. r.signal)
end

if r.full_cmd then
table.insert(err, '*full_command:* ')
table.insert(err, '>sh')
table.insert(err, ' ' .. r.full_cmd)
table.insert(err, '<')
end

table.insert(err, '*stdout:*')

local out = {}
for line in stdout:gmatch('[^\r\n]+') do
table.insert(out, ' ' .. line)
end
if next(out) then
table.insert(err, '')
vim.list_extend(err, out)
else
table.insert(err, ' <none>')
end
table.insert(err, '')
table.insert(err, '*stderr:*')
if #stderr > 0 then
for line in stderr:gmatch('[^\r\n]+') do
table.insert(err, '')
table.insert(err, ' ' .. line)
end
else
table.insert(err, ' <none>')
end
table.insert(err, '')
local error_bufid = vim.api.nvim_create_buf(false, true)
vim.api.nvim_set_current_buf(error_bufid)
vim.o.conceallevel = 2
vim.o.concealcursor = 'n'
vim.o.foldenable = false
vim.api.nvim_set_option_value('filetype', 'checkhealth', {
buf = error_bufid,
})
ksb_util.restore_and_redraw()
local prompt_msg = 'kitty-scrollback.nvim: Fatal error, see logs.'
if stderr:match('.*allow_remote_control.*') then
vim.list_extend(msg, ksb_health.advice().allow_remote_control)
end
if stderr:match('.*/dev/tty.*') then
vim.list_extend(msg, ksb_health.advice().listen_on)
end
vim.api.nvim_buf_set_lines(error_bufid, 0, -1, false, vim.list_extend(msg, err))
M.close_kitty_loading_window() -- cannot use ignore parameter or will be infinite recursion
ksb_util.restore_and_redraw()
local response = vim.fn.confirm(prompt_msg, '&Quit\n&Continue')
if response ~= 2 then
M.signal_term_to_kitty_child_process(true)
end
end

local system_handle_error = function(cmd, sys_opts, ignore_error)
local proc = vim.system(cmd, sys_opts or {})
local result = proc:wait()
local ok = result.code == 0

if not ok then
local msg = {
'',
'==============================================================================',
'kitty-scrollback.nvim',
'',
'ERROR: failed to execute remote Kitty command',
'',
}
local stdout = result.stdout or ''
local stderr = result.stderr or ''
local err = {
'*entrypoint:* |vim.system()|',
'*command:* ' .. table.concat(cmd, ' '),
'*pid:* ' .. proc.pid,
'*code:* ' .. result.code,
'*signal:* ' .. result.signal,
'*stdout:*',
}
local out = {}
for line in stdout:gmatch('[^\r\n]+') do
table.insert(out, ' ' .. line)
end
if next(out) then
vim.list_extend(err, out)
else
table.insert(err, ' <none>')
end
table.insert(err, '*stderr:*')
for line in stderr:gmatch('[^\r\n]+') do
table.insert(err, ' ' .. line)
end
local error_bufid = vim.api.nvim_create_buf(false, true)
vim.o.conceallevel = 2
vim.o.concealcursor = 'n'
vim.api.nvim_set_option_value('filetype', 'checkhealth', {
buf = error_bufid,
if not ignore_error and not ok then
display_error(table.concat(cmd, ' '), {
entrypoint = 'vim.system()',
pid = proc.pid,
code = result.code,
signal = result.signal,
stdout = result.stdout,
stderr = result.stderr,
})
local prompt_msg = 'kitty-scrollback.nvim: Fatal error, see logs.'
if stderr:match('.*allow_remote_control.*') then
vim.list_extend(msg, ksb_health.advice().allow_remote_control)
ignore_error = false -- fatal error, always report this error
end
if stderr:match('.*/dev/tty.*') then
vim.list_extend(msg, ksb_health.advice().listen_on)
ignore_error = false -- fatal error, always report this error
end
if ignore_error then
return ok, result
end
vim.api.nvim_set_current_buf(error_bufid)
vim.api.nvim_buf_set_lines(error_bufid, 0, -1, false, vim.list_extend(msg, err))
vim.cmd.redraw()
local response = vim.fn.confirm(prompt_msg, '&Quit\n&Continue')
if response ~= 2 then
M.signal_term_to_kitty_child_process(true)
end
end

return ok, result
end

M.get_text_term = function(kitty_data, get_text_opts, on_exit_cb)
local esc = vim.fn.eval([["\e"]])
local kitty_get_text_cmd =
string.format([[kitty @ get-text --match="id:%s" %s]], kitty_data.window_id, get_text_opts)
local sed_cmd = string.format(
[[sed -E -e 's/$/%s[0m/g' ]] -- append all lines with reset to avoid unintended colors
.. [[-e 's/%s\[\?25.%s\[.*;.*H%s\[.*//g']], -- remove control sequence added by --add-cursor flag
esc,
esc,
esc,
esc
)
local flush_stdout_cmd = [[kitty +runpy 'sys.stdout.flush()']]
local full_cmd = kitty_get_text_cmd .. ' | ' .. sed_cmd .. ' && ' .. flush_stdout_cmd
local stdout
local stderr
local tail_max = 10
vim.fn.termopen(full_cmd, {
stdout_buffered = true,
stderr_buffered = true,
on_stdout = function(_, data)
stdout = data
end,
on_stderr = function(_, data)
stderr = data
end,
on_exit = function(id, exit_code, event)
if exit_code == 0 then
-- no need to check allow_remote_control or dev/tty because earlier commands would have reported the error
if #stdout >= 2 then
-- the exit code may have been lost while piping the command through sed
-- so search last lines for and error reported by Kitty
local error_index = -1
local tail_diff = #stdout - tail_max
local tail_count = tail_diff < 1 and 1 or math.min(tail_diff, #stdout)
for i = #stdout, tail_count, -1 do
-- see for match kitty/tools/cli/markup/prettify.go ans.Err = fmt_ctx.SprintFunc("bold fg=bright-red")
if stdout[i]:match('^' .. esc .. '%[1;91mError' .. esc .. '%[221;39m: .*') then
error_index = i
break
end
end

if error_index > 0 then
display_error(kitty_get_text_cmd, {
entrypoint = 'termopen() :: exit_code = 0 and error_index > 0',
full_cmd = full_cmd,
code = 1, -- exit code is not returned through pipe but we can assume 1 due to error message
channel_id = id,
stdout = table.concat(
vim.tbl_map(function(line)
return line
:gsub('[\27\155][][()#:;?%d]*[A-PRZcf-ntqry=><~]', '')
:gsub(esc .. '\\', '')
:gsub(';k=s', '')
end, stdout),
'\n'
),
stderr = stderr and table.concat(stderr, '\n') or nil,
})
end
end
on_exit_cb(id, exit_code, event)
else
local out = stdout
and table
.concat(stdout, '\n', math.max(#stdout - tail_max, 1), #stdout)
:gsub('[\27\155][][()#:;?%d]*[A-PRZcf-ntqry=><~]', '')
:gsub('' .. esc .. '\\', '')
:gsub(';k=s', '')
or nil
display_error(full_cmd, {
entrypoint = 'termopen() :: exit_code ~= 0',
code = exit_code,
channel_id = id,
stdout = out,
stderr = stderr and table.concat(stderr, '\n') or nil,
})
end
end,
})
end

M.send_paste_buffer_text_to_kitty_and_quit = function(bracketed_paste_mode)
-- convert table to string separated by carriage returns
local cmd_str = table.concat(
Expand Down Expand Up @@ -148,7 +271,7 @@ end

M.open_kitty_loading_window = function(env)
if p.kitty_loading_winid then
M.close_kitty_loading_window()
M.close_kitty_loading_window(true)
end
local kitty_cmd = vim.list_extend({
'kitty',
Expand Down
Loading