fix(filesystem): fixed call to debounce with wrong arguments (#1227)

Author: pysan3

lua/neo-tree/git/status.lua

@@ -237,7 +237,6 @@ M.status_async = function(path, base, opts)
     end
 
     local job_complete_callback = function()
-      utils.debounce(event_id, nil, nil, nil, utils.debounce_action.COMPLETE_ASYNC_JOB)
       vim.schedule(function()
         events.fire_event(events.GIT_STATUS_CHANGED, {
           git_root = context.git_root,

lua/neo-tree/sources/filesystem/init.lua

@@ -13,7 +13,7 @@ local glob = require("neo-tree.sources.filesystem.lib.globtopattern")
 
 local M = {
   name = "filesystem",
-  display_name = " 󰉓 Files "
+  display_name = " 󰉓 Files ",
 }
 
 local wrap = function(func)
@@ -174,7 +174,7 @@ M.navigate = function(state, path, path_to_reveal, callback, async)
   log.trace("navigate", path, path_to_reveal, async)
   utils.debounce("filesystem_navigate", function()
     M._navigate_internal(state, path, path_to_reveal, callback, async)
-  end, utils.debounce_strategy.CALL_FIRST_AND_LAST, 100)
+  end, 100, utils.debounce_strategy.CALL_FIRST_AND_LAST)
 end
 
 M.reset_search = function(state, refresh, open_current_node)
@@ -423,13 +423,13 @@ M.toggle_directory = function(state, node, path_to_reveal, skip_redraw, recursiv
 end
 
 M.prefetcher = {
-  prefetch = function (state, node)
+  prefetch = function(state, node)
     log.debug("Running fs prefetch for: " .. node:get_id())
     fs_scan.get_dir_items_async(state, node:get_id(), true)
   end,
-  should_prefetch = function (node)
+  should_prefetch = function(node)
     return not node.loaded
-  end
+  end,
 }
 
 return M

lua/neo-tree/utils/init.lua

@@ -35,20 +35,25 @@ local diag_severity_to_string = function(severity)
 end
 
 local tracked_functions = {}
+---@enum NeotreeDebounceStrategy
 M.debounce_strategy = {
   CALL_FIRST_AND_LAST = 0,
   CALL_LAST_ONLY = 1,
 }
 
+---@enum NeotreeDebounceAction
 M.debounce_action = {
   START_NORMAL = 0,
   START_ASYNC_JOB = 1,
   COMPLETE_ASYNC_JOB = 2,
 }
 
-local defer_function
--- Part of debounce. Moved out of the function to eliminate memory leaks.
-defer_function = function(id, frequency_in_ms, strategy, action)
+---Part of debounce. Moved out of the function to eliminate memory leaks.
+---@param id string Identifier for the debounce group, such as the function name.
+---@param frequency_in_ms number Miniumum amount of time between invocations of fn.
+---@param strategy NeotreeDebounceStrategy The debounce_strategy to use, determines which calls to fn are not dropped.
+---@param action NeotreeDebounceAction? The debounce_action to use, determines how the function is invoked
+local function defer_function(id, frequency_in_ms, strategy, action)
   tracked_functions[id].in_debounce_period = true
   vim.defer_fn(function()
     local current_data = tracked_functions[id]
@@ -72,7 +77,8 @@ end
 ---@param id string Identifier for the debounce group, such as the function name.
 ---@param fn function Function to be executed.
 ---@param frequency_in_ms number Miniumum amount of time between invocations of fn.
----@param strategy number The debounce_strategy to use, determines which calls to fn are not dropped.
+---@param strategy NeotreeDebounceStrategy The debounce_strategy to use, determines which calls to fn are not dropped.
+---@param action NeotreeDebounceAction? The debounce_action to use, determines how the function is invoked
 M.debounce = function(id, fn, frequency_in_ms, strategy, action)
   local fn_data = tracked_functions[id]
 
@@ -119,8 +125,8 @@ M.debounce = function(id, fn, frequency_in_ms, strategy, action)
   if type(fn) == "function" then
     success, result = pcall(fn)
   end
-  fn_data.fn = nil
   fn = nil
+  fn_data.fn = fn
 
   if not success then
     log.error("debounce ", id, " error: ", result)
@@ -208,7 +214,7 @@ end
 ---Converts a filesize from libuv.stats into a human readable string with appropriate units.
 ---@param size any
 ---@return string
-M.human_size = function (size)
+M.human_size = function(size)
   local human = filesize(size, { output = "string" })
   ---@cast human string
   return human
@@ -355,12 +361,12 @@ M.get_inner_win_width = function(winid)
 end
 
 local stat_providers = {
-  default = function (node)
+  default = function(node)
     return vim.loop.fs_stat(node.path)
   end,
 }
 
---- Gets the statics for a node in the file system. The `stat` object will be cached 
+--- Gets the statics for a node in the file system. The `stat` object will be cached
 --- for the lifetime of the node.
 ---
 ---@param node table The Nui TreeNode node to get the stats for.
@@ -373,7 +379,7 @@ local stat_providers = {
 --- @field birthtime StatTime
 --- @field mtime StatTime
 --- @field size number
-M.get_stat = function (node)
+M.get_stat = function(node)
   if node.stat == nil then
     local provider = stat_providers[node.stat_provider or "default"]
     local success, stat = pcall(provider, node)
@@ -385,7 +391,7 @@ end
 ---Register a function to provide stats for a node.
 ---@param name string The name of the stat provider.
 ---@param func function The function to call to get the stats.
-M.register_stat_provider = function (name, func)
+M.register_stat_provider = function(name, func)
   stat_providers[name] = func
   log.debug("Registered stat provider", name)
 end
@@ -632,7 +638,7 @@ end
 ---@param bufnr number|nil The buffer number to open
 M.open_file = function(state, path, open_cmd, bufnr)
   open_cmd = open_cmd or "edit"
-    -- If the file is already open, switch to it.
+  -- If the file is already open, switch to it.
   bufnr = bufnr or M.find_buffer_by_name(path)
   if bufnr <= 0 then
     bufnr = nil