fix(autocmds): once=true Lua event-handler may call itself #29544

Problem:
Event handler declared with `once=true` can re-trigger itself (i.e. more
than once!) by calling `nvim_exec_autocmds` or `:doautocmd`.

Analysis:
This happens because the callback is executed before deletion/cleanup
(`aucmd_del`). And calling `aucmd_del` before `call_autocmd_callback`
breaks the autocmd execution...

Solution:
Set `ac->pat=NULL` to temporarily "delete" the autocmd, then restore it
after executing the callback.

Fix #25526

Co-authored-by: Justin M. Keyes <justinkz@gmail.com>
This commit is contained in:
Felipe Vicentin
2025-02-02 01:25:38 +01:00
committed by GitHub
parent 0985e784d8
commit 289c9d21cb
2 changed files with 44 additions and 14 deletions

View File

@@ -160,7 +160,7 @@ describe('autocmd', function()
it('++once', function() -- :help autocmd-once
--
-- ":autocmd ... ++once" executes its handler once, then removes the handler.
-- ":autocmd ++once" executes its handler once, then removes the handler.
--
local expected = {
'Many1',
@@ -206,7 +206,7 @@ describe('autocmd', function()
)
--
-- ":autocmd ... ++once" handlers can be deleted.
-- ":autocmd ++once" handlers can be deleted.
--
expected = {}
command('let g:foo = []')
@@ -216,7 +216,7 @@ describe('autocmd', function()
eq(expected, eval('g:foo'))
--
-- ":autocmd ... <buffer> ++once ++nested"
-- ":autocmd <buffer> ++once ++nested"
--
expected = {
'OptionSet-Once',
@@ -250,6 +250,24 @@ describe('autocmd', function()
--- Autocommands ---]]),
fn.execute('autocmd Tabnew')
)
--
-- :autocmd does not recursively call ++once Lua handlers.
--
exec_lua [[vim.g.count = 0]]
eq(0, eval('g:count'))
exec_lua [[
vim.api.nvim_create_autocmd('User', {
once = true,
pattern = nil,
callback = function()
vim.g.count = vim.g.count + 1
vim.api.nvim_exec_autocmds('User', { pattern = nil })
end,
})
vim.api.nvim_exec_autocmds('User', { pattern = nil })
]]
eq(1, eval('g:count'))
end)
it('internal `aucmd_win` window', function()