fix(stack): scope quick peek closes and preserve wipeout history

Author: mhiro2

lua/peekstack/core/events.lua

@@ -55,9 +55,9 @@ local function ensure_popup_cursor_tracking(group, bufnr)
   })
 end
 
----Close all ephemeral popups across all stacks and reflow
+---Close ephemeral popups that belong to the current root window.
 local function close_ephemeral_popups()
-  stack.close_ephemerals()
+  stack.close_ephemerals(vim.api.nvim_get_current_win())
 end
 
 ---Check if a window is a floating popup

lua/peekstack/core/stack/events.lua

@@ -14,6 +14,47 @@ local function deps()
   end
 end
 
+---@param stack PeekstackStackModel
+---@param idx integer
+---@param item PeekstackPopupModel
+---@param opts? { close_window?: boolean, highlight_origin?: boolean }
+local function remove_stack_popup(stack, idx, item, opts)
+  opts = opts or {}
+  if stack.zoomed_id == item.id then
+    stack.zoomed_id = nil
+  end
+  if opts.highlight_origin ~= false then
+    feedback.highlight_origin(item.origin)
+  end
+  common.emit_popup_event("PeekstackClose", item, stack.root_winid)
+  history.push_entry(stack, history.build_entry(item, idx))
+  user_events.emit("PeekstackHistoryPush", {
+    popup_id = item.id,
+    location = item.location,
+    root_winid = stack.root_winid,
+  })
+  state.unindex_popup(item)
+  table.remove(stack.popups, idx)
+  if opts.close_window ~= false and item.winid and vim.api.nvim_win_is_valid(item.winid) then
+    popup.close(item)
+  end
+end
+
+---@param id integer
+---@param item PeekstackPopupModel
+---@param opts? { close_window?: boolean }
+local function remove_ephemeral(id, item, opts)
+  opts = opts or {}
+  if opts.close_window ~= false and item.winid and vim.api.nvim_win_is_valid(item.winid) then
+    popup.close(item)
+  end
+  state.unregister_ephemeral(id)
+  user_events.emit(
+    "PeekstackClose",
+    user_events.build_popup_data(item, item.origin and item.origin.winid or 0, { ephemeral = true })
+  )
+end
+
 ---@param winid integer
 function M.handle_win_closed(winid)
   deps()
@@ -83,21 +124,32 @@ function M.handle_buf_wipeout(bufnr)
   end
   for id, item in pairs(state.ephemerals) do
     if item.bufnr == bufnr then
-      state.unregister_ephemeral(id)
+      remove_ephemeral(id, item, { close_window = false })
     end
   end
   for _, stack in pairs(state.stacks) do
+    local removed = false
+    local focused_removed = false
     for idx = #stack.popups, 1, -1 do
       local item = stack.popups[idx]
       if item.bufnr == bufnr then
-        if stack.zoomed_id == item.id then
-          stack.zoomed_id = nil
+        if stack.focused_id == item.id then
+          focused_removed = true
         end
-        state.unindex_popup(item)
-        table.remove(stack.popups, idx)
+        remove_stack_popup(stack, idx, item, { close_window = false })
+        removed = true
       end
     end
-    layout.reflow(stack)
+    if removed then
+      if focused_removed then
+        if #stack.popups > 0 then
+          stack.focused_id = stack.popups[#stack.popups].id
+        else
+          stack.focused_id = nil
+        end
+      end
+      layout.reflow(stack)
+    end
   end
 end
 
@@ -121,23 +173,32 @@ function M.handle_origin_wipeout(bufnr)
   end
   for id, item in pairs(state.ephemerals) do
     if should_close_for_origin(item) then
-      popup.close(item)
-      state.unregister_ephemeral(id)
+      remove_ephemeral(id, item)
     end
   end
   for _, stack in pairs(state.stacks) do
+    local removed = false
+    local focused_removed = false
     for idx = #stack.popups, 1, -1 do
       local item = stack.popups[idx]
       if should_close_for_origin(item) then
-        if stack.zoomed_id == item.id then
-          stack.zoomed_id = nil
+        if stack.focused_id == item.id then
+          focused_removed = true
+        end
+        remove_stack_popup(stack, idx, item)
+        removed = true
+      end
+    end
+    if removed then
+      if focused_removed then
+        if #stack.popups > 0 then
+          stack.focused_id = stack.popups[#stack.popups].id
+        else
+          stack.focused_id = nil
         end
-        popup.close(item)
-        state.unindex_popup(item)
-        table.remove(stack.popups, idx)
       end
+      layout.reflow(stack)
     end
-    layout.reflow(stack)
   end
 end
 

lua/peekstack/core/stack/operations.lua

@@ -432,27 +432,43 @@ function M.close_stale(now_ms, opts)
   end
 end
 
-function M.close_ephemerals()
+---@param winid? integer
+function M.close_ephemerals(winid)
   deps()
+  local target_root_winid = nil
+  if winid ~= nil or vim.api.nvim_get_current_win() ~= nil then
+    target_root_winid = state.get_root_winid(winid)
+  end
+
   for _, stack in pairs(state.stacks) do
-    local removed = false
-    for idx = #stack.popups, 1, -1 do
-      local item = stack.popups[idx]
-      if item.ephemeral then
-        popup.close(item)
-        state.unindex_popup(item)
-        table.remove(stack.popups, idx)
-        removed = true
+    if target_root_winid == nil or stack.root_winid == target_root_winid then
+      local removed = false
+      for idx = #stack.popups, 1, -1 do
+        local item = stack.popups[idx]
+        if item.ephemeral then
+          popup.close(item)
+          state.unindex_popup(item)
+          table.remove(stack.popups, idx)
+          removed = true
+        end
+      end
+      if removed then
+        layout.reflow(stack)
       end
-    end
-    if removed then
-      layout.reflow(stack)
     end
   end
 
   for id, item in pairs(state.ephemerals) do
-    popup.close(item)
-    state.unregister_ephemeral(id)
+    local entry = state.lookup_by_id(item.id)
+    local root_winid = entry and entry.root_winid or nil
+    if target_root_winid == nil or root_winid == target_root_winid then
+      popup.close(item)
+      state.unregister_ephemeral(id)
+      user_events.emit(
+        "PeekstackClose",
+        user_events.build_popup_data(item, item.origin and item.origin.winid or 0, { ephemeral = true })
+      )
+    end
   end
 end
 

tests/events_spec.lua

@@ -133,4 +133,41 @@ describe("peekstack.core.events", function()
     assert.equals(1, #buf_leave)
     assert.equals(2, #win_leave)
   end)
+
+  it("closes quick peek popups only for the current root window", function()
+    local location = {
+      uri = vim.uri_from_bufnr(0),
+      range = { start = { line = 0, character = 0 }, ["end"] = { line = 0, character = 10 } },
+      provider = "test",
+    }
+
+    config.setup({
+      ui = {
+        quick_peek = { close_events = { "CursorMoved" } },
+        popup = { auto_close = { enabled = false } },
+      },
+    })
+    events.setup()
+
+    local left_win = vim.api.nvim_get_current_win()
+    vim.api.nvim_cmd({ cmd = "vsplit" }, {})
+    local right_win = vim.api.nvim_get_current_win()
+
+    vim.api.nvim_set_current_win(left_win)
+    local left_popup = stack.push(location, { stack = false })
+    assert.is_not_nil(left_popup)
+
+    vim.api.nvim_set_current_win(right_win)
+    local right_popup = stack.push(location, { stack = false })
+    assert.is_not_nil(right_popup)
+
+    vim.api.nvim_set_current_win(left_win)
+    vim.api.nvim_exec_autocmds("CursorMoved", { modeline = false })
+
+    assert.is_nil(stack._ephemerals()[left_popup.id])
+    assert.is_not_nil(stack._ephemerals()[right_popup.id])
+
+    stack.close(right_popup.id)
+    vim.api.nvim_cmd({ cmd = "only" }, {})
+  end)
 end)

tests/stack_spec.lua

@@ -280,11 +280,13 @@ describe("stack.handle_origin_wipeout", function()
         id = 1,
         origin = { bufnr = 10 },
         origin_is_popup = true,
+        location = helpers.make_location(),
       },
       {
         id = 2,
         origin = { bufnr = 10 },
         origin_is_popup = false,
+        location = helpers.make_location(),
       },
     }
 
@@ -293,6 +295,67 @@ describe("stack.handle_origin_wipeout", function()
     assert.equals(1, #s.popups)
     assert.equals(1, s.popups[1].id)
   end)
+
+  it("pushes history and emits events when the origin buffer is wiped", function()
+    local received = {}
+    local group = vim.api.nvim_create_augroup("PeekstackOriginWipeoutEvents", { clear = true })
+    vim.api.nvim_create_autocmd("User", {
+      group = group,
+      pattern = { "PeekstackClose", "PeekstackHistoryPush" },
+      callback = function(args)
+        table.insert(received, args.match)
+      end,
+    })
+
+    local model = stack.push(helpers.make_location())
+    assert.is_not_nil(model)
+
+    stack.handle_origin_wipeout(model.origin.bufnr)
+
+    local history = stack.history_list()
+    assert.equals(1, #history)
+    assert.equals(model.id, history[1].popup_id)
+    assert.is_nil(stack.find_by_id(model.id))
+    assert.same({ "PeekstackClose", "PeekstackHistoryPush" }, received)
+
+    pcall(vim.api.nvim_del_augroup_by_id, group)
+  end)
+end)
+
+describe("stack.handle_buf_wipeout", function()
+  before_each(function()
+    stack._reset()
+    config.setup({})
+  end)
+
+  after_each(function()
+    stack._reset()
+  end)
+
+  it("pushes history and emits events when the popup buffer is wiped", function()
+    local received = {}
+    local group = vim.api.nvim_create_augroup("PeekstackBufWipeoutEvents", { clear = true })
+    vim.api.nvim_create_autocmd("User", {
+      group = group,
+      pattern = { "PeekstackClose", "PeekstackHistoryPush" },
+      callback = function(args)
+        table.insert(received, args.match)
+      end,
+    })
+
+    local model = stack.push(helpers.make_location())
+    assert.is_not_nil(model)
+
+    stack.handle_buf_wipeout(model.bufnr)
+
+    local history = stack.history_list()
+    assert.equals(1, #history)
+    assert.equals(model.id, history[1].popup_id)
+    assert.is_nil(stack.find_by_id(model.id))
+    assert.same({ "PeekstackClose", "PeekstackHistoryPush" }, received)
+
+    pcall(vim.api.nvim_del_augroup_by_id, group)
+  end)
 end)
 
 describe("stack.close_by_id", function()