fix: infinite recursion in empty folder with hide_root_node = true (#729)

fixes #714

Author: figsoda

lua/neo-tree/sources/common/commands.lua

@@ -11,34 +11,41 @@ local log = require("neo-tree.log")
 local help = require("neo-tree.sources.common.help")
 local Preview = require("neo-tree.sources.common.preview")
 
----Gets the node parent folder recursively
----@param tree table to look for nodes
----@param node table to look for folder parent
----@return table table
-local function get_folder_node(state, node)
+---Gets the node parent folder
+---@param state table to look for nodes
+---@return table? node
+local function get_folder_node(state)
   local tree = state.tree
-  if not node then
-    node = tree:get_node()
-  end
+  local node = tree:get_node()
+  local last_id = node:get_id()
+
+  while node do
+    local insert_as_local = state.config.insert_as
+    local insert_as_global = require("neo-tree").config.window.insert_as
+    local use_parent
+    if insert_as_local then
+      use_parent = insert_as_local == "sibling"
+    else
+      use_parent = insert_as_global == "sibling"
+    end
 
-  local insert_as_local = state.config.insert_as
-  local insert_as_global = require("neo-tree").config.window.insert_as
-  local use_parent
-  if insert_as_local then
-    use_parent = insert_as_local == "sibling"
-  else
-    use_parent = insert_as_global == "sibling"
-  end
+    local is_open_dir = node.type == "directory" and (node:is_expanded() or node.empty_expanded)
+    if use_parent and not is_open_dir then
+      return tree:get_node(node:get_parent_id())
+    end
 
-  local is_open_dir = node.type == "directory" and (node:is_expanded() or node.empty_expanded)
-  if use_parent and not is_open_dir then
-    return tree:get_node(node:get_parent_id())
-  end
+    if node.type == "directory" then
+      return node
+    end
 
-  if node.type == "directory" then
-    return node
+    local parent_id = node:get_parent_id()
+    if parent_id or parent_id == last_id then
+      return node
+    else
+      last_id = parent_id
+      node = tree:get_node(parent_id)
+    end
   end
-  return get_folder_node(state, tree:get_node(node:get_parent_id()))
 end
 
 ---The using_root_directory is used to decide what part of the filename to show

lua/neo-tree/ui/renderer.lua

@@ -216,6 +216,7 @@ create_nodes = function(source_items, state, level)
       extra = item.extra,
       is_nested = item.is_nested,
       skip_node = item.skip_node,
+      is_empty_with_hidden_root = item.is_empty_with_hidden_root,
       -- TODO: The below properties are not universal and should not be here.
       -- Maybe they should be moved to the "extra" field?
       is_link = item.is_link,
@@ -315,7 +316,13 @@ end
 
 local prepare_node = function(item, state)
   if item.skip_node then
-    return nil
+    if item.is_empty_with_hidden_root then
+      local line = NuiLine()
+      line:append("(empty folder)", highlights.MESSAGE)
+      return line
+    else
+      return nil
+    end
   end
   -- pre_render is used to calculate the longest node width
   -- without actually rendering the node.
@@ -1074,7 +1081,6 @@ M.show_nodes = function(sourceItems, state, parentId, callback)
   --local id = string.format("show_nodes %s:%s [%s]", state.name, state.force_float, state.tabnr)
   --utils.debounce(id, function()
   events.fire_event(events.BEFORE_RENDER, state)
-  local is_empty_with_hidden_root = false
   state.longest_width_exact = 0
   local parent
   local level = 0
@@ -1093,10 +1099,8 @@ M.show_nodes = function(sourceItems, state, parentId, callback)
   if config.hide_root_node then
     if not parentId then
       sourceItems[1].skip_node = true
-      if sourceItems[1].children and #sourceItems[1].children > 0 then
-        is_empty_with_hidden_root = false
-      else
-        is_empty_with_hidden_root = true
+      if not (sourceItems[1].children and #sourceItems[1].children > 0) then
+        sourceItems[1].is_empty_with_hidden_root = true
       end
     end
     if not config.retain_hidden_root_indent then
@@ -1163,17 +1167,6 @@ M.show_nodes = function(sourceItems, state, parentId, callback)
   if sourceItems then
     -- normal path
     local nodes = create_nodes(sourceItems, state, level)
-    if is_empty_with_hidden_root then
-      local nodeData = {
-        id = state.path .. "_empty_message",
-        name = "(empty folder)",
-        type = "message",
-        level = 0,
-        is_last_child = true,
-      }
-      local node = NuiTree.Node(nodeData, {})
-      table.insert(nodes, node)
-    end
     draw(nodes, state, parentId)
   else
     -- this was a force grouping of a lazy loaded folder