fix(api): open_win leak from naughty autocommands

seandewar · zeertzjq · commit a9ffdca528d1 · 2026-01-05T11:34:26.000+08:00
Problem: error set by win_set_buf may leak if autocommands immediately close the
new window.

Solution: free the error set by win_set_buf. (prefer nvim_open_win's error as
it's more important and will cause 0 to be returned)
diff --git a/src/nvim/api/win_config.c b/src/nvim/api/win_config.c
@@ -343,6 +343,7 @@ Window nvim_open_win(Buffer buffer, Boolean enter, Dict(win_config) *config, Err
     }
   }
   if (!tp) {
+    api_clear_error(err);  // may have been set by win_set_buf
     api_set_error(err, kErrorTypeException, "Window was closed immediately");
     goto cleanup;
   }
diff --git a/test/functional/api/window_spec.lua b/test/functional/api/window_spec.lua
@@ -2068,6 +2068,31 @@ describe('API/win', function()
       api.nvim_open_win(0, true, { split = 'below' })
       eq(11, api.nvim_win_get_height(0))
     end)
+
+    it('no leak when win_set_buf fails and window is closed immediately', function()
+      -- Following used to leak.
+      command('autocmd BufEnter * ++once quit! | throw 1337')
+      eq(
+        'Window was closed immediately',
+        pcall_err(
+          api.nvim_open_win,
+          api.nvim_create_buf(true, true),
+          true,
+          { relative = 'editor', width = 5, height = 5, row = 1, col = 1 }
+        )
+      )
+      -- If the window wasn't closed, still set errors from win_set_buf.
+      command('autocmd BufEnter * ++once throw 1337')
+      eq(
+        'BufEnter Autocommands for "*": 1337',
+        pcall_err(
+          api.nvim_open_win,
+          api.nvim_create_buf(true, true),
+          true,
+          { relative = 'editor', width = 5, height = 5, row = 1, col = 1 }
+        )
+      )
+    end)
   end)
 
   describe('set_config', function()

Original file line number	Diff line number	Diff line change
`@@ -343,6 +343,7 @@ Window nvim_open_win(Buffer buffer, Boolean enter, Dict(win_config) *config, Err`
`343`	`343`	`}`
`344`	`344`	`}`
`345`	`345`	`if (!tp) {`
	`346`	`+ api_clear_error(err); // may have been set by win_set_buf`
`346`	`347`	`api_set_error(err, kErrorTypeException, "Window was closed immediately");`
`347`	`348`	`goto cleanup;`
`348`	`349`	`}`