bug: High CPU usage recording macros

[blarz]

Did you check docs and existing issues?

• I have read all the which-key.nvim docs
• I have updated the plugin to the latest version before submitting this issue
• I have searched the existing issues of which-key.nvim
• I have searched the existing issues of plugins related to this issue

Neovim version (nvim -v)

0.10.2

Operating system/version

Ubuntu 22.04.

Describe the bug

By accident I left a neovim instance open where there was a macro recording session still running (classic qq I guess). I noticed the CPU fan was spinning and then checked top confirming that nvim --embed was running at 100% CPU. Hitting q to stop the recording got the CPU usage back to normal.

Bisecting my neovim config I found out that this issue only occurs with the which-key plugin loaded.

Seeing that there was some work done in that are, e.g. #851, maybe there are some issues left there?

Steps To Reproduce

1. Open any file nvim foo.txt
2. Start a macro recording, e.g. qq
3. Watch CPU usage of the nvim process go to 100%
4. Stop recording with q
5. CPU usage goes back to normal

Expected Behavior

Regular CPU usage

Health

No response

Log

No response

Repro

No response

[theTastyWizard]

I have the same bug, just noticed it last week before updating to 10.2. 100% cpu core usage when recording macro, but using a clean install of nvim it goes down to 5%

[blarz]

Had a look around in the code today and in the commit 6b023b4, fixing an issue with macros and which-key, it looks like an "infinite recursion", or busy waiting loop calling M.schedule() (wrapped in a timer though), until macro recording is finished:

which-key.nvim/lua/which-key/triggers.lua

Lines 139 to 149 in 6b023b4

	function M.schedule(mode)
	if mode then
	M.suspended[mode] = true
	end
	M.timer:start(
	0,
	0,
	vim.schedule_wrap(function()
	if Util.in_macro() then
	return M.schedule()
	end

Maybe I understand the code wrong and I am not sure if that was intended, or if there is a better way, but it would explain the CPU usage.

[blarz]

According to LazyVim/LazyVim#4553 folke is on vacation until the end of the month 🌴

[blarz]

Obligatory XKCD 😅

But seriously, is this M.schedule() loop actually needed? I tried the plugin without that line, or rather just a return and I could record macros without high CPU usage and the issue with the double recorded characters also didn't happen.

But then again I don't know the codebase at all, so I am not sure what purpose that line serves.

[blarz]

Awesome, thank you! 🚀