local log = require "nvim-tree.log" local utils = require "nvim-tree.utils" local notify = require "nvim-tree.notify" -- TODO add "${3rd}/luv/library" to "workspace.library" ---@class uv.uv_handle_t: table ---@class uv.uv_stream_t: uv.uv_handle_t ---@class uv.uv_pipe_t: uv.uv_stream_t ---@class Runner local Runner = {} Runner.__index = Runner local timeouts = 0 local MAX_TIMEOUTS = 5 ---@private ---@param status string ---@param path string|nil function Runner:_parse_status_output(status, path) if not path then return end -- replacing slashes if on windows if vim.fn.has "win32" == 1 then path = path:gsub("/", "\\") end if #status > 0 and #path > 0 then self.output[utils.path_remove_trailing(utils.path_join { self.toplevel, path })] = status end end ---@private ---@param prev_output string ---@param incoming string ---@return string function Runner:_handle_incoming_data(prev_output, incoming) if incoming and utils.str_find(incoming, "\n") then local prev = prev_output .. incoming local i = 1 local skip_next_line = false for line in prev:gmatch "[^\n]*\n" do if skip_next_line then skip_next_line = false else local status = line:sub(1, 2) local path = line:sub(4, -2) if utils.str_find(status, "R") then -- skip next line if it is a rename entry skip_next_line = true end self:_parse_status_output(status, path) end i = i + #line end return prev:sub(i, -1) end if incoming then return prev_output .. incoming end for line in prev_output:gmatch "[^\n]*\n" do self:_parse_status_output(line) end return "" end ---@param stdout_handle uv.uv_pipe_t ---@param stderr_handle uv.uv_pipe_t ---@return table function Runner:_getopts(stdout_handle, stderr_handle) local untracked = self.list_untracked and "-u" or nil local ignored = (self.list_untracked and self.list_ignored) and "--ignored=matching" or "--ignored=no" return { args = { "--no-optional-locks", "status", "--porcelain=v1", "-z", ignored, untracked, self.path }, cwd = self.toplevel, stdio = { nil, stdout_handle, stderr_handle }, } end ---@param output string function Runner:_log_raw_output(output) if log.enabled "git" and output and type(output) == "string" then log.raw("git", "%s", output) log.line("git", "done") end end ---@param callback function|nil function Runner:_run_git_job(callback) local handle, pid local stdout = vim.loop.new_pipe(false) local stderr = vim.loop.new_pipe(false) local timer = vim.loop.new_timer() if stdout == nil or stderr == nil or timer == nil then return end local function on_finish(rc) self.rc = rc or 0 if timer:is_closing() or stdout:is_closing() or stderr:is_closing() or (handle and handle:is_closing()) then if callback then callback() end return end timer:stop() timer:close() stdout:read_stop() stderr:read_stop() stdout:close() stderr:close() -- don't close the handle when killing as it will leave a zombie if rc == -1 then pcall(vim.loop.kill, pid, "sigkill") elseif handle then handle:close() end if callback then callback() end end local opts = self:_getopts(stdout, stderr) log.line("git", "running job with timeout %dms", self.timeout) log.line("git", "git %s", table.concat(utils.array_remove_nils(opts.args), " ")) handle, pid = vim.loop.spawn( "git", opts, vim.schedule_wrap(function(rc) on_finish(rc) end) ) timer:start( self.timeout, 0, vim.schedule_wrap(function() on_finish(-1) end) ) local output_leftover = "" local function manage_stdout(err, data) if err then return end if data then data = data:gsub("%z", "\n") end self:_log_raw_output(data) output_leftover = self:_handle_incoming_data(output_leftover, data) end local function manage_stderr(_, data) self:_log_raw_output(data) end vim.loop.read_start(stdout, vim.schedule_wrap(manage_stdout)) vim.loop.read_start(stderr, vim.schedule_wrap(manage_stderr)) end function Runner:_wait() local function is_done() return self.rc ~= nil end while not vim.wait(30, is_done) do end end ---@param opts table function Runner:_finalise(opts) if self.rc == -1 then log.line("git", "job timed out %s %s", opts.toplevel, opts.path) timeouts = timeouts + 1 if timeouts == MAX_TIMEOUTS then notify.warn(string.format("%d git jobs have timed out after git.timeout %dms, disabling git integration.", timeouts, opts.timeout)) require("nvim-tree.git").disable_git_integration() end elseif self.rc ~= 0 then log.line("git", "job fail rc %d %s %s", self.rc, opts.toplevel, opts.path) else log.line("git", "job success %s %s", opts.toplevel, opts.path) end end --- Runs a git process, which will be killed if it takes more than timeout which defaults to 400ms ---@param opts table ---@param callback function|nil executed passing return when complete ---@return table|nil status by absolute path, nil if callback present function Runner.run(opts, callback) local self = setmetatable({ toplevel = opts.toplevel, path = opts.path, list_untracked = opts.list_untracked, list_ignored = opts.list_ignored, timeout = opts.timeout or 400, output = {}, rc = nil, -- -1 indicates timeout }, Runner) local async = callback ~= nil local profile = log.profile_start("git %s job %s %s", async and "async" or "sync", opts.toplevel, opts.path) if async and callback then -- async, always call back self:_run_git_job(function() log.profile_end(profile) self:_finalise(opts) callback(self.output) end) else -- sync, maybe call back self:_run_git_job() self:_wait() log.profile_end(profile) self:_finalise(opts) if callback then callback(self.output) else return self.output end end end return Runner