fix(agenda): Reload agenda if headline range was changed

When completing a todo with a repeater date, date is added to the logbook.
This increases the content of the headline and shifts all headlines below the updated headline.
This movement can cause those shifted headlines to have outdated position in the agenda.
To solve this, we reload the agenda anyway and do update in place if we are able to find the headline.

Author: kristijanhusak

lua/orgmode/agenda/init.lua

@@ -181,7 +181,7 @@ function Agenda:reset()
 end
 
 function Agenda:redo(preserve_cursor_pos)
-  self.files:load(true):next(vim.schedule_wrap(function()
+  return self.files:load(true):next(vim.schedule_wrap(function()
     local cursor_view = nil
     if preserve_cursor_pos then
       cursor_view = vim.fn.winsaveview() or {}
@@ -435,14 +435,33 @@ function Agenda:_remote_edit(opts)
     if not opts.update_in_place or not headline then
       return
     end
-    if item.agenda_item then
-      item.agenda_item:set_headline(headline)
-      self.content[line] =
-        AgendaView.build_agenda_item_content(item.agenda_item, item.longest_category, item.longest_date, item.line)
-    else
-      self.content[line] = AgendaTodosView.generate_todo_item(headline, item.longest_category, item.line)
+    local line_range_same = headline:get_range():is_same_line_range(item.headline:get_range())
+
+    local update_item_inline = function()
+      if item.agenda_item then
+        item.agenda_item:set_headline(headline)
+        self.content[line] =
+          AgendaView.build_agenda_item_content(item.agenda_item, item.longest_category, item.longest_date, item.line)
+      else
+        self.content[line] = AgendaTodosView.generate_todo_item(headline, item.longest_category, item.line)
+      end
+      return self:_render(true)
+    end
+
+    if line_range_same then
+      return update_item_inline()
     end
-    return self:_render(true)
+
+    -- If line range was changed, some other agenda items might have outdated position
+    -- In that case, we need to reload the agenda and try to find the same headline to update it in place
+    return self:redo(true):next(function()
+      for content_line, content_item in pairs(self.content) do
+        if content_item.headline and content_item.headline:is_same(headline) then
+          item = self.content[content_line]
+          return update_item_inline()
+        end
+      end
+    end)
   end)
 end
 

lua/orgmode/files/elements/range.lua

@@ -63,6 +63,17 @@ function Range:is_in_line_range(line)
   return line >= self.start_line and line <= self.end_line
 end
 
+function Range:is_same_line_range(range)
+  return self.start_line == range.start_line and self.end_line == range.end_line
+end
+
+function Range:is_same(range)
+  return self.start_line == range.start_line
+    and self.end_line == range.end_line
+    and self.start_col == range.start_col
+    and self.end_col == range.end_col
+end
+
 function Range:clone()
   return Range:new({
     start_line = self.start_line,

lua/orgmode/files/headline.lua

@@ -841,6 +841,7 @@ end
 
 function Headline:is_same(other_headline)
   return self.file.filename == other_headline.filename
+    and self:get_range():is_same(other_headline:get_range())
     and self:get_headline_line_content() == other_headline:get_headline_line_content()
 end