menu_closed event is emitted way too often, even if menu was not open

[MunifTanjim]

FAQ

• I have checked the FAQ and it didn't resolve my problem.

Announcement

• I have checked Breaking change announcement.

Minimal reproducible full config

minimal_init.lua

local root_dir = vim.fn.fnamemodify(vim.trim(vim.fn.system('git rev-parse --show-toplevel')), ':p')

package.path = string.format('%s;%s?.lua;%s?/init.lua', package.path, root_dir, root_dir)

vim.opt.packpath:prepend(root_dir .. '.testcache/site')

vim.opt.runtimepath:prepend(root_dir)

vim.cmd([[
  packadd nvim-cmp
]])

local cmp = require('cmp')

cmp.setup({
  completion = {
    autocomplete = false,
  },
})

cmp.event:on('menu_opened', function()
  print('menu_opened', os.clock())
end)

cmp.event:on('menu_closed', function()
  print('menu_closed', os.clock())
end)

test.sh

#!/usr/bin/env bash

function setup_environment() {
  echo
  echo "[test] setting up environment"
  echo

  local plugins_dir="./.testcache/site/pack/deps/start"
  mkdir -p "${plugins_dir}"

  echo "[nvim-cmp] linking..."
  mkdir -p "./.testcache/site/pack/deps/opt"
  ln -nsf "$(pwd)" "./.testcache/site/pack/deps/opt/nvim-cmp"

  echo "[test] environment ready"
  echo
}

setup_environment

nvim --clean --noplugin -u minimal_init.lua

Description

After adding a few logs inside the source code, found out that:

• nvim-cmp/lua/cmp/view.lua

  Lines 119 to 121 in 17a55b3

  	if #entries == 0 then
  	self:close()
  	end

• nvim-cmp/lua/cmp/view.lua

  Lines 134 to 136 in 17a55b3

  	self.event:emit('menu_closed', {
  	window = self:_get_entries_view(),
  	})

Those two code paths are running very often. And because of that menu_closed is emitted even if the menu is not visible.

Steps to reproduce

Run ./test.sh

Start typing something or move around in insert mode.

Even if the completion menu is not opened once, the menu_closed will be printed very often.

Expected behavior

menu_closed will only fire when menu was actually opened and then closed.

Actual behavior

menu_closed is fired very often even when menu was never opened.

Additional context

No response

[hrsh7th]

The menu_opened event is also emitted too often.
What do you use this event and the actual problem is?

[MunifTanjim]

What do you use this event?

https://github.com/zbirenbaum/copilot.lua/blob/2202f7abe238e9e4e28fb91a885fc1e8a2fd2ab5/README.md?plain=1#L106-L118

and the actual problem is?

Since I'm using it only to set a variable, I guess it doesn't matter much for my use-case.

But created the issue 'cause I expected these events to be emitted when the menu is actually opened/closed.

[hrsh7th]

To be honest, I also think the current implementation is not good and not reasonable.
But changing the implementation would be a breaking change...

[monkoose]

What is the status of this?

Even when autocompletion is disabled it runs this event on every keystroke.

cmp.setup({
  completion = {
    autocomplete = false
  }
}

The menu_opened event is also emitted too often.

For me and this snippet menu_opened doesn't invoke on every key pressed, like menu_closed.