feat(filesystem): show window immediately without waiting for async scan (#1015)

closes #744

Author: cseickel

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

@@ -33,6 +33,7 @@ end
 
 local follow_internal = function(callback, force_show, async)
   log.trace("follow called")
+  local state = get_state()
   if vim.bo.filetype == "neo-tree" or vim.bo.filetype == "neo-tree-popup" then
     return false
   end
@@ -42,7 +43,6 @@ local follow_internal = function(callback, force_show, async)
   end
   ---@cast path_to_reveal string
 
-  local state = get_state()
   if state.current_position == "float" then
     return false
   end
@@ -177,6 +177,7 @@ end
 ---@param path_to_reveal string Node to focus after the items are loaded.
 ---@param callback function Callback to call after the items are loaded.
 M.navigate = function(state, path, path_to_reveal, callback, async)
+  state._ready = false
   log.trace("navigate", path, path_to_reveal, async)
   utils.debounce("filesystem_navigate", function()
     M._navigate_internal(state, path, path_to_reveal, callback, async)

lua/neo-tree/sources/filesystem/lib/fs_scan.lua

@@ -481,6 +481,7 @@ local handle_refresh_or_up = function (context, async)
 end
 
 M.get_items = function(state, parent_id, path_to_reveal, callback, async, recursive) 
+  renderer.acquire_window(state)
   if state.async_directory_scan == "always" then
     async = true
   elseif state.async_directory_scan == "never" then

lua/neo-tree/ui/renderer.lua

@@ -15,7 +15,7 @@ local windows = require("neo-tree.ui.windows")
 local M = { resize_timer_interval = 50 }
 local ESC_KEY = vim.api.nvim_replace_termcodes("<ESC>", true, false, true)
 local default_popup_size = { width = 60, height = "80%" }
-local draw, create_window, create_tree, render_tree
+local draw, create_tree, render_tree
 
 local floating_windows = {}
 local update_floating_windows = function()
@@ -913,7 +913,14 @@ local get_buffer = function(bufname, state)
   return bufnr
 end
 
-create_window = function(state)
+M.acquire_window = function(state)
+  if M.window_exists(state) then
+    return state.winid
+  end
+
+  -- used by tests to determine if the tree is ready for testing
+  state._ready = false
+
   local default_position = utils.resolve_config_option(state, "window.position", "left")
   local relative = utils.resolve_config_option(state, "window.relative", "editor")
   state.current_position = state.current_position or default_position
@@ -954,6 +961,7 @@ create_window = function(state)
   local win
   if state.current_position == "float" then
     M.close_all_floating_windows()
+    M.close(state)
     win = create_floating_window(state, win_options, bufname)
   elseif state.current_position == "current" then
     -- state.id is always the window id or tabnr that this state was created for
@@ -1020,7 +1028,7 @@ create_window = function(state)
   end
 
   set_buffer_mappings(state)
-  return win
+  return state.winid
 end
 
 M.update_floating_window_layouts = function()
@@ -1142,8 +1150,13 @@ draw = function(nodes, state, parent_id)
   end
 
   -- Create the tree if it doesn't exist.
-  if not parent_id and not M.window_exists(state) then
-    create_window(state)
+  if parent_id then
+    if not M.window_exists(state) then
+      log.trace("Window is gone, aborting lazy load of folder")
+      return
+    end
+  else
+    M.acquire_window(state)
     create_tree(state)
   end
 
@@ -1174,6 +1187,7 @@ draw = function(nodes, state, parent_id)
   -- Restore the cursor position/focused node in the tree based on the state
   -- when it was last closed
   M.position.restore(state)
+  state._ready = true
 end
 
 local function group_empty_dirs(node)

tests/neo-tree/command/command_spec.lua

@@ -7,6 +7,8 @@ local run_focus_command = function(command, expected_tree_node)
   local winid = vim.api.nvim_get_current_win()
 
   vim.cmd(command)
+  u.wait_for_neo_tree({ interval = 10, timeout = 200 })
+  --u.wait_for_neo_tree()
   verify.window_handle_is_not(winid)
   verify.buf_name_endswith("neo-tree filesystem [1]")
   if expected_tree_node then
@@ -186,11 +188,10 @@ describe("Command", function()
           u.editfile(baz)
           run_focus_command("Neotree reveal", baz)
           local expected_tree_node = baz
+          -- toggle CLOSE
+          vim.cmd(cmd)
 
           verify.after(500, function()
-            -- toggle CLOSE
-            vim.cmd(cmd)
-
             -- toggle OPEN
             u.editfile(topfile)
             if follow_current_file then

tests/neo-tree/ui/icons_spec.lua

@@ -49,9 +49,7 @@ describe("ui/icons", function()
       req_switch.disable_package("nvim-web-devicons")
 
       vim.cmd([[:Neotree focus]])
-      u.wait_for(function()
-        return vim.bo.filetype == "neo-tree"
-      end)
+      u.wait_for_neo_tree()
 
       local winid = vim.api.nvim_get_current_win()
       local bufnr = vim.api.nvim_win_get_buf(winid)
@@ -88,9 +86,7 @@ describe("ui/icons", function()
 
     it("works w/ nvim-web-devicons", function()
       vim.cmd([[:Neotree focus]])
-      u.wait_for(function()
-        return vim.bo.filetype == "neo-tree"
-      end)
+      u.wait_for_neo_tree()
 
       local winid = vim.api.nvim_get_current_win()
       local bufnr = vim.api.nvim_win_get_buf(winid)
@@ -151,9 +147,7 @@ describe("ui/icons", function()
       req_switch.disable_package("nvim-web-devicons")
 
       vim.cmd([[:Neotree focus]])
-      u.wait_for(function()
-        return vim.bo.filetype == "neo-tree"
-      end)
+      u.wait_for_neo_tree()
 
       local winid = vim.api.nvim_get_current_win()
       local bufnr = vim.api.nvim_win_get_buf(winid)
@@ -190,9 +184,7 @@ describe("ui/icons", function()
 
     it("works w/ nvim-web-devicons", function()
       vim.cmd([[:Neotree focus]])
-      u.wait_for(function()
-        return vim.bo.filetype == "neo-tree"
-      end)
+      u.wait_for_neo_tree()
 
       local winid = vim.api.nvim_get_current_win()
       local bufnr = vim.api.nvim_win_get_buf(winid)

tests/utils/init.lua

@@ -180,4 +180,12 @@ function mod.wait_for(callback, options)
   vim.wait(options.timeout or 1000, callback, options.interval or 100)
 end
 
+---@param options? { interval?: integer, timeout?: integer }
+function mod.wait_for_neo_tree(options)
+  local verify = require("tests.utils.verify")
+  mod.wait_for(function()
+    return verify.get_state() ~= nil
+  end, options)
+end
+
 return mod

tests/utils/verify.lua

@@ -54,14 +54,35 @@ end
 
 verify.tree_focused = function(timeout)
   verify.eventually(timeout or 1000, function()
+    if not verify.get_state() then
+      return false
+    end
     return vim.api.nvim_buf_get_option(0, "filetype") == "neo-tree"
   end, "Current buffer is not a 'neo-tree' filetype")
 end
 
+verify.get_state = function(source_name, winid)
+  if source_name == nil then
+    local success
+    success, source_name = pcall(vim.api.nvim_buf_get_var, 0, "neo_tree_source")
+    if not success then
+      return nil
+    end
+  end
+  local state = require("neo-tree.sources.manager").get_state(source_name, nil, winid)
+  if not state.tree then
+    return nil
+  end
+  if not state._ready then
+    return nil
+  end
+  return state
+end
+
 verify.tree_node_is = function(source_name, expected_node_id, winid, timeout)
   verify.eventually(timeout or 500, function()
-    local state = require("neo-tree.sources.manager").get_state(source_name, nil, winid)
-    if not state.tree then
+    local state = verify.get_state(source_name, winid)
+    if not state then
       return false
     end
     local success, node = pcall(state.tree.get_node, state.tree)