fix(popup): always use current window when position == "cursor"

[pysan3]

Fixes folke/noice.nvim#636.

There are many ways to fix this issue, but I think my approach is the cleanest.

Other options:

• Overwrite internal.position.win to nil just like win_config.win here. (win_config.win will be nil, but internal.position.win is still unchanged and remembers the old value.)
  

  nui.nvim/lua/nui/layout/utils.lua

  Line 145 in c3c7fd6

  win_config.win = internal.position.relative == "win" and internal.position.win or nil

• Pass win_config instead of internal.position to mod.get_container_info here.
  

  nui.nvim/lua/nui/layout/utils.lua

  Line 156 in c3c7fd6

  internal.container_info = mod.get_container_info(internal.position)

Basically we need to pass a table with win = nil to get_window_size() that is called inside get_container_info, or deal with invalid table.win and ignore that value inside that function.

Note

It might be better to relative ~= "win" and 0 or position.win?

Basically the values are relative = "editor"|"win"|"cursor", and "editor" case is dealt with above, so they mean the exact same thing for now, but may not be in the future (when new position value is added).

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.04%. Comparing base (fc59553) to head (42cfb30).

❗ Current head 42cfb30 differs from pull request most recent head c0e07ad. Consider uploading reports for the commit c0e07ad to get more accurate results

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #338   +/-   ##
=======================================
  Coverage   99.04%   99.04%           
=======================================
  Files          20       20           
  Lines        2733     2735    +2     
=======================================
+ Hits         2707     2709    +2     
  Misses         26       26           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[pysan3]

@MunifTanjim Any updates?

[MunifTanjim]

What would happen if I open a popup with relative=cursor, then move the cursor to a different window and call popup:update_layout? 🤔

The container should still be the initial window where the popup was opened, right?

[pysan3]

Oh, I thought position = "cursor" should follow the cursor. So when update_layout, the popup position is remapped to the position / window of which the cursor is positioned right now.

---

This is how to reproduce the problem I was referring to.

And this PR fixes it by making popup always open from the current focused window.

1. new popup (relative = "cursor", position = { row = 1, col = 1 })
2. close it
3. :vs
4. :e different file
5. reopen the popup
6. <C-w>w (go back to the previous window)
7. :q (close this window)
8. (now there's only the new window opened by :vs)
9. reopen the popup
10. ERROR ...o/.local/share/nvim/lazy/nui.nvim/lua/nui/utils/init.lua:29: Invalid window id: 1000

---

When relative = "win" I agree that the popup should stay on the window where it was initially spawned from even after :update_layout() (and do not follow the nvim_get_current_win()).

[pysan3]

Any updates @MunifTanjim ?

[MunifTanjim]

This will just fix the size. But reference to that invalid window id will remain internally.

Can we try this instead?

diff --git a/lua/nui/layout/utils.lua b/lua/nui/layout/utils.lua
index 6f251b5..66efcc3 100644
--- a/lua/nui/layout/utils.lua
+++ b/lua/nui/layout/utils.lua
@@ -137,7 +137,9 @@ function mod.update_layout_config(component_internal, config)
   if options.relative then
     internal.layout.relative = options.relative
 
-    local fallback_winid = internal.position and internal.position.win or vim.api.nvim_get_current_win()
+    local fallback_winid = internal.position and internal.position.win
+      or internal.layout.relative.type == "cursor" and 0
+      or vim.api.nvim_get_current_win()
     internal.position =
       vim.tbl_extend("force", internal.position or {}, mod.parse_relative(internal.layout.relative, fallback_winid))
 

[pysan3]

Fair enough. I'll use that instead.

What do you think about this?

Note

It might be better to relative ~= "win" and 0 or position.win?

Basically the values are relative = "editor"|"win"|"cursor", and "editor" case is dealt with above, so they mean the exact same thing for now, but may not be in the future (when new position value is added).

[MunifTanjim]

nui.nvim also accepts this:

nui.nvim/lua/nui/popup/README.md

Lines 229 to 240 in fc59553

	Relative to the buffer position:
	```lua
	relative = {
	type = "buf",
	-- zero-indexed
	position = {
	row = 5,
	col = 5,
	},
	},
	```

Which internally translates to

win = current_window
bufpos = position_relative_to_buffer_on_current_window

The bufpos is only valid for a specific buffer, so win needs to be fixed to a window that contains that buffer.

[pysan3]

Oh so it is relative = "editor"|"win"|"cursor"|"buf"?

Then I'll use relative == "cursor" and 0.

[pysan3]

@MunifTanjim Fixed!

Please squash merge this PR. The commit history is kinda messy.