refactor(git): decouple git statuses from states, fix bubbling (#1943)

Author: pynappo

lua/neo-tree/git/init.lua

@@ -3,7 +3,10 @@ local events = require("neo-tree.events")
 local log = require("neo-tree.log")
 local Job = require("plenary.job")
 local uv = vim.uv or vim.loop
+local can_create_presized_table, new_table = pcall(require, "table.new")
 local co = coroutine
+---@type metatable
+local weak_kv = { __mode = "kv" }
 
 local M = {}
 local gsplit_plain = vim.fn.has("nvim-0.9") == 1 and { plain = true } or true
@@ -23,9 +26,7 @@ local has_porcelain_v2 = git_version and git_version.major >= 2 and git_version.
 M._supported_porcelain_version = has_porcelain_v2 and 2 or 1
 
 ---@type table<string, neotree.git.Status>
-M.status_cache = setmetatable({}, {
-  __mode = "kv",
-})
+M.statuses = setmetatable({}, weak_kv)
 
 ---@class (exact) neotree.git.Context : neotree.Config.GitStatusAsync
 ---@field git_status neotree.git.Status?
@@ -37,7 +38,8 @@ M.status_cache = setmetatable({}, {
 ---@param git_status neotree.git.Status?
 local update_git_status = function(context, git_status)
   context.git_status = git_status
-  M.status_cache[context.git_root] = git_status
+  M._root_dir_cache = setmetatable({}, { __mode = "kv" })
+  M.statuses[context.git_root] = git_status
   vim.schedule(function()
     events.fire_event(events.GIT_STATUS_CHANGED, {
       git_root = context.git_root,
@@ -261,26 +263,39 @@ M._parse_porcelain = function(
     local typechanged = {}
     local renamed = {}
     local copied = {}
+    local flattened_len = #statuses
     for i, s in ipairs(statuses) do
+      -- simplify statuses to the highest priority ones
       if s:find("U", 1, true) then
+        statuses[i] = "U"
         conflicts[#conflicts + 1] = i
       elseif s:find("?", 1, true) then
+        statuses[i] = "?"
         untracked[#untracked + 1] = i
       elseif s:find("M", 1, true) then
+        statuses[i] = "M"
         modified[#modified + 1] = i
       elseif s:find("A", 1, true) then
+        statuses[i] = "A"
         added[#added + 1] = i
       elseif s:find("D", 1, true) then
+        statuses[i] = "D"
         deleted[#deleted + 1] = i
       elseif s:find("T", 1, true) then
+        statuses[i] = "T"
         typechanged[#typechanged + 1] = i
       elseif s:find("R", 1, true) then
+        statuses[i] = "R"
         renamed[#renamed + 1] = i
       elseif s:find("C", 1, true) then
+        statuses[i] = "C"
         copied[#copied + 1] = i
+      else
+        flattened_len = flattened_len - 1
       end
     end
-    local flattened = {}
+    local bubbleable_statuses_by_prio = can_create_presized_table and new_table(flattened_len, 0)
+      or {}
 
     for _, list in ipairs({
       conflicts,
@@ -292,13 +307,19 @@ M._parse_porcelain = function(
       renamed,
       copied,
     }) do
-      require("neo-tree.utils._compat").table_move(list, 1, #list, #flattened + 1, flattened)
+      require("neo-tree.utils._compat").table_move(
+        list,
+        1,
+        #list,
+        #bubbleable_statuses_by_prio + 1,
+        bubbleable_statuses_by_prio
+      )
     end
 
+    -- bubble them up
     local parent_statuses = {}
     do
-      local dot_byte = ("."):byte(1, 1)
-      for _, i in ipairs(flattened) do
+      for _, i in ipairs(bubbleable_statuses_by_prio) do
         local path = paths[i]
         local status = statuses[i]
         local parent
@@ -322,8 +343,7 @@ M._parse_porcelain = function(
             break
           end
 
-          parent_statuses[parent] = status:byte(1, 1) == dot_byte and status:sub(1, 1)
-            or status:sub(2, 2)
+          parent_statuses[parent] = status
           path = parent
         until false
 
@@ -350,7 +370,7 @@ M._parse_porcelain = function(
     end
   end
 
-  M.status_cache[git_root] = git_status
+  M.statuses[git_root] = git_status
   return git_status
 end
 
@@ -535,7 +555,7 @@ M.status_async = function(path, base, opts)
         batch_delay = opts.batch_delay or 10,
         max_lines = opts.max_lines or 100000,
       }
-      if not M.status_cache[ctx.git_root] then
+      if not M.statuses[ctx.git_root] then
         -- do a fast scan first to get basic things in, then a full scan with untracked files
         async_git_status_job(
           ctx,
@@ -564,33 +584,37 @@ end
 
 ---@param state neotree.State
 ---@param items neotree.FileItem[]
-M.mark_ignored = function(state, items)
-  local gs = state.git_status_lookup
-  if not gs then
-    return
+M.mark_gitignored = function(state, items)
+  local statuses = {}
+  for git_root, git_status in pairs(M.statuses) do
+    if utils.is_subpath(git_root, state.path) or utils.is_subpath(state.path, git_root) then
+      statuses[#statuses + 1] = git_status
+    end
   end
   for _, i in ipairs(items) do
-    local direct_lookup = gs[i.path]
-    if direct_lookup == "!" then
-      i.filtered_by = i.filtered_by or {}
-      i.filtered_by.gitignored = true
+    for _, git_status in ipairs(statuses) do
+      local status = git_status[i.path]
+      if status == "!" then
+        i.filtered_by = i.filtered_by or {}
+        i.filtered_by.gitignored = true
+        break
+      end
     end
   end
 end
 
-local sp = utils.split_path
 ---Invalidate cache for path and parents, updating trees as needed
 ---@param path string
 local invalidate_cache = function(path)
   ---@type string?
-  local parent = sp(path)
+  local parent = utils.split_path(path)
 
   while parent do
-    local cache_entry = M.status_cache[parent]
+    local cache_entry = M.statuses[parent]
     if cache_entry ~= nil then
       update_git_status({ git_root = parent }, nil)
     end
-    parent = sp(parent)
+    parent = utils.split_path(parent)
   end
 end
 
@@ -688,4 +712,27 @@ M.get_git_dir = function(path, callback)
   return git_root
 end
 
+---@type table<string, string|false>
+M._root_dir_cache = setmetatable({}, weak_kv)
+---Given a path, find whether a git status exists for it.
+---@param path string
+---@return string|false? worktree_root
+---@return neotree.git.Status? status
+M.find_existing_status = function(path)
+  local cached = M._root_dir_cache[path]
+  if cached == false then
+    return cached, nil
+  end
+  if cached ~= nil then
+    return cached, M.statuses[cached]
+  end
+  for root_dir, status in pairs(M.statuses) do
+    if utils.is_subpath(root_dir, path, true) then
+      M._root_dir_cache[path] = root_dir
+      return root_dir, status
+    end
+  end
+  M._root_dir_cache[path] = false
+end
+
 return M

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

@@ -143,7 +143,7 @@ M.setup = function(config, global_config)
       handler = function(state)
         local this_state = get_state()
         if state == this_state then
-          state.git_status_lookup = git.status(state.git_base)
+          git.status(state.git_base)
         end
       end,
     })

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

@@ -9,6 +9,7 @@ local log = require("neo-tree.log")
 local help = require("neo-tree.sources.common.help")
 local Preview = require("neo-tree.sources.common.preview")
 local async = require("plenary.async")
+local git = require("neo-tree.git")
 local node_expander = require("neo-tree.sources.common.node_expander")
 
 ---@alias neotree.TreeCommandNormal fun(state: neotree.StateWithTree, ...: any)
@@ -333,8 +334,9 @@ M.git_toggle_file_stage = function(state)
     return
   end
   local path = node:get_id()
-  local gs = log.assert(state.git_status_lookup, "No git status found for this state")
-  local status = gs[path]
+  local root_dir, git_status = git.find_existing_status(path)
+  git_status = log.assert(git_status, "No git status found for this state")
+  local status = git_status[path]
   if not status then
     log.warn("No status found for path", path)
     return
@@ -553,10 +555,14 @@ M.order_by_git_status = function(state)
   set_sort(state, "Git Status")
 
   state.sort_field_provider = function(node)
-    local git_status_lookup = state.git_status_lookup or {}
-    local git_status = git_status_lookup[node.path]
-    if git_status then
-      return git_status
+    local root_dir, git_status = git.find_existing_status(node.path)
+    if not git_status then
+      return ""
+    end
+
+    local status = git_status[node.path]
+    if status then
+      return status
     end
 
     return ""
@@ -614,9 +620,10 @@ M.show_file_details = function(state)
     table.insert(right, utils.date(modified_format, stat.mtime.sec))
   end
 
-  if state.git_status_lookup and state.git_status_lookup[node.path] then
+  local root_dir, git_status = git.find_existing_status(node.path)
+  if git_status and git_status[node.path] then
     table.insert(left, "Git code")
-    table.insert(right, state.git_status_lookup[node.path])
+    table.insert(right, git_status[node.path])
   end
 
   local lines = {}

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

@@ -14,7 +14,7 @@ local highlights = require("neo-tree.ui.highlights")
 local utils = require("neo-tree.utils")
 local file_nesting = require("neo-tree.sources.common.file-nesting")
 local container = require("neo-tree.sources.common.container")
-local nt = require("neo-tree")
+local git = require("neo-tree.git")
 
 ---@alias neotree.Component.Common._Key
 ---|"bufnr"
@@ -233,15 +233,17 @@ end
 
 ---@param config neotree.Component.Common.GitStatus
 M.git_status = function(config, node, state)
-  local git_status_lookup = state.git_status_lookup
   local node_is_dir = node.type == "directory"
   if node_is_dir and config.hide_when_expanded and node:is_expanded() then
     return {}
   end
-  if not git_status_lookup then
+
+  local root_dir, git_status = git.find_existing_status(node.path)
+  if not git_status then
     return {}
   end
-  local git_status = git_status_lookup[node.path]
+
+  local git_status = git_status[node.path]
   if not git_status then
     return {}
   end

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

@@ -144,16 +144,17 @@ M.navigate_up = function(state)
 end
 
 ---@param state neotree.StateWithTree
+---@param reverse boolean?
 local focus_next_git_modified = function(state, reverse)
   local node = assert(state.tree:get_node())
   local current_path = node:get_id()
-  local g = state.git_status_lookup
-  if not utils.truthy(g) then
+  local _, git_status = require("neo-tree.git").find_existing_status(current_path)
+  if not utils.truthy(git_status) then
     return
   end
-  ---@cast g -nil
+  assert(git_status)
   local paths = { current_path }
-  for path, status in pairs(g) do
+  for path, status in pairs(git_status) do
     if path ~= current_path and not vim.tbl_contains({ "!", "?" }, status) then
       --don't include files not in the current working directory
       if utils.is_subpath(state.path, path) then
@@ -162,18 +163,22 @@ local focus_next_git_modified = function(state, reverse)
     end
   end
   local sorted_paths = utils.sort_by_tree_display(paths)
-  if reverse then
-    sorted_paths = utils.reverse_list(sorted_paths)
-  end
 
+  ---@param path string
+  ---@return boolean is_file
   local is_file = function(path)
     local success, stats = pcall(uv.fs_stat, path)
-    return (success and stats and stats.type ~= "directory")
+    return (success and stats and stats.type ~= "directory" or false)
   end
 
   local passed = false
   local target = nil
-  for _, path in ipairs(sorted_paths) do
+  local from, to, increment = 1, #sorted_paths, 1
+  if reverse then
+    from, to, increment = #sorted_paths, 1, -1
+  end
+  for i = from, to, increment do
+    local path = sorted_paths[i]
     if target == nil and is_file(path) then
       target = path
     end

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

@@ -384,21 +384,23 @@ M.setup = function(config, global_config)
         end
       end,
     })
-  elseif global_config.enable_git_status and global_config.git_status_async then
-    manager.subscribe(M.name, {
-      event = events.GIT_STATUS_CHANGED,
-      handler = wrap(manager.git_status_changed),
-    })
   elseif global_config.enable_git_status then
-    manager.subscribe(M.name, {
-      event = events.BEFORE_RENDER,
-      handler = function(state)
-        local this_state = get_state()
-        if state == this_state then
-          state.git_status_lookup = git.status(state.git_base, false, state.path)
-        end
-      end,
-    })
+    if global_config.git_status_async then
+      manager.subscribe(M.name, {
+        event = events.GIT_STATUS_CHANGED,
+        handler = wrap(manager.git_status_changed),
+      })
+    else
+      manager.subscribe(M.name, {
+        event = events.BEFORE_RENDER,
+        handler = function(state)
+          local this_state = get_state()
+          if state == this_state then
+            git.status(state.git_base, false, state.path)
+          end
+        end,
+      })
+    end
   end
 
   -- Respond to git events from git_status source or Fugitive