fix(buffers): Fix fallback for finding a buffer by filename (#1126)

Author: kristijanhusak

lua/orgmode/state/buffers.lua

@@ -29,25 +29,56 @@ function OrgBuffers.get_buffer_by_filename(filename)
     return OrgBuffers._bufs[resolved_filename]
   end
 
-  -- If filename does not have an org extension, try to find the buf number and return it if filetype is org
+  local bufnr = vim.fn.bufnr(resolved_filename)
+
+  if bufnr < 0 then
+    return -1
+  end
+
+  -- If filename does not have an org extension, return the buffer only if it has correct filetype
   if not OrgBuffers._is_valid_file_name(resolved_filename) then
-    local bufnr = vim.fn.bufnr(resolved_filename)
-    if bufnr > -1 and vim.bo[bufnr].filetype == 'org' then
+    if vim.bo[bufnr].filetype == 'org' then
       return bufnr
     end
+
+    return -1
+  end
+
+  -- bufnr() can return wrong buffer number in cases when there are multiple files matching, for example:
+  -- * `/path/to/orgfiles/todos.org`
+  -- * `/path/to/orgfiles/todos.org_archive`
+  -- Doing `bufnr('/path/to/orgfiles/todos.org')` can return buffer number for `/path/to/orgfiles/todos.org_archive`.
+  -- Resolve the filename of the found buffer, and make sure it matches the resolved filename we are looking for
+  -- If not, fallback to nvim_list_bufs
+  local buffer_filename = OrgBuffers._resolve_filename(vim.api.nvim_buf_get_name(bufnr))
+
+  if buffer_filename == resolved_filename then
+    return OrgBuffers.add(bufnr)
+  end
+
+  local all_bufs = vim.api.nvim_list_bufs()
+  for _, buf in ipairs(all_bufs) do
+    local valid_buffer_name = OrgBuffers.get_valid_buffer_name(buf)
+    if valid_buffer_name and valid_buffer_name == resolved_filename then
+      return OrgBuffers.add(buf)
+    end
   end
 
   return -1
 end
 
 ---Add the buffer to the list
 ---@param bufnr number
+---@return number bufnr if the buffer is valid and added, -1 otherwise
 function OrgBuffers.add(bufnr)
   local name = OrgBuffers.get_valid_buffer_name(bufnr)
 
   if name then
     OrgBuffers._bufs[name] = bufnr
+    return bufnr
   end
+
+  return -1
 end
 
 ---Remove the buffer from the list
@@ -63,13 +94,13 @@ end
 ---Get valid buffer name if the buffer is an org file
 ---@param bufnr number
 function OrgBuffers.get_valid_buffer_name(bufnr)
-  local name = OrgBuffers._resolve_filename(vim.api.nvim_buf_get_name(bufnr))
+  local bufname = vim.api.nvim_buf_get_name(bufnr)
 
-  if OrgBuffers._is_valid_file_name(name) then
-    return name
+  if not OrgBuffers._is_valid_file_name(bufname) then
+    return nil
   end
 
-  return nil
+  return OrgBuffers._resolve_filename(bufname)
 end
 
 ---Resolve and normalize the filename