fix: UNKNOWN PLUGIN error resulting from unloaded buffers #931
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
prettymuchbryce
changed the title
prettymuchbryce
changed the title
akinsho
reviewed
Jun 24, 2024
lua/bufferline/utils/init.lua
Outdated
| ---@return integer[] | ||
| function M.get_valid_buffers() return vim.tbl_filter(M.is_valid, vim.api.nvim_list_bufs()) end | ||
| ---@return table[] | ||
| function M.get_valid_buffers() return vim.tbl_filter(M.is_valid, vim.fn.getbufinfo()) end |
There was a problem hiding this comment.
I think you could use vim.iter here like
local bufs = vim.iter(vim.api.nvim_list_bufs()):filter(vim.api.nvim_buf_is_loaded)or to maintain backwards compat for people who haven't migrated could do a loop and rather than filter map vim.fn.getbufinfo() and only add the buffer number to the resulting list if it is valid
|
LGTM thanks for tweaking that 👍🏾 |
sstallion
pushed a commit
to sstallion/bufferline.nvim
that referenced
this pull request
Jul 3, 2024
* Fix UNKNOWN PLUGIN error resulting from unloaded buffers * Maintain get_valid_buffers signature
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Problem
Currently when checking if a buffer is valid, we use the function nvim_buf_is_valid, however there is an edge case here described in the documentation where a buffer could have been unloaded, but still be "valid". If a buffer is unloaded and valid then referencing
buf.buflistedcould result in a(UNKNOWN PLUGIN): Error executing lua: attempt to call a number valueerror. I believe this issue may be a bug in Neovim itself and I have attempted to get more clarity on this here.This issue reproduced in my config when
bufferlineattempted to reference thebuf.buflistedproperty of unloadednvim-treebuffer.Note: A previous attempt at this fix (#928) attempted to address the issue by changing the call to
nvim_buf_is_validtonvim_buf_is_loaded. While this solves the problem defined above, it had the side effect of breaking users of various session plugins. This is because session plugins utilize unloaded buffers which are also listed (i.e. calling.buflistedon these buffers returns1).Solution
Instead of utilizing
buf.buflisted, which can potentially result inUNKNOWN PLUGINerrors for certain unloaded buffers, we utilizevim.fn.getbufinfowhich returns a list of info tables for all buffers. This table contains a propertylistedwhich is0if the buffer is unlisted, and1if the buffer is listed. This allows us to check whether the unloaded buffer is listed, without referencingbuf.buflisteddirectly.I have locally verified that this solution both resolves the
UNKNOWN PLUGINerrors, and supports loading "hidden" session buffers via the posession plugin.