find_file For New File Leaves Node In Inconsistent State

[alex-courtis]

Description

find_file for a valid file that is not known in a closed directory results in the closed directory unable to be opened.

Neovim version

NVIM v0.8.0
Build type: Release
LuaJIT 2.1.0-beta3

Operating system and version

Linux 6.0.6-arch1-1

nvim-tree version

a0f3e99

Minimal config

vim.cmd [[set runtimepath=$VIMRUNTIME]]
vim.cmd [[set packpath=/tmp/nvt-min/site]]
local package_root = "/tmp/nvt-min/site/pack"
local install_path = package_root .. "/packer/start/packer.nvim"
local function load_plugins()
  require("packer").startup {
    {
      "wbthomason/packer.nvim",
      "nvim-tree/nvim-tree.lua",
      "nvim-tree/nvim-web-devicons",
      -- ADD PLUGINS THAT ARE _NECESSARY_ FOR REPRODUCING THE ISSUE
    },
    config = {
      package_root = package_root,
      compile_path = install_path .. "/plugin/packer_compiled.lua",
      display = { non_interactive = true },
    },
  }
end
if vim.fn.isdirectory(install_path) == 0 then
  print "Installing nvim-tree and dependencies."
  vim.fn.system { "git", "clone", "--depth=1", "https://github.com/wbthomason/packer.nvim", install_path }
end
load_plugins()
require("packer").sync()
vim.cmd [[autocmd User PackerComplete ++once echo "Ready!" | lua setup()]]
vim.opt.termguicolors = true
vim.opt.cursorline = true

-- MODIFY NVIM-TREE SETTINGS THAT ARE _NECESSARY_ FOR REPRODUCING THE ISSUE
_G.setup = function()
  require("nvim-tree").setup {
    filesystem_watchers = {
      enable = false,
    },
    log = {
      enable = true,
      truncate = true,
      types = {
        all = false,
        config = false,
        copy_paste = false,
        dev = true,
        diagnostics = false,
        git = true,
        profile = false,
        watcher = true,
      },
    },
  }
end

Steps to reproduce

mkdir x
touch x/a
:NvimTreeOpen
open x
close x
!touch x/b
:lua require("nvim-tree.api").tree.find_file("x/b")

Expected behavior

Node x requires two edit to open.

Actual behavior

Open with one edit.

[alex-courtis]

Failing for update_focused_file.enabled and renderer.group_empty. The top grouped node is expanded and its grouping discarded, resulting in two instances of the directories: one grouped, one not.

This one is tricky: grouped nodes are directly iterated during find-file, with an opportunity to refresh the actual parent node not easily arising.

[alex-courtis]

Pragmatic proposal: find-file runs watch.refresh_path(absolute_parent_dir) or a reload(node, status) prior to finding.

This will fail in the case of symlinked directories, only refreshing the first one. That's an existing problem and can be seen via watchers. A full explorer reload does not suffer from this. This may be a Too Bad edge case and we can address it if needed.

A get_all_nodes_from_path function may be useful for the find-files case and could be applied to the watcher case. This needs thought.